* 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>
* 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
* Complete documentation for environment variable-based OpenTelemetry configuration
* Address PR review comments
- Add Values column to OTLP Configuration table for consistency
- Fix New Relic endpoint to include required port 4318
- Add note about Datadog region-specific endpoints
Remove Teams Plan as an option for seat upgrades in the managing-members documentation. This aligns with the product strategy to drive customers toward Enterprise for any multiplayer/team scenarios.
Related: https://github.com/cline/cline-web/pull/256
* 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>
* Replace process.env usage with a BUILD_CONSTANTS variable
* Update import
* revert doc update
* Enable configuring an OTEL collector at runtime
* Refactor
* Refactor
* Add changeset
* Do not build IS_STANDALONE
* Add comment
* Update the `.env.example` file
* Remove `true` from the selected options and revert env.example
* Use `true` for runtime variables
* 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>
* 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>
* docs: add xAI Grok and Mistral AI provider configs
* docs: add Anthropic Claude model configuration guide
- Add comprehensive documentation for configuring Anthropic Claude models with Cline
- Include API key setup, supported models list, and configuration steps
- Cover advanced features like prompt caching and rate limits
- Update navigation to include new Anthropic page in custom model configs section
* docs: add DeepSeek, Ollama, OpenAI, OpenAI Compatible pages and update Plan & Act
* docs: add Extended Thinking section to Anthropic configuration guide
* docs: update vscode language model api page
* docs: update vscode language model api docs
* Add model documentation pages and update navigation structure
- Add new documentation pages for model overviews (Claude, Gemini, OpenAI, XAI)
- Add general models overview page
- Update docs.json to include new model documentation in navigation
- Update OpenAI-compatible model documentation
* Remove Notes column from model documentation tables for consistency
* Fix table formatting in Gemini models documentation
* added 5 new model configurations and updated existing ones
* Update AWS Bedrock documentation with minimal IAM permissions
* modified: docs/get-to-know-the-models/claude-models.mdx
* Renamed 'custom model configuration' to 'provider configuation' to avoid providers being confused with models
* Fix dollar sign rendering in model documentation
- Escape dollar signs in pricing tables to prevent MDX parsing issues
- Fixes disappearing dollar signs in gemini-models.mdx and other model docs
- Dollar signs now display correctly as literal currency symbols
* Add feature descriptions to OpenAI and XAI model docs
- Added 'Diverse Performance for Different Tasks Across Model Tiers' section to OpenAI models
- Added 'Real-time Information Access' section to XAI models
- Maintains consistency with existing Claude and Gemini documentation format
- Highlights valuable features for agentic AI coding workflows
* removing these files due to name change in header. they're in the new docs/provider configs folder
* added 2 new issues per model page + formatting
* Update model documentation files
* Fix: Correct paths in docs.json for provider configs
* docs: update docs.json and apply formatting
* docs: fix broken links, add OpenRouter & Requesty pages
* docs: remove 'get to know the models' section and files
* Update docs/provider-config/openai-compatible.mdx
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
---------
Co-authored-by: kevinneung <94151024+kevinneung@users.noreply.github.com>
Co-authored-by: Dennise Bartlett <bartlett.dc.1@gmail.com>
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
Robin Newhouse