From 782c66b284900fdbfd6d7fb0b4392f82cb1def94 Mon Sep 17 00:00:00 2001 From: Marius Wichtner Date: Wed, 28 Jan 2026 12:40:01 +0100 Subject: [PATCH] docs: update README for Kilo CLI release - Restructure README to match OpenCode style - Document built-in agents (build, plan, general) - Add migration guide for Kilo Code extension users - Link to migration documentation - Remove unverified claims and broken links - Fix typo: designeed -> enhanced --- README.md | 81 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 61 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 9c943a5748..1c68b84c5e 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,76 @@

- X (Twitter) - Substack Blog - Discord - Reddit + + + + + Kilo logo + + +

+

The open source AI coding agent.

+

+ Discord + X + Reddit

-# 🧑‍💻 Kilo CLI +--- -> Kilo is the all-in-one agentic engineering platform. Build, ship, and iterate faster with the most popular open source coding agent. -> #1 on OpenRouter. 1M+ Kilo Coders. 20T+ tokens processed - -## Installation +### Installation ```bash -# Coming soon! +npm i -g @kilocode/cli # or bun/pnpm/yarn ``` -## Key Features +### Agents -- **Code Generation:** Kilo can generate code using natural language. -- **Task Automation:** Kilo can automate repetitive coding tasks. -- **Automated Refactoring:** Kilo can refactor and improve existing code. -- **MCP Server Marketplace**: Kilo can easily find, and use MCP servers to extend the agent capabilities. -- **Multi Mode**: Plan with Architect, Code with Coder, and Debug with Debugger, and make your own custom modes. +Kilo CLI includes two built-in agents you can switch between using the `Tab` key: -## Contributing +- **build** - Default, full access agent for development work +- **plan** - Read-only agent for analysis and code exploration + - Denies file edits by default + - Asks permission before running bash commands + - Ideal for exploring unfamiliar codebases or planning changes -Contributions are welcome, and they are greatly appreciated! Get started by reading our [Contributing Guide](CONTRIBUTING.md). Or join our [Discord](https://discord.gg/kilocode) to chat with the team and community. +Also included is a **general** subagent for complex searches and multi-step tasks. +This is used internally and can be invoked using `@general` in messages. -## FAQ +### Migrating from Kilo Code Extension + +If you're coming from the Kilo Code VS Code extension, your configurations are automatically migrated: + +| Kilo Code Feature | Kilo CLI Equivalent | +| -------------------------------------------- | -------------------------------------------- | +| Custom modes | Converted to agents | +| Rules (`.kilocoderules`, `.kilocode/rules/`) | Added to `instructions` array | +| Skills (`.kilocode/skills/`) | Auto-discovered alongside `.opencode/skill/` | +| Workflows (`.kilocode/workflows/`) | Converted to commands | +| MCP servers | Migrated to `mcp` config | + +**Default mode mappings:** + +- `code` → `build` agent +- `architect` → `plan` agent + +For detailed migration information, see: + +- [Migration Overview](packages/opencode/src/kilocode/docs/migration.md) +- [Rules Migration](packages/opencode/src/kilocode/docs/rules-migration.md) + +### Documentation + +For more info on how to configure Kilo CLI, [**head over to our docs**](https://kilo.ai/docs). + +### Contributing + +If you're interested in contributing, please read our [contributing docs](./CONTRIBUTING.md) before submitting a pull request. + +### FAQ #### Where did Kilo CLI come from? -Kilo CLI is a fork of [OpenCode](https://github.com/anomalyco/opencode) designeed to work within the Kilo all-in-one agentic engineering platform. +Kilo CLI is a fork of [OpenCode](https://github.com/anomalyco/opencode), enhanced to work within the Kilo agentic engineering platform. + +--- + +**Join our community** [Discord](https://kilo.ai/discord) | [X.com](https://x.com/kilocode) | [Reddit](https://reddit.com/r/kilocode)