Skip to main content
← All setup guides

Kilo · Setup guide

How to set up Kilo Code

Install Kilo Code in the VS Code or JetBrains Marketplace (the flagship path), or add the optional CLI for terminal workflows. Connect a provider and start with a read-only task. Useful if you are migrating from discontinued Roo Code tooling.

Kilo Code

editor plugin · checked August 8, 2026

~10 minBeginner

The “Open Kilo Code” link goes to the vendor site. It is not an affiliate-tracked link on this page — no commission is claimed for that click. Affiliate disclosure.

Critical: finish install before closing the window

Keep the installer terminal open until you see a success message. If you used an admin window, do not close it until verification works. Then open a new Terminal or PowerShell window and run the verify step — PATH updates rarely apply to shells that were already open, especially on Windows.

Before you begin

  • VS Code or JetBrains for the flagship IDE path; Node.js and npm only if using the CLI.
  • macOS, Linux, or Windows if you choose the terminal path.
  • A Kilo account and/or provider API keys.
  • A project directory you can safely open.
  • An IntelliJ-based JetBrains IDE is optional if you prefer Kilo’s native plugin over the CLI.

Authentication

/connect in the TUI, or kilo auth from the shell

Account: Kilo account and/or provider API keys

Kilo CLI shares configuration concepts with OpenCode; provider keys and auth tokens often live under ~/.local/share/kilo/ (for example auth.json) — do not assume ~/.config/kilo/. Pick providers deliberately and keep keys out of git.

Install or open it

1. Get the harness ready

These steps are written for beginners. On Mac, Terminal is the black/white text window where you type commands. On Windows, use PowerShell or Terminal. Use the OS tabs to hide steps that are not for your computer, then copy one command at a time.

  1. 01

    Install Kilo Code from the Marketplace (recommended)

    In VS Code, open Extensions, search Kilo Code, choose the official Kilo Code extension (kilocode.Kilo-Code), and click Install. JetBrains users can use Settings → Plugins → Marketplace → Kilo Code. Sign in after the extension loads; this Marketplace path is the flagship starting point, while the CLI below is optional.

    Kilo Code on the VS Code Marketplace
  2. 02

    Migrating from Roo Code?

    Roo Code settings, MCP config, and API keys do not port automatically — plan to re-auth in Kilo and re-add extensions. See the Roo → Kilo migration section in our buyer guides hub: /ai-harnesses/guides/roo-to-kilo-migration.

    Kilo Code docs
  3. 03

    Open Terminal on a Mac

    Mac

    Click the Spotlight search icon (magnifying glass) at the top-right of the menu bar, or press Command (⌘) + Space. Type Terminal and press Return. A text window opens — that is where you paste the install commands below. Leave it open.

  4. 04

    Open Terminal or PowerShell on Windows

    Windows

    Press the Windows key, type Terminal or PowerShell, then press Enter. Use that window for the commands below. If Windows asks for permission to run a script or install software, read the prompt before approving.

  5. 05

    How to paste a command

    Copy one command at a time from this page. Click inside the terminal window, paste (Mac: ⌘+V, Windows: Ctrl+V or right-click → Paste), then press Return / Enter. Wait until the prompt comes back before running the next command. You do not need to type the leading $ if you see one in other docs.

  6. 06

    Do not close the installer until verified

    Keep the installer terminal (or admin PowerShell) open until the install finishes without errors. Closing early can leave a half-written binary or an incomplete PATH update — especially on Windows.

  7. 07

    Open a new terminal after installers

    PATH updates often only apply to new shells — especially on Windows. Do not close the install session until the installer finishes, then open a fresh Terminal/PowerShell before running --version checks.

  8. 08

    Inspect before you pipe an installer

    Commands like curl … | bash download and run a script immediately. Prefer the official package manager when offered. If you use a curl installer, you can download the script first, open it in a text editor, then run it — never paste installers from random blogs.

  9. 09

    Confirm Node.js

    Run node --version. If the command fails, install the LTS build from nodejs.org, then open a new terminal. Kilo’s CLI is distributed as an npm package.

    bash
    node --version

    You should see: A Node version such as v20.x. If the command fails, install LTS from nodejs.org and open a new terminal.

    If this fails
    • “command not found”, “not recognized”, or no window opens. Open a new terminal after install, confirm PATH, then re-run the verify command from the official docs.
  10. 10

    Optional: install the Kilo CLI

    Install the official package globally. When it finishes, open a new terminal window.

    bash
    npm install -g @kilocode/cli

    You should see: The installer finishes without an error. Open a new terminal before the verify step so PATH updates apply.

    If this fails
    • The install command errors, or the next verify step says “command not found”. Re-run the official install command with network access, then open a brand-new terminal window before verifying.
    Kilo CLI docs
  11. 11

    Verify the command

    You should see a version string. If not, reopen the terminal and check that npm’s global bin directory is on PATH.

    bash
    kilo --version

    You should see: A version string. Open a new terminal and confirm npm’s global bin directory is on PATH if it fails.

    If this fails
    • kilo: command not found after npm install. Open a new terminal. Run npm prefix -g and ensure that path’s bin folder is on PATH.
  12. 12

    Optional: install the JetBrains plugin

    In IntelliJ IDEA, PyCharm, WebStorm, GoLand, Rider, CLion, RubyMine, or DataGrip, open Settings → Plugins → Marketplace, search for Kilo Code, install it, and restart if prompted. The native plugin is separate from the CLI but uses the same account and provider choices.

    Kilo Code for JetBrains

Repository or project

2. Start in the right place

Keep the first repository small, clean, and easy to roll back while you learn the harness’s permissions and context model.

  1. 01

    Open the project in Kilo or Terminal

    For the IDE path, open the folder in VS Code or JetBrains and launch the Kilo panel. For the optional CLI path, use cd to enter the repository you want to work on.

    bash
    cd path/to/your-repository

    You should see: The prompt shows you are inside the intended folder (check with `pwd`).

    If this fails
    • “No such file or directory” or you are still in your home folder. Create or clone the practice folder first, then `cd` into it before starting the tool.
  2. 02

    Start the Kilo TUI

    Run kilo with no arguments for the interactive UI.

    bash
    kilo

    You should see: The tool starts in this folder and waits for your first prompt (or shows a short first-run / sign-in screen).

    If this fails
    • Nothing happens, or you land in the wrong folder. Confirm you are inside the practice repo (`pwd`), that you signed in, and that you opened a new terminal after install.
    Kilo CLI
  3. 03

    Connect your first provider

    Type /connect and add credentials, or exit and run kilo auth from the shell if you prefer a non-TUI flow.

    bash
    /connect

    You should see: The command finishes without an error before you continue.

    If this fails
    • The command exits with an error. Read the last few lines of output, fix the named issue, then re-run this step before continuing.

First run

Explain, then one-off run

Use this task to test the workflow before handing over a larger repository or production responsibility.

  1. 01Ask Kilo to summarise the repository and name the test command — no edits.
  2. 02Exit if anything looks wrong with permissions or provider choice.
  3. 03For a second pass, try a one-off: kilo run "add a one-line comment to README explaining how to run tests" and review the diff.

Why this is safe: Separates orientation from mutation and keeps the first write tiny and reviewable.

Stop and review if

  • The agent requests secrets or cloud credentials for a docs task.
  • A one-off run touches files outside the repository.
  • You cannot identify which provider billed the session.

The operating boundary

Privacy, data, and cost

The setup is incomplete until you know what the harness can see, what account pays for it, and who approves a risky action.

Privacy

Kilo’s client routes work through providers you connect (BYOK) or through Kilo Gateway/Pass. Training and retention follow those providers and Kilo’s current cloud terms — confirm before private repos.

Training on code: tier dependent

Confirm current Kilo and provider documentation for your region and plan.

Sensitive repos: Use a sanitized practice repo first; treat /connect credentials like production secrets.

Pricing

Individual platform is free; inference is BYOK, Gateway, or Pass. Teams add ~$15/user/mo. Optional cloud compute bills separately.

Model: hybrid

Watch out: Pass is not unlimited. Agent loops and cloud hours can exceed the free-feeling install.

Estimate a seat stack

When setup goes wrong

  • kilo: command not found after npm install.

    Open a new terminal. Run npm prefix -g and ensure that path’s bin folder is on PATH.

  • Permission denied on npm install -g.

    Reconfigure npm’s global directory to one you own, or use a Node version manager — avoid casual sudo.

  • Provider connect works but requests fail.

    Re-run /connect or kilo auth, confirm credits, and check Kilo’s provider-specific docs for required account IDs or tokens.

  • Migrating from Roo Code — settings or keys do not appear.

    Roo Code settings and API keys do not port automatically. Re-authenticate with /connect or kilo auth, re-import MCP servers, and review the Roo → Kilo migration guide at /ai-harnesses/guides/roo-to-kilo-migration.

Next steps

After the first successful run

Keep the pilot small, then compare surfaces and budget before a team rollout.

Setup details change quickly. The page was checked August 8, 2026; use the official source below before installing in a managed or production environment.