- Rewrite index.mdx as proper getting started guide - New: chat.mdx (modes, permissions, context management) - New: skills.mdx (categories, marketplace, local skills) - New: design-agent.mdx (single/batch image generation) - New: gallery.mdx (browsing, filtering, detail view) - Rewrite providers.mdx — CLI env auth, cc switch caveat, API Key vs Auth Token, Chinese provider presets, model mapping, priority chain - Rewrite mcp.mdx — three transport types, dual view modes - Rewrite assistant-workspace.mdx — align with Settings > Assistant tab - Rewrite faq.mdx — comprehensive Q&A - Bridge split into 5 pages: overview + Telegram + Discord + Feishu + QQ - Flatten single-page folders to remove sidebar expand arrows - Update meta.json with new pages Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
58 lines
2.7 KiB
Plaintext
58 lines
2.7 KiB
Plaintext
---
|
|
title: Getting Started
|
|
description: Get started with CodePilot — a desktop workspace for Claude Code.
|
|
---
|
|
|
|
# Getting Started
|
|
|
|
CodePilot is a desktop workspace for Claude Code that brings conversations, providers, MCP, Skills, Bridge, and Assistant Workspace together in one interface.
|
|
|
|
## Prerequisites
|
|
|
|
Before using CodePilot, you need:
|
|
|
|
1. **Node.js 18+** — CodePilot depends on Node.js to run the Claude Code CLI
|
|
2. **Claude Code CLI** — Anthropic's official command-line tool (can be installed automatically on first launch)
|
|
3. **At least one API key** — From Anthropic, OpenRouter, or another supported provider (see [Providers](/docs/providers) for details on obtaining and configuring keys)
|
|
|
|
## Installation & First Launch
|
|
|
|
1. Download the installer for your platform from [GitHub Releases](https://github.com/op7418/CodePilot/releases) ([detailed installation guide](/docs/installation))
|
|
2. Install and launch CodePilot
|
|
3. On first launch, a **Setup Wizard** will guide you through:
|
|
- Detecting and installing Node.js (if not found)
|
|
- Detecting and installing the Claude Code CLI (if not found)
|
|
- Configuring at least one API provider
|
|
|
|
## Interface Overview
|
|
|
|
The CodePilot interface consists of a left sidebar and a main workspace area:
|
|
|
|
| Navigation | Description |
|
|
|------------|-------------|
|
|
| **Chat** | Converse with Claude in Code / Plan / Ask modes |
|
|
| **MCP** | Manage MCP servers to give Claude access to external tools |
|
|
| **Skills** | Browse and manage skills (local + marketplace) |
|
|
| **Bridge** | Bridge conversations to Telegram, Discord, Feishu, QQ |
|
|
| **Gallery** | View images generated by Claude |
|
|
| **Settings** | Providers, CLI config, usage stats, Assistant Workspace |
|
|
|
|
## Starting Your First Conversation
|
|
|
|
1. Click **Chat** in the sidebar to open the chat page
|
|
2. Type your request in the input box and press Enter
|
|
3. Claude will stream its response, showing tool calls and file operations as they happen
|
|
4. Use the mode switcher above the input box to change the conversation mode:
|
|
- **Code** — Default mode. Claude can read/write files and run commands
|
|
- **Plan** — Planning mode. Claude analyzes and proposes a plan without executing anything
|
|
- **Ask** — Q&A mode. Claude answers questions without using any tools
|
|
|
|
## Next Steps
|
|
|
|
- [Installation](/docs/installation) — Detailed installation and setup steps
|
|
- [Providers](/docs/providers) — Configure multiple LLM providers
|
|
- [MCP](/docs/mcp) — Extend Claude's capabilities with MCP plugins
|
|
- [Skills](/docs/skills) — Use and manage skills
|
|
- [Bridge](/docs/bridge) — Continue Claude conversations on your phone
|
|
- [Assistant Workspace](/docs/assistant-workspace) — Manage project context and Claude's behavior
|