Update README with Kilo Code content and demo gif

2026-02-19 17:03:52 +01:00
parent 80482b1834
commit 06155f8a29
2 changed files with 55 additions and 57 deletions
@@ -1,18 +1,53 @@
 <p align="center">
-  <a href="https://kilo.ai">
-    <img src="logo.png" alt="Kilo CLI logo">
-  </a>
-</p>
-<p align="center">The open source AI coding agent.</p>
-<p align="center">
-  <a href="https://kilo.ai/discord"><img alt="Discord" src="https://img.shields.io/discord/1391832426048651334?style=flat-square&label=discord" /></a>
-  <a href="https://x.com/kilocode"><img alt="X" src="https://img.shields.io/badge/X-@kilocode-000000?style=flat-square&logo=x&logoColor=white" /></a>
-  <a href="https://www.reddit.com/r/kilocode/"><img alt="Reddit" src="https://img.shields.io/badge/Reddit-r%2Fkilocode-FF4500?style=flat-square&logo=reddit&logoColor=white" /></a>
+  <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>
 </p>

---
+# 🚀 Kilo

-### Installation
+> 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. 1.5M+ Kilo Coders. 25T+ tokens processed
+
+- ✨ Generate code from natural language
+- ✅ Checks its own work
+- 🧪 Run terminal commands
+- 🌐 Automate the browser
+- ⚡ Inline autocomplete suggestions
+- 🤖 Latest AI models
+- 🎁 API keys optional
+- 💡 **Get $20 in bonus credits when you top-up for the first time** Credits can be used with 500+ models like Gemini 3 Pro, Claude 4.5 Sonnet & Opus, and GPT-5
+
+<p align="center">
+  <img src="https://media.githubusercontent.com/media/Kilo-Org/kilocode/main/kilo.gif" width="100%" />
+</p>
+
+## Quick Links
+
+- [VS Code Marketplace](https://kilo.ai/vscode-marketplace?utm_source=Readme) (download)
+- Install CLI: `npm install -g @kilocode/cli`
+- [Official Kilo.ai Home page](https://kilo.ai) (learn more)
+
+## Key Features
+
+- **Code Generation:** Kilo can generate code using natural language.
+- **Inline Autocomplete:** Get intelligent code completions as you type, powered by AI.
+- **Task Automation:** Kilo can automate repetitive coding tasks to save time..
+- **Automated Refactoring:** Kilo can refactor and improve existing code efficiently.
+- **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.
+
+## Get Started in Visual Studio Code
+
+1. Install the Kilo Code extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=kilocode.Kilo-Code).
+2. Create your account to access 500+ cutting-edge AI models including Gemini 3 Pro, Claude 4.5 Sonnet & Opus, and GPT-5 – with transparent pricing that matches provider rates exactly.
+3. Start coding with AI that adapts to your workflow. Watch our quick-start guide to see Kilo in action:
+
+[![Watch the video](https://img.youtube.com/vi/pqGfYXgrhig/maxresdefault.jpg)](https://youtu.be/pqGfYXgrhig)
+
+## Get Started with the CLI

 ```bash
 # npm
@@ -24,19 +59,6 @@ npx @kilocode/cli

 Then run `kilo` in any project directory to start.

-### Agents
-
-Kilo CLI includes two built-in agents you can switch between using the `Tab` key:
-
- **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
-
-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.
-
 ### Autonomous Mode (CI/CD)

 Use the `--auto` flag with `kilo run` to enable fully autonomous operation without user interaction. This is ideal for CI/CD pipelines and automated workflows:
@@ -47,44 +69,20 @@ kilo run --auto "run tests and fix any failures"

 **Important:** The `--auto` flag disables all permission prompts and allows the agent to execute any action without confirmation. Only use this in trusted environments like CI/CD pipelines.

-### Migrating from Kilo Code Extension
+## Contributing

-If you're coming from the Kilo Code VS Code extension, your configurations are automatically migrated:
+We welcome contributions from developers, writers, and enthusiasts!
+To get started, please read our [Contributing Guide](/CONTRIBUTING.md). It includes details on setting up your environment, coding standards, types of contribution and how to submit pull requests.

-| 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                     |
+## Code of Conduct

-MCP servers are configured in **`~/.config/kilo/opencode.json`** (or `opencode.jsonc`; on Windows the config directory may be under `%USERPROFILE%` depending on your environment). Use a top-level `"mcp"` object: each key is a server name, value is `type: "local"` and `command: ["executable", "arg1", ...]`. Optional per-server: `environment`, `enabled`, `timeout`. Restart the CLI after editing for changes to take effect. (Path from [`packages/opencode/src/global/index.ts`](packages/opencode/src/global/index.ts); schema in [`config.ts`](packages/opencode/src/config/config.ts) `McpLocal`.)
+Our community is built on respect, inclusivity, and collaboration. Please review our [Code of Conduct](/CODE_OF_CONDUCT.md) to understand the expectations for all contributors and community members.

-**Default mode mappings:**
+## License

- `code` → `build` agent
- `architect` → `plan` agent
+This project is licensed under the MIT License.
+You’re free to use, modify, and distribute this code, including for commercial purposes as long as you include proper attribution and license notices. See [License](/LICENSE).

-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?
+### Where did Kilo CLI come from?

 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)