mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-24 16:02:55 +08:00
Merge pull request #11988 from Kilo-Org/docs-improve-onboarding-flow
docs(kilo-docs): improve onboarding flow
This commit is contained in:
Emilie Lima Schario
@@ -2,28 +2,23 @@ import { NavSection } from "../types"
|
||||
|
||||
export const GettingStartedNav: NavSection[] = [
|
||||
{
|
||||
title: "Introduction",
|
||||
title: "Get Started",
|
||||
links: [
|
||||
{ href: "/getting-started", children: "Overview" },
|
||||
{ href: "/getting-started/installing", children: "Installation" },
|
||||
{ href: "/getting-started/quickstart", children: "Quickstart" },
|
||||
{ href: "/getting-started/setup-authentication", children: "Authentication" },
|
||||
{ href: "/getting-started/quickstart", children: "Your First Task" },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "Configuration",
|
||||
links: [
|
||||
{
|
||||
href: "/getting-started/setup-authentication",
|
||||
children: "Setup & Authentication",
|
||||
},
|
||||
{
|
||||
href: "/getting-started/using-kilo-for-free",
|
||||
children: "Using Kilo for Free",
|
||||
},
|
||||
{
|
||||
href: "/getting-started/byok",
|
||||
children: "Bring Your Own Key (BYOK)",
|
||||
},
|
||||
{ href: "/getting-started/byok", children: "Bring Your Own Key (BYOK)" },
|
||||
{ href: "/ai-providers", children: "AI Providers" },
|
||||
{
|
||||
href: "/getting-started/settings",
|
||||
children: "Settings",
|
||||
|
||||
@@ -39,7 +39,7 @@ The panel opens as an editor tab and stays active across focus changes.
|
||||
|
||||
Agent Manager uses the same sign-in, provider settings, models, BYOK keys, custom providers, MCP servers, and permission rules as the extension sidebar. Configure them from extension Settings and they apply to Agent Manager as well.
|
||||
|
||||
See [Setup & Authentication](/docs/getting-started/setup-authentication), [AI Providers](/docs/ai-providers), and [Bring Your Own Key](/docs/getting-started/byok) for setup details.
|
||||
See [Authentication](/docs/getting-started/setup-authentication), [AI Providers](/docs/ai-providers), and [Bring Your Own Key](/docs/getting-started/byok) for setup details.
|
||||
|
||||
## Working with Worktrees
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ Your sessions sync across all of these, so you can start a task on your phone an
|
||||
## Quick Start
|
||||
|
||||
1. [Install Kilo Code](/docs/getting-started/installing) in your preferred environment
|
||||
2. [Connect an AI provider](/docs/ai-providers) or use Kilo's built-in provider & credits
|
||||
2. [Set up authentication](/docs/getting-started/setup-authentication) or use Kilo's built-in provider
|
||||
3. [Run your first task](/docs/getting-started/quickstart)
|
||||
|
||||
{% callout type="tip" %}
|
||||
|
||||
@@ -124,11 +124,10 @@ If you plan to remain on that version for a while, you may also want to temporar
|
||||
|
||||
## Next Steps
|
||||
|
||||
After installation, check out these resources to get started:
|
||||
After installation:
|
||||
|
||||
- [Quickstart Guide](/docs/getting-started/quickstart) - Get up and running in minutes
|
||||
- [Setting Up Authentication](/docs/getting-started/setup-authentication) - Configure your AI provider
|
||||
- [Your First Task](/docs/code-with-ai/agents/chat-interface) - Learn the basics of working with Kilo Code
|
||||
1. **[Set up authentication](/docs/getting-started/setup-authentication)** to configure your AI provider
|
||||
2. **[Run your first task](/docs/getting-started/quickstart)** — Learn how to chat with Kilo to complete tasks
|
||||
|
||||
## Getting Support
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
title: "Quickstart"
|
||||
title: "Your First Task"
|
||||
description: "Get up and running with Kilo Code in minutes"
|
||||
---
|
||||
|
||||
# Quickstart
|
||||
# Your First Task
|
||||
|
||||
After you [set up Kilo Code](/docs/getting-started/setup-authentication), follow the guide for your platform below.
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode" %}
|
||||
{% tab label="VS Code" %}
|
||||
|
||||
## Step by Step Guide
|
||||
|
||||
@@ -36,16 +36,9 @@ Kilo Code analyzes your request and proposes actions. By default, most tools are
|
||||
|
||||
To change which actions require approval, open **Settings** (gear icon) and go to the **Auto-Approve** tab. You can set each tool to Allow, Ask, or Deny. See [Auto-Approving Actions](/docs/getting-started/settings/auto-approving-actions) for details.
|
||||
|
||||
### Step 5: Iterate
|
||||
### Step 5: Iterate and Review
|
||||
|
||||
Kilo Code works iteratively. Continue giving feedback or follow-up instructions until your task is complete.
|
||||
|
||||
### Key Differences from Legacy
|
||||
|
||||
- **Settings** are managed via `kilo.jsonc` config files (the Settings webview reads and writes the same files)
|
||||
- **Permissions** use a granular per-tool system instead of broad approval categories
|
||||
- **Modes** are called "agents" and configured as `.md` files or via the `agent` config key
|
||||
- **Autocomplete** uses FIM (Fill-in-the-Middle) with Codestral
|
||||
Kilo Code works iteratively. Continue giving feedback or follow-up instructions until your task is complete. The assistant will propose file edits, run commands, and complete your request step by step.
|
||||
|
||||
{% /tab %}
|
||||
{% tab label="CLI" %}
|
||||
@@ -68,7 +61,7 @@ Run the `kilo` command to start the interactive TUI (terminal user interface):
|
||||
kilo
|
||||
```
|
||||
|
||||
If this is your first time, run `kilo auth login` first to authenticate (see [Setup & Authentication](/docs/getting-started/setup-authentication)).
|
||||
If this is your first time, run `kilo auth login` first to authenticate (see [Authentication](/docs/getting-started/setup-authentication)).
|
||||
|
||||
### Step 3: Type Your Task
|
||||
|
||||
@@ -86,9 +79,9 @@ Kilo analyzes your request and proposes actions. By default, most tools are auto
|
||||
|
||||
To change permission defaults, configure the `permission` key in your `kilo.jsonc` config file. See [Auto-Approving Actions](/docs/getting-started/settings/auto-approving-actions) for details.
|
||||
|
||||
### Step 5: Iterate
|
||||
### Step 5: Iterate and Review
|
||||
|
||||
Kilo works iteratively. Continue giving feedback or follow-up instructions until your task is complete.
|
||||
Kilo works iteratively. Continue giving feedback or follow-up instructions until your task is complete. The assistant will propose file edits, run commands, and complete your request step by step.
|
||||
|
||||
### One-Shot Mode
|
||||
|
||||
@@ -107,19 +100,13 @@ kilo run --auto "fix the failing tests in test/auth.test.ts"
|
||||
{% /tab %}
|
||||
{% /tabs %}
|
||||
|
||||
## Conclusion
|
||||
## What You Can Do Next
|
||||
|
||||
You've completed your first task. Along the way you learned:
|
||||
Now that you've completed your first task, try these capabilities:
|
||||
|
||||
- How to interact with Kilo Code using natural language
|
||||
- Why approval keeps you in control
|
||||
- How iteration lets the AI refine its work
|
||||
|
||||
Ready for more? Here are some next steps:
|
||||
|
||||
- **[Autocomplete](/docs/code-with-ai/features/autocomplete)** — Get inline code suggestions as you type
|
||||
- **[Agents](/docs/code-with-ai/agents/using-agents)** — Explore different agents for different tasks
|
||||
- **[Git commit generation](/docs/code-with-ai/features/git-commit-generation)** — Automatically generate commit messages
|
||||
- **[Autocomplete](/docs/code-with-ai/features/autocomplete)** — Get inline code suggestions as you type in your editor
|
||||
- **[Agents](/docs/code-with-ai/agents/using-agents)** — Switch between specialized agents for coding, architecture, debugging, and more
|
||||
- **[Git](/docs/code-with-ai/features/git-commit-generation)** — Auto-generate commit messages from your changes
|
||||
|
||||
{% callout type="tip" %}
|
||||
**Accelerate development:** Check out multiple copies of your repository and run Kilo Code on all of them in parallel (using git to resolve any conflicts, same as with human devs). This can dramatically speed up development on large projects.
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
---
|
||||
title: "Setup & Authentication"
|
||||
title: "Authentication"
|
||||
description: "Configure Kilo Code and connect to your AI providers"
|
||||
---
|
||||
|
||||
# Setup & Authentication
|
||||
# Authentication
|
||||
|
||||
When you install Kilo Code, you'll be prompted to sign in or create a free account. This automatically configures everything you need to get started.
|
||||
|
||||
## Quick Start with Kilo Account
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode" %}
|
||||
{% tab label="VS Code" %}
|
||||
|
||||
The extension prompts you to sign in when you first open Kilo Code in VS Code. Click **Sign In** and complete the browser-based flow. Sign-in applies across extension surfaces, including the sidebar and Agent Manager.
|
||||
|
||||
@@ -93,7 +93,7 @@ Already have a ChatGPT subscription? You can use it with Kilo Code through the [
|
||||
### Configuring Your Provider
|
||||
|
||||
{% tabs %}
|
||||
{% tab label="VSCode" %}
|
||||
{% tab label="VS Code" %}
|
||||
|
||||
1. Open Kilo Code in VS Code
|
||||
2. Click the gear icon ({% codicon name="gear" /%}) in the extension UI to open **Settings**
|
||||
|
||||
Reference in New Issue
Block a user