mirror of
https://github.com/cline/cline.git
synced 2026-09-19 02:05:44 +08:00
* docs: add comprehensive SDK documentation as top-level tab Adds 27 new documentation pages for the Cline SDK (@clinebot/core, @clinebot/agents, @clinebot/llms, @clinebot/shared) organized into a dedicated "SDK" tab in the Mintlify docs navigation. Structure: - Getting Started: overview, quickstart, examples - Core Concepts: agents, sessions, tools, streaming/events, extensions, hooks, providers/models - Guides: building an agent, custom tools, writing extensions, permission handling, scheduled agents, multi-agent teams, connectors, production - Architecture: layered stack overview, hub-spoke RPC, package reference - API Reference: ClineCore, Agent, Gateway, Tools API, Events, Types - CLI: commands, configuration, connector setup Removes the old single-page SDK overview (cline-sdk/overview.md) that documented the previous ACP-based ClineAgent API, and removes its reference from the Cline CLI navigation group. * docs: fix SDK docs review feedback - Change "desktop app" to "JetBrains plugin" in overview (not released yet) - Rename "Providers & Models" to "Model Providers" - Rename "Streaming & Events" to "Streaming Events" - Remove duplicate cli/connectors.mdx (guides/connectors.mdx covers everything) * docs: add wizard commands, Discord connector, and platform credential details * feat(docs): create CLI tab with new feature pages and updated reference - Add CLI as its own top-level tab in docs navigation - Remove CLI group from Docs tab and SDK tab - Delete SDK CLI pages (content moved to CLI tab) - Add new feature pages: connectors, scheduling, MCP servers, agent teams - Rewrite cli-reference.mdx with all new commands (connect, mcp, schedule, rpc, checkpoint, doctor) and new flags (reasoning-effort, thinking, sandbox, teams, spawn, tool-enable/disable, autoapprove) - Update configuration.mdx with new directory structure, env vars (CLINE_DATA_DIR, CLINE_RPC_ADDRESS, CLINE_SESSION_BACKEND_MODE, CLINE_SANDBOX), and MCP wizard reference * docs: rename Docs tab to Extension and reorder tabs Tab order: Extension, CLI, SDK, Kanban, Enterprise, API, Learn * docs: simplify SDK install to single @clinebot/core package @clinebot/core re-exports from agents, llms, and shared, so users only need one install and one import source. Updated all getting-started, quickstart, examples, and guide pages to import from @clinebot/core. Concept and reference pages keep individual package imports since they document those specific packages. * docs: use @clinebot/sdk as the primary install and import path @clinebot/sdk is an alias for @clinebot/core that re-exports from all packages. All user-facing pages (overview, quickstart, examples, guides) now show npm install @clinebot/sdk and import from @clinebot/sdk. Architecture and reference pages keep individual package names since they document the internal package structure. * docs: rename Extension tab to Cline * docs: fix packages page and merge duplicate imports * fix: use getting-started page in CLI tab nav and remove conflicting redirect * docs: rename CLI Getting Started page title to Overview * docs: rename cline-cli/ to cli/ and cline-sdk/ to sdk/ Shorter, cleaner URL paths. Updated all internal links across every doc page and added 44 redirects for old paths so existing URLs don't break. * docs: update hub-spoke architecture from gRPC/RPC to WebSockets - Rewrite hub-spoke.mdx: WebSocket protocol, capability brokerage, spoke workers, session participants, hub daemon discovery - Replace all RPC/gRPC/sidecar references with hub/WebSocket across all SDK and CLI docs - Backend modes: local/hub/remote/auto (was local/rpc/auto) - Hub command replaces rpc command (cline hub start/stop/status/ensure) - Default port 25463 (was 4317), log file hub-daemon.log - Remove @clinebot/rpc and @clinebot/scheduler from architecture docs (functionality absorbed into @clinebot/core) - Update ClineCore reference to remove rpc options - Add capability brokerage and session participant concepts * docs: add Ecosystem page to SDK tab * docs: move Ecosystem page after Guides and fix opening sentence * docs: rename extensions to plugins across all SDK and CLI docs - Rename AgentExtension to AgentPlugin in all code examples - Rename ExtensionAPI to PluginAPI - Rename extensions.mdx to plugins.mdx, writing-extensions.mdx to writing-plugins.mdx - Rename all variable names (databaseExtension -> databasePlugin, etc.) - Rename config field from extensions to plugins - Update all prose, section headers, and cross-links - Add redirects for old paths * clean up attempt 1 * remove deprecated features * part 1 of large provider changes * a large pass on workflows * cli ref updates * config rewrite * more concise instsallation and model selection * provider reorg cont * update providers * one step further cleaning up * kanban finishing clean up * wip... * another big cleanup - remove the CLI tabgroup * sdk tighten up pt1 * more sdk doc tightening * making more progress * doc update based on bee latest branch * nit update on codepaths * remove learn section * docs: add plugin install command documentation Document the new clite plugin install command across CLI reference, customization plugins page, SDK plugins concept page, and the writing plugins guide. Cover all three source types (npm, git, local), the package.json manifest format with cline.plugins field, host-provided dependency handling, auto-detection logic, and the install directory structure. Reference cline/typescript-lsp-plugin as a concrete install example. * docs: deduplicate plugin install docs Trim redundant plugin install content from CLI reference, SDK plugins concept page, and writing-plugins guide. Each now links to the customization/plugins page as the single source of truth for manifest format, install commands, and directory layout. * further simplify the doc * further clean up * mark warnings * docs: rename @clinebot to @cline and clite to cline SDK packages moved to the @cline npm org. Update all docs references to use @cline/sdk, @cline/agents, @cline/core, @cline/shared, @cline/llms and the cline CLI binary name. * docs: streamline SDK docs with example references (#10617) * docs: streamline SDK docs with example references and @cline/sdk imports Replace large standalone code blobs in SDK docs with references to working examples in the SDK repository. Users can now clone and run real code instead of copy-pasting from docs. - Update all imports from @cline/agents, @cline/core, @cline/shared to @cline/sdk (the public-facing package) - Fix model IDs from claude-sonnet-4-6 to claude-sonnet-4-20250514 - Quickstart: trim duplicate code patterns, add cards linking to cli-agent, code-review-bot, multi-agent, desktop-app examples - Overview: add examples table with difficulty progression, update install instructions to use @cline/sdk - Building an Agent: rewrite as a walkthrough of the code-review-bot example rather than inline code blobs across 4 separate files - Creating Custom Tools: rewrite to use createTool with zod, add completion tools section, reference working examples - Tools: show createTool with zod as primary pattern - Events: reference multi-agent example for streaming UI pattern - Architecture: update install to @cline/sdk * fix: use claude-sonnet-4-6 model ID across all SDK docs * remove connector page from sdk * small reordering * clean up sdk app and plugin examples --------- Co-authored-by: Renee Huang <renee@cline.bot> * remove features/connectors * doc revisions * fix references after folder change * docs: fix SDK review feedback after rebase * docs: address Greptile SDK review feedback * docs: move TUI page under CLI nav * docs: restore TUI page placement --------- Co-authored-by: Renee Huang <renee@cline.bot> Co-authored-by: John Simone <john@cline.bot> Co-authored-by: Arafatkatze <arafat.da.khan@gmail.com>
306 lines
9.4 KiB
Plaintext
306 lines
9.4 KiB
Plaintext
---
|
|
title: "CLI Reference"
|
|
description: "Complete command reference for Cline CLI including all commands, flags, and configuration options."
|
|
---
|
|
|
|
```bash
|
|
cline --help # Show all commands
|
|
cline <command> --help # Show help for a specific command
|
|
```
|
|
|
|
## Synopsis
|
|
|
|
```bash
|
|
cline [options] [command] [prompt]
|
|
```
|
|
|
|
## Help Menu (Source of Truth)
|
|
|
|
```text
|
|
Usage: cline [options] [command] [prompt]
|
|
|
|
Cline CLI - AI coding assistant in your terminal
|
|
|
|
Arguments:
|
|
prompt Your prompt. Default to start in act mode with auto-approve enabled.
|
|
|
|
Options:
|
|
-V, --version Output the version number
|
|
-p, --plan Run in plan mode
|
|
--json Output messages as JSON instead of styled text
|
|
--auto-approve <boolean> Set tool auto-approval for all tools (default: true)
|
|
-t, --timeout <seconds> Optional timeout in seconds (default: 0 for no timeout)
|
|
-m, --model <model-id> Model to use for the session with the selected provider
|
|
-v, --verbose Show verbose output
|
|
-c, --cwd <path> Working directory
|
|
--config <path> Configuration directory (default: ~/.cline/data/settings)
|
|
--data-dir <path> Use isolated local state at this directory path (default: ~/.cline)
|
|
--thinking <level> Set reasoning effort level between none|low|medium|high|xhigh (default: medium)
|
|
--retries <count> Maximum consecutive mistakes (retries) before halting
|
|
--hooks-dir <path> Directory path to additional hooks for runtime hook injection (default: ~/.cline/hooks)
|
|
--acp Run in Agent Client Protocol (ACP) mode for editor integration
|
|
-i, --tui Open the terminal user interface (TUI) for interactive sessions
|
|
--id <session-id> Resume an existing session by ID
|
|
-k, --key <api-key> API key override for this run
|
|
-P, --provider <id> Provider id (default: cline)
|
|
-s, --system <system-prompt> Override the default system prompt
|
|
-z, --zen Start a session that runs in the background hub
|
|
-h, --help display help for command
|
|
|
|
Commands:
|
|
auth [options] [provider] Authenticate a provider and configure what model is used
|
|
config [options] Show current configuration
|
|
connect [options] [adapter] Connect to an editor or IDE adapter
|
|
mcp Manage MCP servers
|
|
dev Developer tools and utilities
|
|
doctor Diagnose and fix configuration issues
|
|
history|h [options] List session history or manage saved sessions
|
|
hook Handle a hook payload from stdin
|
|
plugin Manage Cline Plugins
|
|
schedule Manage scheduled tasks
|
|
hub Manage the local hub daemon
|
|
update [options] Check for updates and install if available
|
|
version Show Cline CLI version number
|
|
kanban Launch the kanban app and exit
|
|
```
|
|
|
|
## Global Options
|
|
|
|
| Option | Description |
|
|
|--------|-------------|
|
|
| `-V, --version` | Output the version number |
|
|
| `-p, --plan` | Run in plan mode |
|
|
| `--json` | Output messages as JSON instead of styled text |
|
|
| `--auto-approve <boolean>` | Set tool auto-approval for all tools (default: `true`) |
|
|
| `-t, --timeout <seconds>` | Optional timeout in seconds (default: `0` for no timeout) |
|
|
| `-m, --model <model-id>` | Model to use for the session with the selected provider |
|
|
| `-v, --verbose` | Show verbose output |
|
|
| `-c, --cwd <path>` | Working directory |
|
|
| `--config <path>` | Configuration directory (default: `~/.cline/data/settings`) |
|
|
| `--data-dir <path>` | Use isolated local state at this directory path (default: `~/.cline`) |
|
|
| `--thinking <level>` | Set reasoning effort: `none\|low\|medium\|high\|xhigh` (default `medium`) |
|
|
| `--retries <count>` | Maximum consecutive mistakes (retries) before halting |
|
|
| `--hooks-dir <path>` | Directory path to additional hooks for runtime hook injection (default: `~/.cline/hooks`) |
|
|
| `--acp` | Run in Agent Client Protocol (ACP) mode for editor integration |
|
|
| `-i, --tui` | Open the terminal user interface (TUI) for interactive sessions |
|
|
| `--id <session-id>` | Resume an existing session by ID |
|
|
| `-k, --key <api-key>` | API key override for this run |
|
|
| `-P, --provider <id>` | Provider id (default: `cline`) |
|
|
| `-s, --system <system-prompt>` | Override the default system prompt |
|
|
| `-z, --zen` | Start a session that runs in the background hub |
|
|
| `-h, --help` | Display help for command |
|
|
|
|
## Commands
|
|
|
|
### `cline` (default)
|
|
|
|
Start a task or enter interactive mode.
|
|
|
|
```bash
|
|
cline
|
|
cline "your prompt here"
|
|
cline "Run tests and fix failures"
|
|
echo "prompt" | cline
|
|
```
|
|
|
|
### `auth [options] [provider]`
|
|
|
|
Configure authentication with an AI provider.
|
|
|
|
```bash
|
|
cline auth
|
|
```
|
|
|
|
### `config [options]`
|
|
|
|
Show current configuration.
|
|
|
|
```bash
|
|
cline config
|
|
```
|
|
|
|
### `connect [options] [adapter]`
|
|
|
|
Connect to messaging platforms. See [Connectors](/cli/connectors).
|
|
|
|
```bash
|
|
cline connect
|
|
cline connect [adapter]
|
|
```
|
|
|
|
### `mcp`
|
|
|
|
Manage MCP servers. See [MCP](/mcp/mcp-overview).
|
|
|
|
```bash
|
|
cline mcp
|
|
```
|
|
|
|
### `dev`
|
|
|
|
Developer tools and utilities.
|
|
|
|
```bash
|
|
cline dev
|
|
```
|
|
|
|
### `doctor`
|
|
|
|
Diagnose and fix configuration issues.
|
|
|
|
```bash
|
|
cline doctor
|
|
```
|
|
|
|
### `history|h [options]`
|
|
|
|
List session history or manage saved sessions.
|
|
|
|
```bash
|
|
cline history
|
|
cline h
|
|
```
|
|
|
|
### `hook`
|
|
|
|
Handle a hook payload from stdin.
|
|
|
|
```bash
|
|
cat payload.json | cline hook
|
|
```
|
|
|
|
### `plugin`
|
|
|
|
Manage Cline plugins. Install plugins from npm, git repositories, or local paths. See [Plugins](/customization/plugins) for full details and the plugin manifest format.
|
|
|
|
```bash
|
|
cline plugin install <source> # Install a plugin
|
|
cline plugin i <source> # Shorthand alias
|
|
```
|
|
|
|
| Option | Description |
|
|
|--------|-------------|
|
|
| `--npm` | Treat source as an npm package |
|
|
| `--git` | Treat source as a git repository |
|
|
| `--force` | Replace an existing install for the same source |
|
|
| `--json` | Output result as JSON |
|
|
| `--cwd <path>` | Install to `<path>/.cline/plugins` instead of the global directory |
|
|
|
|
Try it with the [TypeScript Navigation Plugin](https://github.com/cline/typescript-lsp-plugin):
|
|
|
|
```bash
|
|
cline plugin install https://github.com/cline/typescript-lsp-plugin.git
|
|
```
|
|
|
|
### `schedule`
|
|
|
|
Manage scheduled agents. See [Scheduling](/cli/scheduling).
|
|
|
|
```bash
|
|
cline schedule
|
|
```
|
|
|
|
### `hub`
|
|
|
|
Manage the local hub daemon.
|
|
|
|
```bash
|
|
cline hub
|
|
```
|
|
|
|
### `update [options]`
|
|
|
|
Check for updates and install if available.
|
|
|
|
```bash
|
|
cline update
|
|
```
|
|
|
|
### `version`
|
|
|
|
Show Cline CLI version number.
|
|
|
|
```bash
|
|
cline version
|
|
cline -V
|
|
```
|
|
|
|
### `kanban`
|
|
|
|
Launch the kanban app and exit.
|
|
|
|
```bash
|
|
cline kanban
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Description |
|
|
|----------|-------------|
|
|
| `CLINE_DATA_DIR` | Custom configuration directory (replaces `~/.cline/data/`) |
|
|
| `CLINE_HUB_ADDRESS` | Override hub address (default: `127.0.0.1:25463`) |
|
|
| `CLINE_SESSION_BACKEND_MODE` | Force backend mode (`local`, `hub`, `remote`, `auto`) |
|
|
| `CLINE_SANDBOX_DATA_DIR` | Sandbox session storage directory |
|
|
| `CLINE_SANDBOX` | Enable sandbox mode |
|
|
| `CLINE_HOOKS_DIR` | Additional hooks directory |
|
|
| `CLINE_BUILD_ENV` | Set to `development` for debug features |
|
|
| `CLINE_DEBUG_PORT_BASE` | Base port for Node.js inspector |
|
|
| `CLINE_COMMAND_PERMISSIONS` | JSON policy restricting shell commands (see below) |
|
|
|
|
### CLINE_COMMAND_PERMISSIONS
|
|
|
|
Restrict which shell commands the agent can execute:
|
|
|
|
```bash
|
|
export CLINE_COMMAND_PERMISSIONS='{"allow": ["npm *", "git *"], "deny": ["rm -rf *", "sudo *"]}'
|
|
```
|
|
|
|
| Field | Type | Description |
|
|
|-------|------|-------------|
|
|
| `allow` | `string[]` | Glob patterns for allowed commands. If set, only matching commands are permitted. |
|
|
| `deny` | `string[]` | Glob patterns for denied commands. Deny rules always take precedence. |
|
|
| `allowRedirects` | `boolean` | Whether to allow shell redirects (`>`, `>>`, `<`). Default: `false`. |
|
|
|
|
## JSON Output Format
|
|
|
|
When using `--json`, each message is a JSON object on its own line:
|
|
|
|
```json
|
|
{"type": "say", "text": "I'll create the file now.", "ts": 1760501486669, "say": "text"}
|
|
```
|
|
|
|
| Field | Type | Description |
|
|
|-------|------|-------------|
|
|
| `type` | `"ask"` or `"say"` | Message category |
|
|
| `text` | `string` | Message content |
|
|
| `ts` | `number` | Unix timestamp in milliseconds |
|
|
| `say` | `string` | Subtype when `type` is `"say"` |
|
|
| `ask` | `string` | Subtype when `type` is `"ask"` |
|
|
| `reasoning` | `string` | Model reasoning (if available) |
|
|
| `partial` | `boolean` | `true` while streaming |
|
|
|
|
## Configuration Files
|
|
|
|
```
|
|
~/.cline/
|
|
data/
|
|
settings/
|
|
providers.json # API keys and provider config
|
|
rules/ # Global rules
|
|
skills/ # Global skills
|
|
teams/ # Team state
|
|
sessions/ # Session database (SQLite)
|
|
logs/
|
|
hub-daemon.log # Hub logs
|
|
plugins/ # Global plugins
|
|
_installed/ # Managed by `cline plugin install`
|
|
|
|
.cline/ # Project root
|
|
rules/ # Project rules
|
|
skills/ # Project skills
|
|
hooks/ # Lifecycle hooks
|
|
plugins/ # Project plugins
|
|
mcp.json # MCP server config
|
|
agents.yaml # Agent definitions
|
|
```
|