mirrors/cline--cline
1
0
Fork 0
Code Issues Pull Requests Actions Deployments Models Agent Notes Packages Projects Releases Wiki Activity

chore: import upstream snapshot with attribution

Browse Source
This commit is contained in:
wehub-resource-sync
2026-07-13 12:52:40 +08:00
commit 9c06d70b3c
3233 changed files with 672160 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/authorizing-with-cline.mdx
+102
View File
@@ -0,0 +1,102 @@
---
title: "Authorization"
description: "Authenticate with Cline and choose your first AI model"
---
Cline connects to AI models through a **provider**. You have three common paths:
- **Cline (usage-billing)** (recommended): sign in with Google/GitHub/email, no API key setup.
- **ClinePass**: a $9.99/month subscription provider with access to selected open coding models and 2-5x API rate limits.
- **Bring Your Own Key (BYOK)**: use your own provider credentials (cloud or local runtimes).
## Menu
- [IDE Setup](#ide-setup)
- [CLI Setup](#cli-setup)
## IDE Setup
<Steps>
<Step title="Open Cline Settings">
Click the settings icon (⚙️) in the Cline panel.
</Step>
<Step title="Select Provider">
Choose your desired provider from the **API Provider** dropdown.
</Step>
<Step title="Authenticate">
- **Cline (usage-billing):** Click **Sign In** and complete OAuth.
- **ClinePass:** Select **ClinePass**, click **Sign In**, and subscribe if prompted.
- **BYOK cloud provider:** Paste your API key into the **API Key** field.
- **Local runtime (Ollama/LM Studio):** no key needed; ensure runtime is running.
</Step>
<Step title="Select Model">
Choose your desired model from the **Model** dropdown.
</Step>
</Steps>
## Provider Options
### Cline (usage-billing)
- One sign-in, no key management
- Built-in billing and free model options
- Access to multiple providers from one account
Add credits in Cline settings or at [app.cline.bot/dashboard](https://app.cline.bot/dashboard).
### ClinePass
- Flat **$9.99/month** subscription
- 2-5x API rate limits for longer agent sessions
- Curated open coding models including GLM, Kimi, DeepSeek, and MiMo
Subscribe from the [ClinePass dashboard](https://app.cline.bot/dashboard/subscription?personal=true), then select **ClinePass** as your provider in Cline. See the [ClinePass guide](/getting-started/clinepass) for included models and reference pricing.
### BYOK (cloud + local)
### Cloud Providers
| Provider | Best For | Setup Guide |
|----------|----------|-------------|
| **OpenRouter** | Multiple models, competitive pricing | [Setup](/provider-config/openrouter) |
| **Anthropic** | Direct Claude access | [Setup](/provider-config/anthropic) |
| **Claude Code** | Claude Max/Pro subscription | [Setup](/provider-config/anthropic) |
| **OpenAI** | GPT models | [Setup](/provider-config/openai) |
| **Google Gemini** | Gemini models | [Setup](/provider-config/google-gemini) |
| **AWS Bedrock** | Enterprise | [Setup](/provider-config/aws-bedrock/api-key) |
| **DeepSeek** | Great value | [Setup](/provider-config/deepseek) |
### Local Models
Run models on your own hardware for complete privacy and zero per-request costs.
| Provider | Best For | Setup Guide |
|----------|----------|-------------|
| **Ollama** | CLI-based local runtime | [Setup](/running-models-locally/overview#runtime-options) |
| **LM Studio** | GUI-based local runtime | [Setup](/running-models-locally/overview#runtime-options) |
Local models require sufficient hardware (especially GPU memory). See [Running Models Locally](/running-models-locally/overview) for requirements.
## CLI Setup
```bash
# Authenticate from the terminal
cline auth
# Shorthand
cline a
```
Runs the same auth flow as IDE setup.
## Troubleshooting
| Issue | Fix |
|-------|-----|
| "Unauthorized: Please sign in" | Session expired. Click **Sign In** to re-authenticate. |
| Browser doesn't open | Check default browser settings. Copy the URL from the Cline output panel manually. |
| Frequent re-authentication | Check org security policies. Ensure you're not clearing IDE secrets. Try a full sign-out/sign-in. |
| Can't access organization | Verify membership at [app.cline.bot](https://app.cline.bot). Ask your admin about permissions. Sign out and back in. |
docs/getting-started/cline-provider.mdx
+38
View File
@@ -0,0 +1,38 @@
---
title: "Cline (usage-billing)"
description: "Use Cline (usage-billing) for pay-as-you-go model access with built-in authentication and Cline credits."
---
Cline (usage-billing) is the simplest way to get started with pay-as-you-go model access in Cline.
Instead of managing separate API keys across multiple vendors, you sign in once, add **Cline credits**, and select from available models directly in Cline.
If you want a flat monthly subscription for selected open coding models with higher rate limits, use [ClinePass](/getting-started/clinepass) instead. ClinePass is a separate provider in Cline.
## Why use Cline (usage-billing)
- **Fastest setup**: no manual API key copy/paste; access to 100+ models supported by Cline
- **One account**: sign in once with Google, GitHub, or email
- **Pay as you go**: add Cline credits and use one balance across supported models
- **Free options**: look for models tagged **FREE** in the selector
## How it works
Cline (usage-billing) is the pay-as-you-go provider in Cline. Add Cline credits, then select **Cline** wherever you configure your provider.
- **IDE Extension**: Go to IDE extension settings, set **API Provider** to **Cline**, and sign in.
- **CLI**: Go to `/settings` and select **Cline** as your provider.
## Credits and usage
- Add **Cline credits** from your [Cline dashboard](https://app.cline.bot/dashboard)
- Credits are used on a pay-as-you-go basis when you select paid models through Cline (usage-billing)
- View usage in Cline Settings → **View Usage**
- Switch organizations in Cline Settings → **Switch Organization**
## Related
- [Authorization](/getting-started/authorizing-with-cline)
- [ClinePass](/getting-started/clinepass)
- [Local models](/running-models-locally/overview)
- [Provider setup guides](/provider-config/openrouter)
docs/getting-started/clinepass.mdx
+119
View File
@@ -0,0 +1,119 @@
---
title: "ClinePass"
description: "A low-cost monthly subscription that gives you reliable access to popular open coding models with 2-5x API rate limits."
---
ClinePass is a low-cost monthly subscription — **$9.99/month** — that gives you reliable access to popular open coding models with **2-5x the API rate limits** of standard access.
It's completely optional. You don't need ClinePass to use Cline, and you can always use any other provider alongside it.
<Card title="Subscribe to ClinePass" icon="credit-card" href="https://app.cline.bot/dashboard/subscription?personal=true">
Get started for $9.99/month and unlock 2-5x API rate limits.
</Card>
## How it works
ClinePass is a separate provider in Cline. After subscribing, select **ClinePass** wherever you configure your provider.
- **IDE Extension**: Go to IDE extension settings, set **API Provider** to **ClinePass**, and sign in.
<Frame>
<img src="/assets/clinepass/clinepass-ide-extension.png" alt="Cline IDE extension settings with ClinePass selected as the API Provider" />
</Frame>
- **CLI**: Go to `/settings` and select **ClinePass** as your provider.
<Frame>
<img src="/assets/clinepass/clinepass-cli.png" alt="Cline CLI settings showing ClinePass selected as the provider" />
</Frame>
## Why ClinePass
Open models have gotten really good. They now reach performance close to proprietary models for coding tasks, and because many providers can serve them competitively, they're usually far cheaper.
However, getting reliable access can be difficult. Providers vary in quality and availability, and standard rate limits can throttle heavy agentic workflows that read files, run commands, and iterate across many turns.
ClinePass solves this by:
- Curating a select group of open models tested and benchmarked for coding agent use
- Offering **2-5x the API rate limits** so you can run long, complex agent tasks without interruption
- Providing stable access through Cline's infrastructure
<Note>
ClinePass is a separate provider from Cline (usage-billing). You can use both independently — subscribe to ClinePass for 2-5x API rate limits, or use Cline (usage-billing) for pay-as-you-go access.
</Note>
## Models
ClinePass includes the following models, tested and benchmarked for coding agent use:
| Model | Model ID |
|-------|------------|
| GLM-5.2 | `cline-pass/glm-5.2` |
| Kimi K2.7 Code | `cline-pass/kimi-k2.7-code` |
| Kimi K2.6 | `cline-pass/kimi-k2.6` |
| DeepSeek V4 Pro | `cline-pass/deepseek-v4-pro` |
| DeepSeek V4 Flash | `cline-pass/deepseek-v4-flash` |
| MiMo-V2.5 | `cline-pass/mimo-v2.5` |
| MiMo-V2.5-Pro | `cline-pass/mimo-v2.5-pro` |
| MiniMax M3 | `cline-pass/minimax-m3` |
| Qwen3.7 Max | `cline-pass/qwen3.7-max` |
| Qwen3.7 Plus | `cline-pass/qwen3.7-plus` |
## Using ClinePass outside of Cline
You can use ClinePass models from your own scripts, apps, or automation through the Cline API. The API uses the same OpenAI-compatible Chat Completions format as the rest of Cline's API.
To get started, create an API key from **Settings > API Keys** in [app.cline.bot](https://app.cline.bot). For the complete walkthrough, see the [Cline API Getting Started guide](/api/getting-started).
Use the full ClinePass model slug in the `model` field:
```bash
export CLINE_API_KEY="your_api_key_here"
curl -X POST https://api.cline.bot/api/v1/chat/completions \
-H "Authorization: Bearer $CLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "cline-pass/qwen3.7-max",
"messages": [
{"role": "user", "content": "Write a TypeScript function that validates an email address."}
],
"stream": false
}'
```
## Reference pricing
ClinePass is a flat monthly subscription, so you are not charged the individual API prices below. These reference prices show the underlying per-1M-token rates for each model and can help you understand how usage is measured against your ClinePass quota (2-5x quota compares to paying standard api rate).
| Model | Input | Output | Cached Read | Cached Write |
|-------|-------|--------|-------------|--------------|
| GLM-5.2 | $1.40 | $4.40 | $0.26 | - |
| Kimi K2.7 Code | $0.95 | $4.00 | $0.19 | - |
| Kimi K2.6 | $0.95 | $4.00 | $0.16 | - |
| DeepSeek V4 Pro | $1.74 | $3.48 | $0.0145 | - |
| DeepSeek V4 Flash | $0.14 | $0.28 | $0.0028 | - |
| MiMo-V2.5 | $0.14 | $0.28 | $0.0028 | - |
| MiMo-V2.5-Pro | $1.74 | $3.48 | $0.0145 | - |
| MiniMax M3 | $0.30 | $1.20 | $0.06 | - |
| Qwen3.7 Max | $2.50 | $7.50 | $0.50 | $3.125 |
| Qwen3.7 Plus (≤ 256K tokens) | $0.40 | $1.60 | $0.04 | $0.50 |
| Qwen3.7 Plus (> 256K tokens) | $1.20 | $4.80 | $0.12 | $1.50 |
## Usage
ClinePass measures usage against three limits:
- **5-hour rolling window** — your usage within rolling 5-hour period
- **Weekly** — your usage over the calendar week
- **Monthly** — your usage over the calendar month
To check your current usage, visit your [Cline dashboard](https://app.cline.bot/dashboard/subscription?personal=true).
## Related
- [Cline (usage-billing)](/getting-started/cline-provider)
- [Authorization](/getting-started/authorizing-with-cline)
- [Local models](/running-models-locally/overview)
docs/getting-started/config.mdx
+165
View File
@@ -0,0 +1,165 @@
---
title: "Config"
sidebarTitle: "Config"
description: "Understand where Cline stores configuration and how global and project config work together."
---
Cline configuration lives in two scopes:
- **Global configuration** in `~/.cline/` (applies globally across all Cline applications, including IDE, CLI, and SDK)
- **Project configuration** in `.cline/` (applies only to the current workspace)
## Configuration Directory Layout
Cline stores shared configuration across a few well-known locations. The primary root is `~/.cline/`, with structured app state under `~/.cline/data/`:
```text
~/.cline/
data/
settings/
providers.json # API keys and provider configuration
global-settings.json # Global settings
cline_mcp_settings.json # MCP settings
teams/ # Team state
sessions/ # Session data
db/ # SQLite databases (for example cron.db)
workflows/ # Global workflows
rules/ # Global rules
hooks/ # Global hooks
skills/ # Global skills
agents/ # Global agent definitions
plugins/ # Global plugins (.js, .ts)
cron/ # Global cron specs
```
Additional global search paths supported by the code:
```text
~/Documents/Cline/
Rules/ # Additional global rules
Hooks/ # Additional global hooks
Plugins/ # Additional global plugins
Workflows/ # Additional global workflows
```
Project-level configuration lives in `.cline/` at your repository root:
```text
.cline/
rules/ # Project rules
skills/ # Project skills
hooks/ # Lifecycle hooks
agents/ # Project agent definitions
plugins/ # Project plugins
cron/ # Workspace cron specs
```
Notes:
- Global provider settings, global settings, and MCP settings are stored under `~/.cline/data/settings/`.
- Global workflows resolve from `~/.cline/data/workflows/`.
- Global rules, hooks, skills, agents, plugins, and cron specs resolve directly under `~/.cline/`.
- Rules, hooks, plugins, and workflows may also be discovered from `~/Documents/Cline/` for compatibility.
## What Goes Where?
- Use **global (`~/.cline/`)** for defaults shared across all Cline applications (IDE, CLI, SDK) on your machine.
- Use **project (`.cline/`)** for team-shared behavior that should travel with the repo.
Commit `.cline/` files you want to share with your team. Keep secrets out of the repo.
## Configure Through the CLI
Use the interactive config UI:
```bash
cline config
```
From there, you can view/edit:
- Settings (global + workspace)
- Rules
- Skills
- Hooks
## Useful Configuration Commands
Use a custom configuration directory:
```bash
cline --config /path/to/custom/config "your task"
```
Or via environment variable:
```bash
export CLINE_DATA_DIR=/custom/path/to/cline
cline "your task"
```
View CLI logs when troubleshooting:
```bash
cline dev log
```
## Environment Variables
| Variable | Description |
|----------|-------------|
| `CLINE_DATA_DIR` | Custom data 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` | Enable sandbox mode |
| `CLINE_SANDBOX_DATA_DIR` | Sandbox session storage directory |
| `CLINE_HOOKS_DIR` | Additional hooks directory |
| `CLINE_COMMAND_PERMISSIONS` | JSON policy restricting shell commands |
### CLINE_DATA_DIR
```bash
export CLINE_DATA_DIR=/custom/path/to/cline
cline "your task"
```
### 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
}
```
Rules:
- `deny` overrides `allow`
- If `allow` is set, commands not matching `allow` are denied
- `allowRedirects` controls shell redirects (`>`, `>>`, `<`), default `false`
## Related Docs
- [CLI Configuration](/cli/configuration)
- [Rules](/customization/cline-rules)
- [Skills](/customization/skills)
- [Hooks](/customization/hooks)
- [Plugins](/customization/plugins)
- [.clineignore](/customization/clineignore)
## Security Notes
<Warning>
Only use rules, hooks, skills, and plugins from sources you trust.
</Warning>
Hooks and plugins can execute code. Review them like any other executable artifact before adding them globally or to a project.
docs/getting-started/installing-cline.mdx
+139
View File
@@ -0,0 +1,139 @@
---
title: "Installing Cline"
description: "Choose your installation path: IDE Extension, CLI, SDK, or Kanban"
---
## Choose Your Install Path
- [IDE Extension](#ide-extension) — VS Code, Cursor, JetBrains, Windsurf, VSCodium, Antigravity
- [CLI](#cli) — terminal workflows
- [Kanban](#kanban) (preview) — easily manage through multiple agents through a kanban board
- [SDK](#sdk) — build with `@cline/sdk`
## IDE Extension
Use this if you want Cline inside your editor UI.
<Tabs>
<Tab title="VS Code / Cursor / Windsurf / VSCodium / Antigravity">
<Steps>
<Step title="Open Extensions">
Press `Ctrl/Cmd + Shift + X`.
</Step>
<Step title="Search for Cline">
Type `Cline`.
</Step>
<Step title="Install">
Click **Install** on the Cline extension.
</Step>
<Step title="Open Cline">
Use the Cline activity bar icon, or run `Cline: Open In New Tab` from Command Palette.
</Step>
<Step title="Authorize with Cline">
After installing the extension, complete provider setup in Cline settings. Use the Cline Provider for pay-as-you-go access, ClinePass for a flat monthly subscription, or bring your own provider key.
[Authorize with Cline](/getting-started/authorizing-with-cline)
</Step>
</Steps>
<Note>
Windsurf and VSCodium use Open VSX. The install flow is the same.
</Note>
</Tab>
<Tab title="JetBrains">
<Steps>
<Step title="Open Plugins Marketplace">
**Settings** → **Plugins** → **Marketplace**.
</Step>
<Step title="Install Cline">
Search `Cline`, click **Install**, then restart the IDE.
</Step>
<Step title="Open Cline">
**View** → **Tool Windows** → **Cline**.
</Step>
<Step title="Authorize with Cline">
After installing the extension, complete provider setup in Cline settings. Use the Cline Provider for pay-as-you-go access, ClinePass for a flat monthly subscription, or bring your own provider key.
[Authorize with Cline](/getting-started/authorizing-with-cline)
</Step>
</Steps>
Alternative: install from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/28247-cline).
</Tab>
</Tabs>
## CLI
Use this if you want Cline in terminal workflows (interactive + automation).
<Steps>
<Step title="Install Node.js">
Install Node.js 20+ (22 recommended).
</Step>
<Step title="Install CLI">
```bash
npm install -g cline
```
</Step>
<Step title="Authenticate">
```bash
cline auth
```
</Step>
<Step title="Run Cline">
```bash
cline
# or
cline "your task"
```
</Step>
</Steps>
More details: [CLI Installation & Setup](/usage/cli-overview)
## Kanban
Use this if you want task-board workflows with agent execution.
<Steps>
<Step title="Install Node.js">
Install Node.js 18+.
</Step>
<Step title="Launch Kanban">
```bash
npx kanban
```
</Step>
</Steps>
More details: [Kanban](/usage/kanban)
## SDK
Use this if you are building your own app/agent on top of Cline.
<Steps>
<Step title="Create project">
```bash
mkdir my-agent && cd my-agent
npm init -y
```
</Step>
<Step title="Install SDK">
```bash
npm install @cline/sdk
```
</Step>
<Step title="Build and run">
Browse SDK examples to run your first agent.
</Step>
</Steps>
Start here: [SDK Examples](/sdk/examples)
## Need Help?
- [Troubleshooting](/troubleshooting/networking-and-proxies)
- [Discord community](https://discord.gg/cline)