diff --git a/README.md b/README.md index 31ef5436e1..a4d7b8c8f2 100644 --- a/README.md +++ b/README.md @@ -1,144 +1,165 @@ +

+ Kilo Code logo +

+ +

The open source coding agent for building with AI in VS Code, JetBrains, or the CLI.

+

VS Code Marketplace + npm X (Twitter) - Substack Blog + Blog Discord Reddit

-

- kilo-code-logo -

+Kilo-in-VS-Code-and-CLI -

- Kilo is the all-in-one agentic engineering platform.
- Build, ship, and iterate faster with the most popular open source coding agent. -

+--- -

- Kilo Code running inside VS Code -

+Kilo Code is an AI coding agent that meets you everywhere you work: [VS Code](https://kilo.ai/landing/vs-code), [JetBrains](https://kilo.ai/features/jetbrains-native), and the [CLI](https://kilo.ai/cli). It's open source with open pricing. You pick from 500+ models, switch between them mid-task, and pay the model provider's rate with zero markup. No API keys required to start. -

- Website · - Install · - IDE · - CLI · - Docs · - Models · - Gateway · - Pricing · - Kilo Pass -

+### Installation -

- 500+ models. One open source agent in VS Code, JetBrains, CLI, Slack, and Cloud. -

+Pick where you want to run Kilo. -- ✨ Generate code from natural language -- ✅ Checks its own work -- 🧪 Run terminal commands -- 🌐 Automate the browser -- ⚡ Inline autocomplete suggestions -- 🤖 Latest AI models -- 🎁 API keys optional +
+VS Code -## 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) +Install the [Kilo Code extension](vscode:extension/kilocode.kilo-code) directly, or grab it from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=kilocode.Kilo-Code). Create an account and you'll have access to 500+ models including GPT-5.5, Claude Opus 4.7, Claude Sonnet 4.6, and Gemini 3.1 Pro Preview, all at provider pricing. -## 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. +
+CLI -## 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 GPT-5.5, Claude Opus 4.7, Claude Sonnet 4.6, and Gemini 3.1 Pro Preview, 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 - -## Get Started with the CLI +
```bash # npm npm install -g @kilocode/cli -# Or run directly with npx -npx @kilocode/cli +# curl +curl -fsSL https://kilo.ai/cli/install | bash + +# pnpm +pnpm add -g @kilocode/cli + +# bun +bun add -g @kilocode/cli + +# Homebrew (macOS / Linux) +brew install Kilo-Org/tap/kilo + +# Arch Linux (AUR) +paru -S kilo-bin ``` Then run `kilo` in any project directory to start. - +
-### npm Install Note: Hidden `.kilo` File +
+JetBrains -On some systems and npm versions, installing `@kilocode/cli` can create a hidden `.kilo` file near the installed `kilo` command (for example in a global npm bin directory). This file is an npm-generated launcher helper, not project data. +
-- Why it exists: npm may create helper artifacts while wiring CLI executables. -- Size caveat: size can vary by platform, npm version, and install mode (symlink vs copied launcher), so a strict fixed size is not guaranteed. -- Safety: it is safe to leave in place. Do not edit it manually. Use your package manager's uninstall (`npm uninstall -g @kilocode/cli`) to remove install artifacts cleanly. - +Install the [Kilo Code plugin](https://plugins.jetbrains.com/plugin/28350-kilo-code) from the JetBrains Marketplace, or search "Kilo Code" in `Settings → Plugins` inside any JetBrains IDE. -### Install from GitHub Releases (Optional) +
-Download the latest binary or source code from the [Releases page](https://github.com/Kilo-Org/kilocode/releases), use this quick guide: +
+Cloud Agent -- `kilo--.zip` is the CLI binary for your OS and CPU architecture on Windows and macOS. (`kilo-linux-.tar.gz` for Linux) -- `darwin` means macOS. -- `x64` is standard 64-bit Intel/AMD CPUs. -- `x64-baseline` is a compatibility build for older x64 CPUs(do not support AVX Instruction). -- `arm64` is ARM-based Linux/MacOS. -- `musl` is statically linked Linux build for Alpine/minimal Docker without glibc. Alpine/minimal Docker users should prefer the matching \*-musl asset. -- `kilo-vscode-*.vsix` is the VS Code extension package and not the CLI binary. -- `Source code` releases are for building from source, not normal installation. +
-For most users: +Run Kilo from the web, no local machine needed, at [app.kilo.ai/cloud](https://app.kilo.ai/cloud). -- **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 on ARM:** `kilo-linux-arm64.tar.gz` +
+ +
+Code Reviews + +
+ +Set up automated AI code reviews on your pull requests at [app.kilo.ai/code-reviews](https://app.kilo.ai/code-reviews). + +
+ +
+KiloClaw + +
+ +Spin up your always-on AI agent at [app.kilo.ai/claw](https://app.kilo.ai/claw). + +
+ +
+Install the CLI from GitHub Releases (binaries) + +Download the latest binary from the [Releases page](https://github.com/Kilo-Org/kilocode/releases). + +| Platform | Asset | +| --- | --- | +| 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 ARM | `kilo-linux-arm64.tar.gz` | + +Notes: `x64-baseline` is a compatibility build for older CPUs without AVX. `musl` is the statically linked build for Alpine or minimal Docker images without glibc. `kilo-vscode-*.vsix` is the VS Code extension package, not the CLI. `Source code` archives are for building from source. + +
+ +### Agents + +Kilo ships with specialized agents you switch between depending on the task. You can also build your own custom agents. + +- **Code** - The default. Implements and edits code from natural language. +- **Plan** - Designs architecture and writes implementation plans before any code gets written. +- **Ask** - Answers questions about your codebase without touching any files. +- **Debug** - Troubleshoots and traces issues. +- **Review** - Reviews your changes and surfaces issues across performance, security, style, and test coverage. + +Learn more about [agents and custom agents](https://kilo.ai/docs/code-with-ai/agents/using-agents). + +### What it does + +- **Code generation** from natural language, across multiple files. +- **Inline autocomplete** with ghost-text suggestions and tab to accept. +- **Self-checking** so the agent reviews and corrects its own work. +- **Terminal and browser control** to run commands and automate the web. +- **MCP marketplace** to find and wire up MCP servers that extend what the agent can do. +- **500+ models** with mid-task switching, so you can match latency, cost, and reasoning to the job. ### 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: +Run `kilo run` with `--auto` for fully autonomous operation with no prompts, built for CI/CD pipelines: ```bash 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. +`--auto` disables all permission prompts and lets the agent execute any action without confirmation. Only use it in trusted environments. -## Contributing +### Documentation -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. +For configuration and everything else, [head over to the docs](https://kilo.ai/docs). -See [RELEASING.md](RELEASING.md) for the VS Code extension and CLI release process. +### Contributing -See [packages/kilo-jetbrains/RELEASING.md](packages/kilo-jetbrains/RELEASING.md) for the JetBrains plugin release process. +Contributions are welcome from developers, writers, and everyone in between. Start with the [Contributing Guide](/CONTRIBUTING.md) for environment setup, coding standards, and how to open a pull request. See [RELEASING.md](RELEASING.md) for the VS Code extension and CLI release process, and [packages/kilo-jetbrains/RELEASING.md](packages/kilo-jetbrains/RELEASING.md) for the JetBrains plugin. -## Code of Conduct +Please review our [Code of Conduct](/CODE_OF_CONDUCT.md) before getting involved. -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. +### License -## License +MIT. You're free to use, modify, and distribute this code, including commercially, as long as you keep the attribution and license notices. See [License](/LICENSE). -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). - -## FAQ +### FAQ
Where did Kilo CLI come from? @@ -146,3 +167,7 @@ You’re free to use, modify, and distribute this code, including for commercial Kilo CLI is a fork of [OpenCode](https://github.com/anomalyco/opencode), enhanced to work within the Kilo agentic engineering platform.
+ +--- + +**Join the community** [Discord](https://kilo.ai/discord) | [X](https://x.com/kilocode) | [Reddit](https://www.reddit.com/r/kilocode/)