mirror of
https://github.com/cline/cline.git
synced 2026-09-16 21:01:52 +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>
225 lines
7.9 KiB
Plaintext
225 lines
7.9 KiB
Plaintext
---
|
|
title: "Overview"
|
|
description: "Run Cline AI coding agents directly in your terminal with an interactive CLI or automated workflows"
|
|
---
|
|
|
|
## What is Cline CLI?
|
|
|
|
Cline CLI brings the full power of Cline to your terminal. Whether you prefer an interactive experience or automated workflows for CI/CD pipelines, the CLI adapts to your needs.
|
|
|
|
The CLI supports macOS, Linux, and Windows, and works with all the same AI providers as the VS Code extension.
|
|
|
|
<Tip>
|
|
Ready to get started? Check out the [installation guide](/cline-cli/installation) to install Cline CLI and run your first task.
|
|
</Tip>
|
|
|
|
## Two Ways to Use Cline CLI
|
|
|
|
The CLI operates in two distinct modes, automatically selecting the appropriate one based on how you invoke it:
|
|
|
|
### Interactive Mode
|
|
|
|
Interactive mode is designed for **hands-on development sessions** where you want to collaborate with Cline in real-time. It provides a rich terminal interface that feels like chatting with an AI assistant.
|
|
|
|
**When it activates:** Running `cline` without arguments, or when stdin is a TTY (terminal).
|
|
|
|
```bash
|
|
cline
|
|
```
|
|
|
|
Key features:
|
|
|
|
- **Real-time conversation** - Type messages, see Cline's responses, and iterate on tasks
|
|
- **Visual feedback** - Animated welcome screen, syntax-highlighted code, and progress indicators
|
|
- **File mentions** with `@` - Reference workspace files with fuzzy search autocomplete
|
|
- **Slash commands** with `/` - Quick access to `/settings`, `/history`, `/models`, and workflows
|
|
- **Keyboard shortcuts** - `Tab` to toggle Plan/Act, `Shift+Tab` for auto-approve all
|
|
- **Session summaries** - See tasks completed, files modified, and token usage on exit
|
|
- **Settings panel** - Configure providers, models, and features without leaving the CLI
|
|
|
|
Interactive mode keeps you in control. You review Cline's plan, approve or modify actions, and guide the conversation.
|
|
|
|
[Learn more about interactive mode →](/cline-cli/interactive-mode)
|
|
|
|
### Headless Mode (Non-Interactive)
|
|
|
|
Headless mode is designed for **automation, scripting, and CI/CD pipelines** where human interaction isn't possible or desired.
|
|
|
|
**When it activates:** Using the `-y`/`--yolo` flag, `--json` flag, piping input/output, or when stdin is not a TTY.
|
|
|
|
```bash
|
|
# Headless with auto-approval (YOLO mode)
|
|
cline -y "Run tests and fix any failures"
|
|
|
|
# Headless with JSON output for parsing
|
|
cline --json "List all TODO comments" | jq '.text'
|
|
|
|
# Headless via piped input
|
|
cat README.md | cline "Summarize this document"
|
|
|
|
# Chain multiple headless commands
|
|
git diff | cline -y "explain these changes" | cline -y "write a commit message"
|
|
```
|
|
|
|
Key features:
|
|
|
|
- **No visual interface** - Clean text or JSON output suitable for scripting
|
|
- **Automatic execution** - With `-y`, Cline approves all actions and runs autonomously
|
|
- **Process control** - Exits automatically when the task completes
|
|
- **Piped workflows** - Read from stdin, write to stdout, chain with other commands
|
|
- **Machine-readable output** - Use `--json` to get structured output for parsing
|
|
|
|
<Warning>
|
|
Headless mode with `-y` gives Cline full autonomy. Run on a clean git branch so you can easily revert changes if needed.
|
|
</Warning>
|
|
|
|
### Mode Detection Summary
|
|
|
|
Cline automatically detects which mode to use based on your invocation. This table shows how different command patterns trigger each mode, helping you predict behavior in scripts and interactive sessions.
|
|
|
|
| Invocation | Mode | Reason |
|
|
|------------|------|--------|
|
|
| `cline` | Interactive | No arguments, TTY connected |
|
|
| `cline "task"` | Interactive | TTY connected |
|
|
| `cline -y "task"` | Headless | YOLO flag forces headless |
|
|
| `cline --json "task"` | Headless | JSON flag forces headless |
|
|
| `cat file \| cline "task"` | Headless | stdin is piped |
|
|
| `cline "task" > output.txt` | Headless | stdout is redirected |
|
|
|
|
[Learn more about CLI workflows →](/cline-cli/three-core-flows)
|
|
|
|
## Supported Model Providers
|
|
|
|
Cline CLI supports all providers available in the VS Code extension:
|
|
|
|
- **Anthropic** (Claude)
|
|
- **OpenAI** (GPT-4o, GPT-4)
|
|
- **OpenAI Codex** (ChatGPT subscription)
|
|
- **OpenRouter**
|
|
- **AWS Bedrock**
|
|
- **Google Gemini**
|
|
- **X AI (Grok)**
|
|
- **Cerebras**
|
|
- **DeepSeek**
|
|
- **Ollama** (local models)
|
|
- **LM Studio** (local models)
|
|
- **OpenAI Compatible** (any compatible API)
|
|
|
|
During setup, authenticate with `cline auth` to configure your preferred provider. [See setup guide →](/cline-cli/installation#authenticate)
|
|
|
|
## What You Can Build
|
|
|
|
### Automated Code Maintenance
|
|
|
|
Keep your codebase healthy with automated fixes. Cline scans for issues and applies corrections across multiple files.
|
|
|
|
```bash
|
|
cline -y "Fix all ESLint errors in src/"
|
|
```
|
|
Finds and fixes linting violations throughout your source directory.
|
|
|
|
```bash
|
|
cline -y "Update all deprecated React lifecycle methods"
|
|
```
|
|
Migrates legacy code patterns to modern equivalents (e.g., `componentWillMount` → `useEffect`).
|
|
|
|
```bash
|
|
cline -y "Update dependencies with known vulnerabilities"
|
|
```
|
|
Identifies outdated packages with security issues and updates them to safe versions.
|
|
|
|
### CI/CD Integration
|
|
|
|
Integrate Cline into your continuous integration pipelines for automated code review and documentation.
|
|
|
|
```bash
|
|
git diff origin/main | cline -y "Review these changes for issues"
|
|
```
|
|
Pipes your PR diff to Cline for automated code review, catching bugs and style issues before merge.
|
|
|
|
```bash
|
|
git log --oneline v1.0..v1.1 | cline -y "Write release notes"
|
|
```
|
|
Generates human-readable release notes from your commit history between two tags.
|
|
|
|
```bash
|
|
cline -y "Run tests and fix failures" --timeout 600
|
|
```
|
|
Executes your test suite, analyzes failures, and attempts fixes with a 10-minute timeout.
|
|
|
|
### Development Workflows
|
|
|
|
From quick edits to complex refactors, Cline adapts to your workflow.
|
|
|
|
```bash
|
|
cline
|
|
```
|
|
Launches interactive mode for exploratory development and back-and-forth collaboration.
|
|
|
|
```bash
|
|
cline "Refactor this function to use async/await"
|
|
```
|
|
Executes a focused task directly from the command line with approval prompts at key steps.
|
|
|
|
```bash
|
|
cline "Based on @src/api.ts, add error handling to all endpoints"
|
|
```
|
|
Uses file mentions (`@`) to give Cline context about specific files in your workspace.
|
|
|
|
### Custom Shell Pipelines
|
|
|
|
Chain Cline with other CLI tools to build powerful automation workflows.
|
|
|
|
```bash
|
|
gh pr diff 123 | cline -y "Review this PR"
|
|
```
|
|
Fetches a GitHub PR diff and pipes it directly to Cline for review.
|
|
|
|
```bash
|
|
cline --json "List all TODO comments" | jq '.text'
|
|
```
|
|
Outputs structured JSON that you can process with tools like `jq` for scripting.
|
|
|
|
```bash
|
|
git diff | cline -y "explain" | cline -y "write a haiku about these changes"
|
|
```
|
|
Chains multiple Cline invocations together for creative multi-step workflows.
|
|
|
|
## Features at a Glance
|
|
|
|
| Feature | Interactive Mode | Non-Interactive Mode |
|
|
|---------|------------------|----------------------|
|
|
| Interactive chat | ✓ | - |
|
|
| File mentions (@) | ✓ | ✓ (inline) |
|
|
| Slash commands (/) | ✓ | - |
|
|
| Settings panel | ✓ | `cline config` |
|
|
| Plan/Act toggle | ✓ (Tab) | `-p` / `-a` flags |
|
|
| Auto-approve | ✓ (Shift+Tab) | `-y` flag |
|
|
| Session summary | ✓ | - |
|
|
| JSON output | - | `--json` |
|
|
| Piped input | - | ✓ |
|
|
|
|
## Learn More
|
|
|
|
<Columns cols={2}>
|
|
<Card title="Installation & Setup" icon="download" href="/cline-cli/installation">
|
|
Install Cline CLI and authenticate with your preferred provider.
|
|
</Card>
|
|
|
|
<Card title="Interactive Mode" icon="terminal" href="/cline-cli/interactive-mode">
|
|
Master the interactive CLI with keyboard 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="Use in Other Editors" icon="code" href="/cline-cli/acp-editor-integrations">
|
|
Run Cline as an ACP agent in JetBrains, Neovim, Zed, and more.
|
|
</Card>
|
|
</Columns>
|