diff --git a/README.md b/README.md index a8aa8b1e8..b87d3a910 100644 --- a/README.md +++ b/README.md @@ -1,88 +1 @@ -

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

- -# πŸš€ Kilo - -> 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 - -

- -

- -## 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 -npm install -g @kilocode/cli - -# Or run directly with npx -npx @kilocode/cli -``` - -Then run `kilo` in any project directory to start. - -### 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: - -```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. - -## Contributing - -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. - -## Code of Conduct - -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 - -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). - -### 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. +This repo has been moved to https://github.com/Kilo-Org/kilocode