* docs: correct shared paths, log files, commands and tool names
Several pages repeat the same facts about where Cline keeps its files,
which commands exist and what the built-in tools are called, and many of
them no longer match the shipped CLI and SDK:
- Workflows live in ~/.cline/workflows/, not ~/.cline/data/workflows/.
The session index is ~/.cline/data/db/sessions.db, each session has a
folder of JSON files, and hub locks and logs are under ~/.cline/data/.
- cline start and cline dev log do not exist; the log command is
cline doctor log, and the CLI log is ~/.cline/data/logs/cline.log.
- The built-in tools are run_commands, search_codebase,
fetch_web_content and skills, not bash, search, fetch_web and
use_skill.
- CLINE_HUB_ADDRESS is read only by cline schedule; the hub port is
CLINE_HUB_PORT.
- No CLI 3 release reads CLINE_COMMAND_PERMISSIONS. The pages that
offered it, including the PR review sample, now say the CLI has no
command allow list and point to a PreToolUse hook. The unused
permissionDeniedError string in the VS Code prompts goes with it.
Part of #14853.
Co-authored-by: Mikołaj Kondratek <19799111+mkondratek@users.noreply.github.com>
Co-authored-by: Manpreet Kaur <26463231+Manpreet2298@users.noreply.github.com>
Co-authored-by: Renee Huang <100229782+reneehuang1@users.noreply.github.com>
* docs: qualify log, tool routing and command-approval advice
- cline doctor log always opens the default log file, so say so where
CLINE_LOG_PATH is described.
- The editor and apply_patch choice is a default that SDK callers can
replace with toolRoutingRules.
- The PR review sample now warns that hooks and plugins in the checked-out
pull request run with the job's environment, and says how to keep them
from running before relying on a global PreToolUse hook.
- The conditional-approval example no longer auto-approves git diff,
which runs a configured external diff program, and notes that Git can
run programs named in a repository's config.
* docs: run the PR review sample with a read-only token
The sample gave an auto-approved Cline run a token that can write pull
requests. Split it into two jobs: `review` runs Cline with read-only
permissions on a checkout of the base branch and writes review.md;
`post` runs no repository or model code and posts the file with
`gh pr review --comment`.
Skip pull requests from forks and Dependabot, which get no secrets,
and warn against `pull_request_target`. Fence the workflow with four
backticks so the code block inside the prompt no longer ends it early.
---------
Co-authored-by: Dominic Cooney <55120+dominiccooney@users.noreply.github.com>
Co-authored-by: Mikołaj Kondratek <19799111+mkondratek@users.noreply.github.com>
Co-authored-by: Manpreet Kaur <26463231+Manpreet2298@users.noreply.github.com>
Co-authored-by: Renee Huang <100229782+reneehuang1@users.noreply.github.com>
* shared: expose workspace/global rules path helpers and search redirected Documents
resolveWorkspaceRulesConfigPaths returns both supported workspace rule
layouts (.clinerules and .cline/rules) so hosts can stop hardcoding one
of them (#14186). resolveGlobalRulesConfigPaths returns every global
rules location and now also includes OneDrive Known-Folder-Move
Documents candidates: the VS Code extension resolves the real Documents
folder through the OS and creates global rules there, so on Windows
machines with redirected Documents the SDK resolver (used by the
desktop app and CLI) never found them (#14144).
* vscode: surface rules from every shared resolver location in the Rules panel
The Rules panel's toggle refresh was hardcoded to the workspace
.clinerules directory and the Documents global directory, so rules the
SDK runtime loads from .cline/rules (and global ~/.cline/rules,
~/Cline/Rules) were applied to the model but silently missing from the
panel (#14186). Synchronize toggles across every directory the shared
resolver searches, combining per-directory results the same way the
Cursor rules multi-location handling already does.
Also drop the ambient @cline/shared/storage stub: it shadowed the real
module declaration and hid every export the stub didn't re-declare;
tsc resolves the real dist types fine.
* desktop: classify .cline/rules workspace rules as Project in Customize view
The Rules tab grouped project rules only when their path contained
/.clinerules/, so rules in the .cline/rules layout were shown as Global
(#14186, #14144).
* fix(desktop): anchor rule scope to workspace roots and document layouts
---------
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
* docs: add enforced .clineignore guard plugin example
Adds clineignore-read-files-guard.ts, a beforeTool hook plugin that blocks
read_files, editor, apply_patch, and run_commands calls targeting paths
matching gitignore-style patterns in a workspace .clineignore file, and
protects .clineignore itself from modification. Features it on the
.clineignore docs page as the enforced replacement for the deprecated
built-in feature.
Co-authored-by: Saoud Rizwan <saoudrizwan@users.noreply.github.com>
* docs: use a PreToolUse file hook for the enforced .clineignore example
Replaces the plugin-based guard with a PreToolUse hook script that works in
the VS Code extension today (.clinerules/hooks/PreToolUse plus the Enable
Hooks setting) as well as the CLI (.cline/hooks/PreToolUse.sh). The script
handles both hook payload shapes, blocks read_files/editor/apply_patch/
run_commands calls matching .clineignore patterns, and protects .clineignore
itself from modification.
Co-authored-by: Saoud Rizwan <saoudrizwan@users.noreply.github.com>
* fix: canonicalize paths in .clineignore guard hook
Lexically collapse '.', '..', and empty segments before the ignore match
and the .clineignore self-protection check, closing bypasses via
noncanonical paths like ./.clineignore, secrets/../.env, or
/root/./file (Greptile review finding on #13649).
Co-authored-by: Saoud Rizwan <saoudrizwan@users.noreply.github.com>
* docs: note symlink limitation in .clineignore guard hook docs
Co-authored-by: Saoud Rizwan <saoudrizwan@users.noreply.github.com>
---------
Co-authored-by: Saoud Rizwan <saoudrizwan@users.noreply.github.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
* docs: fix typos and incorrect slash command reference
- Fix double period in MiniMax provider description
- Remove duplicate 'through' in kanban install description
- Fix /new -> /newtask (correct slash command name)
* docs(hooks): fix description to reference SDK Plugins, not SDK Hooks
The description said 'SDK Hooks page' but the content links to the
SDK Plugins page (/sdk/plugins). Align the description with the
actual destination.
* docs: mark .clineignore as deprecated soon
Add a deprecation notice to the .clineignore page and update pages that recommend it. Enforcement of ignore rules is extremely difficult (agents can get around them via @ mentions or shell commands), and the feature is orphaned in the VS Code/JetBrains extension (ClineIgnoreController), not part of the Cline SDK or CLI.
* docs: update clineignore deprecation wording
* wording changes
* update clineignore docs with plugin reference
* fix plugin example url
* edit clineignore docs file
* update formatting for clineignore doc
* clean up clineignore docs file
---------
Co-authored-by: Cline <bot@cline.bot>
Co-authored-by: TheRealSpencer <spencer@cline.bot>
The Skills note pointed users to "Settings → Features → Enable Skills,"
but that toggle no longer exists — the Features settings section has no
Skills entry and skills are loaded by default. Point users to the actual
Skills menu (scale icon → Skills tab), consistent with the access path
already documented later in the same page.
Fixes#11740
Co-authored-by: Minhkunn <minh.12072k6@gmail.com>
* 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>
* Add provider/model context to all hook payloads
* Fixes as per Greptile feedback
* Further fixes as per Greptile feedback
* Further fixes as per Greptile feedback
* further fixes as per Greptile feedback
* Fix flapping hooks tests on Windows
* feat(hooks): add Windows hook execution via PowerShell
* chore(changeset): add release note for Windows hooks
* Get hooks working on Windows
Remove changeset file (we no longer use changeset files)
feat(hooks): support Windows PowerShell hook resolution and management
feat(hooks): complete windows powershell hook support and tests
Detect linux-style hooks only on macOS and linux and detect PowerShell-style hooks only on Windows
Fixes for failing unit tests on Windows in CI
Fix failing unit tests on Windows in CI
Fix unit tests for hooks on Windows
Be clear about .ps1 file extension for hooks in PowerShell vs. bash/binary for linux-style hooks
Remove separate test suite step
Reapply hooks-specific test suite
Fix failing hooks tests
* Harden Windows hook PowerShell runtime and test coverage
* test: centralize hook test env and platform overrides
---------
Co-authored-by: Saoud Rizwan <7799382+saoudrizwan@users.noreply.github.com>
