Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

1,027 pages for path.

Titles and paths first, then pages whose text carries it. Each row opens that page as this site last read it.

Choose a permission mode Claude Code CLI · in the page permission-modes …sion-mode manual` or `"defaultMode": "manual"`. Writes to [protected paths](#protected-paths) are never auto-approved except in `bypassPermissions` mode and in plan-mode sessions where bypass permiss… Configure permissions Claude Code CLI · in the page permissions …mmon filesystem commands such as `mkdir`, `touch`, `mv`, and `cp` for paths in the working directory or `additionalDirectories` | | `plan` | Claude reads files and runs read-only shell commands to exp… Test plugins with evals Claude Code CLI · in the page plugin-evals …the report and iterate** Open the `Published:` URL, or the `Report:` path when no `Published:` line appears, to see each grader's verdict and explanation for every run, and for `llm` graders the judg… Plugin commands reference Claude Code CLI · in the page plugins/cli-reference …es the fields below. `id`, `version`, `scope`, `enabled`, and `installPath` are always present, and the others appear only when they apply. | Field | Type | Description | | :- | :- | :- | | `id` | st… Code intelligence plugins Claude Code CLI · in the page plugins/code-intelligence …rver typescript`. After you install the binary, confirm it's on the `PATH` of the shell you start `claude` from, for example with `which typescript-language-server`, or `Get-Command typescript-langua… Add components to a plugin Claude Code CLI · in the page plugins/components …ol. While the plugin is enabled, Claude Code puts this folder on the `PATH` of the shell it runs commands in, so Claude, or a skill's instructions, can run the tool by name without the user installing… Create a Claude Code plugin Claude Code CLI · in the page plugins/create …e steps from it. You can keep a plugin anywhere, because you pass its path to Claude Code when you start a session. **1. Create the plugin directory** Create the plugin directory, with a `.claude-pl… Create a marketplace Claude Code CLI · in the page plugins/create-marketplace …ry and needs a `name` and a `source`. Write the entry's `source` as a path from the marketplace root. The root is `my-marketplace/`, the directory that contains `.claude-plugin/`. ```json my-marketpl… Plugin dependencies Claude Code CLI · in the page plugins/dependencies …own repository, so the plugin's author creates the tags * **Relative path such as `./plugins/secrets-vault`**: the marketplace repository, so the marketplace maintainer creates the tags ### Create a… Host and maintain a marketplace Claude Code CLI · in the page plugins/host-marketplace …marketplace add /Volumes/shared/claude-plugins` | Read access to the path | To pin a branch or tag of a GitHub or git-URL marketplace, tell users to append `#<ref>`, as in `your-org/your-marketplace… Install and manage plugins Claude Code CLI · in the page plugins/install …lace.git#v1.0.0` | | Local directory or file | A relative or absolute path to a directory that holds `.claude-plugin/marketplace.json`, or to the JSON file itself. Start a relative path with `./` or `… Plugin loading reference Claude Code CLI · in the page plugins/loading …nstalled_plugins.json` records each install with its `scope`, `installPath`, and `version` * `cache/` holds the plugin files * **Loaded, in the running session**: the plugin set Claude Code loaded a… Plugin manifest reference Claude Code CLI · in the page plugins/manifest-reference …ence for plugin.json: every field with its type and default, accepted path forms, and the userConfig and environment variable schemas. A plugin manifest is the `plugin.json` file in a plugin's `.clau… Marketplace reference Claude Code CLI · in the page plugins/marketplace-reference …rces](#marketplace-sources) * **Output from [`claude plugin validate <path>`](/docs/en/plugins/cli-reference)**: [Validation messages](#validation-messages), which maps each message to the field it na… Manage mods for your organization Claude Code CLI · in the page plugins/mods/admin …a user's machine, start Claude Code there with `--plugin-dir` and the path of a directory that holds a mod, such as `claude --plugin-dir ./first-mod`. The mod's hooks don't run, and the transcript and… Use the mods API Claude Code CLI · in the page plugins/mods/api …of access: | Namespace | What it does | | :- | :- | | `$.fs` | `read(path)`, `write(path, text)`, `exists(path)`, `stat(path)`, and `list(path)` work on files and directories | | `$.process` | `run([… Create a mod Claude Code CLI · in the page plugins/mods/create …h is `~/.claude/dev-mods/` followed by the session's ID. A mod's full path looks like `~/.claude/dev-mods/3f2a9c1e-5b7d-4e8a-9c21-6d0f4b8a7e13/git-branch/`. > [!NOTE] > > In the `default` and `accept… React to events with a mod Claude Code CLI · in the page plugins/mods/events …nst changed = !result.deny && !result.isError if (changed && e.file_path.endsWith('.mdx')) $.ui.log('Claude changed ' + e.file_path) // Return the result as it came, so Claude reads what the tool… Interface gallery for mods Claude Code CLI · in the page plugins/mods/gallery …ng in these screenshots. ### `Code` Name the `language`, or pass a `path` for Claude Code to infer it from. With `startLine`, the lines are numbered from that number: ```javascript theme={null} Cod… Draw in the interface with a mod Claude Code CLI · in the page plugins/mods/interface …URL such as `http://localhost:3000` * **No `@`**: write an `@` in the path or query as `%40` * **Spelling**: what `new URL(href).href` returns, apart from a missing `/` after the host. That excludes a… Mods reference Claude Code CLI · in the page plugins/mods/reference …d fields. | | `hooks/hooks.json` | Yes | `modules`: an array with one path, relative to this file, to the hooks module, as in `"modules": ["./register.js"]`. Can also hold [settings hooks](/docs/en/ho… Test a mod Claude Code CLI · in the page plugins/mods/test …ol: 'Bash', command: 'ls' }) await $.tool.call({ tool: 'Read', file_path: 'README.md' }) // Run /tally and check the text its hook returns const answer = await $.command.run({ command: 'tally',… Troubleshoot a mod Claude Code CLI · in the page plugins/mods/troubleshoot …n your shell start Claude Code with `--debug`, or with `--debug-file <path>` to choose where it goes: ```bash theme={null} claude --debug-file ./mod-debug.log --plugin-dir ./first-mod ``` In another… Manage Claude Code plugins for your organization Claude Code CLI · in the page plugins/org …ins that Claude Code fetches from a git repository, a URL, or a local path. Once you register a marketplace on a machine, Claude Code can install plugins from it. To install plugins for a fleet, set… Plugins overview Claude Code CLI · in the page plugins/overview …ace](https://claude.com/marketplace/plugins). This diagram shows the path from a marketplace to your session. A marketplace lists a plugin, you install that plugin, and Claude Code loads its componen… Publish and distribute a plugin Claude Code CLI · in the page plugins/publish …p `--strict` if you chose to omit `version` in the previous step. * **Paths**: validation reports component paths that don't start with `./`. Inside hook commands and MCP server configs, refer to file… Recommend plugins for your org Claude Code CLI · in the page plugins/relevance …ry.terraform.io"]`. Bare lowercase hostname only: no scheme, port, or path. Exact case-insensitive match. | 20 entries of 128 characters each | | `filesRead` | array of strings | Glob patterns matched… Plugin security and trust Claude Code CLI · in the page plugins/security …ry**: Claude Code adds each enabled plugin's `bin/` directory to the `PATH` of the Bash tool's shell, so Claude's Bash commands can run any executable there. A command that Claude runs with the [Power… Troubleshoot plugins Claude Code CLI · in the page plugins/troubleshooting …al command`. The cause isn't the plugin command. Follow [Verify your PATH](/docs/en/troubleshoot-install.md#verify-your-path), then retry the plugin command. ### `Unknown command` and command spelli… How Claude Code uses prompt caching Claude Code CLI · in the page prompt-caching …aiting for auto-compaction to trigger mid-task. If you've gone down a path you want to abandon entirely, [`/rewind`](#rewinding-the-conversation) to an earlier turn instead. Rewinding truncates back t… Prompt library Claude Code CLI · in the page prompt-library …er', cat: 'Understand', roles: [], prompt: 'explain what {path} does and how data flows through it. write it up as {format}', slots: { path: 'src/scheduler/queue.ts', forma… Quickstart Claude Code CLI · in the page quickstart …isn't found or isn't recognized, the install directory isn't on your PATH yet: see [Fix your PATH](/docs/en/troubleshoot-install.md#command-not-found-claude-after-installation). If you see `The toke… Continue local sessions from any device with Remote Control Claude Code CLI · in the page remote-control …t configuration all stay available, and typing `@` autocompletes file paths from your local project. * **Work from both surfaces at once**: the conversation and the progress of [subagents](/docs/en/su… Automate work with scheduled tasks Claude Code CLI · in the page routines …o my nightly review for pull requests opened in acme/webapp`. The CLI path requires Claude Code v2.1.225 or later. When Claude adds the trigger, it replies with a link to the task the trigger fires.… Choose a sandbox environment Claude Code CLI · in the page sandbox-environments …spawn arbitrary code. [Permission rules](/docs/en/permissions.md) for path or domain gate them instead. * [MCP](/docs/en/mcp.md) servers, [command hooks](/docs/en/hooks.md#command-hook-fields), and [p… Configure the sandboxed Bash tool Claude Code CLI · in the page sandboxing …ditional-directories-grant-file-access-not-configuration). [Protected paths](#protected-paths) stay write-denied | [`filesystem.allowWrite`](/docs/en/settings-reference#sandbox-filesystem-allowwrite),… Run prompts on a schedule Claude Code CLI · in the page scheduled-tasks …oks for the file in two locations and uses the first one it finds. | Path | Scope | | :- | :- | | `.claude/loop.md` | Project-level. Takes precedence when both files exist. | | `~/.claude/loop.md` |… Security Claude Code CLI · in the page security …Bash commands like `mkdir`, `touch`, `rm`, `mv`, `cp`, and `sed` for paths in the working directory. Other Bash commands and out-of-scope paths still prompt ### User responsibility You're responsib… Catch security issues as Claude writes code Claude Code CLI · in the page security-guidance …er-security-tools). ## Prerequisites * Python 3.7 or later on your `PATH`. The agentic commit review needs Python 3.10 or later, as do all model-backed reviews when Claude Code uses a third-party pr… Self-hosted environments Claude Code CLI · in the page self-hosted-environments …ty and limitations](#availability-and-limitations) for the enablement path and what's excluded. A self-hosted environment executes Claude Code cloud sessions on infrastructure your organization opera… Customize sessions in self-hosted environments Claude Code CLI · in the page self-hosted-environments-configuration …binary, so signals and exit codes propagate correctly. Point `--exec-path`, or `SELF_HOSTED_RUNNER_EXEC_PATH`, at the wrapper when you start the runner: ```bash theme={null} claude self-hosted-runne… Deploy self-hosted environments to production Claude Code CLI · in the page self-hosted-environments-deploy …sted-environments#availability-and-limitations) covers the enablement path. This page covers running the fleet in production; see the [quickstart](/docs/en/self-hosted-environments-quickstart.md) for… Verify session identity in self-hosted environments Claude Code CLI · in the page self-hosted-environments-identity …| jq -re '.act.email // .act.sub' ``` Wrappers receive the absolute path to the runner's own binary in `CLAUDE_RUNNER_CLAUDE_BIN`; use that path rather than a PATH-resolved `claude` so the decode ru… Self-hosted environments quickstart Claude Code CLI · in the page self-hosted-environments-quickstart …sted-environments#availability-and-limitations) covers the enablement path. This page gets your first session running; see [Self-hosted environments](/docs/en/self-hosted-environments) for what they a… Self-hosted environments reference Claude Code CLI · in the page self-hosted-environments-reference …opic.com` | API base URL. Override only for testing. | | `--base-dir <path>` | `SELF_HOSTED_RUNNER_BASE_DIR` | `/workspace`; none on Windows | Directory for repository checkouts and per-session workin… Test self-hosted environments end to end Claude Code CLI · in the page self-hosted-environments-testing …sted-environments#availability-and-limitations) covers the enablement path. This page is the CI test recipe; see the [quickstart](/docs/en/self-hosted-environments-quickstart.md) for setup and [Deploy… Configure server-managed settings Claude Code CLI · in the page server-managed-settings …es. Claude Code reads a `managed-mcp.json` deployed at its [system path](/docs/en/managed-mcp.md#exclusive-control-with-managed-mcp-json) separately from the managed settings tier, so the file stil… Manage sessions Claude Code CLI · in the page sessions …| Resumes the named session directly | | `claude --resume <transcript-path>` | Resumes the session stored in the `.jsonl` [transcript file](#where-transcripts-are-stored) at that absolute path | | `cl… Claude Code settings Claude Code CLI · in the page settings …l.md` | On Windows, paths shown as `~/.claude` resolve to `%USERPROFILE%\.claude`. *** ## Settings files The `settings.json` file is the official m… Example settings files Claude Code CLI · in the page settings-example …k-resolves) walks through writing it. * **Rules match the command and path as written.** `Bash(git push *)` doesn't match [`git -C . push`](/docs/en/permissions#bash-rule-limits). `Read(./.env)` on it…
Feedback