Codepilot
Home/Docs

Documentation

Get Codepilot running in your editor in minutes, then learn the CLI, the config file, and the guides that help you get the most out of your AI pair-programmer.

// quickstart

Install in four steps

Codepilot installs as an editor extension and a small CLI. You'll be getting completions within a couple of minutes.

  1. Install the extension. Search "Codepilot" in your editor's marketplace, or run the CLI installer below.
  2. Authenticate. Run codepilot login — it opens your browser to sign in and stores a local token.
  3. Open a project. Codepilot indexes your repository locally so completions match your code.
  4. Start typing. Ghost-text suggestions appear inline — press Tab to accept.
$ npm install -g codepilot-cli # added 1 package in 3s $ codepilot login → opening browser to authenticate… ✓ logged in as you@team.dev $ codepilot init ✓ wrote codepilot.json · indexed 412 files
// cli

CLI reference

The codepilot binary brings completions, reviews, and tests to any terminal or CI pipeline.

$ codepilot explain src/auth.ts --lines 20-48 $ codepilot test src/cart.ts --framework jest $ codepilot review --staged # reviews staged diff, prints inline notes $ codepilot complete --file main.go --at 12:4

Run codepilot --help for the full command list, or codepilot <command> --help for any subcommand.

// config

The codepilot.json file

Drop a codepilot.json at your repo root to tune behavior per project. It's committed alongside your code, so the whole team shares the same setup.

Any key set here overrides your global settings for this repository only.

// editors

Supported editors

One account works across every editor below — sign in once per machine.

VS Code JetBrains (all IDEs) Neovim Visual Studio Sublime Text JupyterLab CLI / CI
// guides

Guides

Short, practical walkthroughs for getting more out of Codepilot.

Tuning completion quality

How to use ignore globs, max-line limits, and model selection to get sharper suggestions.

Read guide

Generating a test suite

Walk through generating, reviewing, and committing tests for an untested module.

Read guide

Using the REST API

Authenticate, stream completions, and wire Codepilot into your own developer tools.

Read guide

Self-hosting & privacy

Deploy Codepilot in your VPC and turn on zero data retention for sensitive repos.

Read guide

Ready to install Codepilot?

Follow the quickstart above and you'll be accepting your first AI completion in minutes.

Install free Contact support