* 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>
* 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>
* 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>
* 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>
* 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
* 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>
* 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
* 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>
* 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
* Enable biome rules: noUnusedVariables, noUnusedFunctionParameters, noUnusedImports
* Apply new rules with format
* remove unused currentReplaceContent
* update nextTerminalId
* fix all format issues
* update biome config
* add back applyContextOptimizations and killAllChromeBrowsers
* 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>
