Skip to content

Commit 07e10ae

Browse files
authored
Merge pull request #3716 from Kilo-Org/florian/feat/cloud-agent-docs
Kilo Code cloud agent initial docs
2 parents 016ca3e + e04f9f1 commit 07e10ae

2 files changed

Lines changed: 113 additions & 0 deletions

File tree

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: Cloud Agents
3+
sidebar_label: Cloud Agents
4+
---
5+
6+
# Cloud Agents
7+
8+
Cloud Agents let you run Kilo Code in the cloud from any device, without relying on your local machine. They provide a remote development environment that can read and modify your GitHub repositories, run commands, and auto-commit changes as work progresses.
9+
10+
---
11+
12+
## What Cloud Agents Enable
13+
14+
- Run Kilo Code remotely from a browser
15+
- Auto-create branches and push work continuously
16+
- Use env vars + startup commands to shape the workspace
17+
- Work from anywhere while keeping your repo in sync
18+
19+
---
20+
21+
## Prerequisites
22+
23+
Before using Cloud Agents:
24+
25+
- **GitHub Integration must be configured**
26+
Connect your account via the [Integrations tab](https://app.kilo.ai/integrations) so that Cloud Agents can access your repositories.
27+
28+
---
29+
30+
## Cost
31+
32+
- **Compute is free during limited beta**
33+
- Please provide any feedback in our Cloud Agents beta Discord channel:
34+
- [Kilo Discord](https://discord.gg/D2ExdEcq)
35+
- **Kilo Code credits are still used** when the agent performs work (model usage, operations, etc.).
36+
37+
---
38+
39+
## How to Use
40+
41+
1. **Connect your GitHub account** in the [Integrations](https://app.kilo.ai/integrations) tab of your personal or organization dashboard.
42+
2. **Select a repository** to use as your workspace.
43+
3. **Add environment variables** (secrets supported) and set optional startup commands.
44+
4. **Start chatting with Kilo Code.**
45+
46+
Your work is always pushed to GitHub, ensuring nothing is lost.
47+
48+
---
49+
50+
## How Cloud Agents Work
51+
52+
- Each user receives an **isolated Linux container** with common dev tools preinstalled (Python, Node.js, git, etc.).
53+
- All Cloud Agent chats share a **single container instance**, while each session gets its own workspace directory.
54+
- When a session begins:
55+
1. Your repo is cloned
56+
2. A unique branch is created
57+
3. Your startup commands run
58+
4. Env vars are injected
59+
60+
- After every message, the agent:
61+
- Looks for file changes
62+
- Commits them
63+
- Pushes to the session’s branch
64+
65+
- Containers are **ephemeral**:
66+
- Spindown occurs after inactivity
67+
- Expect slightly longer setup after idle periods
68+
- Inactive sessions are deleted after **7 days** during the beta
69+
70+
---
71+
72+
## Environment Variables & Startup Commands
73+
74+
You can customize each Cloud Agent session by defining:
75+
76+
### Environment Variables
77+
- Add key/value pairs or secrets
78+
- Injected into the container before the session starts
79+
- Useful for API keys or config flags
80+
81+
### Startup Commands
82+
- Commands run immediately after cloning the repo and checking out the session branch
83+
- Great for:
84+
- Installing dependencies
85+
- Bootstrapping tooling
86+
- Running setup scripts
87+
88+
---
89+
90+
## Perfect For
91+
92+
Cloud Agents are great for:
93+
94+
- **Remote debugging** using Kilo Code debug mode
95+
- **Exploration of unfamiliar codebases** without touching your local machine
96+
- **Architect-mode brainstorming** while on the go
97+
- **Automated refactors or tech debt cleanup** driven by Kilo Code
98+
- **Offloading CI-like tasks**, experiments, or batch updates
99+
100+
---
101+
102+
## Limitations and Guidance
103+
104+
- Each message can run for **up to 10 minutes**.
105+
Break large tasks into smaller steps; use a `plan.md` or `todo.md` file to keep scope clear.
106+
- **Context is not persistent across messages yet.**
107+
Kilo Code does not remember previous turns; persistent in-repo notes help keep it aligned.
108+
- **Auto/YOLO mode is always on.**
109+
The agent will modify code without prompting for confirmation.
110+
- **Saved sessions** in the sidebar are not yet shared between logins or restorable locally.
111+
- **MCP support is coming**, but **Docker-based MCP servers will *not* be supported**.
112+

apps/kilocode-docs/sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ const sidebars: SidebarsConfig = {
153153
},
154154
"features/auto-launch-configuration",
155155
"advanced-usage/auto-cleanup",
156+
"advanced-usage/cloud-agent",
156157
"advanced-usage/deploy",
157158
"features/experimental/experimental-features",
158159
],

0 commit comments

Comments
 (0)