Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 35 additions & 32 deletions apps/kilocode-docs/docs/advanced-usage/cloud-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Cloud Agents let you run Kilo Code in the cloud from any device, without relying

## What Cloud Agents Enable

- Run Kilo Code remotely from a browser
- Auto-create branches and push work continuously
- Use env vars + startup commands to shape the workspace
- Run Kilo Code remotely from a browser
- Auto-create branches and push work continuously
- Use env vars + startup commands to shape the workspace
- Work from anywhere while keeping your repo in sync

---
Expand All @@ -30,18 +30,18 @@ Before using Cloud Agents:
## Cost

- **Compute is free during limited beta**
- Please provide any feedback in our Cloud Agents beta Discord channel:
- [Kilo Discord](https://discord.gg/D2ExdEcq)
- Please provide any feedback in our Cloud Agents beta Discord channel:
- [Kilo Discord](https://discord.gg/D2ExdEcq)
- **Kilo Code credits are still used** when the agent performs work (model usage, operations, etc.).

---

## How to Use

1. **Connect your GitHub account** in the [Integrations](https://app.kilo.ai/integrations) tab of your personal or organization dashboard.
2. **Select a repository** to use as your workspace.
3. **Add environment variables** (secrets supported) and set optional startup commands.
4. **Start chatting with Kilo Code.**
1. **Connect your GitHub account** in the [Integrations](https://app.kilo.ai/integrations) tab of your personal or organization dashboard.
2. **Select a repository** to use as your workspace.
3. **Add environment variables** (secrets supported) and set optional startup commands.
4. **Start chatting with Kilo Code.**

Your work is always pushed to GitHub, ensuring nothing is lost.

Expand All @@ -52,20 +52,22 @@ Your work is always pushed to GitHub, ensuring nothing is lost.
- Each user receives an **isolated Linux container** with common dev tools preinstalled (Python, Node.js, git, etc.).
- All Cloud Agent chats share a **single container instance**, while each session gets its own workspace directory.
- When a session begins:
1. Your repo is cloned
2. A unique branch is created
3. Your startup commands run
4. Env vars are injected

1. Your repo is cloned
2. A unique branch is created
3. Your startup commands run
4. Env vars are injected

- After every message, the agent:
- Looks for file changes
- Commits them
- Pushes to the session’s branch

- Looks for file changes
- Commits them
- Pushes to the session’s branch

- Containers are **ephemeral**:
- Spindown occurs after inactivity
- Expect slightly longer setup after idle periods
- Inactive sessions are deleted after **7 days** during the beta
- Spindown occurs after inactivity
- Expect slightly longer setup after idle periods
- Inactive sessions are deleted after **7 days** during the beta

---

Expand All @@ -74,28 +76,30 @@ Your work is always pushed to GitHub, ensuring nothing is lost.
You can customize each Cloud Agent session by defining:

### Environment Variables
- Add key/value pairs or secrets
- Injected into the container before the session starts

- Add key/value pairs or secrets
- Injected into the container before the session starts
- Useful for API keys or config flags

### Startup Commands
- Commands run immediately after cloning the repo and checking out the session branch

- Commands run immediately after cloning the repo and checking out the session branch
- Great for:
- Installing dependencies
- Bootstrapping tooling
- Running setup scripts
- Installing dependencies
- Bootstrapping tooling
- Running setup scripts

---

## Perfect For

Cloud Agents are great for:

- **Remote debugging** using Kilo Code debug mode
- **Exploration of unfamiliar codebases** without touching your local machine
- **Architect-mode brainstorming** while on the go
- **Automated refactors or tech debt cleanup** driven by Kilo Code
- **Offloading CI-like tasks**, experiments, or batch updates
- **Remote debugging** using Kilo Code debug mode
- **Exploration of unfamiliar codebases** without touching your local machine
- **Architect-mode brainstorming** while on the go
- **Automated refactors or tech debt cleanup** driven by Kilo Code
- **Offloading CI-like tasks**, experiments, or batch updates

---

Expand All @@ -108,5 +112,4 @@ Cloud Agents are great for:
- **Auto/YOLO mode is always on.**
The agent will modify code without prompting for confirmation.
- **Saved sessions** in the sidebar are not yet shared between logins or restorable locally.
- **MCP support is coming**, but **Docker-based MCP servers will *not* be supported**.

- **MCP support is coming**, but **Docker-based MCP servers will _not_ be supported**.
38 changes: 19 additions & 19 deletions apps/kilocode-docs/docs/advanced-usage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ sidebar_label: Deploy

Kilo Deploy lets you ship **Next.js** applications directly from Kilo Code, with:

- **One-click deployment** from the Kilo Code dashboard
- **No manual configuration** — deployment settings are generated for you
- **Deployment history** with logs and build details
- **Automatic rebuilds** on every GitHub push
- **One-click deployment** from the Kilo Code dashboard
- **No manual configuration** — deployment settings are generated for you
- **Deployment history** with logs and build details
- **Automatic rebuilds** on every GitHub push

---

## Prerequisites

- Your project must use **Next.js 15** (all minor/patch versions) or the **latest minor of Next.js 14**
- You must enable the **GitHub Integration**
- Go to **Integrations → GitHub**
- Click **Configure** and follow the prompts to connect GitHub to Kilo Code
- Go to **Integrations → GitHub**
- Click **Configure** and follow the prompts to connect GitHub to Kilo Code

Deploy supports all major package managers: **npm, pnpm, yarn, bun**. Kilo Code automatically detects which one your project uses and runs the correct build command.

Expand All @@ -44,10 +44,10 @@ Deploy supports all major package managers: **npm, pnpm, yarn, bun**. Kilo Code

Kilo Code will:

- Build your project
- Upload artifacts
- Provision your deployment
- Stream logs in real time
- Build your project
- Upload artifacts
- Provision your deployment
- Stream logs in real time

Once complete, you’ll receive a **deployment URL** you can open or share.

Expand All @@ -59,15 +59,15 @@ Once complete, you’ll receive a **deployment URL** you can open or share.

Each deployment is saved automatically with:

- Timestamp
- Build logs
- Deployment URL (Preview/Production)
- Timestamp
- Build logs
- Deployment URL (Preview/Production)

From the deployment details, you can:

- Inspect previous builds
- Redeploy
- Delete deployments
- Inspect previous builds
- Redeploy
- Delete deployments

---

Expand All @@ -85,6 +85,6 @@ Kilo Deploy supports Environment Variables and Secrets. Add the variable **key**

Deploy is ideal for:

1. **Quick prototypes** — instantly push an idea live
2. **Staging environments** — share a preview environment
3. **Rapid iteration** — push commits and get automatic rebuilds
1. **Quick prototypes** — instantly push an idea live
2. **Staging environments** — share a preview environment
3. **Rapid iteration** — push commits and get automatic rebuilds
4 changes: 2 additions & 2 deletions apps/kilocode-docs/docs/basic-usage/using-modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Four ways to switch modes:

1. **Dropdown menu:** Click the selector to the left of the chat input

<img src="/docs/img/modes/modes.png" alt="Using the dropdown menu to switch modes" width="400" />
<img 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

<img src="/docs/img/modes/modes-1.png" alt="Using slash commands to switch modes" width="400" />
<img src="/docs/img/modes/modes-1.png" alt="Using slash commands to switch modes" width="400" />

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.

Expand Down
14 changes: 7 additions & 7 deletions apps/kilocode-docs/docs/features/api-configuration-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,39 +26,39 @@ Note that available settings vary by provider and model. Each provider offers di
1. Open Settings by clicking the gear icon <Codicon name="gear" /> → Providers
2. Click the "+" button next to the profile selector

<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-1.png" alt="Profile selector with plus button" width="550" />
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-1.png" alt="Profile selector with plus button" width="550" />

3. Enter a name for your new profile

<img src="/docs/img/api-configuration-profiles/api-configuration-profiles.png" alt="Creating a new profile dialog" width="550" />
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles.png" alt="Creating a new profile dialog" width="550" />

4. Configure the profile settings:

- Select your API provider
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-2.png" alt="Provider selection dropdown" width="550" />
- Enter API key

<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-3.png" alt="API key entry field" width="550" />
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-3.png" alt="API key entry field" width="550" />

- Choose a model

<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-8.png" alt="Model selection interface" width="550" />
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-8.png" alt="Model selection interface" width="550" />

- Adjust model parameters

<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-5.png" alt="Model parameter adjustment controls" width="550" />
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-5.png" alt="Model parameter adjustment controls" width="550" />

### Switching Profiles

Switch profiles in two ways:

1. From Settings panel: Select a different profile from the dropdown

<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-7.png" alt="Profile selection dropdown in Settings" width="550" />
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-7.png" alt="Profile selection dropdown in Settings" width="550" />

2. During chat: Access the API Configuration dropdown in the chat interface

<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-6.png" alt="API Configuration dropdown in chat interface" width="550" />
<img src="/docs/img/api-configuration-profiles/api-configuration-profiles-6.png" alt="API Configuration dropdown in chat interface" width="550" />

### Pinning and Sorting Profiles

Expand Down
8 changes: 4 additions & 4 deletions apps/kilocode-docs/docs/features/browser-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ To change Browser / Computer Use settings in Kilo:

1. Open Settings by clicking the gear icon <Codicon name="gear" /> → Browser / Computer Use

<img src="/docs/img/browser-use/browser-use.png" alt="Browser settings menu" width="600" />
<img src="/docs/img/browser-use/browser-use.png" alt="Browser settings menu" width="600" />

### Enable/Disable Browser Use

Expand All @@ -90,7 +90,7 @@ To change this setting:

1. Check or uncheck the "Enable browser tool" checkbox within your Browser / Computer Use settings

<img src="/docs/img/browser-use/browser-use-2.png" alt="Enable browser tool setting" width="300" />
<img src="/docs/img/browser-use/browser-use-2.png" alt="Enable browser tool setting" width="300" />

### Viewport Size

Expand All @@ -108,7 +108,7 @@ To change this setting:
- Mobile (360x640)
3. Select your desired resolution.

<img src="/docs/img/browser-use/browser-use-3.png" alt="Viewport size setting" width="600" />
<img src="/docs/img/browser-use/browser-use-3.png" alt="Viewport size setting" width="600" />

### Screenshot Quality

Expand Down Expand Up @@ -146,7 +146,7 @@ To enable this feature:
1. Check the "Use remote browser connection" box in Browser / Computer Use settings
2. Click "Test Connection" to verify

<img src="/docs/img/browser-use/browser-use-5.png" alt="Remote browser connection setting" width="600" />
<img src="/docs/img/browser-use/browser-use-5.png" alt="Remote browser connection setting" width="600" />

#### Common Use Cases

Expand Down
4 changes: 2 additions & 2 deletions apps/kilocode-docs/docs/features/checkpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ 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

<img src="/docs/img/checkpoints/checkpoints.png" alt="Checkpoint settings in Kilo Code configuration" width="500" />
<img src="/docs/img/checkpoints/checkpoints.png" alt="Checkpoint settings in Kilo Code configuration" width="500" />

## How Checkpoints Work

Expand Down Expand Up @@ -60,7 +60,7 @@ To compare your current workspace with a previous checkpoint:
1. Locate the checkpoint in your chat history
2. Click the checkpoint's `View Differences` button

<img src="/docs/img/checkpoints/checkpoints-6.png" alt="View Differences button interface" width="100" />
<img src="/docs/img/checkpoints/checkpoints-6.png" alt="View Differences button interface" width="100" />

3. Review the differences in the comparison view:
- Added lines are highlighted in green
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
## 工作原理

git 提交信息生成器:

- 仅分析您的**暂存更改**(未暂存或未跟踪的文件)
- 使用 AI 理解更改的上下文和目的
- 创建描述性提交信息,解释更改了什么以及为什么,遵循[约定式提交](https://www.conventionalcommits.org/)规范(默认情况下,可自定义)
Expand All @@ -21,7 +22,6 @@ git 提交信息生成器:
2. 在 VS Code 源代码管理面板中,查找提交信息字段旁边的 `Kilo Code` 徽标
3. 单击徽标以生成提交信息


生成的信息将出现在提交信息字段中,您可以根据需要进行审查和修改。

<img src="/docs/img/git-commit-generation/git-commit-1.png" alt="生成的提交信息示例" width="600" />
Expand Down Expand Up @@ -59,6 +59,7 @@ git 提交信息生成器:
<img src="/docs/img/git-commit-generation/git-commit-2.png" alt="提交信息生成设置" width="600" />

默认模板创建约定式提交信息,但您可以修改它以:

- 使用不同的提交信息格式
- 包含与您的项目相关的特定信息
- 遵循您团队的提交信息规范
Expand All @@ -78,11 +79,13 @@ git 提交信息生成器:
## 最佳实践

### 暂存策略

- 将相关更改一起暂存,以获得更连贯的提交信息
- 避免在单个提交中暂存不相关的更改
- 需要时使用 `git add -p` 进行部分文件暂存

### 消息审查

- 始终在提交前审查生成的信息
- 编辑信息以添加 AI 可能遗漏的上下文
- 确保信息准确描述更改
Expand Down Expand Up @@ -133,7 +136,9 @@ git add .
```

### 信息质量差

如果生成的信息没有帮助:

- 审查您的暂存策略 - 不要将不相关的更改一起暂存
- 使用更具体的指令自定义提示模板
- 通过 API 配置尝试不同的 AI 模型
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: '编排模式'
sidebar_label: "编排模式"
---

import YouTubeEmbed from '@site/src/components/YouTubeEmbed';
Expand All @@ -15,10 +15,10 @@ import YouTubeEmbed from '@site/src/components/YouTubeEmbed';

## 为何使用编排模式?

- **处理复杂性**:将大型、多步骤项目(如构建完整功能)分解为专注的子任务(如设计、实现、文档)。
- **使用专业模式**:自动将子任务委派给最适合该工作的模式,利用其专业能力以获得最佳结果。
- **保持专注与效率**:每个子任务都在其独立的上下文中运行,具有单独的对话历史。这可以防止父任务(orchestrator)被详细的执行步骤(如代码差异或文件分析结果)所干扰,使其能够专注于高层次的工作流,并根据已完成子任务的简洁摘要高效管理整体流程。
- **简化工作流**:一个子任务的结果可以自动传递给下一个子任务,从而创建顺畅的工作流(例如,架构决策直接传递给编码任务)。
- **处理复杂性**:将大型、多步骤项目(如构建完整功能)分解为专注的子任务(如设计、实现、文档)。
- **使用专业模式**:自动将子任务委派给最适合该工作的模式,利用其专业能力以获得最佳结果。
- **保持专注与效率**:每个子任务都在其独立的上下文中运行,具有单独的对话历史。这可以防止父任务(orchestrator)被详细的执行步骤(如代码差异或文件分析结果)所干扰,使其能够专注于高层次的工作流,并根据已完成子任务的简洁摘要高效管理整体流程。
- **简化工作流**:一个子任务的结果可以自动传递给下一个子任务,从而创建顺畅的工作流(例如,架构决策直接传递给编码任务)。

## 工作原理

Expand All @@ -29,11 +29,11 @@ import YouTubeEmbed from '@site/src/components/YouTubeEmbed';

## 关键注意事项

- **需要批准**:默认情况下,每个子任务的创建和完成都需要你的批准。如果需要,可以通过 [Auto-Approving Actions](/features/auto-approving-actions#subtasks) 设置自动完成此操作。
- **上下文隔离与传递**:每个子任务都在完全隔离的上下文中运行,具有自己的对话历史。它不会自动继承父任务的上下文。信息必须显式传递:
* **向下**:在子任务创建时通过初始指令传递。
* **向上**:在子任务完成时通过最终摘要传递。注意,只有该摘要会返回给父任务。
- **任务切换**:Kilo 的界面帮助您查看任务的层次结构(哪个任务是父任务,哪些是子任务)。您通常可以在活动和暂停的任务之间切换。
- **需要批准**:默认情况下,每个子任务的创建和完成都需要你的批准。如果需要,可以通过 [Auto-Approving Actions](/features/auto-approving-actions#subtasks) 设置自动完成此操作。
- **上下文隔离与传递**:每个子任务都在完全隔离的上下文中运行,具有自己的对话历史。它不会自动继承父任务的上下文。信息必须显式传递:
- **向下**:在子任务创建时通过初始指令传递。
- **向上**:在子任务完成时通过最终摘要传递。注意,只有该摘要会返回给父任务。
- **任务切换**:Kilo 的界面帮助您查看任务的层次结构(哪个任务是父任务,哪些是子任务)。您通常可以在活动和暂停的任务之间切换。

编排模式提供了一种强大的方式来管理复杂的开发工作流,直接在 Kilo Code 中利用专业模式以实现最大效率。

Expand Down
Loading