mirror of
https://github.com/cline/cline.git
synced 2026-09-19 10:13:34 +08:00
* docs: restructure CLI reference to web-friendly format Replace embedded man page format with structured markdown sections for better readability. Simplify description, reorganize commands and options into clear categories, and update Next Steps navigation cards. * Add ACP editor integrations documentation (#9036) * Add ACP editor integrations documentation with JetBrains and Neovim video demos * Add Model Orchestration documentation with --config and --thinking flags - Document --config and --thinking flags in CLI reference - Create new model-orchestration.mdx sample page - Add patterns for CI/CD review, task phase optimization, and multi-model consensus - Link to production GitHub Actions workflow - Update samples overview with new card - Update docs navigation * Add Worktree Workflows documentation with --cwd flag - Document --cwd flag in CLI reference - Create comprehensive worktree-workflows.mdx sample page - Add patterns for parallel execution and cross-worktree piping - Include real-world examples and best practices - Add CLI section to features/worktrees.mdx for discoverability - Update samples overview and navigation - Cross-link between CLI and VS Code worktree docs * Remove broken image references from worktrees documentation - Remove worktrees-overview.png Frame (image not available) - Remove worktrees-merge.png Frame (image not available) - Documentation remains fully functional with comprehensive text explanations * Remove accidentally committed local test file - Delete src/test/verify-platformio-mcp.ts which was causing CI failures - File contained TypeScript errors and hardcoded local paths - Was meant for local testing only, should not have been committed * Add native JetBrains plugin recommendation to ACP docs - Add prominent Note recommending native JetBrains plugin - Link directly to JetBrains installation section - Position ACP setup as an alternative approach - Keep all existing ACP content and video * docs: refine CLI reference formatting and ACP title Improve CLI reference readability with clearer headings and descriptions, and clarify the ACP editor integration page title for better discovery.docs: refine CLI reference formatting and ACP title Improve CLI reference readability with clearer headings and descriptions, and clarify the ACP editor integration page title for better discovery. * Fix CLI 2.0 syntax in model-orchestration.mdx - Updated issue analysis pipeline to use shell variables for passing context - Added explanatory note about why direct piping doesn't work - Corrected example to complete each phase before starting the next - All examples now use proper CLI 2.0 syntax * Completely rewrite cli-reference.mdx with accurate CLI 2.0 information - Removed all outdated CLI 1.0 content (instance management, Cline Core architecture, gRPC references) - Added accurate CLI 2.0 commands: task, history, config, auth, update, version, dev - Corrected all command flags and options based on actual man page - Added proper examples for all commands - Included environment variables documentation (CLINE_DIR, CLINE_COMMAND_PERMISSIONS) - Added shell completion instructions - Removed incorrect three-layer architecture description - All content now matches cli/man/cline.1.md source of truth Fixes outdated documentation issue mentioned in PR#9036 * Fix MDX syntax error in cli-reference.mdx - Replace angle bracket URLs with proper markdown links - MDX parser was interpreting <https://...> as invalid HTML tags - Now uses [url](url) format which is proper MDX syntax Fixes deployment validation error --------- Co-authored-by: Renee Huang <renee@cline.bot> * docs: enhance interactive mode documentation with structured settings overview * docs: restructure and improve CLI reference documentation - Reorganize command structure with clearer global options section - Add mode behavior table explaining interactive vs plain text modes - Improve option descriptions with consistent formatting - Add horizontal rules between sections for better readability - Document timeout option and environment variables more clearly - Add Tips & Tricks section for common usage patterns - Update frontmatter description to reflect content changes * docs: improve ACP editor integrations page with editor descriptions - Update page title to be more concise ("ACP: Editor Integrations") - Remove redundant H1 header that duplicated the title - Add introductory descriptions for JetBrains, Neovim, and Zed sections - Rename "Zed Editor" section to just "Zed" for consistency * docs: expand CLI reference with modes of operation and agent behavior * Update docs/cline-cli/cli-reference-deprecated.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Tony Loehr <turingxo@gmail.com> Co-authored-by: Renee Huang <renee@cline.bot> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
275 lines
6.9 KiB
Plaintext
275 lines
6.9 KiB
Plaintext
---
|
|
title: "Installation & Setup"
|
|
description: "Install Cline CLI on macOS, Linux, or Windows and configure your AI provider"
|
|
---
|
|
|
|
Cline CLI brings the full power of Cline to your terminal. In just a few minutes, you can install the CLI, authenticate with your preferred AI provider, and start running tasks from any directory on your machine.
|
|
|
|
## Prerequisites
|
|
|
|
Cline CLI requires **Node.js version 20 or higher**. We recommend Node.js 22 for the best experience.
|
|
|
|
Check your Node.js version:
|
|
|
|
```bash
|
|
node --version
|
|
```
|
|
|
|
If you need to install or update Node.js, visit [nodejs.org](https://nodejs.org) or use a version manager like [nvm](https://github.com/nvm-sh/nvm).
|
|
|
|
## Install Cline CLI
|
|
|
|
Install globally via npm:
|
|
|
|
```bash
|
|
npm install -g cline
|
|
```
|
|
|
|
Verify the installation:
|
|
|
|
```bash
|
|
cline version
|
|
```
|
|
|
|
<Tip>
|
|
To install a specific version, use `npm install -g cline@2.0.0`. Check [npm](https://www.npmjs.com/package/cline) for available versions.
|
|
</Tip>
|
|
|
|
## Authenticate
|
|
|
|
After installation, run the authentication wizard:
|
|
|
|
```bash
|
|
cline auth
|
|
```
|
|
|
|
This launches an interactive wizard with multiple options. Choose the method that works best for your workflow.
|
|
|
|
### Option 1: Sign in with Cline (Recommended)
|
|
|
|
Select **"Sign in with Cline"** to authenticate with your Cline account via OAuth. Your browser opens automatically to complete sign-in.
|
|
|
|
### Option 2: Sign in with ChatGPT Subscription
|
|
|
|
If you have a ChatGPT Plus or Pro subscription, select **"Sign in with ChatGPT Subscription"**. This uses OpenAI's Codex OAuth to authenticate with your existing subscription.
|
|
|
|
### Option 3: Import from Existing Tools
|
|
|
|
Already using another AI coding CLI? Cline can import your existing configuration:
|
|
|
|
- **Import from Codex CLI** - Imports credentials from `~/.codex/auth.json`
|
|
- **Import from OpenCode** - Imports configuration from `~/.local/share/opencode/auth.json`
|
|
|
|
### Option 4: Bring Your Own API Key
|
|
|
|
Select **"Bring your own API key"** to manually configure any supported provider. Or skip the wizard entirely with flags:
|
|
|
|
```bash
|
|
# Anthropic (Claude)
|
|
cline auth -p anthropic -k sk-ant-api-xxxxx -m claude-sonnet-4-5-20250929
|
|
|
|
# OpenAI
|
|
cline auth -p openai-native -k sk-xxxxx -m gpt-4o
|
|
|
|
# OpenRouter
|
|
cline auth -p openrouter -k sk-or-xxxxx -m anthropic/claude-sonnet-4-5-20250929
|
|
|
|
# OpenAI-compatible provider with custom base URL
|
|
cline auth -p openai -k your-api-key -b https://api.example.com/v1
|
|
```
|
|
|
|
**Quick Setup Flags:**
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `-p, --provider <id>` | Provider ID (e.g., `anthropic`, `openai-native`, `openrouter`) |
|
|
| `-k, --apikey <key>` | Your API key |
|
|
| `-m, --modelid <id>` | Model ID (e.g., `claude-sonnet-4-5-20250929`, `gpt-4o`) |
|
|
| `-b, --baseurl <url>` | Base URL for OpenAI-compatible providers |
|
|
|
|
<Tip>
|
|
Flags are especially useful for scripting, CI/CD environments, or setting up multiple machines.
|
|
</Tip>
|
|
|
|
### Supported Providers
|
|
|
|
| Provider | Provider ID | Notes |
|
|
|----------|-------------|-------|
|
|
| Anthropic | `anthropic` | Direct Claude API access |
|
|
| OpenAI | `openai-native` | GPT-4o, GPT-4, etc. |
|
|
| OpenAI Codex | `openai-codex` | ChatGPT subscription OAuth |
|
|
| OpenRouter | `openrouter` | Access multiple providers |
|
|
| AWS Bedrock | `bedrock` | Claude via AWS |
|
|
| Google Gemini | `gemini` | Gemini Pro, etc. |
|
|
| X AI (Grok) | `xai` | Grok models |
|
|
| Cerebras | `cerebras` | Fast inference |
|
|
| DeepSeek | `deepseek` | DeepSeek models |
|
|
| Ollama | `ollama` | Local models |
|
|
| LM Studio | `lmstudio` | Local models |
|
|
| OpenAI Compatible | `openai` | Any OpenAI-compatible API |
|
|
|
|
## Verify Your Setup
|
|
|
|
Confirm everything is working with a simple test:
|
|
|
|
```bash
|
|
cline "What is 2 + 2?"
|
|
```
|
|
|
|
If Cline responds with an answer, your installation and authentication are complete.
|
|
|
|
Check your current configuration:
|
|
|
|
```bash
|
|
cline config
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
Now you're ready to use Cline. Choose how you want to work:
|
|
|
|
### Interactive Mode
|
|
|
|
Launch the interactive CLI for development:
|
|
|
|
```bash
|
|
cline
|
|
```
|
|
|
|
You'll see the Cline welcome screen. Type your task and press Enter. Use:
|
|
- `Tab` to toggle between Plan and Act modes
|
|
- `Shift+Tab` to enable auto-approve
|
|
- `/help` for available commands
|
|
|
|
[Learn more about interactive mode →](/cline-cli/interactive-mode)
|
|
|
|
### Direct Task Execution
|
|
|
|
Run a task directly from your shell:
|
|
|
|
```bash
|
|
cline "Add error handling to utils.js"
|
|
```
|
|
|
|
For non-interactive execution (perfect for scripts and CI/CD):
|
|
|
|
```bash
|
|
cline -y "Run tests and fix any failures"
|
|
```
|
|
|
|
[Learn more about CLI workflows →](/cline-cli/three-core-flows)
|
|
|
|
## Switching Providers
|
|
|
|
To change your configured provider at any time:
|
|
|
|
```bash
|
|
cline auth
|
|
```
|
|
|
|
You can also use the settings panel in interactive mode:
|
|
|
|
```bash
|
|
cline
|
|
# Then type: /settings
|
|
# Navigate to the API tab
|
|
```
|
|
|
|
## Updating
|
|
|
|
Check for updates and install the latest version:
|
|
|
|
```bash
|
|
cline update
|
|
```
|
|
|
|
Or update manually via npm:
|
|
|
|
```bash
|
|
npm update -g cline
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Command Not Found
|
|
|
|
If `cline` is not found after installation:
|
|
|
|
1. Ensure npm global bin is in your PATH:
|
|
```bash
|
|
npm bin -g
|
|
```
|
|
|
|
2. Add the path to your shell configuration (`.bashrc`, `.zshrc`, etc.):
|
|
```bash
|
|
export PATH="$PATH:$(npm bin -g)"
|
|
```
|
|
|
|
3. Restart your terminal or source your shell config.
|
|
|
|
### Permission Errors
|
|
|
|
If you get permission errors during installation:
|
|
|
|
```bash
|
|
# Option 1: Use a Node version manager (recommended)
|
|
# nvm, fnm, or volta handle permissions automatically
|
|
|
|
# Option 2: Fix npm permissions
|
|
# See: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally
|
|
```
|
|
|
|
### OAuth Flow Issues
|
|
|
|
If the browser doesn't open automatically during OAuth:
|
|
1. Copy the URL from the terminal
|
|
2. Paste it in your browser manually
|
|
3. Complete the sign-in flow
|
|
4. Return to the terminal
|
|
|
|
### API Key Validation
|
|
|
|
If your API key is rejected:
|
|
1. Verify the key is correct and hasn't expired
|
|
2. Check that you've selected the correct provider
|
|
3. Ensure your API account has the necessary permissions
|
|
|
|
**Provider-specific tips:**
|
|
- **Anthropic**: Keys start with `sk-ant-`
|
|
- **OpenAI**: Keys start with `sk-`
|
|
- **AWS Bedrock**: Requires AWS credentials configured separately. See [AWS Bedrock documentation](/provider-config/aws-bedrock/api-key).
|
|
|
|
## Uninstallation
|
|
|
|
To remove Cline CLI:
|
|
|
|
```bash
|
|
npm uninstall -g cline
|
|
```
|
|
|
|
To also remove configuration data:
|
|
|
|
```bash
|
|
rm -rf ~/.cline
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
<Columns cols={2}>
|
|
<Card title="Interactive Mode" icon="terminal" href="/cline-cli/interactive-mode">
|
|
Master the interactive CLI with shortcuts and slash commands.
|
|
</Card>
|
|
|
|
<Card title="CLI Workflows" icon="route" href="/cline-cli/three-core-flows">
|
|
Learn interactive mode, direct execution, and automation patterns.
|
|
</Card>
|
|
|
|
<Card title="Configuration" icon="gear" href="/cline-cli/configuration">
|
|
Configure settings, rules, workflows, and environment variables.
|
|
</Card>
|
|
|
|
<Card title="CLI Reference" icon="book" href="/cline-cli/cli-reference">
|
|
Complete command documentation with all flags and options.
|
|
</Card>
|
|
</Columns>
|