mirror of
https://github.com/cline/cline.git
synced 2026-09-18 17:50:56 +08:00
571480e3b6
* docs(features): add comprehensive hooks documentation Add detailed documentation for the Hooks feature, including: - Overview of hooks functionality and use cases - Getting started guide with step-by-step setup instructions - Hook types and lifecycle explanations - JSON communication format and examples - Validation and blocking capabilities - Best practices and implementation patterns Update docs navigation to include the new hooks documentation page in the features section. * docs(features): reorganize and clarify Hooks documentation - add frontmatter description and insert demo GIF in Getting Started - reorganize Hook Types into Task Lifecycle and Communication categories - convert tables into dedicated sections per hook with explicit "Input Fields" examples - add JSON input/output examples and clarify execution timing, limits, and context behavior - remove embedded bash examples and Advanced Topics clutter; streamline troubleshooting and security warning * Update docs/features/hooks.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs: reorganize hooks documentation into four categories Restructure the hooks documentation to improve clarity and organization: - Change from two categories to four logical categories: Tool Execution, User Interaction, Task Lifecycle, and API Response - Reorder hooks by category based on trigger points and use cases - Add complete JSON examples with all base fields for each hook type - Enhance descriptions with clearer use case explanations - Improve consistency across hook documentation format This reorganization makes it easier for developers to find the right hook for their specific needs and understand the complete data structure they will receive. * docs: enhance TaskStart hook example with JSON payload handling Replace basic "Hello World" example with practical demonstration of reading JSON input from stdin and using jq to inspect payload structure and field types. Added explanatory text to help developers understand hook input/output mechanics before building complex logic. * Update docs/features/hooks.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * comments out preCompact and taskComplete * fix: clarify description of hook types in documentation --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: CandiedUniverse <132302818+candieduniverse@users.noreply.github.com> Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
337 lines
8.3 KiB
JSON
337 lines
8.3 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "linden",
|
|
"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": "Introduction",
|
|
"pages": [
|
|
"introduction/welcome",
|
|
"introduction/overview"
|
|
]
|
|
},
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"getting-started/installing-cline",
|
|
"getting-started/selecting-your-model",
|
|
"getting-started/your-first-project"
|
|
]
|
|
},
|
|
{
|
|
"group": "Best Practices",
|
|
"pages": [
|
|
"prompting/understanding-context-management",
|
|
"prompting/prompt-engineering-guide",
|
|
"prompting/cline-memory-bank"
|
|
]
|
|
},
|
|
{
|
|
"group": "CLI",
|
|
"pages": [
|
|
"cline-cli/overview",
|
|
"cline-cli/installation",
|
|
"cline-cli/three-core-flows",
|
|
{
|
|
"group": "CLI Samples",
|
|
"pages": [
|
|
"cline-cli/samples/overview",
|
|
"cline-cli/samples/github-issue-rca",
|
|
"cline-cli/samples/github-integration"
|
|
]
|
|
},
|
|
"cline-cli/cli-reference"
|
|
]
|
|
},
|
|
{
|
|
"group": "Features",
|
|
"pages": [
|
|
{
|
|
"group": "@ Mentions",
|
|
"pages": [
|
|
"features/at-mentions/overview",
|
|
"features/at-mentions/file-mentions",
|
|
"features/at-mentions/terminal-mentions",
|
|
"features/at-mentions/problem-mentions",
|
|
"features/at-mentions/git-mentions",
|
|
"features/at-mentions/url-mentions"
|
|
]
|
|
},
|
|
"features/auto-approve",
|
|
"features/auto-compact",
|
|
"features/checkpoints",
|
|
"features/cline-rules",
|
|
{
|
|
"group": "Commands & Shortcuts",
|
|
"pages": [
|
|
"features/commands-and-shortcuts/overview",
|
|
"features/commands-and-shortcuts/code-commands",
|
|
"features/commands-and-shortcuts/terminal-integration",
|
|
"features/commands-and-shortcuts/git-integration",
|
|
"features/commands-and-shortcuts/keyboard-shortcuts"
|
|
]
|
|
},
|
|
{
|
|
"group": "Customization",
|
|
"pages": [
|
|
"features/customization/opening-cline-in-sidebar",
|
|
"features/customization/disable-terminal-pagers"
|
|
]
|
|
},
|
|
"features/dictation",
|
|
"features/drag-and-drop",
|
|
"features/editing-messages",
|
|
"features/focus-chain",
|
|
"features/hooks",
|
|
"features/multiroot-workspace",
|
|
"features/plan-and-act",
|
|
{
|
|
"group": "Slash Commands",
|
|
"pages": [
|
|
"features/slash-commands/new-task",
|
|
"features/slash-commands/new-rule",
|
|
"features/slash-commands/smol",
|
|
"features/slash-commands/report-bug",
|
|
"features/slash-commands/deep-planning"
|
|
]
|
|
},
|
|
"features/slash-commands/workflows",
|
|
{
|
|
"group": "Task Management",
|
|
"pages": [
|
|
"features/tasks/understanding-tasks",
|
|
"features/tasks/task-management"
|
|
]
|
|
},
|
|
"features/yolo-mode"
|
|
]
|
|
},
|
|
{
|
|
"group": "Model & Provider Configuration",
|
|
"pages": [
|
|
{
|
|
"group": "Model Selection",
|
|
"pages": [
|
|
"core-features/model-selection-guide",
|
|
"model-config/model-comparison",
|
|
"model-config/context-windows"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cloud Providers",
|
|
"pages": [
|
|
"provider-config/anthropic",
|
|
"provider-config/claude-code",
|
|
"provider-config/openai",
|
|
"provider-config/openrouter",
|
|
"provider-config/cerebras",
|
|
"provider-config/deepseek",
|
|
"provider-config/groq",
|
|
"provider-config/xai-grok",
|
|
"provider-config/mistral-ai",
|
|
"provider-config/doubao",
|
|
"provider-config/fireworks",
|
|
"provider-config/zai",
|
|
"provider-config/gcp-vertex-ai",
|
|
{
|
|
"group": "AWS Bedrock",
|
|
"pages": [
|
|
"provider-config/aws-bedrock/api-key",
|
|
"provider-config/aws-bedrock/iam-credentials",
|
|
"provider-config/aws-bedrock/cli-profile"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Running Models Locally",
|
|
"pages": [
|
|
"running-models-locally/overview",
|
|
"running-models-locally/ollama",
|
|
"running-models-locally/lm-studio"
|
|
]
|
|
},
|
|
{
|
|
"group": "Advanced Configuration",
|
|
"pages": [
|
|
"provider-config/openai-compatible",
|
|
"provider-config/litellm-and-cline-using-codestral",
|
|
"provider-config/vscode-language-model-api",
|
|
"provider-config/sap-aicore",
|
|
"provider-config/vercel-ai-gateway",
|
|
"provider-config/requesty",
|
|
"provider-config/baseten"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "MCP Integration",
|
|
"pages": [
|
|
"mcp/mcp-overview",
|
|
"mcp/adding-mcp-servers-from-github",
|
|
"mcp/configuring-mcp-servers",
|
|
"mcp/connecting-to-a-remote-server",
|
|
"mcp/mcp-marketplace",
|
|
"mcp/mcp-server-development-protocol",
|
|
"mcp/mcp-transport-mechanisms"
|
|
]
|
|
},
|
|
{
|
|
"group": "Cline Tools Reference",
|
|
"pages": [
|
|
"exploring-clines-tools/cline-tools-guide",
|
|
"exploring-clines-tools/new-task-tool",
|
|
"exploring-clines-tools/remote-browser-support"
|
|
]
|
|
},
|
|
{
|
|
"group": "Enterprise",
|
|
"pages": [
|
|
"enterprise-solutions/overview",
|
|
"enterprise-solutions/security-concerns"
|
|
]
|
|
},
|
|
{
|
|
"group": "Reference",
|
|
"pages": [
|
|
"troubleshooting/terminal-quick-fixes",
|
|
"troubleshooting/terminal-integration-guide",
|
|
"more-info/telemetry"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Learn",
|
|
"icon": "graduation-cap",
|
|
"href": "https://cline.bot/learn"
|
|
},
|
|
{
|
|
"tab": "Blog",
|
|
"icon": "newspaper",
|
|
"href": "https://cline.bot/blog"
|
|
}
|
|
]
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"x": "https://x.com/cline",
|
|
"github": "https://github.com/cline/cline",
|
|
"discord": "https://discord.gg/cline"
|
|
}
|
|
},
|
|
"anchors": [
|
|
{
|
|
"name": "Overview",
|
|
"icon": "house",
|
|
"url": "introduction/overview"
|
|
}
|
|
],
|
|
"redirects": [
|
|
{
|
|
"source": "/getting-started/installing-cline-jetbrains",
|
|
"destination": "/getting-started/installing-cline"
|
|
},
|
|
{
|
|
"source": "/getting-started/what-is-cline",
|
|
"destination": "/introduction/overview"
|
|
},
|
|
{
|
|
"source": "/getting-started/overview",
|
|
"destination": "/introduction/overview"
|
|
},
|
|
{
|
|
"source": "/introduction",
|
|
"destination": "/introduction/welcome"
|
|
},
|
|
{
|
|
"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": "/prompting/understanding-context-management"
|
|
},
|
|
{
|
|
"source": "/best-practices/understanding-context-management",
|
|
"destination": "/prompting/understanding-context-management"
|
|
},
|
|
{
|
|
"source": "/getting-started/your-first-task",
|
|
"destination": "/getting-started/your-first-project"
|
|
},
|
|
{
|
|
"source": "/cline-cli/samples",
|
|
"destination": "/cline-cli/samples/overview"
|
|
}
|
|
],
|
|
"search": {
|
|
"prompt": "Search Cline documentation..."
|
|
}
|
|
}
|