mirror of
https://github.com/cline/cline.git
synced 2026-09-14 02:29:17 +08:00
6def83a5d9
* initial doc changes * rm general api endpoint * Add API documentation section with endpoint reference pages - Add new API docs: overview, getting-started, authentication, models, chat-completions, errors, and SDK examples - Update api/reference.mdx with expanded endpoint documentation - Update enterprise-solutions/api-reference.mdx with improvements - Update docs.json with new API section navigation entries --------- Co-authored-by: Juan Pablo <juan@cline.bot> Co-authored-by: Tony Loehr <turingxo@gmail.com>
650 lines
17 KiB
JSON
650 lines
17 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "mint",
|
|
"name": "Cline",
|
|
"description": "AI-powered coding agent for complex work",
|
|
"colors": {
|
|
"primary": "#9D4EDD",
|
|
"light": "#F0E6FF",
|
|
"dark": "#000000"
|
|
},
|
|
"logo": {
|
|
"light": "/assets/Cline_Logo-complete_black.png",
|
|
"dark": "/assets/Cline_Logo-complete_white.png"
|
|
},
|
|
"favicon": {
|
|
"light": "/assets/robot_panel_light.png",
|
|
"dark": "/assets/robot_panel_dark.png"
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"light": "#fafaf9",
|
|
"dark": "#0f0f0f"
|
|
}
|
|
},
|
|
"styling": {
|
|
"eyebrows": "breadcrumbs",
|
|
"codeblocks": "system",
|
|
"css": "styles.css"
|
|
},
|
|
"appearance": {
|
|
"default": "system",
|
|
"strict": false
|
|
},
|
|
"fonts": {
|
|
"family": "Geist Sans"
|
|
},
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"label": "GitHub",
|
|
"icon": "github",
|
|
"href": "https://github.com/cline/cline"
|
|
},
|
|
{
|
|
"label": "Discord",
|
|
"icon": "discord",
|
|
"href": "https://discord.gg/cline"
|
|
}
|
|
],
|
|
"primary": {
|
|
"type": "button",
|
|
"label": "Install Cline",
|
|
"href": "https://cline.bot/install?utm_source=website&utm_medium=header"
|
|
}
|
|
},
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "Docs",
|
|
"icon": "square-terminal",
|
|
"groups": [
|
|
{
|
|
"group": "Home",
|
|
"pages": [
|
|
"home",
|
|
"getting-started/quick-start"
|
|
]
|
|
},
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"getting-started/what-is-cline",
|
|
"getting-started/installing-cline",
|
|
"getting-started/authorizing-with-cline",
|
|
"getting-started/your-first-project"
|
|
]
|
|
},
|
|
{
|
|
"group": "Core Workflows",
|
|
"pages": [
|
|
"core-workflows/task-management",
|
|
"core-workflows/plan-and-act",
|
|
"core-workflows/working-with-files",
|
|
"core-workflows/using-commands",
|
|
"core-workflows/checkpoints"
|
|
]
|
|
},
|
|
{
|
|
"group": "Customization",
|
|
"pages": [
|
|
"customization/overview",
|
|
"customization/cline-rules",
|
|
"customization/skills",
|
|
"customization/workflows",
|
|
"customization/hooks",
|
|
"customization/clineignore"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cline CLI",
|
|
"pages": [
|
|
"cline-cli/overview",
|
|
"cline-cli/installation",
|
|
"cline-cli/interactive-mode",
|
|
{
|
|
"group": "Headless Mode",
|
|
"pages": [
|
|
"cline-cli/three-core-flows",
|
|
"cline-cli/samples/overview",
|
|
"cline-cli/samples/github-issue-rca",
|
|
"cline-cli/samples/github-integration",
|
|
"cline-cli/samples/github-pr-review",
|
|
"cline-cli/samples/model-orchestration",
|
|
"cline-cli/samples/worktree-workflows"
|
|
]
|
|
},
|
|
"cline-cli/configuration",
|
|
"cline-cli/acp-editor-integrations",
|
|
"cline-sdk/overview",
|
|
"cline-cli/cli-reference"
|
|
]
|
|
},
|
|
{
|
|
"group": "Features",
|
|
"pages": [
|
|
"features/memory-bank",
|
|
"features/focus-chain",
|
|
"features/auto-approve",
|
|
"features/auto-compact",
|
|
"features/multiroot-workspace",
|
|
"features/subagents",
|
|
"features/background-edit",
|
|
"features/jupyter-notebooks",
|
|
"features/deep-planning",
|
|
"features/web-tools",
|
|
"features/worktrees"
|
|
]
|
|
},
|
|
{
|
|
"group": "Models & Providers",
|
|
"pages": [
|
|
{
|
|
"group": "Choosing & Configuring Models",
|
|
"pages": [
|
|
"core-features/model-selection-guide",
|
|
"model-config/context-windows"
|
|
]
|
|
},
|
|
{
|
|
"group": "Running Models Locally",
|
|
"pages": [
|
|
"running-models-locally/overview",
|
|
"running-models-locally/ollama",
|
|
"running-models-locally/lm-studio"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cloud Providers",
|
|
"pages": [
|
|
"provider-config/qwen",
|
|
"provider-config/anthropic",
|
|
"provider-config/asksage",
|
|
"provider-config/baseten",
|
|
"provider-config/cerebras",
|
|
"provider-config/claude-code",
|
|
"provider-config/deepseek",
|
|
"provider-config/doubao",
|
|
"provider-config/fireworks",
|
|
"provider-config/gcp-vertex-ai",
|
|
"provider-config/google-gemini",
|
|
"provider-config/groq",
|
|
"provider-config/huawei-cloud-maas",
|
|
"provider-config/huggingface",
|
|
"provider-config/minimax",
|
|
"provider-config/mistral-ai",
|
|
"provider-config/moonshot",
|
|
"provider-config/nebius",
|
|
"provider-config/nousresearch",
|
|
"provider-config/openai",
|
|
"provider-config/openai-codex",
|
|
"provider-config/openrouter",
|
|
"provider-config/oracle-code-assist",
|
|
"provider-config/qwen-code",
|
|
"provider-config/sambanova",
|
|
"provider-config/together",
|
|
"provider-config/xai-grok",
|
|
"provider-config/zai",
|
|
{
|
|
"group": "AWS Bedrock",
|
|
"pages": [
|
|
"provider-config/aws-bedrock/api-key",
|
|
"provider-config/aws-bedrock/iam-credentials",
|
|
"provider-config/aws-bedrock/cli-profile"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Advanced Configuration",
|
|
"pages": [
|
|
"provider-config/aihubmix",
|
|
"provider-config/dify",
|
|
"provider-config/hicap",
|
|
"provider-config/litellm-and-cline-using-codestral",
|
|
"provider-config/openai-compatible",
|
|
"provider-config/requesty",
|
|
"provider-config/sap-aicore",
|
|
"provider-config/vercel-ai-gateway",
|
|
"provider-config/vscode-language-model-api"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "MCP (Extending Cline)",
|
|
"pages": [
|
|
"mcp/mcp-overview",
|
|
"mcp/mcp-marketplace",
|
|
"mcp/adding-and-configuring-servers",
|
|
"mcp/mcp-server-development-protocol",
|
|
"mcp/connecting-to-a-remote-server",
|
|
"mcp/mcp-transport-mechanisms"
|
|
]
|
|
},
|
|
{
|
|
"group": "Tools Reference",
|
|
"pages": [
|
|
"tools-reference/all-cline-tools",
|
|
"tools-reference/browser-automation"
|
|
]
|
|
},
|
|
{
|
|
"group": "Troubleshooting",
|
|
"pages": [
|
|
"troubleshooting/terminal-quick-fixes",
|
|
"troubleshooting/networking-and-proxies",
|
|
"troubleshooting/task-history-recovery"
|
|
]
|
|
},
|
|
{
|
|
"group": "Contributing",
|
|
"pages": [
|
|
"contributing/documentation-guide",
|
|
"contributing/doc-templates"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Enterprise",
|
|
"icon": "building",
|
|
"groups": [
|
|
{
|
|
"group": "Enterprise Solutions",
|
|
"pages": [
|
|
"enterprise-solutions/overview",
|
|
"enterprise-solutions/onboarding",
|
|
"enterprise-solutions/sso-setup",
|
|
"enterprise-solutions/team-management/managing-members",
|
|
{
|
|
"group": "SaaS Provider Configuration",
|
|
"pages": [
|
|
"enterprise-solutions/configuration/remote-configuration/overview",
|
|
{
|
|
"group": "AWS Bedrock",
|
|
"pages": [
|
|
"enterprise-solutions/configuration/remote-configuration/aws-bedrock/admin-configuration",
|
|
"enterprise-solutions/configuration/remote-configuration/aws-bedrock/member-configuration"
|
|
]
|
|
},
|
|
{
|
|
"group": "LiteLLM",
|
|
"pages": [
|
|
"enterprise-solutions/configuration/remote-configuration/litellm/admin-configuration",
|
|
"enterprise-solutions/configuration/remote-configuration/litellm/member-configuration"
|
|
]
|
|
},
|
|
{
|
|
"group": "Google Vertex AI",
|
|
"pages": [
|
|
"enterprise-solutions/configuration/remote-configuration/google-vertex/admin-configuration",
|
|
"enterprise-solutions/configuration/remote-configuration/google-vertex/member-configuration"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Control Other Cline Features",
|
|
"pages": [
|
|
"enterprise-solutions/configuration/infrastructure-configuration/control-other-cline-features/yolo-mode",
|
|
"enterprise-solutions/configuration/infrastructure-configuration/control-other-cline-features/mcp-marketplace"
|
|
]
|
|
},
|
|
{
|
|
"group": "Monitoring",
|
|
"pages": [
|
|
"enterprise-solutions/monitoring/overview",
|
|
"enterprise-solutions/monitoring/telemetry",
|
|
"enterprise-solutions/monitoring/opentelemetry"
|
|
]
|
|
},
|
|
"enterprise-solutions/api-reference"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "API",
|
|
"icon": "code",
|
|
"groups": [
|
|
{
|
|
"group": "Cline API",
|
|
"pages": [
|
|
"api/overview",
|
|
"api/getting-started",
|
|
"api/authentication"
|
|
]
|
|
},
|
|
{
|
|
"group": "Endpoints",
|
|
"pages": [
|
|
"api/chat-completions"
|
|
]
|
|
},
|
|
{
|
|
"group": "Reference",
|
|
"pages": [
|
|
"api/models",
|
|
"api/errors",
|
|
"api/sdk-examples"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Learn",
|
|
"icon": "graduation-cap",
|
|
"href": "https://cline.bot/learn"
|
|
}
|
|
]
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"x": "https://x.com/cline",
|
|
"github": "https://github.com/cline/cline",
|
|
"discord": "https://discord.gg/cline"
|
|
}
|
|
},
|
|
"anchors": [
|
|
{
|
|
"name": "Overview",
|
|
"icon": "house",
|
|
"url": "getting-started/what-is-cline"
|
|
}
|
|
],
|
|
"redirects": [
|
|
{
|
|
"source": "/getting-started/installing-cline-jetbrains",
|
|
"destination": "/getting-started/installing-cline"
|
|
},
|
|
{
|
|
"source": "/getting-started/overview",
|
|
"destination": "/getting-started/what-is-cline"
|
|
},
|
|
{
|
|
"source": "/introduction",
|
|
"destination": "/getting-started/what-is-cline"
|
|
},
|
|
{
|
|
"source": "/introduction/welcome",
|
|
"destination": "/getting-started/what-is-cline"
|
|
},
|
|
{
|
|
"source": "/introduction/overview",
|
|
"destination": "/getting-started/what-is-cline"
|
|
},
|
|
{
|
|
"source": "/getting-started/model-selection-guide",
|
|
"destination": "/core-features/model-selection-guide"
|
|
},
|
|
{
|
|
"source": "/provider-config/ollama",
|
|
"destination": "/running-models-locally/ollama"
|
|
},
|
|
{
|
|
"source": "/running-models-locally/read-me-first",
|
|
"destination": "/running-models-locally/overview"
|
|
},
|
|
{
|
|
"source": "/getting-started/understanding-context-management",
|
|
"destination": "/model-config/context-windows"
|
|
},
|
|
{
|
|
"source": "/best-practices/understanding-context-management",
|
|
"destination": "/model-config/context-windows"
|
|
},
|
|
{
|
|
"source": "/prompting/understanding-context-management",
|
|
"destination": "/model-config/context-windows"
|
|
},
|
|
{
|
|
"source": "/prompting/prompt-engineering-guide",
|
|
"destination": "/customization/cline-rules"
|
|
},
|
|
{
|
|
"source": "/prompting/cline-memory-bank",
|
|
"destination": "/features/memory-bank"
|
|
},
|
|
{
|
|
"source": "/customization/memory-bank",
|
|
"destination": "/features/memory-bank"
|
|
},
|
|
{
|
|
"source": "/customization/focus-chain",
|
|
"destination": "/features/focus-chain"
|
|
},
|
|
{
|
|
"source": "/customization/auto-approve",
|
|
"destination": "/features/auto-approve"
|
|
},
|
|
{
|
|
"source": "/customization/auto-compact",
|
|
"destination": "/features/auto-compact"
|
|
},
|
|
{
|
|
"source": "/getting-started/your-first-task",
|
|
"destination": "/getting-started/your-first-project"
|
|
},
|
|
{
|
|
"source": "/cline-cli/samples",
|
|
"destination": "/cline-cli/samples/overview"
|
|
},
|
|
{
|
|
"source": "/cline-cli/overview",
|
|
"destination": "/cline-cli/getting-started"
|
|
},
|
|
{
|
|
"source": "/features/hooks/real-world-examples",
|
|
"destination": "/customization/hooks"
|
|
},
|
|
{
|
|
"source": "/features/hooks/index",
|
|
"destination": "/customization/hooks"
|
|
},
|
|
{
|
|
"source": "/features/hooks/hook-reference",
|
|
"destination": "/customization/hooks"
|
|
},
|
|
{
|
|
"source": "/features/hooks/samples",
|
|
"destination": "/customization/hooks"
|
|
},
|
|
{
|
|
"source": "/features/plan-and-act",
|
|
"destination": "/core-workflows/plan-and-act"
|
|
},
|
|
{
|
|
"source": "/features/checkpoints",
|
|
"destination": "/core-workflows/checkpoints"
|
|
},
|
|
{
|
|
"source": "/features/tasks/understanding-tasks",
|
|
"destination": "/core-workflows/task-management"
|
|
},
|
|
{
|
|
"source": "/features/tasks/task-management",
|
|
"destination": "/core-workflows/task-management"
|
|
},
|
|
{
|
|
"source": "/features/at-mentions/overview",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/at-mentions/file-mentions",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/at-mentions/folder-mentions",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/at-mentions/terminal-mentions",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/at-mentions/problem-mentions",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/at-mentions/git-mentions",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/at-mentions/url-mentions",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/drag-and-drop",
|
|
"destination": "/core-workflows/working-with-files"
|
|
},
|
|
{
|
|
"source": "/features/yolo-mode",
|
|
"destination": "/features/auto-approve"
|
|
},
|
|
{
|
|
"source": "/features/cline-rules",
|
|
"destination": "/customization/cline-rules"
|
|
},
|
|
{
|
|
"source": "/features/cline-rules/overview",
|
|
"destination": "/customization/cline-rules"
|
|
},
|
|
{
|
|
"source": "/features/cline-rules/conditional-rules",
|
|
"destination": "/customization/cline-rules"
|
|
},
|
|
{
|
|
"source": "/features/commands-and-shortcuts/overview",
|
|
"destination": "/core-workflows/using-commands"
|
|
},
|
|
{
|
|
"source": "/features/commands-and-shortcuts/code-commands",
|
|
"destination": "/core-workflows/using-commands"
|
|
},
|
|
{
|
|
"source": "/features/commands-and-shortcuts/terminal-integration",
|
|
"destination": "/core-workflows/using-commands"
|
|
},
|
|
{
|
|
"source": "/features/commands-and-shortcuts/git-integration",
|
|
"destination": "/core-workflows/using-commands"
|
|
},
|
|
{
|
|
"source": "/features/commands-and-shortcuts/keyboard-shortcuts",
|
|
"destination": "/core-workflows/using-commands"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/new-task",
|
|
"destination": "/core-workflows/using-commands"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/workflows/index",
|
|
"destination": "/customization/workflows"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/workflows/quickstart",
|
|
"destination": "/customization/workflows"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/workflows/best-practices",
|
|
"destination": "/customization/workflows"
|
|
},
|
|
{
|
|
"source": "/exploring-clines-tools/cline-tools-guide",
|
|
"destination": "/tools-reference/all-cline-tools"
|
|
},
|
|
{
|
|
"source": "/exploring-clines-tools/new-task-tool",
|
|
"destination": "/tools-reference/all-cline-tools"
|
|
},
|
|
{
|
|
"source": "/exploring-clines-tools/remote-browser-support",
|
|
"destination": "/tools-reference/browser-automation"
|
|
},
|
|
{
|
|
"source": "/mcp/adding-mcp-servers-from-github",
|
|
"destination": "/mcp/adding-and-configuring-servers"
|
|
},
|
|
{
|
|
"source": "/mcp/configuring-mcp-servers",
|
|
"destination": "/mcp/adding-and-configuring-servers"
|
|
},
|
|
{
|
|
"source": "/more-info/telemetry",
|
|
"destination": "/enterprise-solutions/monitoring/telemetry"
|
|
},
|
|
{
|
|
"source": "/enterprise-solutions/configure-AWS-Bedrock-Admin",
|
|
"destination": "/enterprise-solutions/configuration/remote-configuration/aws-bedrock/admin-configuration"
|
|
},
|
|
{
|
|
"source": "/enterprise-solutions/configure-AWS-Bedrock-Member",
|
|
"destination": "/enterprise-solutions/configuration/remote-configuration/aws-bedrock/member-configuration"
|
|
},
|
|
{
|
|
"source": "/enterprise-solutions/configure-workOS-authkit",
|
|
"destination": "/enterprise-solutions/onboarding"
|
|
},
|
|
{
|
|
"source": "/enterprise-solutions/Onboarding your Organization",
|
|
"destination": "/enterprise-solutions/onboarding"
|
|
},
|
|
{
|
|
"source": "/enterprise-solutions/team-management/overview",
|
|
"destination": "/enterprise-solutions/team-management/managing-members"
|
|
},
|
|
{
|
|
"source": "/enterprise-solutions/team-management/roles-and-permissions",
|
|
"destination": "/enterprise-solutions/team-management/managing-members"
|
|
},
|
|
{
|
|
"source": "/features/customization/opening-cline-in-sidebar",
|
|
"destination": "/getting-started/installing-cline"
|
|
},
|
|
{
|
|
"source": "/prompting/prompt-engineering-guide/clineignore-file-guide",
|
|
"destination": "/customization/clineignore"
|
|
},
|
|
{
|
|
"source": "/getting-started/selecting-your-model",
|
|
"destination": "/getting-started/authorizing-with-cline"
|
|
},
|
|
{
|
|
"source": "/model-config/model-comparison",
|
|
"destination": "/core-features/model-selection-guide"
|
|
},
|
|
{
|
|
"source": "/troubleshooting/terminal-integration-guide",
|
|
"destination": "/troubleshooting/terminal-quick-fixes"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/deep-planning",
|
|
"destination": "/features/deep-planning"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/smol",
|
|
"destination": "/core-workflows/using-commands#smol"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/explain-changes",
|
|
"destination": "/core-workflows/using-commands#explain-changes"
|
|
},
|
|
{
|
|
"source": "/features/slash-commands/new-rule",
|
|
"destination": "/core-workflows/using-commands#newrule"
|
|
},
|
|
{
|
|
"source": "/features/skills",
|
|
"destination": "/customization/skills"
|
|
},
|
|
{
|
|
"source": "/api/reference",
|
|
"destination": "/api/overview"
|
|
}
|
|
],
|
|
"search": {
|
|
"prompt": "Search Cline documentation..."
|
|
}
|
|
}
|