opensource/kilocode
3
0
Fork 0
mirror of https://github.com/Kilo-Org/kilocode.git synced 2026-09-24 16:02:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into catrielmuller/kiloclaw-client

Browse Source
This commit is contained in:
Catriel Müller
2026-04-01 16:20:14 -03:00
committed by GitHub
parent f1075fc6a9 c27c81a2b4
commit 32f670e1cc
342 changed files with 20672 additions and 2162 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitattributes
+13
View File
@@ -1,3 +1,6 @@
# Enforce LF line endings for all text files
* text=auto eol=lf
# Git LFS tracking for binary/media files
*.gif filter=lfs diff=lfs merge=lfs -text
*.mp4 filter=lfs diff=lfs merge=lfs -text
@@ -5,3 +8,13 @@
# Visual regression baseline snapshots
packages/kilo-ui/tests/**/*.png filter=lfs diff=lfs merge=lfs -text
packages/kilo-vscode/tests/**/*.png filter=lfs diff=lfs merge=lfs -text
# Hide non-English localization files by default in GitHub PR diffs.
**/i18n/*.ts linguist-generated=true
**/i18n/en.ts linguist-generated=false
**/i18n/en*.ts linguist-generated=false
**/i18n/package-nls-en.ts linguist-generated=false
**/i18n/index.ts linguist-generated=false
**/i18n/parity.test.ts linguist-generated=false
packages/kilo-i18n/src/*.ts linguist-generated=true
packages/kilo-i18n/src/en.ts linguist-generated=false
.kilocode/skills/vscode-visual-regression/SKILL.md
+3 -2
View File
@@ -59,7 +59,7 @@ export const MyStoryName: Story = {
name: "MyComponent — description of variant",
render: () => (
<StoryProviders>
<div style={{ width: "420px", height: "400px" }}>
<div style={{ "max-height": "400px", overflow: "auto" }}>
<MyComponent someProp="value" />
</div>
</StoryProviders>
@@ -71,7 +71,8 @@ export const MyStoryName: Story = {
- **Always start with `/** @jsxImportSource solid-js \*/`\*\* — required for SolidJS JSX compilation.
- **Always wrap in `<StoryProviders>`** — provides all required contexts (VSCode, Server, Config, Provider, Session, I18n, Dialog, Marked, Data, Diff, Code). Without it, components that call `useVSCode()`, `useSession()`, etc. will throw.
- **Set explicit dimensions** on a wrapper div so the screenshot has a deterministic size. Use `width: "420px"` for sidebar-width components (the standard VS Code sidebar). Use `width: "200px"` for narrow/collapsed states.
- **Do NOT set an explicit `width` on the wrapper div.** The Playwright viewport is already 420px wide (or 200px for narrow stories). Setting `width: "420px"` leaves no room for a vertical scrollbar and causes right-side cropping in screenshots. Let the viewport control the width.
- **Use `max-height` not `height` for the wrapper div** when you need to constrain vertical size. A fixed `height` forces a scrollbar even when content is short; `max-height` avoids unnecessary scrollbars that would eat into the available horizontal space.
- **Meta `title`** determines the snapshot subdirectory. Use PascalCase or slash-notation (e.g., `"Composite/Webview"`). Playwright transforms it: `"Composite/Webview"` becomes `composite-webview/` in the snapshots folder.
- **Export name** determines the story ID. The Storybook ID is `{lowercase-title}--{kebab-export-name}`. For example, `title: "Chat"` + `export const ChatViewIdle` produces ID `chat--chat-view-idle`.
- **Snapshot path** is derived automatically: `tests/visual-regression.spec.ts-snapshots/{title-slug}/{variant-slug}.png`. Example: `chat/chat-view-idle-chromium-linux.png`.
.opencode/command/issues.md
+1 -1
View File
@@ -3,7 +3,7 @@ description: "find issue(s) on github"
model: opencode/claude-haiku-4-5
---
Search through existing issues in Kilo-Org/kilo using the gh cli to find issues matching this query:
Search through existing issues in Kilo-Org/kilocode using the gh cli to find issues matching this query:
$ARGUMENTS
README.md
+6 -6
View File
@@ -1,9 +1,9 @@
<p align="center">
<a href="https://marketplace.visualstudio.com/items?itemName=kilocode.Kilo-Code"><img src="https://img.shields.io/badge/VS_Code_Marketplace-007ACC?style=flat&logo=visualstudiocode&logoColor=white" alt="VS Code Marketplace"></a>
<a href="https://x.com/kilocode"><img src="https://img.shields.io/badge/kilocode-000000?style=flat&logo=x&logoColor=white" alt="X (Twitter)"></a>
<a href="https://blog.kilo.ai"><img src="https://img.shields.io/badge/Blog-555?style=flat&logo=substack&logoColor=white" alt="Substack Blog"></a>
<a href="https://kilo.ai/discord"><img src="https://img.shields.io/badge/Join%20Discord-5865F2?style=flat&logo=discord&logoColor=white" alt="Discord"></a>
<a href="https://www.reddit.com/r/kilocode/"><img src="https://img.shields.io/badge/Join%20r%2Fkilocode-D84315?style=flat&logo=reddit&logoColor=white" alt="Reddit"></a>
<a href="https://marketplace.visualstudio.com/items?itemName=kilocode.Kilo-Code"><img src="https://raster.shields.io/badge/VS_Code_Marketplace-007ACC?style=flat&logo=visualstudiocode&logoColor=white" alt="VS Code Marketplace"></a>
<a href="https://x.com/kilocode"><img src="https://raster.shields.io/badge/kilocode-000000?style=flat&logo=x&logoColor=white" alt="X (Twitter)"></a>
<a href="https://blog.kilo.ai"><img src="https://raster.shields.io/badge/Blog-555?style=flat&logo=substack&logoColor=white" alt="Substack Blog"></a>
<a href="https://kilo.ai/discord"><img src="https://raster.shields.io/badge/Join%20Discord-5865F2?style=flat&logo=discord&logoColor=white" alt="Discord"></a>
<a href="https://www.reddit.com/r/kilocode/"><img src="https://raster.shields.io/badge/Join%20r%2Fkilocode-D84315?style=flat&logo=reddit&logoColor=white" alt="Reddit"></a>
</p>
# 🚀 Kilo
@@ -84,7 +84,7 @@ For most users:
- **Windows (most PCs):** `kilo-windows-x64.zip`
- **macOS Apple Silicon:** `kilo-darwin-arm64.zip`
- **macOS Intel:** `kilo-darwin-x64.zip`
- **Linux x64:** `kilo-linux-x64.tar,gz`
- **Linux x64:** `kilo-linux-x64.tar.gz`
- **Linux on ARM:** `kilo-linux-arm64.tar.gz`
### Autonomous Mode (CI/CD)
bun.lock
+26 -20
View File
@@ -27,7 +27,7 @@
},
"packages/app": {
"name": "@opencode-ai/app",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@kilocode/kilo-i18n": "workspace:*",
"@kilocode/kilo-ui": "workspace:*",
@@ -79,7 +79,7 @@
},
"packages/desktop": {
"name": "@opencode-ai/desktop",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@opencode-ai/app": "workspace:*",
"@opencode-ai/ui": "workspace:*",
@@ -112,7 +112,7 @@
},
"packages/desktop-electron": {
"name": "@opencode-ai/desktop-electron",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@opencode-ai/app": "workspace:*",
"@opencode-ai/ui": "workspace:*",
@@ -142,7 +142,7 @@
},
"packages/kilo-docs": {
"name": "@kilocode/kilo-docs",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@docsearch/css": "^4",
"@docsearch/js": "^4",
@@ -171,10 +171,10 @@
},
"packages/kilo-gateway": {
"name": "@kilocode/kilo-gateway",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@ai-sdk/anthropic": "2.0.65",
"@ai-sdk/openai": "2.0.89",
"@ai-sdk/openai": "2.0.101",
"@ai-sdk/openai-compatible": "1.0.32",
"@clack/prompts": "1.0.0-alpha.1",
"@kilocode/plugin": "workspace:*",
@@ -206,7 +206,7 @@
},
"packages/kilo-i18n": {
"name": "@kilocode/kilo-i18n",
"version": "7.1.5",
"version": "7.1.17",
"devDependencies": {
"@tsconfig/node22": "catalog:",
"@types/bun": "catalog:",
@@ -216,7 +216,7 @@
},
"packages/kilo-telemetry": {
"name": "@kilocode/kilo-telemetry",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@kilocode/kilo-gateway": "workspace:*",
"@opentelemetry/api": "1.9.0",
@@ -236,7 +236,7 @@
},
"packages/kilo-ui": {
"name": "@kilocode/kilo-ui",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@kobalte/core": "0.13.11",
"@opencode-ai/util": "workspace:*",
@@ -271,7 +271,7 @@
},
"packages/kilo-vscode": {
"name": "kilo-code",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@anthropic-ai/sdk": "^0.39.0",
"@kilocode/kilo-i18n": "workspace:*",
@@ -324,7 +324,7 @@
},
"packages/opencode": {
"name": "@kilocode/cli",
"version": "7.1.5",
"version": "7.1.17",
"bin": {
"kilo": "./bin/kilo",
"kilocode": "./bin/kilo",
@@ -344,7 +344,7 @@
"@ai-sdk/google-vertex": "3.0.106",
"@ai-sdk/groq": "2.0.34",
"@ai-sdk/mistral": "2.0.27",
"@ai-sdk/openai": "2.0.89",
"@ai-sdk/openai": "2.0.101",
"@ai-sdk/openai-compatible": "1.0.32",
"@ai-sdk/perplexity": "2.0.23",
"@ai-sdk/provider": "2.0.1",
@@ -447,7 +447,7 @@
},
"packages/plugin": {
"name": "@kilocode/plugin",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@kilocode/sdk": "workspace:*",
"zod": "catalog:",
@@ -461,14 +461,14 @@
},
"packages/script": {
"name": "@opencode-ai/script",
"version": "7.1.5",
"version": "7.1.17",
"devDependencies": {
"@types/bun": "catalog:",
},
},
"packages/sdk/js": {
"name": "@kilocode/sdk",
"version": "7.1.5",
"version": "7.1.17",
"devDependencies": {
"@hey-api/openapi-ts": "0.90.10",
"@tsconfig/node22": "catalog:",
@@ -479,7 +479,7 @@
},
"packages/storybook": {
"name": "@opencode-ai/storybook",
"version": "7.1.5",
"version": "7.1.17",
"devDependencies": {
"@opencode-ai/ui": "workspace:*",
"@solidjs/meta": "catalog:",
@@ -502,7 +502,7 @@
},
"packages/ui": {
"name": "@opencode-ai/ui",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"@kilocode/sdk": "workspace:*",
"@kobalte/core": "catalog:",
@@ -549,7 +549,7 @@
},
"packages/util": {
"name": "@opencode-ai/util",
"version": "7.1.5",
"version": "7.1.17",
"dependencies": {
"zod": "catalog:",
},
@@ -666,7 +666,7 @@
"@ai-sdk/mistral": ["@ai-sdk/mistral@2.0.27", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@ai-sdk/provider-utils": "3.0.20" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-gaptHgaXjMw3+eA0Q4FABcsj5nQNP6EpFaGUR+Pj5WJy7Kn6mApl975/x57224MfeJIShNpt8wFKK3tvh5ewKg=="],
"@ai-sdk/openai": ["@ai-sdk/openai@2.0.89", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@ai-sdk/provider-utils": "3.0.20" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-4+qWkBCbL9HPKbgrUO/F2uXZ8GqrYxHa8SWEYIzxEJ9zvWw3ISr3t1/27O1i8MGSym+PzEyHBT48EV4LAwWaEw=="],
"@ai-sdk/openai": ["@ai-sdk/openai@2.0.101", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@ai-sdk/provider-utils": "3.0.22" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-kQ52HLV45T3bQbRzWExXW6+pkg3Nvq4dUnZHUPJXWgkUUsAhZjxHrXqPOc/0yfn/4+Dn2uLmIgAkP9IfzMMcNg=="],
"@ai-sdk/openai-compatible": ["@ai-sdk/openai-compatible@1.0.32", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@ai-sdk/provider-utils": "3.0.20" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-YspqqyJPzHjqWrjt4y/Wgc2aJgCcQj5uIJgZpq2Ar/lH30cEVhgE+keePDbjKpetD9UwNggCj7u6kO3unS23OQ=="],
@@ -4364,6 +4364,8 @@
"@ai-sdk/amazon-bedrock/aws4fetch": ["aws4fetch@1.0.20", "", {}, "sha512-/djoAN709iY65ETD6LKCtyyEI04XIBP5xVvfmNxsEP0uJB5tyaGBztSryRr4HqMStr9R06PisQE7m9zDTXKu6g=="],
"@ai-sdk/azure/@ai-sdk/openai": ["@ai-sdk/openai@2.0.89", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@ai-sdk/provider-utils": "3.0.20" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-4+qWkBCbL9HPKbgrUO/F2uXZ8GqrYxHa8SWEYIzxEJ9zvWw3ISr3t1/27O1i8MGSym+PzEyHBT48EV4LAwWaEw=="],
"@ai-sdk/azure/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.20", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-iXHVe0apM2zUEzauqJwqmpC37A5rihrStAih5Ks+JE32iTe4LZ58y17UGBjpQQTCRw9YxMeo2UFLxLpBluyvLQ=="],
"@ai-sdk/cerebras/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.20", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-iXHVe0apM2zUEzauqJwqmpC37A5rihrStAih5Ks+JE32iTe4LZ58y17UGBjpQQTCRw9YxMeo2UFLxLpBluyvLQ=="],
@@ -4388,7 +4390,7 @@
"@ai-sdk/mistral/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.20", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-iXHVe0apM2zUEzauqJwqmpC37A5rihrStAih5Ks+JE32iTe4LZ58y17UGBjpQQTCRw9YxMeo2UFLxLpBluyvLQ=="],
"@ai-sdk/openai/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.20", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-iXHVe0apM2zUEzauqJwqmpC37A5rihrStAih5Ks+JE32iTe4LZ58y17UGBjpQQTCRw9YxMeo2UFLxLpBluyvLQ=="],
"@ai-sdk/openai/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.22", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-fFT1KfUUKktfAFm5mClJhS1oux9tP2qgzmEZVl5UdwltQ1LO/s8hd7znVrgKzivwv1s1FIPza0s9OpJaNB/vHw=="],
"@ai-sdk/openai-compatible/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.20", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-iXHVe0apM2zUEzauqJwqmpC37A5rihrStAih5Ks+JE32iTe4LZ58y17UGBjpQQTCRw9YxMeo2UFLxLpBluyvLQ=="],
@@ -4842,6 +4844,8 @@
"ai-gateway-provider/@ai-sdk/google-vertex": ["@ai-sdk/google-vertex@3.0.90", "", { "dependencies": { "@ai-sdk/anthropic": "2.0.56", "@ai-sdk/google": "2.0.46", "@ai-sdk/provider": "2.0.0", "@ai-sdk/provider-utils": "3.0.19", "google-auth-library": "^10.5.0" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-C9MLe1KZGg1ZbupV2osygHtL5qngyCDA6ATatunyfTbIe8TXKG8HGni/3O6ifbnI5qxTidIn150Ox7eIFZVMYg=="],
"ai-gateway-provider/@ai-sdk/openai": ["@ai-sdk/openai@2.0.89", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@ai-sdk/provider-utils": "3.0.20" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-4+qWkBCbL9HPKbgrUO/F2uXZ8GqrYxHa8SWEYIzxEJ9zvWw3ISr3t1/27O1i8MGSym+PzEyHBT48EV4LAwWaEw=="],
"ajv-keywords/ajv": ["ajv@6.14.0", "", { "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" } }, "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw=="],
"anymatch/picomatch": ["picomatch@2.3.1", "", {}, "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA=="],
@@ -5606,6 +5610,8 @@
"ai-gateway-provider/@ai-sdk/google-vertex/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.19", "", { "dependencies": { "@ai-sdk/provider": "2.0.0", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-W41Wc9/jbUVXVwCN/7bWa4IKe8MtxO3EyA0Hfhx6grnmiYlCvpI8neSYWFE0zScXJkgA/YK3BRybzgyiXuu6JA=="],
"ai-gateway-provider/@ai-sdk/openai/@ai-sdk/provider-utils": ["@ai-sdk/provider-utils@3.0.20", "", { "dependencies": { "@ai-sdk/provider": "2.0.1", "@standard-schema/spec": "^1.0.0", "eventsource-parser": "^3.0.6" }, "peerDependencies": { "zod": "^3.25.76 || ^4.1.8" } }, "sha512-iXHVe0apM2zUEzauqJwqmpC37A5rihrStAih5Ks+JE32iTe4LZ58y17UGBjpQQTCRw9YxMeo2UFLxLpBluyvLQ=="],
"ajv-keywords/ajv/json-schema-traverse": ["json-schema-traverse@0.4.1", "", {}, "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="],
"app-builder-lib/@electron/get/fs-extra": ["fs-extra@8.1.0", "", { "dependencies": { "graceful-fs": "^4.2.0", "jsonfile": "^4.0.0", "universalify": "^0.1.0" } }, "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g=="],
nix/hashes.json
+4 -4
View File
@@ -1,8 +1,8 @@
{
"nodeModules": {
"x86_64-linux": "sha256-85Pa4C5F3yqjMzIGBcWYGe+IitSg9nnTtixqZPRnFps=",
"aarch64-linux": "sha256-qeyu0LS1z8JXGa+2EVd/U94uQIV8zi53ZmymE9/trSU=",
"aarch64-darwin": "sha256-qwedJnAMcM/gTVSCTErsP++HM2lYQtLE+PM1QkT7fy8=",
"x86_64-darwin": "sha256-372zLuwN6TLhn4JIDorEc13mjMpC91UbukxE/Y14c/k="
"x86_64-linux": "sha256-YjB3YfaA79nztpZoYEAlFBakS//G/Guprlqk4BYFgOA=",
"aarch64-linux": "sha256-ru470M8RVwyOPNGr6I4VfApQRHhYFFMPjOBneTRBJtc=",
"aarch64-darwin": "sha256-M6LIPBHnYH9AtIRAKyW44VN71Kb28nztzFteCkL0588=",
"x86_64-darwin": "sha256-HURoot79BFHYwoEp0XqVdI6cRdV7KGvmRRqOf+hUa9Q="
}
}
package.json
+1 -1
View File
@@ -112,6 +112,6 @@
"@openrouter/ai-sdk-provider@1.5.4": "patches/@openrouter%2Fai-sdk-provider@1.5.4.patch",
"ghostty-web@0.3.0": "patches/ghostty-web@0.3.0.patch"
},
"version": "7.1.5",
"version": "7.1.17",
"peerDependencies": {}
}
packages/app/package.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@opencode-ai/app",
"version": "7.1.5",
"version": "7.1.17",
"description": "",
"type": "module",
"exports": {
packages/desktop-electron/package.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "@opencode-ai/desktop-electron",
"private": true,
"version": "7.1.5",
"version": "7.1.17",
"type": "module",
"license": "MIT",
"homepage": "https://opencode.ai",
packages/desktop/package.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "@opencode-ai/desktop",
"private": true,
"version": "7.1.5",
"version": "7.1.17",
"type": "module",
"license": "MIT",
"scripts": {
packages/extensions/zed/extension.toml
+6 -6
View File
@@ -1,7 +1,7 @@
id = "kilo"
name = "Kilo"
description = "The open source coding agent."
version = "7.1.5"
version = "7.1.17"
schema_version = 1
authors = ["Anomaly"]
repository = "https://github.com/Kilo-Org/kilocode"
@@ -11,26 +11,26 @@ name = "Kilo"
icon = "./icons/opencode.svg"
[agent_servers.opencode.targets.darwin-aarch64]
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.5/opencode-darwin-arm64.zip"
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.17/opencode-darwin-arm64.zip"
cmd = "./opencode"
args = ["acp"]
[agent_servers.opencode.targets.darwin-x86_64]
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.5/opencode-darwin-x64.zip"
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.17/opencode-darwin-x64.zip"
cmd = "./opencode"
args = ["acp"]
[agent_servers.opencode.targets.linux-aarch64]
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.5/opencode-linux-arm64.tar.gz"
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.17/opencode-linux-arm64.tar.gz"
cmd = "./opencode"
args = ["acp"]
[agent_servers.opencode.targets.linux-x86_64]
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.5/opencode-linux-x64.tar.gz"
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.17/opencode-linux-x64.tar.gz"
cmd = "./opencode"
args = ["acp"]
[agent_servers.opencode.targets.windows-x86_64]
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.5/opencode-windows-x64.zip"
archive = "https://github.com/Kilo-Org/kilocode/releases/download/v7.1.17/opencode-windows-x64.zip"
cmd = "./opencode.exe"
args = ["acp"]
packages/kilo-docs/lib/nav/automate.ts
+3 -2
View File
@@ -29,6 +29,7 @@ export const AutomateNav: NavSection[] = [
{
href: "/automate/extending/auto-launch",
children: "Auto-launch Configuration",
platform: "legacy",
},
{
href: "/automate/mcp/overview",
@@ -53,8 +54,8 @@ export const AutomateNav: NavSection[] = [
{
title: "Tools",
links: [
{ href: "/automate/how-tools-work", children: "How Tools Work" },
{ href: "/automate/tools", children: "Tools Details" },
{ href: "/automate/how-tools-work", children: "How Tools Work", platform: "legacy" },
{ href: "/automate/tools", children: "Tools Details", platform: "legacy" },
],
},
]
packages/kilo-docs/lib/nav/code-with-ai.ts
+3 -3
View File
@@ -41,10 +41,10 @@ export const CodeWithAiNav: NavSection[] = [
children: "Free & Budget Models",
},
{
href: "/code-with-ai/agents/using-modes",
children: "Modes",
href: "/code-with-ai/agents/using-agents",
children: "Agents",
subLinks: [
{ href: "/code-with-ai/agents/using-modes", children: "Using Modes" },
{ href: "/code-with-ai/agents/using-agents", children: "Using Agents" },
{
href: "/code-with-ai/agents/orchestrator-mode",
children: "Orchestrator Mode",
packages/kilo-docs/lib/nav/contributing.ts
-4
View File
@@ -13,10 +13,6 @@ export const ContributingNav: NavSection[] = [
href: "/contributing/ecosystem",
children: "Ecosystem",
},
{
href: "/contributing/cline-to-kilo-migration",
children: "Cline to Kilo Migration",
},
],
},
{
packages/kilo-docs/lib/nav/customize.ts
+4 -1
View File
@@ -20,9 +20,10 @@ export const CustomizeNav: NavSection[] = [
{
href: "/customize/custom-subagents",
children: "Custom Subagents",
platform: "new",
},
{ href: "/customize/agents-md", children: "agents.md" },
{ href: "/customize/workflows", children: "Workflows" },
{ href: "/customize/workflows", children: "Workflows", platform: "new" },
{ href: "/customize/skills", children: "Skills" },
{
href: "/customize/prompt-engineering",
@@ -36,6 +37,7 @@ export const CustomizeNav: NavSection[] = [
{
href: "/customize/context/codebase-indexing",
children: "Codebase Indexing",
platform: "legacy",
},
{
href: "/customize/context/context-condensing",
@@ -48,6 +50,7 @@ export const CustomizeNav: NavSection[] = [
{
href: "/customize/context/large-projects",
children: "Large Projects",
platform: "legacy",
},
],
},
packages/kilo-docs/lib/nav/kiloclaw.ts
+58 -6
View File
@@ -7,19 +7,71 @@ export const KiloClawNav: NavSection[] = [
{ href: "/kiloclaw/overview", children: "Overview" },
{ href: "/kiloclaw/dashboard", children: "Dashboard" },
{ href: "/kiloclaw/pre-installed-software", children: "Pre-installed Software" },
{ href: "/kiloclaw/control-ui", children: "Control UI" },
{ href: "/kiloclaw/chat-platforms", children: "Chat Platforms" },
{ href: "/kiloclaw/end-to-end", children: "End to End Config" },
{
href: "/kiloclaw/development-tools/github",
href: "/kiloclaw/control-ui/overview",
children: "Control UI",
subLinks: [
{ href: "/kiloclaw/control-ui/overview", children: "Overview" },
{ href: "/kiloclaw/control-ui/changing-models", children: "Changing Models" },
{ href: "/kiloclaw/control-ui/exec-approvals", children: "Exec Approvals" },
{ href: "/kiloclaw/control-ui/version-pinning", children: "Version Pinning" },
],
},
{
href: "/kiloclaw/chat-platforms",
children: "Chat Platforms",
subLinks: [
{ href: "/kiloclaw/chat-platforms", children: "Overview" },
{ href: "/kiloclaw/chat-platforms/telegram", children: "Telegram" },
{ href: "/kiloclaw/chat-platforms/discord", children: "Discord" },
{ href: "/kiloclaw/chat-platforms/slack", children: "Slack" },
],
},
{
href: "/kiloclaw/development-tools",
children: "Development Tools",
subLinks: [
{ href: "/kiloclaw/development-tools", children: "Overview" },
{ href: "/kiloclaw/development-tools/github", children: "GitHub" },
{ href: "/kiloclaw/development-tools/google", children: "Google Workspace" },
],
},
{ href: "/kiloclaw/version-pinning", children: "Version Pinning" },
{ href: "/kiloclaw/troubleshooting", children: "Troubleshooting" },
{ href: "/kiloclaw/pricing", children: "Pricing" },
{
href: "/kiloclaw/triggers",
children: "Triggers",
subLinks: [
{ href: "/kiloclaw/triggers", children: "Overview" },
{ href: "/kiloclaw/triggers/webhooks", children: "Webhooks" },
],
},
{
href: "/kiloclaw/tools",
children: "Tools",
subLinks: [
{ href: "/kiloclaw/tools", children: "Overview" },
{ href: "/kiloclaw/tools/1password", children: "1Password" },
{ href: "/kiloclaw/tools/brave-search", children: "Brave Search" },
{ href: "/kiloclaw/tools/agentcard", children: "AgentCard" },
],
},
{
href: "/kiloclaw/troubleshooting/common-questions",
children: "Troubleshooting",
subLinks: [
{ href: "/kiloclaw/troubleshooting/common-questions", children: "Common Questions" },
{ href: "/kiloclaw/troubleshooting/gateway-process", children: "Gateway Process States" },
{ href: "/kiloclaw/troubleshooting/architecture", children: "Architecture Notes" },
],
},
{
href: "/kiloclaw/faq/general",
children: "FAQ",
subLinks: [
{ href: "/kiloclaw/faq/general", children: "General" },
{ href: "/kiloclaw/faq/pricing", children: "Pricing" },
],
},
],
},
]
packages/kilo-docs/lychee.toml
+4
View File
@@ -32,4 +32,8 @@ exclude = [
'^https?://github\.com/',
# Redirects to login page, blocked by bots
'^https?://vercel\.link/',
# API base URL, returns 404 when fetched directly
'^https?://api\.apertis\.ai/v1/?$',
# Redirects to authenticated Google Cloud console
'^https?://console\.cloud\.google\.com',
]
packages/kilo-docs/markdoc/partials/install-jetbrains.md
+1 -1
View File
@@ -18,7 +18,7 @@ Before installing the Kilo Code plugin, ensure you have:
1. If you don't have a JetBrains IDE installed, download one from [jetbrains.com](https://www.jetbrains.com/)
2. Then, you can click the button below to install Kilo Code directly from the JetBrains Marketplace:
[![Install Kilo Code](https://img.shields.io/badge/Install%20Kilo%20Code-F8F674?style=for-the-badge)](https://plugins.jetbrains.com/plugin/28350-kilo-code)
[![Install Kilo Code](https://raster.shields.io/badge/Install%20Kilo%20Code-F8F674?style=for-the-badge)](https://plugins.jetbrains.com/plugin/28350-kilo-code)
### Install from JetBrains Marketplace
packages/kilo-docs/markdoc/partials/install-vscode.md
+1 -1
View File
@@ -3,7 +3,7 @@
1. If you don't have VS Code installed, download it from [code.visualstudio.com](https://code.visualstudio.com/)
2. Then, you can click the button below to install Kilo Code directly from the VS Code Marketplace:
[![Install Kilo Code](https://img.shields.io/badge/Install%20Kilo%20Code-F8F674?style=for-the-badge)](vscode:extension/kilocode.kilo-code)
[![Install Kilo Code](https://raster.shields.io/badge/Install%20Kilo%20Code-F8F674?style=for-the-badge)](vscode:extension/kilocode.kilo-code)
### Install from VS Code Marketplace
packages/kilo-docs/package.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@kilocode/kilo-docs",
"version": "7.1.5",
"version": "7.1.17",
"private": true,
"scripts": {
"dev": "next dev --webpack --port 3002",
packages/kilo-docs/pages/ai-providers/anthropic.md
+44
View File
@@ -17,12 +17,56 @@ Anthropic is an AI safety and research company that builds reliable, interpretab
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Anthropic" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Anthropic API key into the "Anthropic API Key" field.
4. **Select Model:** Choose your desired Claude model from the "Model" dropdown.
5. **(Optional) Custom Base URL:** If you need to use a custom base URL for the Anthropic API, check "Use custom base URL" and enter the URL. Most people won't need to adjust this.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Anthropic and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export ANTHROPIC_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"anthropic": {
"env": ["ANTHROPIC_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "anthropic/claude-sonnet-4-20250514",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Prompt Caching:** Claude 3 models support [prompt caching](https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching), which can significantly reduce costs and latency for repeated prompts.
packages/kilo-docs/pages/ai-providers/bedrock.md
+50
View File
@@ -34,6 +34,9 @@ You have three options for configuring AWS credentials:
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Bedrock" from the "API Provider" dropdown.
3. **Select Authentication Method:**
@@ -48,6 +51,53 @@ You have three options for configuring AWS credentials:
5. **(Optional) Cross-Region Inference:** Check "Use cross-region inference" if you want to access models in a region different from your configured AWS region.
6. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add AWS Bedrock. The extension uses the AWS credentials chain for authentication — configure your AWS credentials using the AWS CLI or environment variables before adding the provider.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Bedrock uses the AWS credentials chain for authentication. Configure your AWS credentials using the AWS CLI or environment variables:
**Environment variables:**
```bash
export AWS_ACCESS_KEY_ID="your-access-key"
export AWS_SECRET_ACCESS_KEY="your-secret-key"
export AWS_REGION="us-east-1"
```
Or use an AWS profile:
```bash
aws configure --profile bedrock
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"amazon-bedrock": {},
},
}
```
Then set your default model:
```jsonc
{
"model": "amazon-bedrock/anthropic.claude-sonnet-4-20250514-v1:0",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Permissions:** Ensure your IAM user or role has the necessary permissions to invoke Bedrock models. The `bedrock:InvokeModel` permission is required.
packages/kilo-docs/pages/ai-providers/cerebras.md
+44
View File
@@ -17,11 +17,55 @@ Cerebras is known for their ultra-fast AI inference powered by the Cerebras CS-3
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Cerebras" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Cerebras API key into the "Cerebras API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Cerebras and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export CEREBRAS_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"cerebras": {
"env": ["CEREBRAS_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "cerebras/llama-4-scout-17b-16e-instruct",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Inference Speed:** Cerebras models deliver some of the fastest inference speeds available, reducing wait times during development.
packages/kilo-docs/pages/ai-providers/chutes-ai.md
+44
View File
@@ -20,11 +20,55 @@ Always refer to the official Chutes AI documentation or your dashboard for the m
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Chutes AI" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Chutes AI API key into the "Chutes AI API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Chutes AI and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export CHUTES_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"chutes": {
"env": ["CHUTES_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "chutes/model-name",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Free Access:** Chutes AI provides free API access, making it an excellent option for experimentation and development without immediate costs.
packages/kilo-docs/pages/ai-providers/claude-code.md
+49
View File
@@ -34,11 +34,60 @@ The specific models available depend on your Claude subscription and plan. See [
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Claude Code" from the "API Provider" dropdown.
3. **Select Model:** Choose your desired Claude model from the "Model" dropdown.
4. **(Optional) Custom CLI Path:** If you installed Claude Code to a location other than the default `claude` command, enter the full path to your Claude executable in the "Claude Code Path" field. Most users won't need to change this.
{% /tab %}
{% tab label="VSCode" %}
{% callout type="warning" %}
Claude Code credentials no longer work in Kilo Code. Please use the [Anthropic provider](/docs/ai-providers/anthropic) with an API key instead.
{% /callout %}
{% /tab %}
{% tab label="CLI" %}
Claude Code uses your existing Anthropic credentials (from the `claude` CLI). Make sure the Claude Code CLI is installed and authenticated:
```bash
claude --version
claude auth login
```
If you have an `ANTHROPIC_API_KEY` environment variable set, the Claude CLI will use it automatically:
```bash
export ANTHROPIC_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"anthropic": {
"env": ["ANTHROPIC_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "anthropic/claude-sonnet-4-20250514",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **No API Keys Required:** Claude Code uses your existing CLI authentication, so you don't need to manage separate API keys.
packages/kilo-docs/pages/ai-providers/deepseek.md
+44
View File
@@ -17,11 +17,55 @@ Kilo Code supports accessing models through the DeepSeek API, including `deepsee
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "DeepSeek" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your DeepSeek API key into the "DeepSeek API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add DeepSeek and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export DEEPSEEK_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"deepseek": {
"env": ["DEEPSEEK_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "deepseek/deepseek-chat",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Pricing:** Refer to the [DeepSeek Pricing](https://api-docs.deepseek.com/quick_start/pricing/) page for details on model costs.
packages/kilo-docs/pages/ai-providers/fireworks.md
+44
View File
@@ -17,11 +17,55 @@ Fireworks AI is a high-performance platform for running AI models that offers fa
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Fireworks AI" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Fireworks AI API key into the "Fireworks AI API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Fireworks AI and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export FIREWORKS_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"fireworks-ai": {
"env": ["FIREWORKS_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "fireworks-ai/accounts/fireworks/models/llama4-scout-instruct-basic",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Performance:** Fireworks AI is optimized for speed and offers excellent performance for both chat and completion tasks.
packages/kilo-docs/pages/ai-providers/gemini.md
+44
View File
@@ -17,11 +17,55 @@ Kilo Code supports Google's Gemini family of models through the Google AI Gemini
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Google Gemini" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Gemini API key into the "Gemini API Key" field.
4. **Select Model:** Choose your desired Gemini model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Google Gemini and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export GOOGLE_GENERATIVE_AI_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"google": {
"env": ["GOOGLE_GENERATIVE_AI_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "google/gemini-2.5-pro",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Pricing:** Gemini API usage is priced based on input and output tokens. Refer to the [Gemini pricing page](https://ai.google.dev/pricing) for detailed information.
packages/kilo-docs/pages/ai-providers/glama.md
+20
View File
@@ -26,11 +26,31 @@ Refer to the [Glama documentation](https://glama.ai/models) for the most up-to-d
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Glama" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Glama API key into the "Glama API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Glama and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
{% callout type="warning" %}
Glama is not yet available as a CLI provider. Check the [Kilo Code releases](https://github.com/Kilo-Org/kilocode/releases) for updates on provider support.
{% /callout %}
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Pricing:** Glama operates on a pay-per-use basis. Pricing varies depending on the model you choose.
packages/kilo-docs/pages/ai-providers/groq.md
+42 -12
View File
@@ -20,17 +20,54 @@ Kilo Code will attempt to fetch the list of available models from the Groq API.
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Groq" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Groq API key into the "Groq API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
## Tips and Notes
{% /tab %}
{% tab label="VSCode" %}
- **High-Speed Inference:** Groq's LPUs provide exceptionally fast response times, making it ideal for interactive development workflows.
- **Token Limits:** Some models have specific `max_tokens` limits that are automatically handled by Kilo Code (e.g., the `moonshotai/kimi-k2-instruct` model).
- **Cost Efficiency:** Groq often provides competitive pricing for high-speed inference compared to other providers.
- **Model Selection:** Choose models based on your specific needs - larger models like `llama3-70b-8192` for complex reasoning tasks, or smaller models like `llama3-8b-8192` for faster, simpler operations.
Open **Settings** (gear icon) and go to the **Providers** tab to add Groq and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export GROQ_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"groq": {
"env": ["GROQ_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "groq/llama-3.3-70b-versatile",
}
```
{% /tab %}
{% /tabs %}
## Supported Models
@@ -46,13 +83,6 @@ Kilo Code supports the following models through Groq:
**Note:** Model availability may change. Refer to the [Groq documentation](https://console.groq.com/docs/models) for the latest model list and specifications.
## Configuration in Kilo Code
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Groq" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Groq API key into the "Groq API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
## Model-Specific Features
### Kimi K2 Model
packages/kilo-docs/pages/ai-providers/inception.md
+44
View File
@@ -23,11 +23,55 @@ Refer to Inception's current website and developer documentation for the most up
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Inception" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Inception API key into the "Inception API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Inception and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export INCEPTION_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"inception": {
"env": ["INCEPTION_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "inception/mercury-coder-small-beta",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Enterprise Focus:** Inception is designed for production-grade AI applications with emphasis on reliability and consistency.
packages/kilo-docs/pages/ai-providers/index.md
+1 -5
View File
@@ -58,11 +58,7 @@ Route requests through unified APIs with additional features:
- **Regional** - Better latency in certain locations
{% callout type="note" %}
All API keys use VS Code's Secret Storage—never stored in plain text.
{% /callout %}
{% callout type="warning" title="Time-to-first-byte timeout" %}
For all providers, there is a **five-minute timeout** on time to first token. This means if a provider does not begin streaming a response within five minutes of the request being sent, the request will be cancelled. This is a constraint of the Bun runtime and cannot be easily configured.
In the **VSCode (Legacy)** version, API keys use VS Code's Secret Storage. In the current **VSCode & CLI** version, keys are set via environment variables or referenced in `kilo.json` config files. See individual provider pages for setup instructions for each platform.
{% /callout %}
## Next Steps
packages/kilo-docs/pages/ai-providers/lmstudio.md
+38
View File
@@ -27,12 +27,50 @@ Kilo Code supports running models locally using LM Studio. LM Studio provides a
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "LM Studio" from the "API Provider" dropdown.
3. **Enter Model ID:** Enter the _file name_ of the model you loaded in LM Studio (e.g., `codellama-7b.Q4_0.gguf`). You can find this in the LM Studio "Local Server" tab.
4. **(Optional) Base URL:** By default, Kilo Code will connect to LM Studio at `http://localhost:1234`. If you've configured LM Studio to use a different address or port, enter the full URL here.
5. **(Optional) Timeout:** By default, API requests time out after 10 minutes. Local models can be slow, if you hit this timeout you can consider increasing it here: VS Code Extensions panel > Kilo Code gear menu > Settings > API Request Timeout.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add LM Studio. No API key is needed since LM Studio runs locally. You can configure the base URL if LM Studio is running on a different host or port.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
LM Studio runs locally, so no API key is needed. Configure the base URL if LM Studio is running on a different host or port:
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"lmstudio": {
"baseURL": "http://localhost:1234/v1",
},
},
}
```
Then set your default model:
```jsonc
{
"model": "lmstudio/codellama-7b",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Resource Requirements:** Running large language models locally can be resource-intensive. Make sure your computer meets the minimum requirements for the model you choose.
packages/kilo-docs/pages/ai-providers/minimax.md
+44
View File
@@ -17,11 +17,55 @@ MiniMax is a global AI foundation model company focused on fast, cost-efficient
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Navigate to **Providers**. Choose **MiniMax** from the API Provider dropdown.
3. **Enter API Key:** Paste your MiniMax API key into the MiniMax API Key field.
4. **Select Model:** Choose your desired MiniMax model from the Model dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add MiniMax and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export MINIMAX_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"minimax": {
"env": ["MINIMAX_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "minimax/MiniMax-M1",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Performance:** MiniMax M2.1 emphasizes fast inference, strong coding ability, and exceptional tool-calling performance.
packages/kilo-docs/pages/ai-providers/mistral.md
+44
View File
@@ -17,11 +17,55 @@ Kilo Code supports accessing models through the Mistral AI API, including both s
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Mistral" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Mistral API key into the "Mistral API Key" field if you're using a `mistral` model. If you intend to use `codestral-latest`, see the "Codestral" section below.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Mistral and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export MISTRAL_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"mistral": {
"env": ["MISTRAL_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "mistral/mistral-large-latest",
}
```
{% /tab %}
{% /tabs %}
## Using Codestral
[Codestral](https://docs.mistral.ai/capabilities/code_generation/) is a model specifically designed for code generation and interaction.
packages/kilo-docs/pages/ai-providers/moonshot.md
+44
View File
@@ -17,11 +17,55 @@ Moonshot.ai is a Chinese AI company known for their **Kimi** models featuring ul
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Moonshot.ai" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Moonshot.ai API key into the "Moonshot.ai API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Moonshot.ai and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export MOONSHOT_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"moonshotai": {
"env": ["MOONSHOT_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "moonshotai/moonshot-v1-auto",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Ultra-Long Context:** Kimi models excel at handling large codebases and complex projects with their extended context windows.
packages/kilo-docs/pages/ai-providers/ollama.md
+38
View File
@@ -72,12 +72,50 @@ By default, API requests time out after 10 minutes. Local models can be slow, if
### Configure Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
- Open the Kilo Code panel ({% kiloCodeIcon size="1em" /%}).
- Click the Settings gear icon ({% codicon name="gear" /%}).
- Select "Ollama" as the API Provider.
- Select the model configured in the previous step.
- (Optional) You can configure the base URL if you're running Ollama on a different machine. The default is `http://localhost:11434`.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Ollama. No API key is needed since Ollama runs locally. You can configure the base URL if Ollama is running on a different host.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Ollama runs locally, so no API key is needed. Configure the base URL if Ollama is running on a different host:
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"ollama": {
"baseURL": "http://localhost:11434/v1",
},
},
}
```
Then set your default model:
```jsonc
{
"model": "ollama/qwen3-coder:30b",
}
```
{% /tab %}
{% /tabs %}
## Further Reading
Refer to the [Ollama documentation](https://ollama.com/docs) for more information on installing, configuring and using Ollama.
packages/kilo-docs/pages/ai-providers/openai-chatgpt-plus-pro.md
+40
View File
@@ -4,6 +4,9 @@ sidebar_label: ChatGPT Plus/Pro
# Using ChatGPT Subscriptions With Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. Open Kilo Code settings (click the gear icon {% codicon name="gear" /%} in the Kilo Code panel).
2. In **API Provider**, select **OpenAI – ChatGPT Plus/Pro**.
3. Click **Sign in to OpenAI Codex**.
@@ -11,6 +14,43 @@ sidebar_label: ChatGPT Plus/Pro
5. Back in Kilo Code settings, pick a model from the dropdown.
6. Save.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab. ChatGPT Plus/Pro uses OAuth authentication — follow the sign-in flow to connect your ChatGPT subscription.
{% /tab %}
{% tab label="CLI" %}
ChatGPT Plus/Pro uses OAuth authentication, which is only available in the VS Code extension. For the CLI, use the [OpenAI API provider](/docs/ai-providers/openai) with an API key instead:
```bash
export OPENAI_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"openai": {
"env": ["OPENAI_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "openai/gpt-4.1",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Subscription Required:** You need an active ChatGPT Plus or Pro subscription. This provider won't work with free ChatGPT accounts. See [OpenAI's ChatGPT plans](https://openai.com/chatgpt/pricing) for more information.
packages/kilo-docs/pages/ai-providers/openai-compatible.md
+45
View File
@@ -14,6 +14,9 @@ This document focuses on setting up providers _other than_ the official OpenAI A
## General Configuration
{% tabs %}
{% tab label="VSCode (Legacy)" %}
The key to using an OpenAI-compatible provider is to configure two main settings:
1. **Base URL:** This is the API endpoint for the provider. It will _not_ be `https://api.openai.com/v1` (that's for the official OpenAI API).
@@ -34,6 +37,48 @@ You'll find these settings in the Kilo Code settings panel (click the {% codicon
- Input Price
- Output Price
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add an OpenAI Compatible provider. Enter your API key and the provider's base URL.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key and base URL as environment variables or configure them in your `kilo.json` config file:
**Environment variable:**
```bash
export OPENAI_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"openai-compatible": {
"env": ["OPENAI_API_KEY"],
"baseURL": "https://api.your-provider.com/v1",
},
},
}
```
Then set your default model:
```jsonc
{
"model": "openai-compatible/model-name",
}
```
{% /tab %}
{% /tabs %}
### Full Endpoint URL Support
Kilo Code supports full endpoint URLs in the Base URL field, providing greater flexibility for provider configuration:
packages/kilo-docs/pages/ai-providers/openai.md
+44
View File
@@ -17,11 +17,55 @@ Kilo Code supports accessing models directly through the official OpenAI API.
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "OpenAI" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your OpenAI API key into the "OpenAI API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add OpenAI and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export OPENAI_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"openai": {
"env": ["OPENAI_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "openai/gpt-4.1",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Pricing:** Refer to the [OpenAI Pricing](https://openai.com/pricing) page for details on model costs.
packages/kilo-docs/pages/ai-providers/openrouter.md
+44
View File
@@ -16,12 +16,56 @@ OpenRouter is an AI platform that provides access to a wide variety of language
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "OpenRouter" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your OpenRouter API key into the "OpenRouter API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
5. **(Optional) Custom Base URL:** If you need to use a custom base URL for the OpenRouter API, check "Use custom base URL" and enter the URL. Leave this blank for most users.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add OpenRouter and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export OPENROUTER_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"openrouter": {
"env": ["OPENROUTER_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "openrouter/anthropic/claude-sonnet-4-20250514",
}
```
{% /tab %}
{% /tabs %}
## Supported Transforms
OpenRouter provides an [optional "middle-out" message transform](https://openrouter.ai/docs/features/message-transforms) to help with prompts that exceed the maximum context size of a model. You can enable it by checking the "Compress prompts and message chains to the context size" box.
packages/kilo-docs/pages/ai-providers/ovhcloud.md
+44
View File
@@ -24,7 +24,51 @@ You can report any bugs or feedbacks by chatting with us in our [Discord server]
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "OVHcloud AI Endpoints" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your AI Endpoints API key into the "OVHcloud AI Endpoints API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add OVHcloud AI Endpoints and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export OVHCLOUD_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"ovhcloud": {
"env": ["OVHCLOUD_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "ovhcloud/model-name",
}
```
{% /tab %}
{% /tabs %}
packages/kilo-docs/pages/ai-providers/requesty.md
+44
View File
@@ -15,11 +15,55 @@ Kilo Code supports accessing models through the [Requesty](https://www.requesty.
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Requesty" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Requesty API key into the "Requesty API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Requesty and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export REQUESTY_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"requesty": {
"env": ["REQUESTY_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "requesty/anthropic/claude-sonnet-4-20250514",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Optimizations**: Requesty offers range of in-flight cost optimizations to lower your costs.
packages/kilo-docs/pages/ai-providers/sap-ai-core.md
+44
View File
@@ -77,6 +77,9 @@ The exact list of available models depends on your SAP AI Core configuration and
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "SAP AI Core" from the "API Provider" dropdown.
3. **Enter Credentials:**
@@ -91,6 +94,47 @@ The exact list of available models depends on your SAP AI Core configuration and
5. **Select Model:** Choose your desired model from the dropdown
6. **Select Deployment:** (Foundation Models Mode only) Choose an active deployment for your selected model
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add SAP AI Core. Enter your OAuth2 client credentials (Client ID, Client Secret, Base URL, and Auth URL) in the provider settings.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
SAP AI Core uses OAuth2 client credentials for authentication. Set the credentials as environment variables or in your config file:
**Environment variables:**
```bash
export AICORE_SERVICE_KEY='{"your": "service-key-json"}'
export AICORE_DEPLOYMENT_ID="your-deployment-id"
export AICORE_RESOURCE_GROUP="your-resource-group"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"sap-ai-core": {},
},
}
```
Then set your default model:
```jsonc
{
"model": "sap-ai-core/model-name",
}
```
{% /tab %}
{% /tabs %}
## Deployments (Foundation Models Mode)
When using Foundation Models mode:
packages/kilo-docs/pages/ai-providers/unbound.md
+20
View File
@@ -20,11 +20,31 @@ Unbound allows you configure a list of supported models in your application, and
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Unbound" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Unbound API key into the "Unbound API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Unbound and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
{% callout type="warning" %}
Unbound is not yet available as a CLI provider. Check the [Kilo Code releases](https://github.com/Kilo-Org/kilocode/releases) for updates on provider support.
{% /callout %}
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Security Focus:** Unbound emphasizes security features for enterprise use. If your organization has strict security requirements for AI usage, Unbound might be a good option.
packages/kilo-docs/pages/ai-providers/v0.md
+45
View File
@@ -15,6 +15,9 @@ To use v0 with Kilo Code, you'll need:
## Configuration
{% tabs %}
{% tab label="VSCode (Legacy)" %}
Setting up v0 in Kilo Code is straightforward:
1. In Kilo Code settings (click the {% codicon name="gear" /%} icon):
@@ -26,6 +29,48 @@ Setting up v0 in Kilo Code is straightforward:
<!-- <img src="/docs/img/providers/v0-setup.png" alt="v0 configuration in Kilo Code settings" width="600" /> -->
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add an OpenAI Compatible provider. Set the base URL to `https://api.v0.dev/v1` and enter your v0 API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
v0 uses the OpenAI-compatible provider. Set the API key and base URL in your config:
**Environment variable:**
```bash
export OPENAI_API_KEY="your-v0-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"openai-compatible": {
"env": ["OPENAI_API_KEY"],
"baseURL": "https://api.v0.dev/v1",
},
},
}
```
Then set your default model:
```jsonc
{
"model": "openai-compatible/v0-1.0-md",
}
```
{% /tab %}
{% /tabs %}
## Troubleshooting
- **"Invalid API Key":** Double-check that you've entered the API key correctly.
packages/kilo-docs/pages/ai-providers/vercel-ai-gateway.md
+44
View File
@@ -54,11 +54,55 @@ Check the model description in the dropdown for specific capabilities.
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "Vercel AI Gateway" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your Vercel AI Gateway API key into the "Vercel AI Gateway API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add Vercel AI Gateway and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export AI_GATEWAY_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"vercel": {
"env": ["AI_GATEWAY_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "vercel/anthropic/claude-sonnet-4",
}
```
{% /tab %}
{% /tabs %}
---
## Prompt Caching
packages/kilo-docs/pages/ai-providers/vertex.md
+47
View File
@@ -20,6 +20,9 @@ Kilo Code supports accessing models through Google Cloud Platform's Vertex AI, a
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "GCP Vertex AI" from the "API Provider" dropdown.
3. **Configure Authentication:**
@@ -31,6 +34,50 @@ Kilo Code supports accessing models through Google Cloud Platform's Vertex AI, a
5. **Select Region:** Choose the region where your Vertex AI resources are located (e.g., `us-east5`).
6. **Select Model:** Choose your desired model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add GCP Vertex AI. The extension uses Google Application Default Credentials (ADC) for authentication — run `gcloud auth application-default login` before adding the provider. Set your project ID and region in the provider settings.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Vertex AI uses Google Application Default Credentials (ADC) for authentication. Set up ADC using the Google Cloud CLI:
```bash
gcloud auth application-default login
```
Set your project and region as environment variables:
```bash
export GOOGLE_CLOUD_PROJECT="your-project-id"
export GOOGLE_CLOUD_LOCATION="us-east5"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"google-vertex": {},
},
}
```
Then set your default model:
```jsonc
{
"model": "google-vertex/claude-sonnet-4@20250514",
}
```
{% /tab %}
{% /tabs %}
## Tips and Notes
- **Permissions:** Ensure your Google Cloud account has the necessary permissions to access Vertex AI and the specific models you want to use.
packages/kilo-docs/pages/ai-providers/xai.md
+44
View File
@@ -17,11 +17,55 @@ xAI is the company behind Grok, a large language model known for its conversatio
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon ({% codicon name="gear" /%}) in the Kilo Code panel.
2. **Select Provider:** Choose "xAI" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your xAI API key into the "xAI API Key" field.
4. **Select Model:** Choose your desired Grok model from the "Model" dropdown.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add xAI and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export XAI_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"xai": {
"env": ["XAI_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "xai/grok-3",
}
```
{% /tab %}
{% /tabs %}
## Reasoning Capabilities
Some models feature specialized reasoning capabilities, allowing them to "think before responding" - particularly useful for complex problem-solving tasks.
packages/kilo-docs/pages/ai-providers/zenmux.md
+44
View File
@@ -16,12 +16,56 @@ import Codicon from "@site/src/components/Codicon";
## Configuration in Kilo Code
{% tabs %}
{% tab label="VSCode (Legacy)" %}
1. **Open Kilo Code Settings:** Click the gear icon (<Codicon name="gear" />) in the Kilo Code panel.
2. **Select Provider:** Choose "ZenMux" from the "API Provider" dropdown.
3. **Enter API Key:** Paste your ZenMux API key into the "ZenMux API Key" field.
4. **Select Model:** Choose your desired model from the "Model" dropdown.
5. **(Optional) Custom Base URL:** If you need to use a custom base URL for the ZenMux API, check "Use custom base URL" and enter the URL. Leave this blank for most users.
{% /tab %}
{% tab label="VSCode" %}
Open **Settings** (gear icon) and go to the **Providers** tab to add ZenMux and enter your API key.
The extension stores this in your `kilo.json` config file. You can also edit the config file directly — see the **CLI** tab for the file format.
{% /tab %}
{% tab label="CLI" %}
Set the API key as an environment variable or configure it in your `kilo.json` config file:
**Environment variable:**
```bash
export ZENMUX_API_KEY="your-api-key"
```
**Config file** (`~/.config/kilo/kilo.json` or `./kilo.json`):
```jsonc
{
"provider": {
"zenmux": {
"env": ["ZENMUX_API_KEY"],
},
},
}
```
Then set your default model:
```jsonc
{
"model": "zenmux/openai/gpt-5",
}
```
{% /tab %}
{% /tabs %}
## Supported Models
ZenMux supports a wide range of models from various providers:
packages/kilo-docs/pages/automate/agent-manager.md
+108 -3
View File
@@ -5,6 +5,108 @@ description: "Manage and orchestrate multiple AI agents"
# Agent Manager
The Agent Manager is a control panel for running and orchestrating multiple Kilo Code agents, with support for parallel worktree-isolated sessions.
{% tabs %}
{% tab label="VSCode" %}
The Agent Manager is a **full-panel editor tab** built directly into the extension. All sessions share the single `kilo serve` backend process. It supports:
- Multiple parallel sessions, each in its own git worktree
- A diff/review panel showing changes vs. the parent branch
- Dedicated VS Code integrated terminals per session
- Setup scripts and `.env` auto-copy on worktree creation
- Session import from existing branches, external worktrees, or GitHub PR URLs
- "Continue in Worktree" to promote a sidebar session to the Agent Manager
## Opening the Agent Manager
- Keyboard shortcut: `Cmd+Shift+M` (macOS) / `Ctrl+Shift+M` (Windows/Linux)
- Command Palette: "Kilo Code: Open Agent Manager"
- Click the Agent Manager icon in the sidebar toolbar
The panel opens as an editor tab and stays active across focus changes.
## Working with Worktrees
Each Agent Manager session runs in an isolated git worktree on a separate branch, keeping your main branch clean.
### Creating a New Worktree Session
1. Click **New Worktree** or press `Cmd+N` (macOS) / `Ctrl+N` (Windows/Linux) to create a new worktree
2. Enter a branch name (or let Kilo generate one)
3. Type your first message to start the agent
A new git worktree is created from your current branch. The agent works in isolation — your main branch is unaffected.
### Multi-Version Mode
You can run up to 4 parallel implementations of the same prompt across separate worktrees:
1. Click the multi-version button and enter a prompt
2. Optionally assign different models to each version
3. Kilo creates one worktree + session per version and runs them in parallel
### Importing Existing Work
- **From a branch:** Import an existing git branch as a worktree
- **From a GitHub PR URL:** Paste a PR URL to import it as a worktree
- **From an external worktree:** Import a worktree that already exists on disk
- **Continue in Worktree:** From the sidebar chat, promote the current session to a new Agent Manager worktree
## Sending Messages, Approvals, and Control
- **Continue the conversation:** Send a follow-up message to the running agent
- **Approvals:** The Permission Dock shows tool approval prompts — approve once, approve always, or deny
- **Cancel:** Sends a cooperative stop signal to the agent
- **Stop:** Force-terminates the session and marks it as stopped
## Diff / Review Panel
Press `Cmd+D` (macOS) / `Ctrl+D` (Windows/Linux) to toggle the diff panel. It shows a live-updating diff between the worktree and its parent branch.
- Select files and click **Apply to Main Branch** to merge changes
- Conflicts are surfaced with a resolution dialog
- Supports unified and split diff views
## Terminals
Each session has a dedicated integrated terminal. Press `Cmd+/` (macOS) / `Ctrl+/` (Windows/Linux) to focus the terminal for the active session.
## Setup Scripts
Place an executable script at `.kilo/setup-script` in your project root. It runs automatically whenever a new worktree is created (useful for `npm install`, env setup, etc.). Root-level `.env` and `.env.*` files are also auto-copied from the main repo before the setup script runs.
## Session State and Persistence
Agent Manager state is persisted in `.kilo/agent-manager.json`. Sessions, worktrees, and their order are restored on reload.
## Keyboard Shortcuts (Agent Manager Panel)
| Shortcut (macOS) | Shortcut (Windows/Linux) | Action |
| ------------------------ | ------------------------- | --------------------------------- |
| `Cmd+Shift+M` | `Ctrl+Shift+M` | Open Agent Manager |
| `Cmd+N` | `Ctrl+N` | New worktree |
| `Cmd+Shift+N` | `Ctrl+Shift+N` | New worktree (advanced options) |
| `Cmd+Shift+O` | `Ctrl+Shift+O` | Import/open worktree |
| `Cmd+Shift+W` | `Ctrl+Shift+W` | Close current worktree |
| `Cmd+T` | `Ctrl+T` | New tab (session) in worktree |
| `Cmd+W` | `Ctrl+W` | Close current tab |
| `Cmd+Alt+Up` / `Down` | `Ctrl+Alt+Up` / `Down` | Previous / next worktree |
| `Cmd+Alt+Left` / `Right` | `Ctrl+Alt+Left` / `Right` | Previous / next tab in worktree |
| `Cmd+/` | `Ctrl+/` | Show terminal for current session |
| `Cmd+D` | `Ctrl+D` | Toggle diff panel |
| `Cmd+Shift+/` | `Ctrl+Shift+/` | Show keyboard shortcuts |
| `Cmd+1` … `Cmd+9` | `Ctrl+1` … `Ctrl+9` | Jump to worktree/session by index |
## Troubleshooting
- **"Please open a folder…" error** — the Agent Manager requires a VS Code workspace folder
- **Worktree creation fails** — ensure Git is installed and the workspace is a valid git repository. Open the main repository (where `.git` is a directory), not an existing worktree checkout.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
The Agent Manager is a dedicated control panel for running and supervising Kilo Code agents as interactive CLI processes. It supports:
- Local sessions
@@ -22,7 +124,7 @@ This page reflects the actual implementation in the extension.
## Opening the Agent Manager
- Command Palette: “Kilo Code: Open Agent Manager”
- Command Palette: "Kilo Code: Open Agent Manager"
- Or use the title/menu entry if available in your Kilo Code UI
The panel opens as a webview and stays active across focus changes.
@@ -34,13 +136,13 @@ The panel opens as a webview and stays active across focus changes.
- Approve or reject, optionally adding a short note
- Cancel vs Stop
- Cancel sends a structured cancel message to the running process (clean cooperative stop)
- Stop force-terminates the underlying CLI process, updating status to “stopped”
- Stop force-terminates the underlying CLI process, updating status to "stopped"
## Resuming an existing session
You can continue a session later (local or remote):
- If a session is not currently running, the Agent Manager will spawn a new CLI process attached to that session’s ID
- If a session is not currently running, the Agent Manager will spawn a new CLI process attached to that session's ID
- Labels from the original session are preserved whenever possible
- Your first follow-up message becomes the continuation input
@@ -144,6 +246,9 @@ Message transcripts are fetched from a signed blob and exclude internal checkpoi
- Verify you're logged in via extension settings or using CLI with kilocode provider
- BYOK configurations do not support Agent Manager authentication
{% /tab %}
{% /tabs %}
## Related features
- [Sessions](/docs/collaborate/sessions-sharing)
packages/kilo-docs/pages/automate/extending/shell-integration.md
+77
View File
@@ -7,6 +7,9 @@ description: "Integrate Kilo Code with your shell environment"
Terminal Shell Integration is a key feature that enables Kilo Code to execute commands in your terminal and intelligently process their output. This bidirectional communication between the AI and your development environment unlocks powerful automation capabilities.
{% tabs %}
{% tab label="VSCode (Legacy)" %}
## What is Shell Integration?
Shell integration is automatically enabled in Kilo Code and connects directly to your terminal's command execution lifecycle without requiring any setup from you. This built-in feature allows Kilo Code to:
@@ -340,6 +343,80 @@ The [VS Code Terminal Integration Test Extension](https://github.com/KJ7LNW/vsce
- Note your environment (OS, VS Code version, shell, and any shell prompt customization)
- Open an issue with these details to help improve shell integration
{% /tab %}
{% tab label="VSCode & CLI" %}
## How Shell Execution Works
The new CLI and extension take a fundamentally different approach to shell execution. Instead of relying on VS Code's terminal shell integration, the CLI spawns and manages shell processes directly using the `bash` tool.
This means:
- **No VS Code shell integration required** — the CLI handles shell execution independently
- **No shell integration setup or troubleshooting** — it works out of the box
- **Consistent behavior** across environments — the same shell execution logic runs whether you use the CLI directly or through the VS Code extension
## The `bash` Tool
The `bash` tool is the primary way the agent executes shell commands. It spawns a persistent shell session and runs commands within it.
### Key Features
- **Working directory control**: Use the `workdir` parameter to run commands in a specific directory, instead of `cd <dir> && <command>` patterns
- **Configurable timeout**: Set a per-command timeout in milliseconds (defaults to 2 minutes)
- **Real-time output streaming**: Command output is streamed back as it's produced
- **Process tree management**: The tool manages the full process tree, ensuring child processes are properly cleaned up
### Security Analysis
Commands are parsed using **Tree-sitter** before execution, enabling:
- Path resolution to detect file access patterns
- External directory detection to flag commands that reach outside the project
- Structured analysis of command intent for safer auto-approval decisions
### Shell Detection
The CLI automatically detects the appropriate shell for your platform using `Shell.acceptable()`. This selects a compatible shell (bash, zsh, etc.) without requiring manual configuration.
## Agent Manager Terminals (VS Code Extension)
When using the Kilo Code VS Code extension with the Agent Manager, each agent session gets its own dedicated VS Code terminal.
### Per-Session Terminals
- Each session creates a terminal named **`Agent: {branch}`**, where `{branch}` is the git branch or worktree the session is working in
- The terminal's working directory is automatically set to the session's worktree directory
- Terminals are standard VS Code integrated terminals — you can interact with them directly
### Keyboard Shortcuts
| Shortcut | Action |
| --------------------------- | ---------------------------- |
| <kbd>Cmd</kbd>+<kbd>/</kbd> | Focus the session's terminal |
| <kbd>Cmd</kbd>+<kbd>.</kbd> | Cycle agent mode |
### Terminal Context Menu Actions
Right-click in an Agent Manager terminal to access these actions:
- **Add Terminal Content to Context** — sends the terminal's visible output to the agent as context
- **Fix This Command** — asks the agent to diagnose and fix the last failed command
- **Explain This Command** — asks the agent to explain what a command does
## Troubleshooting
Shell execution in the new CLI is significantly simpler than the **VSCode** version's terminal integration. Most issues are resolved by ensuring:
1. **A supported shell is installed**: bash or zsh on macOS/Linux, PowerShell on Windows
2. **The shell is on your PATH**: The CLI needs to find the shell binary
3. **File permissions are correct**: The CLI needs execute permission on the shell binary
If commands fail to execute, check the CLI's log output for error details. The CLI logs the shell it detected and any errors during command execution.
{% /tab %}
{% /tabs %}
## Support
If you've followed these steps and are still experiencing problems, please:
packages/kilo-docs/pages/automate/how-tools-work.md
+112
View File
@@ -18,6 +18,20 @@ Describe what you want to accomplish in natural language, and Kilo Code will:
## Tool Categories
{% tabs %}
{% tab label="VSCode" %}
| Category | Purpose | Tool Names |
| :------- | :----------------------------------------- | :----------------------------------------------------------- |
| Read | Access file content and code structure | `read`, `glob`, `grep` |
| Edit | Create or modify files and code | `edit`, `multiedit`, `write`, `apply_patch` |
| Execute | Run commands and perform system operations | `bash` |
| Web | Fetch and search web content | `webfetch`, `websearch`, `codesearch` |
| Workflow | Manage task flow and sub-agents | `question`, `task`, `todowrite`, `todoread`, `plan`, `skill` |
{% /tab %}
{% tab label="VSCode (Legacy)" %}
| Category | Purpose | Tool Names |
| :------- | :----------------------------------------- | :----------------------------------------------------------------------- |
| Read | Access file content and code structure | `read_file`, `search_files`, `list_files`, `list_code_definition_names` |
@@ -26,10 +40,29 @@ Describe what you want to accomplish in natural language, and Kilo Code will:
| Browser | Interact with web content | `browser_action` |
| Workflow | Manage task flow and context | `ask_followup_question`, `attempt_completion`, `switch_mode`, `new_task` |
{% /tab %}
{% /tabs %}
## Example: Using Tools
Here's how a typical tool interaction works:
{% tabs %}
{% tab label="VSCode" %}
{% callout type="info" title="Tool Approval UI" %}
When a tool is proposed, you'll see an approval prompt in the **Permission Dock** at the bottom of the chat. You can approve once, approve always (saves to config), or deny.
{% /callout %}
**User:** Create a file named `greeting.js` that logs a greeting message
**Kilo Code:** (Proposes the `write` tool)
The extension shows the file path and proposed content for review. Click **Approve** to execute or **Deny** to cancel.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
{% callout type="info" title="Tool Approval UI" %}
When a tool is proposed, you'll see Save and Reject buttons along with an optional Auto-approve checkbox for trusted operations.
{% /callout %}
@@ -56,8 +89,55 @@ greet('World');
**Kilo Code:** (Confirms file creation)
{% /tab %}
{% /tabs %}
## Tool Safety and Approval
{% tabs %}
{% tab label="VSCode" %}
Every tool use is subject to a permission check. The default action for any tool with no matching rule in your config is **`ask`** — meaning Kilo will pause and prompt you before executing it.
**Default permissions by tool:**
| Tool(s) | Default |
| :------------------------------------------- | :----------------------------------------------- |
| `read`, `glob`, `grep`, `list` | `ask` |
| `edit`, `write`, `multiedit`, `apply_patch` | `ask` |
| `bash` | `ask` (per-command) |
| `external_directory` | `ask` (when accessing paths outside the project) |
| `task` | `ask` |
| `webfetch`, `websearch`, `codesearch` | `ask` |
| `todowrite`, `todoread`, `question`, `skill` | `ask` |
No tools are auto-approved out of the box. You must explicitly grant `allow` in your config, or approve them at runtime.
**At runtime**, the **Permission Dock** floating UI in the chat panel shows each pending approval. For each tool call you can:
- **Approve once** — execute this call only
- **Approve always** — save an `allow` rule to your config so future matching calls are auto-approved
- **Deny** — cancel the tool call
To pre-configure permissions in your config file:
```json
{
"permission": {
"read": "allow",
"glob": "allow",
"grep": "allow",
"edit": "ask",
"bash": "ask"
}
}
```
This safety mechanism ensures you maintain control over which files are modified, what commands are executed, and how your codebase is changed.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Every tool use requires your explicit approval. When Kilo proposes a tool, you'll see:
- A "Save" button to approve and execute the tool
@@ -66,8 +146,37 @@ Every tool use requires your explicit approval. When Kilo proposes a tool, you'l
This safety mechanism ensures you maintain control over which files are modified, what commands are executed, and how your codebase is changed. Always review tool proposals carefully before saving them.
{% /tab %}
{% /tabs %}
## Core Tools Reference
{% tabs %}
{% tab label="VSCode" %}
| Tool Name | Description | Category |
| :------------ | :----------------------------------------------------- | :------- |
| `read` | Reads file contents with line numbers | Read |
| `glob` | Finds files by glob pattern | Read |
| `grep` | Searches file contents with regex | Read |
| `edit` | Makes precise text replacements in a file | Edit |
| `multiedit` | Multiple edits in a single call | Edit |
| `write` | Creates new files or overwrites existing ones | Edit |
| `apply_patch` | Applies unified diffs (used with certain models) | Edit |
| `bash` | Runs shell commands | Execute |
| `webfetch` | Fetches a URL | Web |
| `websearch` | Searches the web (Kilo/OpenRouter users) | Web |
| `codesearch` | Semantic code search (Kilo/OpenRouter users) | Web |
| `question` | Asks you a clarifying question with selectable options | Workflow |
| `task` | Spawns a sub-agent session | Workflow |
| `todowrite` | Creates and updates a session TODO list | Workflow |
| `todoread` | Reads the current session TODO list | Workflow |
| `plan` | Enters structured planning mode | Workflow |
| `skill` | Invokes a reusable skill (Markdown instruction module) | Workflow |
{% /tab %}
{% tab label="VSCode (Legacy)" %}
| Tool Name | Description | Category |
| :--------------------------- | :-------------------------------------------------- | :------- |
| `read_file` | Reads the content of a file with line numbers | Read |
@@ -84,6 +193,9 @@ This safety mechanism ensures you maintain control over which files are modified
| `switch_mode` | Changes to a different operational mode | Workflow |
| `new_task` | Creates a new subtask with a specific starting mode | Workflow |
{% /tab %}
{% /tabs %}
## Learn More About Tools
For more detailed information about each tool, including complete parameter references and advanced usage patterns, see the [Tool Use Overview](/docs/automate/tools) documentation.
packages/kilo-docs/pages/automate/index.md
-1
View File
@@ -36,7 +36,6 @@ Connect Kilo Code to external tools and services:
- [**Using MCP in Kilo Code**](/docs/automate/mcp/using-in-kilo-code) — Configuration guide
- [**STDIO & SSE Transports**](/docs/automate/mcp/server-transports) — Local and remote server options
- [**MCP vs API**](/docs/automate/mcp/mcp-vs-api) — When to use MCP
- [**Using MCP in CLI**](/docs/automate/mcp/using-in-cli) — CLI-specific MCP setup
## Integrations
packages/kilo-docs/pages/automate/mcp/using-in-kilo-code.md
+429 -53
View File
@@ -7,31 +7,103 @@ description: "How to use MCP servers in Kilo Code"
Model Context Protocol (MCP) extends Kilo Code's capabilities by connecting to external tools and services. This guide covers everything you need to know about using MCP with Kilo Code.
{% youtube url="https://youtu.be/6O9RQoQRX8A" caption="Demostrating MCP installation in Kilo Code" /%}
{% youtube url="https://youtu.be/6O9RQoQRX8A" caption="Demonstrating MCP installation in Kilo Code" /%}
## Configuring MCP Servers
MCP server configurations can be managed at two levels:
{% tabs %}
{% tab label="VSCode" %}
1. **Global Configuration**: Stored in the `mcp_settings.json` file, accessible via VS Code settings (see below). These settings apply across all your workspaces unless overridden by a project-level configuration.
2. **Project-level Configuration**: Defined in a `.kilocode/mcp.json` file within your project's root directory. This allows you to set up project-specific servers and share configurations with your team by committing the file to version control. Kilo Code automatically detects and loads this file if it exists.
MCP server configurations are stored inside the main Kilo config file. There are two levels:
**Precedence**: If a server name exists in both global and project configurations, the **project-level configuration takes precedence**.
1. **Global Configuration**: `~/.config/kilo/kilo.jsonc` — applies to all projects.
2. **Project-level Configuration**: `kilo.jsonc` in your project root, or `.kilo/kilo.jsonc` for a cleaner setup.
### Editing MCP Settings Files
**Precedence**: Project-level configuration takes precedence over global configuration.
You can edit both global and project-level MCP configuration files directly from the Kilo Code settings.
### Editing MCP Settings
1. Click the {% codicon name="gear" /%} icon in the top navigation of the Kilo Code pane to open `Settings`.
2. Click the `Agent Behaviour` tab on the left side
3. Select the `MCP Servers` sub-tab
4. Click the appropriate button:
- **`Edit Global MCP`**: Opens the global `mcp_settings.json` file.
- **`Edit Project MCP`**: Opens the project-specific `.kilocode/mcp.json` file. If this file doesn't exist, Kilo Code will create it for you.
You can edit MCP settings from the Kilo Code settings UI:
{% image src="/docs/img/using-mcp-in-kilo-code/mcp-installed-config.png" alt="Edit Global MCP and Edit Project MCP buttons" width="600" caption="Edit Global MCP and Edit Project MCP buttons" /%}
1. Click the {% codicon name="gear" /%} icon in the sidebar toolbar to open Settings.
2. Click the `Agent Behaviour` tab on the left side.
3. Select the `MCP Servers` sub-tab.
Both files use a JSON format with a `mcpServers` object containing named server configurations:
From here you can add, edit, enable/disable, and delete MCP servers. Changes are written directly to the appropriate config file.
### Config Format
MCP servers are configured under the `mcp` key in `kilo.jsonc`:
**Local (STDIO) server:**
```json
{
"mcp": {
"my-local-server": {
"type": "local",
"command": ["node", "/path/to/server.js"],
"environment": {
"API_KEY": "your_api_key"
},
"enabled": true,
"timeout": 10000
}
}
}
```
**Remote (HTTP/SSE) server:**
```json
{
"mcp": {
"my-remote-server": {
"type": "remote",
"url": "https://your-server-url.com/mcp",
"headers": {
"Authorization": "Bearer your-token"
},
"enabled": true,
"timeout": 15000
}
}
}
```
Remote servers support OAuth 2.0 authentication. If the server supports it, Kilo Code will automatically start the OAuth flow when you connect. You can also disable OAuth with `"oauth": false`.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
MCP server configurations can be managed at two levels: **global** (applies across all workspaces) and **project-level** (specific to a single project). Project-level configuration takes precedence over global settings.
| Scope | Path | Description |
| ----------- | -------------------- | --------------------------------------------------------------- |
| **Global** | `mcp_settings.json` | Accessible via VS Code settings. Applies across all workspaces. |
| **Project** | `.kilocode/mcp.json` | In your project root. Auto-detected by Kilo Code. |
Project-level configs can be committed to version control to share with your team.
{% /tab %}
{% tab label="CLI" %}
The CLI accepts several config filenames. The recommended file is `kilo.json`:
| Scope | Recommended Path | Also supported |
| ----------- | ------------------------------------ | -------------------------------------------------------------- |
| **Global** | `~/.config/kilo/kilo.json` | `kilo.jsonc`, `opencode.json`, `opencode.jsonc`, `config.json` |
| **Project** | `./kilo.json` or `./.kilo/kilo.json` | `kilo.jsonc`, `opencode.jsonc`, `opencode.json` |
{% /tab %}
{% /tabs %}
## Configuration Format
{% tabs %}
{% tab label="VSCode (Legacy)" %}
Both global and project-level files use a JSON format with a `mcpServers` object containing named server configurations:
```json
{
@@ -51,11 +123,43 @@ Both files use a JSON format with a `mcpServers` object containing named server
_Example of MCP Server config in Kilo Code (STDIO Transport)_
### Understanding Transport Types
{% /tab %}
{% tab label="VSCode" %}
MCP supports three transport types for server communication:
In the VS Code extension, open **Settings → MCP** and click **Add Server** to configure a new server through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
#### STDIO Transport
{% /tab %}
{% tab label="CLI" %}
Add MCP servers under the `mcp` key in your config file. Each server has a unique name that you can reference in prompts.
```json
{
"mcp": {
"my-server": {
"type": "local",
"command": ["npx", "-y", "my-mcp-command"],
"enabled": true
}
}
}
```
You can disable a server by setting `enabled` to `false` without removing it from your config.
{% /tab %}
{% /tabs %}
## Understanding Transport Types
MCP supports two main transport types:
- **Local (STDIO)**: Servers run as a child process on your machine, communicating over stdin/stdout.
- **Remote (HTTP/SSE)**: Servers hosted over HTTP/HTTPS. Kilo Code tries `StreamableHTTP` first, then falls back to `SSE` automatically.
For more details, see [STDIO & SSE Transports](server-transports).
### STDIO Transport
Used for local servers running on your machine:
@@ -69,6 +173,9 @@ For more in-depth information about how STDIO transport works, see [STDIO Transp
STDIO configuration example:
{% tabs %}
{% tab label="VSCode (Legacy)" %}
```json
{
"mcpServers": {
@@ -85,7 +192,43 @@ STDIO configuration example:
}
```
#### Streamable HTTP Transport
{% /tab %}
{% tab label="VSCode" %}
In the VS Code extension, open **Settings → MCP**, click **Add Server**, and choose **Local (stdio)**. Fill in the command, arguments, and optional environment variables through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
{% /tab %}
{% tab label="CLI" %}
```json
{
"mcp": {
"my-local-server": {
"type": "local",
"command": ["npx", "-y", "my-mcp-command"],
"enabled": true,
"environment": {
"API_KEY": "your_api_key"
}
}
}
}
```
#### Local Server Options
| Option | Type | Required | Description |
| ------------- | ------- | -------- | --------------------------------------------------------------------- |
| `type` | String | Yes | Must be `"local"`. |
| `command` | Array | Yes | Command and arguments to run the MCP server. |
| `environment` | Object | No | Environment variables to set when running the server. |
| `enabled` | Boolean | No | Enable or disable the MCP server on startup. |
| `timeout` | Number | No | Timeout in ms for fetching tools from the MCP server. Default: 30000. |
{% /tab %}
{% /tabs %}
### Streamable HTTP Transport
Used for remote servers accessed over HTTP/HTTPS:
@@ -94,7 +237,8 @@ Used for remote servers accessed over HTTP/HTTPS:
- Requires network access
- Allows centralized deployment and management
Streamable HTTP transport configuration example:
{% tabs %}
{% tab label="VSCode (Legacy)" %}
```json
{
@@ -112,7 +256,43 @@ Streamable HTTP transport configuration example:
}
```
#### SSE Transport
{% /tab %}
{% tab label="VSCode" %}
In the VS Code extension, open **Settings → MCP**, click **Add Server**, and choose **Remote (HTTP)**. Enter the server URL and optional headers through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
{% /tab %}
{% tab label="CLI" %}
```json
{
"mcp": {
"my-remote-server": {
"type": "remote",
"url": "https://my-mcp-server.com/mcp",
"enabled": true,
"headers": {
"Authorization": "Bearer MY_API_KEY"
}
}
}
}
```
#### Remote Server Options
| Option | Type | Required | Description |
| --------- | ------- | -------- | --------------------------------------------------------------------- |
| `type` | String | Yes | Must be `"remote"`. |
| `url` | String | Yes | URL of the remote MCP server. |
| `enabled` | Boolean | No | Enable or disable the MCP server on startup. |
| `headers` | Object | No | HTTP headers to send with requests. |
| `timeout` | Number | No | Timeout in ms for fetching tools from the MCP server. Default: 30000. |
{% /tab %}
{% /tabs %}
### SSE Transport
⚠️ DEPRECATED: The SSE Transport has been deprecated as of MCP specification version 2025-03-26. Please use the HTTP Stream Transport instead, which implements the new Streamable HTTP transport specification.
@@ -143,6 +323,24 @@ SSE configuration example:
}
```
## Managing MCP Servers
{% tabs %}
{% tab label="VSCode (Legacy)" %}
### Editing MCP Settings Files
You can edit both global and project-level MCP configuration files directly from the Kilo Code settings.
1. Click the {% codicon name="gear" /%} icon in the top navigation of the Kilo Code pane to open `Settings`.
2. Click the `Agent Behaviour` tab on the left side
3. Select the `MCP Servers` sub-tab
4. Click the appropriate button:
- **`Edit Global MCP`**: Opens the global `mcp_settings.json` file.
- **`Edit Project MCP`**: Opens the project-specific `.kilocode/mcp.json` file. If this file doesn't exist, Kilo Code will create it for you.
{% image src="/docs/img/using-mcp-in-kilo-code/mcp-installed-config.png" alt="Edit Global MCP and Edit Project MCP buttons" width="600" caption="Edit Global MCP and Edit Project MCP buttons" /%}
### Deleting a Server
1. Press the {% codicon name="trash" /%} next to the MCP server you would like to delete
@@ -158,16 +356,95 @@ SSE configuration example:
1. Press the {% codicon name="activate" /%} toggle switch next to the MCP server to enable/disable it
{% /tab %}
{% tab label="VSCode" %}
In the VS Code extension, manage MCP servers from **Settings → MCP**:
- **Add a server**: Click **Add Server** and fill in the details
- **Enable/disable**: Toggle a server on or off without removing its configuration
- **Delete**: Remove a server from the list
The extension also supports the `{env:VARIABLE_NAME}` syntax in config files to reference environment variables (see the **CLI** tab for details).
{% /tab %}
{% tab label="CLI" %}
### CLI Commands
| Command | Description |
| ----------------- | ------------------------------- |
| `kilo mcp list` | List all configured MCP servers |
| `kilo mcp add` | Add an MCP server |
| `kilo mcp auth` | Authenticate with an MCP server |
| `kilo mcp logout` | Log out from an MCP server |
| `kilo mcp debug` | Debug an MCP server connection |
Inside the interactive TUI, use the `/mcps` slash command to toggle MCP servers on or off.
### Environment Variables
Use `{env:VARIABLE_NAME}` syntax in config files to reference environment variables:
```json
{
"mcp": {
"my-server": {
"type": "remote",
"url": "https://mcp.example.com/mcp",
"headers": {
"Authorization": "Bearer {env:MY_API_KEY}"
}
}
}
}
```
{% /tab %}
{% /tabs %}
### Network Timeout
{% tabs %}
{% tab label="VSCode" %}
Set the `timeout` field (in milliseconds) in the server's config entry. The default is 10 seconds for local servers and 15 seconds for remote servers.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
To set the maximum time to wait for a response after a tool call to the MCP server:
1. Click the `Network Timeout` pulldown at the bottom of the individual MCP server's config box and change the time. Default is 1 minute but it can be set between 30 seconds and 5 minutes.
{% image src="/docs/img/using-mcp-in-kilo-code/using-mcp-in-kilo-code-6.png" alt="Network Timeout pulldown" width="400" caption="Network Timeout pulldown" /%}
{% /tab %}
{% /tabs %}
### Auto Approve Tools
{% tabs %}
{% tab label="VSCode" %}
MCP tool calls use the same permission system as built-in tools. Each MCP tool's permission key is its namespaced name: `{server}_{tool}` (e.g. `my_server_do_something`).
**At runtime:** When an MCP tool is called, the Permission Dock shows an approval prompt. Click **Approve Always** to save an allow rule to your config so future calls to that tool are auto-approved.
**In your config file:** Add the tool name (or a wildcard pattern) to the `permission` key in `kilo.jsonc`:
```json
{
"permission": {
"my_server_do_something": "allow",
"my_server_*": "allow"
}
}
```
{% /tab %}
{% tab label="VSCode (Legacy)" %}
MCP tool auto-approval works on a per-tool basis and is disabled by default. To configure auto-approval:
1. First enable the global "Use MCP servers" auto-approval option in [auto-approving-actions](/docs/getting-started/settings/auto-approving-actions)
@@ -178,41 +455,14 @@ MCP tool auto-approval works on a per-tool basis and is disabled by default. To
When enabled, Kilo Code will automatically approve this specific tool without prompting. Note that the global "Use MCP servers" setting takes precedence - if it's disabled, no MCP tools will be auto-approved.
## Finding and Installing MCP Servers
Kilo Code does not come with any pre-installed MCP servers. You'll need to find and install them separately.
- **Community Repositories:** Check for community-maintained lists of MCP servers on GitHub
- **Ask Kilo Code:** You can ask Kilo Code to help you find or even create MCP servers
- **Build Your Own:** Create custom MCP servers using the SDK to extend Kilo Code with your own tools
For full SDK documentation, visit the [MCP GitHub repository](https://github.com/modelcontextprotocol/).
## Using MCP Tools in Your Workflow
After configuring an MCP server, Kilo Code will automatically detect available tools and resources. To use them:
1. Type your request in the Kilo Code chat interface
2. Kilo Code will identify when an MCP tool can help with your task
3. Approve the tool use when prompted (or use auto-approval)
Example: "Analyze the performance of my API" might use an MCP tool that tests API endpoints.
## Troubleshooting MCP Servers
Common issues and solutions:
- **Server Not Responding:** Check if the server process is running and verify network connectivity
- **Permission Errors:** Ensure proper API keys and credentials are configured in your `mcp_settings.json` (for global settings) or `.kilocode/mcp.json` (for project settings).
- **Tool Not Available:** Confirm the server is properly implementing the tool and it's not disabled in settings
- **Slow Performance:** Try adjusting the network timeout value for the specific MCP server
{% callout type="tip" %}
**Reduce system prompt size:** If you're not using MCP, turn it off in Settings > Agent Behaviour > MCP Servers to significantly cut down the size of the system prompt and improve performance.
{% /callout %}
{% /tab %}
{% /tabs %}
## Platform-Specific MCP Configuration Examples
{% tabs %}
{% tab label="VSCode (Legacy)" %}
### Windows Configuration Example
When setting up MCP servers on Windows, you'll need to use the Windows Command Prompt (`cmd`) to execute commands. Here's an example of configuring a Puppeteer MCP server on Windows:
@@ -252,4 +502,130 @@ For macOS or Linux, you would use a different configuration:
{% /callout %}
{% /tab %}
{% tab label="VSCode" %}
In the VS Code extension, use **Settings → MCP → Add Server** to add any of the examples below through the UI. You can also edit the config files directly — see the **CLI** tab for the JSON format.
{% /tab %}
{% tab label="CLI" %}
### Windows
When setting up local MCP servers on Windows, use the full `cmd` invocation in the `command` array:
```json
{
"mcp": {
"puppeteer": {
"type": "local",
"command": ["cmd", "/c", "npx", "-y", "@modelcontextprotocol/server-puppeteer"],
"enabled": true
}
}
}
```
The same approach can be used for other MCP servers on Windows, adjusting the package name as needed for different server types.
### Figma Desktop
Connect to the Figma Desktop app's MCP server:
```json
{
"mcp": {
"Figma Desktop": {
"type": "remote",
"url": "http://127.0.0.1:3845/mcp"
}
}
}
```
### Context7
Add the [Context7](https://github.com/upstash/context7) MCP server for documentation search:
```json
{
"mcp": {
"context7": {
"type": "remote",
"url": "https://mcp.context7.com/mcp"
}
}
}
```
### Everything Test Server
Add the test MCP server for development:
```json
{
"mcp": {
"mcp_everything": {
"type": "local",
"command": ["npx", "-y", "@modelcontextprotocol/server-everything"]
}
}
}
```
{% /tab %}
{% /tabs %}
## Finding and Installing MCP Servers
Kilo Code does not come with any pre-installed MCP servers. You'll need to find and install them separately.
- **Kilo Marketplace:** Browse community-contributed MCP server configurations and agent skills in the [Kilo Marketplace](https://github.com/Kilo-Org/kilo-marketplace). The marketplace includes ready-to-use configs for popular tools like Figma, Sentry, and more.
- **Community Repositories:** Check for community-maintained lists of MCP servers on GitHub
- **Ask Kilo Code:** You can ask Kilo Code to help you find or even create MCP servers
- **Build Your Own:** Create custom MCP servers using the SDK to extend Kilo Code with your own tools
For full SDK documentation, visit the [MCP GitHub repository](https://github.com/modelcontextprotocol/).
## Using MCP Tools in Your Workflow
After configuring an MCP server, Kilo Code will automatically detect available tools and resources. To use them:
1. Type your request in the Kilo Code chat interface
2. Kilo Code will identify when an MCP tool can help with your task
3. Approve the tool use when prompted (or use auto-approval)
Example: "Analyze the performance of my API" might use an MCP tool that tests API endpoints.
## Troubleshooting MCP Servers
{% tabs %}
{% tab label="VSCode" %}
- **Server Not Responding:** Check if the server process is running and verify network connectivity. Review server status in Settings > Agent Behaviour > MCP Servers.
- **`needs_auth` status:** For remote servers with OAuth, the extension will show a notification to start the auth flow. Click it to authenticate.
- **`failed` status:** Check the CLI output for error details. Ensure commands and paths are correct.
- **Tool Not Available:** Confirm the server is properly implementing the tool and it's not disabled in settings.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
- **Server Not Responding:** Check if the server process is running and verify network connectivity
- **Permission Errors:** Ensure proper API keys and credentials are configured in your `mcp_settings.json` (for global settings) or `.kilocode/mcp.json` (for project settings).
- **Tool Not Available:** Confirm the server is properly implementing the tool and it's not disabled in settings
- **Slow Performance:** Try adjusting the network timeout value for the specific MCP server
{% /tab %}
{% tab label="CLI" %}
- **Server Not Responding:** Check if the server process is running. Use `kilo mcp debug <server-name>` to inspect the connection.
- **Permission Errors:** Ensure API keys and credentials are set in your `kilo.jsonc` config or via `{env:VARIABLE_NAME}` references.
- **Tool Not Available:** Confirm the server is properly implementing the tool and it is not disabled (`"enabled": false`) in your config.
- **Slow Performance:** Increase the `timeout` value for the specific MCP server in your config.
{% /tab %}
{% /tabs %}
{% callout type="tip" %}
**Reduce system prompt size:** If you're not using MCP, turn it off in Settings > Agent Behaviour > MCP Servers to significantly cut down the size of the system prompt and improve performance.
{% /callout %}
packages/kilo-docs/pages/automate/tools/index.md
+89
View File
@@ -11,6 +11,92 @@ Kilo Code implements a sophisticated tool system that allows AI models to intera
### Tool Groups
{% tabs %}
{% tab label="VSCode" %}
Tools are organized into logical groups based on their functionality:
| Category | Purpose | Tools | Common Use |
| ------------------ | --------------------------------- | ------------------------------------------------------------ | --------------------------------------- |
| **Read Group** | File system reading and searching | `read`, `glob`, `grep` | Code exploration and analysis |
| **Edit Group** | File system modifications | `edit`, `multiedit`, `write`, `apply_patch` | Code changes and file manipulation |
| **Execute Group** | Shell command execution | `bash` | Running scripts, building projects |
| **Web Group** | Fetch and search web content | `webfetch`, `websearch`, `codesearch` | Research, documentation lookup |
| **Browser Group** | Web browser automation | `kilo-playwright_*` (via built-in Playwright MCP) | Browser testing and interaction |
| **MCP Group** | External tool integration | MCP server tools (namespaced as `{server}_{tool}`) | Specialized functionality via MCP |
| **Workflow Group** | Sub-agents and task management | `question`, `task`, `todowrite`, `todoread`, `plan`, `skill` | Context switching and task organization |
### Always Available Tools
Certain tools are accessible regardless of the current agent:
- `question`: Ask the user a clarifying question with selectable options
- `task`: Spawn a sub-agent session
- `todowrite` / `todoread`: Manage session task lists
## Available Tools
### Read Tools
These tools help Kilo Code understand your code and project:
- `read` - Reads file contents with line numbers
- `glob` - Finds files matching a glob pattern
- `grep` - Searches file contents with regex
### Edit Tools
These tools help Kilo Code make changes to your code:
- `edit` - Makes precise text replacements in a file
- `multiedit` - Multiple edits in a single call
- `write` - Creates new files or fully overwrites existing ones
- `apply_patch` - Applies unified diffs (used with certain models)
### Execute Tools
These tools help Kilo Code run commands:
- `bash` - Runs shell commands with configurable timeout and working directory
### Web Tools
These tools help Kilo Code access web content:
- `webfetch` - Fetches a URL and returns the content
- `websearch` - Searches the web (available to Kilo/OpenRouter users)
- `codesearch` - Semantic code search (available to Kilo/OpenRouter users)
### Browser Tools
The VS Code extension has a built-in browser automation tool powered by [Playwright MCP](https://www.npmjs.com/package/@playwright/mcp). Enable it in Settings → Browser Automation. When enabled, it registers an MCP server named `kilo-playwright` and exposes tools such as:
- `kilo-playwright_browser_navigate` - Navigate to a URL
- `kilo-playwright_browser_click` - Click an element
- `kilo-playwright_browser_type` - Type text into an element
- `kilo-playwright_browser_screenshot` - Capture a screenshot
- `kilo-playwright_browser_snapshot` - Capture an accessibility snapshot
These follow the same permission model as all MCP tools (see below).
### MCP Tools
MCP server tools are automatically available when an MCP server is connected. Tool names are namespaced as `{server}_{tool}`. See [MCP Overview](/docs/automate/mcp/overview) for details.
### Workflow Tools
These tools help manage the conversation and task flow:
- `question` - Asks you a clarifying question with selectable options
- `task` - Spawns a sub-agent (child session)
- `todowrite` - Creates and updates a session TODO list
- `todoread` - Reads the current session TODO list
- `plan` - Enters structured planning mode
- `skill` - Invokes a reusable skill (Markdown instruction module)
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Tools are organized into logical groups based on their functionality:
| Category | Purpose | Tools | Common Use |
@@ -80,6 +166,9 @@ These tools help manage the conversation and task flow:
- [new_task](/docs/automate/tools/new-task) - Creates a new subtask
- [update_todo_list](/docs/automate/tools/update-todo-list) - Tracks task progress with step-by-step checklists
{% /tab %}
{% /tabs %}
## Tool Calling Mechanism
### When Tools Are Called
packages/kilo-docs/pages/code-with-ai/agents/auto-model.md
+1 -1
View File
@@ -131,5 +131,5 @@ Auto Model is actively being improved. We'd love to hear how it's working for yo
## Related
- [Model Selection Guide](/docs/code-with-ai/agents/model-selection) - General guidance on choosing models
- [Using Modes](/docs/code-with-ai/agents/using-modes) - Learn about different Kilo Code modes
- [Using Agents](/docs/code-with-ai/agents/using-agents) - Learn about different Kilo Code agents
- [Free & Budget Models](/docs/code-with-ai/agents/free-and-budget-models) - Cost-effective alternatives
packages/kilo-docs/pages/code-with-ai/agents/chat-interface.md
+113 -21
View File
@@ -6,7 +6,7 @@ description: "Learn how to use the Kilo Code chat interface effectively"
# Chatting with Kilo Code
{% callout type="tip" %}
**Bottom line:** Kilo Code is an AI coding assistant that lives in VS Code. You chat with it in plain English, and it writes, edits, and explains code for you.
**Bottom line:** Kilo Code is an AI coding assistant. You chat with it in plain English, and it writes, edits, and explains code for you.
{% /callout %}
{% callout type="note" title="Prefer quick completions?" %}
@@ -15,10 +15,26 @@ If you're typing code in the editor and want AI to finish your line or block, ch
## Quick Setup
Find the Kilo Code icon ({% kilo-code-icon /%}) in VS Code's Primary Side Bar. Click it to open the chat panel.
{% tabs %}
{% tab label="VSCode" %}
Click the Kilo Code icon ({% kiloCodeIcon /%}) in VS Code's Primary Side Bar to open the sidebar chat. You can also pop it out into an editor tab for a larger workspace.
{% /tab %}
{% tab label="CLI" %}
Open your terminal and run `kilo` to launch the interactive terminal interface (TUI). You'll see a prompt where you can start typing requests immediately. The TUI is fully keyboard-driven — no mouse required.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Find the Kilo Code icon ({% kiloCodeIcon /%}) in VS Code's Primary Side Bar. Click it to open the chat panel.
**Lost the panel?** Go to View > Open View... and search for "Kilo Code"
{% /tab %}
{% /tabs %}
## How to Talk to Kilo Code
**The key insight:** Just type what you want in normal English. No special commands needed.
@@ -46,6 +62,40 @@ Find the Kilo Code icon ({% kilo-code-icon /%}) in VS Code's Primary Side Bar. C
## The Chat Interface
{% tabs %}
{% tab label="VSCode" %}
**Essential controls:**
- **Input prompt** - Type your requests and press Enter to send
- **Action buttons** - Approve or reject proposed changes, answer questions
- **Agent dropdown** - Switch between agents (e.g. Code, Ask, Plan) from the sidebar
- **Session management** - Start new sessions or resume previous ones
**Providing context:**
The extension automatically passes context from your editor, including your open tabs and active file. You can type `@` in the chat input to get file autocomplete suggestions, or mention file paths naturally in your message (e.g., "update src/utils.ts to add a helper function"). The agent can also discover files on its own using its built-in tools.
{% /tab %}
{% tab label="CLI" %}
**Essential controls:**
- **Input prompt** - Type your requests and press Enter to send
- **Action buttons** - Approve or reject proposed changes, answer questions
- **Agent cycling** - Switch between agents using keybinds or slash commands
- **Session management** - Start new sessions or resume previous ones
- **New task** - Start a new task, available using the `+` button at the top or `New Task` button above the chat input
- **Worktree** - Continue the current task with it's git state and session history in the Agent Manager in an isolated worktree
- **File changes** - Shows the number of lines changed and opens a diff view
**Providing context:**
Type `@` in the TUI to get file autocomplete suggestions, or mention file paths directly in your message (e.g., "look at src/utils.ts") and the agent will read them. When using the non-interactive `kilo run` command, you can pass `-f path/to/file.ts` to explicitly include files. The agent can also discover files on its own using its built-in tools.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
{% image src="/docs/img/the-chat-interface/the-chat-interface-1.png" alt="Chat interface components labeled with callouts" width="800" caption="Everything you need is right here" /%}
**Essential controls:**
@@ -56,6 +106,20 @@ Find the Kilo Code icon ({% kilo-code-icon /%}) in VS Code's Primary Side Bar. C
- **Plus button** - Start a new task session
- **Mode selector** - Choose how Kilo should approach your task
**Providing context with @-mentions:**
Reference files and other context directly in your message using `@`:
- `@file` - Reference a specific file
- `@url` - Include content from a URL
- `@problems` - Include current VS Code problems
- `@terminal` - Include terminal output
- `@git-changes` - Include uncommitted changes
- `@commit` - Reference a specific commit
{% /tab %}
{% /tabs %}
## Quick Interactions
**Click to act:**
@@ -85,29 +149,19 @@ Find the Kilo Code icon ({% kilo-code-icon /%}) in VS Code's Primary Side Bar. C
## Suggested Responses
When Kilo Code needs more information to complete a task, it uses the [`ask_followup_question`](/docs/automate/tools/ask-followup-question) tool. To make responding easier and faster, Kilo Code often provides suggested answers alongside the question.
{% image src="/docs/img/suggested-responses/suggested-responses.png" alt="Example of Kilo Code asking a question with suggested response buttons below it" width="800" caption="Suggested responses appear as clickable buttons below questions" /%}
When Kilo Code needs more information to complete a task, it asks a follow-up question and often provides suggested answers to make responding faster.
**How it works:**
1. **Question Appears** - Kilo Code asks a question using the `ask_followup_question` tool
2. **Suggestions Displayed** - If suggestions are provided, they appear as buttons below the question
3. **Interaction** - You can interact with these suggestions in two ways
1. **Question Appears** - Kilo Code asks a question using the `question` tool
2. **Options Displayed** - Selectable options are presented that you can choose from
3. **Selection** - Pick an option or type a custom response
**Interacting with suggestions:**
{% callout type="info" title="VSCode (Legacy)" collapsed=true %}
In the legacy extension, Kilo Code uses the `ask_followup_question` tool instead. Suggestions appear as clickable buttons below the question. You can click a button to send the answer directly, or hold `Shift` and click (or click the pencil icon {% codicon name="edit" /%}) to copy the suggestion into the input box for editing before sending.
You have two options for using suggested responses:
1. **Direct Selection**:
- **Action**: Simply click the button containing the answer you want to provide
- **Result**: The selected answer is immediately sent back to Kilo Code as your response. This is the quickest way to reply if one of the suggestions perfectly matches your intent.
2. **Edit Before Sending**:
- **Action**:
- Hold down `Shift` and click the suggestion button
- _Alternatively_, hover over the suggestion button and click the pencil icon ({% codicon name="edit" /%}) that appears
- **Result**: The text of the suggestion is copied into the chat input box. You can then modify the text as needed before pressing Enter to send your customized response. This is useful when a suggestion is close but needs minor adjustments.
{% image src="/docs/img/suggested-responses/suggested-responses.png" alt="Example of Kilo Code asking a question with suggested response buttons below it" width="800" caption="Suggested responses appear as clickable buttons below questions" /%}
{% /callout %}
**Benefits:**
@@ -119,6 +173,41 @@ This feature streamlines the interaction when Kilo Code requires clarification,
## Tips for Better Workflow
{% tabs %}
{% tab label="VSCode" %}
{% callout type="tip" %}
**Switch agents for different tasks.** Use the agent dropdown, `/agents` slash command, or `Cmd+.` (`Ctrl+.` on Windows/Linux) to switch between agents like Code, Ask, and Plan. Each agent is tuned for a different type of task — see [Using Agents](/docs/code-with-ai/agents/using-agents) for details.
{% /callout %}
{% callout type="tip" %}
**Your editor context is automatic.** The extension reads your open tabs and active file, so you don't need to manually reference every file. Focus your message on what you want done.
{% /callout %}
{% callout type="tip" %}
**Pop out to an editor tab.** If the sidebar feels cramped, pop the chat into a full editor tab for more room.
{% /callout %}
{% callout type="tip" %}
**Move Kilo Code to the Secondary Side Bar** for a better layout. Right-click on the Kilo Code icon in the Activity Bar and select **Move To → Secondary Side Bar**. This lets you see the Explorer, Search, Source Control, etc. alongside Kilo Code.
{% image src="/docs/img/move-to-secondary.png" alt="Move to Secondary Side Bar" width="600" caption="Move Kilo Code to the Secondary Side Bar for better workspace organization" /%}
{% /callout %}
{% /tab %}
{% tab label="CLI" %}
{% callout type="tip" %}
**Switch agents for different tasks.** Use `/agents`, press `Tab` to cycle agents, or use `Ctrl+X a` to open the agent picker. Each agent is tuned for a different type of task — see [Using Agents](/docs/code-with-ai/agents/using-agents) for details.
{% /callout %}
{% callout type="tip" %}
**The TUI is keyboard-driven.** Navigate, approve changes, and switch agents entirely from the keyboard — no mouse needed.
{% /callout %}
{% /tab %}
{% tab label="VSCode (Legacy)" %}
{% callout type="tip" %}
**Move Kilo Code to the Secondary Side Bar** for a better layout. Right-click on the Kilo Code icon in the Activity Bar and select **Move To → Secondary Side Bar**. This lets you see the Explorer, Search, Source Control, etc. alongside Kilo Code.
@@ -129,4 +218,7 @@ This feature streamlines the interaction when Kilo Code requires clarification,
**Drag files directly into chat.** Once you have Kilo Code in a separate sidebar from the file explorer, you can drag files from the explorer into the chat window (even multiple at once). Just hold down the Shift key after you start dragging the files.
{% /callout %}
Ready to start coding? Open the chat panel and describe what you want to build!
{% /tab %}
{% /tabs %}
Ready to start coding? Start a session in Kilo Code and describe what you want to build!
packages/kilo-docs/pages/code-with-ai/agents/context-mentions.md
+89
View File
@@ -5,6 +5,92 @@ description: "How to provide context to Kilo Code using mentions"
# Context Mentions
Providing the right context helps Kilo Code understand your project and perform tasks accurately. All platforms support `@`-mentions for referencing files, and the agent can also discover context on its own using built-in tools like `read`, `grep`, and `glob`.
{% tabs %}
{% tab label="VSCode" %}
The extension supports `@`-mention autocomplete for file paths and also uses a tool-based context model where the agent can automatically discover and read files using built-in tools.
## How Context Works
When you describe a task, the agent uses its tools — `read`, `grep`, `glob`, and others — to find and read relevant files on its own. You don't need to explicitly point it at files in most cases; just describe what you want done and the agent will locate the right code.
### @-Mention Autocomplete
Type `@` in the chat input followed by a filename to get autocomplete suggestions. Selecting a file attaches its contents to your message. This is the quickest way to reference a specific file.
### Automatic Editor Context
The extension automatically includes context from your editor with each message — your currently focused file and all open editor tabs. You don't need to mention these explicitly.
Selected code and editor diagnostics (errors/warnings) are not included automatically. However, you can send these to Kilo Code through VS Code's Code Actions: select code or hover over an error, then use the lightbulb menu to find context-dependent actions like "Explain with Kilo Code" or "Fix with Kilo Code."
### Tool-Based File Access
Rather than attaching file contents up front, the agent reads files on demand during its work:
| Tool | Purpose | Example |
| -------- | --------------------------------------------- | ------------------------------------------- |
| **read** | Read the contents of a specific file | Agent reads `src/utils.ts` to understand it |
| **glob** | Find files matching a pattern | Agent searches for `**/*.test.ts` |
| **grep** | Search file contents for a pattern | Agent searches for `function handleError` |
| **bash** | Run shell commands including `git` operations | Agent runs `git diff` or `git log` |
This means the agent can explore your entire project as needed, rather than being limited to files you explicitly mention.
## Best Practices
| Practice | Description |
| ------------------------------ | -------------------------------------------------------------------------------------------------- |
| **Describe the task clearly** | The agent finds context on its own — focus on _what_ you want done rather than _where_ the code is |
| **Mention files when helpful** | If you know the exact file, mention its path to save the agent a search step |
| **Keep editor tabs relevant** | Open tabs are passed as context, so keep relevant files open |
| **Trust the agent's tools** | The agent can search, read, and explore your codebase — let it do the discovery work |
{% /tab %}
{% tab label="CLI" %}
The CLI uses a tool-based context model. The agent **automatically discovers and reads the context it needs** using built-in tools. In the TUI, you can type `@` to get file autocomplete suggestions for quick file references.
## How Context Works
When you describe a task, the agent uses its tools — `read`, `grep`, `glob`, and others — to find and read relevant files on its own. You don't need to explicitly point it at files in most cases; just describe what you want done and the agent will locate the right code.
### Providing File Context
In the terminal-based TUI, you can provide context in several ways:
- **Type `@` for file autocomplete** — In the TUI, type `@` followed by a filename to get autocomplete suggestions for quick file references.
- **Mention file paths in your message** — Simply refer to files by path in your conversation text (e.g., "look at src/utils.ts") and the agent will read them.
- **Use `kilo run -f`** — When using the non-interactive `kilo run` command, pass `-f path/to/file.ts` to explicitly include a file's contents in the context.
- **Let the agent find files itself** — The agent has access to `glob` (find files by pattern), `grep` (search file contents), and `read` (read file contents) tools. Describe what you're looking for and it will locate the relevant code.
### Tool-Based File Access
Rather than attaching file contents up front, the agent reads files on demand during its work:
| Tool | Purpose | Example |
| -------- | --------------------------------------------- | ------------------------------------------- |
| **read** | Read the contents of a specific file | Agent reads `src/utils.ts` to understand it |
| **glob** | Find files matching a pattern | Agent searches for `**/*.test.ts` |
| **grep** | Search file contents for a pattern | Agent searches for `function handleError` |
| **bash** | Run shell commands including `git` operations | Agent runs `git diff` or `git log` |
This means the agent can explore your entire project as needed, rather than being limited to files you explicitly mention.
## Best Practices
| Practice | Description |
| ------------------------------ | -------------------------------------------------------------------------------------------------- |
| **Describe the task clearly** | The agent finds context on its own — focus on _what_ you want done rather than _where_ the code is |
| **Mention files when helpful** | If you know the exact file, mention its path to save the agent a search step |
| **Use `kilo run -f`** | Pass key files with `-f` when using `kilo run` for immediate context |
| **Trust the agent's tools** | The agent can search, read, and explore your codebase — let it do the discovery work |
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Context mentions are a powerful way to provide Kilo Code with specific information about your project, allowing it to perform tasks more accurately and efficiently. You can use mentions to refer to files, folders, problems, and Git commits. Context mentions start with the `@` symbol.
{% image src="/docs/img/context-mentions/context-mentions.png" alt="Context Mentions Overview - showing the @ symbol dropdown menu in the chat interface" width="600" caption="Context mentions overview showing the @ symbol dropdown menu in the chat interface." /%}
@@ -116,3 +202,6 @@ The dropdown automatically suggests:
| **Click mentions** | Click mentions in chat history to open files or view content |
| **Eliminate copy-pasting** | Use mentions instead of manually copying code or errors |
| **Combine mentions** | "Fix @problems in @/src/component.ts using the pattern from commit @a1b2c3d" |
{% /tab %}
{% /tabs %}
packages/kilo-docs/pages/code-with-ai/agents/free-and-budget-models.md
+3 -3
View File
@@ -131,9 +131,9 @@ When you need more capability than free models provide, these options deliver ex
**Use appropriate modes to limit expensive operations:**
- **[Ask Mode](/docs/code-with-ai/agents/using-modes#ask-mode):** Information gathering without code changes
- **[Architect Mode](/docs/code-with-ai/agents/using-modes#architect-mode):** Planning without expensive file operations
- **[Debug Mode](/docs/code-with-ai/agents/using-modes#debug-mode):** Focused troubleshooting
- **[Ask Agent](/docs/code-with-ai/agents/using-agents#ask):** Information gathering without code changes
- **[Plan Agent](/docs/code-with-ai/agents/using-agents#plan):** Planning without expensive file operations
- **[Debug Agent](/docs/code-with-ai/agents/using-agents#debug):** Focused troubleshooting
**Custom modes for budget control:**
packages/kilo-docs/pages/code-with-ai/agents/model-selection.md
+27
View File
@@ -19,6 +19,33 @@ This isn't benchmarks from some lab. It's real usage data from developers like y
While the specifics change constantly, some principles stay consistent:
### How to Select and Switch Models
{% tabs %}
{% tab label="VSCode" %}
- Use the **model selector** in the chat prompt area to pick a model for the current session. You can also type `/models` to open the model picker.
- Set per-agent defaults and a global default in the **Settings** panel (Models tab), or directly in the `kilo.jsonc` config file.
- **Model precedence:** Session override → Per-agent config → Global config → Recent models → Kilo Auto (free).
{% /tab %}
{% tab label="CLI" %}
- In the TUI, use the **model picker** (`Ctrl+X m` or `/models`) to switch models.
- For non-interactive use, pass `--model` flag to `kilo run` (e.g., `kilo run --model claude-sonnet-4-20250514`).
- Set the global default with the `model` key in `kilo.jsonc`, or configure per-agent models in the `agent` section.
- **Model precedence:** `--model` flag → Per-agent config → Last used in session → Global config → Recent models → First available.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
- Use the **model dropdown** in the chat panel to select a model for each conversation.
- Configure **API profiles** in Settings to group provider + model combinations and switch between them quickly.
- Models are **sticky per mode** — each mode (Code, Architect, Debug, etc.) remembers the last model you selected.
{% /tab %}
{% /tabs %}
**For complex coding tasks**: Premium models (Claude Sonnet/Opus, GPT-5 class, Gemini Pro) typically handle nuanced requirements, large refactors, and architectural decisions better.
**For everyday coding**: Mid-tier models often provide the best balance of speed, cost, and quality. They're fast enough to keep your flow state intact and capable enough for most tasks.
packages/kilo-docs/pages/code-with-ai/agents/orchestrator-mode.md
+33 -35
View File
@@ -1,42 +1,40 @@
---
title: "Orchestrator Mode"
description: "Using Orchestrator mode for complex multi-step tasks"
description: "Orchestrator mode is no longer needed — agents with full tool access now support subagents natively"
---
# Orchestrator Mode: Coordinate Complex Workflows
# Orchestrator Mode (Deprecated)
Orchestrator Mode (formerly known as Boomerang Tasks) allows you to break down complex projects into smaller, manageable pieces. Think of it like delegating parts of your work to specialized assistants. Each subtask runs in its own context, often using a different Kilo Code mode tailored for that specific job (like [`code`](/docs/code-with-ai/agents/using-modes#code-mode-default), [`architect`](/docs/code-with-ai/agents/using-modes#architect-mode), or [`debug`](/docs/code-with-ai/agents/using-modes#debug-mode)).
{% youtube url="https://www.youtube.com/watch?v=20MmJNeOODo" caption="Orchestrator Mode explained and demonstrated" /%}
## Why Use Orchestrator Mode?
- **Tackle Complexity:** Break large, multi-step projects (e.g., building a full feature) into focused subtasks (e.g., design, implementation, documentation).
- **Use Specialized Modes:** Automatically delegate subtasks to the mode best suited for that specific piece of work, leveraging specialized capabilities for optimal results.
- **Maintain Focus & Efficiency:** Each subtask operates in its own isolated context with a separate conversation history. This prevents the parent (orchestrator) task from becoming cluttered with the detailed execution steps (like code diffs or file analysis results), allowing it to focus efficiently on the high-level workflow and manage the overall process based on concise summaries from completed subtasks.
- **Streamline Workflows:** Results from one subtask can be automatically passed to the next, creating a smooth flow (e.g., architectural decisions feeding into the coding task).
## How It Works
1. Using Orchestrator Mode, Kilo can analyze a complex task and suggest breaking it down into a subtask.
2. The parent task pauses, and the new subtask begins in a different mode.
3. When the subtask's goal is achieved, Kilo signals completion.
4. The parent task resumes with only the summary of the subtask. The parent uses this summary to continue the main workflow.
## Key Considerations
- **Approval Required:** By default, you must approve the creation and completion of each subtask. This can be automated via the [Auto-Approving Actions](/docs/getting-started/settings/auto-approving-actions#subtasks) settings if desired.
- **Context Isolation and Transfer:** Each subtask operates in complete isolation with its own conversation history. It does not automatically inherit the parent's context. Information must be explicitly passed:
- **Down:** Via the initial instructions provided when the subtask is created.
- **Up:** Via the final summary provided when the subtask finishes. Be mindful that only this summary returns to the parent.
- **Navigation:** Kilo's interface helps you see the hierarchy of tasks (which task is the parent, which are children). You can typically navigate between active and paused tasks.
Orchestrator Mode provides a powerful way to manage complex development workflows directly within Kilo Code, leveraging specialized modes for maximum efficiency.
{% callout type="tip" title="Keep Tasks Focused" %}
Use subtasks to maintain clarity. If a request significantly shifts focus or requires a different expertise (mode), consider creating a subtask rather than overloading the current one.
{% callout type="warning" title="Deprecated — scheduled for removal" %}
Orchestrator mode is deprecated and will be removed in a future release. In the VSCode extension and CLI, **agents with full tool access (Code, Plan, Debug) can now delegate to subagents automatically**. You no longer need a dedicated orchestrator — just pick the agent for your task and it will coordinate subagents when helpful. (Read-only agents like Ask do not support delegation.)
{% /callout %}
1. This context is passed via the `message` parameter of the [`new_task`](/docs/automate/tools/new-task) tool.
2. The mode for the subtask is specified via the `mode` parameter of the [`new_task`](/docs/automate/tools/new-task) tool during initiation.
3. This summary is passed via the `result` parameter of the [`attempt_completion`](/docs/automate/tools/attempt-completion) tool when the subtask finishes.
## What Changed
Previously, orchestrator mode was the only way to break complex tasks into subtasks. You had to explicitly switch to orchestrator mode, which would then delegate work to other modes like Code or Architect.
Now, **subagent support is built into agents that have full tool access** (Code, Plan, Debug). When one of these agents encounters a task that would benefit from delegation — like exploring a codebase, running a parallel search, or handling a subtask in isolation — it can launch a subagent directly using the `task` tool. There's no need to switch agents first.
## What You Should Do
- **Just pick the right agent for your task.** Use Code for implementation, Plan for architecture, Debug for troubleshooting. Each will orchestrate subagents where it makes sense.
- **Add custom subagents** if you want specialized delegation behavior. See [Custom Subagents](/docs/customize/custom-subagents) for details.
- **Stop switching to orchestrator mode** before complex tasks. Your current agent already has that capability.
## How Subagents Work
1. The agent analyzes a complex task and decides a subtask would benefit from isolation.
2. It launches a subagent session using the `task` tool (e.g., `general` for autonomous work, `explore` for codebase research).
3. The subagent runs in its own isolated context — separate conversation history, no shared state.
4. When done, the subagent returns a summary to the parent agent, which continues its work.
Agents can launch multiple subagent sessions concurrently for parallel work.
{% callout type="info" title="VSCode (Legacy)" collapsed=true %}
In the legacy extension, orchestrator mode uses two dedicated tools:
1. [`new_task`](/docs/automate/tools/new-task) — Creates a subtask with context passed via the `message` parameter and a mode specified via `mode` (e.g., `code`, `architect`, `debug`).
2. [`attempt_completion`](/docs/automate/tools/attempt-completion) — Signals subtask completion and passes a summary back to the parent via the `result` parameter.
{% youtube url="https://www.youtube.com/watch?v=20MmJNeOODo" caption="Orchestrator Mode in the legacy extension" /%}
{% /callout %}
packages/kilo-docs/pages/code-with-ai/agents/using-agents.md
+263
View File
@@ -0,0 +1,263 @@
---
title: "Using Agents"
description: "Understanding and using different agents in Kilo Code"
---
# Using Agents
Agents in Kilo Code are specialized personas that tailor the assistant's behavior to your current task. Each agent offers different capabilities, expertise, and access levels to help you accomplish specific goals.
{% callout type="info" %}
The **VSCode (Legacy)** extension calls these **modes** instead of agents. The concept is the same — specialized personas with distinct tool access and behavior.
{% /callout %}
## Why Use Different Agents?
- **Task specialization:** Get precisely the type of assistance you need for your current task
- **Safety controls:** Prevent unintended file modifications when focusing on planning or learning
- **Focused interactions:** Receive responses optimized for your current activity
- **Workflow optimization:** Seamlessly transition between planning, implementing, debugging, and learning
## Switching Agents
{% tabs %}
{% tab label="VSCode" %}
There are several ways to switch agents:
- **Dropdown menu:** Click the agent selector in the sidebar to switch between agents.
- **Slash commands:** Type `/agents` in the chat input to open the agent picker.
- **Keyboard shortcut:** Press `Cmd+.` (macOS) or `Ctrl+.` (Windows/Linux) to cycle through available agents. Add `Shift` to cycle in reverse.
{% /tab %}
{% tab label="CLI" %}
There are several ways to switch agents:
- **Cycle agents:** Press `Tab` to cycle forward through agents, or `Shift+Tab` to cycle backward.
- **Agent picker:** Press `Ctrl+X a` (leader key + `a`) to open the full agent list.
- **Slash commands:** Type `/agents` in the chat input to open the agent picker.
- **Config file:** Set the `default_agent` key in your configuration to change the default agent on startup.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
{% youtube url="https://youtu.be/cS4vQfX528w" caption="Explaining the different modes in Kilo Code" /%}
Four ways to switch modes:
1. **Dropdown menu:** Click the selector to the left of the chat input
{% image src="/docs/img/modes/modes.png" alt="Using the dropdown menu to switch modes" width="400" /%}
2. **Slash command:** Type `/agents` or `/modes` to list modes and switch. Type `/newtask` to create a new task, or `/smol` to condense your context window.
{% image src="/docs/img/modes/modes-1.png" alt="Using slash commands to switch modes" width="400" /%}
### Understanding /newtask vs /smol
Users often confuse `/newtask` and `/smol`. Here's the key difference:
| Command | Purpose | When to Use |
| ---------- | ----------------------------------------------------- | ----------------------------------------------------------------------- |
| `/newtask` | Creates a new task with context from the current task | When you want to start something new while carrying over context |
| `/smol` | Condenses your current context window | When your conversation is getting too long and you want to summarize it |
3. **Toggle command/Keyboard shortcut:** Use the keyboard shortcut below, applicable to your operating system. Each press cycles through the available modes in sequence, wrapping back to the first mode after reaching the end.
| Operating System | Shortcut |
| ---------------- | -------- |
| macOS | ⌘ + . |
| Windows | Ctrl + . |
| Linux | Ctrl + . |
You can hold `shift` to move backwards through the list of modes, for example ⌘ + shift + on macOS.
4. **Accept suggestions:** Click on mode switch suggestions that Kilo Code offers when appropriate
{% image src="/docs/img/modes/modes-2.png" alt="Accepting a mode switch suggestion from Kilo Code" width="400" /%}
{% /tab %}
{% /tabs %}
## Built-in Agents
{% tabs %}
{% tab label="VSCode" %}
### code (Default)
| Aspect | Details |
| -------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Description** | A skilled software engineer with expertise in programming languages, design patterns, and best practices |
| **Tool Access** | Full access to all tools: `read`, `edit`, `glob`, `grep`, `bash`, `task`, `webfetch`, plus tools from MCP servers |
| **Ideal For** | Writing code, implementing features, debugging, and general development |
| **Special Features** | No tool restrictions — full flexibility for all coding tasks |
### ask
| Aspect | Details |
| -------------------- | ------------------------------------------------------------------------------------------------- |
| **Description** | A knowledgeable technical assistant focused on answering questions without changing your codebase |
| **Tool Access** | Read-only tools only (cannot edit files or run commands) |
| **Ideal For** | Code explanation, concept exploration, and technical learning |
| **Special Features** | Optimized for informative responses without modifying your project |
### plan
| Aspect | Details |
| -------------------- | ---------------------------------------------------------------------------------------------------- |
| **Description** | An experienced technical leader and planner who helps design systems and create implementation plans |
| **Tool Access** | Read-only tools plus restricted file editing (plan files in `.kilo/plans/` only) |
| **Ideal For** | System design, high-level planning, and architecture discussions |
| **Special Features** | Similar to the legacy extension's "Architect" mode, with a planning-focused approach |
### debug
| Aspect | Details |
| -------------------- | ----------------------------------------------------------------------------------- |
| **Description** | An expert problem solver specializing in systematic troubleshooting and diagnostics |
| **Tool Access** | Full access to all tools |
| **Ideal For** | Tracking down bugs, diagnosing errors, and resolving complex issues |
| **Special Features** | Uses a methodical approach of analyzing, narrowing possibilities, and fixing issues |
### orchestrator (Deprecated)
| Aspect | Details |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
| **Description** | A strategic workflow orchestrator who coordinates complex tasks by delegating them to appropriate specialized agents |
| **Tool Access** | Limited access to create new tasks and coordinate workflows |
| **Ideal For** | Breaking down complex projects into manageable subtasks assigned to specialized agents |
| **Special Features** | Delegates work to other agents; also has access to the **explore** subagent for codebase exploration |
{% callout type="warning" %}
Orchestrator is deprecated and will be removed in a future release. Agents with full tool access (Code, Plan, Debug) now support subagents natively — there's no need for a dedicated orchestrator. See [Orchestrator Mode (Deprecated)](/docs/code-with-ai/agents/orchestrator-mode) for migration details.
{% /callout %}
{% callout type="info" %}
The VSCode extension and CLI do not include a built-in Review agent. Code review workflows can be handled by the **code** agent or via custom agent configurations.
{% /callout %}
{% /tab %}
{% tab label="CLI" %}
### code (Default)
| Aspect | Details |
| -------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Description** | A skilled software engineer with expertise in programming languages, design patterns, and best practices |
| **Tool Access** | Full access to all tools: `read`, `edit`, `glob`, `grep`, `bash`, `task`, `webfetch`, plus tools from MCP servers |
| **Ideal For** | Writing code, implementing features, debugging, and general development |
| **Special Features** | No tool restrictions — full flexibility for all coding tasks |
### ask
| Aspect | Details |
| -------------------- | ------------------------------------------------------------------------------------------------- |
| **Description** | A knowledgeable technical assistant focused on answering questions without changing your codebase |
| **Tool Access** | Read-only tools only (cannot edit files or run commands) |
| **Ideal For** | Code explanation, concept exploration, and technical learning |
| **Special Features** | Optimized for informative responses without modifying your project |
### plan
| Aspect | Details |
| -------------------- | ---------------------------------------------------------------------------------------------------- |
| **Description** | An experienced technical leader and planner who helps design systems and create implementation plans |
| **Tool Access** | Read-only tools plus restricted file editing (plan files in `.kilo/plans/` only) |
| **Ideal For** | System design, high-level planning, and architecture discussions |
| **Special Features** | Similar to the legacy extension's "Architect" mode, with a planning-focused approach |
### debug
| Aspect | Details |
| -------------------- | ----------------------------------------------------------------------------------- |
| **Description** | An expert problem solver specializing in systematic troubleshooting and diagnostics |
| **Tool Access** | Full access to all tools |
| **Ideal For** | Tracking down bugs, diagnosing errors, and resolving complex issues |
| **Special Features** | Uses a methodical approach of analyzing, narrowing possibilities, and fixing issues |
### orchestrator (Deprecated)
| Aspect | Details |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
| **Description** | A strategic workflow orchestrator who coordinates complex tasks by delegating them to appropriate specialized agents |
| **Tool Access** | Limited access to create new tasks and coordinate workflows |
| **Ideal For** | Breaking down complex projects into manageable subtasks assigned to specialized agents |
| **Special Features** | Delegates work to other agents; also has access to the **explore** subagent for codebase exploration |
{% callout type="warning" %}
Orchestrator is deprecated and will be removed in a future release. Agents with full tool access (Code, Plan, Debug) now support subagents natively — there's no need for a dedicated orchestrator. See [Orchestrator Mode (Deprecated)](/docs/code-with-ai/agents/orchestrator-mode) for migration details.
{% /callout %}
{% callout type="info" %}
The VSCode extension and CLI do not include a built-in Review agent. Code review workflows can be handled by the **code** agent or via custom agent configurations.
{% /callout %}
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Code Mode (Default)
| Aspect | Details |
| -------------------- | -------------------------------------------------------------------------------------------------------- |
| **Description** | A skilled software engineer with expertise in programming languages, design patterns, and best practices |
| **Tool Access** | Full access to all tool groups: `read`, `edit`, `browser`, `command`, `mcp` |
| **Ideal For** | Writing code, implementing features, debugging, and general development |
| **Special Features** | No tool restrictions—full flexibility for all coding tasks |
### Ask Mode
| Aspect | Details |
| -------------------- | ------------------------------------------------------------------------------------------------- |
| **Description** | A knowledgeable technical assistant focused on answering questions without changing your codebase |
| **Tool Access** | Limited access: `read`, `browser`, `mcp` only (cannot edit files or run commands) |
| **Ideal For** | Code explanation, concept exploration, and technical learning |
| **Special Features** | Optimized for informative responses without modifying your project |
### Architect Mode
| Aspect | Details |
| -------------------- | ---------------------------------------------------------------------------------------------------- |
| **Description** | An experienced technical leader and planner who helps design systems and create implementation plans |
| **Tool Access** | Access to `read`, `browser`, `mcp`, and restricted `edit` (markdown files only) |
| **Ideal For** | System design, high-level planning, and architecture discussions |
| **Special Features** | Follows a structured approach from information gathering to detailed planning |
### Debug Mode
| Aspect | Details |
| -------------------- | ----------------------------------------------------------------------------------- |
| **Description** | An expert problem solver specializing in systematic troubleshooting and diagnostics |
| **Tool Access** | Full access to all tool groups: `read`, `edit`, `browser`, `command`, `mcp` |
| **Ideal For** | Tracking down bugs, diagnosing errors, and resolving complex issues |
| **Special Features** | Uses a methodical approach of analyzing, narrowing possibilities, and fixing issues |
{% callout type="tip" %}
**Keep debugging separate from main tasks:** When using Debug mode, ask Kilo to "start a new task in Debug mode with all of the necessary context needed to figure out X" so that the debugging process uses its own context window and doesn't pollute the main task.
{% /callout %}
### Orchestrator Mode
| Aspect | Details |
| -------------------- | ------------------------------------------------------------------------------------------------------------------- |
| **Description** | A strategic workflow orchestrator who coordinates complex tasks by delegating them to appropriate specialized modes |
| **Tool Access** | Limited access to create new tasks and coordinate workflows |
| **Ideal For** | Breaking down complex projects into manageable subtasks assigned to specialized modes |
| **Special Features** | Uses the new_task tool to delegate work to other modes |
### Review Mode
| Aspect | Details |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Description** | An expert code reviewer specializing in analyzing changes to provide structured feedback on quality, security, and best practices |
| **Tool Access** | Access to `read`, `browser`, `mcp`, and when permitted, `edit` |
| **Ideal For** | Catching issues early, enforcing code standards, accelerating PR turnaround |
| **Special Features** | Code review before committing, surfacing feedback across performance, security, style, and test coverage |
{% /tab %}
{% /tabs %}
## Custom Agents
Create your own specialized assistants by defining tool access, file permissions, and behavior instructions. Custom agents help enforce team standards or create purpose-specific assistants. See [Custom Modes documentation](/docs/customize/custom-modes) for setup instructions.
packages/kilo-docs/pages/code-with-ai/agents/using-modes.md
-121
View File
@@ -1,121 +0,0 @@
---
title: "Using Modes"
description: "Understanding and using different modes in Kilo Code"
---
# Using Modes
Modes in Kilo Code are specialized personas that tailor the assistant's behavior to your current task. Each mode offers different capabilities, expertise, and access levels to help you accomplish specific goals.
## Why Use Different Modes?
- **Task specialization:** Get precisely the type of assistance you need for your current task
- **Safety controls:** Prevent unintended file modifications when focusing on planning or learning
- **Focused interactions:** Receive responses optimized for your current activity
- **Workflow optimization:** Seamlessly transition between planning, implementing, debugging, and learning
{% youtube url="https://youtu.be/cS4vQfX528w" caption="Explaining the different modes in Kilo Code" /%}
## Switching Between Modes
Four ways to switch modes:
1. **Dropdown menu:** Click the selector to the left of the chat input
{% image src="/docs/img/modes/modes.png" alt="Using the dropdown menu to switch modes" width="400" /%}
2. **Slash command:** Type `/architect`, `/ask`, `/debug`, or `/code` in the chat input to switch modes. Type `/newtask` to create a new task, or `/smol` to condense your context window.
{% image src="/docs/img/modes/modes-1.png" alt="Using slash commands to switch modes" width="400" /%}
### Understanding /newtask vs /smol
Users often confuse `/newtask` and `/smol`. Here's the key difference:
| Command | Purpose | When to Use |
| ---------- | ----------------------------------------------------- | ----------------------------------------------------------------------- |
| `/newtask` | Creates a new task with context from the current task | When you want to start something new while carrying over context |
| `/smol` | Condenses your current context window | When your conversation is getting too long and you want to summarize it |
3. **Toggle command/Keyboard shortcut:** Use the keyboard shortcut below, applicable to your operating system. Each press cycles through the available modes in sequence, wrapping back to the first mode after reaching the end.
| Operating System | Shortcut |
| ---------------- | -------- |
| macOS | ⌘ + . |
| Windows | Ctrl + . |
| Linux | Ctrl + . |
4. **Accept suggestions:** Click on mode switch suggestions that Kilo Code offers when appropriate
{% image src="/docs/img/modes/modes-2.png" alt="Accepting a mode switch suggestion from Kilo Code" width="400" /%}
## Built-in Modes
### Code Mode (Default)
| Aspect | Details |
| -------------------- | -------------------------------------------------------------------------------------------------------- |
| **Description** | A skilled software engineer with expertise in programming languages, design patterns, and best practices |
| **Tool Access** | Full access to all tool groups: `read`, `edit`, `browser`, `command`, `mcp` |
| **Ideal For** | Writing code, implementing features, debugging, and general development |
| **Special Features** | No tool restrictions—full flexibility for all coding tasks |
### Ask Mode
| Aspect | Details |
| -------------------- | ------------------------------------------------------------------------------------------------- |
| **Description** | A knowledgeable technical assistant focused on answering questions without changing your codebase |
| **Tool Access** | Limited access: `read`, `browser`, `mcp` only (cannot edit files or run commands) |
| **Ideal For** | Code explanation, concept exploration, and technical learning |
| **Special Features** | Optimized for informative responses without modifying your project |
### Architect Mode
| Aspect | Details |
| -------------------- | ---------------------------------------------------------------------------------------------------- |
| **Description** | An experienced technical leader and planner who helps design systems and create implementation plans |
| **Tool Access** | Access to `read`, `browser`, `mcp`, and restricted `edit` (markdown files only) |
| **Ideal For** | System design, high-level planning, and architecture discussions |
| **Special Features** | Follows a structured approach from information gathering to detailed planning |
### Debug Mode
| Aspect | Details |
| -------------------- | ----------------------------------------------------------------------------------- |
| **Description** | An expert problem solver specializing in systematic troubleshooting and diagnostics |
| **Tool Access** | Full access to all tool groups: `read`, `edit`, `browser`, `command`, `mcp` |
| **Ideal For** | Tracking down bugs, diagnosing errors, and resolving complex issues |
| **Special Features** | Uses a methodical approach of analyzing, narrowing possibilities, and fixing issues |
{% callout type="tip" %}
**Keep debugging separate from main tasks:** When using Debug mode, ask Kilo to "start a new task in Debug mode with all of the necessary context needed to figure out X" so that the debugging process uses its own context window and doesn't pollute the main task.
{% /callout %}
### Orchestrator Mode
| Aspect | Details |
| -------------------- | ------------------------------------------------------------------------------------------------------------------- |
| **Description** | A strategic workflow orchestrator who coordinates complex tasks by delegating them to appropriate specialized modes |
| **Tool Access** | Limited access to create new tasks and coordinate workflows |
| **Ideal For** | Breaking down complex projects into manageable subtasks assigned to specialized modes |
| **Special Features** | Uses the new_task tool to delegate work to other modes |
### Review Mode
| Aspect | Details |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Description** | An expert code reviewer specializing in analyzing changes to provide structured feedback on quality, security, and best practices |
| **Tool Access** | Access to `read`, `browser`, `mcp`, and when permitted, `edit` |
| **Ideal For** | Catching issues early, enforcing code standards, accelerating PR turnaround |
| **Special Features** | Code review before committing, surfacing feedback across performance, security, style, and test coverage |
## Custom Modes
Create your own specialized assistants by defining tool access, file permissions, and behavior instructions. Custom modes help enforce team standards or create purpose-specific assistants. See [Custom Modes documentation](/docs/customize/custom-modes) for setup instructions.
<!--
EXISTING PAGES TO MIGRATE:
- `basic-usage/using-modes` - Modes documentation
Migrate the existing modes documentation here.
-->
packages/kilo-docs/pages/code-with-ai/features/autocomplete/index.md
+42
View File
@@ -7,6 +7,45 @@ description: "AI-powered code autocompletion in Kilo Code"
Kilo Code's autocomplete feature provides intelligent code suggestions and completions while you're typing, helping you write code faster and more efficiently. It offers both automatic and manual triggering options.
{% tabs %}
{% tab label="VSCode" %}
## How Autocomplete Works
The extension uses **Fill-in-the-Middle (FIM)** completion powered by Codestral (`mistralai/codestral-2508`). It analyzes the code before and after your cursor to generate contextually accurate inline suggestions.
## Triggering Options
### Auto-trigger
Autocomplete is **enabled by default** and automatically shows inline suggestions as you type. Suggestions appear as ghost text that you can accept with `Tab`.
### Trigger on keybinding (Cmd+L)
Press `Cmd+L` (Mac) or `Ctrl+L` (Windows/Linux) to manually request a completion at your cursor position.
{% callout type="note" %}
This keybinding requires `kilo-code.new.autocomplete.enableSmartInlineTaskKeybinding` to be enabled in VS Code settings. It is **disabled by default**.
{% /callout %}
## Status Bar
The extension displays an **autocomplete status indicator** in the VS Code status bar, including:
- Current autocomplete state (active/snoozed)
- Cumulative cost tracking for autocomplete requests
### Snooze / Unsnooze
You can temporarily disable autocomplete by clicking the status bar item to **snooze** it. Click again to **unsnooze** and re-enable suggestions.
## Copilot Conflict Detection
The extension automatically detects if **GitHub Copilot** inline suggestions are enabled and warns you about potential conflicts. Disable Copilot's inline completions for the best experience with Kilo Code autocomplete.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
## How Autocomplete Works
Autocomplete analyzes your code context and provides:
@@ -86,6 +125,9 @@ If using Cursor, go to **Settings** > **Cursor Settings** > **Tab**, and toggle
{% image src="https://github.com/user-attachments/assets/fd2eeae2-f770-40ca-8a72-a9d5a1c17d47" alt="Disable Cursor autocomplete" width="800" caption="Disable Cursor autocomplete" /%}
{% /tab %}
{% /tabs %}
## Best Practices
1. **Balance speed and quality**: Faster models provide quicker suggestions but may be less accurate
packages/kilo-docs/pages/code-with-ai/features/browser-use.md
+84
View File
@@ -13,6 +13,32 @@ Browser Use requires an advanced agentic model. It is typically most reliable wi
## How Browser Use Works
{% tabs %}
{% tab label="VSCode" %}
Browser automation is built into the extension and requires no manual setup. Enable it from **Settings → Browser** and Kilo handles the rest automatically.
{% /tab %}
{% tab label="CLI" %}
Kilo Code uses [Playwright](https://playwright.dev/) for browser automation. Add it to your `kilo.jsonc` configuration:
```json
{
"mcp": {
"playwright": {
"type": "local",
"command": ["npx", "-y", "@playwright/mcp@latest"]
}
}
}
```
Playwright downloads Chromium automatically on first use.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
By default, Kilo Code uses a built-in browser that:
- Launches automatically when you ask Kilo to visit a website
@@ -22,6 +48,9 @@ By default, Kilo Code uses a built-in browser that:
All of this happens directly within VS Code, with no setup required.
{% /tab %}
{% /tabs %}
## Using Browser Use
A typical browser interaction follows this pattern:
@@ -39,6 +68,38 @@ For example:
## How Browser Actions Work
{% tabs %}
{% tab label="VSCode" %}
Kilo launches a browser automatically when asked and returns screenshots after each action so you can see what's happening. It can navigate to URLs, click elements, fill in forms, scroll, hover, select from dropdowns, and drag and drop — all driven by natural language instructions in chat.
{% /tab %}
{% tab label="CLI" %}
The Playwright MCP server provides a set of browser tools for interacting with web pages. These tools return screenshots and accessibility snapshots after each action.
Key characteristics:
- The browser launches automatically when a browser tool is invoked
- Multiple browser tools can be used in sequence
- Screenshots are captured after each action for visual feedback
### Available Browser Tools
| Tool | Description | When to Use |
| -------------------- | ----------------------------------- | ------------------------------------- |
| `browser_navigate` | Navigates to a URL | Opening a web page |
| `browser_click` | Clicks an element on the page | Interacting with buttons, links, etc. |
| `browser_type` | Types text into an input element | Filling forms, search boxes |
| `browser_screenshot` | Captures a screenshot of the page | Inspecting visual state |
| `browser_scroll` | Scrolls the page or a specific area | Viewing content above or below |
| `browser_hover` | Hovers over an element | Revealing tooltips or menus |
| `browser_select` | Selects an option from a dropdown | Choosing from select elements |
| `browser_drag` | Drags an element to a target | Drag-and-drop interactions |
{% /tab %}
{% tab label="VSCode (Legacy)" %}
The browser_action tool controls a browser instance that returns screenshots and console logs after each action, allowing you to see the results of interactions.
Key characteristics:
@@ -59,8 +120,28 @@ Key characteristics:
| `scroll_up` | Scrolls up by one page | Returning to previous content |
| `close` | Closes the browser | Ending a browser session |
{% /tab %}
{% /tabs %}
## Browser Use Settings
{% tabs %}
{% tab label="VSCode" %}
Browser automation settings are available under **Settings → Browser**:
- **Enable browser automation**: Toggle to enable or disable browser automation
- **Headless mode**: Run the browser without a visible window (default: disabled)
- **Use system Chrome**: Enabled by default — uses your installed Chrome. Disable to have Playwright download and use Chromium instead.
{% /tab %}
{% tab label="CLI" %}
Browser automation is configured in your `kilo.jsonc` file. No additional settings are required — Playwright manages the browser lifecycle automatically.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
{% callout type="info" title="Default Browser Settings" %}
- **Enable browser tool**: Enabled
@@ -161,3 +242,6 @@ Connect to a visible Chrome window to observe Kilo's interactions in real-time:
```bash
google-chrome --remote-debugging-port=9222 --user-data-dir=/tmp/chrome-debug --no-first-run
```
{% /tab %}
{% /tabs %}
packages/kilo-docs/pages/code-with-ai/features/checkpoints.md
+101 -12
View File
@@ -14,6 +14,65 @@ Checkpoints let you:
- Compare different implementation approaches
- Revert to previous project states without losing work
## Configuration Options
{% tabs %}
{% tab label="VSCode" %}
Checkpoints (called **snapshots** in the new extension) are configured via the `snapshot` key in your config file (`kilo.jsonc` or `~/.config/kilo/kilo.jsonc`):
```json
{
"snapshot": true
}
```
You can also toggle this in Settings:
1. Open Settings by clicking the gear icon {% codicon name="gear" /%}
2. Go to the `Checkpoints` tab
3. Toggle the snapshot setting
{% /tab %}
{% tab label="CLI" %}
Checkpoints are controlled by the `snapshot` boolean in your `kilo.jsonc` configuration file:
```json
{
"snapshot": true
}
```
When enabled, the system automatically captures snapshots at each step of a task.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Access checkpoint settings in Kilo Code settings under the "Checkpoints" section:
1. Open Settings by clicking the gear icon {% codicon name="gear" /%} → Checkpoints
2. Check or uncheck the "Enable automatic checkpoints" checkbox
{% image src="/docs/img/checkpoints/checkpoints.png" alt="Checkpoint settings in Kilo Code configuration" width="500" /%}
{% /tab %}
{% /tabs %}
## How Checkpoints Work
{% tabs %}
{% tab label="VSCode" %}
The new extension uses **git-based snapshots** of your working directory. Snapshots are taken before and after agent edits. They integrate with your existing Git repository — no separate shadow repository is created.
**Reverting changes:**
You can revert any message's changes from the chat. A **Revert Banner** appears at the top of the chat when the session is in a reverted state, making it clear that you are viewing an earlier state. Use the banner to unrevert and return to the latest state.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
{% callout type="info" title="Important Notes" %}
- **Checkpoints are enabled by default.**
@@ -25,17 +84,6 @@ Checkpoints let you:
{% /callout %}
## Configuration Options
Access checkpoint settings in Kilo Code settings under the "Checkpoints" section:
1. Open Settings by clicking the gear icon {% codicon name="gear" /%} → Checkpoints
2. Check or uncheck the "Enable automatic checkpoints" checkbox
{% image src="/docs/img/checkpoints/checkpoints.png" alt="Checkpoint settings in Kilo Code configuration" width="500" /%}
## How Checkpoints Work
Kilo Code captures snapshots of your project's state using a shadow Git repository, separate from your main version control system. These snapshots, called checkpoints, automatically record changes throughout your AI-assisted workflow—whenever tasks begin, files change, or commands run.
Checkpoints are stored as Git commits in the shadow repository, capturing:
@@ -46,8 +94,35 @@ Checkpoints are stored as Git commits in the shadow repository, capturing:
- Renamed files
- Binary file changes
{% /tab %}
{% /tabs %}
## Working with Checkpoints
{% tabs %}
{% tab label="VSCode" %}
Checkpoints are integrated directly into your workflow through the chat interface. Each message that caused file changes shows a diff summary. You can:
- Click the diff badge on a message to open the **Diff Viewer** and review what changed
- Click **Revert** on any message to restore the workspace to its state before that message
A **Revert Banner** is shown at the top of the chat whenever you are in a reverted state, with an option to return to the current state.
{% /tab %}
{% tab label="CLI" %}
Checkpoints are captured automatically at each step of a task. In the CLI terminal interface, checkpoints appear as revert points in the conversation. You can revert to any point by selecting the corresponding message.
### Reverting Changes
- **Full revert**: Revert your workspace to any point in the conversation
- **Undo a revert**: Restore the state before the last revert
- **Per-file revert**: Selectively undo changes to specific files while keeping others
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Checkpoints are integrated directly into your workflow through the chat interface.
Checkpoints appear directly in your chat history in two forms:
@@ -93,6 +168,9 @@ To restore a project to a previous checkpoint state:
{% image src="/docs/img/checkpoints/checkpoints-9.png" alt="Confirmation dialog for restoring checkpoint with files & task" width="300" /%}
{% /tab %}
{% /tabs %}
### Limitations and Considerations
- **Scope**: Checkpoints only capture changes made during active Kilo Code tasks
@@ -102,6 +180,14 @@ To restore a project to a previous checkpoint state:
## Technical Implementation
{% tabs %}
{% tab label="VSCode" %}
The new extension uses the underlying Git repository in your workspace to create snapshot commits. No shadow repository is used.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Checkpoint Architecture
The checkpoint system consists of:
@@ -183,9 +269,12 @@ Checkpoints do not support nested Git repositories. The working directory must b
Operations are queued to prevent concurrent Git operations that might corrupt repository state. This ensures that rapid checkpoint operations complete safely even when requested in quick succession.
{% /tab %}
{% /tabs %}
## Git Installation
Checkpoints require Git to be installed on your system. The implementation uses the `simple-git` library, which relies on Git command-line tools to create and manage shadow repositories.
Checkpoints require Git to be installed on your system.
### macOS
packages/kilo-docs/pages/code-with-ai/features/code-actions.md
+34
View File
@@ -7,6 +7,37 @@ description: "Quick code actions and refactoring with Kilo Code"
Code Actions are a powerful feature of VS Code that provide quick fixes, refactorings, and other code-related suggestions directly within the editor. Kilo Code integrates with this system to offer AI-powered assistance for common coding tasks.
{% callout type="info" %}
Code Actions are a **VS Code extension feature** and are not available in the CLI/TUI.
{% /callout %}
{% tabs %}
{% tab label="VSCode" %}
## Available Code Actions
The extension provides code actions via the editor context menu and lightbulb:
- **Add to Context:** Adds selected code (with file path and line numbers) to the active chat session. Keyboard shortcut: `Cmd+K Cmd+A` (Mac) or `Ctrl+K Ctrl+A` (Windows/Linux).
- **Explain Code:** Asks Kilo to explain the selected code.
- **Fix Code:** Asks Kilo to fix problems in the selected code.
- **Improve Code:** Asks Kilo to suggest improvements to the selected code.
### Agent Manager Integration
If the **Agent Manager** is active, code actions route to the current Agent Manager session rather than the sidebar chat. This allows code actions to work seamlessly within multi-session workflows.
### Terminal Context Menu
The extension also adds code actions to the **terminal context menu**:
- **Add Terminal Content:** Adds selected terminal output to the chat context.
- **Fix Command:** Asks Kilo to fix a failed terminal command.
- **Explain Command:** Asks Kilo to explain a terminal command or its output.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
## What are Code Actions?
Code Actions appear as a lightbulb icon (💡) in the editor gutter (the area to the left of the line numbers). They can also be accessed via the right-click context menu, or via keyboard shortcut. They are triggered when:
@@ -90,4 +121,7 @@ You can customize the prompts used for each Code Action by modifying the "Suppor
3. **Edit the Prompts:** Modify the text in the text area for the prompt you want to customize. You can use placeholders like `${filePath}` and `${selectedText}` to include information about the current file and selection.
4. **Click "Done":** Save your changes.
{% /tab %}
{% /tabs %}
By using Kilo Code's Code Actions, you can quickly get AI-powered assistance directly within your coding workflow. This can save you time and help you write better code.
packages/kilo-docs/pages/code-with-ai/features/git-commit-generation.md
+17
View File
@@ -53,6 +53,20 @@ Common types include:
## Configuration
{% tabs %}
{% tab label="VSCode" %}
The extension provides the same **SCM button** in the VS Code Source Control panel. Clicking it generates a commit message using the CLI backend's commit message generation API.
Configuration is handled through the extension's settings or the shared `kilo.jsonc` config file.
{% callout type="info" %}
Git commit message generation is a **VS Code extension feature**. It is not available in the CLI/TUI.
{% /callout %}
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Customizing the Commit Template
You can customize how commit messages are generated by modifying the prompt template:
@@ -81,6 +95,9 @@ You can configure which API profile to use for commit message generation:
Consider creating a dedicated [API configuration profile](/docs/ai-providers) with a faster, more cost-effective model specifically for commit message generation.
{% /callout %}
{% /tab %}
{% /tabs %}
## Best Practices
### Staging Strategy
packages/kilo-docs/pages/code-with-ai/index.md
+2 -2
View File
@@ -34,10 +34,10 @@ Use Kilo Code wherever you work:
Kilo uses specialized agents to help with different tasks:
- [**Chat Interface**](/docs/code-with-ai/agents/chat-interface) — Conversation-based coding
- [**Using Modes**](/docs/code-with-ai/agents/using-modes) — Switch between Code, Architect, Debug, and Ask modes
- [**Using Agents**](/docs/code-with-ai/agents/using-agents) — Switch between Code, Ask, Plan, Debug, and other agents
- [**Model Selection**](/docs/code-with-ai/agents/model-selection) — Choose the right AI model for each task
- [**Context Mentions**](/docs/code-with-ai/agents/context-mentions) — Reference files, functions, and symbols
- [**Orchestrator Mode**](/docs/code-with-ai/agents/orchestrator-mode) — Complex multi-step tasks
- [**Orchestrator Mode**](/docs/code-with-ai/agents/orchestrator-mode) — Legacy orchestration (now built into all agents)
- [**Free & Budget Models**](/docs/code-with-ai/agents/free-and-budget-models) — Cost-effective AI options
## Features
packages/kilo-docs/pages/code-with-ai/platforms/cli.md
+3 -2
View File
@@ -1,6 +1,7 @@
---
title: "Kilo CLI"
description: "Using Kilo Code from the command line"
platform: new
---
{% callout type="warning" title="Version Notice" %}
@@ -167,7 +168,7 @@ Review your code locally before pushing — catch issues early without waiting f
Configuration is managed through:
- `/connect` command for provider setup (interactive)
- Config files in **`~/.config/kilo/`**: the CLI (Kilo CLI 1.0 from [Kilo-Org/kilocode](https://github.com/Kilo-Org/kilocode)) merges `config.json`, `opencode.json`, and `opencode.jsonc`. Use **`opencode.json`** (or `opencode.jsonc`) for provider, model, permission, and **MCP** settings. Restart the CLI after editing. See [Using MCP in the CLI](/docs/automate/mcp/using-in-cli) for MCP config format.
- Config files in **`~/.config/kilo/`**: use **`kilo.jsonc`** for provider, model, permission, and **MCP** settings. Restart the CLI after editing. See [Using MCP in Kilo Code](/docs/automate/mcp/using-in-kilo-code) for MCP config format.
- `kilo auth` for credential management
## Slash Commands
@@ -175,7 +176,7 @@ Configuration is managed through:
The CLI's interactive mode supports slash commands for common operations. The main commands are documented above in the [Interactive Slash Commands](#interactive-slash-commands) section.
{% callout type="tip" %}
**Confused about /newtask vs /smol in the IDE?** See the [Using Modes](/docs/code-with-ai/agents/using-modes#understanding-newtask-vs-smol) documentation for details.
**Confused about /newtask vs /smol in the IDE?** See the [Using Agents](/docs/code-with-ai/agents/using-agents#understanding-newtask-vs-smol) documentation for details.
{% /callout %}
## Permissions
packages/kilo-docs/pages/code-with-ai/platforms/vscode.md
+54
View File
@@ -5,6 +5,60 @@ description: "Using Kilo Code in Visual Studio Code"
# VS Code Extension
Kilo Code is available as two VS Code extensions: the **VSCode (Legacy)** extension and the current **VSCode** version built on the Kilo CLI core.
{% tabs %}
{% tab label="VSCode" %}
## Installation
1. Open VS Code
2. Go to Extensions (`Ctrl+Shift+X` / `Cmd+Shift+X`)
3. Search for "Kilo Code"
4. Click the dropdown arrow next to **Install** and select **Install Pre-Release Version**
The extension bundles its own CLI binary and spawns `kilo serve` as a background process. All communication happens over HTTP + SSE.
## Key Features
Key features include:
- **SolidJS-based UI** — Rebuilt sidebar with a modern component architecture
- **[JSONC config files](/docs/getting-started/settings)** — Portable settings in `kilo.jsonc` instead of VS Code settings
- **[Granular permissions](/docs/getting-started/settings/auto-approving-actions)** — Per-tool permission rules with glob patterns
- **[Agents](/docs/code-with-ai/agents/using-agents)** — Customizable agents (`.kilo/agents/*.md`) replacing the modes system
- **[Agent Manager](/docs/automate/agent-manager)** — Enhanced with diff panel, multi-model comparison, PR import, and code review annotations
- **[Autocomplete](/docs/code-with-ai/features/autocomplete)** — FIM-based with Codestral, status bar cost tracking
- **[Workflows](/docs/customize/workflows)** — Repeatable prompt templates as `.md` files
- **[Skills](/docs/customize/skills)** — Load specialized domain knowledge from SKILL.md files
- **[Custom Subagents](/docs/customize/custom-subagents)** — Define specialized sub-agents for the `task` tool
- **Open in Tab** — Pop the chat out into a full editor tab
- **Sub-Agent Viewer** — Read-only panels for viewing child agent sessions
- **Legacy Migration** — Automatic migration wizard for VSCode extension settings
## Shared Settings
The extension shares its configuration with the CLI. Settings in `~/.config/kilo/kilo.jsonc` (global) and `./kilo.jsonc` (project) apply to both the CLI and the extension.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
## Installation
{% partial file="install-vscode.md" /%}
## Key Features
- **Sidebar chat** — AI-powered chat panel in the VS Code activity bar
- **[Autocomplete](/docs/code-with-ai/features/autocomplete)** — Inline code completions as you type
- **[Code Actions](/docs/code-with-ai/features/code-actions)** — Explain, fix, and improve code from the editor context menu
- **[Agents](/docs/code-with-ai/agents/using-agents)** — Code, Ask, Architect, Debug, Orchestrator, and Review modes
- **[Custom Modes](/docs/customize/custom-modes)** — Define custom modes with `.kilocodemodes` YAML files
- **[MCP](/docs/automate/mcp/overview)** — Connect to MCP servers for extended capabilities
- **[Agent Manager](/docs/automate/agent-manager)** — Multi-session orchestration with git worktree isolation
- **[Git Commit Generation](/docs/code-with-ai/features/git-commit-generation)** — AI-powered commit messages from the Source Control panel
- **[Context Mentions](/docs/code-with-ai/agents/context-mentions)** — Reference files, URLs, diagnostics, and git changes with `@`
- **[Checkpoints](/docs/code-with-ai/features/checkpoints)** — Git-based snapshots for undo/redo
{% /tab %}
{% /tabs %}
packages/kilo-docs/pages/collaborate/teams/custom-modes-org.md
+2 -2
View File
@@ -5,7 +5,7 @@ description: "Create organization-wide custom modes"
# Custom Modes (Org)
Custom Modes let you create tailored versions of Kilo’s built-in [modes](/docs/code-with-ai/agents/using-modes) for your organization. You can also adjust the settings for Kilo Code's original default modes. You can define a mode’s purpose, behavior, and tool access — helping Kilo adapt to your team’s unique workflows.
Custom Modes let you create tailored versions of Kilo's built-in [agents](/docs/code-with-ai/agents/using-agents) for your organization. You can also adjust the settings for Kilo Code's original default modes. You can define a mode's purpose, behavior, and tool access — helping Kilo adapt to your team's unique workflows.
For example, Admins and Owners can extend these by creating **Custom Modes** with specialized roles or personalities (e.g. "Documentation Writer" or "Security Reviewer").
@@ -22,7 +22,7 @@ For example, Admins and Owners can extend these by creating **Custom Modes** wit
| ---------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Mode Name** | Display name for the new mode (e.g. _Security Reviewer_). |
| **Mode Slug** | A short identifier used internally (e.g. `security-reviewer`). |
| **Role Definition** | Describe Kilo’s role and personality for this mode. Shapes how it reasons and responds. |
| **Role Definition** | Describe Kilo's role and personality for this mode. Shapes how it reasons and responds. |
| **Short Description** | A brief summary shown in the mode selector. |
| **When to Use (optional)** | Guidance for when this mode should be used. Helps the Orchestrator choose the right mode for a task. |
| **Custom Instructions (optional)** | Add behavioral guidelines specific to this mode. |
packages/kilo-docs/pages/contributing/cline-to-kilo-migration.md
-180
View File
@@ -1,180 +0,0 @@
---
title: "Cline to Kilo: Contributor Migration Guide"
description: "A guide for Cline contributors who want to start contributing to Kilo Code"
---
# Cline to Kilo: Contributor Migration Guide
If you've been contributing to Cline and you're ready to bring those skills over to Kilo Code, you're in the right place. This guide will walk you through what's different, what's the same, and how to get up and running as a Kilo contributor.
The good news: if you've been contributing to Cline, you already have most of the skills you need. The workflows are similar, but there are some differences worth knowing about before you dive in.
## The Quick Version
| What You Know from Cline | What's Different in Kilo |
| -------------------------------------------- | ------------------------ |
| `npm run install:all` | `pnpm install` |
| `npm run protos` required before first build | Not required |
| F5 to launch dev extension | Same — F5 to launch |
| Changesets for versioning | Same — `pnpm changeset` |
## Setting Up Your Environment
### What Stays the Same
- Git, Node.js (v20.18.1+), and VS Code are still your core tools
- F5 still launches the extension in debug mode
- The project structure follows similar patterns (`src/`, `webview-ui/`, `e2e/`)
### What's Changed
**Package Manager: pnpm instead of npm**
Kilo uses pnpm for dependency management. If you don't have it installed:
```bash
npm install -g pnpm
```
Then instead of:
```bash
# Cline
npm run install:all
```
You'll run:
```bash
# Kilo
pnpm install
```
This single command handles everything — the main extension, webview UI, and e2e tests.
**No Protocol Buffer Generation**
In Cline, you needed to run `npm run protos` before your first build. Kilo doesn't require this step. Just install dependencies and you're ready to go.
**Building the Extension**
```bash
pnpm build
```
This builds the webview UI, compiles TypeScript, bundles everything, and drops a `.vsix` file in `bin/`.
## Development Workflow Differences
### Hot Reloading
Kilo has improved hot reloading in development mode:
- **Webview UI changes:** Apply immediately without restart (same as Cline)
- **Core extension changes:** In dev mode (`NODE_ENV="development"`), Kilo automatically triggers `workbench.action.reloadWindow` — no manual debugger restarts needed
In Cline, you had to manually stop debugging, kill background tasks, and restart. Kilo handles this for you during development.
**Note:** Production builds still require the manual stop/restart cycle.
### Git Hooks
Kilo uses Husky for git hooks, which run automatically:
**Pre-commit:**
- Blocks commits directly to main
- Runs type generation (`pnpm generate-types`)
- Checks for type file changes
- Runs lint-staged
**Pre-push:**
- Blocks pushes directly to main
- Compiles the project
- Reminds you to create a changeset if needed
These hooks catch issues early. If a commit or push fails, check the hook output for details.
## Testing
### Running Tests
```bash
# All tests
pnpm test
# Extension tests only
pnpm test:extension
# Webview tests only
pnpm test:webview
# E2E / Integration tests
pnpm test:integration
```
### E2E Test Setup
For integration tests, create a `.env.local` file in the project root:
```
OPENROUTER_API_KEY=sk-or-v1-...
```
Check `e2e/VSCODE_INTEGRATION_TESTS.md` for full details.
## Contributing Code
### Creating a Pull Request
The changeset workflow is identical to Cline:
```bash
pnpm changeset
```
Choose your version bump:
- **major** — breaking changes
- **minor** — new features
- **patch** — bug fixes
Commit the generated `.changeset` file with your changes.
### Code Quality Checks
```bash
pnpm lint # ESLint
pnpm check-types # TypeScript type checking
```
## What's New in Kilo
Beyond the workflow changes, Kilo has expanded significantly as a platform. As a contributor, you might find opportunities to work on:
- **Multiple interfaces:** VS Code, JetBrains, CLI, and web (Cloud Agents, App Builder)
- **Specialized Agent modes:** Code, Ask, Debug, Architect, Orchestrator
- **Custom Modes:** A system for creating and sharing specialized agent configurations
- **Platform features:** Sessions, Parallel Agents, Deploy, Code Reviews, Managed Indexing
- **Kilo Marketplace:** A community-driven repository where you can contribute Skills (modular workflows), MCP Servers (tool integrations), and Modes (custom agent behaviors)
Check the [Architecture Overview](architecture) to understand how these pieces fit together.
## Getting Help
- **Discord:** Real-time support from the community
- **GitHub Discussions:** For questions and feature ideas
- **Reddit:** Community discussions
## TL;DR Checklist
- ✅ Install pnpm globally
- ✅ Fork and clone the Kilo repo
- ✅ Run `pnpm install` (not `npm run install:all`)
- ✅ Skip the protos step — it's not needed
- ✅ Press F5 to launch the dev extension
- ✅ Create a changeset before your PR (`pnpm changeset`)
- ✅ Let the git hooks do their thing
Welcome to Kilo. We're glad you're here.
packages/kilo-docs/pages/contributing/index.md
+1 -1
View File
@@ -6,7 +6,7 @@ description: "Contribute to Kilo Code"
# Contributing Overview
{% callout type="info" %}
**New versions of the VS Code extension and CLI are being developed in [Kilo-Org/Kilo](https://github.com/Kilo-Org/Kilo)** (extension at `packages/kilo-vscode`, CLI at `packages/opencode`). If you're looking to contribute to the extension or CLI, please head over to that repository.
**New versions of the VS Code extension and CLI are being developed in [Kilo-Org/kilocode](https://github.com/Kilo-Org/kilocode)** (extension at `packages/kilo-vscode`, CLI at `packages/opencode`). If you're looking to contribute to the extension or CLI, please head over to that repository.
{% /callout %}
Kilo Code is an open-source project that welcomes contributions from developers of all skill levels. This guide will help you get started with contributing to Kilo Code, whether you're fixing bugs, adding features, improving documentation, or sharing custom modes.
packages/kilo-docs/pages/customize/agents-md.md
+61 -1
View File
@@ -138,6 +138,35 @@ When you start a task in Kilo Code:
### Interaction with Other Rules
{% tabs %}
{% tab label="VSCode" %}
In the new platform, AGENTS.md is loaded alongside other instruction sources. The CLI also supports `.claude/` and `.agents/` directories for compatibility with other tools.
| Source | Scope | Location | Priority |
| ------------------------------------------------ | --------- | ------------------------------------------ | ---------------- |
| **Agent prompt** | Per-agent | `agent.<name>.prompt` in config | 1 (Highest) |
| **[Instructions](/docs/customize/custom-rules)** | Project | `instructions` key in project `kilo.jsonc` | 2 |
| **AGENTS.md** | Project | `AGENTS.md` at project root | 3 |
| **[Instructions](/docs/customize/custom-rules)** | Global | `instructions` key in global `kilo.jsonc` | 4 |
| **[Skills](/docs/customize/skills)** | Both | `.kilo/skills/`, config `skills` key | Loaded on demand |
{% /tab %}
{% tab label="CLI" %}
In the new platform, AGENTS.md is loaded alongside other instruction sources. The CLI also supports `.claude/` and `.agents/` directories for compatibility with other tools.
| Source | Scope | Location | Priority |
| ------------------------------------------------ | --------- | ------------------------------------------ | ---------------- |
| **Agent prompt** | Per-agent | `agent.<name>.prompt` in config | 1 (Highest) |
| **[Instructions](/docs/customize/custom-rules)** | Project | `instructions` key in project `kilo.jsonc` | 2 |
| **AGENTS.md** | Project | `AGENTS.md` at project root | 3 |
| **[Instructions](/docs/customize/custom-rules)** | Global | `instructions` key in global `kilo.jsonc` | 4 |
| **[Skills](/docs/customize/skills)** | Both | `.kilo/skills/`, config `skills` key | Loaded on demand |
{% /tab %}
{% tab label="VSCode (Legacy)" %}
AGENTS.md works alongside Kilo Code's other configuration systems:
| Feature | Scope | Location | Purpose | Priority |
@@ -148,9 +177,37 @@ AGENTS.md works alongside Kilo Code's other configuration systems:
| **[Global Custom Rules](/docs/customize/custom-rules)** | Global | `~/.kilocode/rules/` | Global Kilo Code rules | 4 |
| **[Custom Instructions](/docs/customize/custom-instructions)** | Global | IDE settings | Personal preferences across all projects | 5 (Lowest) |
{% /tab %}
{% /tabs %}
### Enabling/Disabling AGENTS.md
AGENTS.md support is **enabled by default** in Kilo Code. To disable it, edit `settings.json`:
{% tabs %}
{% tab label="VSCode" %}
AGENTS.md is loaded automatically. To disable external skill directories (`.claude/skills/`, `.agents/skills/`), set the environment variable:
```bash
export KILO_DISABLE_EXTERNAL_SKILLS=true
```
AGENTS.md itself cannot be individually disabled — it is always loaded if present. To override its instructions, use higher-priority sources like the `instructions` config key or agent-specific prompts.
{% /tab %}
{% tab label="CLI" %}
AGENTS.md is loaded automatically. To disable external skill directories (`.claude/skills/`, `.agents/skills/`), set the environment variable:
```bash
export KILO_DISABLE_EXTERNAL_SKILLS=true
```
AGENTS.md itself cannot be individually disabled — it is always loaded if present. To override its instructions, use higher-priority sources like the `instructions` config key or agent-specific prompts.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
AGENTS.md support is **enabled by default**. To disable it, edit `settings.json`:
```json
{
@@ -158,6 +215,9 @@ AGENTS.md support is **enabled by default** in Kilo Code. To disable it, edit `s
}
```
{% /tab %}
{% /tabs %}
## Related Features
- **[Custom Rules](/docs/customize/custom-rules)** - Kilo Code-specific rules with more control
packages/kilo-docs/pages/customize/context/codebase-indexing.md
+1
View File
@@ -1,6 +1,7 @@
---
title: "Codebase Indexing"
description: "Index your codebase for improved AI understanding"
platform: legacy
---
# Codebase Indexing
packages/kilo-docs/pages/customize/context/context-condensing.md
+151 -15
View File
@@ -17,9 +17,142 @@ Every AI model has a maximum context window - a limit on how much text it can pr
- Higher API costs due to increased token usage
- Eventually hitting the context limit and being unable to continue
{% tabs %}
{% tab label="VSCode" %}
## The Solution: Auto-Compaction
The new platform uses a **Compaction** system to manage context automatically. When your conversation approaches the token limit, compaction kicks in and produces a structured summary that captures:
- The overall goal of the session
- Key discoveries made along the way
- What has been accomplished so far
- Files that were modified
This summary replaces the earlier conversation history, freeing up context window space while maintaining continuity in your work.
## How Compaction Works
### Automatic Compaction
Compaction triggers automatically when the conversation reaches the `usableWindow` token threshold. The full conversation history is sent to a dedicated **compaction agent**, which produces a structured summary. This happens in the background without interrupting your workflow.
### Context Pruning
In addition to compaction, the system can **prune** old tool outputs to reclaim context space incrementally. Tool results older than a 40,000-token recency window are replaced with `"[Old tool result content cleared]"`. This is a lighter-weight mechanism that runs alongside full compaction.
### Manual Compaction
You can also trigger compaction manually:
- **CLI TUI**: Press `<leader>c` to compact the current session
- **Extension Webview**: Send a `CompactRequest` message to trigger compaction
{% callout type="info" %}
There is no `/condense` chat command on the new platform. Use the keybinding or message-based invocation instead.
{% /callout %}
### The Compaction Process
When compaction is triggered:
1. **Threshold Check**: The system detects that context usage has reached the `usableWindow` limit
2. **Agent Summarization**: The full conversation history is sent to a dedicated compaction agent
3. **Structured Summary**: The agent produces a summary covering the goal, discoveries, accomplishments, and modified files
4. **Replacement**: The detailed history is replaced with the compacted summary
5. **Continuation**: You continue working with the freed-up context space
## Configuration Options
Compaction is configured in your `kilo.jsonc` file:
```jsonc
{
"compaction": {
"auto": true, // Enable or disable automatic compaction
"reserved": 4096, // Number of tokens to reserve (keep free) after compaction
"prune": true, // Enable pruning of old tool outputs beyond the recency window
},
}
```
| Option | Type | Description |
| --------------------- | ------- | ------------------------------------------------------------------------ |
| `compaction.auto` | boolean | Enable or disable automatic compaction when the context threshold is hit |
| `compaction.reserved` | number | Number of tokens to reserve after compaction |
| `compaction.prune` | boolean | Enable pruning of old tool outputs outside the 40K token recency window |
{% /tab %}
{% tab label="CLI" %}
## The Solution: Auto-Compaction
The new platform uses a **Compaction** system to manage context automatically. When your conversation approaches the token limit, compaction kicks in and produces a structured summary that captures:
- The overall goal of the session
- Key discoveries made along the way
- What has been accomplished so far
- Files that were modified
This summary replaces the earlier conversation history, freeing up context window space while maintaining continuity in your work.
## How Compaction Works
### Automatic Compaction
Compaction triggers automatically when the conversation reaches the `usableWindow` token threshold. The full conversation history is sent to a dedicated **compaction agent**, which produces a structured summary. This happens in the background without interrupting your workflow.
### Context Pruning
In addition to compaction, the system can **prune** old tool outputs to reclaim context space incrementally. Tool results older than a 40,000-token recency window are replaced with `"[Old tool result content cleared]"`. This is a lighter-weight mechanism that runs alongside full compaction.
### Manual Compaction
You can also trigger compaction manually:
- **CLI TUI**: Press `<leader>c` to compact the current session
- **Extension Webview**: Send a `CompactRequest` message to trigger compaction
{% callout type="info" %}
There is no `/condense` chat command on the new platform. Use the keybinding or message-based invocation instead.
{% /callout %}
### The Compaction Process
When compaction is triggered:
1. **Threshold Check**: The system detects that context usage has reached the `usableWindow` limit
2. **Agent Summarization**: The full conversation history is sent to a dedicated compaction agent
3. **Structured Summary**: The agent produces a summary covering the goal, discoveries, accomplishments, and modified files
4. **Replacement**: The detailed history is replaced with the compacted summary
5. **Continuation**: You continue working with the freed-up context space
## Configuration Options
Compaction is configured in your `kilo.jsonc` file:
```jsonc
{
"compaction": {
"auto": true, // Enable or disable automatic compaction
"reserved": 4096, // Number of tokens to reserve (keep free) after compaction
"prune": true, // Enable pruning of old tool outputs beyond the recency window
},
}
```
| Option | Type | Description |
| --------------------- | ------- | ------------------------------------------------------------------------ |
| `compaction.auto` | boolean | Enable or disable automatic compaction when the context threshold is hit |
| `compaction.reserved` | number | Number of tokens to reserve after compaction |
| `compaction.prune` | boolean | Enable pruning of old tool outputs outside the 40K token recency window |
{% /tab %}
{% tab label="VSCode (Legacy)" %}
## The Solution: Intelligent Condensing
Context Condensing solves this problem by creating a concise summary of your conversation that captures:
**Context Condensing** solves this problem by creating a concise summary of your conversation that captures:
- The original task or goal
- Key decisions made during the session
@@ -63,20 +196,6 @@ Context Condensing uses an AI model to generate summaries. You can configure whi
You can configure context condensing thresholds and behavior on a per-profile basis, allowing different settings for different projects or use cases.
## Best Practices
### When to Condense
- **Long sessions**: If you've been working for an extended period on a complex task
- **Before major transitions**: When switching to a different aspect of your project
- **When prompted**: When Kilo Code suggests condensing due to context limits
### Maintaining Context Quality
- **Be specific in your initial task**: A clear task description helps create better summaries
- **Use AGENTS.md**: Combine with [AGENTS.md](/docs/customize/agents-md) for persistent project context that doesn't need to be condensed
- **Review the summary**: After condensing, the summary is visible in your chat history
## Troubleshooting
### Context Condensing Error
@@ -95,6 +214,23 @@ If the condensed summary doesn't capture important details:
- Use clear, specific language when describing your tasks
- Important context can be reinforced after condensing by reminding Kilo Code of key details
{% /tab %}
{% /tabs %}
## Best Practices
### When to Condense
- **Long sessions**: If you've been working for an extended period on a complex task
- **Before major transitions**: When switching to a different aspect of your project
- **When prompted**: When Kilo Code suggests condensing or compaction due to context limits
### Maintaining Context Quality
- **Be specific in your initial task**: A clear task description helps create better summaries
- **Use AGENTS.md**: Combine with [AGENTS.md](/docs/customize/agents-md) for persistent project context that doesn't need to be condensed
- **Review the summary**: After condensing or compaction, the summary is visible in your chat history
## Related Features
- [AGENTS.md](/docs/customize/agents-md) - Persistent context storage across sessions
packages/kilo-docs/pages/customize/context/kilocodeignore.md
+183 -4
View File
@@ -13,6 +13,61 @@ If no `.kilocodeignore` file exists, Kilo Code can access all files in the works
## Quick Start
{% tabs %}
{% tab label="VSCode" %}
The primary mechanism for controlling file access is the **permission system** in `kilo.jsonc`. You define tool-level permissions with glob patterns:
```json
{
"permission": {
"read": { "*.env": "deny", "*": "allow" },
"edit": { "dist/**": "deny", "*": "allow" }
}
}
```
If you have an existing `.kilocodeignore` file, it is still supported. The **IgnoreMigrator** automatically converts `.kilocodeignore` patterns into permission `deny` rules on `read` and `edit` tools, so your existing rules continue to work without manual changes.
You can also exclude paths from the file watcher separately using `watcher.ignore`:
```json
{
"watcher": {
"ignore": ["tmp/**", "logs/**"]
}
}
```
{% /tab %}
{% tab label="CLI" %}
The primary mechanism for controlling file access is the **permission system** in `kilo.jsonc`. You define tool-level permissions with glob patterns:
```json
{
"permission": {
"read": { "*.env": "deny", "*": "allow" },
"edit": { "dist/**": "deny", "*": "allow" }
}
}
```
If you have an existing `.kilocodeignore` file, it is still supported. The **IgnoreMigrator** automatically converts `.kilocodeignore` patterns into permission `deny` rules on `read` and `edit` tools, so your existing rules continue to work without manual changes.
You can also exclude paths from the file watcher separately using `watcher.ignore`:
```json
{
"watcher": {
"ignore": ["tmp/**", "logs/**"]
}
}
```
{% /tab %}
{% tab label="VSCode (Legacy)" %}
1. Create a `.kilocodeignore` file at the root of your project.
2. Add patterns for files or folders you want Kilo Code to avoid.
3. Save the file. Kilo Code will pick up the changes automatically.
@@ -34,6 +89,9 @@ coverage/
!secrets/README.md
```
{% /tab %}
{% /tabs %}
## Pattern Rules
`.kilocodeignore` follows the same rules as `.gitignore`:
@@ -47,6 +105,35 @@ Patterns are evaluated relative to the workspace root.
## What It Affects
{% tabs %}
{% tab label="VSCode" %}
File access is controlled through **permission-based access control**. Each tool (`read`, `edit`, `glob`, `grep`, `write`, `bash`, etc.) has its own permission rules evaluated against glob patterns.
In addition to your explicit permission rules:
- **Hardcoded directory ignores** — 27 directories are always skipped (e.g. `node_modules`, `.git`, `dist`, `build`, `.cache`, `__pycache__`, `vendor`, and others).
- **Hardcoded file pattern ignores** — 11 file patterns are always skipped (e.g. lock files, binary artifacts).
- **`.gitignore` and `.ignore` files** are also respected when listing and searching files.
If a file is denied by a permission rule, the tool will report that access was blocked.
{% /tab %}
{% tab label="CLI" %}
File access is controlled through **permission-based access control**. Each tool (`read`, `edit`, `glob`, `grep`, `write`, `bash`, etc.) has its own permission rules evaluated against glob patterns.
In addition to your explicit permission rules:
- **Hardcoded directory ignores** — 27 directories are always skipped (e.g. `node_modules`, `.git`, `dist`, `build`, `.cache`, `__pycache__`, `vendor`, and others).
- **Hardcoded file pattern ignores** — 11 file patterns are always skipped (e.g. lock files, binary artifacts).
- **`.gitignore` and `.ignore` files** are also respected when listing and searching files.
If a file is denied by a permission rule, the tool will report that access was blocked.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Kilo Code checks `.kilocodeignore` before accessing files in tools like:
- [`read_file`](/docs/automate/tools/read-file)
@@ -58,17 +145,109 @@ Kilo Code checks `.kilocodeignore` before accessing files in tools like:
If a file is blocked, Kilo Code will return an "access denied" message and suggest updating your `.kilocodeignore` rules.
## Visibility in Lists
{% /tab %}
{% /tabs %}
## Configuration Details
{% tabs %}
{% tab label="VSCode" %}
### Permission Rules
Permission rules are defined per-tool in `kilo.jsonc`. Patterns are evaluated in order — the last matching rule wins:
```json
{
"permission": {
"read": {
"*.env": "deny",
"secrets/**": "deny",
"*": "allow"
},
"edit": {
"dist/**": "deny",
"*.lock": "deny",
"*": "allow"
}
}
}
```
### Migrating from .kilocodeignore
If you already have a `.kilocodeignore` file, you don't need to do anything — the IgnoreMigrator reads your existing patterns and applies them as `deny` rules on `read` and `edit` tools automatically. You can optionally move your rules into `kilo.jsonc` for more granular control (e.g. denying edits but allowing reads).
### File Watcher Exclusions
The `watcher.ignore` setting controls which paths the file watcher skips. This is separate from tool permissions and only affects change detection:
```json
{
"watcher": {
"ignore": ["tmp/**", "logs/**", ".build/**"]
}
}
```
{% /tab %}
{% tab label="CLI" %}
### Permission Rules
Permission rules are defined per-tool in `kilo.jsonc`. Patterns are evaluated in order — the last matching rule wins:
```json
{
"permission": {
"read": {
"*.env": "deny",
"secrets/**": "deny",
"*": "allow"
},
"edit": {
"dist/**": "deny",
"*.lock": "deny",
"*": "allow"
}
}
}
```
### Migrating from .kilocodeignore
If you already have a `.kilocodeignore` file, you don't need to do anything — the IgnoreMigrator reads your existing patterns and applies them as `deny` rules on `read` and `edit` tools automatically. You can optionally move your rules into `kilo.jsonc` for more granular control (e.g. denying edits but allowing reads).
### File Watcher Exclusions
The `watcher.ignore` setting controls which paths the file watcher skips. This is separate from tool permissions and only affects change detection:
```json
{
"watcher": {
"ignore": ["tmp/**", "logs/**", ".build/**"]
}
}
```
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Visibility in Lists
By default, ignored files are hidden from file lists. You can show them with a lock icon by enabling:
Settings -> Context -> **Show .kilocodeignore'd files in lists and searches**
{% /tab %}
{% /tabs %}
## Checkpoints vs .kilocodeignore
Checkpoint tracking is separate from file access rules. Files blocked by `.kilocodeignore` can still be checkpointed if they are not excluded by `.gitignore`. See the [Checkpoints](/docs/code-with-ai/features/checkpoints) documentation for details.
Checkpoint tracking is separate from file access rules. Files blocked by `.kilocodeignore` or permission rules can still be checkpointed if they are not excluded by `.gitignore`. See the [Checkpoints](/docs/code-with-ai/features/checkpoints) documentation for details.
## Troubleshooting
- **Kilo can't access a file you want:** Remove or narrow the matching rule in `.kilocodeignore`.
- **A file still appears in lists:** Check the setting that shows ignored files in lists and searches.
- **Kilo can't access a file you want:** Remove or narrow the matching rule in `.kilocodeignore` (legacy) or adjust the permission rules in `kilo.jsonc` (VSCode extension & CLI).
- **A file still appears in lists:** In the legacy extension, check the setting that shows ignored files in lists and searches. In the extension & CLI, verify your permission and watcher ignore configuration.
- **`.kilocodeignore` patterns not working in the new platform:** Ensure the file is at the workspace root. The IgnoreMigrator reads it automatically — check that your patterns use valid `.gitignore` syntax.
packages/kilo-docs/pages/customize/context/large-projects.md
+1
View File
@@ -1,6 +1,7 @@
---
title: "Large Projects"
description: "Best practices for using Kilo Code with large codebases"
platform: legacy
---
# Working with Large Projects
packages/kilo-docs/pages/customize/custom-instructions.md
+156 -8
View File
@@ -5,18 +5,162 @@ description: "Provide custom instructions to guide Kilo Code"
# Custom Instructions
Custom Instructions allow you to personalize how Kilo Code behaves, providing specific guidance that shapes responses, coding style, and decision-making processes.
Custom Instructions allow you to personalize how Kilo Code behaves, providing specific guidance that shapes responses, coding style, and decision-making processes. Both the **VSCode** and **CLI** versions support custom instructions, though the mechanisms differ.
## What Are Custom Instructions?
Custom Instructions define specific Extension behaviors, preferences, and constraints beyond Kilo's basic role definition. Examples include coding style, documentation standards, testing requirements, and workflow guidelines.
{% tabs %}
{% tab label="VSCode" %}
The extension provides multiple layers of instruction configuration — from per-agent prompts in the Settings UI to auto-discovered files in your project and global config.
## Per-Agent Prompts
Each agent can have its own custom prompt configured through the settings UI:
1. Open **Settings → Agent Behaviour → Agents** subtab
2. Select the agent you want to customize
3. Enter your instructions in the markdown text area under the agent's `prompt` field
4. Save your changes
These prompts are injected into the agent's system prompt and apply across all sessions using that agent.
## Instruction Files
Kilo automatically discovers instruction files at your project root and in parent directories (via `findUp`). The following filenames are recognized:
- **`AGENTS.md`** — The primary instruction file for Kilo
- **`CLAUDE.md`** — Also supported for compatibility
- **`CONTEXT.md`** — Additional project context
Place any of these files at your project root to provide project-wide instructions to the agent.
### Global Instructions
For instructions that apply across all your projects, place an `AGENTS.md` file in your global config directory:
- **Kilo:** `~/.config/kilo/AGENTS.md`
- **Claude-compatible:** `~/.claude/CLAUDE.md`
Project-level instructions are loaded before global instructions and apply to every session.
### Per-Directory Instructions
You can place `AGENTS.md` files in any subdirectory of your project. These are loaded dynamically — when the agent's Read tool accesses a file in that directory, the corresponding `AGENTS.md` is discovered and its contents are injected into the conversation as `<system-reminder>` tags.
This is useful for providing context-specific guidance for different parts of a monorepo or project.
## Additional Instruction Sources
The `instructions` key in `kilo.jsonc` accepts an array of paths, globs, or URLs pointing to additional instruction files. You can manage these in **Settings → Agent Behaviour → Rules** subtab.
```yaml
# Examples of instruction sources
instructions:
- ./docs/coding-standards.md
- ./teams/frontend-rules.md
- https://example.com/team-instructions.md
```
{% callout type="info" title="URL-Based Instructions" %}
URL-based instruction sources are fetched at session start with a 5-second timeout. If the URL is unreachable, the instruction source is silently skipped.
{% /callout %}
## Legacy `.kilocoderules` Support
If your project contains `.kilocoderules` files from the VSCode extension, these are still loaded via auto-migration. However, migrating to `AGENTS.md` is recommended for new projects.
{% /tab %}
{% tab label="CLI" %}
The CLI provides multiple layers of instruction configuration — from per-agent prompts in agent definition files to auto-discovered files in your project and global config.
## Per-Agent Prompts
Each agent can have its own custom prompt defined in its `.md` file (the markdown body) or via the `agent.<name>.prompt` key in `kilo.jsonc`:
```jsonc
// kilo.jsonc
{
"agent": {
"code": {
"prompt": "You are a Python specialist. Follow PEP8 strictly.",
},
},
}
```
Or as the markdown body in `.kilo/agents/code.md`:
```markdown
---
description: Python specialist
---
You are a Python specialist. Follow PEP8 strictly.
```
These prompts are injected into the agent's system prompt and apply across all sessions using that agent.
## Instruction Files
Kilo automatically discovers instruction files at your project root and in parent directories (via `findUp`). The following filenames are recognized:
- **`AGENTS.md`** — The primary instruction file for Kilo
- **`CLAUDE.md`** — Also supported for compatibility
- **`CONTEXT.md`** — Additional project context
Place any of these files at your project root to provide project-wide instructions to the agent.
### Global Instructions
For instructions that apply across all your projects, place an `AGENTS.md` file in your global config directory:
- **Kilo:** `~/.config/kilo/AGENTS.md`
- **Claude-compatible:** `~/.claude/CLAUDE.md`
Project-level instructions are loaded before global instructions and apply to every session.
### Per-Directory Instructions
You can place `AGENTS.md` files in any subdirectory of your project. These are loaded dynamically — when the agent's Read tool accesses a file in that directory, the corresponding `AGENTS.md` is discovered and its contents are injected into the conversation as `<system-reminder>` tags.
This is useful for providing context-specific guidance for different parts of a monorepo or project.
## Additional Instruction Sources
The `instructions` key in `kilo.jsonc` accepts an array of paths, globs, or URLs pointing to additional instruction files. Configure these in your `kilo.jsonc`:
```jsonc
// kilo.jsonc
{
"instructions": [
"./docs/coding-standards.md",
"./teams/frontend-rules.md",
"https://example.com/team-instructions.md",
],
}
```
{% callout type="info" title="URL-Based Instructions" %}
URL-based instruction sources are fetched at session start with a 5-second timeout. If the URL is unreachable, the instruction source is silently skipped.
{% /callout %}
## Legacy `.kilocoderules` Support
If your project contains `.kilocoderules` files from the VSCode extension, these are still loaded via auto-migration. However, migrating to `AGENTS.md` is recommended for new projects.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
## Setting Custom Instructions
{% callout type="info" title="Custom Instructions vs Rules" %}
Custom Instructions are IDE-wide and are applied across all workspaces and maintain your preferences regardless of which project you're working on. Unlike Instructions, [Custom Rules](/docs/customize/custom-rules) are project specific and allow you to setup workspace-based ruleset.
{% /callout %}
## Setting Custom Instructions
**How to set them:**
{% image src="/docs/img/custom-instructions/custom-instructions.png" alt="Kilo Code Modes tab showing global custom instructions interface" width="600" caption="Kilo Code Modes tab showing global custom instructions interface" /%}
@@ -37,20 +181,24 @@ Mode-specific instructions can be set using the Modes Tab
* **Save Changes:** Click "Done" to save your changes
{% callout type="info" title="Global Mode Rules" %}
If the mode itself is global (not workspace-specific), any custom instructions you set for it will also apply globally for that mode across all workspaces.
{% /callout %}
## Mode-Specific Instructions from Files
If the mode itself is global (not workspace-specific), any custom instructions you set for it will also apply globally for that mode across all workspaces.
{% /callout %}
#### Mode-Specific Instructions from Files
For version-controlled mode instructions, use the mode rules file paths documented in [Custom Modes](/docs/customize/custom-modes#mode-specific-instructions-via-filesdirectories):
- Preferred: `.kilo/rules-{mode-slug}/` (directory)
- Fallback: `.kilorules-{mode-slug}` (single file)
- Fallback: `.kilocoderules-{mode-slug}` (single file)
{% callout type="info" title="Legacy Naming Note" %}
Older naming like `.clinerules-{mode-slug}` is not the recommended path for current Kilo mode-specific instructions.
Only `.kilocoderules-{mode-slug}` is recognized as the legacy fallback. Older naming like `.clinerules-{mode-slug}` is not supported.
{% /callout %}
{% /tab %}
{% /tabs %}
## Related Features
- [Custom Modes](/docs/customize/custom-modes)
packages/kilo-docs/pages/customize/custom-modes.md
+751 -8
View File
@@ -5,11 +5,11 @@ description: "Create and configure custom modes in Kilo Code"
# Custom Modes
Kilo Code allows you to create **custom modes** to tailor Kilo's behavior to specific tasks or workflows. Custom modes can be either **global** (available across all projects) or **project-specific** (defined within a single project).
Kilo Code allows you to create **custom modes** (also called **agents**) to tailor Kilo's behavior to specific tasks or workflows. Custom modes can be either **global** (available across all projects) or **project-specific** (defined within a single project).
## Sticky Models for Efficient Workflow
Each mode—including custom ones—features **Sticky Models**. This means Kilo Code automatically remembers and selects the last model you used with a particular mode. This lets you assign different preferred models to different tasks without constant reconfiguration, as Kilo switches between models when you change modes.
{% callout type="info" %}
The current VS Code extension (built on the Kilo CLI) uses **agent Markdown files** to define custom modes. The legacy extension used `custom_modes.yaml` / `.kilocodemodes`. See the tabs below for the relevant approach.
{% /callout %}
## Why Use Custom Modes?
@@ -18,6 +18,443 @@ Each mode—including custom ones—features **Sticky Models**. This means Kilo
- **Experimentation:** Safely experiment with different prompts and configurations without affecting other modes
- **Team Collaboration:** Share custom modes with your team to standardize workflows
{% tabs %}
{% tab label="VSCode" %}
In the VSCode extension and CLI, custom behavioral profiles are called **agents** instead of modes. Agents are defined as Markdown files with YAML frontmatter or as entries in the `agent` key of your config file.
## What's Included in a Custom Agent?
| Property | Description |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| **name** (filename) | The agent's identifier, derived from the `.md` filename (e.g., `docs-writer.md` creates an agent named `docs-writer`) |
| **description** | A short summary displayed in the agent picker and used by the orchestrator for delegation |
| **model** | Pin a specific model in `provider/model` format (e.g., `anthropic/claude-sonnet-4-20250514`) |
| **prompt** (markdown body) | The system prompt text — the markdown body of the file, injected into the agent's system prompt |
| **mode** | Role classification: `primary` (user-selectable), `subagent` (only invoked by other agents), or `all` (both) |
| **permission** | Per-agent permission overrides controlling which tools the agent can use (e.g., deny `edit`, `bash`) |
| **color** | Hex color (`#FF5733`) or theme keyword (`primary`, `accent`, `warning`, etc.) for the agent picker UI |
| **steps** | Maximum agentic iterations before forcing a text-only response |
| **temperature** / **top_p** | Sampling parameters for the agent's model |
| **variant** | Default model variant |
| **hidden** | If `true`, the agent is hidden from the UI (only meaningful for subagents) |
| **disable** | If `true`, removes the agent entirely |
## Methods for Creating and Configuring Agents
### 1. Ask Kilo! (Recommended)
Ask Kilo to create an agent for you:
```
Create a new agent called "docs-writer" that can only read files and edit Markdown files.
```
Kilo will generate the agent definition and write it to `.kilo/agent/` in your project.
### 2. Using the Settings UI
You can manage agents through the **Settings → Agent Behaviour → Agents** subtab in the extension. This lets you view, create, and edit agent configurations — including the agent's prompt, model, permissions, and other properties.
### 3. Markdown Files with YAML Frontmatter
Create `.md` files in any of these directories:
```
.kilo/agents/my-agent.md
.kilo/agent/my-agent.md
.opencode/agents/my-agent.md
```
For global agents, place files in your global config directory:
```
~/.config/kilo/agent/my-agent.md
```
The **filename** (minus `.md`) becomes the agent name. Nested directories create namespaced names (e.g., `agents/backend/sql.md` becomes agent `backend/sql`).
**Example agent file** (`.kilo/agents/docs-writer.md`):
```markdown
---
description: Specialized for writing and editing technical documentation
mode: primary
color: "#10B981"
permission:
edit:
"*.md": "allow"
"*": "deny"
bash: deny
---
You are a technical documentation specialist. Your expertise includes:
- Writing clear, well-structured documentation
- Following markdown best practices
- Creating helpful code examples
Focus on clarity and completeness. Only edit Markdown files.
```
### 4. Config File (`kilo.jsonc`)
Define agents under the `agent` key in your project's `kilo.jsonc`:
```jsonc
{
"agent": {
"docs-writer": {
"description": "Specialized for writing and editing technical documentation",
"mode": "primary",
"color": "#10B981",
"prompt": "You are a technical documentation specialist...",
"permission": {
"edit": {
"*.md": "allow",
"*": "deny",
},
"bash": "deny",
},
},
// Override a built-in agent
"code": {
"model": "anthropic/claude-sonnet-4-20250514",
"temperature": 0.3,
},
},
}
```
## Agent Property Reference
### `mode`
Controls where the agent appears:
| Value | Behavior |
| ---------- | -------------------------------------------------------------------------------------- |
| `primary` | Shown in the agent picker — the user can select it directly |
| `subagent` | Only invokable by other agents via the `task` tool |
| `all` | Available both as a top-level pick and as a subagent (default for user-defined agents) |
### `permission`
An ordered set of rules controlling tool access. Permissions support three actions: `allow`, `deny`, and `ask` (prompt the user). You can use glob patterns to scope rules to specific files or commands:
```yaml
permission:
edit:
"*.md": "allow"
"*": "deny"
bash: deny
read: allow
```
Known permission types include: `read`, `edit`, `bash`, `glob`, `grep`, `list`, `task`, `webfetch`, `websearch`, `codesearch`, `todowrite`, `todoread`, and more.
### `model`
Pin a specific model using the `provider/model` format:
```yaml
model: anthropic/claude-sonnet-4-20250514
```
### `steps`
Limits the number of agentic iterations (tool call rounds) before the agent is forced to respond with text only. Useful for preventing runaway agents:
```yaml
steps: 25
```
## Configuration Precedence
Agent configurations merge from lowest to highest priority:
1. Built-in (native) agent defaults
2. Global config (`~/.config/kilo/kilo.jsonc`)
3. Project config (`kilo.jsonc` at project root)
4. `.kilo/` / `.opencode/` directory configs and agent `.md` files
5. Environment variable overrides (`KILO_CONFIG_CONTENT`)
When the same agent name appears at multiple levels, properties are merged (not replaced wholesale), so you can override just a model or temperature without redefining the entire agent.
## Overriding Built-in Agents
Override any built-in agent (**code**, **plan**, **debug**, **ask**, **orchestrator**, **explore**, **general**) by defining an agent with the same name:
```jsonc
// kilo.jsonc — override the built-in "code" agent
{
"agent": {
"code": {
"model": "openai/gpt-4o",
"temperature": 0.2,
"permission": {
"edit": {
"*.py": "allow",
"*": "deny",
},
},
},
},
}
```
Or as a `.md` file (`.kilo/agents/code.md`):
```markdown
---
model: openai/gpt-4o
temperature: 0.2
permission:
edit:
"*.py": "allow"
"*": "deny"
---
You are a Python specialist. Only edit Python files.
```
## Migration from VSCode Extension Modes
If you have existing `.kilocodemodes` or `custom_modes.yaml` files from the VSCode extension, the extension automatically migrates them on startup. The migration converts:
- `slug` to the agent name (key)
- `roleDefinition` + `customInstructions` to `prompt`
- `groups` (e.g., `["read", "edit", "browser"]`) to `permission` rules
- `whenToUse` / `description` to `description`
- Mode is set to `primary`
Default legacy mode slugs (`code`, `build`, `architect`, `ask`, `debug`, `orchestrator`) are skipped during migration since they map to built-in agents (`build` → `code`, `architect` → `plan`).
{% /tab %}
{% tab label="CLI" %}
In the CLI, custom behavioral profiles are called **agents** instead of modes. Agents are defined as Markdown files with YAML frontmatter or as entries in the `agent` key of your config file.
## What's Included in a Custom Agent?
| Property | Description |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| **name** (filename) | The agent's identifier, derived from the `.md` filename (e.g., `docs-writer.md` creates an agent named `docs-writer`) |
| **description** | A short summary displayed in the agent picker and used by the orchestrator for delegation |
| **model** | Pin a specific model in `provider/model` format (e.g., `anthropic/claude-sonnet-4-20250514`) |
| **prompt** (markdown body) | The system prompt text — the markdown body of the file, injected into the agent's system prompt |
| **mode** | Role classification: `primary` (user-selectable), `subagent` (only invoked by other agents), or `all` (both) |
| **permission** | Per-agent permission overrides controlling which tools the agent can use (e.g., deny `edit`, `bash`) |
| **color** | Hex color (`#FF5733`) or theme keyword (`primary`, `accent`, `warning`, etc.) for the agent picker UI |
| **steps** | Maximum agentic iterations before forcing a text-only response |
| **temperature** / **top_p** | Sampling parameters for the agent's model |
| **variant** | Default model variant |
| **hidden** | If `true`, the agent is hidden from the UI (only meaningful for subagents) |
| **disable** | If `true`, removes the agent entirely |
## Methods for Creating and Configuring Agents
### 1. Ask Kilo! (Recommended)
Ask Kilo to create an agent for you:
```
Create a new agent called "docs-writer" that can only read files and edit Markdown files.
```
Kilo will generate the agent definition and write it to `.kilo/agent/` in your project.
### 2. Using `kilo agent create`
The CLI provides an interactive command:
```bash
kilo agent create
```
This walks you through selecting a description, mode, and tools, then uses an LLM to generate the agent's system prompt and writes a `.md` file with YAML frontmatter.
### 3. Markdown Files with YAML Frontmatter
Create `.md` files in any of these directories:
```
.kilo/agents/my-agent.md
.kilo/agent/my-agent.md
.opencode/agents/my-agent.md
```
For global agents, place files in your global config directory:
```
~/.config/kilo/agent/my-agent.md
```
The **filename** (minus `.md`) becomes the agent name. Nested directories create namespaced names (e.g., `agents/backend/sql.md` becomes agent `backend/sql`).
**Example agent file** (`.kilo/agents/docs-writer.md`):
```markdown
---
description: Specialized for writing and editing technical documentation
mode: primary
color: "#10B981"
permission:
edit:
"*.md": "allow"
"*": "deny"
bash: deny
---
You are a technical documentation specialist. Your expertise includes:
- Writing clear, well-structured documentation
- Following markdown best practices
- Creating helpful code examples
Focus on clarity and completeness. Only edit Markdown files.
```
### 4. Config File (`kilo.jsonc`)
Define agents under the `agent` key in your project's `kilo.jsonc`:
```jsonc
{
"agent": {
"docs-writer": {
"description": "Specialized for writing and editing technical documentation",
"mode": "primary",
"color": "#10B981",
"prompt": "You are a technical documentation specialist...",
"permission": {
"edit": {
"*.md": "allow",
"*": "deny",
},
"bash": "deny",
},
},
// Override a built-in agent
"code": {
"model": "anthropic/claude-sonnet-4-20250514",
"temperature": 0.3,
},
},
}
```
## Agent Property Reference
### `mode`
Controls where the agent appears:
| Value | Behavior |
| ---------- | -------------------------------------------------------------------------------------- |
| `primary` | Shown in the agent picker — the user can select it directly |
| `subagent` | Only invokable by other agents via the `task` tool |
| `all` | Available both as a top-level pick and as a subagent (default for user-defined agents) |
### `permission`
An ordered set of rules controlling tool access. Permissions support three actions: `allow`, `deny`, and `ask` (prompt the user). You can use glob patterns to scope rules to specific files or commands:
```yaml
permission:
edit:
"*.md": "allow"
"*": "deny"
bash: deny
read: allow
```
Known permission types include: `read`, `edit`, `bash`, `glob`, `grep`, `list`, `task`, `webfetch`, `websearch`, `codesearch`, `todowrite`, `todoread`, and more.
### `model`
Pin a specific model using the `provider/model` format:
```yaml
model: anthropic/claude-sonnet-4-20250514
```
### `steps`
Limits the number of agentic iterations (tool call rounds) before the agent is forced to respond with text only. Useful for preventing runaway agents:
```yaml
steps: 25
```
## Configuration Precedence
Agent configurations merge from lowest to highest priority:
1. Built-in (native) agent defaults
2. Global config (`~/.config/kilo/kilo.jsonc`)
3. Project config (`kilo.jsonc` at project root)
4. `.kilo/` / `.opencode/` directory configs and agent `.md` files
5. Environment variable overrides (`KILO_CONFIG_CONTENT`)
When the same agent name appears at multiple levels, properties are merged (not replaced wholesale), so you can override just a model or temperature without redefining the entire agent.
## Overriding Built-in Agents
Override any built-in agent (**code**, **plan**, **debug**, **ask**, **orchestrator**, **explore**, **general**) by defining an agent with the same name:
```jsonc
// kilo.jsonc — override the built-in "code" agent
{
"agent": {
"code": {
"model": "openai/gpt-4o",
"temperature": 0.2,
"permission": {
"edit": {
"*.py": "allow",
"*": "deny",
},
},
},
},
}
```
Or as a `.md` file (`.kilo/agents/code.md`):
```markdown
---
model: openai/gpt-4o
temperature: 0.2
permission:
edit:
"*.py": "allow"
"*": "deny"
---
You are a Python specialist. Only edit Python files.
```
## Migration from VSCode Extension Modes
If you have existing `.kilocodemodes` or `custom_modes.yaml` files from the VSCode extension, the CLI automatically migrates them on startup. The migration converts:
- `slug` to the agent name (key)
- `roleDefinition` + `customInstructions` to `prompt`
- `groups` (e.g., `["read", "edit", "browser"]`) to `permission` rules
- `whenToUse` / `description` to `description`
- Mode is set to `primary`
Default legacy mode slugs (`code`, `build`, `architect`, `ask`, `debug`, `orchestrator`) are skipped during migration since they map to built-in agents (`build` → `code`, `architect` → `plan`).
{% /tab %}
{% tab label="VSCode (Legacy)" %}
## Sticky Models for Efficient Workflow
Each mode—including custom ones—features **Sticky Models**. This means Kilo Code automatically remembers and selects the last model you used with a particular mode. This lets you assign different preferred models to different tasks without constant reconfiguration, as Kilo switches between models when you change modes.
{% callout type="tip" %}
**Keep custom modes on track:** Limit the types of files that they're allowed to edit using the `fileRegex` option in the `groups` configuration. This prevents modes from accidentally modifying files outside their intended scope.
{% /callout %}
@@ -89,6 +526,57 @@ When importing modes, you can change the slug in the exported YAML file before i
## Methods for Creating and Configuring Custom Modes
{% tabs %}
{% tab label="VSCode" %}
Custom agents are defined as Markdown files with optional YAML frontmatter. You can place them in:
- **Project agents:** `.kilo/agents/*.md` (or `.opencode/agents/*.md`)
- **Global agents:** `~/.config/kilo/agents/*.md`
### Agent File Format
```markdown
---
model: anthropic/claude-3-5-sonnet-20241022
description: A specialized agent for writing documentation
mode: primary
---
You are a technical writer specializing in clear, concise documentation.
Focus on clarity, completeness, and consistent formatting.
```
**YAML frontmatter fields:**
| Field | Description |
| ------------- | ----------------------------------------------------------------------------- |
| `model` | Override the default model for this agent |
| `description` | Short description shown in the agent selector |
| `mode` | `"primary"` (user-selectable), `"subagent"` (invoked by AI only), or `"all"` |
| `permission` | Tool permission overrides (same format as the global `permission` config key) |
| `temperature` | Model temperature override |
| `top_p` | Model top_p override |
The filename (without `.md`) becomes the agent's slug and display name.
### Installing via Marketplace
You can also install community-contributed agents from the **Marketplace** tab in the extension sidebar.
### Ask Kilo! (Recommended)
You can also have Kilo create an agent file for you. For example:
```
Create a new agent called "Documentation Writer". It should only be able to read files and write Markdown files.
```
Kilo will create the appropriate `.kilo/agents/docs-writer.md` file with the right frontmatter.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
You can create and configure custom modes in several ways:
### 1. Ask Kilo! (Recommended)
@@ -135,8 +623,6 @@ If you see both YAML and JSON mode files, this is usually from legacy configurat
YAML is now the preferred format for defining custom modes due to better readability, comment support, and cleaner multi-line strings.
### YAML Example
```yaml
customModes:
- slug: docs-writer
@@ -388,9 +874,46 @@ customModes:
- command
```
{% /tab %}
{% /tabs %}
## Understanding Regex in Custom Modes
Regular expressions (`fileRegex`) offer fine-grained control over file editing permissions.
{% tabs %}
{% tab label="VSCode" %}
The extension uses **permission rules with glob patterns** instead of regex. Permissions are defined per-tool (e.g., `edit`, `bash`, `read`) and support `allow`, `deny`, and `ask` actions with glob matching:
```yaml
permission:
edit:
"*.md": "allow"
"*": "deny"
```
The **VSCode (Legacy)** version's `fileRegex` approach is automatically converted to permission rules during migration.
{% /tab %}
{% tab label="CLI" %}
The CLI uses **permission rules with glob patterns** instead of regex. Permissions are defined per-tool (e.g., `edit`, `bash`, `read`) and support `allow`, `deny`, and `ask` actions with glob matching:
```yaml
permission:
edit:
"*.md": "allow"
"*": "deny"
```
The **VSCode (Legacy)** version's `fileRegex` approach is automatically converted to permission rules during migration.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Regular expressions (`fileRegex`) in the **VSCode** version offer fine-grained control over file editing permissions within tool groups.
{% /tab %}
{% /tabs %}
{% callout type="tip" %}
@@ -445,6 +968,183 @@ When a mode attempts to edit a file that doesn't match its `fileRegex` pattern,
## Example Configurations
{% tabs %}
{% tab label="VSCode" %}
### Basic Documentation Writer (`.kilo/agents/docs-writer.md`)
```markdown
---
description: Specialized for writing and editing technical documentation
mode: primary
color: "#10B981"
permission:
edit:
"*.md": "allow"
"*": "deny"
bash: deny
---
You are a technical writer specializing in clear documentation.
Focus on clear explanations and examples.
```
### Test Engineer (`.kilo/agents/test-engineer.md`)
```markdown
---
description: Focused on writing and maintaining test suites
mode: primary
color: "#F59E0B"
permission:
edit:
"*.{test,spec}.{js,ts}": "allow"
"*": "deny"
---
You are a test engineer focused on code quality.
Use for writing tests, debugging test failures, and improving test coverage.
```
### Security Reviewer (`.kilo/agents/security-review.md`)
```markdown
---
description: Read-only security analysis and vulnerability assessment
mode: primary
color: "#EF4444"
permission:
edit: deny
bash: deny
---
You are a security specialist reviewing code for vulnerabilities.
Focus on:
- Input validation issues
- Authentication and authorization flaws
- Data exposure risks
- Injection vulnerabilities
```
### Config File Example (`kilo.jsonc`)
```jsonc
{
"agent": {
"docs-writer": {
"description": "Specialized for writing and editing technical documentation",
"mode": "primary",
"color": "#10B981",
"prompt": "You are a technical writer specializing in clear documentation.",
"permission": {
"edit": { "*.md": "allow", "*": "deny" },
"bash": "deny",
},
},
"test-engineer": {
"description": "Focused on writing and maintaining test suites",
"mode": "primary",
"prompt": "You are a test engineer focused on code quality.",
"permission": {
"edit": { "*.{test,spec}.{js,ts}": "allow", "*": "deny" },
},
},
},
}
```
{% /tab %}
{% tab label="CLI" %}
### Basic Documentation Writer (`.kilo/agents/docs-writer.md`)
```markdown
---
description: Specialized for writing and editing technical documentation
mode: primary
color: "#10B981"
permission:
edit:
"*.md": "allow"
"*": "deny"
bash: deny
---
You are a technical writer specializing in clear documentation.
Focus on clear explanations and examples.
```
### Test Engineer (`.kilo/agents/test-engineer.md`)
```markdown
---
description: Focused on writing and maintaining test suites
mode: primary
color: "#F59E0B"
permission:
edit:
"*.{test,spec}.{js,ts}": "allow"
"*": "deny"
---
You are a test engineer focused on code quality.
Use for writing tests, debugging test failures, and improving test coverage.
```
### Security Reviewer (`.kilo/agents/security-review.md`)
```markdown
---
description: Read-only security analysis and vulnerability assessment
mode: primary
color: "#EF4444"
permission:
edit: deny
bash: deny
---
You are a security specialist reviewing code for vulnerabilities.
Focus on:
- Input validation issues
- Authentication and authorization flaws
- Data exposure risks
- Injection vulnerabilities
```
### Config File Example (`kilo.jsonc`)
```jsonc
{
"agent": {
"docs-writer": {
"description": "Specialized for writing and editing technical documentation",
"mode": "primary",
"color": "#10B981",
"prompt": "You are a technical writer specializing in clear documentation.",
"permission": {
"edit": { "*.md": "allow", "*": "deny" },
"bash": "deny",
},
},
"test-engineer": {
"description": "Focused on writing and maintaining test suites",
"mode": "primary",
"prompt": "You are a test engineer focused on code quality.",
"permission": {
"edit": { "*.{test,spec}.{js,ts}": "allow", "*": "deny" },
},
},
},
}
```
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Basic Documentation Writer (YAML)
```yaml
@@ -498,8 +1198,48 @@ customModes:
- browser
```
{% /tab %}
{% /tabs %}
## Troubleshooting
{% tabs %}
{% tab label="VSCode" %}
### Common Issues
- **Agent not appearing:** Ensure the `.md` file is in a recognized directory (`.kilo/agents/`, `.kilo/agent/`, `.opencode/agents/`). Check that the `mode` property is `primary` or `all` if you expect it in the agent picker.
- **Permission errors:** Permission rules are evaluated last-match-wins. If an agent can't use a tool you expect, check that an `allow` rule appears after any `deny` rules for that permission.
- **YAML frontmatter parse errors:** Ensure the frontmatter block starts and ends with `---` on its own line. Validate that YAML keys match expected property names (e.g., `top_p` not `topP`).
- **Agent overrides not working:** Config merges from global to project level. If a global config sets a property, your project config can override it, but both must use the same agent name.
### Tips for Agent Definitions
- **Keep prompts focused:** The markdown body is your system prompt — write it as if briefing a colleague
- **Use `mode: subagent`** for helper agents that shouldn't be directly selectable by users
- **Use the Settings UI** to view and edit agents through the **Settings → Agent Behaviour → Agents** subtab
- **Legacy modes are auto-migrated:** If you have `.kilocodemodes` files, they'll be converted on startup — no manual migration needed
{% /tab %}
{% tab label="CLI" %}
### Common Issues
- **Agent not appearing:** Ensure the `.md` file is in a recognized directory (`.kilo/agents/`, `.kilo/agent/`, `.opencode/agents/`). Check that the `mode` property is `primary` or `all` if you expect it in the agent picker.
- **Permission errors:** Permission rules are evaluated last-match-wins. If an agent can't use a tool you expect, check that an `allow` rule appears after any `deny` rules for that permission.
- **YAML frontmatter parse errors:** Ensure the frontmatter block starts and ends with `---` on its own line. Validate that YAML keys match expected property names (e.g., `top_p` not `topP`).
- **Agent overrides not working:** Config merges from global to project level. If a global config sets a property, your project config can override it, but both must use the same agent name.
### Tips for Agent Definitions
- **Keep prompts focused:** The markdown body is your system prompt — write it as if briefing a colleague
- **Use `mode: subagent`** for helper agents that shouldn't be directly selectable by users
- **Test with `kilo agent create`** to see how the CLI generates agent definitions, then customize from there
- **Legacy modes are auto-migrated:** If you have `.kilocodemodes` files, they'll be converted on startup — no manual migration needed
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Common Issues
- **Mode not appearing:** After creating or importing a mode, you may need to reload the VS Code window
@@ -514,6 +1254,9 @@ customModes:
- **Hyphens for List Items:** List items start with a hyphen and a space (e.g., `- read`)
- **Validate Your YAML:** Use online YAML validators or your editor's built-in validation
{% /tab %}
{% /tabs %}
## Community Gallery
Ready to explore more? Check out the [Show and Tell](https://github.com/Kilo-Org/kilocode/discussions/categories/show-and-tell) to discover and share custom modes created by the community!
Ready to explore more? Check out the [Show and Tell](https://github.com/Kilo-Org/kilocode/discussions/categories/show-and-tell) to discover and share custom modes and agents created by the community!
packages/kilo-docs/pages/customize/custom-rules.md
+240 -18
View File
@@ -26,11 +26,82 @@ Kilo Code supports two types of custom rules:
- **Project Rules**: Apply only to the current project workspace
- **Global Rules**: Apply across all projects and workspaces
{% callout type="note" title="UI Support" %}
The built-in rules management UI is available for general rules only. Mode-specific rules must be managed through the file system.
## Rule Location
{% tabs %}
{% tab label="VSCode" %}
### Project Rules
Project rules are configured via the `instructions` key in your project's `kilo.jsonc` file. You can edit this file directly or use the **Settings** webview to manage the `instructions` configuration. Each entry points to a file path or glob pattern:
```jsonc
// kilo.jsonc
{
"instructions": [".kilo/rules/formatting.md", ".kilo/rules/*.md"],
}
```
You can also place rule files in the **`.kilo/`** directory structure:
```
project/
├── .kilo/
│ ├── rules/
│ │ ├── formatting.md
│ │ ├── restricted_files.md
│ │ └── naming_conventions.md
├── kilo.json
├── src/
└── ...
```
### Global Rules
Global rules are configured via the `instructions` key in your global `kilo.jsonc` config file (typically at `~/.config/kilo/kilo.jsonc`).
{% callout type="note" title="Migration" %}
The extension is backward compatible with `.kilocode/rules/` directories. Existing rules will continue to work, but migrating to `kilo.jsonc` is recommended.
{% /callout %}
## Rule Location
{% /tab %}
{% tab label="CLI" %}
### Project Rules
Project rules are configured via the `instructions` key in your project's `kilo.jsonc` file. Each entry points to a file path or glob pattern:
```jsonc
// kilo.jsonc
{
"instructions": [".kilo/rules/formatting.md", ".kilo/rules/*.md"],
}
```
You can also place rule files in the **`.kilo/`** directory structure:
```
project/
├── .kilo/
│ ├── rules/
│ │ ├── formatting.md
│ │ ├── restricted_files.md
│ │ └── naming_conventions.md
├── kilo.json
├── src/
└── ...
```
### Global Rules
Global rules are configured via the `instructions` key in your global `kilo.jsonc` config file (typically at `~/.config/kilo/kilo.jsonc`).
{% callout type="note" title="Migration" %}
The CLI is backward compatible with `.kilocode/rules/` directories. Existing rules will continue to work, but migrating to `kilo.jsonc` is recommended.
{% /callout %}
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Project Rules
@@ -59,8 +130,54 @@ Global rules are stored in your home directory and apply to all projects:
│ └── documentation_style.md
```
{% /tab %}
{% /tabs %}
## Managing Rules Through the UI
{% tabs %}
{% tab label="VSCode" %}
Rules are managed by editing the `instructions` array in your `kilo.jsonc` config file. You can also use the **Settings** webview in VS Code to edit the configuration.
- **Add a rule**: Add a file path or glob pattern to the `instructions` array
- **Remove a rule**: Remove the entry from the array
- **Disable a rule temporarily**: Comment out the line in `kilo.jsonc` (JSONC supports `//` comments)
```jsonc
// kilo.jsonc
{
"instructions": [
".kilo/rules/formatting.md",
// ".kilo/rules/experimental.md" -- temporarily disabled
".kilo/rules/naming_conventions.md",
],
}
```
{% /tab %}
{% tab label="CLI" %}
Rules are managed by editing the `instructions` array in your `kilo.jsonc` config file directly.
- **Add a rule**: Add a file path or glob pattern to the `instructions` array
- **Remove a rule**: Remove the entry from the array
- **Disable a rule temporarily**: Comment out the line in `kilo.jsonc` (JSONC supports `//` comments)
```jsonc
// kilo.jsonc
{
"instructions": [
".kilo/rules/formatting.md",
// ".kilo/rules/experimental.md" -- temporarily disabled
".kilo/rules/naming_conventions.md",
],
}
```
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Kilo Code provides a built-in interface for managing your custom rules without manually editing files in the `.kilocode/rules/` directories. To access the UI, click on the <Codicon name="law" /> icon in the **bottom right corner** of the Kilo Code window.
You can access the rules management UI to:
@@ -70,8 +187,46 @@ You can access the rules management UI to:
- Create and edit rules directly in the interface
- Organize rules by category and priority
{% callout type="note" title="UI Support" %}
The built-in rules management UI is available for general rules only. Mode-specific rules must be managed through the file system.
{% /callout %}
{% /tab %}
{% /tabs %}
## Rule Loading Order
{% tabs %}
{% tab label="VSCode" %}
Rules are loaded in the order they appear in the `instructions` array in `kilo.jsonc`:
1. **Global instructions** from the global `kilo.jsonc` config
2. **Project instructions** from the project's `kilo.jsonc`
Files matched by glob patterns are loaded in filesystem order. Project-level instructions take precedence over global instructions for conflicting directives.
{% callout type="note" title="Backward Compatibility" %}
If `.kilocode/rules/` directories exist in your project, their contents are automatically included for backward compatibility. To fully migrate, move your rule files and reference them in `kilo.jsonc`.
{% /callout %}
{% /tab %}
{% tab label="CLI" %}
Rules are loaded in the order they appear in the `instructions` array in `kilo.jsonc`:
1. **Global instructions** from the global `kilo.jsonc` config
2. **Project instructions** from the project's `kilo.jsonc`
Files matched by glob patterns are loaded in filesystem order. Project-level instructions take precedence over global instructions for conflicting directives.
{% callout type="note" title="Backward Compatibility" %}
If `.kilocode/rules/` directories exist in your project, their contents are automatically included for backward compatibility. To fully migrate, move your rule files and reference them in `kilo.jsonc`.
{% /callout %}
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### General Rules (Any Mode)
Rules are loaded in the following priority order:
@@ -86,21 +241,64 @@ Rules are loaded in the following priority order:
When both global and project rules exist, they are combined with project rules taking precedence over global rules for conflicting directives.
{% callout type="note" %}
We strongly recommend keeping your rules in the `.kilocode/rules/` folder as it provides better organization and is the preferred approach for future versions. The folder-based structure allows for more granular rule organization and clearer separation of concerns. The legacy file-based approach is maintained for backward compatibility but may be subject to change in future releases.
We strongly recommend keeping your rules in the `.kilocode/rules/` folder as it provides better organization and is the preferred approach for future versions. The legacy file-based approach is maintained for backward compatibility but may be subject to change in future releases.
{% /callout %}
### Mode-Specific Rules
Additionally, the system supports mode-specific rules, which are loaded separately and have their own priority order:
The system also supports mode-specific rules with their own priority order:
1. First, it checks for `.kilocode/rules-${mode}/` directory
2. If that doesn't exist or is empty, it falls back to `.kilocoderules-${mode}` file (deprecated)
Currently, mode-specific rules are only supported at the project level.
When both generic rules and mode-specific rules exist, the mode-specific rules are given priority in the final output.
Mode-specific rules are only supported at the project level. When both generic and mode-specific rules exist, mode-specific rules take priority.
{% /tab %}
{% /tabs %}
## Creating Custom Rules
{% tabs %}
{% tab label="VSCode" %}
### Using the Settings UI or Config File
1. Create a `kilo.jsonc` file in your project root (if it doesn't exist)
2. Create a `.kilo/rules/` directory (or any directory you prefer)
3. Write your rule as a Markdown file in that directory
4. Add the file path or a glob pattern to the `instructions` array in `kilo.jsonc`
```jsonc
// kilo.jsonc
{
"instructions": [".kilo/rules/my-new-rule.md"],
}
```
Rules are applied on the next interaction. You can also edit `kilo.jsonc` through the **Settings** webview in VS Code.
{% /tab %}
{% tab label="CLI" %}
### Using the Config File
1. Create a `kilo.jsonc` file in your project root (if it doesn't exist)
2. Create a `.kilo/rules/` directory (or any directory you prefer)
3. Write your rule as a Markdown file in that directory
4. Add the file path or a glob pattern to the `instructions` array in `kilo.jsonc`
```jsonc
// kilo.jsonc
{
"instructions": [".kilo/rules/my-new-rule.md"],
}
```
Rules are applied on the next interaction.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Using the UI Interface
{% image src="/docs/img/custom-rules/rules-ui.png" alt="Rules tab in Kilo Code" width="400" /%}
@@ -132,6 +330,9 @@ To create rules manually:
Rules will be automatically applied to all future Kilo Code interactions. Any new changes will be applied immediately.
{% /tab %}
{% /tabs %}
## Example Rules
### Example 1: Table Formatting
@@ -192,10 +393,6 @@ Custom rules can be applied to a wide variety of scenarios:
- **Keep It Simple**: Rules should be concise and easy to understand
- **Update Regularly**: Review and update rules as project requirements change
{% callout type="tip" title="Pro Tip: File-Based Team Standards" %}
When working in team environments, placing `.kilocode/rules/codestyle.md` files under version control allows you to standardize Kilo's behavior across your entire development team. This ensures consistent code style, documentation practices, and development workflows for everyone on the project.
{% /callout %}
## Limitations
- Rules are applied on a best-effort basis by the AI models
@@ -205,16 +402,41 @@ When working in team environments, placing `.kilocode/rules/codestyle.md` files
## Troubleshooting
{% tabs %}
{% tab label="VSCode" %}
If your rules aren't being followed:
1. **Check the `instructions` array** in your config to ensure the file path is correct.
2. **Verify Markdown formatting**: Ensure the file is valid Markdown.
3. **Restart the session**: Start a new chat session to pick up config changes.
{% /tab %}
{% tab label="CLI" %}
If your rules aren't being followed:
1. **Check the `instructions` array** in your config to ensure the file path is correct.
2. **Verify Markdown formatting**: Ensure the file is valid Markdown.
3. **Restart the session**: Start a new chat session to pick up config changes.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
If your custom rules aren't being properly followed:
1. **Check rule status in the UI**: Use the rules management interface to verify that your rules are active and properly loaded
1. **Verify rule formatting**: Ensure that your rules are properly formatted with clear Markdown structure
1. **Check rule locations**: Ensure that your rules are located in supported locations:
- Global rules: `~/.kilocode/rules/` directory
- Project rules: `.kilocode/rules/` directory
- Legacy files: `.kilocoderules`, `.roorules`, or `.clinerules`
1. **Rule specificity**: Verify that the rules are specific and unambiguous
1. **Restart VS Code**: Restart VS Code to ensure the rules are properly loaded
2. **Rule specificity**: Verify that the rules are specific and unambiguous
3. **Check rule locations**:
- **Check rule status in the UI**: Use the rules management interface to verify that your rules are active and properly loaded
- Ensure rules are in supported locations:
- Global rules: `~/.kilocode/rules/` directory
- Project rules: `.kilocode/rules/` directory
- Legacy files: `.kilocoderules`, `.roorules`, or `.clinerules`
- **Restart VS Code** to ensure the rules are properly loaded
{% /tab %}
{% /tabs %}
## Related Features
packages/kilo-docs/pages/customize/custom-subagents.md
+6 -5
View File
@@ -1,6 +1,7 @@
---
title: "Custom Subagents"
description: "Create and configure custom subagents in Kilo Code's CLI"
platform: new
---
# Custom Subagents
@@ -8,7 +9,7 @@ description: "Create and configure custom subagents in Kilo Code's CLI"
Kilo Code's CLI supports **custom subagents** — specialized AI assistants that can be invoked by primary agents or manually via `@` mentions. Subagents run in their own isolated sessions with tailored prompts, models, tool access, and permissions, enabling you to build purpose-built workflows for tasks like code review, documentation, security audits, and more.
{% callout type="info" %}
Custom subagents are currently configured through the config file (`kilo.json`) or via markdown agent files. UI-based configuration is not yet available.
Custom subagents are currently configured through the config file (`kilo.jsonc`) or via markdown agent files. UI-based configuration is not yet available.
{% /callout %}
## What Are Subagents?
@@ -47,7 +48,7 @@ There are two ways to define custom subagents: through JSON configuration or mar
### Method 1: JSON Configuration
Add agents to the `agent` section of your `kilo.json` config file. Any key that doesn't match a built-in agent name creates a new custom agent.
Add agents to the `agent` section of your `kilo.jsonc` config file. Any key that doesn't match a built-in agent name creates a new custom agent.
```json
{
@@ -245,8 +246,8 @@ Agent configurations are merged from multiple sources. Later sources override ea
1. **Built-in agent defaults** (native agents defined in the codebase)
2. **Global config** (`~/.config/kilo/config.json`)
3. **Global agent markdown files** (`~/.config/kilo/agents/*.md`)
4. **Project config** (`kilo.json` in the project root)
3. **Project config** (`kilo.jsonc` in the project root)
4. **Global agent markdown files** (`~/.config/kilo/agents/*.md`)
5. **Project agent markdown files** (`.kilo/agents/*.md`)
When overriding a built-in agent, properties are merged — only the fields you specify are overridden. When creating a new custom agent, unspecified fields use sensible defaults (`mode: "all"`, full permissions inherited from global config).
@@ -373,5 +374,5 @@ To disable a built-in agent entirely:
- [Custom Modes](/docs/customize/custom-modes) — Create specialized primary agents with tool restrictions
- [Custom Rules](/docs/customize/custom-rules) — Define rules that apply to specific file types or situations
- [Orchestrator Mode](/docs/code-with-ai/agents/orchestrator-mode) — Coordinate complex tasks by delegating to subagents
- [Orchestrator Mode](/docs/code-with-ai/agents/orchestrator-mode) — Legacy mode for task delegation (now built into all agents)
- [Task Tool](/docs/automate/tools/new-task) — The tool used to invoke subagents
packages/kilo-docs/pages/customize/skills.md
+331 -37
View File
@@ -47,6 +47,115 @@ This means:
Skills are loaded from multiple locations, allowing both personal skills and project-specific instructions.
{% tabs %}
{% tab label="VSCode" %}
### Global Skills (User-Level)
Global skills are located in the `.kilo` directory within your Home directory:
- Mac and Linux: `~/.kilo/skills/`
- Windows: `\Users\<yourUser>\.kilo\skills\`
```
~/.kilo/
└── skills/ # Generic skills (all modes)
├── my-skill/
│ └── SKILL.md
└── another-skill/
└── SKILL.md
```
### Project Skills (Workspace-Level)
Located in `.kilo/skills/` within your project:
```
your-project/
└── .kilo/
└── skills/ # Generic skills for this project
└── project-conventions/
└── SKILL.md
```
### Compatibility Directories
For interoperability with other tools, the CLI also loads skills from:
- `.claude/skills/` — Claude Code compatibility
- `.agents/skills/` — Open agent standard
### Additional Skill Paths and Remote URLs
You can configure extra skill locations and remote skill URLs in your `kilo.jsonc` config (project or global):
```jsonc
{
"skills": {
"paths": ["/path/to/shared/skills", "~/my-skills", "relative/skills"],
"urls": ["https://example.com/skills/my-skill/SKILL.md"],
},
}
```
The `skills.paths` key accepts absolute paths, `~/` home-relative paths, or paths relative to the project root. The `skills.urls` key accepts URLs pointing to remote `SKILL.md` files that are fetched on demand.
{% /tab %}
{% tab label="CLI" %}
### Global Skills (User-Level)
Global skills are located in the `.kilo` directory within your Home directory:
- Mac and Linux: `~/.kilo/skills/`
- Windows: `\Users\<yourUser>\.kilo\skills\`
```
~/.kilo/
└── skills/ # Generic skills (all modes)
├── my-skill/
│ └── SKILL.md
└── another-skill/
└── SKILL.md
```
### Project Skills (Workspace-Level)
Located in `.kilo/skills/` within your project:
```
your-project/
└── .kilo/
└── skills/ # Generic skills for this project
└── project-conventions/
└── SKILL.md
```
### Compatibility Directories
For interoperability with other tools, the CLI also loads skills from:
- `.claude/skills/` — Claude Code compatibility
- `.agents/skills/` — Open agent standard
### Additional Skill Paths and Remote URLs
You can configure extra skill locations and remote skill URLs in your `kilo.jsonc` config (project or global):
```jsonc
{
"skills": {
"paths": ["/path/to/shared/skills", "~/my-skills", "relative/skills"],
"urls": ["https://example.com/skills/my-skill/SKILL.md"],
},
}
```
The `skills.paths` key accepts absolute paths, `~/` home-relative paths, or paths relative to the project root. The `skills.urls` key accepts URLs pointing to remote `SKILL.md` files that are fetched on demand.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
### Global Skills (User-Level)
Global skills are located in the `.kilocode` directory within your Home directory.
@@ -84,9 +193,29 @@ your-project/
└── SKILL.md
```
{% /tab %}
{% /tabs %}
## Mode-Specific Skills
To create a skill that only appears in a specific mode:
{% tabs %}
{% tab label="VSCode" %}
The new platform does not use mode-specific skill directories. All skills are loaded into a shared pool and the agent decides which skill to invoke based on the skill's `description` field and the current task context.
If you need a skill to only apply in certain situations, write a clear and specific `description` in the SKILL.md frontmatter so the agent knows when to use it.
{% /tab %}
{% tab label="CLI" %}
The new platform does not use mode-specific skill directories. All skills are loaded into a shared pool and the agent decides which skill to invoke based on the skill's `description` field and the current task context.
If you need a skill to only apply in certain situations, write a clear and specific `description` in the SKILL.md frontmatter so the agent knows when to use it.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
To create a skill that only appears in a specific mode, place it in a `skills-{mode-slug}` directory:
```bash
# For Code mode only
@@ -98,8 +227,24 @@ mkdir -p ~/.kilocode/skills-architect/microservices
The directory naming pattern is `skills-{mode-slug}` where `{mode-slug}` matches the mode's identifier (e.g., `code`, `architect`, `ask`, `debug`).
{% /tab %}
{% /tabs %}
## Priority and Overrides
{% tabs %}
{% tab label="VSCode" %}
When multiple skills share the same name, project-level skills (`.kilo/skills/`) take precedence over global skills (`~/.kilo/skills/`). Skills from compatibility directories (`.claude/skills/`, `.agents/skills/`) and additional configured paths are loaded alongside project and global skills.
{% /tab %}
{% tab label="CLI" %}
When multiple skills share the same name, project-level skills (`.kilo/skills/`) take precedence over global skills (`~/.kilo/skills/`). Skills from compatibility directories (`.claude/skills/`, `.agents/skills/`) and additional configured paths are loaded alongside project and global skills.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
When multiple skills share the same name, Kilo Code uses these priority rules:
1. **Project skills override global skills** - A project skill with the same name takes precedence
@@ -111,8 +256,34 @@ This allows you to:
- Override them per-project when needed
- Customize behavior for specific modes
{% /tab %}
{% /tabs %}
## When Skills Are Loaded
{% tabs %}
{% tab label="VSCode" %}
Skills are discovered when a session starts. The CLI scans all configured skill directories and reads metadata (name, description, file path) for each skill.
- In the **CLI**: Skills are loaded when you start a new session or run `kilo run`
- In the **VS Code extension**: Skills are loaded when the extension connects to the CLI server
Skills are re-scanned at the start of each new session. To pick up newly added or modified skills, start a new session.
{% /tab %}
{% tab label="CLI" %}
Skills are discovered when a session starts. The CLI scans all configured skill directories and reads metadata (name, description, file path) for each skill.
- In the **CLI**: Skills are loaded when you start a new session or run `kilo run`
- In the **VS Code extension**: Skills are loaded when the extension connects to the CLI server
Skills are re-scanned at the start of each new session. To pick up newly added or modified skills, start a new session.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Skills are discovered when Kilo Code initializes:
- When VSCode starts
@@ -126,6 +297,9 @@ Skills directories are monitored for changes to `SKILL.md` files. However, the m
You can symlink skills directories to share skills across machines or from a central repository. When using symlinks, the skill's `name` field must match the **symlink name**, not the target directory name.
{% /tab %}
{% /tabs %}
## SKILL.md Format
The `SKILL.md` file uses YAML frontmatter followed by Markdown content containing the instructions:
@@ -213,62 +387,145 @@ These additional files can be referenced from your skill's instructions, allowin
## Example: Creating a Skill
{% tabs %}
{% tab label="VSCode" %}
1. Create the skill directory:
```bash
mkdir -p ~/.kilo/skills/api-design
```
2. Create `SKILL.md` (see content below)
3. Start a new session to pick up the skill
{% /tab %}
{% tab label="CLI" %}
1. Create the skill directory:
```bash
mkdir -p ~/.kilo/skills/api-design
```
2. Create `SKILL.md` (see content below)
3. Start a new session to pick up the skill
{% /tab %}
{% tab label="VSCode (Legacy)" %}
1. Create the skill directory:
```bash
mkdir -p ~/.kilocode/skills/api-design
```
2. Create `SKILL.md`:
```markdown
---
name: api-design
description: REST API design best practices and conventions
---
# API Design Guidelines
When designing REST APIs, follow these conventions:
## URL Structure
- Use plural nouns for resources: `/users`, `/orders`
- Use kebab-case for multi-word resources: `/order-items`
- Nest related resources: `/users/{id}/orders`
## HTTP Methods
- GET: Retrieve resources
- POST: Create new resources
- PUT: Replace entire resource
- PATCH: Partial update
- DELETE: Remove resource
## Response Codes
- 200: Success
- 201: Created
- 400: Bad Request
- 404: Not Found
- 500: Server Error
```
2. Create `SKILL.md` (see content below)
3. Reload VSCode to load the skill
4. The skill will now be available in all modes
{% /tab %}
{% /tabs %}
Example `SKILL.md`:
```markdown
---
name: api-design
description: REST API design best practices and conventions
---
# API Design Guidelines
When designing REST APIs, follow these conventions:
## URL Structure
- Use plural nouns for resources: `/users`, `/orders`
- Use kebab-case for multi-word resources: `/order-items`
- Nest related resources: `/users/{id}/orders`
## HTTP Methods
- GET: Retrieve resources
- POST: Create new resources
- PUT: Replace entire resource
- PATCH: Partial update
- DELETE: Remove resource
## Response Codes
- 200: Success
- 201: Created
- 400: Bad Request
- 404: Not Found
- 500: Server Error
```
## Finding Skills
{% tabs %}
{% tab label="VSCode" %}
The new platform does not have a marketplace UI yet. You can find and share skills through:
- **[Kilo Marketplace repository](https://github.com/Kilo-Org/kilo-marketplace)** — Browse community skills on GitHub and manually download them into your skills directory
- **[Agent Skills Specification](https://agentskills.io/home)** — The open specification that skills follow, enabling interoperability across different AI agents
- **Remote URLs** — Use the `skills.urls` config key to load skills directly from URLs without manually downloading them
{% /tab %}
{% tab label="CLI" %}
The new platform does not have a marketplace UI yet. You can find and share skills through:
- **[Kilo Marketplace repository](https://github.com/Kilo-Org/kilo-marketplace)** — Browse community skills on GitHub and manually download them into your skills directory
- **[Agent Skills Specification](https://agentskills.io/home)** — The open specification that skills follow, enabling interoperability across different AI agents
- **Remote URLs** — Use the `skills.urls` config key to load skills directly from URLs without manually downloading them
{% /tab %}
{% tab label="VSCode (Legacy)" %}
You can discover and install community-created skills through:
- **Kilo Marketplace** - Browse skills directly in the Kilo Code extension via the Marketplace tab, or explore the [Kilo Marketplace repository](https://github.com/Kilo-Org/kilo-marketplace) on GitHub
- [Agent Skills Specification](https://agentskills.io/home) - The open specification that skills follow, enabling interoperability across different AI agents
- **Kilo Marketplace** — Browse skills directly in the Kilo Code extension via the Marketplace tab, or explore the [Kilo Marketplace repository](https://github.com/Kilo-Org/kilo-marketplace) on GitHub
- [Agent Skills Specification](https://agentskills.io/home) — The open specification that skills follow, enabling interoperability across different AI agents
{% /tab %}
{% /tabs %}
## Troubleshooting
### Skill Not Loading?
{% tabs %}
{% tab label="VSCode" %}
1. **Verify frontmatter**: Ensure `name` and `description` are present in the YAML frontmatter. The `name` does not need to match the directory name but should be unique across all loaded skills.
2. **Start a new session**: Skills are scanned at session start. Begin a new session to pick up changes.
3. **Check file location**: Ensure `SKILL.md` is directly inside the skill directory (e.g., `.kilo/skills/my-skill/SKILL.md`), not nested further.
4. **Check config paths**: If using `skills.paths` or `skills.urls`, verify the paths and URLs are correct in your `kilo.jsonc`.
{% /tab %}
{% tab label="CLI" %}
1. **Verify frontmatter**: Ensure `name` and `description` are present in the YAML frontmatter. The `name` does not need to match the directory name but should be unique across all loaded skills.
2. **Start a new session**: Skills are scanned at session start. Begin a new session to pick up changes.
3. **Check file location**: Ensure `SKILL.md` is directly inside the skill directory (e.g., `.kilo/skills/my-skill/SKILL.md`), not nested further.
4. **Check config paths**: If using `skills.paths` or `skills.urls`, verify the paths and URLs are correct in your `kilo.jsonc`.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
1. **Check the Output panel**: Open `View` → `Output` → Select "Kilo Code" from dropdown. Look for skill-related errors.
2. **Verify frontmatter**: Ensure `name` exactly matches the directory name and `description` is present.
@@ -277,6 +534,9 @@ You can discover and install community-created skills through:
4. **Check file location**: Ensure `SKILL.md` is directly inside the skill directory, not nested further.
{% /tab %}
{% /tabs %}
### Verifying a Skill is Available
To confirm a skill is properly loaded and available to the agent, you can ask the agent directly. Simply send a message like:
@@ -291,10 +551,26 @@ If the agent confirms the skill is available, you're ready to use it. If not, ch
### Checking if a Skill Was Used
{% tabs %}
{% tab label="VSCode" %}
When the agent uses a skill, it invokes the `skill` tool with the skill's name. Look for a `skill` tool call in the conversation to confirm a skill was loaded. The tool output includes the full skill content injected into context.
{% /tab %}
{% tab label="CLI" %}
When the agent uses a skill, it invokes the `skill` tool with the skill's name. Look for a `skill` tool call in the conversation to confirm a skill was loaded. The tool output includes the full skill content injected into context.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
To see if a skill was actually used during a conversation, look for a `read_file` tool call in the chat that targets a `SKILL.md` file. When the agent decides to use a skill, it reads the full skill file into context—this appears as a file read operation in the conversation.
There's currently no dedicated UI indicator showing "Skill X was activated." The `read_file` call is the most reliable way to confirm a skill was used.
{% /tab %}
{% /tabs %}
### Common Errors
| Error | Cause | Solution |
@@ -307,6 +583,24 @@ There's currently no dedicated UI indicator showing "Skill X was activated." The
Have you created a skill that others might find useful? Share it with the community by contributing to the [Kilo Marketplace](https://github.com/Kilo-Org/kilo-marketplace)!
{% tabs %}
{% tab label="VSCode" %}
While the new platform does not yet have a built-in marketplace UI, skills from the [Kilo Marketplace repository](https://github.com/Kilo-Org/kilo-marketplace) can be manually downloaded into your `.kilo/skills/` directory or loaded via `skills.urls` in config.
{% /tab %}
{% tab label="CLI" %}
While the new platform does not yet have a built-in marketplace UI, skills from the [Kilo Marketplace repository](https://github.com/Kilo-Org/kilo-marketplace) can be manually downloaded into your `.kilo/skills/` directory or loaded via `skills.urls` in config.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Skills submitted to the marketplace are browsable and installable directly from the Marketplace tab in the **VSCode** version.
{% /tab %}
{% /tabs %}
### How to Submit Your Skill
1. **Prepare your skill**: Ensure your skill directory contains a valid `SKILL.md` file with proper frontmatter
packages/kilo-docs/pages/customize/workflows.md
+92 -6
View File
@@ -1,16 +1,64 @@
---
title: "Workflows"
description: "Create automated workflows with Kilo Code"
platform: new
---
# Workflows
Workflows automate repetitive tasks by defining step-by-step instructions for Kilo Code to execute. Invoke any workflow by typing `/[workflow-name.md]` in the chat.
Workflows (also called **slash commands** in the new extension) automate repetitive tasks by defining step-by-step instructions for Kilo Code to execute.
{% image src="/docs/img/slash-commands/workflows.png" alt="Workflows tab in Kilo Code" width="600" caption="Workflows tab in Kilo Code" /%}
## Creating Workflows
{% tabs %}
{% tab label="VSCode" %}
Workflows are Markdown files stored as **slash commands** in `.kilo/commands/`:
- **Global commands**: `~/.config/kilo/commands/` (available in all projects)
- **Project commands**: `[project]/.kilo/commands/` (project-specific)
### Basic Setup
1. Create a `.md` file with step-by-step instructions
2. Save it in your commands directory
3. Type `/command-name` in the chat (just the filename without `.md` extension) to execute
For example, a file at `.kilo/commands/submit-pr.md` is invoked with `/submit-pr`.
### Optional Frontmatter
Command files can include YAML frontmatter:
```markdown
---
description: Submit a pull request with checks
agent: code
---
You are helping submit a pull request...
```
| Field | Description |
| ------------- | --------------------------------------------- |
| `description` | Shown in the command picker |
| `agent` | Which agent to use when invoking this command |
| `model` | Model override for this command |
| `subtask` | When `true`, runs as a sub-agent session |
### Workflow Capabilities
Workflows can leverage all built-in tools: `read`, `glob`, `grep`, `edit`, `write`, `bash`, `webfetch`, and MCP server tools.
### Migration from Legacy Workflows
The new extension automatically migrates legacy workflows from `.kilocode/workflows/` to the new command format on startup. You can also manually move files and remove the `.md` extension from invocations.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Workflows are markdown files stored in `.kilocode/workflows/`:
- **Global workflows**: `~/.kilocode/workflows/` (available in all projects)
@@ -29,7 +77,10 @@ Workflows can leverage:
- [Built-in tools](/docs/automate/tools): [`read_file()`](/docs/automate/tools/read-file), [`search_files()`](/docs/automate/tools/search-files), [`execute_command()`](/docs/automate/tools/execute-command)
- CLI tools: `gh`, `docker`, `npm`, custom scripts
- [MCP integrations](/docs/automate/mcp/overview): Slack, databases, APIs
- [Mode switching](/docs/code-with-ai/agents/using-modes): [`new_task()`](/docs/automate/tools/new-task) for specialized contexts
- [Agent switching](/docs/code-with-ai/agents/using-agents): [`new_task()`](/docs/automate/tools/new-task) for specialized contexts
{% /tab %}
{% /tabs %}
## Common Workflow Patterns
@@ -64,7 +115,38 @@ Workflows can leverage:
## Example: PR Submission Workflow
Let's walk through creating a workflow for submitting a pull request. This workflow handles the entire process from code review to deployment notification.
Let's walk through creating a workflow for submitting a pull request.
{% tabs %}
{% tab label="VSCode" %}
Create a file called `submit-pr.md` in your `.kilo/commands` directory:
```markdown
---
description: Submit a pull request with full checks
---
# Submit PR Workflow
You are helping submit a pull request. Follow these steps:
1. First, use `grep` to check for any TODO comments or console.log statements that shouldn't be committed
2. Run tests using `bash` with `npm test` or the appropriate test command
3. If tests pass, stage and commit changes with a descriptive commit message
4. Push the branch and create a pull request using `bash` with `gh pr create`
5. Use `question` to get the PR title and description from the user
Parameters needed (ask if not provided):
- Branch name
- Reviewers to assign
```
Trigger this workflow by typing `/submit-pr` in the chat.
{% /tab %}
{% tab label="VSCode (Legacy)" %}
Create a file called `submit-pr.md` in your `.kilocode/workflows` directory:
@@ -85,12 +167,16 @@ Parameters needed (ask if not provided):
- Reviewers to assign
```
Now you can trigger this workflow by typing `/submit-pr.md` in the chat. Kilo Code will:
Trigger this workflow by typing `/submit-pr.md` in the chat.
{% /tab %}
{% /tabs %}
Kilo Code will:
- Scan your code for common issues before committing
- Run your test suite to catch problems early
- Handle the Git operations and PR creation
- Notify your team automatically
- Set up follow-up tasks for deployment
This saves you from manually running the same 7-step process every time you want to submit code for review.
This saves you from manually running the same steps every time you want to submit code for review.
packages/kilo-docs/pages/getting-started/quickstart.md
+2 -2
View File
@@ -157,7 +157,7 @@ Kilo Code analyzes your request and proposes specific actions. These may include
{% callout type="tip" %}
The level of autonomy is configurable, allowing you to make the agent more or less autonomous.
You can learn more about [using modes](/docs/code-with-ai/agents/using-modes) and [auto-approving actions](/docs/getting-started/settings/auto-approving-actions).
You can learn more about [using agents](/docs/code-with-ai/agents/using-agents) and [auto-approving actions](/docs/getting-started/settings/auto-approving-actions).
{% /callout %}
### Step 5: Iterate
@@ -180,7 +180,7 @@ You've completed your first task. Along the way you learned:
Ready for more? Here are some next steps:
- **[Autocomplete](/docs/code-with-ai/features/autocomplete)** — Get inline code suggestions as you type
- **[Modes](/docs/code-with-ai/agents/using-modes)** — Explore different modes for different tasks
- **[Agents](/docs/code-with-ai/agents/using-agents)** — Explore different agents for different tasks
- **[Git commit generation](/docs/code-with-ai/features/git-commit-generation)** — Automatically generate commit messages
{% callout type="tip" %}
packages/kilo-docs/pages/getting-started/settings/index.md
+23 -1
View File
@@ -140,7 +140,29 @@ Use this option only if you are certain you want to remove all Kilo Code data or
{% tabs %}
{% tab label="VSCode" %}
The extension does not currently expose the same experimental feature toggles as the **VSCode (Legacy)** version. Advanced options are configured via the JSONC config files that the Settings webview reads and writes. Refer to the auto-generated `$schema` in your `kilo.jsonc` for the full list of available options.
The new extension exposes experimental features via the **Experimental** tab in Settings (click the gear icon {% codicon name="gear" /%} → Experimental).
Available experimental toggles include:
- **Share mode** — `manual`, `auto`, or `disabled` session sharing
- **LSP integration** — expose language server diagnostics to the agent
- **Paste summary** — summarize large clipboard pastes before including them
- **Batch tool** — allow the agent to batch multiple tool calls in one step
Advanced options not exposed in the UI can be configured via the `experimental` key in `kilo.jsonc`:
```json
{
"experimental": {
"codebase_search": true,
"batch_tool": false,
"disable_paste_summary": false,
"mcp_timeout": 30000
}
}
```
Refer to the auto-generated `$schema` in your `kilo.jsonc` for the full list of available options.
{% /tab %}
{% tab label="CLI" %}
packages/kilo-docs/pages/kiloclaw/chat-platforms.md
-155
View File
@@ -1,155 +0,0 @@
---
title: "Connecting Chat Platforms"
description: "Connect your KiloClaw agent to Telegram, Discord, Slack, and more"
---
# Connecting Chat Platforms
KiloClaw supports connecting your AI agent to Telegram, Discord, and Slack. You can configure channels from the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard#channels), or from the OpenClaw Control UI after accessing your instance.
While the exact steps vary for configuring a chat platform (called a _channel_ by OpenClaw), the steps are to:
1. Configure the channel
2. Redeploy the KiloClaw instance
3. Initiate the pairing in the chat app
4. Accept the pairing request in the [KiloClaw UI](https://app.kilo.ai/claw)
Detailed instructions for supported chat apps are below.
## Chat Apps (Channels)
### Telegram
1. Open Telegram and search for [@BotFather](https://t.me/BotFather)
2. Send `/newbot` and follow the prompts to create your bot
3. Copy the **Bot Token** that BotFather gives you
4. Go to the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard)
5. Paste the token into the **Telegram Bot Token** field
6. Click **Save**
7. Redeploy your KiloClaw instance
8. Send a direct message to your bot in Telegram: `/start`
{% image src="/docs/img/kiloclaw/telegram.png" alt="Connect account screen" width="800" caption="Telegram bot token entry" /%}
You can remove or replace a configured token at any time.
> ℹ️ **Info**
> Advanced settings such as DM policy, allow lists, and groups can be configured in the OpenClaw Control UI after connecting.
### Discord
To connect Discord, you need a **Bot Token** from the [Discord Developer Portal](https://discord.com/developers/applications).
#### Create an Application and Bot
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) and log in
2. Click **New Application**, give it a name, and click **Create**
3. Click **Bot** on the left sidebar
4. Click **Add Bot** and confirm
#### Enable Privileged Intents
On the **Bot** page, scroll down to **Privileged Gateway Intents** and enable:
- **Message Content Intent** (required)
- **Server Members Intent** (recommended — needed for role allowlists and name matching)
- **Presence Intent** (optional)
#### Copy Your Bot Token
1. Scroll back up on the **Bot** page and click **Reset Token**
> 📝 **Note**
> Despite the name, this generates your first token — nothing is being "reset."
2. Copy the token that appears and paste it into the **Discord Bot Token** field in your KiloClaw dashboard.
{% image src="/docs/img/kiloclaw/discord.png" alt="Connect account screen" width="800" caption="Discord bot token entry" /%}
Enter the token in the Settings tab and click **Save**. You can remove or replace a configured token at any time.
#### Generate an Invite URL and Add the Bot to Your Server
1. Click **OAuth2** on the sidebar
2. Scroll down to **OAuth2 URL Generator** and enable:
- `bot`
- `applications.commands`
3. A **Bot Permissions** section will appear below. Enable:
- View Channels
- Send Messages
- Read Message History
- Embed Links
- Attach Files
- Add Reactions (optional)
4. Copy the generated URL at the bottom
5. Paste it into your browser, select your server, and click **Continue**
6. You should now see your bot in the Discord server
#### Start Chatting with the Bot
1. Right-click on the Bot in Discord and click **Message**
2. DM the bot `/pair`
3. You should get a response back with a pairing code
4. Return to [app.kilocode.ai/claw](https://app.kilocode.ai/claw) and confirm the pairing code and approve
5. You should now be able to chat with the bot from Discord
### Slack
#### Step 1: Create a Slack App from the OpenClaw Manifest
1. Go to [Slack App Management](https://api.slack.com/apps) and click **Create New App** → **From a Manifest**
2. Copy the manifest from the [OpenClaw docs](https://docs.openclaw.ai/channels/slack#manifest-and-scope-checklist)
3. Paste the manifest JSON into Slack's manifest editor
4. Customize the manifest before creating:
- Rename the app to your preferred name wherever it appears
- Update the slash command if desired (e.g., `/kiloclaw`)
5. Click **Create**
#### Step 2: Generate Tokens
You need two tokens from Slack:
**App-Level Token**
1. In your Slack app settings, scroll down to **App-Level Tokens**
2. Click **Generate Token**
3. Add the `connections:write` scope
4. Generate and copy the token (starts with `xapp-`)
**Bot User OAuth Token**
1. In the left sidebar, click **Install App**
2. Install the app to your workspace
3. Copy the **Bot User OAuth Token** (starts with `xoxb-`)
#### Step 3: Connect Slack to KiloClaw
1. In the [KiloClaw UI](https://app.kilo.ai/claw), find the Slack integration section (may show "not configured")
2. Enter both tokens:
- The `xapp-` app-level token
- The `xoxb-` bot user OAuth token
3. Click **Save**
4. Scroll to the top of the KiloClaw UI and click **Redeploy**. Wait for the instance to come back up
#### Step 4: Pair Slack with KiloClaw
1. In Slack, DM the app and type your slash command (e.g., `/claw`) followed by anything — this triggers the pairing flow
> 📝 **Note**
> The slash command is whatever you defined in the manifest. Any text after the command will work to trigger pairing.
2. The app will return a pairing code
3. Return to [app.kilocode.ai/claw](https://app.kilocode.ai/claw) and confirm the pairing code and approve
4. You should now be able to chat with the bot from Slack
## Future Support
Additional platforms (such as WhatsApp) are planned for future releases. For the latest on supported platforms, refer to the [OpenClaw documentation](https://docs.openclaw.ai).
## Related
- [KiloClaw Overview](/docs/kiloclaw/overview)
- [Dashboard Reference](/docs/kiloclaw/dashboard)
- [Troubleshooting](/docs/kiloclaw/troubleshooting)
- [KiloClaw Pricing](/docs/kiloclaw/pricing)
- [OpenClaw Documentation](https://docs.openclaw.ai)
packages/kilo-docs/pages/kiloclaw/chat-platforms/discord.md
+67
View File
@@ -0,0 +1,67 @@
---
title: "Discord"
description: "Connect your KiloClaw agent to Discord"
---
# Discord
Connect your KiloClaw agent to Discord by creating a bot in the Discord Developer Portal and linking it to your KiloClaw dashboard.
## Prerequisites
Make sure you have a Discord server ready to add the bot to. If you don't have one, open Discord, scroll to the bottom of your server list, click **+**, choose **Create My Own**, then **For me and my friends**, and give it a name.
## Create an Application and Bot
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) and log in
2. Click **New Application**, give it a name, and click **Create**
## Enable Privileged Intents
On the **Bot** page, scroll down to **Privileged Gateway Intents** and enable:
- **Message Content Intent** (required)
- **Server Members Intent** (recommended — needed for role allowlists and name matching)
- **Presence Intent** (optional)
## Generate an Invite URL and Add the Bot to Your Server
1. Click **OAuth2** on the sidebar
2. Scroll down to **OAuth2 URL Generator** and enable:
- `bot`
- `applications.commands`
3. A **Bot Permissions** section will appear below. Enable:
- View Channels
- Send Messages
- Read Message History
- Embed Links
- Attach Files
- Add Reactions (optional)
4. Copy the generated URL at the bottom
5. Paste it into your browser, select your server, and click **Continue**
6. You should now see your bot in the Discord server
## Copy Your Bot Token
1. Go back to the **Bot** page on the left sidebar and click **Reset Token**
> 📝 **Note**
> Despite the name, this generates your first token — nothing is being "reset."
2. Copy the token that appears and paste it into the **Discord Bot Token** field in your KiloClaw dashboard.
{% image src="/docs/img/kiloclaw/discord.png" alt="Connect account screen" width="800" caption="Discord bot token entry" /%}
Enter the token in the Settings tab and click **Save**. You can remove or replace a configured token at any time.
## Redeploy to Apply Changes
After saving your token, click **Redeploy** (the yellow button at the top of the KiloClaw dashboard) to apply the changes. The server will restart in about 30–45 seconds. Wait for the redeploy to complete before pairing.
## Start Chatting with the Bot
1. Right-click on the Bot in Discord and click **Message**
2. DM the bot `/pair`
3. You should get a response back with a pairing code
4. Return to [app.kilo.ai/claw](https://app.kilo.ai/claw) and confirm the pairing code and approve
5. You should now be able to chat with the bot from Discord
packages/kilo-docs/pages/kiloclaw/chat-platforms/index.md
+21
View File
@@ -0,0 +1,21 @@
---
title: "Chat Platforms"
description: "Connect your KiloClaw agent to Telegram, Discord, and Slack"
---
# Chat Platforms
KiloClaw supports connecting your AI agent to messaging platforms so it can receive instructions and send responses directly in your chat apps. You can configure channels from the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard#channels), or from the OpenClaw Control UI after accessing your instance.
The general steps to connect any chat platform are:
1. Configure the channel token in Settings
2. Redeploy the KiloClaw instance
3. Initiate the pairing in the chat app
4. Accept the pairing request in the [KiloClaw UI](https://app.kilo.ai/claw)
## Supported Platforms
- [**Telegram**](/docs/kiloclaw/chat-platforms/telegram) — Connect via a BotFather bot token.
- [**Discord**](/docs/kiloclaw/chat-platforms/discord) — Connect via a Discord Developer Portal bot token.
- [**Slack**](/docs/kiloclaw/chat-platforms/slack) — Connect via a Slack app manifest with app-level and bot tokens.
packages/kilo-docs/pages/kiloclaw/chat-platforms/slack.md
+55
View File
@@ -0,0 +1,55 @@
---
title: "Slack"
description: "Connect your KiloClaw agent to Slack"
---
# Slack
Connect your KiloClaw agent to Slack by creating a Slack app from the OpenClaw manifest and linking it to your KiloClaw dashboard.
## Step 1: Create a Slack App from the OpenClaw Manifest
1. Go to [Slack App Management](https://api.slack.com/apps) and click **Create New App** → **From a Manifest**
2. Copy the manifest from the [OpenClaw docs](https://docs.openclaw.ai/channels/slack#manifest-and-scope-checklist)
3. Paste the manifest JSON into Slack's manifest editor
4. Customize the manifest before creating:
- Rename the app to your preferred name wherever it appears
- Update the slash command if desired (e.g., `/kiloclaw`)
5. Click **Create**
## Step 2: Generate Tokens
You need two tokens from Slack:
**App-Level Token**
1. In your Slack app settings, scroll down to **App-Level Tokens**
2. Click **Generate Token**
3. Add the `connections:write` scope
4. Generate and copy the token (starts with `xapp-`)
**Bot User OAuth Token**
1. In the left sidebar, click **Install App**
2. Install the app to your workspace
3. Copy the **Bot User OAuth Token** (starts with `xoxb-`)
## Step 3: Connect Slack to KiloClaw
1. In the [KiloClaw UI](https://app.kilo.ai/claw), find the Slack integration section (may show "not configured")
2. Enter both tokens:
- The `xapp-` app-level token
- The `xoxb-` bot user OAuth token
3. Click **Save**
4. Scroll to the top of the KiloClaw UI and click **Redeploy**. Wait for the instance to come back up
## Step 4: Pair Slack with KiloClaw
1. In Slack, DM the app and type your slash command (e.g., `/claw`) followed by anything — this triggers the pairing flow
> 📝 **Note**
> The slash command is whatever you defined in the manifest. Any text after the command will work to trigger pairing.
2. The app will return a pairing code
3. Return to [app.kilocode.ai/claw](https://app.kilocode.ai/claw) and confirm the pairing code and approve
4. You should now be able to chat with the bot from Slack
packages/kilo-docs/pages/kiloclaw/chat-platforms/telegram.md
+24
View File
@@ -0,0 +1,24 @@
---
title: "Telegram"
description: "Connect your KiloClaw agent to Telegram"
---
# Telegram
Connect your KiloClaw agent to Telegram by creating a bot via BotFather and linking it to your KiloClaw dashboard.
1. Open Telegram and search for [@BotFather](https://t.me/BotFather)
2. Send `/newbot` and follow the prompts to create your bot
3. Copy the **Bot Token** that BotFather gives you
4. Go to the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard)
5. Paste the token into the **Telegram Bot Token** field
6. Click **Save**
7. Redeploy your KiloClaw instance
8. Send a direct message to your bot in Telegram: `/start`
{% image src="/docs/img/kiloclaw/telegram.png" alt="Connect account screen" width="800" caption="Telegram bot token entry" /%}
You can remove or replace a configured token at any time.
> ℹ️ **Info**
> Advanced settings such as DM policy, allow lists, and groups can be configured in the OpenClaw Control UI after connecting.
packages/kilo-docs/pages/kiloclaw/control-ui.md
-116
View File
@@ -1,116 +0,0 @@
---
title: "OpenClaw Control UI"
description: "Browser-based dashboard for managing your OpenClaw instance"
---
# OpenClaw Control UI
The Control UI is a browser-based dashboard (built with Vite + Lit) served by the OpenClaw Gateway on the same port as the gateway itself (default: `http://localhost:18789/`). It connects via WebSocket and gives you real-time control over your agent, channels, sessions, and system configuration. For KiloClaw users, see [Accessing the Control UI](/docs/kiloclaw/dashboard#accessing-the-control-ui) to get started.
## Features
- **Chat** — Send messages, stream responses with live tool-call output, view history, and abort runs.
- **Channels** — View the status of connected messaging platforms, scan QR codes for login, and edit per-channel config.
- **Sessions** — List active sessions with thinking and verbose overrides.
- **Cron Jobs** — Create, edit, enable/disable, run, and view history of scheduled tasks.
- **Skills** — View status, enable/disable, install, and manage API keys for skills.
- **Nodes** — List paired devices and their capabilities.
- **Exec Approvals** — Edit gateway or node command allowlists. See [Exec Approvals](#exec-approvals) below.
- **Config** — View and edit `openclaw.json` with schema-based form rendering and a raw JSON editor.
- **Logs** — Live tail of gateway logs with filtering and export.
- **Debug** — Status, health, model snapshots, event log, and manual RPC calls.
- **Update** — Run package updates and restart the gateway.
For more details, please see the official [OpenClaw documentation](https://docs.openclaw.ai/web/control-ui).
{% callout type="warning" %}
Do not use the **Update** feature in the Control UI to update KiloClaw. Use **Redeploy** from the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#redeploy) instead. Updating via the Control UI will not apply the correct KiloClaw platform image and may break your instance.
{% /callout %}
## Changing Models
The Control UI Chat tab doubles as a command line for model management. KiloClaw exposes 335+ models through the `kilocode` provider and you can browse and switch between them without leaving the chat.
| Command | Description |
| ------------------------------------ | ------------------------------------------------------------------------------- |
| `/model status` | View the currently active model and provider |
| `/models kilocode` | Browse available models (paginated, 20 per page) |
| `/models kilocode <page>` | Jump to a specific page (e.g. `/models kilocode 2`) |
| `/model kilocode/<provider>/<model>` | Switch to a specific model (e.g. `/model kilocode/anthropic/claude-sonnet-4.6`) |
| `/models kilocode all` | List every available model at once |
Each `/models` response includes helper text at the bottom with shortcuts for switching, paging, and listing all models.
To change the default model for all new sessions, edit `agents.defaults.model.primary` in your `openclaw.json` via **Config** in the Control UI (or the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#changing-the-model) for a quick dropdown pick).
For the full list of providers, advanced configuration, and CLI commands, see the [OpenClaw Model Providers documentation](https://docs.openclaw.ai/providers).
## Authentication
Auth is handled via token or password on the WebSocket handshake. Remote connections require one-time device pairing — the pairing request appears on the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#pairing-requests) or in the Control UI itself.
## Exec Approvals
Exec approvals are the safety interlock that controls which commands your agent can run on the host machine (gateway or node). By default, **all host exec requests are denied** — you must explicitly allowlist the commands you want your agent to run independently. This prevents accidental execution of destructive commands.
{% callout type="warning" %}
The default security policy is `deny`. You must configure an allowlist before your agent can execute any host commands.
{% /callout %}
### How It Works
Approvals are enforced locally on the execution host and sit on top of tool policy and elevated gating. The effective policy is always the **stricter** of `tools.exec.*` and the approvals defaults. Settings are stored in `~/.openclaw/exec-approvals.json` on the host.
### Security Policies
| Policy | Behavior |
| ----------- | ---------------------------------------------- |
| `deny` | Block all host exec requests (default) |
| `allowlist` | Allow only commands matching the allowlist |
| `full` | Allow everything (equivalent to elevated mode) |
### Ask Behavior
The `ask` setting controls when the user is prompted for approval:
| Setting | Behavior |
| --------- | ------------------------------------------------------- |
| `off` | Never prompt |
| `on-miss` | Prompt only when the allowlist does not match (default) |
| `always` | Prompt on every command |
If a prompt is required but no UI is reachable, the `askFallback` setting decides the outcome (`deny` by default).
### Allowlists
Allowlists are **per agent** — each agent has its own set of allowed command patterns. Patterns are case-insensitive globs that must resolve to binary paths (basename-only entries are ignored).
Example patterns:
```
~/Projects/**/bin/rg
~/.local/bin/*
/opt/homebrew/bin/rg
```
Each entry tracks last-used metadata (timestamp, command, resolved path) so you can audit and keep the list tidy.
### Approval Flow
When a command requires approval, the gateway broadcasts the request to connected operator clients. The approval dialog shows the command, arguments, working directory, agent ID, and resolved path. You can:
- **Allow once** — run the command now
- **Allow always** — add to the allowlist and run
- **Deny** — block the request
Approval prompts can also be forwarded to chat channels (Slack, Telegram, Discord, etc.) and resolved with `/approve`.
### Editing in the Control UI
Navigate to **Nodes > Exec Approvals** in the Control UI to edit defaults, per-agent overrides, and allowlists. Select a scope (Defaults or a specific agent), adjust the policy, add or remove allowlist patterns, then save.
## Related
- [KiloClaw Dashboard](/docs/kiloclaw/dashboard)
- [KiloClaw Overview](/docs/kiloclaw/overview)
- [Connecting Chat Platforms](/docs/kiloclaw/chat-platforms)
packages/kilo-docs/pages/kiloclaw/control-ui/changing-models.md
+22
View File
@@ -0,0 +1,22 @@
---
title: "Changing Models"
description: "Browse and switch models from the Control UI chat"
---
# Changing Models
The Control UI Chat tab doubles as a command line for model management. KiloClaw exposes 335+ models through the `kilocode` provider and you can browse and switch between them without leaving the chat.
| Command | Description |
| ------------------------------------ | ------------------------------------------------------------------------------- |
| `/model status` | View the currently active model and provider |
| `/models kilocode` | Browse available models (paginated, 20 per page) |
| `/models kilocode <page>` | Jump to a specific page (e.g. `/models kilocode 2`) |
| `/model kilocode/<provider>/<model>` | Switch to a specific model (e.g. `/model kilocode/anthropic/claude-sonnet-4.6`) |
| `/models kilocode all` | List every available model at once |
Each `/models` response includes helper text at the bottom with shortcuts for switching, paging, and listing all models.
To change the default model for all new sessions, edit `agents.defaults.model.primary` in your `openclaw.json` via **Config** in the Control UI (or the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#changing-the-model) for a quick dropdown pick).
For the full list of providers, advanced configuration, and CLI commands, see the [OpenClaw Model Providers documentation](https://docs.openclaw.ai/providers).
packages/kilo-docs/pages/kiloclaw/control-ui/exec-approvals.md
+64
View File
@@ -0,0 +1,64 @@
---
title: "Exec Approvals"
description: "Control which commands your KiloClaw agent can run on the host machine"
---
# Exec Approvals
Exec approvals are the safety interlock that controls which commands your agent can run on the host machine (gateway or node). By default, **all host exec requests are denied** — you must explicitly allowlist the commands you want your agent to run independently. This prevents accidental execution of destructive commands.
{% callout type="warning" %}
The default security policy is `deny`. You must configure an allowlist before your agent can execute any host commands.
{% /callout %}
## How It Works
Approvals are enforced locally on the execution host and sit on top of tool policy and elevated gating. The effective policy is always the **stricter** of `tools.exec.*` and the approvals defaults. Settings are stored in `~/.openclaw/exec-approvals.json` on the host.
## Security Policies
| Policy | Behavior |
| ----------- | ---------------------------------------------- |
| `deny` | Block all host exec requests (default) |
| `allowlist` | Allow only commands matching the allowlist |
| `full` | Allow everything (equivalent to elevated mode) |
## Ask Behavior
The `ask` setting controls when the user is prompted for approval:
| Setting | Behavior |
| --------- | ------------------------------------------------------- |
| `off` | Never prompt |
| `on-miss` | Prompt only when the allowlist does not match (default) |
| `always` | Prompt on every command |
If a prompt is required but no UI is reachable, the `askFallback` setting decides the outcome (`deny` by default).
## Allowlists
Allowlists are **per agent** — each agent has its own set of allowed command patterns. Patterns are case-insensitive globs that must resolve to binary paths (basename-only entries are ignored).
Example patterns:
```
~/Projects/**/bin/rg
~/.local/bin/*
/opt/homebrew/bin/rg
```
Each entry tracks last-used metadata (timestamp, command, resolved path) so you can audit and keep the list tidy.
## Approval Flow
When a command requires approval, the gateway broadcasts the request to connected operator clients. The approval dialog shows the command, arguments, working directory, agent ID, and resolved path. You can:
- **Allow once** — run the command now
- **Allow always** — add to the allowlist and run
- **Deny** — block the request
Approval prompts can also be forwarded to chat channels (Slack, Telegram, Discord, etc.) and resolved with `/approve`.
## Editing in the Control UI
Navigate to **Nodes > Exec Approvals** in the Control UI to edit defaults, per-agent overrides, and allowlists. Select a scope (Defaults or a specific agent), adjust the policy, add or remove allowlist patterns, then save.
packages/kilo-docs/pages/kiloclaw/control-ui/overview.md
+32
View File
@@ -0,0 +1,32 @@
---
title: "Control UI Overview"
description: "Browser-based dashboard for managing your OpenClaw instance"
---
# OpenClaw Control UI
The Control UI is a browser-based dashboard (built with Vite + Lit) served by the OpenClaw Gateway on the same port as the gateway itself (default: `http://localhost:18789/`). It connects via WebSocket and gives you real-time control over your agent, channels, sessions, and system configuration. For KiloClaw users, see [Accessing the Control UI](/docs/kiloclaw/dashboard#accessing-the-control-ui) to get started.
## Features
- **Chat** — Send messages, stream responses with live tool-call output, view history, and abort runs.
- **Channels** — View the status of connected messaging platforms, scan QR codes for login, and edit per-channel config.
- **Sessions** — List active sessions with thinking and verbose overrides.
- **Cron Jobs** — Create, edit, enable/disable, run, and view history of scheduled tasks.
- **Skills** — View status, enable/disable, install, and manage API keys for skills.
- **Nodes** — List paired devices and their capabilities.
- **Exec Approvals** — Edit gateway or node command allowlists. See [Exec Approvals](/docs/kiloclaw/control-ui/exec-approvals).
- **Config** — View and edit `openclaw.json` with schema-based form rendering and a raw JSON editor.
- **Logs** — Live tail of gateway logs with filtering and export.
- **Debug** — Status, health, model snapshots, event log, and manual RPC calls.
- **Update** — Run package updates and restart the gateway.
For more details, please see the official [OpenClaw documentation](https://docs.openclaw.ai/web/control-ui).
{% callout type="warning" %}
Do not use the **Update** feature in the Control UI to update KiloClaw. Use **Redeploy** from the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#redeploy) instead. Updating via the Control UI will not apply the correct KiloClaw platform image and may break your instance.
{% /callout %}
## Authentication
Auth is handled via token or password on the WebSocket handshake. Remote connections require one-time device pairing — the pairing request appears on the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#pairing-requests) or in the Control UI itself.
packages/kilo-docs/pages/kiloclaw/version-pinning.md → packages/kilo-docs/pages/kiloclaw/control-ui/version-pinning.md
-6
View File
@@ -45,9 +45,3 @@ To return to automatic updates:
{% callout type="warning" %}
Clearing a pin and running **Upgrade & Redeploy** will update your instance to the latest supported platform version. Review the changelog before upgrading to check for breaking changes.
{% /callout %}
## Related
- [Dashboard Reference](/docs/kiloclaw/dashboard)
- [KiloClaw Overview](/docs/kiloclaw/overview)
- [Troubleshooting](/docs/kiloclaw/troubleshooting)
packages/kilo-docs/pages/kiloclaw/dashboard.md
+6 -2
View File
@@ -74,6 +74,10 @@ If the gateway crashes, it's automatically restarted. The machine itself can be
Gateway process info is only available when the machine is running.
{% /callout %}
## Instance Specs
The specs of your instance, including number of CPUs, memory, and storage, are visible at the top right of the instance controls section.
## Settings
### Changing the Model
@@ -96,7 +100,7 @@ You can pin your instance to a specific OpenClaw version and variant from the Se
Select a version and variant from the dropdowns and click **Save**. To return to automatic updates, clear the version pin and save.
See [Version Pinning](/docs/kiloclaw/version-pinning) for details.
See [Version Pinning](/docs/kiloclaw/control-ui/version-pinning) for details.
### Version Status Indicators
@@ -195,4 +199,4 @@ These are the beta specifications for machines and subject to change without not
- [OpenClaw Control UI](/docs/kiloclaw/control-ui)
- [Connecting Chat Platforms](/docs/kiloclaw/chat-platforms)
- [Troubleshooting](/docs/kiloclaw/troubleshooting)
- [KiloClaw Pricing](/docs/kiloclaw/pricing)
- [KiloClaw Pricing](/docs/kiloclaw/faq/pricing)
packages/kilo-docs/pages/kiloclaw/development-tools/index.md
+13
View File
@@ -0,0 +1,13 @@
---
title: "Development Tools"
description: "Connect your KiloClaw agent to development platforms like GitHub and Google Workspace"
---
# Development Tools
KiloClaw supports integrations with popular development platforms, allowing your agent to interact with repositories, code reviews, calendars, documents, and more — all autonomously.
## Available Integrations
- [**GitHub**](/docs/kiloclaw/development-tools/github) — Clone repositories, push commits, open pull requests, and leave code reviews.
- [**Google Workspace**](/docs/kiloclaw/development-tools/google) — Access Gmail, Calendar, Drive, Docs, Sheets, Slides, Tasks, and more.

Some files were not shown because too many files have changed in this diff Show More