mirror of
https://github.com/cline/cline.git
synced 2026-09-19 02:05:44 +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>
279 lines
6.6 KiB
Plaintext
279 lines
6.6 KiB
Plaintext
---
|
|
title: "Configuration"
|
|
description: "Manage Cline CLI settings with cline config, environment variables, and configuration files"
|
|
---
|
|
|
|
Cline CLI provides multiple ways to configure settings, from the interactive `cline config` command to environment variables for automation.
|
|
|
|
## The Config Command
|
|
|
|
Launch the configuration interface:
|
|
|
|
```bash
|
|
cline config
|
|
```
|
|
|
|
This opens an interactive view with tabs for different configuration categories.
|
|
|
|
## Configuration Tabs
|
|
|
|
Navigate between tabs using arrow keys.
|
|
|
|
### Settings Tab
|
|
|
|
View and edit global and workspace-specific settings:
|
|
|
|
- **Global State**: Settings that apply across all workspaces
|
|
- **Workspace State**: Settings specific to the current directory
|
|
|
|
### Rules Tab
|
|
|
|
Manage Cline rules that guide AI behavior:
|
|
|
|
- **`.clinerules` files**: Project-specific rules in your workspace
|
|
- **Cursor rules**: Import rules from Cursor editor format
|
|
- **Windsurf rules**: Import rules from Windsurf editor format
|
|
|
|
Rules help Cline understand your project's conventions, coding standards, and preferences.
|
|
|
|
### Workflows Tab
|
|
|
|
View and manage [workflows](/features/slash-commands/workflows/index):
|
|
|
|
- List available workflows
|
|
- View workflow definitions
|
|
- Workflows appear as slash commands in interactive mode
|
|
|
|
### Hooks Tab
|
|
|
|
Configure [hooks](/features/hooks/index) for custom logic integration:
|
|
|
|
- Enable/disable hooks globally
|
|
- View configured hook scripts
|
|
- Hooks run at key points in Cline's workflow
|
|
|
|
<Note>
|
|
Hooks must be enabled via settings. Use `cline config` to toggle `hooks-enabled`.
|
|
</Note>
|
|
|
|
### Skills Tab
|
|
|
|
Manage [skills](/features/skills) that extend Cline's capabilities:
|
|
|
|
- View available skills
|
|
- Enable/disable specific skills
|
|
- Skills provide specialized instructions for specific tasks
|
|
|
|
## Configuration Directory
|
|
|
|
Cline stores configuration in `~/.cline/data/`:
|
|
|
|
```
|
|
~/.cline/
|
|
├── data/ # Configuration directory
|
|
│ ├── globalState.json # Global settings
|
|
│ ├── secrets.json # API keys (encrypted)
|
|
│ ├── workspace/ # Workspace-specific state
|
|
│ └── tasks/ # Task history and data
|
|
└── log/ # Log files
|
|
```
|
|
|
|
### Viewing Logs
|
|
|
|
For debugging, view the log file:
|
|
|
|
```bash
|
|
cline dev log
|
|
```
|
|
|
|
This opens the log file in your default editor.
|
|
|
|
## Environment Variables
|
|
|
|
### CLINE_DIR
|
|
|
|
Override the default configuration directory:
|
|
|
|
```bash
|
|
export CLINE_DIR=/custom/path/to/cline
|
|
cline "your task"
|
|
```
|
|
|
|
When set, all Cline data is stored in this directory instead of `~/.cline/data/`.
|
|
|
|
**Use cases:**
|
|
- Running multiple isolated Cline configurations
|
|
- Team-shared configurations
|
|
- CI/CD with custom state directories
|
|
|
|
### CLINE_COMMAND_PERMISSIONS
|
|
|
|
Restrict which shell commands Cline can execute:
|
|
|
|
```bash
|
|
export CLINE_COMMAND_PERMISSIONS='{"allow": ["npm *", "git *"], "deny": ["rm -rf *"]}'
|
|
```
|
|
|
|
**Format:**
|
|
|
|
```json
|
|
{
|
|
"allow": ["pattern1", "pattern2"],
|
|
"deny": ["pattern3"],
|
|
"allowRedirects": true
|
|
}
|
|
```
|
|
|
|
**Fields:**
|
|
|
|
| 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 take precedence over allow. |
|
|
| `allowRedirects` | `boolean` | Whether to allow shell redirects (`>`, `>>`, `<`). Default: `false` |
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# Allow only npm and git commands
|
|
export CLINE_COMMAND_PERMISSIONS='{"allow": ["npm *", "git *"]}'
|
|
|
|
# Allow dev commands but deny dangerous ones
|
|
export CLINE_COMMAND_PERMISSIONS='{"allow": ["npm *", "git *", "node *"], "deny": ["rm -rf *", "sudo *"]}'
|
|
|
|
# Allow file operations with redirects
|
|
export CLINE_COMMAND_PERMISSIONS='{"allow": ["cat *", "echo *"], "allowRedirects": true}'
|
|
```
|
|
|
|
<Warning>
|
|
When `allow` is set, all commands not matching the allow patterns are denied. Use this for security-sensitive environments.
|
|
</Warning>
|
|
|
|
## Using --config Flag
|
|
|
|
Run Cline with a custom configuration directory:
|
|
|
|
```bash
|
|
cline --config /path/to/custom/config "your task"
|
|
```
|
|
|
|
This is useful for:
|
|
- Running isolated Cline instances
|
|
- Testing different configurations
|
|
- Separating work and personal setups
|
|
|
|
**Example: Multiple configurations**
|
|
|
|
```bash
|
|
# Work configuration
|
|
cline --config ~/.cline-work "review this PR"
|
|
|
|
# Personal projects
|
|
cline --config ~/.cline-personal "help me with this side project"
|
|
```
|
|
|
|
## Configuration for Local Providers
|
|
|
|
### Ollama
|
|
|
|
Configure context window size for Ollama:
|
|
|
|
```bash
|
|
# In settings or via config
|
|
cline config
|
|
# Navigate to Settings tab, find ollama-api-options-ctx-num
|
|
```
|
|
|
|
Or set via environment:
|
|
|
|
```bash
|
|
# Set context window to 32K tokens
|
|
cline -m ollama/llama3 "your task"
|
|
```
|
|
|
|
### LM Studio
|
|
|
|
Configure max tokens for LM Studio:
|
|
|
|
```bash
|
|
cline config
|
|
# Navigate to Settings tab, find lm-studio-max-tokens
|
|
```
|
|
|
|
## Importing Configuration
|
|
|
|
### From VS Code Extension
|
|
|
|
If you use the Cline VS Code extension, the CLI automatically detects and can share some settings. However, the CLI maintains its own configuration for terminal-specific features.
|
|
|
|
### From Other CLI Tools
|
|
|
|
See [Installation & Setup](/cline-cli/installation#option-3-import-from-existing-tools) for importing configurations from:
|
|
- Codex CLI
|
|
- OpenCode
|
|
|
|
## Configuration Best Practices
|
|
|
|
### For Development
|
|
|
|
Use the default configuration with workspace-specific rules:
|
|
|
|
```bash
|
|
# Add project-specific rules
|
|
echo "Use TypeScript strict mode" > .clinerules/typescript.md
|
|
```
|
|
|
|
### For CI/CD
|
|
|
|
Use environment variables and `--yolo` mode:
|
|
|
|
```bash
|
|
export CLINE_COMMAND_PERMISSIONS='{"allow": ["npm test", "npm run build"]}'
|
|
cline -y "run tests and fix any failures"
|
|
```
|
|
|
|
### For Teams
|
|
|
|
Share configuration via version control:
|
|
|
|
```bash
|
|
# Commit .clinerules/ to your repo
|
|
git add .clinerules/
|
|
git commit -m "Add Cline rules for team"
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Configuration Not Persisting
|
|
|
|
1. Check write permissions on `~/.cline/data/`
|
|
2. Ensure `CLINE_DIR` isn't set to a read-only location
|
|
3. Verify the config directory exists
|
|
|
|
### Environment Variables Not Working
|
|
|
|
1. Ensure variables are exported: `export CLINE_DIR=/path`
|
|
2. Check for typos in variable names
|
|
3. Verify JSON syntax for `CLINE_COMMAND_PERMISSIONS`
|
|
|
|
### Reset Configuration
|
|
|
|
To start fresh, remove the configuration directory:
|
|
|
|
```bash
|
|
rm -rf ~/.cline/data/
|
|
cline auth # Re-authenticate
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
<Columns cols={2}>
|
|
<Card title="CLI Workflows" icon="route" href="/cline-cli/three-core-flows">
|
|
Learn about interactive mode, direct execution, and automation patterns.
|
|
</Card>
|
|
|
|
<Card title="CLI Reference" icon="terminal" href="/cline-cli/cli-reference">
|
|
Complete command documentation with all flags and options.
|
|
</Card>
|
|
</Columns>
|