This documentation applies only to Kilo version 1.0 and later. Users running versions below 1.0 should upgrade before proceeding.
Kilo CLI
Orchestrate agents from your terminal. Plan, debug, and code fast with keyboard-first navigation on the command line.
The Kilo Code CLI uses the same underlying technology that powers the IDE extensions, so you can expect the same workflow to handle agentic coding tasks from start to finish.
Source code & issues (Kilo CLI 1.0): Kilo-Org/kilo ยท Report an issue
Getting Started
Install
Use Kilo Code directly from your terminal for maximum flexibility.
Install via npm
npm install -g @kilocode/cli
Verify Installation
kilo --version
Change directory to where you want to work and run kilo:
# Start the TUI kilo # Check the version kilo --version # Get help kilo --help
First-Time Setup with /connect
After installation, run kilo and use the /connect command to add your first provider credentials. This is the interactive way to configure API keys for model providers.
Update
Upgrade the Kilo CLI:
kilo upgrade
Or use npm:
npm update -g @kilocode/cli
What you can do with Kilo Code CLI
- Plan and execute code changes without leaving your terminal. Use your command line to make edits to your project without opening your IDE.
- Switch between hundreds of LLMs without constraints. Other CLI tools only work with one model or curate opinionated lists. With Kilo, you can switch models without booting up another tool.
- Choose the right mode for the task in your workflow. Select between Architect, Ask, Debug, Orchestrator, or custom agent modes.
- Automate tasks. Get AI assistance writing shell scripts for tasks like renaming all of the files in a folder or transforming sizes for a set of images.
- Extend capabilities with skills. Add domain expertise and repeatable workflows through Agent Skills.
CLI Reference
Top-Level CLI Commands
| Command | Description |
|---|---|
kilo [project] | Start the TUI (Terminal User Interface) |
kilo run [message..] | Run with a message (non-interactive mode) |
kilo attach <url> | Attach to a running kilo server |
kilo serve | Start a headless server |
kilo web | Start server and open web interface |
kilo auth | Manage credentials (login, logout, list) |
kilo agent | Manage agents (create, list) |
kilo mcp | Manage MCP servers (list, add, auth) |
kilo models [provider] | List available models |
kilo stats | Show token usage and cost statistics |
kilo session | Manage sessions (list) |
kilo export [sessionID] | Export session data as JSON |
kilo import <file> | Import session data from JSON file or URL |
kilo upgrade [target] | Upgrade kilo to latest or specific version |
kilo uninstall | Uninstall kilo and remove related files |
kilo pr <number> | Fetch and checkout a GitHub PR branch |
kilo github | Manage GitHub agent (install, run) |
kilo debug | Debugging and troubleshooting tools |
kilo completion | Generate shell completion script |
Global Options
| Flag | Description |
|---|---|
--help, -h | Show help |
--version, -v | Show version number |
--print-logs | Print logs to stderr |
--log-level | Log level: DEBUG, INFO, WARN, ERROR |
Interactive Slash Commands
Session Commands
| Command | Aliases | Description |
|---|---|---|
/sessions | /resume, /continue | Switch session |
/new | /clear | New session |
/share | - | Share session |
/unshare | - | Unshare session |
/rename | - | Rename session |
/timeline | - | Jump to message |
/fork | - | Fork from message |
/compact | /summarize | Compact/summarize session |
/undo | - | Undo previous message |
/redo | - | Redo message |
/copy | - | Copy session transcript |
/export | - | Export session transcript |
/timestamps | /toggle-timestamps | Show/hide timestamps |
/thinking | /toggle-thinking | Show/hide thinking blocks |
Agent & Model Commands
| Command | Description |
|---|---|
/models | Switch model |
/agents | Switch agent |
/mcps | Toggle MCPs |
Provider Commands
| Command | Description |
|---|---|
/connect | Connect/add a provider - entry point for new users to add API credentials |
System Commands
| Command | Aliases | Description |
|---|---|---|
/status | - | View status |
/themes | - | Switch theme |
/help | - | Show help |
/editor | - | Open external editor |
/exit | /quit, /q | Exit the app |
Kilo Gateway Commands (when connected)
| Command | Aliases | Description |
|---|---|---|
/profile | /me, /whoami | View your Kilo Gateway profile |
/teams | /team, /org, /orgs | Switch between Kilo Gateway teams |
Built-in Commands
| Command | Description |
|---|---|
/init | Create/update AGENTS.md file for the project |
/local-review | Review code changes |
/local-review-uncommitted | Review uncommitted changes |
Local Code Reviews
Review your code locally before pushing โ catch issues early without waiting for PR reviews. Local code reviews give you AI-powered feedback on your changes without creating a public pull request.
Commands
| Command | Description |
|---|---|
/local-review | Review current branch changes vs base branch |
/local-review-uncommitted | Review uncommitted changes (staged + unstaged) |
Config Reference
Configuration is managed through:
/connectcommand for provider setup (interactive)- Config files in
~/.config/kilo/: the CLI (Kilo CLI 1.0 from Kilo-Org/kilo) mergesconfig.json,opencode.json, andopencode.jsonc. Useopencode.json(oropencode.jsonc) for provider, model, permission, and MCP settings. Restart the CLI after editing. See Using MCP in the CLI for MCP config format. kilo authfor credential management
Slash Commands
The CLI's interactive mode supports slash commands for common operations. The main commands are documented above in the Interactive Slash Commands section.
Confused about /newtask vs /smol in the IDE? See the Using Modes documentation for details.
Permissions
Kilo Code uses the permission config to decide whether a given action should run automatically, prompt you, or be blocked.
Actions
Each permission rule resolves to one of:
"allow"โ run without approval"ask"โ prompt for approval"deny"โ block the action
Configuration
You can set permissions globally (with *), and override specific tools.
{
"$schema": "https://kilo.ai/config.json",
"permission": {
"*": "ask",
"bash": "allow",
"edit": "deny"
}
}
You can also set all permissions at once:
{
"$schema": "https://kilo.ai/config.json",
"permission": "allow"
}
Granular Rules (Object Syntax)
For most permissions, you can use an object to apply different actions based on the tool input.
{
"$schema": "https://opencode.ai/config.json",
"permission": {
"bash": {
"*": "ask",
"git *": "allow",
"npm *": "allow",
"rm *": "deny",
"grep *": "allow"
},
"edit": {
"*": "deny",
"packages/web/src/content/docs/*.mdx": "allow"
}
}
}
Rules are evaluated by pattern match, with the last matching rule winning. A common pattern is to put the catch-all "*" rule first, and more specific rules after it.
Wildcards
Permission patterns use simple wildcard matching:
*matches zero or more of any character?matches exactly one character- All other characters match literally
Home Directory Expansion
You can use ~ or $HOME at the start of a pattern to reference your home directory. This is particularly useful for external_directory rules.
~/projects/*โ/Users/username/projects/*$HOME/projects/*โ/Users/username/projects/*~โ/Users/username
External Directories
Use external_directory to allow tool calls that touch paths outside the working directory where Kilo was started. This applies to any tool that takes a path as input (for example read, edit, list, glob, grep, and many bash commands).
{
"$schema": "https://kilo.ai/config.json",
"permission": {
"external_directory": {
"~/projects/personal/**": "allow"
}
}
}
Any directory allowed here inherits the same defaults as the current workspace. Since read defaults to "allow", reads are also allowed for entries under external_directory unless overridden. Add explicit rules when a tool should be restricted in these paths, such as blocking edits while keeping reads:
{
"$schema": "https://kilo.ai/config.json",
"permission": {
"external_directory": {
"~/projects/personal/**": "allow"
},
"edit": {
"~/projects/personal/**": "deny"
}
}
}
Aliases: /t and /history can be used as shorthand for /tasks
Configuration
The Kilo CLI is a fork of OpenCode and supports the same configuration options. The CLI you install with npm install -g @kilocode/cli (Kilo CLI 1.0) is built from Kilo-Org/kilo. For comprehensive configuration documentation, see the OpenCode Config documentation.
Config File Location (Kilo CLI 1.0)
| Scope | Path |
|---|---|
| Global | ~/.config/kilo/opencode.json or opencode.jsonc (Windows: config dir may vary; same filenames) |
| Project | ./opencode.json or ./.opencode/ in project root |
Project-level configuration takes precedence over global settings.
Key Configuration Options
{
"$schema": "https://opencode.ai/config.json",
"model": "anthropic/claude-sonnet-4-20250514",
"provider": {
"anthropic": {
"options": {
"apiKey": "{env:ANTHROPIC_API_KEY}"
}
}
}
}
Common configuration options include:
model- Default model to useprovider- Provider-specific settings (API keys, base URLs, custom models)mcp- MCP server configurationpermission- Tool permission settings (alloworask)instructions- Paths to instruction files (e.g.,["CONTRIBUTING.md", ".cursor/rules/*.md"])formatter- Code formatter configurationdisabled_providers/enabled_providers- Control which providers are available
Environment Variables
Use {env:VARIABLE_NAME} syntax in config files to reference environment variables:
{
"provider": {
"openai": {
"options": {
"apiKey": "{env:OPENAI_API_KEY}"
}
}
}
}
For full details on all configuration options including compaction, file watchers, plugins, and experimental features, see the OpenCode Config documentation.
Config reference for providers
Kilo gives you the ability to bring your own keys for a number of model providers and AI gateways, like OpenRouter and Vercel AI Gateway. Each provider has unique configuration options and some let you set environment variables.
You can reference the Provider Configuration Guide for examples (same config format; for Kilo CLI 1.0 the file is ~/.config/kilo/opencode.json). You can also run:
kilo config
to complete configuration with an interactive workflow on the command line.
You can also use the /config slash command during an interactive session, which is equivalent to running kilocode config.
Interactive Mode
Interactive mode is the default mode when running Kilo Code without the --auto flag, designed to work interactively with a user through the console.
In interactive mode Kilo Code will request approval for operations which have not been auto-approved, allowing the user to review and approve operations before they are executed, and optionally add them to the auto-approval list.
Interactive Command Approval
When running in interactive mode, command approval requests show hierarchical options:
[!] Action Required: > โ Run Command (y) โ Always run git (1) โ Always run git status (2) โ Always run git status --short --branch (3) โ Reject (n)
Selecting an "Always run" option will:
- Approve and execute the current command
- Add the pattern to your
execute.allowedlist in the config - Auto-approve matching commands in the future
This allows you to progressively build your auto-approval rules without manually editing the config file.
Autonomous Mode (Non-Interactive)
Autonomous mode allows Kilo Code to run in automated environments like CI/CD pipelines without requiring user interaction.
# Run in autonomous mode with a message kilo run --auto "Implement feature X"
Autonomous Mode Behavior
When running in autonomous mode:
- No User Interaction: All approval requests are handled automatically based on configuration
- Auto-Approval/Rejection: Operations are approved or rejected based on your auto-approval settings
- Follow-up Questions: Automatically responded with a message instructing the AI to make autonomous decisions
- Automatic Exit: The CLI exits automatically when the task completes or times out
Auto-Approval in Autonomous Mode
Autonomous mode respects your auto-approval configuration. Operations which are not auto-approved will not be allowed.
Autonomous Mode Follow-up Questions
In autonomous mode, when the AI asks a follow-up question, it receives this response:
"This process is running in non-interactive autonomous mode. The user cannot make decisions, so you should make the decision autonomously."
This instructs the AI to proceed without user input.
Exit Codes
0: Success (task completed)124: Timeout (task exceeded time limit)1: Error (initialization or execution failure)
Example CI/CD Integration
# GitHub Actions example
- name: Run Kilo Code
run: |
kilo run "Implement the new feature" --auto
Session Continuation
Resume your last conversation from the current workspace using the --continue (or -c) flag:
# Resume the most recent session from this workspace kilo --continue kilo -c
This feature:
- Automatically finds the most recent session from the current workspace
- Loads the full conversation history
- Allows you to continue where you left off
- Cannot be used with autonomous mode or with a prompt argument
- Exits with an error if no previous sessions are found
Example workflow:
# Start a session kilo # > "Create a REST API" # ... work on the task ... # Exit with /exit # Later, resume the same session kilo --continue # Conversation history is restored, ready to continue
Limitations:
- Cannot be combined with autonomous mode
- Cannot be used with a prompt argument
- Only works when there's at least one previous session in the workspace
Environment Variable Overrides
The CLI supports overriding config values with environment variables. The supported environment variables are:
KILO_PROVIDER: Override the active provider ID- For
kilocodeprovider:KILOCODE_<FIELD_NAME>(e.g.,KILOCODE_MODELโkilocodeModel) - For other providers:
KILO_<FIELD_NAME>(e.g.,KILO_API_KEYโapiKey)
Switching into an Organization from the CLI
Use the /teams command to see a list of all organizations you can switch into.
Use /teams and select a team to switch teams.
The process is the same when switching into a Team or Enterprise organization.