mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-24 16:02:55 +08:00
Merge pull request #10165 from Kilo-Org/brian/addBotDocs
This commit is contained in:
Brian Turcotte
@@ -19,9 +19,17 @@ export const CodeWithAiNav: NavSection[] = [
|
||||
children: "CLI",
|
||||
subLinks: [{ href: "/code-with-ai/platforms/cli-reference", children: "Command Reference" }],
|
||||
},
|
||||
{
|
||||
href: "/code-with-ai/platforms/kilo-connect",
|
||||
children: "Kilo Connect",
|
||||
subLinks: [
|
||||
{ href: "/code-with-ai/platforms/slack", children: "Slack" },
|
||||
{ href: "/code-with-ai/platforms/github", children: "GitHub" },
|
||||
{ href: "/code-with-ai/platforms/linear", children: "Linear" },
|
||||
],
|
||||
},
|
||||
{ href: "/code-with-ai/platforms/cloud-agent", children: "Cloud Agent" },
|
||||
{ href: "/code-with-ai/platforms/mobile", children: "Mobile Apps" },
|
||||
{ href: "/code-with-ai/platforms/slack", children: "Slack" },
|
||||
{ href: "/code-with-ai/app-builder", children: "App Builder" },
|
||||
{
|
||||
href: "/code-with-ai/gastown",
|
||||
|
||||
@@ -0,0 +1,127 @@
|
||||
---
|
||||
title: "GitHub"
|
||||
description: "Using Kilo Code in GitHub issues, pull requests, and review comments"
|
||||
---
|
||||
|
||||
# Kilo for GitHub
|
||||
|
||||
**Kilo for GitHub** lets you interact with Kilo directly from your GitHub issues, pull requests, and review comments. Mention the bot and it will:
|
||||
|
||||
- Read the surrounding context
|
||||
- Access the repository
|
||||
- Respond with answers, code reviews, or full implementations
|
||||
|
||||
---
|
||||
|
||||
## What You Can Do
|
||||
|
||||
### Ask questions on review comments
|
||||
|
||||
When you're reviewing a pull request and want a second opinion on a piece of code:
|
||||
|
||||
```
|
||||
@kilocode-bot is this true?
|
||||
```
|
||||
|
||||
The bot reads the review comment, the surrounding diff, and the relevant code in the repository to give you an informed answer.
|
||||
|
||||
### Fix issues directly from GitHub
|
||||
|
||||
Tag the bot on any issue and ask it to handle the fix:
|
||||
|
||||
```
|
||||
@kilocode-bot please fix
|
||||
```
|
||||
|
||||
The bot will:
|
||||
|
||||
- Read the issue description
|
||||
- Analyze the relevant code
|
||||
- Create a branch with the implementation
|
||||
- Open a pull request
|
||||
|
||||
### Diagnose bug reports
|
||||
|
||||
When a bug report comes in and you want to understand what's going on before diving in:
|
||||
|
||||
```
|
||||
@kilocode-bot what could be the cause of this issue?
|
||||
```
|
||||
|
||||
The bot examines the bug report, searches the codebase for related code paths, and shares its analysis directly in the issue thread.
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Mention `@kilocode-bot`** on an issue, pull request, or review comment
|
||||
2. **Kilo reads the context** — the issue description, PR diff, review thread, and connected repository code
|
||||
3. **A Cloud Agent spins up** to process the request
|
||||
4. **Kilo responds** with an answer, analysis, or a pull request containing the implementation
|
||||
|
||||
For implementation requests, the bot creates a new branch, commits the changes, and opens a PR back to the repository. You'll see the PR linked directly in the thread.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Kilo Code account with available credits
|
||||
- Your GitHub integration configured via the Integrations tab at [app.kilo.ai](https://app.kilo.ai)
|
||||
- The Kilo Code Bot GitHub App installed on the relevant repositories
|
||||
|
||||
---
|
||||
|
||||
## Setup
|
||||
|
||||
1. Go to [app.kilo.ai](https://app.kilo.ai) and navigate to the **Integrations** tab
|
||||
2. Connect your GitHub account through the **KiloConnect** GitHub App if you haven't already
|
||||
3. Install the **Kilo Code Bot** GitHub App on your repositories at [github.com/apps/kilo-code-bot](https://github.com/apps/kilo-code-bot/)
|
||||
|
||||
Once installed, `@kilocode-bot` is available on any issue or PR in the repositories you've authorized.
|
||||
|
||||
---
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Code Review Assistance
|
||||
|
||||
During a PR review, mention the bot on any comment or line of code to get a quick analysis. The bot can:
|
||||
|
||||
- Verify logic
|
||||
- Suggest improvements
|
||||
- Explain unfamiliar patterns
|
||||
|
||||
### Issue Triage and Fixes
|
||||
|
||||
When new issues come in, the bot can diagnose probable causes and, if you ask, implement a fix directly. This works best for straightforward bugs where the issue description gives enough context to act.
|
||||
|
||||
### Bulk or Cross-Repo Changes
|
||||
|
||||
Need to bump a dependency or apply a config change across your org? Mention the repos in a single comment and the bot handles each one.
|
||||
|
||||
---
|
||||
|
||||
## Cost
|
||||
|
||||
Kilo Code credits are consumed the same way as any other Kilo interface. Credit usage depends on the model selected and the complexity of the task.
|
||||
|
||||
---
|
||||
|
||||
## Tips for Best Results
|
||||
|
||||
- **Be specific about what you want.** "Please fix" works best on well-described issues. For vague issues, ask the bot to diagnose first.
|
||||
- **Mention specific repositories** if the fix spans multiple repos.
|
||||
- **Use on review comments** for quick, contextual questions during code review.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**The bot isn't responding to mentions.**
|
||||
Make sure the Kilo Code Bot GitHub App is installed on the repository and that you're mentioning `@kilocode-bot` (not `@kilo`).
|
||||
|
||||
**The bot can't access the repository.**
|
||||
Verify that both the KiloConnect App and the Kilo Code Bot App are installed and have access to the repository in question.
|
||||
|
||||
**The implementation doesn't match what I expected.**
|
||||
Try providing more context in the issue description or comment. The bot works best when the problem and desired outcome are clearly described.
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Kilo Connect"
|
||||
description: "Use Kilo Code directly from Slack, GitHub, and Linear"
|
||||
---
|
||||
|
||||
# Kilo Connect
|
||||
|
||||
**Kilo Connect** brings Kilo Code into the tools your team already uses. Instead of switching to a separate interface, you can trigger implementations, ask questions, and get pull requests opened directly from your chat, issue tracker, or code review workflow.
|
||||
|
||||
---
|
||||
|
||||
## Supported Integrations
|
||||
|
||||
| Integration | Trigger | What It Can Do |
|
||||
|---|---|---|
|
||||
| [Slack](/docs/code-with-ai/platforms/slack) | `@Kilo` in any channel or DM | Ask questions, implement fixes, debug issues |
|
||||
| [GitHub](/docs/code-with-ai/platforms/github) | `@kilocode-bot` on issues and PRs | Fix issues, review code, cross-repo changes |
|
||||
| [Linear](/docs/code-with-ai/platforms/linear) | `@kilo` on any issue | Implement fixes, investigate bugs, cross-repo changes |
|
||||
|
||||
---
|
||||
|
||||
## How to Set Up
|
||||
|
||||
All integrations are configured from the **Integrations** tab at [app.kilo.ai](https://app.kilo.ai). Each integration requires:
|
||||
|
||||
- A Kilo Code account with available credits
|
||||
- A connected Git provider (GitHub or GitLab) so Kilo can access your repositories
|
||||
- The specific integration installed and authorized for your workspace
|
||||
@@ -0,0 +1,119 @@
|
||||
---
|
||||
title: "Linear"
|
||||
description: "Using Kilo Code in Linear"
|
||||
---
|
||||
|
||||
# Kilo for Linear
|
||||
|
||||
**Kilo for Linear** connects Kilo Code to your Linear workspace, so you can trigger implementations, debug issues, and investigate bugs directly from your project management tool. Mention `@kilo` on any issue and the bot gets to work.
|
||||
|
||||
---
|
||||
|
||||
## What You Can Do
|
||||
|
||||
### Fix issues from Linear
|
||||
|
||||
Tag the bot on any Linear issue and tell it to implement the fix:
|
||||
|
||||
```
|
||||
@kilo please fix
|
||||
```
|
||||
|
||||
The bot will:
|
||||
|
||||
- Read the issue title, description, and comments
|
||||
- Spin up a Cloud Agent to implement the solution
|
||||
- Show a thinking/processing animation in Linear while it works
|
||||
- Link the resulting pull request back to the issue
|
||||
|
||||
### Apply changes across multiple repositories
|
||||
|
||||
If a fix or upgrade needs to land in several repos at once:
|
||||
|
||||
```
|
||||
@kilo please fix this in the cloud, landing, and handbook repos
|
||||
```
|
||||
|
||||
The bot handles each repository independently, creating separate branches and pull requests for each.
|
||||
|
||||
### Get help understanding an issue
|
||||
|
||||
Before jumping into a fix, ask the bot to analyze the problem:
|
||||
|
||||
```
|
||||
@kilo what could be the cause of this issue?
|
||||
```
|
||||
|
||||
The bot examines the issue context and searches the connected codebase to surface likely causes.
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Mention `@kilo`** in a comment on a Linear issue
|
||||
2. **Kilo reads the issue context** — title, description, labels, and comment thread
|
||||
3. **A Cloud Agent spins up** to process the request (you'll see a thinking animation in Linear while this happens)
|
||||
4. **Kilo responds** with an answer or opens a pull request with the implementation
|
||||
|
||||
When Kilo creates a pull request, it links back to the Linear issue so everything stays connected.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Kilo Code account with available credits
|
||||
- Your GitHub or GitLab integration configured via the Integrations tab at [app.kilo.ai](https://app.kilo.ai)
|
||||
- Access to a Linear workspace where you can install integrations
|
||||
|
||||
---
|
||||
|
||||
## Setup
|
||||
|
||||
1. Go to [app.kilo.ai](https://app.kilo.ai) and navigate to the **Integrations** tab
|
||||
2. Set up the **Linear** integration
|
||||
3. Authorize Kilo to access your Linear workspace
|
||||
|
||||
Once connected, `@kilo` is available as a mention in any issue across your Linear workspace.
|
||||
|
||||
---
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Sprint Cleanup
|
||||
|
||||
Have a backlog of well-described bugs? Tag the bot on each one and let it work through them while you focus on higher-priority work.
|
||||
|
||||
### Cross-Repo Upgrades
|
||||
|
||||
Need to upgrade a framework version or apply a config change across several services? Create a single Linear issue describing the change, then tell the bot which repos to update.
|
||||
|
||||
### Issue Investigation
|
||||
|
||||
When a bug report is unclear or the root cause isn't obvious, ask the bot to analyze the issue before committing to a fix. It can search the codebase and surface likely problem areas.
|
||||
|
||||
---
|
||||
|
||||
## Cost
|
||||
|
||||
Kilo Code credits are consumed the same way as any other Kilo interface. Credit usage depends on the model selected and the complexity of the task.
|
||||
|
||||
---
|
||||
|
||||
## Tips for Best Results
|
||||
|
||||
- **Write clear issue descriptions.** The bot works best when the issue title and description give enough context to understand the problem and the expected outcome.
|
||||
- **Mention specific repositories** if the change needs to land in more than one.
|
||||
- **Start with diagnosis for ambiguous issues.** Ask the bot to analyze the issue before asking it to fix.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**The bot isn't responding to mentions.**
|
||||
Confirm that the Linear integration is set up in the Integrations tab at [app.kilo.ai](https://app.kilo.ai) and that the bot has access to your workspace.
|
||||
|
||||
**The bot can't access the repository.**
|
||||
Make sure your GitHub or GitLab integration is configured and that the relevant repositories are authorized.
|
||||
|
||||
**The pull request doesn't match what I expected.**
|
||||
Provide more detail in the issue description, or comment with additional context before asking the bot to fix.
|
||||
@@ -5,50 +5,71 @@ description: "Using Kilo Code in Slack"
|
||||
|
||||
# Kilo for Slack
|
||||
|
||||
Kilo for Slack brings the power of Kilo Code directly into your Slack workspace. Ask questions about your repositories, request code implementations, or get help with issues—all without leaving Slack.
|
||||
**Kilo for Slack** brings Kilo Code directly into your Slack workspace. Ask questions about your repositories, request code implementations, debug issues, and collaborate with your team — all without leaving Slack.
|
||||
|
||||
When you mention `@Kilo` in a thread, the bot:
|
||||
|
||||
- Reads the full conversation
|
||||
- Accesses your connected repositories
|
||||
- Answers your question or spins up a Cloud Agent to implement the change
|
||||
- Creates branches, pushes commits, and opens pull requests on your behalf
|
||||
|
||||
---
|
||||
|
||||
## What You Can Do With Kilo for Slack
|
||||
## What You Can Do
|
||||
|
||||
- **Ask questions about your repositories** — Get explanations about code, architecture, or implementation details
|
||||
- **Request code implementations** — Tell the bot to implement fixes or features suggested in Slack threads
|
||||
- **Get help with debugging** — Share error messages or issues and get AI-powered assistance
|
||||
- **Collaborate with your team** — Mention the bot in any channel to get help in context
|
||||
### Ask questions about your codebase
|
||||
|
||||
```
|
||||
@Kilo what does the UserService class do in our main backend repo?
|
||||
```
|
||||
|
||||
```
|
||||
@Kilo how is error handling implemented in the payment processing module?
|
||||
```
|
||||
|
||||
### Implement fixes and features from Slack discussions
|
||||
|
||||
When your team identifies a bug or improvement in a thread, ask the bot to handle it:
|
||||
|
||||
```
|
||||
@Kilo based on this thread, can you implement the fix for the null pointer exception in the order processing service?
|
||||
```
|
||||
|
||||
The bot will:
|
||||
|
||||
- Read the thread context
|
||||
- Understand the proposed solution
|
||||
- Create a branch with the implementation
|
||||
- Push a pull request to your repository
|
||||
|
||||
### Implement changes across multiple repositories
|
||||
|
||||
If the same change needs to land in several repos, just tell the bot:
|
||||
|
||||
```
|
||||
@Kilo please fix this in the cloud, landing, and handbook repos
|
||||
```
|
||||
|
||||
### Debug issues
|
||||
|
||||
Paste an error message or stack trace and ask for help:
|
||||
|
||||
```
|
||||
@Kilo I'm seeing this error in production:
|
||||
[paste error message]
|
||||
Can you help me understand what's causing it?
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
| Platform | Integration Type | Details |
|
||||
|---|---|---|
|
||||
| GitHub | GitHub App | [GitHub Setup Guide](/docs/automate/integrations#connecting-github) |
|
||||
| GitLab | OAuth or PAT | [GitLab Setup Guide](/docs/automate/integrations#connecting-gitlab) |
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before using Kilo for Slack:
|
||||
|
||||
- You must have a **Kilo Code account** with available credits
|
||||
- Your **Git provider integration must be configured** via the [Integrations tab](https://app.kilo.ai/integrations) so Kilo can access your repositories
|
||||
|
||||
To install Kilo for Slack, simply go to the integrations menu in the sidebar on https://app.kilo.ai and set up the Slack integration.
|
||||
|
||||
---
|
||||
|
||||
## How to Interact with Kilo
|
||||
## How to Interact
|
||||
|
||||
### Direct Messages
|
||||
|
||||
You can message Kilo directly through Slack DMs for private conversations:
|
||||
You can DM Kilo directly for private conversations. Find Kilo in your workspace's app list and start a direct message.
|
||||
|
||||
1. Find **Kilo** in your Slack workspace's app list
|
||||
2. Start a direct message conversation
|
||||
3. Ask your question or describe what you need
|
||||
|
||||
This is ideal for:
|
||||
Good for:
|
||||
|
||||
- Private questions about your code
|
||||
- Sensitive debugging sessions
|
||||
@@ -62,114 +83,80 @@ Mention the bot in any channel where it's been added:
|
||||
@Kilo can you explain how the authentication flow works in our backend?
|
||||
```
|
||||
|
||||
This is great for:
|
||||
Good for:
|
||||
|
||||
- Team discussions where AI assistance would help
|
||||
- Collaborative debugging sessions
|
||||
- Collaborative debugging
|
||||
- Getting quick answers during code reviews
|
||||
|
||||
---
|
||||
|
||||
## Use Cases
|
||||
## Prerequisites
|
||||
|
||||
### Ask Questions About Your Repositories
|
||||
Before using Kilo for Slack:
|
||||
|
||||
Get instant answers about your codebase without switching contexts:
|
||||
- You need a Kilo Code account with available credits
|
||||
- Your Git provider integration (GitHub or GitLab) must be configured via the Integrations tab at [app.kilo.ai](https://app.kilo.ai) so Kilo can access your repositories
|
||||
|
||||
```
|
||||
@Kilo what does the UserService class do in our main backend repo?
|
||||
```
|
||||
---
|
||||
|
||||
```
|
||||
@Kilo how is error handling implemented in the payment processing module?
|
||||
```
|
||||
## Setup
|
||||
|
||||
### Implement Fixes from Slack Discussions
|
||||
To install Kilo for Slack, go to the Integrations menu in the sidebar at [app.kilo.ai](https://app.kilo.ai) and set up the Slack integration.
|
||||
|
||||
When your team identifies an issue or improvement in a Slack thread, ask the bot to implement it:
|
||||
|
||||
```
|
||||
@Kilo based on this thread, can you implement the fix for the null pointer exception in the order processing service?
|
||||
```
|
||||
|
||||
The bot can:
|
||||
|
||||
- Read the context from the thread
|
||||
- Understand the proposed solution
|
||||
- Create a branch with the implementation
|
||||
- Push the changes to your repository
|
||||
|
||||
### Debug Issues
|
||||
|
||||
Share error messages or stack traces and get help:
|
||||
|
||||
```
|
||||
@Kilo I'm seeing this error in production:
|
||||
[paste error message]
|
||||
Can you help me understand what's causing it?
|
||||
```
|
||||
| Platform | Integration Type | Details |
|
||||
|---|---|---|
|
||||
| GitHub | GitHub App | [GitHub Setup Guide](/docs/automate/integrations#connecting-github) |
|
||||
| GitLab | OAuth or PAT | [GitLab Setup Guide](/docs/automate/integrations#connecting-gitlab) |
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Message Kilo** — Either through DMs or by mentioning it in a channel
|
||||
2. **Kilo processes your request** — Kilo uses your connected repositories to understand context
|
||||
3. **AI generates a response** — Kilo Code's AI analyzes your request and provides helpful responses
|
||||
4. **Code changes (if requested)** — For implementation requests, Kilo can create pull or merge requests
|
||||
|
||||
---
|
||||
|
||||
## Cost
|
||||
|
||||
- **Kilo Code credits are used** when Kilo performs work (model usage, operations, etc.)
|
||||
- Credit usage is similar to using Kilo Code through other interfaces
|
||||
|
||||
---
|
||||
|
||||
## Tips for Best Results
|
||||
|
||||
- **Be specific** — The more context you provide, the better the response
|
||||
- **Reference specific files or functions** — Help the bot understand exactly what you're asking about
|
||||
- **Use threads** — Keep related conversations in threads for better context
|
||||
- **Specify the repository** — If you have multiple repos connected, mention which one you're asking about
|
||||
|
||||
---
|
||||
|
||||
## Limitations
|
||||
|
||||
- Kilo can only access repositories you've connected through the [Integrations](https://app.kilo.ai/integrations) page
|
||||
- Complex multi-step implementations may require follow-up messages
|
||||
- Response times may vary based on the complexity of your request
|
||||
1. **Message Kilo** through a DM or channel mention
|
||||
2. **Kilo processes your request** using your connected repositories for context
|
||||
3. **AI generates a response** analyzing your request and providing an answer
|
||||
4. **Code changes (if requested)** — Kilo creates a branch, commits the changes, and opens a pull or merge request
|
||||
|
||||
---
|
||||
|
||||
## Changing the Model
|
||||
|
||||
You can customize which AI model Kilo uses for generating responses. The model affects the quality, speed, and capabilities of Kilo's responses.
|
||||
You can customize which AI model Kilo uses for generating responses.
|
||||
|
||||
1. Go to your [Kilo Workspace](https://app.kilo.ai/)
|
||||
2. Navigate to **Integrations** > **Slack**
|
||||
3. Select your preferred model for Kilo for Slack
|
||||
1. Go to your Kilo Workspace at [app.kilo.ai](https://app.kilo.ai)
|
||||
2. Navigate to **Integrations > Slack**
|
||||
3. Select your preferred model
|
||||
|
||||
Kilo will start using the new model immediately for subsequent requests.
|
||||
Kilo for Slack supports 400+ models across different providers. The new model applies immediately to subsequent requests.
|
||||
|
||||
### Available Models
|
||||
---
|
||||
|
||||
Kilo for Slack supports over 400+ models across different providers.
|
||||
## Cost
|
||||
|
||||
Kilo Code credits are used when Kilo performs work (model usage, operations, etc.). Credit usage is the same as using Kilo through any other interface.
|
||||
|
||||
---
|
||||
|
||||
## Tips for Best Results
|
||||
|
||||
- **Be specific.** The more context you provide, the better the response.
|
||||
- **Reference specific files or functions.** Help the bot understand exactly what you're asking about.
|
||||
- **Use threads.** Keep related conversations in threads for better context.
|
||||
- **Specify the repository.** If you have multiple repos connected, mention which one you're asking about.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"Kilo isn't responding."**
|
||||
Ensure Kilo for Slack is installed in your workspace and has been added to the channel you're using.
|
||||
**Kilo isn't responding.**
|
||||
Make sure Kilo for Slack is installed in your workspace and has been added to the channel you're using.
|
||||
|
||||
**"Kilo can't access my repository."**
|
||||
Verify your Git provider integration is configured correctly in the [Integrations tab](https://app.kilo.ai/integrations).
|
||||
**Kilo can't access my repository.**
|
||||
Verify your Git provider integration is configured correctly in the Integrations tab.
|
||||
|
||||
**"I'm getting incomplete responses."**
|
||||
**I'm getting incomplete responses.**
|
||||
Try breaking your request into smaller, more specific questions.
|
||||
|
||||
**"Kilo doesn't understand my codebase."**
|
||||
Make sure the repository you're asking about is connected and accessible through your Git provider integration.
|
||||
**Kilo doesn't understand my codebase.**
|
||||
Confirm that the repository you're asking about is connected and accessible through your Git provider integration.
|
||||
|
||||
Reference in New Issue
Block a user