mirror of
https://github.com/cline/cline.git
synced 2026-09-19 10:13:34 +08:00
10db578fd3b8df47bc094174dd98a1840e6d855e
71
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
 morning-verluandmorning-verlu
|
42e4ea60db |
Fix marketplace getting started link (#11170)
Co-authored-by: morning-verlu <258725120+morning-verlu@users.noreply.github.com> |
||
|
Renee HuangandSaoud Rizwan
|
47f6d00f61 |
docs: add back memorybank; correct CLI install commands (#10830)
* add back memorybank; correct CLI install commands * add more details on plugin --------- Co-authored-by: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com> |
||
|
Saoud Rizwan
|
7547229d6a |
docs(sdk): reframe runtime page as ClineCore, remove tier choice from overview (#10708)
* docs(sdk): remove Runtime Choices from overview, rename runtime to session-management The SDK overview page had a prominent "Runtime Choices" section with an "Agent vs ClineCore" comparison table and CTA link front and center. New users don't have the context to make that decision on the overview page. Removed that section entirely so the overview flows cleanly from install to snippet to next steps. Renamed sdk/runtime.mdx to sdk/session-management.mdx with updated title and sidebar label to frame the page around session management rather than two competing class names. Updated all nav entries and redirects in docs.json. * docs(sdk): rename runtime page to ClineCore, reframe as full harness Renamed sdk/runtime.mdx to sdk/clinecore.mdx. Reframed the page to lead with ClineCore as the full Cline harness, with Agent explained at the bottom as the primitive you use when you want to skip the harness. All original content preserved, just reordered so ClineCore sections come first. Updated nav and redirects in docs.json. |
||
|
|
0b0ca9b1fa |
docs: add SDK documentation (#10350)
* 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> |
||
|
Tony Loehr
|
10af2439be |
docs: add prompt storage schema and OpenTelemetry events reference (#10195)
* docs: add prompt storage schema and OpenTelemetry events reference - Add comprehensive prompt storage documentation (DEVREL-142) - Complete enterpriseTelemetry.promptUploading schema - Setup guides for AWS S3 and Cloudflare R2 - Storage architecture and sync worker behavior - IAM policies and troubleshooting - Add OpenTelemetry events catalog (DEVREL-143) - Document 80+ events across 8 categories - Example payloads and analytics query patterns - Integration examples for Datadog, Grafana, New Relic - Event schema reference and best practices - Update monitoring documentation - Add cross-references between related pages - Update navigation in docs.json - Integrate new pages into Enterprise > Monitoring section * fix: update broken link in telemetry.mdx to point to OTel events page * docs: address PR review comments - Fix file contents exclusion claim in prompt-storage.mdx - Remove misleading claim about file contents not being stored - Add warning that tool inputs (like write_to_file content) are included - Standardize attribute naming in opentelemetry-events.mdx - Change model_id to model in event tables for consistency - Match actual emitted event schema shown in example payloads - Add SQL syntax note in opentelemetry-events.mdx - Clarify that attribute access syntax is platform-specific - Provide examples for BigQuery and ClickHouse * adjustments |
||
|
Tony Loehrandgreptile-apps[bot]
|
fddabb6b8d |
docs: add Kanban remote access documentation (#10274)
* docs: add Kanban remote access documentation Add comprehensive documentation for accessing Kanban remotely: - Local network access (--host flag and KANBAN_RUNTIME_HOST env var) - Tailscale for secure remote access - Docker deployment - SSH tunneling - Ngrok for public URLs - Cloudflare Tunnels with AWS CDK example * Update docs/kanban/remote-access.mdx Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update docs/kanban/remote-access.mdx Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> |
||
|
|
841402c178 |
docs: add all enterprise inference providers to Remote Provider Configuration (#10127)
* docs: add OpenAI Compatible and Anthropic to enterprise SaaS provider configuration Add documentation for all inference providers supported by the core platform's remote config system (ProviderSettingsSchema). Previously only Bedrock, Vertex, and LiteLLM had dedicated pages. New pages: - OpenAI Compatible admin/member config (covers Azure Foundry) - Anthropic admin/member config Updated: - overview.mdx: expanded provider table to 7 rows - docs.json: added navigation groups - Capabilities Manual: added provider links * Update docs/enterprise-solutions/configuration/remote-configuration/overview.mdx Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update docs/enterprise-solutions/configuration/remote-configuration/overview.mdx Co-authored-by: Renee Huang <100229782+reneehuang1@users.noreply.github.com> --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Co-authored-by: Renee Huang <100229782+reneehuang1@users.noreply.github.com> |
||
|
John SimoneandRenee Huang
|
7a0f11837e |
Add Kanban docs (#9988)
* add kanban docs * fix rendering error in overview, drop kanban flags from commands * fix stray link --------- Co-authored-by: Renee Huang <100229782+reneehuang1@users.noreply.github.com> |
||
|
Tony Loehrandgreptile-apps[bot]
|
54726f1677 |
docs: fix SDK documentation accuracy and completeness (#9856)
* docs: fix SDK documentation accuracy and completeness - Fix setPermissionHandler API Reference to use correct async/return signature (was showing old callback pattern with (request, resolve) => void) - Remove non-existent PermissionResolver type from Exported Types table - Fix PermissionHandler type description to match actual signature - Add missing hooksDir option to ClineAgentOptions documentation - Fix newSession() example to use real model IDs - Replace developer personal path in Full Example with generic path - Use placeholder for version in initialize() example to avoid staleness - Expand Stop Reasons table and add note about current implementation - Add missing key exported types: AcpSessionStatus, AcpSessionState, RequestPermissionRequest/Response, PermissionOption, SessionUpdatePayload, SessionModelState, ModelInfo, TextContent/ImageContent/AudioContent, SetSessionMode/Model request/response types, TranslatedMessage * docs: improve SDK visibility and disambiguate from API code examples - Move SDK page higher in Cline CLI nav (after Installation, before Interactive Mode) - Add sidebarTitle 'SDK (Programmatic Use)' for clearer nav label - Rename api/sdk-examples to 'Code Examples' to avoid naming confusion with the Cline SDK - Update API overview card title to match * Apply suggestions from code review Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * docs: add ClientCapabilities, Error Handling, and BYO API key docs to SDK - Document clientCapabilities object and its effect on agent behavior - Add Error Handling section with all throwable errors per method - Expand BYO API key setup with concrete CLI auth examples * docs: fix duplicated Stop Reasons table rows from code review * docs: fix 3 accuracy issues found in source code audit - Fix protocolVersion: was '0.9.0' (fabricated), actually 1 (number) from @agentclientprotocol/sdk - Fix clientCapabilities: was claiming they change SDK behavior, but ClineAgent always uses standalone providers (capabilities only matter via AcpAgent stdio wrapper) - Fix permission options: remove reject_always (never sent by agent, only allow_once/allow_always/reject_once are used) * docs: clarify custom clineDir usage with CLI --config flag Address PR review feedback: the BYO auth section mentioned custom clineDir without showing how to target it from the CLI. Remove the vague reference and add explicit --config flag documentation with side-by-side SDK and CLI examples. * docs: remove misleading 'by default' qualifier from SDK BYO auth section --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> |
||
|
|
6def83a5d9 |
[doc] api doc changes (#9581)
* 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> |
||
|
Renee Huang
|
819f9ce00d | show sdk docs in cline page (#9597) | ||
|
Tony LoehrandJuan Pablo Flores
|
810b5b78f5 |
added mcp enterprise configuration details (#9501)
Co-authored-by: Juan Pablo Flores <juan@cline.bot> |
||
|
Renee HuangandJuan Pablo Flores
|
e884699d24 |
New Cline Docs (#9280)
* only doc changes * merge * fix installtion page redirects * fix redirect, remove unused parts * rm irrelevant info * clean up terminal guides * docs: add home page and reorganize navigation * chore: remove 71 unused docs files not referenced in navigation Remove .mdx files that are no longer referenced in docs.json navigation and only existed as stale content from previous documentation restructuring. These files were either completely orphaned or only served as redirect source pages (Mintlify handles redirects at the routing level without needing the source file to exist). Updated docs.json redirects that previously pointed to archive/ pages to point to current equivalents instead: - /archive/understanding-context-management → /model-config/context-windows - /archive/prompt-engineering-guide → /customization/cline-rules - /archive/telemetry → /enterprise-solutions/monitoring/telemetry Deleted files by category: Archive (entire directory removed): - archive/prompt-engineering-guide.mdx - archive/telemetry.mdx - archive/understanding-context-management.mdx Cline CLI: - cline-cli/cli-reference-deprecated.mdx Enterprise Solutions (16 files): - enterprise-solutions/bundled-endpoints.mdx - enterprise-solutions/configuration/overview.mdx - enterprise-solutions/configuration/choosing-your-deployment.mdx - enterprise-solutions/configuration/infrastructure-configuration/overview.mdx - enterprise-solutions/configuration/infrastructure-configuration/rules.mdx - enterprise-solutions/configuration/infrastructure-configuration/workflows.mdx - enterprise-solutions/configuration/infrastructure-configuration/control-other-cline-features/overview.mdx - enterprise-solutions/configuration/infrastructure-configuration/mcp/overview.mdx - enterprise-solutions/configuration/infrastructure-configuration/mcp/mcp-marketplace.mdx - enterprise-solutions/configuration/infrastructure-configuration/mcp/remote-mcp-servers.mdx - enterprise-solutions/configuration/infrastructure-configuration/providers/overview.mdx - enterprise-solutions/configuration/infrastructure-configuration/providers/custom.mdx - enterprise-solutions/configuration/infrastructure-configuration/providers/aws-bedrock/overview.mdx - enterprise-solutions/configuration/infrastructure-configuration/providers/google-vertex/overview.mdx - enterprise-solutions/configuration/infrastructure-configuration/providers/litellm/overview.mdx - enterprise-solutions/monitoring/opentelemetry_override.mdx Exploring Cline's Tools (entire directory removed): - exploring-clines-tools/cline-tools-guide.mdx - exploring-clines-tools/new-task-tool.mdx - exploring-clines-tools/remote-browser-support.mdx Features — old pages consolidated into core-workflows/ and customization/ (37 files): - features/checkpoints.mdx - features/drag-and-drop.mdx - features/editing-messages.mdx - features/explain-changes.mdx - features/skills.mdx - features/yolo-mode.mdx - features/at-mentions/ (7 files — all consolidated into core-workflows/working-with-files) - features/cline-rules/ (2 files — consolidated into customization/cline-rules) - features/commands-and-shortcuts/ (5 files — consolidated into core-workflows/using-commands) - features/customization/ (2 files) - features/hooks/ (3 files — consolidated into customization/hooks) - features/slash-commands/ (7 files) - features/slash-commands/workflows/ (3 files — consolidated into customization/workflows) - features/tasks/ (2 files — consolidated into core-workflows/task-management) Introduction (entire directory removed): - introduction/overview.mdx - introduction/welcome.mdx MCP: - mcp/adding-mcp-servers-from-github.mdx - mcp/configuring-mcp-servers.mdx More Info (entire directory removed): - more-info/telemetry.mdx Prompting (entire directory removed): - prompting/cline-memory-bank.mdx - prompting/prompt-engineering-guide.mdx - prompting/understanding-context-management.mdx Provider Config: - provider-config/fireworks-ai.mdx - provider-config/ollama.mdx Getting Started: - getting-started/selecting-your-model.mdx Total: 71 files deleted, 12,344 lines removed. * docs: update and add documentation pages * revert unintended formatting changes to src files * new first project docs --------- Co-authored-by: Juan Pablo Flores <juan@cline.bot> |
||
|
Juan Pablo Flores
|
cee74d2f3a |
docs: add subagents feature documentation (#9258)
* docs: add subagents feature documentation Add new documentation page covering the Subagents feature, including how it works, enabling/configuring, auto-approve behavior, available tools, and usage guidance. Register the page in docs.json sidebar nav. * docs: remove hardcoded subagent limit from subagents page Remove references to 'up to five' subagents, as the limit is no longer fixed. Updates both the intro paragraph and the How It Works section. |
||
|
Tony LoehrandRenee Huang
|
5ae47fb90b |
Update docs for CLI 2.0 and fix workflow (#9068)
* 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 * docs: Add GitHub PR Review sample and modernize Actions integration * fix: Add cline installation step to PR review workflow - Fix CI/CD failure by actually installing cline before running it - Update docs model ID to match workflow (claude-opus-4-5-20251101) - Change from 'npx cline version' to 'npm install -g cline' + 'cline version' --------- Co-authored-by: Renee Huang <renee@cline.bot> |
||
|
|
b57aefb5a1 |
Cli 2.0 docs (#9060)
* 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> |
||
|
Juan Pablo Floresandcline-test
|
1167b4f3a6 |
feat(rules): Conditional rules docs (#8874)
* docs(rules): Initial thoughts on docs for conditional rules. * docs: restructure Cline Rules documentation into nested structure Reorganize Cline Rules documentation by: - Creating a "Cline Rules" group with overview and conditional-rules pages - Moving conditional-rules.mdx into features/cline-rules/ subdirectory - Adding URL redirects for backward compatibility - Streamlining conditional-rules content for clarity and conciseness - Adding cross-reference link to the overview page This improves documentation navigation by grouping related rule concepts together and makes the content more accessible with clearer, more concise explanations. * docs(cline-rules): consolidate rule file format documentation Reorganize and expand the documentation for supported rule file formats: - Add new "Supported Rule Files" section with comprehensive table - Document cross-tool compatibility (Cursor, Windsurf, AGENTS.md) - Clarify file priority and loading behavior - Remove separate AGENTS.md section and integrate into unified table This improves discoverability by showing all supported formats in one place and makes it clearer how Cline works with rules from different AI coding tools. * docs(rules): remove context management note from overview --------- Co-authored-by: cline-test <132302818+candieduniverse@users.noreply.github.com> |
||
|
|
0220628c39 |
Adds Open AI Codex docs (#8791)
* feat(docs): add OpenAI Codex provider setup instructions and update model selection guidance * fix(docs): improve clarity and formatting in OpenAI Codex documentation * Update docs/provider-config/openai-codex.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/provider-config/openai-codex.mdx --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Tony Loehr <turingxo@gmail.com> |
||
|
Tony Loehr
|
d3e1065707 |
added jupyter docs (#8742)
* added jupyter docs * fix jupyter docs and add gifs * fix jupyter docs 2 * fix jupyter gif placement |
||
|
|
7885c75a4f |
feat: add git worktree view (#8308)
* feat: add git worktree management UI
Adds a worktrees view accessible from the navbar that allows users to:
- View all existing worktrees with their branch and path info
- Create new worktrees from local/remote branches or new branches
- Switch between worktrees (opens folder in VS Code)
- Delete worktrees with confirmation
Implementation includes:
- New proto definitions for worktree service RPCs
- Controller handlers for CRUD operations
- Git worktree utility functions
- WorktreesView React component with full UI
- Navbar integration with worktree button
* feat: enhance worktree creation error handling in WorktreesView
Adds error state management for worktree creation in the WorktreesView component. Introduces a new state variable to capture and display error messages when worktree creation fails, improving user feedback during the process.
* feat: add worktree defaults retrieval to WorktreeService and UI
Introduces a new RPC method `getWorktreeDefaults` to fetch suggested defaults for branch names and paths when creating new worktrees. Updates the WorktreesView component to utilize this method, enhancing the user experience by auto-generating branch names and paths. Additionally, integrates tooltips for improved UI interactions and adds a close button to the worktree creation modal.
* feat: implement .worktreeinclude file management in WorktreeService
Adds new RPC methods to the WorktreeService for managing .worktreeinclude files, including retrieving the status of the file and creating it with specified content. Updates the WorktreesView component to handle the creation and status checking of .worktreeinclude, enhancing user experience by automating file management for worktrees. Additionally, modifies the UI to reflect these changes, including updated tooltips and improved error handling.
* feat: add checkout branch functionality to WorktreeService and UI
Introduces a new RPC method `checkoutBranch` to the WorktreeService for switching branches within the current worktree. Updates the WorktreesView component to support this functionality, enhancing user experience by allowing seamless branch switching. Additionally, refines the UI layout for better responsiveness and improves loading/error state handling.
* feat: reposition New Worktree button for improved UI layout
Moves the New Worktree button to a fixed position at the bottom of the WorktreesView component, enhancing accessibility and user experience. The button is now styled to occupy the full width, ensuring better visibility and interaction within the UI.
* feat: update documentation links in WorktreesView component
Modifies the documentation links in the WorktreesView component to point to the correct feature sections, ensuring users have access to accurate resources. Additionally, adds the "features/worktrees" entry in the documentation JSON for better organization.
* feat: add worktree merging functionality and UI enhancements
Introduces a new feature for merging worktrees, allowing users to merge changes from a worktree's branch into the main branch with options to delete the worktree post-merge. Updates the WorktreesView component to include a merge modal, handling merge conflicts, and integrating with the WorktreeService for seamless operations. Additionally, enhances documentation to reflect these changes.
* refactor: replace exec with simple-git for worktree operations
Refactors the worktree management code to utilize the simple-git library instead of child_process exec for executing Git commands. This change enhances code readability and maintainability by providing a more streamlined interface for Git operations in the checkoutBranch, mergeWorktree, and git-worktree modules. Additionally, it improves error handling and reduces the complexity of command execution.
* feat: enhance mergeWorktree functionality to check target worktree status
Implements a check for uncommitted changes in the target worktree before merging, ensuring that users are informed if the target branch has uncommitted changes. This update improves error handling and user feedback during the merge process by verifying the state of both the source and target worktrees. Additionally, it integrates the listWorktrees utility to identify the correct worktree for the target branch.
* refactor: optimize worktree loading to prevent UI flickering
Enhances the loadWorktrees function in WorktreesView to only update the component's state if the fetched data has changed, reducing unnecessary re-renders and preventing flickering. This change improves the user experience by providing a smoother interface when loading worktrees. Additionally, simplifies the polling mechanism for updates.
* feat: update merge conflict display and task creation flow in WorktreesView
Enhances the merge conflict notification by providing a clearer list of conflicting files, including a summary for additional files. Additionally, modifies the task creation flow to close the worktrees view upon task creation, improving user experience during the merge process.
* fix: improve tooltip functionality and clean up WorktreesView component
Enhances the tooltip for the current worktree indicator to provide additional context for users. Additionally, removes the display of commit hashes in the worktree list to streamline the UI, improving overall clarity and user experience.
* feat: add symlink functionality for .worktreeinclude to sync with .gitignore
Introduces a new section in the documentation explaining how to create a symlink from .gitignore to .worktreeinclude. This allows users to automatically sync patterns between the two files, simplifying worktree setup. Additionally, includes a note for users needing different patterns to create a regular .worktreeinclude file instead.
* fix: simplify merge request button in WorktreesView component
Removes the "Merge" text from the button label in the WorktreesView component, streamlining the user interface. This change focuses on clarity by allowing the button to simply prompt users to "Ask Cline to Resolve," enhancing the overall user experience during merge conflict resolution.
* Update docs/features/worktrees.mdx
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Update webview-ui/src/components/worktrees/WorktreesView.tsx
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Fixes docs not rendering
* perf(worktree): optimize file copying for .worktreeinclude
Address performance feedback - worktree creation was taking ~20 seconds
for large directories like node_modules (50k+ files).
Optimizations:
- Use native `cp -r` for entire directories (10-20x faster)
- Parallelize file copying with batches of 100 (5-10x faster)
- Parallelize directory traversal with Promise.all
The old implementation copied files sequentially which caused the
bottleneck. Now directories like node_modules are copied using the
system's native cp command, and individual files are copied in
parallel batches.
Also adds unit tests for the worktree-include module.
* feat(worktree): add multi-root and subfolder workspace warnings
- Detect and warn when multiple workspace folders are open (worktrees not supported in multi-root)
- Detect and warn when a subfolder of a git repo is open instead of the root, showing the actual git root path
- Fix UI overflow on narrow widths by using min-h-32 instead of fixed h-32
* refactor(worktree): auto-fill defaults when create modal opens
* fix(worktree): add cursor pointer to create modal close button
* feat(worktree): add clear buttons to create modal input fields
* feat(worktree): add quick launch button on home page
Extract CreateWorktreeModal as reusable component with openAfterCreate prop.
Add New Worktree Window button to WelcomeSection that creates a worktree
and opens it in a new window. Shows current worktree branch and path info.
* refactor(ui): polish home screen and worktree modal
- Update HistoryPreview: rename to Recent, move View All to header with chevron
- Remove logo pop-in animation from HomeHeader
- Remove info icon tooltip from What can I do for you heading
- Remove fade-in animations from WelcomeSection
- Move worktree button below history preview with more spacing
- Update CreateWorktreeModal copy and reduce spacing between fields
- Add Current label with branch icon above path in worktree info
* feat(worktree): auto-open Cline sidebar on worktree launch
When switching to a worktree via quick launch button, automatically
open the Cline sidebar in the new/reloaded window. Uses globalState
to pass the target path between windows, reading directly from
context.globalState at startup to bypass StateManager cache timing.
* fix(worktree): improve quick launch UX
- Make current branch/path clickable to navigate to worktrees view
- Fix word wrap for long branch names and paths
- Show .worktreeinclude warning in create modal with learn more link
* chore: ignore .worktrees directory and CLAUDE.local.md
* feat(worktree): add delete confirmation modal
* refactor(ui): remove worktrees button from title bar
* fix(worktree): improve .worktreeinclude warning styling
* docs(worktrees): update for new UI features
- Document quick launch button on home screen
- Update getting started to reflect auto-filled defaults
- Document Cline auto-open behavior when switching worktrees
- Update delete section with confirmation modal details
- Add limitations section for multi-root and subfolder workspaces
* fix(worktree): rename Main badge to Primary
* feat(worktree): add worktrees button to sidebar header
Adds a git-branch icon button to the Cline sidebar header for quick
access to the Worktrees view. Also updates docs to mention this new
entry point and adds a typical workflow section.
* fix(worktree): UI polish
- Change New Worktree Window tooltip to show above button instead of below
- Add break-all to branch names for long branch text wrapping
- Simplify merge button tooltip and modal title (remove 'and close')
* fix(e2e): update tests to match renamed Recent header
* fix(worktree): improve non-git repo message
* fix(worktree): wrap path instead of truncating
* fix(e2e): update auth test to use aria-label instead of removed class
* fix(worktree): add option to delete branch when deleting worktree
- Update delete modal copy to accurately describe behavior
- Add checkbox to optionally delete branch (unchecked by default)
- Show warning about unpushed commits when checkbox is checked
- Update proto, handler, and UI to support delete_branch option
* fix: remove worktrees menu button from sidebar
Remove the worktrees button from the VS Code extension menu bar.
* fix(ui): temporarily disable new worktree button, add tooltip to current worktree
Comment out "New Worktree Window" button until worktree creation is stable.
Add tooltip to current worktree info with "View and manage git worktrees.
Great for running parallel Cline tasks."
* feat: add worktree-exp feature flag for worktrees feature
Put the worktrees feature behind a feature flag (worktree-exp) that
defaults to false. When enabled, users can toggle the feature in
settings. The home page worktree section only shows when both the
feature flag is enabled and the user setting is on.
* feat: add telemetry for worktree feature usage
Track worktree feature engagement:
- worktree.view_opened: when users open worktrees view (with source)
- worktree.created: when worktrees are created (with total count)
- worktree.merge_attempted: when merge is attempted (success/conflicts)
* fix: replace DangerButton with Button variant="danger"
DangerButton component was removed from main. Use the standard
Button component with variant="danger" instead.
* Fix merge conflict artifacts
* Revert "fix(e2e): increase getSidebar timeout for slower macOS CI runners"
This reverts commit
|
||
|
Robin Newhouse
|
38f619cfd9 |
docs(skills): add Skills feature documentation (#8397)
* docs: add Skills feature documentation Add comprehensive documentation for the Agent Skills feature including: - Overview of what skills are and why they're useful - How to create skills with SKILL.md and YAML frontmatter - Global vs project skill locations - Managing skills via the UI toggle interface - Real example (data-analysis skill) - Bundling supporting files and scripts - Comparison with Rules and Workflows |
||
|
Toshii
|
b34166e99a | add web tool docs (#8408) | ||
|
Juan Pablo Flores
|
0da6ddc001 |
feat: Add Background Edit feature to enhance workflow efficiency (#8405)
* Introduced a new feature, Background Edit, allowing file changes without opening the diff editor. * Updated documentation to explain how to enable and use Background Edit, including its benefits and relationship with other features. |
||
|
Tomás Barreiroandellipsis-dev[bot]
|
c5afbd743e |
Add Remote Config OTEL docs and change the OTEL override logs (#8346)
* Add Remote Config OTEL docs and change the OTEL override logs * Add the new page to the sidebar * Update docs/enterprise-solutions/monitoring/opentelemetry.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * Update docs/enterprise-solutions/monitoring/opentelemetry_override.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * Fix inconsistent casing --------- Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> |
||
|
Tony Loehr
|
e4fbe331f4 |
sso docs (#8169)
* sso docs * sso UI first approach * added screenshot * removed keycloak mention |
||
|
|
1be314dfed |
Enterprise docs (#7714)
* enterprise docs * tested for accuracy * Reorganize Enterprise docs structure - Consolidate member management under team-management/ - Unify all configuration under configuration/ with two clear paths: - remote-configuration/ for simple cloud-based setup - infrastructure-configuration/ for advanced enterprise features - Create comprehensive overview pages explaining the differences - Update all internal links to reflect new paths - Preserve all existing content while eliminating redundancy - Maintain clear separation between admin and member documentation * removed trailing backslash * fix docs.json * enterprise docs reformat * monday update * tidied up managing members section * fixed deployment guide * simplify rules * workflow cleanup * rules tweak * Update docs/enterprise-solutions/configuration/overview.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * fix other features * fixed provider docs * fixed monitoring * fix providers * updated cta and rbac * fix enterprise overview * enterprise-docs * hid self-hosted section for now * addressed format fixed * docs: restructure monitoring navigation and move telemetry - Remove unnecessary OpenTelemetry dropdown wrapper in Enterprise navigation - Move Cline Telemetry from control-other-cline-features to monitoring section - Update all internal documentation links to new telemetry path - Simplify Control Other Cline Features section to focus on Yolo Mode only - Group related monitoring features (overview, telemetry, opentelemetry) together This creates a more cohesive navigation structure where telemetry-related features are adjacent and eliminates unnecessary nested dropdowns. * docs: rename Basic Telemetry to Cline Telemetry and add link - Rename all instances of 'Basic Telemetry' to 'Cline Telemetry' for consistency - Add href link to Cline Telemetry card in Monitoring Options section - Update section headings and subheadings to use 'Cline Telemetry' - Ensures consistent naming across monitoring documentation * docs: restructure Enterprise YOLO Mode to focus on administrator controls - Change title from 'Yolo Mode' to 'YOLO Mode' for consistency - Add reference link to /features/yolo-mode for general documentation - Remove duplicate content about basic YOLO Mode functionality - Focus exclusively on Enterprise administrator configuration and controls - Add comprehensive policy recommendations by organization size - Include security implications, monitoring requirements, and compliance considerations - Provide detailed technical implementation guidance - Update overview.mdx card description to reflect enterprise focus * docs: hide self-hosted/infrastructure configuration references - Remove choosing-your-deployment from Enterprise navigation - Remove self-hosted references from enterprise-solutions/overview.mdx - Remove self-hosted comparison and warning from remote-configuration/overview.mdx - Remove Info boxes linking to infrastructure config from provider pages (AWS, Google, LiteLLM) - Remove Self-Hosted OpenTelemetry Collector section from opentelemetry.mdx - Remove self-hosted deployment section from control-other-cline-features/overview.mdx All self-hosted/infrastructure configuration documentation remains intact but is no longer navigable or linked from SaaS provider configuration pages. This allows easy restoration when features become available. * clarified domain and seat info * fixed getOpenTabs function * Update getOpenTabs.ts * Update package.json * Revert package-lock files to main --------- Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> Co-authored-by: Juan Pablo Flores <juan@cline.bot> |
||
|
BeeandSaoud Rizwan
|
a5f6c1d732 |
feat: add auto-recovery for corrupted task history state (#7875)
* feat: add auto-recovery for corrupted task history state Add automatic reconstruction of task history when JSON parsing fails. Changes: - Modified `reconstructTaskHistory()` to return reconstruction result or null - Enhanced `readTaskHistoryFromState()` with automatic corruption recovery - Added recursive reconstruction attempt with loop prevention flag - Wrapped JSON parsing in try-catch to handle corruption gracefully When task history state file is corrupted, the system now automatically attempts to reconstruct history from existing task folders, providing better resilience against file corruption issues. * feat: Add telemetry tracking for extension storage errors Replace console.error logging with structured telemetry capture for extension storage operations. This change: - Adds a new EXTENSION_STORAGE_ERROR telemetry event type to track storage-related failures - Implements captureExtensionStorageError method with error message truncation to prevent excessive data - Replaces three console.error calls in readTaskHistoryFromState with telemetry events This improves error monitoring and provides better insights into extension storage failures while maintaining data efficiency through message truncation. * fix: improve type safety and error handling in task history Add explicit return type to reconstructTaskHistory() function and refactor error handling in readTaskHistoryFromState() with nested try-catch blocks to better distinguish between file read errors and JSON parse errors. This improves error recovery and makes error tracking more precise through separate telemetry calls. * add param to reconstructTaskHistory for manually called action --------- Co-authored-by: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com> |
||
|
Tony Loehr
|
4c2f28f2af |
docs: remove Advanced Patterns and Testing & Debugging from Hooks documentation (#7869)
- Removed advanced-patterns.mdx and testing-and-debugging.mdx files - Updated docs.json to remove these pages from navigation - Updated hooks/index.mdx to remove corresponding Card components - Simplified Hooks documentation to focus on core concepts: Overview, Hook Reference, and Samples |
||
|
Tony Loehrandellipsis-dev[bot]
|
eeb1cc7da8 |
added subpages and content to hooks (#7797)
* added subpages and content to hooks * Update docs/features/hooks/advanced-patterns.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> * Add complete hook type coverage with examples for TaskCancel, TaskComplete, TaskResume, PreCompact, UserPromptSubmit * Fix hook documentation API mismatches and add TaskComplete - Add missing TaskComplete hook to reference documentation - Fix TaskCancel/TaskResume field paths to match protobuf API - Improve security practices in hook examples - Add proper error handling and validation * Update hooks documentation: rename samples, remove PreCompact, improve structure - Rename 'Real World Examples' to 'Samples' with skill-based organization - Remove PreCompact references (feature not yet available) - Update navigation structure in docs.json - Add multiworkspace mention to Overview - Create 9 comprehensive examples (beginner/intermediate/advanced) - Clean up duplicate content and fix cross-references * Update hooks documentation: Add Windows support - Remove incorrect warning that hooks don't work on Windows - Add positive cross-platform support note (Windows, macOS, Linux) - Clarify that bash examples work with standard shells including Git Bash/WSL on Windows * fixed hooks overview redirect * Add UI screenshots to hooks documentation * hooks in action * fixed hooks overview and examples * fixed terminology * fixed hooks examples * hooks groupings * fixed appearance of hook names * refactor hook docs --------- Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> |
||
|
Saoud Rizwan
|
b15c364a62 | feat: add 'Explain Changes' feature for code review (#7765) | ||
|
Juan Pablo Flores
|
b0bd0e3974 | Docs/task history recovery (#7776) | ||
|
Dominic Cooneyandellipsis-dev[bot]
|
bcbaa4518d |
docs: Document proxy settings. (#7637)
* docs: Document proxy settings. * Update docs/troubleshooting/networking-and-proxies.mdx Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> --------- Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> |
||
|
|
c15287ace0 |
Creates and Refactor Enterprise Docs (#7365)
* Refactor enterprise documentation: reorganize member management and roles, add AWS Bedrock configuration guides, and remove outdated security concerns section. * Update docs/enterprise-solutions/provider-remote-config/aws-bedrock/admin-configuration.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: reneehuang1 <100229782+reneehuang1@users.noreply.github.com> |
||
|
Juan Pablo FloresandCopilot
|
c94e2cf913 |
Upgrade/workflows docs (#7593)
* feat(workflows): restructure and enhance workflows documentation with best practices and quick start guide * feat(workflows): enhance documentation with modular workflow practices and new PR review workflow example * feat(workflows): improve clarity in workflow creation instructions * Update docs/features/slash-commands/workflows/best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> |
||
|
Alex KerandAlexKer
|
f2ddab71f1 |
updated baseten docs to include kimi instructions and updated location (#7588)
Co-authored-by: AlexKer <AlexKer@users.noreply.github.com> |
||
|
|
571480e3b6 |
Hooks docs (#7173)
* 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> |
||
|
|
5c2c264a1d |
initial CLI samples (#7040)
* initial CLI samples * Add GitHub integration and root cause analysis samples to CLI documentation * docs(cline-cli): restructure samples into nested documentation group Convert the single samples page into a grouped navigation structure with three separate sample pages: - Overview (main samples page) - GitHub Issue RCA - GitHub Integration Add redirect from the old `/cline-cli/samples` path to the new `/cline-cli/samples/overview` location to maintain backward compatibility with existing links. * docs: improve GitHub issue RCA sample docs with better structure and links Reorganize documentation with source code links, move demo video to prominent position, simplify explanations, and add tutorial references for better discoverability. * docs: improve github-issue-rca documentation and add download instructions - Remove redundant "Demo Video" heading from mdx documentation - Add "Getting the Script" section to README with two options: - Option 1: Clone/view repository with direct link to script - Option 2: Direct download using curl with example commands These changes make it easier for users to quickly access and download the analyze-issue.sh script without needing to navigate the repository structure, improving the overall user experience. * docs: update GitHub Root Cause Analysis sample links and enhance README with installation instructions * docs(samples): improve GitHub integration setup guide and add prerequisites Enhanced the GitHub integration sample documentation with: - Added prerequisites section listing required knowledge and resources - Improved setup instructions with direct curl commands for downloading files - Added prominent warning callout for editing GITORG and GITREPO variables - Included beginner-friendly note recommending simpler sample first - Updated documentation link to point directly to GitHub repository - Provided two options for adding analysis script (download or copy) - Enhanced formatting and clarity throughout the guide These changes make the sample more accessible to new users and reduce setup friction by providing copy-paste commands and clearer guidance. * docs(samples): consolidate CLI samples documentation and enhance GitHub integration README with improved image formatting * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * removes bookmarks and creates padding for images * Update image source in README for CLI sample * Add GitHub CLI samples and update docs navigation - Add GitHub Issue RCA sample (docs/cline-cli/samples/github-issue-rca.mdx) - Add GitHub Actions integration sample (docs/cline-cli/samples/github-integration.mdx) - Add samples overview page (docs/cline-cli/samples/overview.mdx) - Update docs.json to include new CLI samples navigation entries * docs: simplify "Getting the Script" section in GitHub Issue RCA sample Reorder options so curl download is Option 1 and the full script view is Option 2. Remove the clone/view-repo entry, move the chmod +x instruction into a Note after the script accordion, and clarify the Basic Usage intro text. * docs: tidy GitHub Integration sample — remove redundant workflow placement note, simplify script copy options, fix GitHub Action capitalization and related-samples link * docs: remove GitHub Integration and GitHub Issue RCA sample READMEs --------- Co-authored-by: Juan Pablo <juan@cline.bot> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> |
||
|
Juan Pablo FloresandCopilot
|
8f8c4561a6 |
Docs upgrade (#6907)
* style(docs): update background color scheme to neutral tones Update documentation background colors from purple-tinted theme to neutral gray tones. Changed light mode from lavender (#F0E6FF) to off-white (#fafaf9) and dark mode from pure black (#000000) to dark gray (#0f0f0f) for improved visual consistency. * refactor(docs): remove gradient decoration from theme config Remove the "decoration": "gradient" property from the documentation theme configuration. This simplifies the theme settings by removing the gradient decoration option from the color configuration object. * docs: change documentation font family to Geist Mono Replace Roboto with Geist Mono as the default font family in the documentation configuration. This updates the visual styling of the documentation to use a monospace font, which may improve readability for code-heavy content. * docs: update branding and restructure navigation - Replace robot panel logos with new Cline brand logos - Add icons to navbar links (Docs, GitHub, Discord) - Restructure navigation from groups to tabs format - Add icons to navigation items for improved UX - Include new Docs link in navbar with book icon This update modernizes the documentation appearance and improves navigation hierarchy for better user experience. * docs: restructure navigation with hierarchical groups and pages Restructured documentation navigation from flat menu to organized groups: - Removed redundant "Docs" link from navbar - Migrated from "menu" to "groups/pages" structure - Added comprehensive page organization with nested groups: * Introduction, Getting Started, Features * Prompting Skills, Cline's Tools, Enterprise Solutions * MCP Servers, Provider Configuration - Organized features into logical subgroups (@ Mentions, Commands, Customization, Slash Commands) - Improved documentation discoverability and hierarchy This change provides better content organization and easier navigation for users exploring different aspects of Cline documentation. * docs: remove contextual options from documentation config Remove the contextual configuration section containing the "copy" option from docs.json. This simplifies the documentation configuration by removing unused contextual menu options. * docs(multiroot): improve workspace documentation with limitations and technical details - Add important note about experimental limitations affecting Cline rules and checkpoints - Add "How it works" section explaining automatic workspace detection and tracking - Reorganize technical behavior section with detailed subsections for workspace detection, path resolution, and command execution - Document workspace hint syntax for explicit file references (@workspaceName:path) - Standardize heading capitalization to sentence case for consistency - Improve overall content organization and clarity for better user understanding This update provides users with clearer information about the multiroot feature's current state, its limitations, and how to effectively use workspace hints when working with multiple project folders. * docs: restructure overview page with enhanced visual layout - Convert plain markdown sections to CardGroup and Card components with icons - Add tabbed interface for Plan & Act Mode explanation - Update description from "development assistant" to "coding agent" - Reorganize content for improved readability and visual hierarchy - Enhance feature presentations with icon-based cards Improves user experience by transforming the overview documentation into a more visually appealing and scannable format using modern documentation components. * docs: improve installation guide with enhanced structure and UX Restructure the Cline installation documentation to improve readability and user experience: - Add prominent note highlighting 2-minute installation time - Convert prerequisites into visual card components for better clarity - Transform installation steps into structured Step components for easier following - Add manual installation instructions for JetBrains IDEs - Include feature compatibility accordion for JetBrains users - Enhance visual hierarchy with improved component usage (CardGroup, Steps, Accordion) - Simplify language and improve descriptions throughout This makes the installation process clearer for new users and reduces friction during onboarding. * style(docs): remove text opacity reduction for better readability * docs: refactor model selection guide with visual step-by-step instructions - Replace tab-based layout with linear step-by-step flow - Add screenshots for each configuration step (config, provider, API, model) - Reorganize content structure for improved clarity and user experience - Add quickstart options and streamlined provider recommendations - Improve navigation with visual aids to help users configure Cline faster * docs: add installation screenshots and context management guide * docs: flatten provider config structure in documentation Remove the "Alternative Providers" grouping and move all provider configuration pages (OpenRouter, Cerebras, DeepSeek, Groq, xAI Grok, Mistral AI, Doubao, Fireworks, and ZAI) to the main provider configuration list. This simplifies the documentation navigation by treating all providers equally rather than categorizing some as alternatives. * docs: restructure context management docs and improve content clarity **Changes:** - Reorganized documentation structure by moving context management from `/best-practices` to `/prompting` section for better categorization - Added URL redirect to maintain backward compatibility for old links - Updated navigation references in welcome page to point to new location - Improved readability of context management explanations with more narrative, conversational prose - Enhanced context window documentation by adding cache tokens indicator and using emoji-based formatting for better visual clarity - Streamlined Cline Memory Bank setup instructions from 4 to 3 steps - Updated context bar screenshot to use newer image asset **Why:** Better documentation organization and improved user experience through clearer explanations of how Cline builds and manages context during tasks. * docs(context-management): convert Quick Reference to Info component Replace blockquote formatting with Info component for the Quick Reference section in the context management documentation. This improves visual presentation and maintains consistency with documentation standards. Also removes trailing whitespace at the end of the file for cleaner formatting. * docs: add Cline Enterprise overview and restructure enterprise section - Add comprehensive enterprise overview documentation covering security, governance, observability, and developer experience features - Rename "Enterprise & Security" navigation group to "Enterprise" - Consolidate enterprise documentation by replacing 4 pages with 2: new overview page and security concerns - Document BYOI (Bring Your Own Inference), SSO authentication, and role-based access control capabilities This restructuring provides a clearer entry point for enterprise users and consolidates previously scattered enterprise information into a cohesive overview document. * docs(enterprise): streamline enterprise overview and update font - Change documentation font from Geist Mono to Geist Sans - Add enterprise website link card for detailed information - Remove Developer Experience, Proven at Scale, and Pricing sections - Consolidate Flexible Inference section content - Simplify enterprise overview to focus on core capabilities These changes reduce redundancy by directing users to the enterprise website for pricing and detailed features while keeping the docs focused on technical implementation and core capabilities. * clean-images * Update docs/getting-started/installing-cline.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/styles.css Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs(cline-cli): add platform availability warning to overview Add a prominent warning callout indicating that Cline CLI is currently in preview and only supports macOS and Linux, with Windows support coming soon. This sets clear expectations for users about platform compatibility. Also remove redundant introductory text in the "What you can build with this" section to improve content clarity. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> |
||
|
|
16e1c02b98 |
add cli docs (#6836)
* ready for review * WIP: late-breaking cli arg change fix-ups (still more to double-check) * updates for late-breaking CLI changes * updated docs to match yesterday's usage updates * docs(cli): restructure documentation and add dedicated installation guide - Extract installation instructions into separate installation.mdx page - Simplify overview.mdx to focus on use cases and getting started - Improve cli-reference.mdx with quick help commands section - Reorganize content for better information architecture - Make documentation more user-friendly and action-oriented This restructuring separates concerns: installation details are now in their own page, the overview focuses on what Cline CLI can do, and the reference page is more accessible with inline help examples before the full manual. --------- Co-authored-by: Juan Pablo <juan@cline.bot> Co-authored-by: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com> |
||
|
canvrnoandKevin Bond
|
feee75b158 |
Added multiroot docs (#6597)
Co-authored-by: Kevin Bond <kevin@Kevins-MacBook-Pro.local> |
||
|
Juan Pablo Flores
|
246b0fa999 |
Add documentation for changes introduced in 3.30 (#6512)
* docs: update what-is-cline to use generic IDE references Updated documentation to replace VS Code-specific references with generic "IDE" terms, making it applicable to modern IDEs beyond VS Code for broader compatibility. * docs: expand Cline installation guide with comprehensive setup instructions - Add prerequisites section with account creation and editor compatibility - Include detailed installation steps for VS Code/Cursor and JetBrains IDEs - Add troubleshooting sections for common installation issues - Expand editor support information and setup guidance - Improve documentation structure with tabs and accordions for better UX * docs: remove font weight and reorder getting started pages - Remove font weight property from fonts configuration - Reorder getting started pages to place installation before model selection guide * fixes title font-weight to original values * docs: improve JetBrains plugin installation link text Replace generic URL text with descriptive "JetBrains Marketplace" link text for better user experience and accessibility in the Cline installation guide. * docs: add voice mode feature documentation and cross-references Add comprehensive documentation for Voice Mode feature including setup instructions, use cases, and technical requirements. Also add cross-reference tip in plan-and-act.mdx to promote voice mode usage during planning discussions. * docs: rename voice-mode to dictation for clarity Rename voice-mode.mdx to dictation.mdx and update all references throughout the documentation to use "Dictation" instead of "Voice Mode" for more accurate terminology and better user understanding. * feat(docs): add YOLO mode documentation Add comprehensive documentation for YOLO mode feature, covering auto-approval functionality, safety warnings, use cases, and best practices for autonomous operation. * docs: reorganize navigation structure and add redirect for JetBrains install page - Remove JetBrains installation page from getting-started section - Reorder Features section with @ Mentions first, followed by alphabetically sorted individual features - Move Slash Commands group after individual features and add workflows page - Add yolo-mode feature to the end - Add redirect from old JetBrains install path to main installation guide * docs: improve JetBrains logo visibility and simplify dictation instructions - Remove Frame wrapper around JetBrains logo for cleaner markup - Add CSS styling to ensure JetBrains logo visibility in dark mode with background, border, and hover effects - Simplify dictation instructions by removing redundant recording state description |
||
|
Igor Tceglevskii
|
58b14c69b1 | CLINE_ACTIVE usage (#6471) | ||
|
celestial-vaultandJuan Pablo
|
1bdd1e943f |
Add docs for opening cline in right sidebar (#6292)
* Add docs for opening cline in right sidebar * use frame tags * change to gifs * docs(customization): refactor sidebar instructions with Steps component Updated opening-cline-in-sidebar.mdx to replace numbered lists with structured <Steps> components for improved readability. Also updated image sources and added a link for Cursor alignment guidance. --------- Co-authored-by: Juan Pablo <juan@cline.bot> |
||
|
Ara
|
c16e271c14 |
Adding voice mode to Cline (#6208)
* Adding voice mode |
||
|
Alex KerandAlexKer
|
2668bcdbe0 |
added baseten link to docs.json (#6312)
* added baseten link to docs.json * fixed docs formatting --------- Co-authored-by: AlexKer <AlexKer@users.noreply.github.com> |
||
|
Nick Baumann
|
ecc58178dc |
Jetbrains docs (#5948)
* docs: Update Claude Code documentation to include Pro plans alongside Max plans * Add JetBrains installation documentation - Create comprehensive installation guide for JetBrains IDEs - Include both marketplace and manual installation methods - Document supported IDEs and key differences from VSCode - Add alpha status note and terminal integration limitations - Update docs.json navigation to include new page * Add images to JetBrains installation documentation - Add demo GIF showing Cline in action in JetBrains IDE - Add screenshot of JetBrains marketplace download page - Add screenshot of Install Plugin from Disk dialog - Add screenshot of file selection dialog with zip file - Complete visual walkthrough of installation process * Update JetBrains demo to high-quality GIF - Replace jetbrains-demo.gif with jetbrains-demo-hifi.gif - Improved visual quality for better user experience * Add JetBrains settings dialog screenshot - Add screenshot showing the main settings dialog - Provides visual guidance for accessing IDE settings - Complete visual walkthrough now includes 5 screenshots * Add JetBrains logo and finalize documentation - Add JetBrains logo at top of page with proper styling - Update content with user revisions (BYOK note, streamlined structure) - Complete visual installation walkthrough with 5 images - Ready for PR review |
||
|
Nick Baumannandpashpashpash
|
2ebd92ee94 |
docs: Add 5 new provider guides and update model selection guide (#5716)
Co-authored-by: pashpashpash <nik@cline.bot> |
||
|
Daniel Steigmanandpashpashpash
|
8806beda20 |
Change default strict plan mode setting to enabled (#5714)
* Change default strict plan mode setting to enabled - Updated default from false to true in state-helpers.ts (primary backend default) - Updated fallback default in controller/index.ts (Task initialization) - Updated frontend default in ExtensionStateContext.tsx for consistency - Fixed linting issue with forEach callback return value - New users will now have strict plan mode enabled by default - Prevents file edits in Plan Mode, enforcing cleaner separation of planning vs execution * added changeset --------- Co-authored-by: pashpashpash <nik@cline.bot> |
||
|
JoshandSaoud Rizwan
|
6dc44b9c7e |
Add vercel ai gateway provider (#5355)
* Add vercel ai gateway provider * Formatting * grab correct context window field * changelog * Post-rebase fixes * fix formatting * Update model picker, add reasoning tokens to output * Fix Vercel AI Gateway model info persistence * use cache service rather than getallextensionstate * Reorder vercel gateway option * Show image support info * Fix providerUtils.ts * Fix broken model id and merge conflict issue * fix pricing display for free users * revert ts ignore * revert to cost field, add note for free users 0 cost * udpate gateway docs * Delete docs/package-lock.json --------- Co-authored-by: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com> |
||
|
ershang-fireworks
|
7e7280d7c5 |
Fix fireworks provider (#5435)
* fix * fix default model id * fix tests * Add changeset for fireworks provider fix * add docs for fireworks provider * add empty line to doc * format * fix model selector * remove unnecessary * fix test |