Getting started
Install kcode, register it, and run a first session.
Install
kcode runs on Apple silicon Macs with macOS 14 (Sonoma) or later. There is no Intel build.
- Get the DMG from Download.
- Open it and drag kcode to Applications.
- Open kcode. It is notarized, so macOS opens it like any other app.
Register
On first launch kcode asks for your name and email address and emails you a six-digit code. Type the code into kcode and the Mac is registered. The first registration makes your kcode.sh account, and with it the free trial starts. No card is needed; the pricing page gives the trial’s length.
Model access
kcode works with supported providers, including OpenAI, Anthropic, Google, OpenRouter, Groq, DeepSeek, Fireworks, and Mistral. Connect one in Settings › Providers, with kcode auth, or by putting its key in the environment before you launch. You can use your own API key or a supported LLM subscription plan such as ChatGPT Plus/Pro or Kimi For Coding. kcode bundles no model access; usage limits and billing stay with the provider. /model lists the available models.
A first session
Mission Control opens on an empty grid. Press ⌘N, pick a project folder, and type what you want done. A few things worth knowing on day one:
/at the start of the input opens the command menu./helplists everything.⌘Mgoes back to the grid from a session;⌘1to⌘9jump to a tile.⌘Pis the command palette,⌘,the settings page,Ctrl-Bthe shortcut cheatsheet./permissions planputs a session in read-only mode when you want it to look before it touches anything.Escstops the running turn.
Configuration
Settings live in ~/.kcode/config.toml, with a per-project overlay in <project>/.kcode/config.toml. Every control on the settings page is one of those keys. kcode config defaults prints the whole surface with defaults, and the settings reference explains each key.
Next
- Your first plugin adds a tool in Lua in a few minutes.
- Headless runs kcode from a script or CI.
- The reference lists every command, shortcut, tool, and setting.