diff --git a/packages/kilo-docs/lib/nav/getting-started.ts b/packages/kilo-docs/lib/nav/getting-started.ts index 1cb858a9b58..41aebfc156e 100644 --- a/packages/kilo-docs/lib/nav/getting-started.ts +++ b/packages/kilo-docs/lib/nav/getting-started.ts @@ -41,7 +41,17 @@ export const GettingStartedNav: NavSection[] = [ { title: "Help", links: [ - { href: "/getting-started/faq", children: "FAQ" }, + { + href: "/getting-started/faq", + children: "FAQ", + subLinks: [ + { href: "/getting-started/faq/general", children: "General" }, + { href: "/getting-started/faq/setup-and-installation", children: "Setup and Installation" }, + { href: "/getting-started/faq/credits-and-billing", children: "Credits and Billing" }, + { href: "/getting-started/faq/account-and-integration", children: "Account and Integration" }, + { href: "/getting-started/faq/known-issues", children: "Known Issues" }, + ], + }, { href: "/getting-started/migrating", children: "Migrating from Cursor", diff --git a/packages/kilo-docs/pages/getting-started/faq.md b/packages/kilo-docs/pages/getting-started/faq.md deleted file mode 100644 index 63dcc77f8bd..00000000000 --- a/packages/kilo-docs/pages/getting-started/faq.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -title: "Frequently Asked Questions" -description: "Find answers to common questions about Kilo Code" ---- - -# Frequently Asked Questions - -This page answers some common questions about Kilo Code. - -## General - -### What is Kilo Code? - -Kilo Code is an open-source AI agent extension for Visual Studio Code. It helps you write code more efficiently by generating code, automating tasks, and providing suggestions. - -### How does Kilo Code work? - -Kilo Code uses large language models (LLMs) to understand your requests and translate them into actions. It can: - -- Read, write, and delete files in your project. -- Execute commands in your VS Code terminal. -- Perform web browsing (if enabled). -- Use external tools via the Model Context Protocol (MCP). - -You interact with Kilo Code through a chat interface, where you provide instructions and review/approve its proposed actions, or you can use the inline autocomplete feature which helps you as you type. - -### What can Kilo Code do? - -Kilo Code can help with a variety of coding tasks, including: - -- Generating code from natural language descriptions. -- Refactoring existing code. -- Fixing bugs. -- Writing documentation. -- Explaining code. -- Answering questions about your codebase. -- Automating repetitive tasks. -- Creating new files and projects. - -### Is Kilo Code free to use? - -The Kilo Code extension itself is free and open-source. In order for Kilo Code to be useful, you need an AI model to respond to your queries. Models are hosted by providers and most charge for access. - -There are some models available for free. The set of free models if constantly changing based on provider pricing decisions. - -You can also use Kilo Code with a [local model](/docs/automate/extending/local-models) or "Bring Your Own API Key" for [another model provider](/docs/getting-started/setup-authentication) (like [Anthropic](/docs/ai-providers/anthropic), [OpenAI](/docs/ai-providers/openai), [OpenRouter](/docs/ai-providers/openrouter), [Requesty](/docs/ai-providers/requesty), etc.). - -### How do I pay for model usage via Kilo Code? - -If you choose to pay for models via Kilo Code, you do so by buying Kilo Credits. You can [buy Kilo Credits](/docs/getting-started/adding-credits) securely via Stripe with a credit card. We do not charge a markup on Kilo Credits. $1 you give us is $1 in Kilo Credits. - -Model usage is metered by the providers in terms of different kinds of tokens. When you use a model, we debit your Kilo credits by the amount the provider charges us -- with no markup. - -You can use any models you like as long as you have credits in your account. When you run out of credits, you can add more. It's that simple! - -If you're looking to earn some credits, you could join our [Discord](https://kilo.ai/discord) where we sometimes have promotional offers! - -### What are the risks of using Kilo Code? - -Kilo Code is a powerful tool, and it's important to use it responsibly. Here are some things to keep in mind: - -- **Kilo Code can make mistakes.** Always review Kilo Code's proposed changes carefully before approving them. -- **Kilo Code can execute commands.** Be very cautious about allowing Kilo Code to run commands, especially if you're using auto-approval. -- **Kilo Code can access the internet.** If you're using a provider that supports web browsing, be aware that Kilo Code could potentially access sensitive information. - -## Setup & Installation - -### How do I install Kilo Code? - -See the [Installation Guide](/docs/getting-started/installing) for detailed instructions. - -### Which API providers are supported? - -Kilo Code supports a wide range of API providers, including: - -- [Anthropic (Claude)](/docs/ai-providers/kilocode) -- [Anthropic (Claude)](/docs/ai-providers/anthropic) -- [OpenAI](/docs/ai-providers/openai) -- [OpenRouter](/docs/ai-providers/openrouter) -- [Google Gemini](/docs/ai-providers/gemini) -- [Glama](/docs/ai-providers/glama) -- [AWS Bedrock](/docs/ai-providers/bedrock) -- [GCP Vertex AI](/docs/ai-providers/vertex) -- [Ollama](/docs/ai-providers/ollama) -- [LM Studio](/docs/ai-providers/lmstudio) -- [DeepSeek](/docs/ai-providers/deepseek) -- [Mistral](/docs/ai-providers/mistral) -- [Unbound](/docs/ai-providers/unbound) -- [Requesty](/docs/ai-providers/requesty) -- [VS Code Language Model API](/docs/ai-providers/vscode-lm) - -### How do I get an API key? - -Each API provider has its own process for obtaining an API key. See the [Setting Up Your First AI Provider](/docs/getting-started/setup-authentication) for links to the relevant documentation for each provider. - -### Can I use Kilo Code with local models? - -Yes, Kilo Code supports running models locally using [Ollama](/docs/providers/ollama) and [LM Studio](/docs/providers/lmstudio). See [Using Local Models](/docs/advanced-usage/local-models) for instructions. - -## Usage - -### How do I start a new task? - -Open the Kilo Code panel ({% kiloCodeIcon size="1em" /%}) and type your task in the chat box. Be clear and specific about what you want Kilo Code to do. See [The Chat Interface](/docs/basic-usage/the-chat-interface) for best practices. - -### When should I use chat vs autocomplete? - -Use **chat** when you need to: - -- Make complex, multi-file changes -- Refactor code across your project -- Get explanations or ask questions -- Have Kilo Code execute commands or browse the web -- Work on tasks that require planning and multiple steps - -Use **autocomplete** when you need to: - -- Complete the current line or block of code quickly -- Get suggestions for common patterns and boilerplate -- Make quick, localized edits without context switching -- Speed up typing repetitive code - -In general, autocomplete is best for quick, in-flow coding assistance, while chat is better for larger tasks that require more context and interaction. - -### What are modes in Kilo Code? - -[Modes](/docs/code-with-ai/agents/using-modes) are different personas that Kilo Code can adopt, each with a specific focus and set of capabilities. The built-in modes are: - -- **Code:** For general-purpose coding tasks. -- **Architect:** For planning and technical leadership. -- **Ask:** For answering questions and providing information. -- **Debug:** For systematic problem diagnosis. - You can also create [Custom Modes](/docs/customize/custom-modes). - -### How do I switch between modes? - -Use the dropdown menu in the chat input area to select a different mode, or use the `/` command to switch to a specific mode. - -### What are tools and how do I use them? - -[Tools](/docs/basic-usage/how-tools-work) are how Kilo Code interacts with your system. Kilo Code automatically selects and uses the appropriate tools to complete your tasks. You don't need to call tools directly. You will be prompted to approve or reject each tool use. - -### What are context mentions? - -[Context mentions](/docs/basic-usage/context-mentions) are a way to provide Kilo Code with specific information about your project, such as files, folders, or problems. Use the "@" symbol followed by the item you want to mention (e.g., `@/src/file.ts`, `@problems`). - -### Can Kilo Code access the internet? - -Yes, if you are using a provider with a model that support web browsing. Be mindful of the security implications of allowing this. - -### Can Kilo Code run commands in my terminal? - -Yes, Kilo Code can execute commands in your VS Code terminal. You will be prompted to approve each command before it's executed, unless you've enabled auto-approval for commands. Be extremely cautious about auto-approving commands. If you're experiencing issues with terminal commands, see the [Shell Integration Guide](/docs/features/shell-integration) for troubleshooting. - -### How do I provide feedback to Kilo Code? - -You can provide feedback by approving or rejecting Kilo Code's proposed actions. You can provide additional feedback by using the feedback field. - -### Can I customize Kilo Code's behavior? - -Yes, you can customize Kilo Code in several ways: - -- **Custom Instructions:** Provide general instructions that apply to all modes, or mode-specific instructions. -- **Custom Modes:** Create your own modes with tailored prompts and tool permissions. -- **`.clinerules` Files:** Create `.clinerules` files in your project to provide additional guidelines. -- **Settings:** Adjust various settings, such as auto-approval, diff editing, and more. - -### Does Kilo Code have any auto approval settings? - -Yes, Kilo Code has a few settings that when enabled will automatically approve actions. Find out more [here](/docs/features/auto-approving-actions). - -## Advanced Features - -### Can I use Kilo Code offline? - -Yes, if you use a [local model](/docs/advanced-usage/local-models). - -### What is MCP (Model Context Protocol)? - -[MCP](/docs/automate/mcp/overview) is a protocol that allows Kilo Code to communicate with external servers, extending its capabilities with custom tools and resources. - -### Can I create my own MCP servers? - -Yes, you can create your own MCP servers to add custom functionality to Kilo Code. See the [MCP documentation](https://github.com/modelcontextprotocol) for details. -Yes, you can create your own MCP servers to add custom functionality to Kilo Code. See the [MCP documentation](https://github.com/modelcontextprotocol) for details. - -## Known Limitations - -### Multi-Folder Workspaces ("Add Folder to Workspace") - -Using VS Code's "Add Folder to Workspace" feature to add additional folders is not supported by the Kilo Code VS Code extension. - -**What this means:** - -- If you use "File > Add Folder to Workspace..." to add additional folders to your VS Code workspace, Kilo Code will **not** recognize these additional folders as part of the workspace. -- Any folders added this way will be treated as directories **outside** of the workspace from Kilo Code's perspective. -- Kilo Code only operates within the first root-level folder in the workspace (the first folder opened or the root of a single-folder workspace). - -**Workarounds:** - -- Open the workspace in a parent folder which includes all of your desired folders, if possible. Note that this will also give the agent access to any other folders within that parent folder. -- Use context mentions (e.g., `@/path/to/file`) to reference files within the primary workspace folder. Read actions outside of the first folder may ask permission depending on your auto-approve settings. It is not currently possible to add individual folders to the auto-approve for reading outside of the workspace. - -## Troubleshooting - -### Kilo Code isn't responding. What should I do? - -- Make sure your API key is correct and hasn't expired. -- Check your internet connection. -- Check the status of your chosen API provider. -- Try restarting VS Code. -- If the problem persists, report the issue on [GitHub](https://github.com/Kilo-Org/kilocode/issues) or [Discord](https://kilo.ai/discord). - -### I'm seeing an error message. What does it mean? - -The error message should provide some information about the problem. If you're unsure how to resolve it, seek help in the community forums. - -### Kilo Code made changes I didn't want. How do I undo them? - -Kilo Code uses VS Code's built-in file editing capabilities. You can use the standard "Undo" command (Ctrl/Cmd + Z) to revert changes. Also, if experimental checkpoints are enabled, Kilo can revert changes made to a file. - -### How do I report a bug or suggest a feature? - -Please report bugs or suggest features on the Kilo Code [Issues page](https://github.com/Kilo-Org/kilocode/issues) and [Feature Requests page](https://github.com/Kilo-Org/kilocode/discussions/categories/ideas). diff --git a/packages/kilo-docs/pages/getting-started/faq/account-and-integration.md b/packages/kilo-docs/pages/getting-started/faq/account-and-integration.md new file mode 100644 index 00000000000..72c25d8dd37 --- /dev/null +++ b/packages/kilo-docs/pages/getting-started/faq/account-and-integration.md @@ -0,0 +1,44 @@ +--- +title: "Account and Integration" +description: "Questions about accounts and integrations in Kilo Code" +tocDepth: 2 +--- + +# Account and Integration + +This section contains questions about accounts and integrations in Kilo Code. + +## Account + +### What happens when the trial ends? + +When the trial expires: + +Your organization will become inaccessible. +No charges will be applied. +If you have any remaining credits in your organization, you can contact Support to request that they be moved to your personal account. + +## Integrations + +### How do I unlink my GitHub account? + +#### Context + +You may need to unlink your GitHub account. + +This process involves removing the **Kilo Connect** application from your GitHub account settings. + +#### Answer + +To unlink your GitHub account, follow these steps: + +1. Go to your GitHub account and navigate to **Settings → Applications → Installed GitHub Apps** or visit [https://github.com/settings/installations](https://github.com/settings/installations) +2. Find **Kilo Connect** in the list of installed applications +3. Click **Configure** next to Kilo Connect +4. From the configuration page, you can either: + - **Uninstall** the integration completely, or + - **Edit** which repositories are connected + +{% callout type="tip" %} +If you'd like to reconnect GitHub later, simply open your Kilo Code profile, go to **Integrations**, and connect GitHub again. +{% /callout %} diff --git a/packages/kilo-docs/pages/getting-started/faq/credits-and-billing.md b/packages/kilo-docs/pages/getting-started/faq/credits-and-billing.md new file mode 100644 index 00000000000..b2c7f377245 --- /dev/null +++ b/packages/kilo-docs/pages/getting-started/faq/credits-and-billing.md @@ -0,0 +1,74 @@ +--- +title: "Credits and Billing" +description: "Questions about credits, billing, and pricing in Kilo Code" +tocDepth: 2 +--- + +# Credits and Billing + +This section contains questions about credits, billing, and pricing in Kilo Code. + +## Credits + +### Why am I seeing requests for "Codestral 2508"? + +Kilo Code uses Codestral 2508 (a model by Mistral AI) as the dedicated engine for our Autocomplete feature. It is optimized for speed and low latency, making it perfect for real-time code suggestions. + +#### Why is it running in the background? + +Because Autocomplete needs to be ready the moment you start typing, the model stays active in the background whenever the feature is enabled. This occurs even if you aren't currently using the Kilo Chat. + +#### How much does it cost? + +You can use Codestral 2508 for Autocomplete completely for free by configuring it through our Mistral integration. + +**Setup Guide:** [Setting up Mistral for Free Autocomplete](/docs/code-with-ai/features/autocomplete/mistral-setup#setting-up-mistral-for-free-autocomplete) + +#### How to Disable These Requests + +If you prefer not to have background requests running, you can turn off the feature entirely: + +1. Open your **Kilo Settings**. +2. Navigate to the **Autocomplete** tab. +3. Toggle the feature to **Off**. + +{% callout type="note" %} +Disabling this will stop all ghost-text suggestions in your editor. +{% /callout %} + +### Why do I have credits, but Kilo shows a low balance or warning? + +Kilo credits are not shared between Personal and Organization environments. + +If you have credits in one environment but are currently using the other, Kilo may show a low balance or usage warning. + +#### How to fix it + +**In the IDE** + +Use the environment selector dropdown to switch to the account that holds your credits (Personal or the specific Organization). + +{% image src="/docs/img/faq/credits-environment-selector.png" alt="Environment selector dropdown showing Personal and Organization environments" caption="Use the environment selector to switch between Personal and Organization accounts" /%} + +**In the CLI** + +Run: + +``` +/teams +``` + +Then choose the environment you want to use. + +#### Why this happens + +Each environment maintains its own balance and usage tracking to ensure clear billing and access control. Switching environments ensures Kilo is using the correct credit pool. + +## Billing + +### How do I add a VAT number to my invoices? + +You can add your VAT number during the credit purchase process. + +In the credit purchase window, enable the option “I’m purchasing as a business.” +Once enabled, a field will appear to enter your VAT number. diff --git a/packages/kilo-docs/pages/getting-started/faq/general.md b/packages/kilo-docs/pages/getting-started/faq/general.md new file mode 100644 index 00000000000..d020ad6f9f4 --- /dev/null +++ b/packages/kilo-docs/pages/getting-started/faq/general.md @@ -0,0 +1,27 @@ +--- +title: "General" +description: "General questions about Kilo Code" +--- + +# General + +This section contains general questions about Kilo Code. + +## How does Kilo Code work? + +Kilo Code uses large language models (LLMs) to understand your requests and translate them into actions. It can: + +- Read, write, and delete files in your project. +- Execute commands in your VS Code terminal. +- Perform web browsing (if enabled). +- Use external tools via the Model Context Protocol (MCP). + +You interact with Kilo Code through a chat interface, where you provide instructions and review/approve its proposed actions, or you can use the inline autocomplete feature which helps you as you type. + +## Is Kilo Code free to use? + +The Kilo Code extension itself is free and open-source. In order for Kilo Code to be useful, you need an AI model to respond to your queries. Models are hosted by providers and most charge for access. + +There are some [models](https://kilo.ai/leaderboard#all-models) available for free. The set of free models is constantly changing based on provider pricing decisions. + +You can also use Kilo Code with a [local model](/docs/automate/extending/local-models) or ["Bring Your Own API Key"](/docs/getting-started/byok). diff --git a/packages/kilo-docs/pages/getting-started/faq/index.md b/packages/kilo-docs/pages/getting-started/faq/index.md new file mode 100644 index 00000000000..8930d4fa195 --- /dev/null +++ b/packages/kilo-docs/pages/getting-started/faq/index.md @@ -0,0 +1,28 @@ +--- +title: "FAQ" +description: "Frequently Asked Questions about Kilo Code" +--- + +# FAQ + +This section contains the most frequently asked questions. + +## General + +- [**General**](/docs/getting-started/faq/general) - General questions about Kilo Code + +## Setup and Installation + +- [**Setup and Installation**](/docs/getting-started/faq/setup-and-installation) - Questions about setting up and installing Kilo Code + +## Credits and Billing + +- [**Credits and Billing**](/docs/getting-started/faq/credits-and-billing) - Questions about credits, billing, and pricing + +## Account and Integration + +- [**Account and Integration**](/docs/getting-started/faq/account-and-integration) - Questions about accounts and integrations + +## Known Issues + +- [**Known Issues**](/docs/getting-started/faq/known-issues) - Known issues and limitations of Kilo Code diff --git a/packages/kilo-docs/pages/getting-started/faq/known-issues.md b/packages/kilo-docs/pages/getting-started/faq/known-issues.md new file mode 100644 index 00000000000..04c8b25ffb5 --- /dev/null +++ b/packages/kilo-docs/pages/getting-started/faq/known-issues.md @@ -0,0 +1,93 @@ +--- +title: "Known Issues" +description: "Known issues and limitations of Kilo Code" +tocDepth: 2 +--- + +# Known Issues + +This section contains known issues and limitations of Kilo Code. + +## VSCode + +### Workflows get stuck on "API Request…" and never start + +#### Symptoms + +- Workflow shows "API Request…" and keeps spinning +- Usage meter stays at 0 tokens +- Canceling shows "Task file not found for task ID" +- VS Code becomes unresponsive until restart + +#### Cause + +In some cases, this behavior can be caused by a conflict with other VS Code extensions that interact with files or workspace scanning. + +A reported example was the **Todo Tree** extension, which interfered with workflow execution. Disabling the extension resolved the issue immediately. + +#### Workarounds + +1. Temporarily disable recently installed VS Code extensions +2. Retry the workflow +3. Re-enable extensions one by one to identify conflicts + +#### Recommendation + +If you encounter similar behavior: + +- Test with extensions disabled +- [Share logs](/docs/getting-started/troubleshooting/troubleshooting-extension) with support if the issue persists + +We are working on documenting known extension conflicts to improve troubleshooting guidance. + +### Why am I seeing a "PowerShell not recognized" error on Windows? + +You may see an error like this: + +``` +Command failed with exit code 1: powershell (Get-CimInstance -ClassName Win32_OperatingSystem).caption +'powershell' is not recognized as an internal or external command, +operable program or batch file. +``` + +This error occurs when Windows cannot find the PowerShell executable. Most commonly, this happens because the `PATH` environment variable does not include the directory where PowerShell is installed. + +#### How do I fix this? + +**Add PowerShell to your PATH:** + +1. Press `Windows + X` (or right-click the Start button) and select **System** +2. Click **Advanced system settings** +3. Select **Environment Variables** +4. Under **System variables** (or User variables), find **Path** and click **Edit** +5. Click **New** and add: + ``` + %SYSTEMROOT%\System32\WindowsPowerShell\v1.0\ + ``` +6. Click **OK** to save your changes +7. Restart your computer + +#### Do I need to restart? + +Yes. A restart is required for Windows to apply the updated `PATH` variable. + +#### Why does this error appear in remote or container environments? + +This error can also appear if a Windows-specific PowerShell command is executed in: + +- Remote SSH sessions +- Containers +- WSL +- macOS or Linux environments + +In these cases, PowerShell may not be available, and the command must be replaced with an OS-appropriate alternative. + +#### Still having issues? + +Verify that PowerShell is installed and accessible by running: + +``` +where powershell +``` + +If PowerShell is missing or blocked, system policies or security tools may need to be reviewed. diff --git a/packages/kilo-docs/pages/getting-started/faq/setup-and-installation.md b/packages/kilo-docs/pages/getting-started/faq/setup-and-installation.md new file mode 100644 index 00000000000..0be2bf9b643 --- /dev/null +++ b/packages/kilo-docs/pages/getting-started/faq/setup-and-installation.md @@ -0,0 +1,12 @@ +--- +title: "Setup and Installation" +description: "Frequently asked questions about setting up and installing Kilo Code" +--- + +# Setup and Installation + +Frequently asked questions about setting up and installing Kilo Code. + +{% callout type="tip" %} +This section is being expanded. If you have a question that isn't answered here, please reach out on [Discord](https://kilo.ai/discord) or check the [Troubleshooting guide](/docs/getting-started/troubleshooting). +{% /callout %} diff --git a/packages/kilo-docs/pages/getting-started/using-kilo-for-free.md b/packages/kilo-docs/pages/getting-started/using-kilo-for-free.md index cf1b8916d09..1f9d48f714f 100644 --- a/packages/kilo-docs/pages/getting-started/using-kilo-for-free.md +++ b/packages/kilo-docs/pages/getting-started/using-kilo-for-free.md @@ -86,7 +86,7 @@ Background tasks degrade gracefully when you don't have credits: ### How to Get It Free -Configure the `small_model` parameter in `~/.kilocode/config.json` to use a free model: +Configure the `small_model` parameter in `~/.config/kilo/config.json` to use a free model: ```json { diff --git a/packages/kilo-docs/public/img/faq/credits-environment-selector.png b/packages/kilo-docs/public/img/faq/credits-environment-selector.png new file mode 100644 index 00000000000..3de0a63c924 Binary files /dev/null and b/packages/kilo-docs/public/img/faq/credits-environment-selector.png differ