Anthropic - Claude Code Docs Changes

agent-teams.md +403 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Orchestrate teams of Claude Code sessions

7> Coordinate multiple Claude Code instances working together as a team, with shared tasks, inter-agent messaging, and centralized management.

9<Warning>

10 Agent teams are experimental and disabled by default. Enable them by adding `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS` to your [settings.json](/en/settings) or environment. Agent teams have [known limitations](#limitations) around session resumption, task coordination, and shutdown behavior.

11</Warning>

13Agent teams let you coordinate multiple Claude Code instances working together. One session acts as the team lead, coordinating work, assigning tasks, and synthesizing results. Teammates work independently, each in its own context window, and communicate directly with each other.

15Unlike [subagents](/en/sub-agents), which run within a single session and can only report back to the main agent, you can also interact with individual teammates directly without going through the lead.

17<Note>

18 Agent teams require Claude Code v2.1.32 or later. Check your version with `claude --version`.

19</Note>

21This page covers:

23* [When to use agent teams](#when-to-use-agent-teams), including best use cases and how they compare with subagents

24* [Starting a team](#start-your-first-agent-team)

25* [Controlling teammates](#control-your-agent-team), including display modes, task assignment, and delegation

26* [Best practices for parallel work](#best-practices)

28## When to use agent teams

30Agent teams are most effective for tasks where parallel exploration adds real value. See [use case examples](#use-case-examples) for full scenarios. The strongest use cases are:

32* **Research and review**: multiple teammates can investigate different aspects of a problem simultaneously, then share and challenge each other's findings

33* **New modules or features**: teammates can each own a separate piece without stepping on each other

34* **Debugging with competing hypotheses**: teammates test different theories in parallel and converge on the answer faster

35* **Cross-layer coordination**: changes that span frontend, backend, and tests, each owned by a different teammate

37Agent teams add coordination overhead and use significantly more tokens than a single session. They work best when teammates can operate independently. For sequential tasks, same-file edits, or work with many dependencies, a single session or [subagents](/en/sub-agents) are more effective.

39### Compare with subagents

41Both agent teams and [subagents](/en/sub-agents) let you parallelize work, but they operate differently. Choose based on whether your workers need to communicate with each other:

43<Frame caption="Subagents only report results back to the main agent and never talk to each other. In agent teams, teammates share a task list, claim work, and communicate directly with each other.">

44 <img src="https://mintcdn.com/claude-code/nsvRFSDNfpSU5nT7/images/subagents-vs-agent-teams-light.png?fit=max&auto=format&n=nsvRFSDNfpSU5nT7&q=85&s=2f8db9b4f3705dd3ab931fbe2d96e42a" className="dark:hidden" alt="Diagram comparing subagent and agent team architectures. Subagents are spawned by the main agent, do work, and report results back. Agent teams coordinate through a shared task list, with teammates communicating directly with each other." width="4245" height="1615" data-path="images/subagents-vs-agent-teams-light.png" />

46 <img src="https://mintcdn.com/claude-code/nsvRFSDNfpSU5nT7/images/subagents-vs-agent-teams-dark.png?fit=max&auto=format&n=nsvRFSDNfpSU5nT7&q=85&s=d573a037540f2ada6a9ae7d8285b46fd" className="hidden dark:block" alt="Diagram comparing subagent and agent team architectures. Subagents are spawned by the main agent, do work, and report results back. Agent teams coordinate through a shared task list, with teammates communicating directly with each other." width="4245" height="1615" data-path="images/subagents-vs-agent-teams-dark.png" />

47</Frame>

49| | Subagents | Agent teams |

50| :---------------- | :----------------------------------------------- | :-------------------------------------------------- |

51| **Context** | Own context window; results return to the caller | Own context window; fully independent |

52| **Communication** | Report results back to the main agent only | Teammates message each other directly |

53| **Coordination** | Main agent manages all work | Shared task list with self-coordination |

54| **Best for** | Focused tasks where only the result matters | Complex work requiring discussion and collaboration |

55| **Token cost** | Lower: results summarized back to main context | Higher: each teammate is a separate Claude instance |

57Use subagents when you need quick, focused workers that report back. Use agent teams when teammates need to share findings, challenge each other, and coordinate on their own.

59## Enable agent teams

61Agent teams are disabled by default. Enable them by setting the `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS` environment variable to `1`, either in your shell environment or through [settings.json](/en/settings):

63```json settings.json theme={null}

64{

65 "env": {

66 "CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS": "1"

67 }

68}

69```

71## Start your first agent team

73After enabling agent teams, tell Claude to create an agent team and describe the task and the team structure you want in natural language. Claude creates the team, spawns teammates, and coordinates work based on your prompt.

75This example works well because the three roles are independent and can explore the problem without waiting on each other:

77```text theme={null}

78I'm designing a CLI tool that helps developers track TODO comments across

79their codebase. Create an agent team to explore this from different angles: one

80teammate on UX, one on technical architecture, one playing devil's advocate.

81```

83From there, Claude creates a team with a [shared task list](/en/interactive-mode#task-list), spawns teammates for each perspective, has them explore the problem, synthesizes findings, and attempts to [clean up the team](#clean-up-the-team) when finished.

85The lead's terminal lists all teammates and what they're working on. Use Shift+Down to cycle through teammates and message them directly. After the last teammate, Shift+Down wraps back to the lead.

87If you want each teammate in its own split pane, see [Choose a display mode](#choose-a-display-mode).

89## Control your agent team

91Tell the lead what you want in natural language. It handles team coordination, task assignment, and delegation based on your instructions.

93### Choose a display mode

95Agent teams support two display modes:

97* **In-process**: all teammates run inside your main terminal. Use Shift+Down to cycle through teammates and type to message them directly. Works in any terminal, no extra setup required.

98* **Split panes**: each teammate gets its own pane. You can see everyone's output at once and click into a pane to interact directly. Requires tmux, or iTerm2.

100<Note>

101 `tmux` has known limitations on certain operating systems and traditionally works best on macOS. Using `tmux -CC` in iTerm2 is the suggested entrypoint into `tmux`.

102</Note>

103

104The default is `"auto"`, which uses split panes if you're already running inside a tmux session, and in-process otherwise. The `"tmux"` setting enables split-pane mode and auto-detects whether to use tmux or iTerm2 based on your terminal. To override, set `teammateMode` in your [settings.json](/en/settings):

105

106```json theme={null}

107{

108 "teammateMode": "in-process"

109}

110```

111

112To force in-process mode for a single session, pass it as a flag:

113

114```bash theme={null}

115claude --teammate-mode in-process

116```

117

118Split-pane mode requires either [tmux](https://github.com/tmux/tmux/wiki) or iTerm2 with the [`it2` CLI](https://github.com/mkusaka/it2). To install manually:

119

120* **tmux**: install through your system's package manager. See the [tmux wiki](https://github.com/tmux/tmux/wiki/Installing) for platform-specific instructions.

121* **iTerm2**: install the [`it2` CLI](https://github.com/mkusaka/it2), then enable the Python API in **iTerm2 → Settings → General → Magic → Enable Python API**.

122

123### Specify teammates and models

124

125Claude decides the number of teammates to spawn based on your task, or you can specify exactly what you want:

126

127```text theme={null}

128Create a team with 4 teammates to refactor these modules in parallel.

129Use Sonnet for each teammate.

130```

131

132### Require plan approval for teammates

133

134For complex or risky tasks, you can require teammates to plan before implementing. The teammate works in read-only plan mode until the lead approves their approach:

135

136```text theme={null}

137Spawn an architect teammate to refactor the authentication module.

138Require plan approval before they make any changes.

139```

140

141When a teammate finishes planning, it sends a plan approval request to the lead. The lead reviews the plan and either approves it or rejects it with feedback. If rejected, the teammate stays in plan mode, revises based on the feedback, and resubmits. Once approved, the teammate exits plan mode and begins implementation.

142

143The lead makes approval decisions autonomously. To influence the lead's judgment, give it criteria in your prompt, such as "only approve plans that include test coverage" or "reject plans that modify the database schema."

144

145### Talk to teammates directly

146

147Each teammate is a full, independent Claude Code session. You can message any teammate directly to give additional instructions, ask follow-up questions, or redirect their approach.

148

149* **In-process mode**: use Shift+Down to cycle through teammates, then type to send them a message. Press Enter to view a teammate's session, then Escape to interrupt their current turn. Press Ctrl+T to toggle the task list.

150* **Split-pane mode**: click into a teammate's pane to interact with their session directly. Each teammate has a full view of their own terminal.

151

152### Assign and claim tasks

153

154The shared task list coordinates work across the team. The lead creates tasks and teammates work through them. Tasks have three states: pending, in progress, and completed. Tasks can also depend on other tasks: a pending task with unresolved dependencies cannot be claimed until those dependencies are completed.

155

156The lead can assign tasks explicitly, or teammates can self-claim:

157

158* **Lead assigns**: tell the lead which task to give to which teammate

159* **Self-claim**: after finishing a task, a teammate picks up the next unassigned, unblocked task on its own

160

161Task claiming uses file locking to prevent race conditions when multiple teammates try to claim the same task simultaneously.

162

163### Shut down teammates

164

165To gracefully end a teammate's session:

166

167```text theme={null}

168Ask the researcher teammate to shut down

169```

170

171The lead sends a shutdown request. The teammate can approve, exiting gracefully, or reject with an explanation.

172

173### Clean up the team

174

175When you're done, ask the lead to clean up:

176

177```text theme={null}

178Clean up the team

179```

180

181This removes the shared team resources. When the lead runs cleanup, it checks for active teammates and fails if any are still running, so shut them down first.

182

183<Warning>

184 Always use the lead to clean up. Teammates should not run cleanup because their team context may not resolve correctly, potentially leaving resources in an inconsistent state.

185</Warning>

186

187### Enforce quality gates with hooks

188

189Use [hooks](/en/hooks) to enforce rules when teammates finish work or tasks complete:

190

191* [`TeammateIdle`](/en/hooks#teammateidle): runs when a teammate is about to go idle. Exit with code 2 to send feedback and keep the teammate working.

192* [`TaskCompleted`](/en/hooks#taskcompleted): runs when a task is being marked complete. Exit with code 2 to prevent completion and send feedback.

193

194## How agent teams work

195

196This section covers the architecture and mechanics behind agent teams. If you want to start using them, see [Control your agent team](#control-your-agent-team) above.

197

198### How Claude starts agent teams

199

200There are two ways agent teams get started:

201

202* **You request a team**: give Claude a task that benefits from parallel work and explicitly ask for an agent team. Claude creates one based on your instructions.

203* **Claude proposes a team**: if Claude determines your task would benefit from parallel work, it may suggest creating a team. You confirm before it proceeds.

204

205In both cases, you stay in control. Claude won't create a team without your approval.

206

207### Architecture

208

209An agent team consists of:

210

211| Component | Role |

212| :------------ | :----------------------------------------------------------------------------------------- |

213| **Team lead** | The main Claude Code session that creates the team, spawns teammates, and coordinates work |

214| **Teammates** | Separate Claude Code instances that each work on assigned tasks |

215| **Task list** | Shared list of work items that teammates claim and complete |

216| **Mailbox** | Messaging system for communication between agents |

217

218See [Choose a display mode](#choose-a-display-mode) for display configuration options. Teammate messages arrive at the lead automatically.

219

220The system manages task dependencies automatically. When a teammate completes a task that other tasks depend on, blocked tasks unblock without manual intervention.

221

222Teams and tasks are stored locally:

223

224* **Team config**: `~/.claude/teams/{team-name}/config.json`

225* **Task list**: `~/.claude/tasks/{team-name}/`

226

227The team config contains a `members` array with each teammate's name, agent ID, and agent type. Teammates can read this file to discover other team members.

228

229### Permissions

230

231Teammates start with the lead's permission settings. If the lead runs with `--dangerously-skip-permissions`, all teammates do too. After spawning, you can change individual teammate modes, but you can't set per-teammate modes at spawn time.

232

233### Context and communication

234

235Each teammate has its own context window. When spawned, a teammate loads the same project context as a regular session: CLAUDE.md, MCP servers, and skills. It also receives the spawn prompt from the lead. The lead's conversation history does not carry over.

236

237**How teammates share information:**

238

239* **Automatic message delivery**: when teammates send messages, they're delivered automatically to recipients. The lead doesn't need to poll for updates.

240* **Idle notifications**: when a teammate finishes and stops, they automatically notify the lead.

241* **Shared task list**: all agents can see task status and claim available work.

242

243**Teammate messaging:**

244

245* **message**: send a message to one specific teammate

246* **broadcast**: send to all teammates simultaneously. Use sparingly, as costs scale with team size.

247

248### Token usage

249

250Agent teams use significantly more tokens than a single session. Each teammate has its own context window, and token usage scales with the number of active teammates. For research, review, and new feature work, the extra tokens are usually worthwhile. For routine tasks, a single session is more cost-effective. See [agent team token costs](/en/costs#agent-team-token-costs) for usage guidance.

251

252## Use case examples

253

254These examples show how agent teams handle tasks where parallel exploration adds value.

255

256### Run a parallel code review

257

258A single reviewer tends to gravitate toward one type of issue at a time. Splitting review criteria into independent domains means security, performance, and test coverage all get thorough attention simultaneously. The prompt assigns each teammate a distinct lens so they don't overlap:

259

260```text theme={null}

261Create an agent team to review PR #142. Spawn three reviewers:

262- One focused on security implications

263- One checking performance impact

264- One validating test coverage

265Have them each review and report findings.

266```

267

268Each reviewer works from the same PR but applies a different filter. The lead synthesizes findings across all three after they finish.

269

270### Investigate with competing hypotheses

271

272When the root cause is unclear, a single agent tends to find one plausible explanation and stop looking. The prompt fights this by making teammates explicitly adversarial: each one's job is not only to investigate its own theory but to challenge the others'.

273

274```text theme={null}

275Users report the app exits after one message instead of staying connected.

276Spawn 5 agent teammates to investigate different hypotheses. Have them talk to

277each other to try to disprove each other's theories, like a scientific

278debate. Update the findings doc with whatever consensus emerges.

279```

280

281The debate structure is the key mechanism here. Sequential investigation suffers from anchoring: once one theory is explored, subsequent investigation is biased toward it.

282

283With multiple independent investigators actively trying to disprove each other, the theory that survives is much more likely to be the actual root cause.

284

285## Best practices

286

287### Give teammates enough context

288

289Teammates load project context automatically, including CLAUDE.md, MCP servers, and skills, but they don't inherit the lead's conversation history. See [Context and communication](#context-and-communication) for details. Include task-specific details in the spawn prompt:

290

291```text theme={null}

292Spawn a security reviewer teammate with the prompt: "Review the authentication module

293at src/auth/ for security vulnerabilities. Focus on token handling, session

294management, and input validation. The app uses JWT tokens stored in

295httpOnly cookies. Report any issues with severity ratings."

296```

297

298### Choose an appropriate team size

299

300There's no hard limit on the number of teammates, but practical constraints apply:

301

302* **Token costs scale linearly**: each teammate has its own context window and consumes tokens independently. See [agent team token costs](/en/costs#agent-team-token-costs) for details.

303* **Coordination overhead increases**: more teammates means more communication, task coordination, and potential for conflicts

304* **Diminishing returns**: beyond a certain point, additional teammates don't speed up work proportionally

305

306Start with 3-5 teammates for most workflows. This balances parallel work with manageable coordination. The examples in this guide use 3-5 teammates because that range works well across different task types.

307

308Having 5-6 [tasks](/en/agent-teams#architecture) per teammate keeps everyone productive without excessive context switching. If you have 15 independent tasks, 3 teammates is a good starting point.

309

310Scale up only when the work genuinely benefits from having teammates work simultaneously. Three focused teammates often outperform five scattered ones.

311

312### Size tasks appropriately

313

314* **Too small**: coordination overhead exceeds the benefit

315* **Too large**: teammates work too long without check-ins, increasing risk of wasted effort

316* **Just right**: self-contained units that produce a clear deliverable, such as a function, a test file, or a review

317

318<Tip>

319 The lead breaks work into tasks and assigns them to teammates automatically. If it isn't creating enough tasks, ask it to split the work into smaller pieces. Having 5-6 tasks per teammate keeps everyone productive and lets the lead reassign work if someone gets stuck.

320</Tip>

321

322### Wait for teammates to finish

323

324Sometimes the lead starts implementing tasks itself instead of waiting for teammates. If you notice this:

325

326```text theme={null}

327Wait for your teammates to complete their tasks before proceeding

328```

329

330### Start with research and review

331

332If you're new to agent teams, start with tasks that have clear boundaries and don't require writing code: reviewing a PR, researching a library, or investigating a bug. These tasks show the value of parallel exploration without the coordination challenges that come with parallel implementation.

333

334### Avoid file conflicts

335

336Two teammates editing the same file leads to overwrites. Break the work so each teammate owns a different set of files.

337

338### Monitor and steer

339

340Check in on teammates' progress, redirect approaches that aren't working, and synthesize findings as they come in. Letting a team run unattended for too long increases the risk of wasted effort.

341

342## Troubleshooting

343

344### Teammates not appearing

345

346If teammates aren't appearing after you ask Claude to create a team:

347

348* In in-process mode, teammates may already be running but not visible. Press Shift+Down to cycle through active teammates.

349* Check that the task you gave Claude was complex enough to warrant a team. Claude decides whether to spawn teammates based on the task.

350* If you explicitly requested split panes, ensure tmux is installed and available in your PATH:

351 ```bash theme={null}

352 which tmux

353 ```

354* For iTerm2, verify the `it2` CLI is installed and the Python API is enabled in iTerm2 preferences.

355

356### Too many permission prompts

357

358Teammate permission requests bubble up to the lead, which can create friction. Pre-approve common operations in your [permission settings](/en/permissions) before spawning teammates to reduce interruptions.

359

360### Teammates stopping on errors

361

362Teammates may stop after encountering errors instead of recovering. Check their output using Shift+Down in in-process mode or by clicking the pane in split mode, then either:

363

364* Give them additional instructions directly

365* Spawn a replacement teammate to continue the work

366

367### Lead shuts down before work is done

368

369The lead may decide the team is finished before all tasks are actually complete. If this happens, tell it to keep going. You can also tell the lead to wait for teammates to finish before proceeding if it starts doing work instead of delegating.

370

371### Orphaned tmux sessions

372

373If a tmux session persists after the team ends, it may not have been fully cleaned up. List sessions and kill the one created by the team:

374

375```bash theme={null}

376tmux ls

377tmux kill-session -t <session-name>

378```

379

380## Limitations

381

382Agent teams are experimental. Current limitations to be aware of:

383

384* **No session resumption with in-process teammates**: `/resume` and `/rewind` do not restore in-process teammates. After resuming a session, the lead may attempt to message teammates that no longer exist. If this happens, tell the lead to spawn new teammates.

385* **Task status can lag**: teammates sometimes fail to mark tasks as completed, which blocks dependent tasks. If a task appears stuck, check whether the work is actually done and update the task status manually or tell the lead to nudge the teammate.

386* **Shutdown can be slow**: teammates finish their current request or tool call before shutting down, which can take time.

387* **One team per session**: a lead can only manage one team at a time. Clean up the current team before starting a new one.

388* **No nested teams**: teammates cannot spawn their own teams or teammates. Only the lead can manage the team.

389* **Lead is fixed**: the session that creates the team is the lead for its lifetime. You can't promote a teammate to lead or transfer leadership.

390* **Permissions set at spawn**: all teammates start with the lead's permission mode. You can change individual teammate modes after spawning, but you can't set per-teammate modes at spawn time.

391* **Split panes require tmux or iTerm2**: the default in-process mode works in any terminal. Split-pane mode isn't supported in VS Code's integrated terminal, Windows Terminal, or Ghostty.

392

393<Tip>

394 **`CLAUDE.md` works normally**: teammates read `CLAUDE.md` files from their working directory. Use this to provide project-specific guidance to all teammates.

395</Tip>

396

397## Next steps

398

399Explore related approaches for parallel work and delegation:

400

401* **Lightweight delegation**: [subagents](/en/sub-agents) spawn helper agents for research or verification within your session, better for tasks that don't need inter-agent coordination

402* **Manual parallel sessions**: [Git worktrees](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees) let you run multiple Claude Code sessions yourself without automated team coordination

403* **Compare approaches**: see the [subagent vs agent team](/en/features-overview#compare-similar-features) comparison for a side-by-side breakdown

amazon-bedrock.md +70 −32

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Claude Code on Amazon Bedrock5# Claude Code on Amazon Bedrock

2 6

3> Learn about configuring Claude Code through Amazon Bedrock, including setup, IAM configuration, and troubleshooting.7> Learn about configuring Claude Code through Amazon Bedrock, including setup, IAM configuration, and troubleshooting.

7Before configuring Claude Code with Bedrock, ensure you have:11Before configuring Claude Code with Bedrock, ensure you have:

8 12

9* An AWS account with Bedrock access enabled13* An AWS account with Bedrock access enabled

~~10* Access to desired Claude models (e.g., Claude Sonnet 4.5) in Bedrock~~14* Access to desired Claude models (for example, Claude Sonnet 4.6) in Bedrock

11* AWS CLI installed and configured (optional - only needed if you don't have another mechanism for getting credentials)15* AWS CLI installed and configured (optional - only needed if you don't have another mechanism for getting credentials)

12* Appropriate IAM permissions16* Appropriate IAM permissions

13 17

18<Note>

19 If you are deploying Claude Code to multiple users, [pin your model versions](#4-pin-model-versions) to prevent breakage when Anthropic releases new models.

20</Note>

14## Setup22## Setup

15 23

16### 1. Submit use case details24### 1. Submit use case details

48export AWS_PROFILE=your-profile-name56export AWS_PROFILE=your-profile-name

49```57```

50 58

~~51**Option D: Bedrock API keys**~~59**Option D: AWS Management Console credentials**

61```bash theme={null}

62aws login

63```

65[Learn more](https://docs.aws.amazon.com/signin/latest/userguide/command-line-sign-in.html) about `aws login`.

67**Option E: Bedrock API keys**

52 68

53```bash theme={null}69```bash theme={null}

54export AWS_BEARER_TOKEN_BEDROCK=your-bedrock-api-key70export AWS_BEARER_TOKEN_BEDROCK=your-bedrock-api-key

75 91

76##### Configuration settings explained92##### Configuration settings explained

77 93

78**`awsAuthRefresh`**: Use this for commands that modify the `.aws` directory (e.g., updating credentials, SSO cache, or config files). Output is shown to the user (but user input is not supported), making it suitable for browser-based authentication flows where the CLI displays a code to enter in the browser.94**`awsAuthRefresh`**: Use this for commands that modify the `.aws` directory, such as updating credentials, SSO cache, or config files. The command's output is displayed to the user, but interactive input isn't supported. This works well for browser-based SSO flows where the CLI displays a URL or code and you complete authentication in the browser.

79 95

80**`awsCredentialExport`**: Only use this if you cannot modify `.aws` and must directly return credentials. Output is captured silently (not shown to the user). The command must output JSON in this format:96**`awsCredentialExport`**: Only use this if you can't modify `.aws` and must directly return credentials. Output is captured silently and not shown to the user. The command must output JSON in this format:

81 97

82```json theme={null}98```json theme={null}

83{99{

102export ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION=us-west-2118export ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION=us-west-2

103```119```

104 120

105**For VS Code Extension users**: Configure environment variables in the VS Code extension settings instead of exporting them in your shell. See [Using Third-Party Providers in VS Code](/en/vs-code#using-third-party-providers-vertex-and-bedrock) for detailed instructions. All environment variables shown in this guide should work when configured through the VS Code extension settings.

~~106~~

107When enabling Bedrock for Claude Code, keep the following in mind:121When enabling Bedrock for Claude Code, keep the following in mind:

108 122

109* `AWS_REGION` is a required environment variable. Claude Code does not read from the `.aws` config file for this setting.123* `AWS_REGION` is a required environment variable. Claude Code does not read from the `.aws` config file for this setting.

110* When using Bedrock, the `/login` and `/logout` commands are disabled since authentication is handled through AWS credentials.124* When using Bedrock, the `/login` and `/logout` commands are disabled since authentication is handled through AWS credentials.

111* You can use settings files for environment variables like `AWS_PROFILE` that you don't want to leak to other processes. See [Settings](/en/settings) for more information.125* You can use settings files for environment variables like `AWS_PROFILE` that you don't want to leak to other processes. See [Settings](/en/settings) for more information.

112 126

113### 4. Model configuration127### 4. Pin model versions

114 128

115Claude Code uses these default models for Bedrock:129<Warning>

130 Pin specific model versions for every deployment. If you use model aliases (`sonnet`, `opus`, `haiku`) without pinning, Claude Code may attempt to use a newer model version that isn't available in your Bedrock account, breaking existing users when Anthropic releases updates.

131</Warning>

132

133Set these environment variables to specific Bedrock model IDs:

134

135```bash theme={null}

136export ANTHROPIC_DEFAULT_OPUS_MODEL='us.anthropic.claude-opus-4-6-v1'

137export ANTHROPIC_DEFAULT_SONNET_MODEL='us.anthropic.claude-sonnet-4-6'

138export ANTHROPIC_DEFAULT_HAIKU_MODEL='us.anthropic.claude-haiku-4-5-20251001-v1:0'

139```

140

141These variables use cross-region inference profile IDs (with the `us.` prefix). If you use a different region prefix or application inference profiles, adjust accordingly. For current and legacy model IDs, see [Models overview](https://platform.claude.com/docs/en/about-claude/models/overview). See [Model configuration](/en/model-config#pin-models-for-third-party-deployments) for the full list of environment variables.

142

143Claude Code uses these default models when no pinning variables are set:

116 144

117| Model type | Default value |145| Model type | Default value |

118| :--------------- | :------------------------------------------------- |146| :--------------- | :-------------------------------------------- |

121 149

122<Note>150To customize models further, use one of these methods:

123 For Bedrock users, Claude Code will not automatically upgrade from Haiku 3.5 to Haiku 4.5. To manually switch to a newer Haiku model, set the `ANTHROPIC_DEFAULT_HAIKU_MODEL` environment variable to the full model name (e.g., `us.anthropic.claude-haiku-4-5-20251001-v1:0`).

124</Note>

~~125~~

126To customize models, use one of these methods:

127 151

128```bash theme={null}152```bash theme={null}

129# Using inference profile ID153# Using inference profile ID

130export ANTHROPIC_MODEL='global.anthropic.claude-sonnet-4-5-20250929-v1:0'154export ANTHROPIC_MODEL='global.anthropic.claude-sonnet-4-6'

131export ANTHROPIC_SMALL_FAST_MODEL='us.anthropic.claude-haiku-4-5-20251001-v1:0'155export ANTHROPIC_DEFAULT_HAIKU_MODEL='us.anthropic.claude-haiku-4-5-20251001-v1:0'

132 156

133# Using application inference profile ARN157# Using application inference profile ARN

134export ANTHROPIC_MODEL='arn:aws:bedrock:us-east-2:your-account-id:application-inference-profile/your-model-id'158export ANTHROPIC_MODEL='arn:aws:bedrock:us-east-2:your-account-id:application-inference-profile/your-model-id'

137export DISABLE_PROMPT_CACHING=1161export DISABLE_PROMPT_CACHING=1

138```162```

139 163

140<Note>164<Note>[Prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) may not be available in all regions.</Note>

141 [Prompt caching](https://docs.claude.com/en/docs/build-with-claude/prompt-caching) may not be available in all regions

142</Note>

143 165

144### 5. Output token configuration166#### Map each model version to an inference profile

145 167

146When using Claude Code with Amazon Bedrock, we recommend the following token settings:168The `ANTHROPIC_DEFAULT_*_MODEL` environment variables configure one inference profile per model family. If your organization needs to expose several versions of the same family in the `/model` picker, each routed to its own application inference profile ARN, use the `modelOverrides` setting in your [settings file](/en/settings#settings-files) instead.

147 169

148```bash theme={null}170This example maps three Opus versions to distinct ARNs so users can switch between them without bypassing your organization's inference profiles:

149# Recommended output token settings for Bedrock

150export CLAUDE_CODE_MAX_OUTPUT_TOKENS=4096

151export MAX_THINKING_TOKENS=1024

152```

153 171

154**Why these values:**172```json theme={null}

~~155~~ 173{

156* **`CLAUDE_CODE_MAX_OUTPUT_TOKENS=4096`**: Bedrock's burndown throttling logic sets a minimum of 4096 tokens as the max\_token penalty. Setting this lower won't reduce costs but may cut off long tool uses, causing the Claude Code agent loop to fail persistently. Claude Code typically uses less than 4096 output tokens without extended thinking, but may need this headroom for tasks involving significant file creation or Write tool usage.174 "modelOverrides": {

175 "claude-opus-4-6": "arn:aws:bedrock:us-east-2:123456789012:application-inference-profile/opus-46-prod",

176 "claude-opus-4-5-20251101": "arn:aws:bedrock:us-east-2:123456789012:application-inference-profile/opus-45-prod",

177 "claude-opus-4-1-20250805": "arn:aws:bedrock:us-east-2:123456789012:application-inference-profile/opus-41-prod"

178 }

179}

180```

157 181

158* **`MAX_THINKING_TOKENS=1024`**: This provides space for extended thinking without cutting off tool use responses, while still maintaining focused reasoning chains. This balance helps prevent trajectory changes that aren't always helpful for coding tasks specifically.182When a user selects one of these versions in `/model`, Claude Code calls Bedrock with the mapped ARN. Versions without an override fall back to the built-in Bedrock model ID or any matching inference profile discovered at startup. See [Override model IDs per version](/en/model-config#override-model-ids-per-version) for details on how overrides interact with `availableModels` and other model settings.

159 183

160## IAM configuration184## IAM configuration

161 185

202For details, see [Bedrock IAM documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/security-iam.html).226For details, see [Bedrock IAM documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/security-iam.html).

203 227

204<Note>228<Note>

205 We recommend creating a dedicated AWS account for Claude Code to simplify cost tracking and access control.229 Create a dedicated AWS account for Claude Code to simplify cost tracking and access control.

206</Note>230</Note>

207 231

232## AWS Guardrails

233

234[Amazon Bedrock Guardrails](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) let you implement content filtering for Claude Code. Create a Guardrail in the [Amazon Bedrock console](https://console.aws.amazon.com/bedrock/), publish a version, then add the Guardrail headers to your [settings file](/en/settings). Enable Cross-Region inference on your Guardrail if you're using cross-region inference profiles.

235

236Example configuration:

237

238```json theme={null}

239{

240 "env": {

241 "ANTHROPIC_CUSTOM_HEADERS": "X-Amzn-Bedrock-GuardrailIdentifier: your-guardrail-id\nX-Amzn-Bedrock-GuardrailVersion: 1"

242 }

243}

244```

245

208## Troubleshooting246## Troubleshooting

209 247

210If you encounter region issues:248If you encounter region issues:

analytics.md +182 −45

Details

~~1# Analytics~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> View detailed usage insights and productivity metrics for your organization's Claude Code deployment.~~5# Track team usage with analytics

4 6

~~5Claude Code provides an analytics dashboard that helps organizations understand developer usage patterns, track productivity metrics, and optimize their Claude Code adoption.~~7> View Claude Code usage metrics, track adoption, and measure engineering velocity in the analytics dashboard.

9Claude Code provides analytics dashboards to help organizations understand developer usage patterns, track contribution metrics, and measure how Claude Code impacts engineering velocity. Access the dashboard for your plan:

12| ----------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------- |

16## Access analytics for Teams and Enterprise

18Navigate to [claude.ai/analytics/claude-code](https://claude.ai/analytics/claude-code). Admins and Owners can view the dashboard.

20The Teams and Enterprise dashboard includes:

22* **Usage metrics**: lines of code accepted, suggestion accept rate, daily active users and sessions

23* **Contribution metrics**: PRs and lines of code shipped with Claude Code assistance, with [GitHub integration](#enable-contribution-metrics)

24* **Leaderboard**: top contributors ranked by Claude Code usage

25* **Data export**: download contribution data as CSV for custom reporting

27### Enable contribution metrics

6 28

7<Note>29<Note>

~~8 Analytics are currently available only for organizations using Claude Code with the Claude API through the Claude Console.~~30 Contribution metrics are in public beta and available on Claude for Teams and Claude for Enterprise plans. These metrics only cover users within your claude.ai organization. Usage through the Claude Console API or third-party integrations is not included.

9</Note>31</Note>

10 32

~~11## Access analytics~~33Usage and adoption data is available for all Claude for Teams and Claude for Enterprise accounts. Contribution metrics require additional setup to connect your GitHub organization.

35You need the Owner role to configure analytics settings. A GitHub admin must install the GitHub app.

37<Warning>

38 Contribution metrics are not available for organizations with [Zero Data Retention](/en/zero-data-retention) enabled. The analytics dashboard will show usage metrics only.

39</Warning>

41<Steps>

42 <Step title="Install the GitHub app">

43 A GitHub admin installs the Claude GitHub app on your organization's GitHub account at [github.com/apps/claude](https://github.com/apps/claude).

44 </Step>

46 <Step title="Enable Claude Code analytics">

47 A Claude Owner navigates to [claude.ai/admin-settings/claude-code](https://claude.ai/admin-settings/claude-code) and enables the Claude Code analytics feature.

48 </Step>

50 <Step title="Enable GitHub analytics">

51 On the same page, enable the "GitHub analytics" toggle.

52 </Step>

54 <Step title="Authenticate with GitHub">

55 Complete the GitHub authentication flow and select which GitHub organizations to include in the analysis.

56 </Step>

57</Steps>

12 58

~~13Navigate to the analytics dashboard at [console.anthropic.com/claude-code](https://console.anthropic.com/claude-code).~~59Data typically appears within 24 hours after enabling, with daily updates. If no data appears, you may see one of these messages:

14 60

~~15### Required roles~~61* **"GitHub app required"**: install the GitHub app to view contribution metrics

62* **"Data processing in progress"**: check back in a few days and confirm the GitHub app is installed if data doesn't appear

16 63

~~17* **Primary Owner**~~64Contribution metrics support GitHub Cloud and GitHub Enterprise Server.

~~18* **Owner**~~65

~~19* **Billing**~~66### Review summary metrics

~~20* **Admin**~~

~~21* **Developer**~~

22 67

23<Note>68<Note>

~~24 Users with **User**, **Claude Code User** or **Membership Admin** roles cannot access analytics.~~69 These metrics are deliberately conservative and represent an underestimate of Claude Code's actual impact. Only lines and PRs where there is high confidence in Claude Code's involvement are counted.

25</Note>70</Note>

26 71

~~27## Available metrics~~72The dashboard displays these summary metrics at the top:

74* **PRs with CC**: total count of merged pull requests that contain at least one line of code written with Claude Code

75* **Lines of code with CC**: total lines of code across all merged PRs that were written with Claude Code assistance. Only "effective lines" are counted: lines with more than 3 characters after normalization, excluding empty lines and lines with only brackets or trivial punctuation.

76* **PRs with Claude Code (%)**: percentage of all merged PRs that contain Claude Code-assisted code

77* **Suggestion accept rate**: percentage of times users accept Claude Code's code editing suggestions, including Edit, Write, and NotebookEdit tool usage

78* **Lines of code accepted**: total lines of code written by Claude Code that users have accepted in their sessions. This excludes rejected suggestions and does not track subsequent deletions.

80### Explore the charts

82The dashboard includes several charts to visualize trends over time.

84#### Track adoption

86The Adoption chart shows daily usage trends:

88* **users**: daily active users

89* **sessions**: number of active Claude Code sessions per day

91#### Measure PRs per user

93This chart displays individual developer activity over time:

95* **PRs per user**: total number of PRs merged per day divided by daily active users

96* **users**: daily active users

98Use this to understand how individual productivity changes as Claude Code adoption increases.

100#### View pull requests breakdown

101

102The Pull requests chart shows a daily breakdown of merged PRs:

28 103

~~29### Lines of code accepted~~104* **PRs with CC**: pull requests containing Claude Code-assisted code

105* **PRs without CC**: pull requests without Claude Code-assisted code

30 106

~~31Total lines of code written by Claude Code that users have accepted in their sessions.~~107Toggle to **Lines of code** view to see the same breakdown by lines of code rather than PR count.

32 108

~~33* Excludes rejected code suggestions~~109#### Find top contributors

~~34* Doesn't track subsequent deletions~~

35 110

~~36### Suggestion accept rate~~111The Leaderboard shows the top 10 users ranked by contribution volume. Toggle between:

37 112

~~38Percentage of times users accept code editing tool usage, including:~~113* **Pull requests**: shows PRs with Claude Code vs All PRs for each user

114* **Lines of code**: shows lines with Claude Code vs All lines for each user

39 115

~~40* Edit~~116Click **Export all users** to download complete contribution data for all users as a CSV file. The export includes all users, not just the top 10 displayed.

~~41* Write~~

~~42* NotebookEdit~~

43 117

~~44### Activity~~118### PR attribution

45 119

~~46**users**: Number of active users in a given day (number on left Y-axis)~~120When contribution metrics are enabled, Claude Code analyzes merged pull requests to determine which code was written with Claude Code assistance. This is done by matching Claude Code session activity against the code in each PR.

47 121

~~48**sessions**: Number of active sessions in a given day (number on right Y-axis)~~122#### Tagging criteria

49 123

~~50### Spend~~124PRs are tagged as "with Claude Code" if they contain at least one line of code written during a Claude Code session. The system uses conservative matching: only code where there is high confidence in Claude Code's involvement is counted as assisted.

51 125

~~52**users**: Number of active users in a given day (number on left Y-axis)~~126#### Attribution process

53 127

~~54**spend**: Total dollars spent in a given day (number on right Y-axis)~~128When a pull request is merged:

55 129

~~56### Team insights~~1301. Added lines are extracted from the PR diff

1312. Claude Code sessions that edited matching files within a time window are identified

1323. PR lines are matched against Claude Code output using multiple strategies

1334. Metrics are calculated for AI-assisted lines and total lines

57 134

~~58**Members**: All users who have authenticated to Claude Code~~135Before comparison, lines are normalized: whitespace is trimmed, multiple spaces are collapsed, quotes are standardized, and text is converted to lowercase.

59 136

~~60* API key users are displayed by **API key identifier**~~137Merged pull requests containing Claude Code-assisted lines are labeled as `claude-code-assisted` in GitHub.

~~61* OAuth users are displayed by **email address**~~

62 138

~~63**Spend this month:** Per-user total spend for the current month.~~139#### Time window

64 140

~~65**Lines this month:** Per-user total of accepted code lines for the current month.~~141Sessions from 21 days before to 2 days after the PR merge date are considered for attribution matching.

66 142

~~67## Using analytics effectively~~143#### Excluded files

68 144

~~69### Monitor adoption~~145Certain files are automatically excluded from analysis because they are auto-generated:

70 146

~~71Track team member status to identify:~~147* Lock files: package-lock.json, yarn.lock, Cargo.lock, and similar

148* Generated code: Protobuf outputs, build artifacts, minified files

149* Build directories: dist/, build/, node\_modules/, target/

150* Test fixtures: snapshots, cassettes, mock data

151* Lines over 1,000 characters, which are likely minified or generated

152

153#### Attribution notes

154

155Keep these additional details in mind when interpreting attribution data:

156

157* Code substantially rewritten by developers, with more than 20% difference, is not attributed to Claude Code

158* Sessions outside the 21-day window are not considered

159* The algorithm does not consider the PR source or destination branch when performing attribution

160

161### Get the most from analytics

162

163Use contribution metrics to demonstrate ROI, identify adoption patterns, and find team members who can help others get started.

164

165#### Monitor adoption

166

167Track the Adoption chart and user counts to identify:

72 168

73* Active users who can share best practices169* Active users who can share best practices

74* Overall adoption trends across your organization170* Overall adoption trends across your organization

171* Dips in usage that may indicate friction or issues

172

173#### Measure ROI

174

175Contribution metrics help answer "Is this tool worth the investment?" with data from your own codebase:

176

177* Track changes in PRs per user over time as adoption increases

178* Compare PRs and lines of code shipped with vs. without Claude Code

179* Use alongside [DORA metrics](https://dora.dev/), sprint velocity, or other engineering KPIs to understand changes from adopting Claude Code

180

181#### Identify power users

182

183The Leaderboard helps you find team members with high Claude Code adoption who can:

184

185* Share prompting techniques and workflows with the team

186* Provide feedback on what's working well

187* Help onboard new users

75 188

~~76### Measure productivity~~189#### Access data programmatically

77 190

~~78Tool acceptance rates and code metrics help you:~~191To query this data through GitHub, search for PRs labeled with `claude-code-assisted`.

79 192

~~80* Understand developer satisfaction with Claude Code suggestions~~193## Access analytics for API customers

~~81* Track code generation effectiveness~~194

~~82* Identify opportunities for training or process improvements~~195API customers using the Claude Console can access analytics at [platform.claude.com/claude-code](https://platform.claude.com/claude-code). You need the UsageView permission to access the dashboard, which is granted to Developer, Billing, Admin, Owner, and Primary Owner roles.

196

197<Note>

198 Contribution metrics with GitHub integration are not currently available for API customers. The Console dashboard shows usage and spend metrics only.

199</Note>

200

201The Console dashboard displays:

202

203* **Lines of code accepted**: total lines of code written by Claude Code that users have accepted in their sessions. This excludes rejected suggestions and does not track subsequent deletions.

204* **Suggestion accept rate**: percentage of times users accept code editing tool usage, including Edit, Write, and NotebookEdit tools.

205* **Activity**: daily active users and sessions shown on a chart.

206* **Spend**: daily API costs in dollars alongside user count.

207

208### View team insights

209

210The team insights table shows per-user metrics:

211

212* **Members**: all users who have authenticated to Claude Code. API key users display by key identifier, OAuth users display by email address.

213* **Spend this month**: per-user total API costs for the current month.

214* **Lines this month**: per-user total of accepted code lines for the current month.

215

216<Note>

217 Spend figures in the Console dashboard are estimates for analytics purposes. For actual costs, refer to your billing page.

218</Note>

83 219

84## Related resources220## Related resources

85 221

~~86* [Monitoring usage with OpenTelemetry](/en/monitoring-usage) for custom metrics and alerting~~222* [Monitoring with OpenTelemetry](/en/monitoring-usage): export real-time metrics and events to your observability stack

~~87* [Identity and access management](/en/iam) for role configuration~~223* [Manage costs effectively](/en/costs): set spend limits and optimize token usage

224* [Permissions](/en/permissions): configure roles and permissions

authentication.md +134 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Authentication

7> Log in to Claude Code and configure authentication for individuals, teams, and organizations.

9Claude Code supports multiple authentication methods depending on your setup. Individual users can log in with a Claude.ai account, while teams can use Claude for Teams or Enterprise, the Claude Console, or a cloud provider like Amazon Bedrock, Google Vertex AI, or Microsoft Foundry.

11## Log in to Claude Code

13After [installing Claude Code](/en/setup#install-claude-code), run `claude` in your terminal. On first launch, Claude Code opens a browser window for you to log in.

15If the browser doesn't open automatically, press `c` to copy the login URL to your clipboard, then paste it into your browser.

17You can authenticate with any of these account types:

19* **Claude Pro or Max subscription**: log in with your Claude.ai account. Subscribe at [claude.com/pricing](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=authentication_pro_max).

20* **Claude for Teams or Enterprise**: log in with the Claude.ai account your team admin invited you to.

21* **Claude Console**: log in with your Console credentials. Your admin must have [invited you](#claude-console-authentication) first.

22* **Cloud providers**: if your organization uses [Amazon Bedrock](/en/amazon-bedrock), [Google Vertex AI](/en/google-vertex-ai), or [Microsoft Foundry](/en/microsoft-foundry), set the required environment variables before running `claude`. No browser login is needed.

24To log out and re-authenticate, type `/logout` at the Claude Code prompt.

26If you're having trouble logging in, see [authentication troubleshooting](/en/troubleshooting#authentication-issues).

28## Set up team authentication

30For teams and organizations, you can configure Claude Code access in one of these ways:

32* [Claude for Teams or Enterprise](#claude-for-teams-or-enterprise), recommended for most teams

33* [Claude Console](#claude-console-authentication)

34* [Amazon Bedrock](/en/amazon-bedrock)

35* [Google Vertex AI](/en/google-vertex-ai)

36* [Microsoft Foundry](/en/microsoft-foundry)

38### Claude for Teams or Enterprise

40[Claude for Teams](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=authentication_teams#team-&-enterprise) and [Claude for Enterprise](https://anthropic.com/contact-sales?utm_source=claude_code\&utm_medium=docs\&utm_content=authentication_enterprise) provide the best experience for organizations using Claude Code. Team members get access to both Claude Code and Claude on the web with centralized billing and team management.

42* **Claude for Teams**: self-service plan with collaboration features, admin tools, and billing management. Best for smaller teams.

43* **Claude for Enterprise**: adds SSO, domain capture, role-based permissions, compliance API, and managed policy settings for organization-wide Claude Code configurations. Best for larger organizations with security and compliance requirements.

45<Steps>

46 <Step title="Subscribe">

47 Subscribe to [Claude for Teams](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=authentication_teams_step#team-&-enterprise) or contact sales for [Claude for Enterprise](https://anthropic.com/contact-sales?utm_source=claude_code\&utm_medium=docs\&utm_content=authentication_enterprise_step).

48 </Step>

50 <Step title="Invite team members">

51 Invite team members from the admin dashboard.

52 </Step>

54 <Step title="Install and log in">

55 Team members install Claude Code and log in with their Claude.ai accounts.

56 </Step>

57</Steps>

59### Claude Console authentication

61For organizations that prefer API-based billing, you can set up access through the Claude Console.

63<Steps>

64 <Step title="Create or use a Console account">

65 Use your existing Claude Console account or create a new one.

66 </Step>

68 <Step title="Add users">

69 You can add users through either method:

71 * Bulk invite users from within the Console: Settings -> Members -> Invite

72 * [Set up SSO](https://support.claude.com/en/articles/13132885-setting-up-single-sign-on-sso)

73 </Step>

75 <Step title="Assign roles">

76 When inviting users, assign one of:

78 * **Claude Code** role: users can only create Claude Code API keys

79 * **Developer** role: users can create any kind of API key

80 </Step>

82 <Step title="Users complete setup">

83 Each invited user needs to:

85 * Accept the Console invite

86 * [Check system requirements](/en/setup#system-requirements)

87 * [Install Claude Code](/en/setup#install-claude-code)

88 * Log in with Console account credentials

89 </Step>

90</Steps>

92### Cloud provider authentication

94For teams using Amazon Bedrock, Google Vertex AI, or Microsoft Foundry:

96<Steps>

97 <Step title="Follow provider setup">

98 Follow the [Bedrock docs](/en/amazon-bedrock), [Vertex docs](/en/google-vertex-ai), or [Microsoft Foundry docs](/en/microsoft-foundry).

99 </Step>

100

101 <Step title="Distribute configuration">

102 Distribute the environment variables and instructions for generating cloud credentials to your users. Read more about how to [manage configuration here](/en/settings).

103 </Step>

104

105 <Step title="Install Claude Code">

106 Users can [install Claude Code](/en/setup#install-claude-code).

107 </Step>

108</Steps>

109

110## Credential management

111

112Claude Code securely manages your authentication credentials:

113

114* **Storage location**: on macOS, credentials are stored in the encrypted macOS Keychain. On Linux and Windows, credentials are stored in `~/.claude/.credentials.json`, or under `$CLAUDE_CONFIG_DIR` if that variable is set. On Linux, the file is written with mode `0600`; on Windows, it inherits the access controls of your user profile directory.

115* **Supported authentication types**: Claude.ai credentials, Claude API credentials, Azure Auth, Bedrock Auth, and Vertex Auth.

116* **Custom credential scripts**: the [`apiKeyHelper`](/en/settings#available-settings) setting can be configured to run a shell script that returns an API key.

117* **Refresh intervals**: by default, `apiKeyHelper` is called after 5 minutes or on HTTP 401 response. Set `CLAUDE_CODE_API_KEY_HELPER_TTL_MS` environment variable for custom refresh intervals.

118* **Slow helper notice**: if `apiKeyHelper` takes longer than 10 seconds to return a key, Claude Code displays a warning notice in the prompt bar showing the elapsed time. If you see this notice regularly, check whether your credential script can be optimized.

119

120`apiKeyHelper`, `ANTHROPIC_API_KEY`, and `ANTHROPIC_AUTH_TOKEN` apply to terminal CLI sessions only. Claude Desktop and remote sessions use OAuth exclusively and do not call `apiKeyHelper` or read API key environment variables.

121

122### Authentication precedence

123

124When multiple credentials are present, Claude Code chooses one in this order:

125

1261. Cloud provider credentials, when `CLAUDE_CODE_USE_BEDROCK`, `CLAUDE_CODE_USE_VERTEX`, or `CLAUDE_CODE_USE_FOUNDRY` is set. See [third-party integrations](/en/third-party-integrations) for setup.

1272. `ANTHROPIC_AUTH_TOKEN` environment variable. Sent as the `Authorization: Bearer` header. Use this when routing through an [LLM gateway or proxy](/en/llm-gateway) that authenticates with bearer tokens rather than Anthropic API keys.

1283. `ANTHROPIC_API_KEY` environment variable. Sent as the `X-Api-Key` header. Use this for direct Anthropic API access with a key from the [Claude Console](https://platform.claude.com). In interactive mode, you are prompted once to approve or decline the key, and your choice is remembered. To change it later, use the "Use custom API key" toggle in `/config`. In non-interactive mode (`-p`), the key is always used when present.

1294. [`apiKeyHelper`](/en/settings#available-settings) script output. Use this for dynamic or rotating credentials, such as short-lived tokens fetched from a vault.

1305. Subscription OAuth credentials from `/login`. This is the default for Claude Pro, Max, Team, and Enterprise users.

131

132If you have an active Claude subscription but also have `ANTHROPIC_API_KEY` set in your environment, the API key takes precedence once approved. This can cause authentication failures if the key belongs to a disabled or expired organization. Run `unset ANTHROPIC_API_KEY` to fall back to your subscription, and check `/status` to confirm which method is active.

133

134[Claude Code on the Web](/en/claude-code-on-the-web) always uses your subscription credentials. `ANTHROPIC_API_KEY` and `ANTHROPIC_AUTH_TOKEN` in the sandbox environment do not override them.

best-practices.md +582 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Best Practices for Claude Code

7> Tips and patterns for getting the most out of Claude Code, from configuring your environment to scaling across parallel sessions.

9Claude Code is an agentic coding environment. Unlike a chatbot that answers questions and waits, Claude Code can read your files, run commands, make changes, and autonomously work through problems while you watch, redirect, or step away entirely.

11This changes how you work. Instead of writing code yourself and asking Claude to review it, you describe what you want and Claude figures out how to build it. Claude explores, plans, and implements.

13But this autonomy still comes with a learning curve. Claude works within certain constraints you need to understand.

15This guide covers patterns that have proven effective across Anthropic's internal teams and for engineers using Claude Code across various codebases, languages, and environments. For how the agentic loop works under the hood, see [How Claude Code works](/en/how-claude-code-works).

17***

19Most best practices are based on one constraint: Claude's context window fills up fast, and performance degrades as it fills.

21Claude's context window holds your entire conversation, including every message, every file Claude reads, and every command output. However, this can fill up fast. A single debugging session or codebase exploration might generate and consume tens of thousands of tokens.

23This matters since LLM performance degrades as context fills. When the context window is getting full, Claude may start "forgetting" earlier instructions or making more mistakes. The context window is the most important resource to manage. Track context usage continuously with a [custom status line](/en/statusline), and see [Reduce token usage](/en/costs#reduce-token-usage) for strategies on reducing token usage.

25***

27## Give Claude a way to verify its work

29<Tip>

30 Include tests, screenshots, or expected outputs so Claude can check itself. This is the single highest-leverage thing you can do.

31</Tip>

33Claude performs dramatically better when it can verify its own work, like run tests, compare screenshots, and validate outputs.

35Without clear success criteria, it might produce something that looks right but actually doesn't work. You become the only feedback loop, and every mistake requires your attention.

37| Strategy | Before | After |

38| ------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

39| **Provide verification criteria** | *"implement a function that validates email addresses"* | *"write a validateEmail function. example test cases: [user@example.com](mailto:user@example.com) is true, invalid is false, [user@.com](mailto:user@.com) is false. run the tests after implementing"* |

40| **Verify UI changes visually** | *"make the dashboard look better"* | *"\[paste screenshot] implement this design. take a screenshot of the result and compare it to the original. list differences and fix them"* |

41| **Address root causes, not symptoms** | *"the build is failing"* | *"the build fails with this error: \[paste error]. fix it and verify the build succeeds. address the root cause, don't suppress the error"* |

43UI changes can be verified using the [Claude in Chrome extension](/en/chrome). It opens new tabs in your browser, tests the UI, and iterates until the code works.

45Your verification can also be a test suite, a linter, or a Bash command that checks output. Invest in making your verification rock-solid.

47***

49## Explore first, then plan, then code

51<Tip>

52 Separate research and planning from implementation to avoid solving the wrong problem.

53</Tip>

55Letting Claude jump straight to coding can produce code that solves the wrong problem. Use [Plan Mode](/en/common-workflows#use-plan-mode-for-safe-code-analysis) to separate exploration from execution.

57The recommended workflow has four phases:

59<Steps>

60 <Step title="Explore">

61 Enter Plan Mode. Claude reads files and answers questions without making changes.

63 ```txt claude (Plan Mode) theme={null}

64 read /src/auth and understand how we handle sessions and login.

65 also look at how we manage environment variables for secrets.

66 ```

67 </Step>

69 <Step title="Plan">

70 Ask Claude to create a detailed implementation plan.

72 ```txt claude (Plan Mode) theme={null}

73 I want to add Google OAuth. What files need to change?

74 What's the session flow? Create a plan.

75 ```

77 Press `Ctrl+G` to open the plan in your text editor for direct editing before Claude proceeds.

78 </Step>

80 <Step title="Implement">

81 Switch back to Normal Mode and let Claude code, verifying against its plan.

83 ```txt claude (Normal Mode) theme={null}

84 implement the OAuth flow from your plan. write tests for the

85 callback handler, run the test suite and fix any failures.

86 ```

87 </Step>

89 <Step title="Commit">

90 Ask Claude to commit with a descriptive message and create a PR.

92 ```txt claude (Normal Mode) theme={null}

93 commit with a descriptive message and open a PR

94 ```

95 </Step>

96</Steps>

98<Callout>

99 Plan Mode is useful, but also adds overhead.

100

101 For tasks where the scope is clear and the fix is small (like fixing a typo, adding a log line, or renaming a variable) ask Claude to do it directly.

102

103 Planning is most useful when you're uncertain about the approach, when the change modifies multiple files, or when you're unfamiliar with the code being modified. If you could describe the diff in one sentence, skip the plan.

104</Callout>

105

106***

107

108## Provide specific context in your prompts

109

110<Tip>

111 The more precise your instructions, the fewer corrections you'll need.

112</Tip>

113

114Claude can infer intent, but it can't read your mind. Reference specific files, mention constraints, and point to example patterns.

115

116| Strategy | Before | After |

117| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

118| **Scope the task.** Specify which file, what scenario, and testing preferences. | *"add tests for foo.py"* | *"write a test for foo.py covering the edge case where the user is logged out. avoid mocks."* |

119| **Point to sources.** Direct Claude to the source that can answer a question. | *"why does ExecutionFactory have such a weird api?"* | *"look through ExecutionFactory's git history and summarize how its api came to be"* |

120| **Reference existing patterns.** Point Claude to patterns in your codebase. | *"add a calendar widget"* | *"look at how existing widgets are implemented on the home page to understand the patterns. HotDogWidget.php is a good example. follow the pattern to implement a new calendar widget that lets the user select a month and paginate forwards/backwards to pick a year. build from scratch without libraries other than the ones already used in the codebase."* |

121| **Describe the symptom.** Provide the symptom, the likely location, and what "fixed" looks like. | *"fix the login bug"* | *"users report that login fails after session timeout. check the auth flow in src/auth/, especially token refresh. write a failing test that reproduces the issue, then fix it"* |

122

123Vague prompts can be useful when you're exploring and can afford to course-correct. A prompt like `"what would you improve in this file?"` can surface things you wouldn't have thought to ask about.

124

125### Provide rich content

126

127<Tip>

128 Use `@` to reference files, paste screenshots/images, or pipe data directly.

129</Tip>

130

131You can provide rich data to Claude in several ways:

132

133* **Reference files with `@`** instead of describing where code lives. Claude reads the file before responding.

134* **Paste images directly**. Copy/paste or drag and drop images into the prompt.

135* **Give URLs** for documentation and API references. Use `/permissions` to allowlist frequently-used domains.

136* **Pipe in data** by running `cat error.log | claude` to send file contents directly.

137* **Let Claude fetch what it needs**. Tell Claude to pull context itself using Bash commands, MCP tools, or by reading files.

138

139***

140

141## Configure your environment

142

143A few setup steps make Claude Code significantly more effective across all your sessions. For a full overview of extension features and when to use each one, see [Extend Claude Code](/en/features-overview).

144

145### Write an effective CLAUDE.md

146

147<Tip>

148 Run `/init` to generate a starter CLAUDE.md file based on your current project structure, then refine over time.

149</Tip>

150

151CLAUDE.md is a special file that Claude reads at the start of every conversation. Include Bash commands, code style, and workflow rules. This gives Claude persistent context it can't infer from code alone.

152

153The `/init` command analyzes your codebase to detect build systems, test frameworks, and code patterns, giving you a solid foundation to refine.

154

155There's no required format for CLAUDE.md files, but keep it short and human-readable. For example:

156

157```markdown CLAUDE.md theme={null}

158# Code style

159- Use ES modules (import/export) syntax, not CommonJS (require)

160- Destructure imports when possible (eg. import { foo } from 'bar')

161

162# Workflow

163- Be sure to typecheck when you're done making a series of code changes

164- Prefer running single tests, and not the whole test suite, for performance

165```

166

167CLAUDE.md is loaded every session, so only include things that apply broadly. For domain knowledge or workflows that are only relevant sometimes, use [skills](/en/skills) instead. Claude loads them on demand without bloating every conversation.

168

169Keep it concise. For each line, ask: *"Would removing this cause Claude to make mistakes?"* If not, cut it. Bloated CLAUDE.md files cause Claude to ignore your actual instructions!

170

171| ✅ Include | ❌ Exclude |

172| ---------------------------------------------------- | -------------------------------------------------- |

173| Bash commands Claude can't guess | Anything Claude can figure out by reading code |

174| Code style rules that differ from defaults | Standard language conventions Claude already knows |

175| Testing instructions and preferred test runners | Detailed API documentation (link to docs instead) |

176| Repository etiquette (branch naming, PR conventions) | Information that changes frequently |

177| Architectural decisions specific to your project | Long explanations or tutorials |

178| Developer environment quirks (required env vars) | File-by-file descriptions of the codebase |

179| Common gotchas or non-obvious behaviors | Self-evident practices like "write clean code" |

180

181If Claude keeps doing something you don't want despite having a rule against it, the file is probably too long and the rule is getting lost. If Claude asks you questions that are answered in CLAUDE.md, the phrasing might be ambiguous. Treat CLAUDE.md like code: review it when things go wrong, prune it regularly, and test changes by observing whether Claude's behavior actually shifts.

182

183You can tune instructions by adding emphasis (e.g., "IMPORTANT" or "YOU MUST") to improve adherence. Check CLAUDE.md into git so your team can contribute. The file compounds in value over time.

184

185CLAUDE.md files can import additional files using `@path/to/import` syntax:

186

187```markdown CLAUDE.md theme={null}

188See @README.md for project overview and @package.json for available npm commands.

189

190# Additional Instructions

191- Git workflow: @docs/git-instructions.md

192- Personal overrides: @~/.claude/my-project-instructions.md

193```

194

195You can place CLAUDE.md files in several locations:

196

197* **Home folder (`~/.claude/CLAUDE.md`)**: applies to all Claude sessions

198* **Project root (`./CLAUDE.md`)**: check into git to share with your team

199* **Parent directories**: useful for monorepos where both `root/CLAUDE.md` and `root/foo/CLAUDE.md` are pulled in automatically

200* **Child directories**: Claude pulls in child CLAUDE.md files on demand when working with files in those directories

201

202### Configure permissions

203

204<Tip>

205 Use [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) to let a classifier handle approvals, `/permissions` to allowlist specific commands, or `/sandbox` for OS-level isolation. Each reduces interruptions while keeping you in control.

206</Tip>

207

208By default, Claude Code requests permission for actions that might modify your system: file writes, Bash commands, MCP tools, etc. This is safe but tedious. After the tenth approval you're not really reviewing anymore, you're just clicking through. There are three ways to reduce these interruptions:

209

210* **Auto mode**: a separate classifier model reviews commands and blocks only what looks risky: scope escalation, unknown infrastructure, or hostile-content-driven actions. Best when you trust the general direction of a task but don't want to click through every step

211* **Permission allowlists**: permit specific tools you know are safe, like `npm run lint` or `git commit`

212* **Sandboxing**: enable OS-level isolation that restricts filesystem and network access, allowing Claude to work more freely within defined boundaries

213

214Read more about [permission modes](/en/permission-modes), [permission rules](/en/permissions), and [sandboxing](/en/sandboxing).

215

216### Use CLI tools

217

218<Tip>

219 Tell Claude Code to use CLI tools like `gh`, `aws`, `gcloud`, and `sentry-cli` when interacting with external services.

220</Tip>

221

222CLI tools are the most context-efficient way to interact with external services. If you use GitHub, install the `gh` CLI. Claude knows how to use it for creating issues, opening pull requests, and reading comments. Without `gh`, Claude can still use the GitHub API, but unauthenticated requests often hit rate limits.

223

224Claude is also effective at learning CLI tools it doesn't already know. Try prompts like `Use 'foo-cli-tool --help' to learn about foo tool, then use it to solve A, B, C.`

225

226### Connect MCP servers

227

228<Tip>

229 Run `claude mcp add` to connect external tools like Notion, Figma, or your database.

230</Tip>

231

232With [MCP servers](/en/mcp), you can ask Claude to implement features from issue trackers, query databases, analyze monitoring data, integrate designs from Figma, and automate workflows.

233

234### Set up hooks

235

236<Tip>

237 Use hooks for actions that must happen every time with zero exceptions.

238</Tip>

239

240[Hooks](/en/hooks-guide) run scripts automatically at specific points in Claude's workflow. Unlike CLAUDE.md instructions which are advisory, hooks are deterministic and guarantee the action happens.

241

242Claude can write hooks for you. Try prompts like *"Write a hook that runs eslint after every file edit"* or *"Write a hook that blocks writes to the migrations folder."* Edit `.claude/settings.json` directly to configure hooks by hand, and run `/hooks` to browse what's configured.

243

244### Create skills

245

246<Tip>

247 Create `SKILL.md` files in `.claude/skills/` to give Claude domain knowledge and reusable workflows.

248</Tip>

249

250[Skills](/en/skills) extend Claude's knowledge with information specific to your project, team, or domain. Claude applies them automatically when relevant, or you can invoke them directly with `/skill-name`.

251

252Create a skill by adding a directory with a `SKILL.md` to `.claude/skills/`:

253

254```markdown .claude/skills/api-conventions/SKILL.md theme={null}

255---

256name: api-conventions

257description: REST API design conventions for our services

258---

259# API Conventions

260- Use kebab-case for URL paths

261- Use camelCase for JSON properties

262- Always include pagination for list endpoints

263- Version APIs in the URL path (/v1/, /v2/)

264```

265

266Skills can also define repeatable workflows you invoke directly:

267

268```markdown .claude/skills/fix-issue/SKILL.md theme={null}

269---

270name: fix-issue

271description: Fix a GitHub issue

272disable-model-invocation: true

273---

274Analyze and fix the GitHub issue: $ARGUMENTS.

275

2761. Use `gh issue view` to get the issue details

2772. Understand the problem described in the issue

2783. Search the codebase for relevant files

2794. Implement the necessary changes to fix the issue

2805. Write and run tests to verify the fix

2816. Ensure code passes linting and type checking

2827. Create a descriptive commit message

2838. Push and create a PR

284```

285

286Run `/fix-issue 1234` to invoke it. Use `disable-model-invocation: true` for workflows with side effects that you want to trigger manually.

287

288### Create custom subagents

289

290<Tip>

291 Define specialized assistants in `.claude/agents/` that Claude can delegate to for isolated tasks.

292</Tip>

293

294[Subagents](/en/sub-agents) run in their own context with their own set of allowed tools. They're useful for tasks that read many files or need specialized focus without cluttering your main conversation.

295

296```markdown .claude/agents/security-reviewer.md theme={null}

297---

298name: security-reviewer

299description: Reviews code for security vulnerabilities

300tools: Read, Grep, Glob, Bash

301model: opus

302---

303You are a senior security engineer. Review code for:

304- Injection vulnerabilities (SQL, XSS, command injection)

305- Authentication and authorization flaws

306- Secrets or credentials in code

307- Insecure data handling

308

309Provide specific line references and suggested fixes.

310```

311

312Tell Claude to use subagents explicitly: *"Use a subagent to review this code for security issues."*

313

314### Install plugins

315

316<Tip>

317 Run `/plugin` to browse the marketplace. Plugins add skills, tools, and integrations without configuration.

318</Tip>

319

320[Plugins](/en/plugins) bundle skills, hooks, subagents, and MCP servers into a single installable unit from the community and Anthropic. If you work with a typed language, install a [code intelligence plugin](/en/discover-plugins#code-intelligence) to give Claude precise symbol navigation and automatic error detection after edits.

321

322For guidance on choosing between skills, subagents, hooks, and MCP, see [Extend Claude Code](/en/features-overview#match-features-to-your-goal).

323

324***

325

326## Communicate effectively

327

328The way you communicate with Claude Code significantly impacts the quality of results.

329

330### Ask codebase questions

331

332<Tip>

333 Ask Claude questions you'd ask a senior engineer.

334</Tip>

335

336When onboarding to a new codebase, use Claude Code for learning and exploration. You can ask Claude the same sorts of questions you would ask another engineer:

337

338* How does logging work?

339* How do I make a new API endpoint?

340* What does `async move { ... }` do on line 134 of `foo.rs`?

341* What edge cases does `CustomerOnboardingFlowImpl` handle?

342* Why does this code call `foo()` instead of `bar()` on line 333?

343

344Using Claude Code this way is an effective onboarding workflow, improving ramp-up time and reducing load on other engineers. No special prompting required: ask questions directly.

345

346### Let Claude interview you

347

348<Tip>

349 For larger features, have Claude interview you first. Start with a minimal prompt and ask Claude to interview you using the `AskUserQuestion` tool.

350</Tip>

351

352Claude asks about things you might not have considered yet, including technical implementation, UI/UX, edge cases, and tradeoffs.

353

354```text theme={null}

355I want to build [brief description]. Interview me in detail using the AskUserQuestion tool.

356

357Ask about technical implementation, UI/UX, edge cases, concerns, and tradeoffs. Don't ask obvious questions, dig into the hard parts I might not have considered.

358

359Keep interviewing until we've covered everything, then write a complete spec to SPEC.md.

360```

361

362Once the spec is complete, start a fresh session to execute it. The new session has clean context focused entirely on implementation, and you have a written spec to reference.

363

364***

365

366## Manage your session

367

368Conversations are persistent and reversible. Use this to your advantage!

369

370### Course-correct early and often

371

372<Tip>

373 Correct Claude as soon as you notice it going off track.

374</Tip>

375

376The best results come from tight feedback loops. Though Claude occasionally solves problems perfectly on the first attempt, correcting it quickly generally produces better solutions faster.

377

378* **`Esc`**: stop Claude mid-action with the `Esc` key. Context is preserved, so you can redirect.

379* **`Esc + Esc` or `/rewind`**: press `Esc` twice or run `/rewind` to open the rewind menu and restore previous conversation and code state, or summarize from a selected message.

380* **`"Undo that"`**: have Claude revert its changes.

381* **`/clear`**: reset context between unrelated tasks. Long sessions with irrelevant context can reduce performance.

382

383If you've corrected Claude more than twice on the same issue in one session, the context is cluttered with failed approaches. Run `/clear` and start fresh with a more specific prompt that incorporates what you learned. A clean session with a better prompt almost always outperforms a long session with accumulated corrections.

384

385### Manage context aggressively

386

387<Tip>

388 Run `/clear` between unrelated tasks to reset context.

389</Tip>

390

391Claude Code automatically compacts conversation history when you approach context limits, which preserves important code and decisions while freeing space.

392

393During long sessions, Claude's context window can fill with irrelevant conversation, file contents, and commands. This can reduce performance and sometimes distract Claude.

394

395* Use `/clear` frequently between tasks to reset the context window entirely

396* When auto compaction triggers, Claude summarizes what matters most, including code patterns, file states, and key decisions

397* For more control, run `/compact <instructions>`, like `/compact Focus on the API changes`

398* To compact only part of the conversation, use `Esc + Esc` or `/rewind`, select a message checkpoint, and choose **Summarize from here**. This condenses messages from that point forward while keeping earlier context intact.

399* Customize compaction behavior in CLAUDE.md with instructions like `"When compacting, always preserve the full list of modified files and any test commands"` to ensure critical context survives summarization

400* For quick questions that don't need to stay in context, use [`/btw`](/en/interactive-mode#side-questions-with-btw). The answer appears in a dismissible overlay and never enters conversation history, so you can check a detail without growing context.

401

402### Use subagents for investigation

403

404<Tip>

405 Delegate research with `"use subagents to investigate X"`. They explore in a separate context, keeping your main conversation clean for implementation.

406</Tip>

407

408Since context is your fundamental constraint, subagents are one of the most powerful tools available. When Claude researches a codebase it reads lots of files, all of which consume your context. Subagents run in separate context windows and report back summaries:

409

410```text theme={null}

411Use subagents to investigate how our authentication system handles token

412refresh, and whether we have any existing OAuth utilities I should reuse.

413```

414

415The subagent explores the codebase, reads relevant files, and reports back with findings, all without cluttering your main conversation.

416

417You can also use subagents for verification after Claude implements something:

418

419```text theme={null}

420use a subagent to review this code for edge cases

421```

422

423### Rewind with checkpoints

424

425<Tip>

426 Every action Claude makes creates a checkpoint. You can restore conversation, code, or both to any previous checkpoint.

427</Tip>

428

429Claude automatically checkpoints before changes. Double-tap `Escape` or run `/rewind` to open the rewind menu. You can restore conversation only, restore code only, restore both, or summarize from a selected message. See [Checkpointing](/en/checkpointing) for details.

430

431Instead of carefully planning every move, you can tell Claude to try something risky. If it doesn't work, rewind and try a different approach. Checkpoints persist across sessions, so you can close your terminal and still rewind later.

432

433<Warning>

434 Checkpoints only track changes made *by Claude*, not external processes. This isn't a replacement for git.

435</Warning>

436

437### Resume conversations

438

439<Tip>

440 Run `claude --continue` to pick up where you left off, or `--resume` to choose from recent sessions.

441</Tip>

442

443Claude Code saves conversations locally. When a task spans multiple sessions, you don't have to re-explain the context:

444

445```bash theme={null}

446claude --continue # Resume the most recent conversation

447claude --resume # Select from recent conversations

448```

449

450Use `/rename` to give sessions descriptive names like `"oauth-migration"` or `"debugging-memory-leak"` so you can find them later. Treat sessions like branches: different workstreams can have separate, persistent contexts.

451

452***

453

454## Automate and scale

455

456Once you're effective with one Claude, multiply your output with parallel sessions, non-interactive mode, and fan-out patterns.

457

458Everything so far assumes one human, one Claude, and one conversation. But Claude Code scales horizontally. The techniques in this section show how you can get more done.

459

460### Run non-interactive mode

461

462<Tip>

463 Use `claude -p "prompt"` in CI, pre-commit hooks, or scripts. Add `--output-format stream-json` for streaming JSON output.

464</Tip>

465

466With `claude -p "your prompt"`, you can run Claude non-interactively, without a session. Non-interactive mode is how you integrate Claude into CI pipelines, pre-commit hooks, or any automated workflow. The output formats let you parse results programmatically: plain text, JSON, or streaming JSON.

467

468```bash theme={null}

469# One-off queries

470claude -p "Explain what this project does"

471

472# Structured output for scripts

473claude -p "List all API endpoints" --output-format json

474

475# Streaming for real-time processing

476claude -p "Analyze this log file" --output-format stream-json

477```

478

479### Run multiple Claude sessions

480

481<Tip>

482 Run multiple Claude sessions in parallel to speed up development, run isolated experiments, or start complex workflows.

483</Tip>

484

485There are three main ways to run parallel sessions:

486

487* [Claude Code desktop app](/en/desktop#work-in-parallel-with-sessions): Manage multiple local sessions visually. Each session gets its own isolated worktree.

488* [Claude Code on the web](/en/claude-code-on-the-web): Run on Anthropic's secure cloud infrastructure in isolated VMs.

489* [Agent teams](/en/agent-teams): Automated coordination of multiple sessions with shared tasks, messaging, and a team lead.

490

491Beyond parallelizing work, multiple sessions enable quality-focused workflows. A fresh context improves code review since Claude won't be biased toward code it just wrote.

492

493For example, use a Writer/Reviewer pattern:

494

495| Session A (Writer) | Session B (Reviewer) |

496| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

497| `Implement a rate limiter for our API endpoints` | |

498| | `Review the rate limiter implementation in @src/middleware/rateLimiter.ts. Look for edge cases, race conditions, and consistency with our existing middleware patterns.` |

499| `Here's the review feedback: [Session B output]. Address these issues.` | |

500

501You can do something similar with tests: have one Claude write tests, then another write code to pass them.

502

503### Fan out across files

504

505<Tip>

506 Loop through tasks calling `claude -p` for each. Use `--allowedTools` to scope permissions for batch operations.

507</Tip>

508

509For large migrations or analyses, you can distribute work across many parallel Claude invocations:

510

511<Steps>

512 <Step title="Generate a task list">

513 Have Claude list all files that need migrating (e.g., `list all 2,000 Python files that need migrating`)

514 </Step>

515

516 <Step title="Write a script to loop through the list">

517 ```bash theme={null}

518 for file in $(cat files.txt); do

519 claude -p "Migrate $file from React to Vue. Return OK or FAIL." \

520 --allowedTools "Edit,Bash(git commit *)"

521 done

522 ```

523 </Step>

524

525 <Step title="Test on a few files, then run at scale">

526 Refine your prompt based on what goes wrong with the first 2-3 files, then run on the full set. The `--allowedTools` flag restricts what Claude can do, which matters when you're running unattended.

527 </Step>

528</Steps>

529

530You can also integrate Claude into existing data/processing pipelines:

531

532```bash theme={null}

533claude -p "<your prompt>" --output-format json | your_command

534```

535

536Use `--verbose` for debugging during development, and turn it off in production.

537

538### Run autonomously with auto mode

539

540For uninterrupted execution with background safety checks, use [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode). A classifier model reviews commands before they run, blocking scope escalation, unknown infrastructure, and hostile-content-driven actions while letting routine work proceed without prompts.

541

542```bash theme={null}

543claude --permission-mode auto -p "fix all lint errors"

544```

545

546For non-interactive runs with the `-p` flag, auto mode aborts if the classifier repeatedly blocks actions, since there is no user to fall back to. See [when auto mode falls back](/en/permission-modes#when-auto-mode-falls-back) for thresholds.

547

548***

549

550## Avoid common failure patterns

551

552These are common mistakes. Recognizing them early saves time:

553

554* **The kitchen sink session.** You start with one task, then ask Claude something unrelated, then go back to the first task. Context is full of irrelevant information.

555 > **Fix**: `/clear` between unrelated tasks.

556* **Correcting over and over.** Claude does something wrong, you correct it, it's still wrong, you correct again. Context is polluted with failed approaches.

557 > **Fix**: After two failed corrections, `/clear` and write a better initial prompt incorporating what you learned.

558* **The over-specified CLAUDE.md.** If your CLAUDE.md is too long, Claude ignores half of it because important rules get lost in the noise.

559 > **Fix**: Ruthlessly prune. If Claude already does something correctly without the instruction, delete it or convert it to a hook.

560* **The trust-then-verify gap.** Claude produces a plausible-looking implementation that doesn't handle edge cases.

561 > **Fix**: Always provide verification (tests, scripts, screenshots). If you can't verify it, don't ship it.

562* **The infinite exploration.** You ask Claude to "investigate" something without scoping it. Claude reads hundreds of files, filling the context.

563 > **Fix**: Scope investigations narrowly or use subagents so the exploration doesn't consume your main context.

564

565***

566

567## Develop your intuition

568

569The patterns in this guide aren't set in stone. They're starting points that work well in general, but might not be optimal for every situation.

570

571Sometimes you *should* let context accumulate because you're deep in one complex problem and the history is valuable. Sometimes you should skip planning and let Claude figure it out because the task is exploratory. Sometimes a vague prompt is exactly right because you want to see how Claude interprets the problem before constraining it.

572

573Pay attention to what works. When Claude produces great output, notice what you did: the prompt structure, the context you provided, the mode you were in. When Claude struggles, ask why. Was the context too noisy? The prompt too vague? The task too big for one pass?

574

575Over time, you'll develop intuition that no guide can capture. You'll know when to be specific and when to be open-ended, when to plan and when to explore, when to clear context and when to let it accumulate.

576

577## Related resources

578

579* [How Claude Code works](/en/how-claude-code-works): the agentic loop, tools, and context management

580* [Extend Claude Code](/en/features-overview): skills, hooks, MCP, subagents, and plugins

581* [Common workflows](/en/common-workflows): step-by-step recipes for debugging, testing, PRs, and more

582* [CLAUDE.md](/en/memory): store project conventions and persistent context

channels.md +357 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Push events into a running session with channels

7> Use channels to push messages, alerts, and webhooks into your Claude Code session from an MCP server. Forward CI results, chat messages, and monitoring events so Claude can react while you're away.

9<Note>

10 Channels are in [research preview](#research-preview) and require Claude Code v2.1.80 or later. They require claude.ai login. Console and API key authentication is not supported. Team and Enterprise organizations must [explicitly enable them](#enterprise-controls).

11</Note>

13A channel is an MCP server that pushes events into your running Claude Code session, so Claude can react to things that happen while you're not at the terminal. Channels can be two-way: Claude reads the event and replies back through the same channel, like a chat bridge. Events only arrive while the session is open, so for an always-on setup you run Claude in a background process or persistent terminal.

15Unlike integrations that spawn a fresh cloud session or wait to be polled, the event arrives in the session you already have open: see [how channels compare](#how-channels-compare).

17You install a channel as a plugin and configure it with your own credentials. Telegram, Discord, and iMessage are included in the research preview.

19When Claude replies through a channel, you see the inbound message in your terminal but not the reply text. The terminal shows the tool call and a confirmation (like "sent"), and the actual reply appears on the other platform.

21This page covers:

23* [Supported channels](#supported-channels): Telegram, Discord, and iMessage setup

24* [Install and run a channel](#quickstart) with fakechat, a localhost demo

25* [Who can push messages](#security): sender allowlists and how you pair

26* [Enable channels for your organization](#enterprise-controls) on Team and Enterprise

27* [How channels compare](#how-channels-compare) to web sessions, Slack, MCP, and Remote Control

29To build your own channel, see the [Channels reference](/en/channels-reference).

31## Supported channels

33Each supported channel is a plugin that requires [Bun](https://bun.sh). For a hands-on demo of the plugin flow before connecting a real platform, try the [fakechat quickstart](#quickstart).

35<Tabs>

36 <Tab title="Telegram">

37 View the full [Telegram plugin source](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/telegram).

39 <Steps>

40 <Step title="Create a Telegram bot">

41 Open [BotFather](https://t.me/BotFather) in Telegram and send `/newbot`. Give it a display name and a unique username ending in `bot`. Copy the token BotFather returns.

42 </Step>

44 <Step title="Install the plugin">

45 In Claude Code, run:

47 ```

48 /plugin install telegram@claude-plugins-official

49 ```

51 If Claude Code reports that the plugin is not found in any marketplace, your marketplace is either missing or outdated. Run `/plugin marketplace update claude-plugins-official` to refresh it, or `/plugin marketplace add anthropics/claude-plugins-official` if you haven't added it before. Then retry the install.

53 After installing, run `/reload-plugins` to activate the plugin's configure command.

54 </Step>

56 <Step title="Configure your token">

57 Run the configure command with the token from BotFather:

59 ```

60 /telegram:configure <token>

61 ```

63 This saves it to `~/.claude/channels/telegram/.env`. You can also set `TELEGRAM_BOT_TOKEN` in your shell environment before launching Claude Code.

64 </Step>

66 <Step title="Restart with channels enabled">

67 Exit Claude Code and restart with the channel flag. This starts the Telegram plugin, which begins polling for messages from your bot:

69 ```bash theme={null}

70 claude --channels plugin:telegram@claude-plugins-official

71 ```

72 </Step>

74 <Step title="Pair your account">

75 Open Telegram and send any message to your bot. The bot replies with a pairing code.

77 <Note>If your bot doesn't respond, make sure Claude Code is running with `--channels` from the previous step. The bot can only reply while the channel is active.</Note>

79 Back in Claude Code, run:

81 ```

82 /telegram:access pair <code>

83 ```

85 Then lock down access so only your account can send messages:

87 ```

88 /telegram:access policy allowlist

89 ```

90 </Step>

91 </Steps>

92 </Tab>

94 <Tab title="Discord">

95 View the full [Discord plugin source](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/discord).

97 <Steps>

98 <Step title="Create a Discord bot">

99 Go to the [Discord Developer Portal](https://discord.com/developers/applications), click **New Application**, and name it. In the **Bot** section, create a username, then click **Reset Token** and copy the token.

100 </Step>

101

102 <Step title="Enable Message Content Intent">

103 In your bot's settings, scroll to **Privileged Gateway Intents** and enable **Message Content Intent**.

104 </Step>

105

106 <Step title="Invite the bot to your server">

107 Go to **OAuth2 > URL Generator**. Select the `bot` scope and enable these permissions:

108

109 * View Channels

110 * Send Messages

111 * Send Messages in Threads

112 * Read Message History

113 * Attach Files

114 * Add Reactions

115

116 Open the generated URL to add the bot to your server.

117 </Step>

118

119 <Step title="Install the plugin">

120 In Claude Code, run:

121

122 ```

123 /plugin install discord@claude-plugins-official

124 ```

125

126 If Claude Code reports that the plugin is not found in any marketplace, your marketplace is either missing or outdated. Run `/plugin marketplace update claude-plugins-official` to refresh it, or `/plugin marketplace add anthropics/claude-plugins-official` if you haven't added it before. Then retry the install.

127

128 After installing, run `/reload-plugins` to activate the plugin's configure command.

129 </Step>

130

131 <Step title="Configure your token">

132 Run the configure command with the bot token you copied:

133

134 ```

135 /discord:configure <token>

136 ```

137

138 This saves it to `~/.claude/channels/discord/.env`. You can also set `DISCORD_BOT_TOKEN` in your shell environment before launching Claude Code.

139 </Step>

140

141 <Step title="Restart with channels enabled">

142 Exit Claude Code and restart with the channel flag. This connects the Discord plugin so your bot can receive and respond to messages:

143

144 ```bash theme={null}

145 claude --channels plugin:discord@claude-plugins-official

146 ```

147 </Step>

148

149 <Step title="Pair your account">

150 DM your bot on Discord. The bot replies with a pairing code.

151

152 <Note>If your bot doesn't respond, make sure Claude Code is running with `--channels` from the previous step. The bot can only reply while the channel is active.</Note>

153

154 Back in Claude Code, run:

155

156 ```

157 /discord:access pair <code>

158 ```

159

160 Then lock down access so only your account can send messages:

161

162 ```

163 /discord:access policy allowlist

164 ```

165 </Step>

166 </Steps>

167 </Tab>

168

169 <Tab title="iMessage">

170 View the full [iMessage plugin source](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/imessage).

171

172 The iMessage channel reads your Messages database directly and sends replies through AppleScript. It requires macOS and needs no bot token or external service.

173

174 <Steps>

175 <Step title="Grant Full Disk Access">

176 The Messages database at `~/Library/Messages/chat.db` is protected by macOS. The first time the server reads it, macOS prompts for access: click **Allow**. The prompt names whichever app launched Bun, such as Terminal, iTerm, or your IDE.

177

178 If the prompt doesn't appear or you clicked Don't Allow, grant access manually under **System Settings > Privacy & Security > Full Disk Access** and add your terminal. Without this, the server exits immediately with `authorization denied`.

179 </Step>

180

181 <Step title="Install the plugin">

182 In Claude Code, run:

183

184 ```

185 /plugin install imessage@claude-plugins-official

186 ```

187

188 If Claude Code reports that the plugin is not found in any marketplace, your marketplace is either missing or outdated. Run `/plugin marketplace update claude-plugins-official` to refresh it, or `/plugin marketplace add anthropics/claude-plugins-official` if you haven't added it before. Then retry the install.

189 </Step>

190

191 <Step title="Restart with channels enabled">

192 Exit Claude Code and restart with the channel flag:

193

194 ```bash theme={null}

195 claude --channels plugin:imessage@claude-plugins-official

196 ```

197 </Step>

198

199 <Step title="Text yourself">

200 Open Messages on any device signed into your Apple ID and send a message to yourself. It reaches Claude immediately: self-chat bypasses access control with no setup.

201

202 <Note>The first reply Claude sends triggers a macOS Automation prompt asking if your terminal can control Messages. Click **OK**.</Note>

203 </Step>

204

205 <Step title="Allow other senders">

206 By default, only your own messages pass through. To let another contact reach Claude, add their handle:

207

208 ```

209 /imessage:access allow +15551234567

210 ```

211

212 Handles are phone numbers in `+country` format or Apple ID emails like `user@example.com`.

213 </Step>

214 </Steps>

215 </Tab>

216</Tabs>

217

218You can also [build your own channel](/en/channels-reference) for systems that don't have a plugin yet.

219

220## Quickstart

221

222Fakechat is an officially supported demo channel that runs a chat UI on localhost, with nothing to authenticate and no external service to configure.

223

224Once you install and enable fakechat, you can type in the browser and the message arrives in your Claude Code session. Claude replies, and the reply shows up back in the browser. After you've tested the fakechat interface, try out [Telegram](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/telegram), [Discord](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/discord), or [iMessage](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/imessage).

225

226To try the fakechat demo, you'll need:

227

228* Claude Code [installed and authenticated](/en/quickstart#step-1-install-claude-code) with a claude.ai account

229* [Bun](https://bun.sh) installed. The pre-built channel plugins are Bun scripts. Check with `bun --version`; if that fails, [install Bun](https://bun.sh/docs/installation).

230* **Team/Enterprise users**: your organization admin must [enable channels](#enterprise-controls) in managed settings

231

232<Steps>

233 <Step title="Install the fakechat channel plugin">

234 Start a Claude Code session and run the install command:

235

236 ```text theme={null}

237 /plugin install fakechat@claude-plugins-official

238 ```

239

240 If Claude Code reports that the plugin is not found in any marketplace, your marketplace is either missing or outdated. Run `/plugin marketplace update claude-plugins-official` to refresh it, or `/plugin marketplace add anthropics/claude-plugins-official` if you haven't added it before. Then retry the install.

241 </Step>

242

243 <Step title="Restart with the channel enabled">

244 Exit Claude Code, then restart with `--channels` and pass the fakechat plugin you installed:

245

246 ```bash theme={null}

247 claude --channels plugin:fakechat@claude-plugins-official

248 ```

249

250 The fakechat server starts automatically.

251

252 <Tip>

253 You can pass several plugins to `--channels`, space-separated.

254 </Tip>

255 </Step>

256

257 <Step title="Push a message in">

258 Open the fakechat UI at [http://localhost:8787](http://localhost:8787) and type a message:

259

260 ```text theme={null}

261 hey, what's in my working directory?

262 ```

263

264 The message arrives in your Claude Code session as a `<channel source="fakechat">` event. Claude reads it, does the work, and calls fakechat's `reply` tool. The answer shows up in the chat UI.

265 </Step>

266</Steps>

267

268If Claude hits a permission prompt while you're away from the terminal, the session pauses until you respond. Channel servers that declare the [permission relay capability](/en/channels-reference#relay-permission-prompts) can forward these prompts to you so you can approve or deny remotely. For unattended use, [`--dangerously-skip-permissions`](/en/permission-modes#skip-all-checks-with-bypasspermissions-mode) bypasses prompts entirely, but only use it in environments you trust.

269

270## Security

271

272Every approved channel plugin maintains a sender allowlist: only IDs you've added can push messages, and everyone else is silently dropped.

273

274Telegram and Discord bootstrap the list by pairing:

275

2761. Find your bot in Telegram or Discord and send it any message

2772. The bot replies with a pairing code

2783. In your Claude Code session, approve the code when prompted

2794. Your sender ID is added to the allowlist

280

281iMessage works differently: texting yourself bypasses the gate automatically, and you add other contacts by handle with `/imessage:access allow`.

282

283On top of that, you control which servers are enabled each session with `--channels`, and on Team and Enterprise plans your organization controls availability with [`channelsEnabled`](#enterprise-controls).

284

285Being in `.mcp.json` isn't enough to push messages: a server also has to be named in `--channels`.

286

287The allowlist also gates [permission relay](/en/channels-reference#relay-permission-prompts) if the channel declares it. Anyone who can reply through the channel can approve or deny tool use in your session, so only allowlist senders you trust with that authority.

288

289## Enterprise controls

290

291On Team and Enterprise plans, channels are off by default. Admins control availability through two [managed settings](/en/settings) that users cannot override:

292

293| Setting | Purpose | When not configured |

294| :---------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------- |

295| `channelsEnabled` | Master switch. Must be `true` for any channel to deliver messages. Set via the [claude.ai Admin console](https://claude.ai/admin-settings/claude-code) toggle or directly in managed settings. Blocks all channels including the development flag when off. | Channels blocked |

296| `allowedChannelPlugins` | Which plugins can register once channels are enabled. Replaces the Anthropic-maintained list when set. Only applies when `channelsEnabled` is `true`. | Anthropic default list applies |

297

298Pro and Max users without an organization skip these checks entirely: channels are available and users opt in per session with `--channels`.

299

300### Enable channels for your organization

301

302Admins can enable channels from [**claude.ai → Admin settings → Claude Code → Channels**](https://claude.ai/admin-settings/claude-code), or by setting `channelsEnabled` to `true` in managed settings.

303

304Once enabled, users in your organization can use `--channels` to opt channel servers into individual sessions. If the setting is disabled or unset, the MCP server still connects and its tools work, but channel messages won't arrive. A startup warning tells the user to have an admin enable the setting.

305

306### Restrict which channel plugins can run

307

308By default, any plugin on the Anthropic-maintained allowlist can register as a channel. Admins on Team and Enterprise plans can replace that allowlist with their own by setting `allowedChannelPlugins` in managed settings. Use this to restrict which official plugins are allowed, approve channels from your own internal marketplace, or both. Each entry names a plugin and the marketplace it comes from:

309

310```json theme={null}

311{

312 "channelsEnabled": true,

313 "allowedChannelPlugins": [

314 { "marketplace": "claude-plugins-official", "plugin": "telegram" },

315 { "marketplace": "claude-plugins-official", "plugin": "discord" },

316 { "marketplace": "acme-corp-plugins", "plugin": "internal-alerts" }

317 ]

318}

319```

320

321When `allowedChannelPlugins` is set, it replaces the Anthropic allowlist entirely: only the listed plugins can register. Leave it unset to fall back to the default Anthropic allowlist. An empty array blocks all channel plugins from the allowlist, but `--dangerously-load-development-channels` can still bypass it for local testing. To block channels entirely including the development flag, leave `channelsEnabled` unset instead.

322

323This setting requires `channelsEnabled: true`. If a user passes a plugin to `--channels` that isn't on your list, Claude Code starts normally but the channel doesn't register, and the startup notice explains that the plugin isn't on the organization's approved list.

324

325## Research preview

326

327Channels are a research preview feature. Availability is rolling out gradually, and the `--channels` flag syntax and protocol contract may change based on feedback.

328

329During the preview, `--channels` only accepts plugins from an Anthropic-maintained allowlist, or from your organization's allowlist if an admin has set [`allowedChannelPlugins`](#restrict-which-channel-plugins-can-run). The channel plugins in [claude-plugins-official](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins) are the default approved set. If you pass something that isn't on the effective allowlist, Claude Code starts normally but the channel doesn't register, and the startup notice tells you why.

330

331To test a channel you're building, use `--dangerously-load-development-channels`. See [Test during the research preview](/en/channels-reference#test-during-the-research-preview) for information about testing custom channels that you build.

332

333Report issues or feedback on the [Claude Code GitHub repository](https://github.com/anthropics/claude-code/issues).

334

335## How channels compare

336

337Several Claude Code features connect to systems outside the terminal, each suited to a different kind of work:

338

339| Feature | What it does | Good for |

340| ---------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------- |

341| [Claude Code on the web](/en/claude-code-on-the-web) | Runs tasks in a fresh cloud sandbox, cloned from GitHub | Delegating self-contained async work you check on later |

342| [Claude in Slack](/en/slack) | Spawns a web session from an `@Claude` mention in a channel or thread | Starting tasks directly from team conversation context |

343| Standard [MCP server](/en/mcp) | Claude queries it during a task; nothing is pushed to the session | Giving Claude on-demand access to read or query a system |

344| [Remote Control](/en/remote-control) | You drive your local session from claude.ai or the Claude mobile app | Steering an in-progress session while away from your desk |

345

346Channels fill the gap in that list by pushing events from non-Claude sources into your already-running local session.

347

348* **Chat bridge**: ask Claude something from your phone via Telegram, Discord, or iMessage, and the answer comes back in the same chat while the work runs on your machine against your real files.

349* **[Webhook receiver](/en/channels-reference#example-build-a-webhook-receiver)**: a webhook from CI, your error tracker, a deploy pipeline, or other external service arrives where Claude already has your files open and remembers what you were debugging.

350

351## Next steps

352

353Once you have a channel running, explore these related features:

354

355* [Build your own channel](/en/channels-reference) for systems that don't have plugins yet

356* [Remote Control](/en/remote-control) to drive a local session from your phone instead of forwarding events into it

357* [Scheduled tasks](/en/scheduled-tasks) to poll on a timer instead of reacting to pushed events

channels-reference.md +749 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Channels reference

7> Build an MCP server that pushes webhooks, alerts, and chat messages into a Claude Code session. Reference for the channel contract: capability declaration, notification events, reply tools, sender gating, and permission relay.

9<Note>

10 Channels are in [research preview](/en/channels#research-preview) and require Claude Code v2.1.80 or later. They require claude.ai login. Console and API key authentication is not supported. Team and Enterprise organizations must [explicitly enable them](/en/channels#enterprise-controls).

11</Note>

13A channel is an MCP server that pushes events into a Claude Code session so Claude can react to things happening outside the terminal.

15You can build a one-way or two-way channel. One-way channels forward alerts, webhooks, or monitoring events for Claude to act on. Two-way channels like chat bridges also [expose a reply tool](#expose-a-reply-tool) so Claude can send messages back. A channel with a trusted sender path can also opt in to [relay permission prompts](#relay-permission-prompts) so you can approve or deny tool use remotely.

17This page covers:

19* [Overview](#overview): how channels work

20* [What you need](#what-you-need): requirements and general steps

21* [Example: build a webhook receiver](#example-build-a-webhook-receiver): a minimal one-way walkthrough

22* [Server options](#server-options): the constructor fields

23* [Notification format](#notification-format): the event payload

24* [Expose a reply tool](#expose-a-reply-tool): let Claude send messages back

25* [Gate inbound messages](#gate-inbound-messages): sender checks to prevent prompt injection

26* [Relay permission prompts](#relay-permission-prompts): forward tool approval prompts to remote channels

28To use an existing channel instead of building one, see [Channels](/en/channels). Telegram, Discord, iMessage, and fakechat are included in the research preview.

30## Overview

32A channel is an [MCP](https://modelcontextprotocol.io) server that runs on the same machine as Claude Code. Claude Code spawns it as a subprocess and communicates over stdio. Your channel server is the bridge between external systems and the Claude Code session:

34* **Chat platforms** (Telegram, Discord): your plugin runs locally and polls the platform's API for new messages. When someone DMs your bot, the plugin receives the message and forwards it to Claude. No URL to expose.

35* **Webhooks** (CI, monitoring): your server listens on a local HTTP port. External systems POST to that port, and your server pushes the payload to Claude.

37<img src="https://mintcdn.com/claude-code/zbUxPYi8065L3Y_P/en/images/channel-architecture.svg?fit=max&auto=format&n=zbUxPYi8065L3Y_P&q=85&s=fd6b6b949eab38264043d2a96285a57c" alt="Architecture diagram showing external systems connecting to your local channel server, which communicates with Claude Code over stdio" width="600" height="220" data-path="en/images/channel-architecture.svg" />

39## What you need

41The only hard requirement is the [`@modelcontextprotocol/sdk`](https://www.npmjs.com/package/@modelcontextprotocol/sdk) package and a Node.js-compatible runtime. [Bun](https://bun.sh), [Node](https://nodejs.org), and [Deno](https://deno.com) all work. The pre-built plugins in the research preview use Bun, but your channel doesn't have to.

43Your server needs to:

451. Declare the `claude/channel` capability so Claude Code registers a notification listener

462. Emit `notifications/claude/channel` events when something happens

473. Connect over [stdio transport](https://modelcontextprotocol.io/docs/concepts/transports#standard-io) (Claude Code spawns your server as a subprocess)

49The [Server options](#server-options) and [Notification format](#notification-format) sections cover each of these in detail. See [Example: build a webhook receiver](#example-build-a-webhook-receiver) for a full walkthrough.

51During the research preview, custom channels aren't on the [approved allowlist](/en/channels#supported-channels). Use `--dangerously-load-development-channels` to test locally. See [Test during the research preview](#test-during-the-research-preview) for details.

53## Example: build a webhook receiver

55This walkthrough builds a single-file server that listens for HTTP requests and forwards them into your Claude Code session. By the end, anything that can send an HTTP POST, like a CI pipeline, a monitoring alert, or a `curl` command, can push events to Claude.

57This example uses [Bun](https://bun.sh) as the runtime for its built-in HTTP server and TypeScript support. You can use [Node](https://nodejs.org) or [Deno](https://deno.com) instead; the only requirement is the [MCP SDK](https://www.npmjs.com/package/@modelcontextprotocol/sdk).

59<Steps>

60 <Step title="Create the project">

61 Create a new directory and install the MCP SDK:

63 ```bash theme={null}

64 mkdir webhook-channel && cd webhook-channel

65 bun add @modelcontextprotocol/sdk

66 ```

67 </Step>

69 <Step title="Write the channel server">

70 Create a file called `webhook.ts`. This is your entire channel server: it connects to Claude Code over stdio, and it listens for HTTP POSTs on port 8788. When a request arrives, it pushes the body to Claude as a channel event.

72 ```ts title="webhook.ts" theme={null}

73 #!/usr/bin/env bun

74 import { Server } from '@modelcontextprotocol/sdk/server/index.js'

75 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'

77 // Create the MCP server and declare it as a channel

78 const mcp = new Server(

79 { name: 'webhook', version: '0.0.1' },

80 {

81 // this key is what makes it a channel — Claude Code registers a listener for it

82 capabilities: { experimental: { 'claude/channel': {} } },

83 // added to Claude's system prompt so it knows how to handle these events

84 instructions: 'Events from the webhook channel arrive as <channel source="webhook" ...>. They are one-way: read them and act, no reply expected.',

85 },

86 )

88 // Connect to Claude Code over stdio (Claude Code spawns this process)

89 await mcp.connect(new StdioServerTransport())

91 // Start an HTTP server that forwards every POST to Claude

92 Bun.serve({

93 port: 8788, // any open port works

94 // localhost-only: nothing outside this machine can POST

95 hostname: '127.0.0.1',

96 async fetch(req) {

97 const body = await req.text()

98 await mcp.notification({

99 method: 'notifications/claude/channel',

100 params: {

101 content: body, // becomes the body of the <channel> tag

102 // each key becomes a tag attribute, e.g. <channel path="/" method="POST">

103 meta: { path: new URL(req.url).pathname, method: req.method },

104 },

105 })

106 return new Response('ok')

107 },

108 })

109 ```

110

111 The file does three things in order:

112

113 * **Server configuration**: creates the MCP server with `claude/channel` in its capabilities, which is what tells Claude Code this is a channel. The [`instructions`](#server-options) string goes into Claude's system prompt: tell Claude what events to expect, whether to reply, and how to route replies if it should.

114 * **Stdio connection**: connects to Claude Code over stdin/stdout. This is standard for any [MCP server](https://modelcontextprotocol.io/docs/concepts/transports#standard-io): Claude Code spawns it as a subprocess.

115 * **HTTP listener**: starts a local web server on port 8788. Every POST body gets forwarded to Claude as a channel event via `mcp.notification()`. The `content` becomes the event body, and each `meta` entry becomes an attribute on the `<channel>` tag. The listener needs access to the `mcp` instance, so it runs in the same process. You could split it into separate modules for a larger project.

116 </Step>

117

118 <Step title="Register your server with Claude Code">

119 Add the server to your MCP config so Claude Code knows how to start it. For a project-level `.mcp.json` in the same directory, use a relative path. For user-level config in `~/.claude.json`, use the full absolute path so the server can be found from any project:

120

121 ```json title=".mcp.json" theme={null}

122 {

123 "mcpServers": {

124 "webhook": { "command": "bun", "args": ["./webhook.ts"] }

125 }

126 }

127 ```

128

129 Claude Code reads your MCP config at startup and spawns each server as a subprocess.

130 </Step>

131

132 <Step title="Test it">

133 During the research preview, custom channels aren't on the allowlist, so start Claude Code with the development flag:

134

135 ```bash theme={null}

136 claude --dangerously-load-development-channels server:webhook

137 ```

138

139 When Claude Code starts, it reads your MCP config, spawns your `webhook.ts` as a subprocess, and the HTTP listener starts automatically on the port you configured (8788 in this example). You don't need to run the server yourself.

140

141 If you see "blocked by org policy," your Team or Enterprise admin needs to [enable channels](/en/channels#enterprise-controls) first.

142

143 In a separate terminal, simulate a webhook by sending an HTTP POST with a message to your server. This example sends a CI failure alert to port 8788 (or whichever port you configured):

144

145 ```bash theme={null}

146 curl -X POST localhost:8788 -d "build failed on main: https://ci.example.com/run/1234"

147 ```

148

149 The payload arrives in your Claude Code session as a `<channel>` tag:

150

151 ```text theme={null}

152 <channel source="webhook" path="/" method="POST">build failed on main: https://ci.example.com/run/1234</channel>

153 ```

154

155 In your Claude Code terminal, you'll see Claude receive the message and start responding: reading files, running commands, or whatever the message calls for. This is a one-way channel, so Claude acts in your session but doesn't send anything back through the webhook. To add replies, see [Expose a reply tool](#expose-a-reply-tool).

156

157 If the event doesn't arrive, the diagnosis depends on what `curl` returned:

158

159 * **`curl` succeeds but nothing reaches Claude**: run `/mcp` in your session to check the server's status. "Failed to connect" usually means a dependency or import error in your server file; check the debug log at `~/.claude/debug/<session-id>.txt` for the stderr trace.

160 * **`curl` fails with "connection refused"**: the port is either not bound yet or a stale process from an earlier run is holding it. `lsof -i :<port>` shows what's listening; `kill` the stale process before restarting your session.

161 </Step>

162</Steps>

163

164The [fakechat server](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/fakechat) extends this pattern with a web UI, file attachments, and a reply tool for two-way chat.

165

166## Test during the research preview

167

168During the research preview, every channel must be on the [approved allowlist](/en/channels#research-preview) to register. The development flag bypasses the allowlist for specific entries after a confirmation prompt. This example shows both entry types:

169

170```bash theme={null}

171# Testing a plugin you're developing

172claude --dangerously-load-development-channels plugin:yourplugin@yourmarketplace

173

174# Testing a bare .mcp.json server (no plugin wrapper yet)

175claude --dangerously-load-development-channels server:webhook

176```

177

178The bypass is per-entry. Combining this flag with `--channels` doesn't extend the bypass to the `--channels` entries. During the research preview, the approved allowlist is Anthropic-curated, so your channel stays on the development flag while you build and test.

179

180<Note>

181 This flag skips the allowlist only. The `channelsEnabled` organization policy still applies. Don't use it to run channels from untrusted sources.

182</Note>

183

184## Server options

185

186A channel sets these options in the [`Server`](https://modelcontextprotocol.io/docs/concepts/servers) constructor. The `instructions` and `capabilities.tools` fields are [standard MCP](https://modelcontextprotocol.io/docs/concepts/servers); `capabilities.experimental['claude/channel']` and `capabilities.experimental['claude/channel/permission']` are the channel-specific additions:

187

188| Field | Type | Description |

189| :------------------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

190| `capabilities.experimental['claude/channel']` | `object` | Required. Always `{}`. Presence registers the notification listener. |

191| `capabilities.experimental['claude/channel/permission']` | `object` | Optional. Always `{}`. Declares that this channel can receive permission relay requests. When declared, Claude Code forwards tool approval prompts to your channel so you can approve or deny them remotely. See [Relay permission prompts](#relay-permission-prompts). |

192| `capabilities.tools` | `object` | Two-way only. Always `{}`. Standard MCP tool capability. See [Expose a reply tool](#expose-a-reply-tool). |

193| `instructions` | `string` | Recommended. Added to Claude's system prompt. Tell Claude what events to expect, what the `<channel>` tag attributes mean, whether to reply, and if so which tool to use and which attribute to pass back (like `chat_id`). |

194

195To create a one-way channel, omit `capabilities.tools`. This example shows a two-way setup with the channel capability, tools, and instructions set:

196

197```ts theme={null}

198import { Server } from '@modelcontextprotocol/sdk/server/index.js'

199

200const mcp = new Server(

201 { name: 'your-channel', version: '0.0.1' },

202 {

203 capabilities: {

204 experimental: { 'claude/channel': {} }, // registers the channel listener

205 tools: {}, // omit for one-way channels

206 },

207 // added to Claude's system prompt so it knows how to handle your events

208 instructions: 'Messages arrive as <channel source="your-channel" ...>. Reply with the reply tool.',

209 },

210)

211```

212

213To push an event, call `mcp.notification()` with method `notifications/claude/channel`. The params are in the next section.

214

215## Notification format

216

217Your server emits `notifications/claude/channel` with two params:

218

219| Field | Type | Description |

220| :-------- | :----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

221| `content` | `string` | The event body. Delivered as the body of the `<channel>` tag. |

222| `meta` | `Record<string, string>` | Optional. Each entry becomes an attribute on the `<channel>` tag for routing context like chat ID, sender name, or alert severity. Keys must be identifiers: letters, digits, and underscores only. Keys containing hyphens or other characters are silently dropped. |

223

224Your server pushes events by calling `mcp.notification()` on the `Server` instance. This example pushes a CI failure alert with two meta keys:

225

226```ts theme={null}

227await mcp.notification({

228 method: 'notifications/claude/channel',

229 params: {

230 content: 'build failed on main: https://ci.example.com/run/1234',

231 meta: { severity: 'high', run_id: '1234' },

232 },

233})

234```

235

236The event arrives in Claude's context wrapped in a `<channel>` tag. The `source` attribute is set automatically from your server's configured name:

237

238```text theme={null}

239<channel source="your-channel" severity="high" run_id="1234">

240build failed on main: https://ci.example.com/run/1234

241</channel>

242```

243

244## Expose a reply tool

245

246If your channel is two-way, like a chat bridge rather than an alert forwarder, expose a standard [MCP tool](https://modelcontextprotocol.io/docs/concepts/tools) that Claude can call to send messages back. Nothing about the tool registration is channel-specific. A reply tool has three components:

247

2481. A `tools: {}` entry in your `Server` constructor capabilities so Claude Code discovers the tool

2492. Tool handlers that define the tool's schema and implement the send logic

2503. An `instructions` string in your `Server` constructor that tells Claude when and how to call the tool

251

252To add these to the [webhook receiver above](#example-build-a-webhook-receiver):

253

254<Steps>

255 <Step title="Enable tool discovery">

256 In your `Server` constructor in `webhook.ts`, add `tools: {}` to the capabilities so Claude Code knows your server offers tools:

257

258 ```ts theme={null}

259 capabilities: {

260 experimental: { 'claude/channel': {} },

261 tools: {}, // enables tool discovery

262 },

263 ```

264 </Step>

265

266 <Step title="Register the reply tool">

267 Add the following to `webhook.ts`. The `import` goes at the top of the file with your other imports; the two handlers go between the `Server` constructor and `mcp.connect()`. This registers a `reply` tool that Claude can call with a `chat_id` and `text`:

268

269 ```ts theme={null}

270 // Add this import at the top of webhook.ts

271 import { ListToolsRequestSchema, CallToolRequestSchema } from '@modelcontextprotocol/sdk/types.js'

272

273 // Claude queries this at startup to discover what tools your server offers

274 mcp.setRequestHandler(ListToolsRequestSchema, async () => ({

275 tools: [{

276 name: 'reply',

277 description: 'Send a message back over this channel',

278 // inputSchema tells Claude what arguments to pass

279 inputSchema: {

280 type: 'object',

281 properties: {

282 chat_id: { type: 'string', description: 'The conversation to reply in' },

283 text: { type: 'string', description: 'The message to send' },

284 },

285 required: ['chat_id', 'text'],

286 },

287 }],

288 }))

289

290 // Claude calls this when it wants to invoke a tool

291 mcp.setRequestHandler(CallToolRequestSchema, async req => {

292 if (req.params.name === 'reply') {

293 const { chat_id, text } = req.params.arguments as { chat_id: string; text: string }

294 // send() is your outbound: POST to your chat platform, or for local

295 // testing the SSE broadcast shown in the full example below.

296 send(`Reply to ${chat_id}: ${text}`)

297 return { content: [{ type: 'text', text: 'sent' }] }

298 }

299 throw new Error(`unknown tool: ${req.params.name}`)

300 })

301 ```

302 </Step>

303

304 <Step title="Update the instructions">

305 Update the `instructions` string in your `Server` constructor so Claude knows to route replies back through the tool. This example tells Claude to pass `chat_id` from the inbound tag:

306

307 ```ts theme={null}

308 instructions: 'Messages arrive as <channel source="webhook" chat_id="...">. Reply with the reply tool, passing the chat_id from the tag.'

309 ```

310 </Step>

311</Steps>

312

313Here's the complete `webhook.ts` with two-way support. Outbound replies stream over `GET /events` using [Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) (SSE), so `curl -N localhost:8788/events` can watch them live; inbound chat arrives on `POST /`:

314

315```ts title="Full webhook.ts with reply tool" expandable theme={null}

316#!/usr/bin/env bun

317import { Server } from '@modelcontextprotocol/sdk/server/index.js'

318import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'

319import { ListToolsRequestSchema, CallToolRequestSchema } from '@modelcontextprotocol/sdk/types.js'

320

321// --- Outbound: write to any curl -N listeners on /events --------------------

322// A real bridge would POST to your chat platform instead.

323const listeners = new Set<(chunk: string) => void>()

324function send(text: string) {

325 const chunk = text.split('\n').map(l => `data: ${l}\n`).join('') + '\n'

326 for (const emit of listeners) emit(chunk)

327}

328

329const mcp = new Server(

330 { name: 'webhook', version: '0.0.1' },

331 {

332 capabilities: {

333 experimental: { 'claude/channel': {} },

334 tools: {},

335 },

336 instructions: 'Messages arrive as <channel source="webhook" chat_id="...">. Reply with the reply tool, passing the chat_id from the tag.',

337 },

338)

339

340mcp.setRequestHandler(ListToolsRequestSchema, async () => ({

341 tools: [{

342 name: 'reply',

343 description: 'Send a message back over this channel',

344 inputSchema: {

345 type: 'object',

346 properties: {

347 chat_id: { type: 'string', description: 'The conversation to reply in' },

348 text: { type: 'string', description: 'The message to send' },

349 },

350 required: ['chat_id', 'text'],

351 },

352 }],

353}))

354

355mcp.setRequestHandler(CallToolRequestSchema, async req => {

356 if (req.params.name === 'reply') {

357 const { chat_id, text } = req.params.arguments as { chat_id: string; text: string }

358 send(`Reply to ${chat_id}: ${text}`)

359 return { content: [{ type: 'text', text: 'sent' }] }

360 }

361 throw new Error(`unknown tool: ${req.params.name}`)

362})

363

364await mcp.connect(new StdioServerTransport())

365

366let nextId = 1

367Bun.serve({

368 port: 8788,

369 hostname: '127.0.0.1',

370 idleTimeout: 0, // don't close idle SSE streams

371 async fetch(req) {

372 const url = new URL(req.url)

373

374 // GET /events: SSE stream so curl -N can watch Claude's replies live

375 if (req.method === 'GET' && url.pathname === '/events') {

376 const stream = new ReadableStream({

377 start(ctrl) {

378 ctrl.enqueue(': connected\n\n') // so curl shows something immediately

379 const emit = (chunk: string) => ctrl.enqueue(chunk)

380 listeners.add(emit)

381 req.signal.addEventListener('abort', () => listeners.delete(emit))

382 },

383 })

384 return new Response(stream, {

385 headers: { 'Content-Type': 'text/event-stream', 'Cache-Control': 'no-cache' },

386 })

387 }

388

389 // POST: forward to Claude as a channel event

390 const body = await req.text()

391 const chat_id = String(nextId++)

392 await mcp.notification({

393 method: 'notifications/claude/channel',

394 params: {

395 content: body,

396 meta: { chat_id, path: url.pathname, method: req.method },

397 },

398 })

399 return new Response('ok')

400 },

401})

402```

403

404The [fakechat server](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/fakechat) shows a more complete example with file attachments and message editing.

405

406## Gate inbound messages

407

408An ungated channel is a prompt injection vector. Anyone who can reach your endpoint can put text in front of Claude. A channel listening to a chat platform or a public endpoint needs a real sender check before it emits anything.

409

410Check the sender against an allowlist before calling `mcp.notification()`. This example drops any message from a sender not in the set:

411

412```ts theme={null}

413const allowed = new Set(loadAllowlist()) // from your access.json or equivalent

414

415// inside your message handler, before emitting:

416if (!allowed.has(message.from.id)) { // sender, not room

417 return // drop silently

418}

419await mcp.notification({ ... })

420```

421

422Gate on the sender's identity, not the chat or room identity: `message.from.id` in the example, not `message.chat.id`. In group chats, these differ, and gating on the room would let anyone in an allowlisted group inject messages into the session.

423

424The [Telegram](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/telegram) and [Discord](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/discord) channels gate on a sender allowlist the same way. They bootstrap the list by pairing: the user DMs the bot, the bot replies with a pairing code, the user approves it in their Claude Code session, and their platform ID is added. See either implementation for the full pairing flow. The [iMessage](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/imessage) channel takes a different approach: it detects the user's own addresses from the Messages database at startup and lets them through automatically, with other senders added by handle.

425

426## Relay permission prompts

427

428<Note>

429 Permission relay requires Claude Code v2.1.81 or later. Earlier versions ignore the `claude/channel/permission` capability.

430</Note>

431

432When Claude calls a tool that needs approval, the local terminal dialog opens and the session waits. A two-way channel can opt in to receive the same prompt in parallel and relay it to you on another device. Both stay live: you can answer in the terminal or on your phone, and Claude Code applies whichever answer arrives first and closes the other.

433

434Relay covers tool-use approvals like `Bash`, `Write`, and `Edit`. Project trust and MCP server consent dialogs don't relay; those only appear in the local terminal.

435

436### How relay works

437

438When a permission prompt opens, the relay loop has four steps:

439

4401. Claude Code generates a short request ID and notifies your server

4412. Your server forwards the prompt and ID to your chat app

4423. The remote user replies with a yes or no and that ID

4434. Your inbound handler parses the reply into a verdict, and Claude Code applies it only if the ID matches an open request

444

445The local terminal dialog stays open through all of this. If someone at the terminal answers before the remote verdict arrives, that answer is applied instead and the pending remote request is dropped.

446

447<img src="https://mintcdn.com/claude-code/DsZvsJII1OmzIjIs/en/images/channel-permission-relay.svg?fit=max&auto=format&n=DsZvsJII1OmzIjIs&q=85&s=c1d75f6ee34c2757983e2cca899b90d1" alt="Sequence diagram: Claude Code sends a permission_request notification to the channel server, the server formats and sends the prompt to the chat app, the human replies with a verdict, and the server parses that reply into a permission notification back to Claude Code" width="600" height="230" data-path="en/images/channel-permission-relay.svg" />

448

449### Permission request fields

450

451The outbound notification from Claude Code is `notifications/claude/channel/permission_request`. Like the [channel notification](#notification-format), the transport is standard MCP but the method and schema are Claude Code extensions. The `params` object has four string fields your server formats into the outgoing prompt:

452

453| Field | Description |

454| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

455| `request_id` | Five lowercase letters drawn from `a`-`z` without `l`, so it never reads as a `1` or `I` when typed on a phone. Include it in your outgoing prompt so it can be echoed in the reply. Claude Code only accepts a verdict that carries an ID it issued. The local terminal dialog doesn't display this ID, so your outbound handler is the only way to learn it. |

456| `tool_name` | Name of the tool Claude wants to use, for example `Bash` or `Write`. |

457| `description` | Human-readable summary of what this specific tool call does, the same text the local terminal dialog shows. For a Bash call this is Claude's description of the command, or the command itself if none was given. |

458| `input_preview` | The tool's arguments as a JSON string, truncated to 200 characters. For Bash this is the command; for Write it's the file path and a prefix of the content. Omit it from your prompt if you only have room for a one-line message. Your server decides what to show. |

459

460The verdict your server sends back is `notifications/claude/channel/permission` with two fields: `request_id` echoing the ID above, and `behavior` set to `'allow'` or `'deny'`. Allow lets the tool call proceed; deny rejects it, the same as answering No in the local dialog. Neither verdict affects future calls.

461

462### Add relay to a chat bridge

463

464Adding permission relay to a two-way channel takes three components:

465

4661. A `claude/channel/permission: {}` entry under `experimental` capabilities in your `Server` constructor so Claude Code knows to forward prompts

4672. A notification handler for `notifications/claude/channel/permission_request` that formats the prompt and sends it out through your platform API

4683. A check in your inbound message handler that recognizes `yes <id>` or `no <id>` and emits a `notifications/claude/channel/permission` verdict instead of forwarding the text to Claude

469

470Only declare the capability if your channel [authenticates the sender](#gate-inbound-messages), because anyone who can reply through your channel can approve or deny tool use in your session.

471

472To add these to a two-way chat bridge like the one assembled in [Expose a reply tool](#expose-a-reply-tool):

473

474<Steps>

475 <Step title="Declare the permission capability">

476 In your `Server` constructor, add `claude/channel/permission: {}` alongside `claude/channel` under `experimental`:

477

478 ```ts theme={null}

479 capabilities: {

480 experimental: {

481 'claude/channel': {},

482 'claude/channel/permission': {}, // opt in to permission relay

483 },

484 tools: {},

485 },

486 ```

487 </Step>

488

489 <Step title="Handle the incoming request">

490 Register a notification handler between your `Server` constructor and `mcp.connect()`. Claude Code calls it with the [four request fields](#permission-request-fields) when a permission dialog opens. Your handler formats the prompt for your platform and includes instructions for replying with the ID:

491

492 ```ts theme={null}

493 import { z } from 'zod'

494

495 // setNotificationHandler routes by z.literal on the method field,

496 // so this schema is both the validator and the dispatch key

497 const PermissionRequestSchema = z.object({

498 method: z.literal('notifications/claude/channel/permission_request'),

499 params: z.object({

500 request_id: z.string(), // five lowercase letters, include verbatim in your prompt

501 tool_name: z.string(), // e.g. "Bash", "Write"

502 description: z.string(), // human-readable summary of this call

503 input_preview: z.string(), // tool args as JSON, truncated to ~200 chars

504 }),

505 })

506

507 mcp.setNotificationHandler(PermissionRequestSchema, async ({ params }) => {

508 // send() is your outbound: POST to your chat platform, or for local

509 // testing the SSE broadcast shown in the full example below.

510 send(

511 `Claude wants to run ${params.tool_name}: ${params.description}\n\n` +

512 // the ID in the instruction is what your inbound handler parses in Step 3

513 `Reply "yes ${params.request_id}" or "no ${params.request_id}"`,

514 )

515 })

516 ```

517 </Step>

518

519 <Step title="Intercept the verdict in your inbound handler">

520 Your inbound handler is the loop or callback that receives messages from your platform: the same place you [gate on sender](#gate-inbound-messages) and emit `notifications/claude/channel` to forward chat to Claude. Add a check before the chat-forwarding call that recognizes the verdict format and emits the permission notification instead.

521

522 The regex matches the ID format Claude Code generates: five letters, never `l`. The `/i` flag tolerates phone autocorrect capitalizing the reply; lowercase the captured ID before sending it back.

523

524 ```ts theme={null}

525 // matches "y abcde", "yes abcde", "n abcde", "no abcde"

526 // [a-km-z] is the ID alphabet Claude Code uses (lowercase, skips 'l')

527 // /i tolerates phone autocorrect; lowercase the capture before sending

528 const PERMISSION_REPLY_RE = /^\s*(y|yes|n|no)\s+([a-km-z]{5})\s*$/i

529

530 async function onInbound(message: PlatformMessage) {

531 if (!allowed.has(message.from.id)) return // gate on sender first

532

533 const m = PERMISSION_REPLY_RE.exec(message.text)

534 if (m) {

535 // m[1] is the verdict word, m[2] is the request ID

536 // emit the verdict notification back to Claude Code instead of chat

537 await mcp.notification({

538 method: 'notifications/claude/channel/permission',

539 params: {

540 request_id: m[2].toLowerCase(), // normalize in case of autocorrect caps

541 behavior: m[1].toLowerCase().startsWith('y') ? 'allow' : 'deny',

542 },

543 })

544 return // handled as verdict, don't also forward as chat

545 }

546

547 // didn't match verdict format: fall through to the normal chat path

548 await mcp.notification({

549 method: 'notifications/claude/channel',

550 params: { content: message.text, meta: { chat_id: String(message.chat.id) } },

551 })

552 }

553 ```

554 </Step>

555</Steps>

556

557Claude Code also keeps the local terminal dialog open, so you can answer in either place, and the first answer to arrive is applied. A remote reply that doesn't exactly match the expected format fails in one of two ways, and in both cases the dialog stays open:

558

559* **Different format**: your inbound handler's regex fails to match, so text like `approve it` or `yes` without an ID falls through as a normal message to Claude.

560* **Right format, wrong ID**: your server emits a verdict, but Claude Code finds no open request with that ID and drops it silently.

561

562### Full example

563

564The assembled `webhook.ts` below combines all three extensions from this page: the reply tool, sender gating, and permission relay. If you're starting here, you'll also need the [project setup and `.mcp.json` entry](#example-build-a-webhook-receiver) from the initial walkthrough.

565

566To make both directions testable from curl, the HTTP listener serves two paths:

567

568* **`GET /events`**: holds an SSE stream open and pushes each outbound message as a `data:` line, so `curl -N` can watch Claude's replies and permission prompts arrive live.

569* **`POST /`**: the inbound side, the same handler as earlier, now with the verdict-format check inserted before the chat-forward branch.

570

571```ts title="Full webhook.ts with permission relay" expandable theme={null}

572#!/usr/bin/env bun

573import { Server } from '@modelcontextprotocol/sdk/server/index.js'

574import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'

575import { ListToolsRequestSchema, CallToolRequestSchema } from '@modelcontextprotocol/sdk/types.js'

576import { z } from 'zod'

577

578// --- Outbound: write to any curl -N listeners on /events --------------------

579// A real bridge would POST to your chat platform instead.

580const listeners = new Set<(chunk: string) => void>()

581function send(text: string) {

582 const chunk = text.split('\n').map(l => `data: ${l}\n`).join('') + '\n'

583 for (const emit of listeners) emit(chunk)

584}

585

586// Sender allowlist. For the local walkthrough we trust the single X-Sender

587// header value "dev"; a real bridge would check the platform's user ID.

588const allowed = new Set(['dev'])

589

590const mcp = new Server(

591 { name: 'webhook', version: '0.0.1' },

592 {

593 capabilities: {

594 experimental: {

595 'claude/channel': {},

596 'claude/channel/permission': {}, // opt in to permission relay

597 },

598 tools: {},

599 },

600 instructions:

601 'Messages arrive as <channel source="webhook" chat_id="...">. ' +

602 'Reply with the reply tool, passing the chat_id from the tag.',

603 },

604)

605

606// --- reply tool: Claude calls this to send a message back -------------------

607mcp.setRequestHandler(ListToolsRequestSchema, async () => ({

608 tools: [{

609 name: 'reply',

610 description: 'Send a message back over this channel',

611 inputSchema: {

612 type: 'object',

613 properties: {

614 chat_id: { type: 'string', description: 'The conversation to reply in' },

615 text: { type: 'string', description: 'The message to send' },

616 },

617 required: ['chat_id', 'text'],

618 },

619 }],

620}))

621

622mcp.setRequestHandler(CallToolRequestSchema, async req => {

623 if (req.params.name === 'reply') {

624 const { chat_id, text } = req.params.arguments as { chat_id: string; text: string }

625 send(`Reply to ${chat_id}: ${text}`)

626 return { content: [{ type: 'text', text: 'sent' }] }

627 }

628 throw new Error(`unknown tool: ${req.params.name}`)

629})

630

631// --- permission relay: Claude Code (not Claude) calls this when a dialog opens

632const PermissionRequestSchema = z.object({

633 method: z.literal('notifications/claude/channel/permission_request'),

634 params: z.object({

635 request_id: z.string(),

636 tool_name: z.string(),

637 description: z.string(),

638 input_preview: z.string(),

639 }),

640})

641

642mcp.setNotificationHandler(PermissionRequestSchema, async ({ params }) => {

643 send(

644 `Claude wants to run ${params.tool_name}: ${params.description}\n\n` +

645 `Reply "yes ${params.request_id}" or "no ${params.request_id}"`,

646 )

647})

648

649await mcp.connect(new StdioServerTransport())

650

651// --- HTTP on :8788: GET /events streams outbound, POST routes inbound -------

652const PERMISSION_REPLY_RE = /^\s*(y|yes|n|no)\s+([a-km-z]{5})\s*$/i

653let nextId = 1

654

655Bun.serve({

656 port: 8788,

657 hostname: '127.0.0.1',

658 idleTimeout: 0, // don't close idle SSE streams

659 async fetch(req) {

660 const url = new URL(req.url)

661

662 // GET /events: SSE stream so curl -N can watch replies and prompts live

663 if (req.method === 'GET' && url.pathname === '/events') {

664 const stream = new ReadableStream({

665 start(ctrl) {

666 ctrl.enqueue(': connected\n\n') // so curl shows something immediately

667 const emit = (chunk: string) => ctrl.enqueue(chunk)

668 listeners.add(emit)

669 req.signal.addEventListener('abort', () => listeners.delete(emit))

670 },

671 })

672 return new Response(stream, {

673 headers: { 'Content-Type': 'text/event-stream', 'Cache-Control': 'no-cache' },

674 })

675 }

676

677 // everything else is inbound: gate on sender first

678 const body = await req.text()

679 const sender = req.headers.get('X-Sender') ?? ''

680 if (!allowed.has(sender)) return new Response('forbidden', { status: 403 })

681

682 // check for verdict format before treating as chat

683 const m = PERMISSION_REPLY_RE.exec(body)

684 if (m) {

685 await mcp.notification({

686 method: 'notifications/claude/channel/permission',

687 params: {

688 request_id: m[2].toLowerCase(),

689 behavior: m[1].toLowerCase().startsWith('y') ? 'allow' : 'deny',

690 },

691 })

692 return new Response('verdict recorded')

693 }

694

695 // normal chat: forward to Claude as a channel event

696 const chat_id = String(nextId++)

697 await mcp.notification({

698 method: 'notifications/claude/channel',

699 params: { content: body, meta: { chat_id, path: url.pathname } },

700 })

701 return new Response('ok')

702 },

703})

704```

705

706Test the verdict path in three terminals. The first is your Claude Code session, started with the [development flag](#test-during-the-research-preview) so it spawns `webhook.ts`:

707

708```bash theme={null}

709claude --dangerously-load-development-channels server:webhook

710```

711

712In the second, stream the outbound side so you can see Claude's replies and any permission prompts as they fire:

713

714```bash theme={null}

715curl -N localhost:8788/events

716```

717

718In the third, send a message that will make Claude try to run a command:

719

720```bash theme={null}

721curl -d "list the files in this directory" -H "X-Sender: dev" localhost:8788

722```

723

724The local permission dialog opens in your Claude Code terminal. A moment later the prompt appears in the `/events` stream, including the five-letter ID. Approve it from the remote side:

725

726```bash theme={null}

727curl -d "yes <id>" -H "X-Sender: dev" localhost:8788

728```

729

730The local dialog closes and the tool runs. Claude's reply comes back through the `reply` tool and lands in the stream too.

731

732The three channel-specific pieces in this file:

733

734* **Capabilities** in the `Server` constructor: `claude/channel` registers the notification listener, `claude/channel/permission` opts in to permission relay, `tools` lets Claude discover the reply tool.

735* **Outbound paths**: the `reply` tool handler is what Claude calls for conversational responses; the `PermissionRequestSchema` notification handler is what Claude Code calls when a permission dialog opens. Both call `send()` to broadcast over `/events`, but they're triggered by different parts of the system.

736* **HTTP handler**: `GET /events` holds an SSE stream open so curl can watch outbound live; `POST` is inbound, gated on the `X-Sender` header. A `yes <id>` or `no <id>` body goes to Claude Code as a verdict notification and never reaches Claude; anything else is forwarded to Claude as a channel event.

737

738## Package as a plugin

739

740To make your channel installable and shareable, wrap it in a [plugin](/en/plugins) and publish it to a [marketplace](/en/plugin-marketplaces). Users install it with `/plugin install`, then enable it per session with `--channels plugin:<name>@<marketplace>`.

741

742A channel published to your own marketplace still needs `--dangerously-load-development-channels` to run, since it isn't on the [approved allowlist](/en/channels#supported-channels). To get it added, [submit it to the official marketplace](/en/plugins#submit-your-plugin-to-the-official-marketplace). Channel plugins go through security review before being approved. On Team and Enterprise plans, an admin can instead include your plugin in the organization's own [`allowedChannelPlugins`](/en/channels#restrict-which-channel-plugins-can-run) list, which replaces the default Anthropic allowlist.

743

744## See also

745

746* [Channels](/en/channels) to install and use Telegram, Discord, iMessage, or the fakechat demo, and to enable channels for a Team or Enterprise org

747* [Working channel implementations](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins) for complete server code with pairing flows, reply tools, and file attachments

748* [MCP](/en/mcp) for the underlying protocol that channel servers implement

749* [Plugins](/en/plugins) to package your channel so users can install it with `/plugin install`

checkpointing.md +34 −10

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Checkpointing5# Checkpointing

2 6

~~3> Automatically track and rewind Claude's edits to quickly recover from unwanted changes.~~7> Track, rewind, and summarize Claude's edits and conversation to manage session state.

4 8

5Claude Code automatically tracks Claude's file edits as you work, allowing you to quickly undo changes and rewind to previous states if anything gets off track.9Claude Code automatically tracks Claude's file edits as you work, allowing you to quickly undo changes and rewind to previous states if anything gets off track.

6 10

16* Checkpoints persist across sessions, so you can access them in resumed conversations20* Checkpoints persist across sessions, so you can access them in resumed conversations

17* Automatically cleaned up along with sessions after 30 days (configurable)21* Automatically cleaned up along with sessions after 30 days (configurable)

18 22

~~19### Rewinding changes~~23### Rewind and summarize

25Press `Esc` twice (`Esc` + `Esc`) or use the `/rewind` command to open the rewind menu. A scrollable list shows each of your prompts from the session. Select the point you want to act on, then choose an action:

27* **Restore code and conversation**: revert both code and conversation to that point

28* **Restore conversation**: rewind to that message while keeping current code

29* **Restore code**: revert file changes while keeping the conversation

30* **Summarize from here**: compress the conversation from this point forward into a summary, freeing context window space

31* **Never mind**: return to the message list without making changes

33After restoring the conversation or summarizing, the original prompt from the selected message is restored into the input field so you can re-send or edit it.

35#### Restore vs. summarize

37The three restore options revert state: they undo code changes, conversation history, or both. "Summarize from here" works differently:

39* Messages before the selected message stay intact

40* The selected message and all subsequent messages get replaced with a compact AI-generated summary

41* No files on disk are changed

42* The original messages are preserved in the session transcript, so Claude can reference the details if needed

20 43

~~21Press `Esc` twice (`Esc` + `Esc`) or use the `/rewind` command to open up the rewind menu. You can choose to restore:~~44This is similar to `/compact`, but targeted: instead of summarizing the entire conversation, you keep early context in full detail and only compress the parts that are using up space. You can type optional instructions to guide what the summary focuses on.

22 45

~~23* **Conversation only**: Rewind to a user message while keeping code changes~~46<Note>

~~24* **Code only**: Revert file changes while keeping the conversation~~47 Summarize keeps you in the same session and compresses context. If you want to branch off and try a different approach while preserving the original session intact, use [fork](/en/how-claude-code-works#resume-or-fork-sessions) instead (`claude --continue --fork-session`).

~~25* **Both code and conversation**: Restore both to a prior point in the session~~48</Note>

26 49

27## Common use cases50## Common use cases

28 51

29Checkpoints are particularly useful when:52Checkpoints are particularly useful when:

30 53

~~31* **Exploring alternatives**: Try different implementation approaches without losing your starting point~~54* **Exploring alternatives**: try different implementation approaches without losing your starting point

~~32* **Recovering from mistakes**: Quickly undo changes that introduced bugs or broke functionality~~55* **Recovering from mistakes**: quickly undo changes that introduced bugs or broke functionality

~~33* **Iterating on features**: Experiment with variations knowing you can revert to working states~~56* **Iterating on features**: experiment with variations knowing you can revert to working states

57* **Freeing context space**: summarize a verbose debugging session from the midpoint forward, keeping your initial instructions intact

34 58

35## Limitations59## Limitations

36 60

61## See also85## See also

62 86

63* [Interactive mode](/en/interactive-mode) - Keyboard shortcuts and session controls87* [Interactive mode](/en/interactive-mode) - Keyboard shortcuts and session controls

~~64* [Slash commands](/en/slash-commands) - Accessing checkpoints using `/rewind`~~88* [Built-in commands](/en/commands) - Accessing checkpoints using `/rewind`

65* [CLI reference](/en/cli-reference) - Command-line options89* [CLI reference](/en/cli-reference) - Command-line options

chrome.md +231 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Use Claude Code with Chrome (beta)

7> Connect Claude Code to your Chrome browser to test web apps, debug with console logs, automate form filling, and extract data from web pages.

9Claude Code integrates with the Claude in Chrome browser extension to give you browser automation capabilities from the CLI or the [VS Code extension](/en/vs-code#automate-browser-tasks-with-chrome). Build your code, then test and debug in the browser without switching contexts.

11Claude opens new tabs for browser tasks and shares your browser's login state, so it can access any site you're already signed into. Browser actions run in a visible Chrome window in real time. When Claude encounters a login page or CAPTCHA, it pauses and asks you to handle it manually.

13<Note>

14 Chrome integration is in beta and currently works with Google Chrome and Microsoft Edge. It is not yet supported on Brave, Arc, or other Chromium-based browsers. WSL (Windows Subsystem for Linux) is also not supported.

15</Note>

17## Capabilities

19With Chrome connected, you can chain browser actions with coding tasks in a single workflow:

21* **Live debugging**: read console errors and DOM state directly, then fix the code that caused them

22* **Design verification**: build a UI from a Figma mock, then open it in the browser to verify it matches

23* **Web app testing**: test form validation, check for visual regressions, or verify user flows

24* **Authenticated web apps**: interact with Google Docs, Gmail, Notion, or any app you're logged into without API connectors

25* **Data extraction**: pull structured information from web pages and save it locally

26* **Task automation**: automate repetitive browser tasks like data entry, form filling, or multi-site workflows

27* **Session recording**: record browser interactions as GIFs to document or share what happened

29## Prerequisites

31Before using Claude Code with Chrome, you need:

33* [Google Chrome](https://www.google.com/chrome/) or [Microsoft Edge](https://www.microsoft.com/edge) browser

34* [Claude in Chrome extension](https://chromewebstore.google.com/detail/claude/fcoeoabgfenejglbffodgkkbkcdhcgfn) version 1.0.36 or higher, available in the Chrome Web Store for both browsers

35* [Claude Code](/en/quickstart#step-1-install-claude-code) version 2.0.73 or higher

36* A direct Anthropic plan (Pro, Max, Teams, or Enterprise)

38<Note>

39 Chrome integration is not available through third-party providers like Amazon Bedrock, Google Cloud Vertex AI, or Microsoft Foundry. If you access Claude exclusively through a third-party provider, you need a separate claude.ai account to use this feature.

40</Note>

42## Get started in the CLI

44<Steps>

45 <Step title="Launch Claude Code with Chrome">

46 Start Claude Code with the `--chrome` flag:

48 ```bash theme={null}

49 claude --chrome

50 ```

52 You can also enable Chrome from within an existing session by running `/chrome`.

53 </Step>

55 <Step title="Ask Claude to use the browser">

56 This example navigates to a page, interacts with it, and reports what it finds, all from your terminal or editor:

58 ```text theme={null}

59 Go to code.claude.com/docs, click on the search box,

60 type "hooks", and tell me what results appear

61 ```

62 </Step>

63</Steps>

65Run `/chrome` at any time to check the connection status, manage permissions, or reconnect the extension.

67For VS Code, see [browser automation in VS Code](/en/vs-code#automate-browser-tasks-with-chrome).

69### Enable Chrome by default

71To avoid passing `--chrome` each session, run `/chrome` and select "Enabled by default".

73In the [VS Code extension](/en/vs-code#automate-browser-tasks-with-chrome), Chrome is available whenever the Chrome extension is installed. No additional flag is needed.

75<Note>

76 Enabling Chrome by default in the CLI increases context usage since browser tools are always loaded. If you notice increased context consumption, disable this setting and use `--chrome` only when needed.

77</Note>

79### Manage site permissions

81Site-level permissions are inherited from the Chrome extension. Manage permissions in the Chrome extension settings to control which sites Claude can browse, click, and type on.

83## Example workflows

85These examples show common ways to combine browser actions with coding tasks. Run `/mcp` and select `claude-in-chrome` to see the full list of available browser tools.

87### Test a local web application

89When developing a web app, ask Claude to verify your changes work correctly:

91```text theme={null}

92I just updated the login form validation. Can you open localhost:3000,

93try submitting the form with invalid data, and check if the error

94messages appear correctly?

95```

97Claude navigates to your local server, interacts with the form, and reports what it observes.

99### Debug with console logs

100

101Claude can read console output to help diagnose problems. Tell Claude what patterns to look for rather than asking for all console output, since logs can be verbose:

102

103```text theme={null}

104Open the dashboard page and check the console for any errors when

105the page loads.

106```

107

108Claude reads the console messages and can filter for specific patterns or error types.

109

110### Automate form filling

111

112Speed up repetitive data entry tasks:

113

114```text theme={null}

115I have a spreadsheet of customer contacts in contacts.csv. For each row,

116go to the CRM at crm.example.com, click "Add Contact", and fill in the

117name, email, and phone fields.

118```

119

120Claude reads your local file, navigates the web interface, and enters the data for each record.

121

122### Draft content in Google Docs

123

124Use Claude to write directly in your documents without API setup:

125

126```text theme={null}

127Draft a project update based on the recent commits and add it to my

128Google Doc at docs.google.com/document/d/abc123

129```

130

131Claude opens the document, clicks into the editor, and types the content. This works with any web app you're logged into: Gmail, Notion, Sheets, and more.

132

133### Extract data from web pages

134

135Pull structured information from websites:

136

137```text theme={null}

138Go to the product listings page and extract the name, price, and

139availability for each item. Save the results as a CSV file.

140```

141

142Claude navigates to the page, reads the content, and compiles the data into a structured format.

143

144### Run multi-site workflows

145

146Coordinate tasks across multiple websites:

147

148```text theme={null}

149Check my calendar for meetings tomorrow, then for each meeting with

150an external attendee, look up their company website and add a note

151about what they do.

152```

153

154Claude works across tabs to gather information and complete the workflow.

155

156### Record a demo GIF

157

158Create shareable recordings of browser interactions:

159

160```text theme={null}

161Record a GIF showing how to complete the checkout flow, from adding

162an item to the cart through to the confirmation page.

163```

164

165Claude records the interaction sequence and saves it as a GIF file.

166

167## Troubleshooting

168

169### Extension not detected

170

171If Claude Code shows "Chrome extension not detected":

172

1731. Verify the Chrome extension is installed and enabled in `chrome://extensions`

1742. Verify Claude Code is up to date by running `claude --version`

1753. Check that Chrome is running

1764. Run `/chrome` and select "Reconnect extension" to re-establish the connection

1775. If the issue persists, restart both Claude Code and Chrome

178

179The first time you enable Chrome integration, Claude Code installs a native messaging host configuration file. Chrome reads this file on startup, so if the extension isn't detected on your first attempt, restart Chrome to pick up the new configuration.

180

181If the connection still fails, verify the host configuration file exists at:

182

183For Chrome:

184

185* **macOS**: `~/Library/Application Support/Google/Chrome/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`

186* **Linux**: `~/.config/google-chrome/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`

187* **Windows**: check `HKCU\Software\Google\Chrome\NativeMessagingHosts\` in the Windows Registry

188

189For Edge:

190

191* **macOS**: `~/Library/Application Support/Microsoft Edge/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`

192* **Linux**: `~/.config/microsoft-edge/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`

193* **Windows**: check `HKCU\Software\Microsoft\Edge\NativeMessagingHosts\` in the Windows Registry

194

195### Browser not responding

196

197If Claude's browser commands stop working:

198

1991. Check if a modal dialog (alert, confirm, prompt) is blocking the page. JavaScript dialogs block browser events and prevent Claude from receiving commands. Dismiss the dialog manually, then tell Claude to continue.

2002. Ask Claude to create a new tab and try again

2013. Restart the Chrome extension by disabling and re-enabling it in `chrome://extensions`

202

203### Connection drops during long sessions

204

205The Chrome extension's service worker can go idle during extended sessions, which breaks the connection. If browser tools stop working after a period of inactivity, run `/chrome` and select "Reconnect extension".

206

207### Windows-specific issues

208

209On Windows, you may encounter:

210

211* **Named pipe conflicts (EADDRINUSE)**: if another process is using the same named pipe, restart Claude Code. Close any other Claude Code sessions that might be using Chrome.

212* **Native messaging host errors**: if the native messaging host crashes on startup, try reinstalling Claude Code to regenerate the host configuration.

213

214### Common error messages

215

216These are the most frequently encountered errors and how to resolve them:

217

218| Error | Cause | Fix |

219| ------------------------------------ | ------------------------------------------------ | --------------------------------------------------------------- |

220| "Browser extension is not connected" | Native messaging host cannot reach the extension | Restart Chrome and Claude Code, then run `/chrome` to reconnect |

221| "Extension not detected" | Chrome extension is not installed or is disabled | Install or enable the extension in `chrome://extensions` |

222| "No tab available" | Claude tried to act before a tab was ready | Ask Claude to create a new tab and retry |

223| "Receiving end does not exist" | Extension service worker went idle | Run `/chrome` and select "Reconnect extension" |

224

225## See also

226

227* [Use Claude Code in VS Code](/en/vs-code#automate-browser-tasks-with-chrome): browser automation in the VS Code extension

228* [CLI reference](/en/cli-reference): command-line flags including `--chrome`

229* [Common workflows](/en/common-workflows): more ways to use Claude Code

230* [Data and privacy](/en/data-usage): how Claude Code handles your data

231* [Getting started with Claude in Chrome](https://support.claude.com/en/articles/12012173-getting-started-with-claude-in-chrome): full documentation for the Chrome extension, including shortcuts, scheduling, and permissions

claude-code-on-the-web.md +229 −37

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Claude Code on the web5# Claude Code on the web

2 6

3> Run Claude Code tasks asynchronously on secure cloud infrastructure7> Run Claude Code tasks asynchronously on secure cloud infrastructure

11Claude Code on the web lets developers kick off Claude Code from the Claude app. This is perfect for:15Claude Code on the web lets developers kick off Claude Code from the Claude app. This is perfect for:

12 16

13* **Answering questions**: Ask about code architecture and how features are implemented17* **Answering questions**: Ask about code architecture and how features are implemented

~~14* **Bugfixes and routine tasks**: Well-defined tasks that don't require frequent steering~~18* **Bug fixes and routine tasks**: Well-defined tasks that don't require frequent steering

15* **Parallel work**: Tackle multiple bug fixes in parallel19* **Parallel work**: Tackle multiple bug fixes in parallel

16* **Repositories not on your local machine**: Work on code you don't have checked out locally20* **Repositories not on your local machine**: Work on code you don't have checked out locally

17* **Backend changes**: Where Claude Code can write tests and then write code to pass those tests21* **Backend changes**: Where Claude Code can write tests and then write code to pass those tests

18 22

~~19Claude Code is also available on the Claude iOS app. This is perfect for:~~23Claude Code is also available on the Claude app for [iOS](https://apps.apple.com/us/app/claude-by-anthropic/id6473753684) and [Android](https://play.google.com/store/apps/details?id=com.anthropic.claude) for kicking off tasks on the go and monitoring work in progress.

~~21* **On the go**: Kick off tasks while commuting or away from laptop~~

~~22* **Monitoring**: Watch the trajectory and steer the agent's work~~

23 24

~~24Developers can also move Claude Code sessions from the Claude app to their terminal to continue tasks locally.~~25You can [kick off new tasks on the web from your terminal](#from-terminal-to-web) with `--remote`, or [teleport web sessions back to your terminal](#from-web-to-terminal) to continue locally. To use the web interface while running Claude Code on your own machine instead of cloud infrastructure, see [Remote Control](/en/remote-control).

25 26

26## Who can use Claude Code on the web?27## Who can use Claude Code on the web?

27 28

29 30

30* **Pro users**31* **Pro users**

31* **Max users**32* **Max users**

~~32* **Team premium seat users**~~33* **Team users**

~~33* **Enterprise premium seat users**~~34* **Enterprise users** with premium seats or Chat + Claude Code seats

34 35

35## Getting started36## Getting started

36 37

393. Install the Claude GitHub app in your repositories403. Install the Claude GitHub app in your repositories

404. Select your default environment414. Select your default environment

415. Submit your coding task425. Submit your coding task

~~426. Review changes and create a pull request in GitHub~~436. Review changes in diff view, iterate with comments, then create a pull request

43 44

44## How it works45## How it works

45 46

46When you start a task on Claude Code on the web:47When you start a task on Claude Code on the web:

47 48

481. **Repository cloning**: Your repository is cloned to an Anthropic-managed virtual machine491. **Repository cloning**: Your repository is cloned to an Anthropic-managed virtual machine

~~492. **Environment setup**: Claude prepares a secure cloud environment with your code~~502. **Environment setup**: Claude prepares a secure cloud environment with your code, then runs your [setup script](#setup-scripts) if configured

503. **Network configuration**: Internet access is configured based on your settings513. **Network configuration**: Internet access is configured based on your settings

514. **Task execution**: Claude analyzes code, makes changes, runs tests, and checks its work524. **Task execution**: Claude analyzes code, makes changes, runs tests, and checks its work

525. **Completion**: You're notified when finished and can create a PR with the changes535. **Completion**: You're notified when finished and can create a PR with the changes

536. **Results**: Changes are pushed to a branch, ready for pull request creation546. **Results**: Changes are pushed to a branch, ready for pull request creation

54 55

56## Review changes with diff view

58Diff view lets you see exactly what Claude changed before creating a pull request. Instead of clicking "Create PR" to review changes in GitHub, view the diff directly in the app and iterate with Claude until the changes are ready.

60When Claude makes changes to files, a diff stats indicator appears showing the number of lines added and removed (for example, `+12 -1`). Select this indicator to open the diff viewer, which displays a file list on the left and the changes for each file on the right.

62From the diff view, you can:

64* Review changes file by file

65* Comment on specific changes to request modifications

66* Continue iterating with Claude based on what you see

68This lets you refine changes through multiple rounds of feedback without creating draft PRs or switching to GitHub.

55## Moving tasks between web and terminal70## Moving tasks between web and terminal

56 71

72You can start new tasks on the web from your terminal, or pull web sessions into your terminal to continue locally. Web sessions persist even if you close your laptop, and you can monitor them from anywhere including the Claude mobile app.

74<Note>

75 Session handoff is one-way: you can pull web sessions into your terminal, but you can't push an existing terminal session to the web. The `--remote` flag creates a *new* web session for your current repository.

76</Note>

78### From terminal to web

80Start a web session from the command line with the `--remote` flag:

82```bash theme={null}

83claude --remote "Fix the authentication bug in src/auth/login.ts"

84```

86This creates a new web session on claude.ai. The task runs in the cloud while you continue working locally. Use `/tasks` to check progress, or open the session on claude.ai or the Claude mobile app to interact directly. From there you can steer Claude, provide feedback, or answer questions just like any other conversation.

88#### Tips for remote tasks

90**Plan locally, execute remotely**: For complex tasks, start Claude in plan mode to collaborate on the approach, then send work to the web:

92```bash theme={null}

93claude --permission-mode plan

94```

96In plan mode, Claude can only read files and explore the codebase. Once you're satisfied with the plan, start a remote session for autonomous execution:

98```bash theme={null}

99claude --remote "Execute the migration plan in docs/migration-plan.md"

100```

101

102This pattern gives you control over the strategy while letting Claude execute autonomously in the cloud.

103

104**Run tasks in parallel**: Each `--remote` command creates its own web session that runs independently. You can kick off multiple tasks and they'll all run simultaneously in separate sessions:

105

106```bash theme={null}

107claude --remote "Fix the flaky test in auth.spec.ts"

108claude --remote "Update the API documentation"

109claude --remote "Refactor the logger to use structured output"

110```

111

112Monitor all sessions with `/tasks`. When a session completes, you can create a PR from the web interface or [teleport](#from-web-to-terminal) the session to your terminal to continue working.

113

57### From web to terminal114### From web to terminal

58 115

~~59After starting a task on the web:~~116There are several ways to pull a web session into your terminal:

117

118* **Using `/teleport`**: From within Claude Code, run `/teleport` (or `/tp`) to see an interactive picker of your web sessions. If you have uncommitted changes, you'll be prompted to stash them first.

119* **Using `--teleport`**: From the command line, run `claude --teleport` for an interactive session picker, or `claude --teleport <session-id>` to resume a specific session directly.

120* **From `/tasks`**: Run `/tasks` to see your background sessions, then press `t` to teleport into one

121* **From the web interface**: Click "Open in CLI" to copy a command you can paste into your terminal

122

123When you teleport a session, Claude verifies you're in the correct repository, fetches and checks out the branch from the remote session, and loads the full conversation history into your terminal.

124

125#### Requirements for teleporting

126

127Teleport checks these requirements before resuming a session. If any requirement isn't met, you'll see an error or be prompted to resolve the issue.

128

129| Requirement | Details |

130| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |

131| Clean git state | Your working directory must have no uncommitted changes. Teleport prompts you to stash changes if needed. |

132| Correct repository | You must run `--teleport` from a checkout of the same repository, not a fork. |

133| Branch available | The branch from the web session must have been pushed to the remote. Teleport automatically fetches and checks it out. |

134| Same account | You must be authenticated to the same Claude.ai account used in the web session. |

135

136### Sharing sessions

137

138To share a session, toggle its visibility according to the account

139types below. After that, share the session link as-is. Recipients who open your

140shared session will see the latest state of the session upon load, but the

141recipient's page will not update in real time.

142

143#### Sharing from an Enterprise or Teams account

144

145For Enterprise and Teams accounts, the two visibility options are **Private**

146and **Team**. Team visibility makes the session visible to other members of your

147Claude.ai organization. Repository access verification is enabled by default,

148based on the GitHub account connected to the recipient's account. Your account's

149display name is visible to all recipients with access. [Claude in Slack](/en/slack)

150sessions are automatically shared with Team visibility.

151

152#### Sharing from a Max or Pro account

153

154For Max and Pro accounts, the two visibility options are **Private**

155and **Public**. Public visibility makes the session visible to any user logged

156into claude.ai.

157

158Check your session for sensitive content before sharing. Sessions may contain

159code and credentials from private GitHub repositories. Repository access

160verification is not enabled by default.

161

162Enable repository access verification and/or withhold your name from your shared

163sessions by going to Settings > Claude Code > Sharing settings.

164

165## Schedule recurring tasks

166

167Run Claude on a recurring schedule to automate work like daily PR reviews, dependency audits, and CI failure analysis. See [Schedule tasks on the web](/en/web-scheduled-tasks) for the full guide.

168

169## Managing sessions

170

171### Archiving sessions

172

173You can archive sessions to keep your session list organized. Archived sessions are hidden from the default session list but can be viewed by filtering for archived sessions.

174

175To archive a session, hover over the session in the sidebar and click the archive icon.

60 176

~~611. Click the "Open in CLI" button~~177### Deleting sessions

~~622. Paste and run the command in your terminal in a checkout of the repo~~178

~~633. Any existing local changes will be stashed, and the remote session will be loaded~~179Deleting a session permanently removes the session and its data. This action cannot be undone. You can delete a session in two ways:

~~644. Continue working locally~~180

181* **From the sidebar**: Filter for archived sessions, then hover over the session you want to delete and click the delete icon

182* **From the session menu**: Open a session, click the dropdown next to the session title, and select **Delete**

183

184You will be asked to confirm before a session is deleted.

65 185

66## Cloud environment186## Cloud environment

67 187

111 231

112When you start a session in Claude Code on the web, here's what happens under the hood:232When you start a session in Claude Code on the web, here's what happens under the hood:

113 233

1141. **Environment preparation**: We clone your repository and run any configured Claude hooks for initialization. The repo will be cloned with the default branch on your GitHub repo. If you would like to check out a specific branch, you can specify that in the prompt.2341. **Environment preparation**: We clone your repository and run any configured [setup script](#setup-scripts). The repo will be cloned with the default branch on your GitHub repo. If you would like to check out a specific branch, you can specify that in the prompt.

115 235

1162. **Network configuration**: We configure internet access for the agent. Internet access is limited by default, but you can configure the environment to have no internet or full internet access based on your needs.2362. **Network configuration**: We configure internet access for the agent. Internet access is limited by default, but you can configure the environment to have no internet or full internet access based on your needs.

117 237

123 Claude operates entirely through the terminal and CLI tools available in the environment. It uses the pre-installed tools in the universal image and any additional tools you install through hooks or dependency management.243 Claude operates entirely through the terminal and CLI tools available in the environment. It uses the pre-installed tools in the universal image and any additional tools you install through hooks or dependency management.

124</Note>244</Note>

125 245

126**To add a new environment:** Select the current environment to open the environment selector, and then select "Add environment". This will open a dialog where you can specify the environment name, network access level, and any environment variables you want to set.246**To add a new environment:** Select the current environment to open the environment selector, and then select "Add environment". This will open a dialog where you can specify the environment name, network access level, environment variables, and a [setup script](#setup-scripts).

247

248**To update an existing environment:** Select the current environment, to the right of the environment name, and select the settings button. This will open a dialog where you can update the environment name, network access, environment variables, and setup script.

127 249

128**To update an existing environment:** Select the current environment, to the right of the environment name, and select the settings button. This will open a dialog where you can update the environment name, network access, and environment variables.250**To select your default environment from the terminal:** If you have multiple environments configured, run `/remote-env` to choose which one to use when starting web sessions from your terminal with `--remote`. With a single environment, this command shows your current configuration.

129 251

130<Note>252<Note>

131 Environment variables must be specified as key-value pairs, in [`.env` format](https://www.dotenv.org/). For example:253 Environment variables must be specified as key-value pairs, in [`.env` format](https://www.dotenv.org/). For example:

132 254

133 ```255 ```text theme={null}

134 API_KEY=your_api_key256 API_KEY=your_api_key

135 DEBUG=true257 DEBUG=true

136 ```258 ```

137</Note>259</Note>

138 260

261### Setup scripts

262

263A setup script is a Bash script that runs when a new cloud session starts, before Claude Code launches. Use setup scripts to install dependencies, configure tools, or prepare anything the cloud environment needs that isn't in the [default image](#default-image).

264

265Scripts run as root on Ubuntu 24.04, so `apt install` and most language package managers work.

266

267<Tip>

268 To check what's already installed before adding it to your script, ask Claude to run `check-tools` in a cloud session.

269</Tip>

270

271To add a setup script, open the environment settings dialog and enter your script in the **Setup script** field.

272

273This example installs the `gh` CLI, which isn't in the default image:

274

275```bash theme={null}

276#!/bin/bash

277apt update && apt install -y gh

278```

279

280Setup scripts run only when creating a new session. They are skipped when resuming an existing session.

281

282If the script exits non-zero, the session fails to start. Append `|| true` to non-critical commands to avoid blocking the session on a flaky install.

283

284<Note>

285 Setup scripts that install packages need network access to reach registries. The default network access allows connections to [common package registries](#default-allowed-domains) including npm, PyPI, RubyGems, and crates.io. Scripts will fail to install packages if your environment has network access disabled.

286</Note>

287

288#### Setup scripts vs. SessionStart hooks

289

290Use a setup script to install things the cloud needs but your laptop already has, like a language runtime or CLI tool. Use a [SessionStart hook](/en/hooks#sessionstart) for project setup that should run everywhere, cloud and local, like `npm install`.

291

292Both run at the start of a session, but they belong to different places:

293

294| | Setup scripts | SessionStart hooks |

295| ------------- | ------------------------------------------------- | -------------------------------------------------------------- |

296| Attached to | The cloud environment | Your repository |

297| Configured in | Cloud environment UI | `.claude/settings.json` in your repo |

298| Runs | Before Claude Code launches, on new sessions only | After Claude Code launches, on every session including resumed |

299| Scope | Cloud environments only | Both local and cloud |

300

301SessionStart hooks can also be defined in your user-level `~/.claude/settings.json` locally, but user-level settings don't carry over to cloud sessions. In the cloud, only hooks committed to the repo run.

302

139### Dependency management303### Dependency management

140 304

141Configure automatic dependency installation using [SessionStart hooks](/en/hooks#sessionstart). This can be configured in your repository's `.claude/settings.json` file:305Custom environment images and snapshots are not yet supported. Use [setup scripts](#setup-scripts) to install packages when a session starts, or [SessionStart hooks](/en/hooks#sessionstart) for dependency installation that should also run in local environments. SessionStart hooks have [known limitations](#dependency-management-limitations).

306

307To configure automatic dependency installation with a setup script, open your environment settings and add a script:

308

309```bash theme={null}

310#!/bin/bash

311npm install

312pip install -r requirements.txt

313```

314

315Alternatively, you can use SessionStart hooks in your repository's `.claude/settings.json` file for dependency installation that should also run in local environments:

142 316

143```json theme={null}317```json theme={null}

144{318{

162 336

163```bash theme={null}337```bash theme={null}

164#!/bin/bash338#!/bin/bash

165npm install

166pip install -r requirements.txt

167exit 0

168```

~~169~~

170Make it executable: `chmod +x scripts/install_pkgs.sh`

171 339

172#### Local vs remote execution340# Only run in remote environments

~~173~~

174By default, all hooks execute both locally and in remote (web) environments. To run a hook only in one environment, check the `CLAUDE_CODE_REMOTE` environment variable in your hook script.

~~175~~

176```bash theme={null}

177#!/bin/bash

~~178~~

179# Example: Only run in remote environments

180if [ "$CLAUDE_CODE_REMOTE" != "true" ]; then341if [ "$CLAUDE_CODE_REMOTE" != "true" ]; then

181 exit 0342 exit 0

182fi343fi

183 344

184npm install345npm install

185pip install -r requirements.txt346pip install -r requirements.txt

347exit 0

186```348```

187 349

188#### Persisting environment variables350Make it executable: `chmod +x scripts/install_pkgs.sh`

351

352#### Persist environment variables

353

354SessionStart hooks can persist environment variables for subsequent Bash commands by writing to the file specified in the `CLAUDE_ENV_FILE` environment variable. For details, see [SessionStart hooks](/en/hooks#sessionstart) in the hooks reference.

189 355

190SessionStart hooks can persist environment variables for subsequent bash commands by writing to the file specified in the `CLAUDE_ENV_FILE` environment variable. For details, see [SessionStart hooks](/en/hooks#sessionstart) in the hooks reference.356#### Dependency management limitations

357

358* **Hooks fire for all sessions**: SessionStart hooks run in both local and remote environments. There is no hook configuration to scope a hook to remote sessions only. To skip local execution, check the `CLAUDE_CODE_REMOTE` environment variable in your script as shown above.

359* **Requires network access**: Install commands need network access to reach package registries. If your environment is configured with "No internet" access, these hooks will fail. Use "Limited" (the default) or "Full" network access. The [default allowlist](#default-allowed-domains) includes common registries like npm, PyPI, RubyGems, and crates.io.

360* **Proxy compatibility**: All outbound traffic in remote environments passes through a [security proxy](#security-proxy). Some package managers do not work correctly with this proxy. Bun is a known example.

361* **Runs on every session start**: Hooks run each time a session starts or resumes, adding startup latency. Keep install scripts fast by checking whether dependencies are already present before reinstalling.

191 362

192## Network access and security363## Network access and security

193 364

223 394

224* api.anthropic.com395* api.anthropic.com

225* statsig.anthropic.com396* statsig.anthropic.com

397* platform.claude.com

398* code.claude.com

226* claude.ai399* claude.ai

227 400

228#### Version Control401#### Version Control

230* github.com403* github.com

231* [www.github.com](http://www.github.com)404* [www.github.com](http://www.github.com)

232* api.github.com405* api.github.com

406* npm.pkg.github.com

233* raw\.githubusercontent.com407* raw\.githubusercontent.com

408* pkg-npm.githubusercontent.com

234* objects.githubusercontent.com409* objects.githubusercontent.com

235* codeload.github.com410* codeload.github.com

236* avatars.githubusercontent.com411* avatars.githubusercontent.com

252* [www.docker.com](http://www.docker.com)427* [www.docker.com](http://www.docker.com)

253* production.cloudflare.docker.com428* production.cloudflare.docker.com

254* download.docker.com429* download.docker.com

430* gcr.io

255* \*.gcr.io431* \*.gcr.io

256* ghcr.io432* ghcr.io

257* mcr.microsoft.com433* mcr.microsoft.com

258* \*.data.mcr.microsoft.com434* \*.data.mcr.microsoft.com

435* public.ecr.aws

259 436

260#### Cloud Platforms437#### Cloud Platforms

261 438

276* dot.net453* dot.net

277* visualstudio.com454* visualstudio.com

278* dev.azure.com455* dev.azure.com

456* \*.amazonaws.com

457* \*.api.aws

279* oracle.com458* oracle.com

280* [www.oracle.com](http://www.oracle.com)459* [www.oracle.com](http://www.oracle.com)

281* java.com460* java.com

325 504

326* crates.io505* crates.io

327* [www.crates.io](http://www.crates.io)506* [www.crates.io](http://www.crates.io)

507* index.crates.io

328* static.crates.io508* static.crates.io

329* rustup.rs509* rustup.rs

330* static.rust-lang.org510* static.rust-lang.org

350* gradle.org530* gradle.org

351* [www.gradle.org](http://www.gradle.org)531* [www.gradle.org](http://www.gradle.org)

352* services.gradle.org532* services.gradle.org

533* plugins.gradle.org

534* kotlin.org

535* [www.kotlin.org](http://www.kotlin.org)

353* spring.io536* spring.io

354* repo.spring.io537* repo.spring.io

355 538

423* statsig.com606* statsig.com

424* [www.statsig.com](http://www.statsig.com)607* [www.statsig.com](http://www.statsig.com)

425* api.statsig.com608* api.statsig.com

609* sentry.io

426* \*.sentry.io610* \*.sentry.io

611* http-intake.logs.datadoghq.com

612* \*.datadoghq.com

613* \*.datadoghq.eu

427 614

428#### Content Delivery & Mirrors615#### Content Delivery & Mirrors

429 616

617* sourceforge.net

430* \*.sourceforge.net618* \*.sourceforge.net

431* packagecloud.io619* packagecloud.io

432* \*.packagecloud.io620* \*.packagecloud.io

438* json.schemastore.org626* json.schemastore.org

439* [www.schemastore.org](http://www.schemastore.org)627* [www.schemastore.org](http://www.schemastore.org)

440 628

629#### Model Context Protocol

630

631* \*.modelcontextprotocol.io

632

441<Note>633<Note>

442 Domains marked with `*` indicate wildcard subdomain matching. For example, `*.gcr.io` allows access to any subdomain of `gcr.io`.634 Domains marked with `*` indicate wildcard subdomain matching. For example, `*.gcr.io` allows access to any subdomain of `gcr.io`.

443</Note>635</Note>

473 665

474## Best practices666## Best practices

475 667

4761. **Use Claude Code hooks**: Configure [sessionStart hooks](/en/hooks#sessionstart) to automate environment setup and dependency installation.6681. **Automate environment setup**: Use [setup scripts](#setup-scripts) to install dependencies and configure tools before Claude Code launches. For more advanced scenarios, configure [SessionStart hooks](/en/hooks#sessionstart).

4772. **Document requirements**: Clearly specify dependencies and commands in your `CLAUDE.md` file. If you have an `AGENTS.md` file, you can source it in your `CLAUDE.md` using `@AGENTS.md` to maintain a single source of truth.6692. **Document requirements**: Clearly specify dependencies and commands in your `CLAUDE.md` file. If you have an `AGENTS.md` file, you can source it in your `CLAUDE.md` using `@AGENTS.md` to maintain a single source of truth.

478 670

479## Related resources671## Related resources

cli-reference.md +82 −93

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# CLI reference5# CLI reference

2 6

3> Complete reference for Claude Code command-line interface, including commands and flags.7> Complete reference for Claude Code command-line interface, including commands and flags.

4 8

5## CLI commands9## CLI commands

6 10

11You can start sessions, pipe content, resume conversations, and manage updates with these commands:

~~8| :--------------------------------- | :--------------------------------------------- | :------------------------------------------------ |~~14| :------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------ |

23| `claude auth login` | Sign in to your Anthropic account. Use `--email` to pre-fill your email address, `--sso` to force SSO authentication, and `--console` to sign in with Anthropic Console for API usage billing instead of a Claude subscription | `claude auth login --console` |

24| `claude auth logout` | Log out from your Anthropic account | `claude auth logout` |

25| `claude auth status` | Show authentication status as JSON. Use `--text` for human-readable output. Exits with code 0 if logged in, 1 if not | `claude auth status` |

26| `claude agents` | List all configured [subagents](/en/sub-agents), grouped by source | `claude agents` |

27| `claude auto-mode defaults` | Print the built-in [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) classifier rules as JSON. Use `claude auto-mode config` to see your effective config with settings applied | `claude auto-mode defaults > rules.json` |

29| `claude remote-control` | Start a [Remote Control](/en/remote-control) server to control Claude Code from Claude.ai or the Claude app. Runs in server mode (no local interactive session). See [Server mode flags](/en/remote-control#server-mode) | `claude remote-control --name "My Project"` |

18 30

19## CLI flags31## CLI flags

20 32

21Customize Claude Code's behavior with these command-line flags:33Customize Claude Code's behavior with these command-line flags:

22 34

24| :------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------- |36| :---------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |

26| `--agents` | Define custom [subagents](/en/sub-agents) dynamically via JSON (see below for format) | `claude --agents '{"reviewer":{"description":"Reviews code","prompt":"You are a code reviewer"}}'` |38| `--agent` | Specify an agent for the current session (overrides the `agent` setting) | `claude --agent my-custom-agent` |

27| `--allowedTools` | A list of tools that should be allowed without prompting the user for permission, in addition to [settings.json files](/en/settings) | `"Bash(git log:*)" "Bash(git diff:*)" "Read"` |39| `--agents` | Define custom subagents dynamically via JSON. Uses the same field names as subagent [frontmatter](/en/sub-agents#supported-frontmatter-fields), plus a `prompt` field for the agent's instructions | `claude --agents '{"reviewer":{"description":"Reviews code","prompt":"You are a code reviewer"}}'` |

28| `--disallowedTools` | A list of tools that should be disallowed without prompting the user for permission, in addition to [settings.json files](/en/settings) | `"Bash(git log:*)" "Bash(git diff:*)" "Edit"` |40| `--allow-dangerously-skip-permissions` | Enable permission bypassing as an option without immediately activating it. Allows composing with `--permission-mode` (use with caution) | `claude --permission-mode plan --allow-dangerously-skip-permissions` |

29| `--print`, `-p` | Print response without interactive mode (see [SDK documentation](https://docs.claude.com/en/docs/agent-sdk) for programmatic usage details) | `claude -p "query"` |41| `--allowedTools` | Tools that execute without prompting for permission. See [permission rule syntax](/en/settings#permission-rule-syntax) for pattern matching. To restrict which tools are available, use `--tools` instead | `"Bash(git log *)" "Bash(git diff *)" "Read"` |

31| `--system-prompt-file` | Load system prompt from a file, replacing the default prompt (print mode only; added in v1.0.54) | `claude -p --system-prompt-file ./custom-prompt.txt "query"` |43| `--append-system-prompt-file` | Load additional system prompt text from a file and append to the default prompt | `claude --append-system-prompt-file ./extra-rules.txt` |

32| `--append-system-prompt` | Append custom text to the end of the default system prompt (works in both interactive and print modes; added in v1.0.55) | `claude --append-system-prompt "Always use TypeScript"` |44| `--bare` | Minimal mode: skip auto-discovery of hooks, skills, plugins, MCP servers, auto memory, and CLAUDE.md so scripted calls start faster. Claude has access to Bash, file read, and file edit tools. Sets [`CLAUDE_CODE_SIMPLE`](/en/env-vars). See [bare mode](/en/headless#start-faster-with-bare-mode) | `claude --bare -p "query"` |

34| `--input-format` | Specify input format for print mode (options: `text`, `stream-json`) | `claude -p --output-format json --input-format stream-json` |46| `--channels` | (Research preview) MCP servers whose [channel](/en/channels) notifications Claude should listen for in this session. Space-separated list of `plugin:<name>@<marketplace>` entries. Requires Claude.ai authentication | `claude --channels plugin:my-notifier@my-marketplace` |

35| `--json-schema` | Get validated JSON output matching a JSON Schema after agent completes its workflow (print mode only, see [Agent SDK Structured Outputs](https://docs.claude.com/en/docs/agent-sdk/structured-outputs)) | `claude -p --json-schema '{"type":"object","properties":{...}}' "query"` |47| `--chrome` | Enable [Chrome browser integration](/en/chrome) for web automation and testing | `claude --chrome` |

48| `--continue`, `-c` | Load the most recent conversation in the current directory | `claude --continue` |

49| `--dangerously-load-development-channels` | Enable [channels](/en/channels-reference#test-during-the-research-preview) that are not on the approved allowlist, for local development. Accepts `plugin:<name>@<marketplace>` and `server:<name>` entries. Prompts for confirmation | `claude --dangerously-load-development-channels server:webhook` |

50| `--dangerously-skip-permissions` | Skip permission prompts (use with caution). See [permission modes](/en/permission-modes#skip-all-checks-with-bypasspermissions-mode) for what this does and does not skip | `claude --dangerously-skip-permissions` |

51| `--debug` | Enable debug mode with optional category filtering (for example, `"api,hooks"` or `"!statsig,!file"`) | `claude --debug "api,mcp"` |

52| `--disable-slash-commands` | Disable all skills and commands for this session | `claude --disable-slash-commands` |

53| `--disallowedTools` | Tools that are removed from the model's context and cannot be used | `"Bash(git log *)" "Bash(git diff *)" "Edit"` |

54| `--effort` | Set the [effort level](/en/model-config#adjust-effort-level) for the current session. Options: `low`, `medium`, `high`, `max` (Opus 4.6 only). Session-scoped and does not persist to settings | `claude --effort high` |

55| `--fallback-model` | Enable automatic fallback to specified model when default model is overloaded (print mode only) | `claude -p --fallback-model sonnet "query"` |

56| `--fork-session` | When resuming, create a new session ID instead of reusing the original (use with `--resume` or `--continue`) | `claude --resume abc123 --fork-session` |

57| `--from-pr` | Resume sessions linked to a specific GitHub PR. Accepts a PR number or URL. Sessions are automatically linked when created via `gh pr create` | `claude --from-pr 123` |

58| `--ide` | Automatically connect to IDE on startup if exactly one valid IDE is available | `claude --ide` |

59| `--init` | Run initialization hooks and start interactive mode | `claude --init` |

60| `--init-only` | Run initialization hooks and exit (no interactive session) | `claude --init-only` |

36| `--include-partial-messages` | Include partial streaming events in output (requires `--print` and `--output-format=stream-json`) | `claude -p --output-format stream-json --include-partial-messages "query"` |61| `--include-partial-messages` | Include partial streaming events in output (requires `--print` and `--output-format=stream-json`) | `claude -p --output-format stream-json --include-partial-messages "query"` |

38| `--max-turns` | Limit the number of agentic turns in non-interactive mode | `claude -p --max-turns 3 "query"` |63| `--json-schema` | Get validated JSON output matching a JSON Schema after agent completes its workflow (print mode only, see [structured outputs](https://platform.claude.com/docs/en/agent-sdk/structured-outputs)) | `claude -p --json-schema '{"type":"object","properties":{...}}' "query"` |

66| `--max-turns` | Limit the number of agentic turns (print mode only). Exits with an error when the limit is reached. No limit by default | `claude -p --max-turns 3 "query"` |

67| `--mcp-config` | Load MCP servers from JSON files or strings (space-separated) | `claude --mcp-config ./mcp.json` |

68| `--model` | Sets the model for the current session with an alias for the latest model (`sonnet` or `opus`) or a model's full name | `claude --model claude-sonnet-4-6` |

69| `--name`, `-n` | Set a display name for the session, shown in `/resume` and the terminal title. You can resume a named session with `claude --resume <name>`. <br /><br />[`/rename`](/en/commands) changes the name mid-session and also shows it on the prompt bar | `claude -n "my-feature-work"` |

70| `--no-chrome` | Disable [Chrome browser integration](/en/chrome) for this session | `claude --no-chrome` |

71| `--no-session-persistence` | Disable session persistence so sessions are not saved to disk and cannot be resumed (print mode only) | `claude -p --no-session-persistence "query"` |

72| `--output-format` | Specify output format for print mode (options: `text`, `json`, `stream-json`) | `claude -p "query" --output-format json` |

73| `--enable-auto-mode` | Unlock [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) in the `Shift+Tab` cycle. Requires a Team plan (Enterprise and API support rolling out shortly) and Claude Sonnet 4.6 or Opus 4.6 | `claude --enable-auto-mode` |

74| `--permission-mode` | Begin in a specified [permission mode](/en/permission-modes) | `claude --permission-mode plan` |

45 79| `--remote-control`, `--rc` | Start an interactive session with [Remote Control](/en/remote-control#interactive-session) enabled so you can also control it from claude.ai or the Claude app. Optionally pass a name for the session | `claude --remote-control "My Project"` |

~~46<Tip>~~80| `--resume`, `-r` | Resume a specific session by ID or name, or show an interactive picker to choose a session | `claude --resume auth-refactor` |

~~47 The `--output-format json` flag is particularly useful for scripting and~~81| `--session-id` | Use a specific session ID for the conversation (must be a valid UUID) | `claude --session-id "550e8400-e29b-41d4-a716-446655440000"` |

~~48 automation, allowing you to parse Claude's responses programmatically.~~82| `--setting-sources` | Comma-separated list of setting sources to load (`user`, `project`, `local`) | `claude --setting-sources user,project` |

~~49</Tip>~~83| `--settings` | Path to a settings JSON file or a JSON string to load additional settings from | `claude --settings ./settings.json` |

50 84| `--strict-mcp-config` | Only use MCP servers from `--mcp-config`, ignoring all other MCP configurations | `claude --strict-mcp-config --mcp-config ./mcp.json` |

~~51### Agents flag format~~85| `--system-prompt` | Replace the entire system prompt with custom text | `claude --system-prompt "You are a Python expert"` |

52 86| `--system-prompt-file` | Load system prompt from a file, replacing the default prompt | `claude --system-prompt-file ./custom-prompt.txt` |

~~53The `--agents` flag accepts a JSON object that defines one or more custom subagents. Each subagent requires a unique name (as the key) and a definition object with the following fields:~~87| `--teleport` | Resume a [web session](/en/claude-code-on-the-web) in your local terminal | `claude --teleport` |

54 88| `--teammate-mode` | Set how [agent team](/en/agent-teams) teammates display: `auto` (default), `in-process`, or `tmux`. See [set up agent teams](/en/agent-teams#set-up-agent-teams) | `claude --teammate-mode in-process` |

~~56| :------------ | :------- | :-------------------------------------------------------------------------------------------------------------- |~~90| `--verbose` | Enable verbose logging, shows full turn-by-turn output | `claude --verbose` |

~~59| `tools` | No | Array of specific tools the subagent can use (e.g., `["Read", "Edit", "Bash"]`). If omitted, inherits all tools |~~

~~60| `model` | No | Model alias to use: `sonnet`, `opus`, or `haiku`. If omitted, uses the default subagent model |~~

~~62Example:~~

~~64```bash theme={null}~~

~~65claude --agents '{~~

~~66 "code-reviewer": {~~

~~67 "description": "Expert code reviewer. Use proactively after code changes.",~~

~~68 "prompt": "You are a senior code reviewer. Focus on code quality, security, and best practices.",~~

~~69 "tools": ["Read", "Grep", "Glob", "Bash"],~~

~~70 "model": "sonnet"~~

~~71 },~~

~~72 "debugger": {~~

~~73 "description": "Debugging specialist for errors and test failures.",~~

~~74 "prompt": "You are an expert debugger. Analyze errors, identify root causes, and provide fixes."~~

~~75 }~~

~~76}'~~

~~77```~~

~~79For more details on creating and using subagents, see the [subagents documentation](/en/sub-agents).~~

80 93

81### System prompt flags94### System prompt flags

82 95

~~83Claude Code provides three flags for customizing the system prompt, each serving a different purpose:~~96Claude Code provides four flags for customizing the system prompt. All four work in both interactive and non-interactive modes.

~~86| :----------------------- | :--------------------------------- | :------------------ | :------------------------------------------------------------------- |~~

~~91**When to use each:**~~

~~93* **`--system-prompt`**: Use when you need complete control over Claude's system prompt. This removes all default Claude Code instructions, giving you a blank slate.~~

~~94 ```bash theme={null}~~

~~95 claude --system-prompt "You are a Python expert who only writes type-annotated code"~~

~~96 ```~~

~~98* **`--system-prompt-file`**: Use when you want to load a custom prompt from a file, useful for team consistency or version-controlled prompt templates.~~

~~99 ```bash theme={null}~~

100 claude -p --system-prompt-file ./prompts/code-review.txt "Review this PR"

101 ```

~~102~~

103* **`--append-system-prompt`**: Use when you want to add specific instructions while keeping Claude Code's default capabilities intact. This is the safest option for most use cases.

104 ```bash theme={null}

105 claude --append-system-prompt "Always use TypeScript and include JSDoc comments"

106 ```

107 97

108<Note>98| Flag | Behavior | Example |

109 `--system-prompt` and `--system-prompt-file` are mutually exclusive. You cannot use both flags simultaneously.99| :---------------------------- | :------------------------------------------ | :------------------------------------------------------ |

110</Note>100| `--system-prompt` | Replaces the entire default prompt | `claude --system-prompt "You are a Python expert"` |

101| `--system-prompt-file` | Replaces with file contents | `claude --system-prompt-file ./prompts/review.txt` |

102| `--append-system-prompt` | Appends to the default prompt | `claude --append-system-prompt "Always use TypeScript"` |

103| `--append-system-prompt-file` | Appends file contents to the default prompt | `claude --append-system-prompt-file ./style-rules.txt` |

111 104

112<Tip>105`--system-prompt` and `--system-prompt-file` are mutually exclusive. The append flags can be combined with either replacement flag.

113 For most use cases, `--append-system-prompt` is recommended as it preserves Claude Code's built-in capabilities while adding your custom requirements. Use `--system-prompt` or `--system-prompt-file` only when you need complete control over the system prompt.

114</Tip>

115 106

116For detailed information about print mode (`-p`) including output formats,107For most use cases, use an append flag. Appending preserves Claude Code's built-in capabilities while adding your requirements. Use a replacement flag only when you need complete control over the system prompt.

117streaming, verbose logging, and programmatic usage, see the

118[SDK documentation](https://docs.claude.com/en/docs/agent-sdk).

119 108

120## See also109## See also

121 110

111* [Chrome extension](/en/chrome) - Browser automation and web testing

122* [Interactive mode](/en/interactive-mode) - Shortcuts, input modes, and interactive features112* [Interactive mode](/en/interactive-mode) - Shortcuts, input modes, and interactive features

123* [Slash commands](/en/slash-commands) - Interactive session commands

124* [Quickstart guide](/en/quickstart) - Getting started with Claude Code113* [Quickstart guide](/en/quickstart) - Getting started with Claude Code

125* [Common workflows](/en/common-workflows) - Advanced workflows and patterns114* [Common workflows](/en/common-workflows) - Advanced workflows and patterns

126* [Settings](/en/settings) - Configuration options115* [Settings](/en/settings) - Configuration options

127* [SDK documentation](https://docs.claude.com/en/docs/agent-sdk) - Programmatic usage and integrations116* [Agent SDK documentation](https://platform.claude.com/docs/en/agent-sdk/overview) - Programmatic usage and integrations

code-review.md +187 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Code Review

7> Set up automated PR reviews that catch logic errors, security vulnerabilities, and regressions using multi-agent analysis of your full codebase

9<Note>

10 Code Review is in research preview, available for [Teams and Enterprise](https://claude.ai/admin-settings/claude-code) subscriptions. It is not available for organizations with [Zero Data Retention](/en/zero-data-retention) enabled.

11</Note>

13Code Review analyzes your GitHub pull requests and posts findings as inline comments on the lines of code where it found issues. A fleet of specialized agents examine the code changes in the context of your full codebase, looking for logic errors, security vulnerabilities, broken edge cases, and subtle regressions.

15Findings are tagged by severity and don't approve or block your PR, so existing review workflows stay intact. You can tune what Claude flags by adding a `CLAUDE.md` or `REVIEW.md` file to your repository.

17To run Claude in your own CI infrastructure instead of this managed service, see [GitHub Actions](/en/github-actions) or [GitLab CI/CD](/en/gitlab-ci-cd).

19This page covers:

21* [How reviews work](#how-reviews-work)

22* [Setup](#set-up-code-review)

23* [Customizing reviews](#customize-reviews) with `CLAUDE.md` and `REVIEW.md`

24* [Pricing](#pricing)

26## How reviews work

28Once an admin [enables Code Review](#set-up-code-review) for your organization, reviews trigger when a PR opens, on every push, or when manually requested, depending on the repository's configured behavior. Commenting `@claude review` [starts reviews on a PR](#manually-trigger-reviews) in any mode.

30When a review runs, multiple agents analyze the diff and surrounding code in parallel on Anthropic infrastructure. Each agent looks for a different class of issue, then a verification step checks candidates against actual code behavior to filter out false positives. The results are deduplicated, ranked by severity, and posted as inline comments on the specific lines where issues were found. If no issues are found, Claude posts a short confirmation comment on the PR.

32Reviews scale in cost with PR size and complexity, completing in 20 minutes on average. Admins can monitor review activity and spend via the [analytics dashboard](#view-usage).

34### Severity levels

36Each finding is tagged with a severity level:

38| Marker | Severity | Meaning |

39| :----- | :----------- | :------------------------------------------------------------------ |

40| 🔴 | Normal | A bug that should be fixed before merging |

41| 🟡 | Nit | A minor issue, worth fixing but not blocking |

42| 🟣 | Pre-existing | A bug that exists in the codebase but was not introduced by this PR |

44Findings include a collapsible extended reasoning section you can expand to understand why Claude flagged the issue and how it verified the problem.

46### What Code Review checks

48By default, Code Review focuses on correctness: bugs that would break production, not formatting preferences or missing test coverage. You can expand what it checks by [adding guidance files](#customize-reviews) to your repository.

50## Set up Code Review

52An admin enables Code Review once for the organization and selects which repositories to include.

54<Steps>

55 <Step title="Open Claude Code admin settings">

56 Go to [claude.ai/admin-settings/claude-code](https://claude.ai/admin-settings/claude-code) and find the Code Review section. You need admin access to your Claude organization and permission to install GitHub Apps in your GitHub organization.

57 </Step>

59 <Step title="Start setup">

60 Click **Setup**. This begins the GitHub App installation flow.

61 </Step>

63 <Step title="Install the Claude GitHub App">

64 Follow the prompts to install the Claude GitHub App to your GitHub organization. The app requests these repository permissions:

66 * **Contents**: read and write

67 * **Issues**: read and write

68 * **Pull requests**: read and write

70 Code Review uses read access to contents and write access to pull requests. The broader permission set also supports [GitHub Actions](/en/github-actions) if you enable that later.

71 </Step>

73 <Step title="Select repositories">

74 Choose which repositories to enable for Code Review. If you don't see a repository, make sure you gave the Claude GitHub App access to it during installation. You can add more repositories later.

75 </Step>

77 <Step title="Set review triggers per repo">

78 After setup completes, the Code Review section shows your repositories in a table. For each repository, use the **Review Behavior** dropdown to choose when reviews run:

80 * **Once after PR creation**: review runs once when a PR is opened or marked ready for review

81 * **After every push**: review runs on every push to the PR branch, catching new issues as the PR evolves and auto-resolving threads when you fix flagged issues

82 * **Manual**: reviews start only when someone [comments `@claude review` on a PR](#manually-trigger-reviews); subsequent pushes to that PR are then reviewed automatically

84 Reviewing on every push runs the most reviews and costs the most. Manual mode is useful for high-traffic repos where you want to opt specific PRs into review, or to only start reviewing your PRs once they're ready.

85 </Step>

86</Steps>

88The repositories table also shows the average cost per review for each repo based on recent activity. Use the row actions menu to turn Code Review on or off per repository, or to remove a repository entirely.

90To verify setup, open a test PR. If you chose an automatic trigger, a check run named **Claude Code Review** appears within a few minutes. If you chose Manual, comment `@claude review` on the PR to start the first review. If no check run appears, confirm the repository is listed in your admin settings and the Claude GitHub App has access to it.

92## Manually trigger reviews

94Comment `@claude review` on a pull request to start a review and opt that PR into push-triggered reviews going forward. This works regardless of the repository's configured trigger: use it to opt specific PRs into review in Manual mode, or to get an immediate re-review in other modes. Either way, pushes to that PR trigger reviews from then on.

96For the comment to trigger a review:

98* Post it as a top-level PR comment, not an inline comment on a diff line

99* Put `@claude review` at the start of the comment

100* You must have owner, member, or collaborator access to the repository

101* The PR must be open and not a draft

102

103If a review is already running on that PR, the request is queued until the in-progress review completes. You can monitor progress via the check run on the PR.

104

105## Customize reviews

106

107Code Review reads two files from your repository to guide what it flags. Both are additive on top of the default correctness checks:

108

109* **`CLAUDE.md`**: shared project instructions that Claude Code uses for all tasks, not just reviews. Use it when guidance also applies to interactive Claude Code sessions.

110* **`REVIEW.md`**: review-only guidance, read exclusively during code reviews. Use it for rules that are strictly about what to flag or skip during review and would clutter your general `CLAUDE.md`.

111

112### CLAUDE.md

113

114Code Review reads your repository's `CLAUDE.md` files and treats newly-introduced violations as nit-level findings. This works bidirectionally: if your PR changes code in a way that makes a `CLAUDE.md` statement outdated, Claude flags that the docs need updating too.

115

116Claude reads `CLAUDE.md` files at every level of your directory hierarchy, so rules in a subdirectory's `CLAUDE.md` apply only to files under that path. See the [memory documentation](/en/memory) for more on how `CLAUDE.md` works.

117

118For review-specific guidance that you don't want applied to general Claude Code sessions, use [`REVIEW.md`](#review-md) instead.

119

120### REVIEW\.md

121

122Add a `REVIEW.md` file to your repository root for review-specific rules. Use it to encode:

123

124* Company or team style guidelines: "prefer early returns over nested conditionals"

125* Language- or framework-specific conventions not covered by linters

126* Things Claude should always flag: "any new API route must have an integration test"

127* Things Claude should skip: "don't comment on formatting in generated code under `/gen/`"

128

129Example `REVIEW.md`:

130

131```markdown theme={null}

132# Code Review Guidelines

133

134## Always check

135- New API endpoints have corresponding integration tests

136- Database migrations are backward-compatible

137- Error messages don't leak internal details to users

138

139## Style

140- Prefer `match` statements over chained `isinstance` checks

141- Use structured logging, not f-string interpolation in log calls

142

143## Skip

144- Generated files under `src/gen/`

145- Formatting-only changes in `*.lock` files

146```

147

148Claude auto-discovers `REVIEW.md` at the repository root. No configuration needed.

149

150## View usage

151

152Go to [claude.ai/analytics/code-review](https://claude.ai/analytics/code-review) to see Code Review activity across your organization. The dashboard shows:

153

154| Section | What it shows |

155| :------------------- | :--------------------------------------------------------------------------------------- |

156| PRs reviewed | Daily count of pull requests reviewed over the selected time range |

157| Cost weekly | Weekly spend on Code Review |

158| Feedback | Count of review comments that were auto-resolved because a developer addressed the issue |

159| Repository breakdown | Per-repo counts of PRs reviewed and comments resolved |

160

161The repositories table in admin settings also shows average cost per review for each repo.

162

163## Pricing

164

165Code Review is billed based on token usage. Each review averages \$15-25 in cost, scaling with PR size, codebase complexity, and how many issues require verification. Code Review usage is billed separately through [extra usage](https://support.claude.com/en/articles/12429409-extra-usage-for-paid-claude-plans) and does not count against your plan's included usage.

166

167The review trigger you choose affects total cost:

168

169* **Once after PR creation**: runs once per PR

170* **After every push**: runs on each push, multiplying cost by the number of pushes

171* **Manual**: no reviews until someone comments `@claude review` on a PR

172

173In any mode, commenting `@claude review` [opts the PR into push-triggered reviews](#manually-trigger-reviews), so additional cost accrues per push after that comment.

174

175Costs appear on your Anthropic bill regardless of whether your organization uses AWS Bedrock or Google Vertex AI for other Claude Code features. To set a monthly spend cap for Code Review, go to [claude.ai/admin-settings/usage](https://claude.ai/admin-settings/usage) and configure the limit for the Claude Code Review service.

176

177Monitor spend via the weekly cost chart in [analytics](#view-usage) or the per-repo average cost column in admin settings.

178

179## Related resources

180

181Code Review is designed to work alongside the rest of Claude Code. If you want to run reviews locally before opening a PR, need a self-hosted setup, or want to go deeper on how `CLAUDE.md` shapes Claude's behavior across tools, these pages are good next stops:

182

183* [Plugins](/en/discover-plugins): browse the plugin marketplace, including a `code-review` plugin for running on-demand reviews locally before pushing

184* [GitHub Actions](/en/github-actions): run Claude in your own GitHub Actions workflows for custom automation beyond code review

185* [GitLab CI/CD](/en/gitlab-ci-cd): self-hosted Claude integration for GitLab pipelines

186* [Memory](/en/memory): how `CLAUDE.md` files work across Claude Code

187* [Analytics](/en/analytics): track Claude Code usage beyond code review

commands.md +90 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Built-in commands

7> Complete reference for built-in commands available in Claude Code.

9Type `/` in Claude Code to see all available commands, or type `/` followed by any letters to filter. Not all commands are visible to every user. Some depend on your platform, plan, or environment. For example, `/desktop` only appears on macOS and Windows, `/upgrade` and `/privacy-settings` are only available on Pro and Max plans, and `/terminal-setup` is hidden when your terminal natively supports its keybindings.

11Claude Code also includes [bundled skills](/en/skills#bundled-skills) like `/simplify`, `/batch`, and `/debug` that appear alongside built-in commands when you type `/`. To create your own commands, see [skills](/en/skills).

13In the table below, `<arg>` indicates a required argument and `[arg]` indicates an optional one.

15| Command | Purpose |

16| :--------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

17| `/add-dir <path>` | Add a new working directory to the current session |

18| `/agents` | Manage [agent](/en/sub-agents) configurations |

19| `/btw <question>` | Ask a quick [side question](/en/interactive-mode#side-questions-with-btw) without adding to the conversation |

20| `/chrome` | Configure [Claude in Chrome](/en/chrome) settings |

21| `/clear` | Clear conversation history and free up context. Aliases: `/reset`, `/new` |

22| `/color [color\|default]` | Set the prompt bar color for the current session. Available colors: `red`, `blue`, `green`, `yellow`, `purple`, `orange`, `pink`, `cyan`. Use `default` to reset |

23| `/compact [instructions]` | Compact conversation with optional focus instructions |

24| `/config` | Open the [Settings](/en/settings) interface to adjust theme, model, [output style](/en/output-styles), and other preferences. Alias: `/settings` |

25| `/context` | Visualize current context usage as a colored grid. Shows optimization suggestions for context-heavy tools, memory bloat, and capacity warnings |

26| `/copy [N]` | Copy the last assistant response to clipboard. Pass a number `N` to copy the Nth-latest response: `/copy 2` copies the second-to-last. When code blocks are present, shows an interactive picker to select individual blocks or the full response |

27| `/cost` | Show token usage statistics. See [cost tracking guide](/en/costs#using-the-cost-command) for subscription-specific details |

28| `/desktop` | Continue the current session in the Claude Code Desktop app. macOS and Windows only. Alias: `/app` |

29| `/diff` | Open an interactive diff viewer showing uncommitted changes and per-turn diffs. Use left/right arrows to switch between the current git diff and individual Claude turns, and up/down to browse files |

30| `/doctor` | Diagnose and verify your Claude Code installation and settings |

31| `/effort [low\|medium\|high\|max\|auto]` | Set the model [effort level](/en/model-config#adjust-effort-level). `low`, `medium`, and `high` persist across sessions. `max` applies to the current session only and requires Opus 4.6. `auto` resets to the model default. Without an argument, shows the current level. Takes effect immediately without waiting for the current response to finish |

32| `/exit` | Exit the CLI. Alias: `/quit` |

33| `/export [filename]` | Export the current conversation as plain text. With a filename, writes directly to that file. Without, opens a dialog to copy to clipboard or save to a file |

34| `/extra-usage` | Configure extra usage to keep working when rate limits are hit |

35| `/fast [on\|off]` | Toggle [fast mode](/en/fast-mode) on or off |

36| `/feedback [report]` | Submit feedback about Claude Code. Alias: `/bug` |

37| `/branch [name]` | Create a branch of the current conversation at this point. Alias: `/fork` |

38| `/help` | Show help and available commands |

39| `/hooks` | View [hook](/en/hooks) configurations for tool events |

40| `/ide` | Manage IDE integrations and show status |

41| `/init` | Initialize project with a `CLAUDE.md` guide. Set `CLAUDE_CODE_NEW_INIT=true` for an interactive flow that also walks through skills, hooks, and personal memory files |

42| `/insights` | Generate a report analyzing your Claude Code sessions, including project areas, interaction patterns, and friction points |

43| `/install-github-app` | Set up the [Claude GitHub Actions](/en/github-actions) app for a repository. Walks you through selecting a repo and configuring the integration |

44| `/install-slack-app` | Install the Claude Slack app. Opens a browser to complete the OAuth flow |

45| `/keybindings` | Open or create your keybindings configuration file |

46| `/login` | Sign in to your Anthropic account |

47| `/logout` | Sign out from your Anthropic account |

48| `/mcp` | Manage MCP server connections and OAuth authentication |

49| `/memory` | Edit `CLAUDE.md` memory files, enable or disable [auto-memory](/en/memory#auto-memory), and view auto-memory entries |

50| `/mobile` | Show QR code to download the Claude mobile app. Aliases: `/ios`, `/android` |

51| `/model [model]` | Select or change the AI model. For models that support it, use left/right arrows to [adjust effort level](/en/model-config#adjust-effort-level). The change takes effect immediately without waiting for the current response to finish |

52| `/passes` | Share a free week of Claude Code with friends. Only visible if your account is eligible |

53| `/permissions` | View or update [permissions](/en/permissions#manage-permissions). Alias: `/allowed-tools` |

54| `/plan` | Enter plan mode directly from the prompt |

55| `/plugin` | Manage Claude Code [plugins](/en/plugins) |

56| `/pr-comments [PR]` | Fetch and display comments from a GitHub pull request. Automatically detects the PR for the current branch, or pass a PR URL or number. Requires the `gh` CLI |

57| `/privacy-settings` | View and update your privacy settings. Only available for Pro and Max plan subscribers |

58| `/release-notes` | View the full changelog, with the most recent version closest to your prompt |

59| `/reload-plugins` | Reload all active [plugins](/en/plugins) to apply pending changes without restarting. Reports counts for each reloaded component and flags any load errors |

60| `/remote-control` | Make this session available for [remote control](/en/remote-control) from claude.ai. Alias: `/rc` |

61| `/remote-env` | Configure the default remote environment for [web sessions started with `--remote`](/en/claude-code-on-the-web#environment-configuration) |

62| `/rename [name]` | Rename the current session and show the name on the prompt bar. Without a name, auto-generates one from conversation history |

63| `/resume [session]` | Resume a conversation by ID or name, or open the session picker. Alias: `/continue` |

64| `/review` | Deprecated. Install the [`code-review` plugin](https://github.com/anthropics/claude-code-marketplace/blob/main/code-review/README.md) instead: `claude plugin install code-review@claude-code-marketplace` |

65| `/rewind` | Rewind the conversation and/or code to a previous point, or summarize from a selected message. See [checkpointing](/en/checkpointing). Alias: `/checkpoint` |

66| `/sandbox` | Toggle [sandbox mode](/en/sandboxing). Available on supported platforms only |

67| `/schedule [description]` | Create, update, list, or run [Cloud scheduled tasks](/en/web-scheduled-tasks). Claude walks you through the setup conversationally |

68| `/security-review` | Analyze pending changes on the current branch for security vulnerabilities. Reviews the git diff and identifies risks like injection, auth issues, and data exposure |

69| `/skills` | List available [skills](/en/skills) |

70| `/stats` | Visualize daily usage, session history, streaks, and model preferences |

71| `/status` | Open the Settings interface (Status tab) showing version, model, account, and connectivity. Works while Claude is responding, without waiting for the current response to finish |

72| `/statusline` | Configure Claude Code's [status line](/en/statusline). Describe what you want, or run without arguments to auto-configure from your shell prompt |

73| `/stickers` | Order Claude Code stickers |

74| `/tasks` | List and manage background tasks |

75| `/terminal-setup` | Configure terminal keybindings for Shift+Enter and other shortcuts. Only visible in terminals that need it, like VS Code, Alacritty, or Warp |

76| `/theme` | Change the color theme. Includes light and dark variants, colorblind-accessible (daltonized) themes, and ANSI themes that use your terminal's color palette |

77| `/upgrade` | Open the upgrade page to switch to a higher plan tier |

78| `/usage` | Show plan usage limits and rate limit status |

79| `/vim` | Toggle between Vim and Normal editing modes |

80| `/voice` | Toggle push-to-talk [voice dictation](/en/voice-dictation). Requires a Claude.ai account |

82## MCP prompts

84MCP servers can expose prompts that appear as commands. These use the format `/mcp__<server>__<prompt>` and are dynamically discovered from connected servers. See [MCP prompts](/en/mcp#use-mcp-prompts-as-commands) for details.

86## See also

88* [Skills](/en/skills): create your own commands

89* [Interactive mode](/en/interactive-mode): keyboard shortcuts, Vim mode, and command history

90* [CLI reference](/en/cli-reference): launch-time flags

common-workflows.md +391 −358

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Common workflows5# Common workflows

2 6

~~3> Learn about common workflows with Claude Code.~~7> Step-by-step guides for exploring codebases, fixing bugs, refactoring, testing, and other everyday tasks with Claude Code.

4 8

~~5Each task in this document includes clear instructions, example commands, and best practices to help you get the most from Claude Code.~~9This page covers practical workflows for everyday development: exploring unfamiliar code, debugging, refactoring, writing tests, creating PRs, and managing sessions. Each section includes example prompts you can adapt to your own projects. For higher-level patterns and tips, see [Best practices](/en/best-practices).

6 10

7## Understand new codebases11## Understand new codebases

8 12

24 </Step>28 </Step>

25 29

26 <Step title="Ask for a high-level overview">30 <Step title="Ask for a high-level overview">

~~27 ```~~31 ```text theme={null}

~~28 > give me an overview of this codebase~~ 32 give me an overview of this codebase

29 ```33 ```

30 </Step>34 </Step>

31 35

32 <Step title="Dive deeper into specific components">36 <Step title="Dive deeper into specific components">

~~33 ```~~37 ```text theme={null}

~~34 > explain the main architecture patterns used here~~ 38 explain the main architecture patterns used here

35 ```39 ```

36 40

~~37 ```~~41 ```text theme={null}

~~38 > what are the key data models?~~42 what are the key data models?

39 ```43 ```

40 44

~~41 ```~~45 ```text theme={null}

~~42 > how is authentication handled?~~46 how is authentication handled?

43 ```47 ```

44 </Step>48 </Step>

45</Steps>49</Steps>

58 62

59<Steps>63<Steps>

60 <Step title="Ask Claude to find relevant files">64 <Step title="Ask Claude to find relevant files">

~~61 ```~~65 ```text theme={null}

~~62 > find the files that handle user authentication~~ 66 find the files that handle user authentication

63 ```67 ```

64 </Step>68 </Step>

65 69

66 <Step title="Get context on how components interact">70 <Step title="Get context on how components interact">

~~67 ```~~71 ```text theme={null}

~~68 > how do these authentication files work together?~~ 72 how do these authentication files work together?

69 ```73 ```

70 </Step>74 </Step>

71 75

72 <Step title="Understand the execution flow">76 <Step title="Understand the execution flow">

~~73 ```~~77 ```text theme={null}

~~74 > trace the login process from front-end to database~~ 78 trace the login process from front-end to database

75 ```79 ```

76 </Step>80 </Step>

77</Steps>81</Steps>

81 85

82 * Be specific about what you're looking for86 * Be specific about what you're looking for

83 * Use domain language from the project87 * Use domain language from the project

88 * Install a [code intelligence plugin](/en/discover-plugins#code-intelligence) for your language to give Claude precise "go to definition" and "find references" navigation

84</Tip>89</Tip>

85 90

86***91***

91 96

92<Steps>97<Steps>

93 <Step title="Share the error with Claude">98 <Step title="Share the error with Claude">

~~94 ```~~99 ```text theme={null}

~~95 > I'm seeing an error when I run npm test~~ 100 I'm seeing an error when I run npm test

96 ```101 ```

97 </Step>102 </Step>

98 103

99 <Step title="Ask for fix recommendations">104 <Step title="Ask for fix recommendations">

100 ```105 ```text theme={null}

101 > suggest a few ways to fix the @ts-ignore in user.ts 106 suggest a few ways to fix the @ts-ignore in user.ts

102 ```107 ```

103 </Step>108 </Step>

104 109

105 <Step title="Apply the fix">110 <Step title="Apply the fix">

106 ```111 ```text theme={null}

107 > update user.ts to add the null check you suggested 112 update user.ts to add the null check you suggested

108 ```113 ```

109 </Step>114 </Step>

110</Steps>115</Steps>

125 130

126<Steps>131<Steps>

127 <Step title="Identify legacy code for refactoring">132 <Step title="Identify legacy code for refactoring">

128 ```133 ```text theme={null}

129 > find deprecated API usage in our codebase 134 find deprecated API usage in our codebase

130 ```135 ```

131 </Step>136 </Step>

132 137

133 <Step title="Get refactoring recommendations">138 <Step title="Get refactoring recommendations">

134 ```139 ```text theme={null}

135 > suggest how to refactor utils.js to use modern JavaScript features 140 suggest how to refactor utils.js to use modern JavaScript features

136 ```141 ```

137 </Step>142 </Step>

138 143

139 <Step title="Apply the changes safely">144 <Step title="Apply the changes safely">

140 ```145 ```text theme={null}

141 > refactor utils.js to use ES2024 features while maintaining the same behavior 146 refactor utils.js to use ES2024 features while maintaining the same behavior

142 ```147 ```

143 </Step>148 </Step>

144 149

145 <Step title="Verify the refactoring">150 <Step title="Verify the refactoring">

146 ```151 ```text theme={null}

147 > run tests for the refactored code 152 run tests for the refactored code

148 ```153 ```

149 </Step>154 </Step>

150</Steps>155</Steps>

165 170

166<Steps>171<Steps>

167 <Step title="View available subagents">172 <Step title="View available subagents">

168 ```173 ```text theme={null}

169 > /agents174 /agents

170 ```175 ```

171 176

172 This shows all available subagents and lets you create new ones.177 This shows all available subagents and lets you create new ones.

173 </Step>178 </Step>

174 179

175 <Step title="Use subagents automatically">180 <Step title="Use subagents automatically">

176 Claude Code will automatically delegate appropriate tasks to specialized subagents:181 Claude Code automatically delegates appropriate tasks to specialized subagents:

177 182

178 ```183 ```text theme={null}

179 > review my recent code changes for security issues184 review my recent code changes for security issues

180 ```185 ```

181 186

182 ```187 ```text theme={null}

183 > run all tests and fix any failures188 run all tests and fix any failures

184 ```189 ```

185 </Step>190 </Step>

186 191

187 <Step title="Explicitly request specific subagents">192 <Step title="Explicitly request specific subagents">

188 ```193 ```text theme={null}

189 > use the code-reviewer subagent to check the auth module194 use the code-reviewer subagent to check the auth module

190 ```195 ```

191 196

192 ```197 ```text theme={null}

193 > have the debugger subagent investigate why users can't log in198 have the debugger subagent investigate why users can't log in

194 ```199 ```

195 </Step>200 </Step>

196 201

197 <Step title="Create custom subagents for your workflow">202 <Step title="Create custom subagents for your workflow">

198 ```203 ```text theme={null}

199 > /agents204 /agents

200 ```205 ```

201 206

202 Then select "Create New subagent" and follow the prompts to define:207 Then select "Create New subagent" and follow the prompts to define:

203 208

204 * Subagent type (e.g., `api-designer`, `performance-optimizer`)209 * A unique identifier that describes the subagent's purpose (for example, `code-reviewer`, `api-designer`).

205 * When to use it210 * When Claude should use this agent

206 * Which tools it can access211 * Which tools it can access

207 * Its specialized system prompt212 * A system prompt describing the agent's role and behavior

208 </Step>213 </Step>

209</Steps>214</Steps>

210 215

221 226

222## Use Plan Mode for safe code analysis227## Use Plan Mode for safe code analysis

223 228

224Plan Mode instructs Claude to create a plan by analyzing the codebase with read-only operations, perfect for exploring codebases, planning complex changes, or reviewing code safely.229Plan Mode instructs Claude to create a plan by analyzing the codebase with read-only operations, perfect for exploring codebases, planning complex changes, or reviewing code safely. In Plan Mode, Claude uses [`AskUserQuestion`](/en/tools-reference) to gather requirements and clarify your goals before proposing a plan.

225 230

226### When to use Plan Mode231### When to use Plan Mode

227 232

235 240

236You can switch into Plan Mode during a session using **Shift+Tab** to cycle through permission modes.241You can switch into Plan Mode during a session using **Shift+Tab** to cycle through permission modes.

237 242

238If you are in Normal Mode, **Shift+Tab** will first switch into Auto-Accept Mode, indicated by `⏵⏵ accept edits on` at the bottom of the terminal. A subsequent **Shift+Tab** will switch into Plan Mode, indicated by `⏸ plan mode on`.243If you are in Normal Mode, **Shift+Tab** first switches into Auto-Accept Mode, indicated by `⏵⏵ accept edits on` at the bottom of the terminal. A subsequent **Shift+Tab** will switch into Plan Mode, indicated by `⏸ plan mode on`.

239 244

240**Start a new session in Plan Mode**245**Start a new session in Plan Mode**

241 246

247 252

248**Run "headless" queries in Plan Mode**253**Run "headless" queries in Plan Mode**

249 254

250You can also run a query in Plan Mode directly with `-p` (i.e., in ["headless mode"](/en/headless)):255You can also run a query in Plan Mode directly with `-p` (that is, in ["headless mode"](/en/headless)):

251 256

252```bash theme={null}257```bash theme={null}

253claude --permission-mode plan -p "Analyze the authentication system and suggest improvements"258claude --permission-mode plan -p "Analyze the authentication system and suggest improvements"

259claude --permission-mode plan264claude --permission-mode plan

260```265```

261 266

262```267```text theme={null}

263> I need to refactor our authentication system to use OAuth2. Create a detailed migration plan.268I need to refactor our authentication system to use OAuth2. Create a detailed migration plan.

264```269```

265 270

266Claude will analyze the current implementation and create a comprehensive plan. Refine with follow-ups:271Claude analyzes the current implementation and create a comprehensive plan. Refine with follow-ups:

267 272

273```text theme={null}

274What about backward compatibility?

268```275```

269> What about backward compatibility?276

270> How should we handle database migration?277```text theme={null}

278How should we handle database migration?

271```279```

272 280

281<Tip>Press `Ctrl+G` to open the plan in your default text editor, where you can edit it directly before Claude proceeds.</Tip>

282

283When you accept a plan, Claude automatically names the session from the plan content. The name appears on the prompt bar and in the session picker. If you've already set a name with `--name` or `/rename`, accepting a plan won't overwrite it.

284

273### Configure Plan Mode as default285### Configure Plan Mode as default

274 286

275```json theme={null}287```json theme={null}

291 303

292<Steps>304<Steps>

293 <Step title="Identify untested code">305 <Step title="Identify untested code">

294 ```306 ```text theme={null}

295 > find functions in NotificationsService.swift that are not covered by tests 307 find functions in NotificationsService.swift that are not covered by tests

296 ```308 ```

297 </Step>309 </Step>

298 310

299 <Step title="Generate test scaffolding">311 <Step title="Generate test scaffolding">

300 ```312 ```text theme={null}

301 > add tests for the notification service 313 add tests for the notification service

302 ```314 ```

303 </Step>315 </Step>

304 316

305 <Step title="Add meaningful test cases">317 <Step title="Add meaningful test cases">

306 ```318 ```text theme={null}

307 > add test cases for edge conditions in the notification service 319 add test cases for edge conditions in the notification service

308 ```320 ```

309 </Step>321 </Step>

310 322

311 <Step title="Run and verify tests">323 <Step title="Run and verify tests">

312 ```324 ```text theme={null}

313 > run the new tests and fix any failures 325 run the new tests and fix any failures

314 ```326 ```

315 </Step>327 </Step>

316</Steps>328</Steps>

317 329

318<Tip>330Claude can generate tests that follow your project's existing patterns and conventions. When asking for tests, be specific about what behavior you want to verify. Claude examines your existing test files to match the style, frameworks, and assertion patterns already in use.

319 Tips:

320 331

321 * Ask for tests that cover edge cases and error conditions332For comprehensive coverage, ask Claude to identify edge cases you might have missed. Claude can analyze your code paths and suggest tests for error conditions, boundary values, and unexpected inputs that are easy to overlook.

322 * Request both unit and integration tests when appropriate

323 * Have Claude explain the testing strategy

324</Tip>

325 333

326***334***

327 335

328## Create pull requests336## Create pull requests

329 337

330Suppose you need to create a well-documented pull request for your changes.338You can create pull requests by asking Claude directly ("create a pr for my changes"), or guide Claude through it step-by-step:

331 339

332<Steps>340<Steps>

333 <Step title="Summarize your changes">341 <Step title="Summarize your changes">

334 ```342 ```text theme={null}

335 > summarize the changes I've made to the authentication module 343 summarize the changes I've made to the authentication module

336 ```344 ```

337 </Step>345 </Step>

338 346

339 <Step title="Generate a PR with Claude">347 <Step title="Generate a pull request">

340 ```348 ```text theme={null}

341 > create a pr 349 create a pr

342 ```350 ```

343 </Step>351 </Step>

344 352

345 <Step title="Review and refine">353 <Step title="Review and refine">

346 ```354 ```text theme={null}

347 > enhance the PR description with more context about the security improvements 355 enhance the PR description with more context about the security improvements

348 ```

349 </Step>

~~350~~

351 <Step title="Add testing details">

352 ```

353 > add information about how these changes were tested

354 ```356 ```

355 </Step>357 </Step>

356</Steps>358</Steps>

357 359

358<Tip>360When you create a PR using `gh pr create`, the session is automatically linked to that PR. You can resume it later with `claude --from-pr <number>`.

359 Tips:

360 361

361 * Ask Claude directly to make a PR for you362<Tip>

362 * Review Claude's generated PR before submitting363 Review Claude's generated PR before submitting and ask Claude to highlight potential risks or considerations.

363 * Ask Claude to highlight potential risks or considerations

364</Tip>364</Tip>

365 365

366## Handle documentation366## Handle documentation

369 369

370<Steps>370<Steps>

371 <Step title="Identify undocumented code">371 <Step title="Identify undocumented code">

372 ```372 ```text theme={null}

373 > find functions without proper JSDoc comments in the auth module 373 find functions without proper JSDoc comments in the auth module

374 ```374 ```

375 </Step>375 </Step>

376 376

377 <Step title="Generate documentation">377 <Step title="Generate documentation">

378 ```378 ```text theme={null}

379 > add JSDoc comments to the undocumented functions in auth.js 379 add JSDoc comments to the undocumented functions in auth.js

380 ```380 ```

381 </Step>381 </Step>

382 382

383 <Step title="Review and enhance">383 <Step title="Review and enhance">

384 ```384 ```text theme={null}

385 > improve the generated documentation with more context and examples 385 improve the generated documentation with more context and examples

386 ```386 ```

387 </Step>387 </Step>

388 388

389 <Step title="Verify documentation">389 <Step title="Verify documentation">

390 ```390 ```text theme={null}

391 > check if the documentation follows our project standards 391 check if the documentation follows our project standards

392 ```392 ```

393 </Step>393 </Step>

394</Steps>394</Steps>

417 </Step>417 </Step>

418 418

419 <Step title="Ask Claude to analyze the image">419 <Step title="Ask Claude to analyze the image">

420 ```420 ```text theme={null}

421 > What does this image show?421 What does this image show?

422 ```422 ```

423 423

424 ```424 ```text theme={null}

425 > Describe the UI elements in this screenshot425 Describe the UI elements in this screenshot

426 ```426 ```

427 427

428 ```428 ```text theme={null}

429 > Are there any problematic elements in this diagram?429 Are there any problematic elements in this diagram?

430 ```430 ```

431 </Step>431 </Step>

432 432

433 <Step title="Use images for context">433 <Step title="Use images for context">

434 ```434 ```text theme={null}

435 > Here's a screenshot of the error. What's causing it?435 Here's a screenshot of the error. What's causing it?

436 ```436 ```

437 437

438 ```438 ```text theme={null}

439 > This is our current database schema. How should we modify it for the new feature?439 This is our current database schema. How should we modify it for the new feature?

440 ```440 ```

441 </Step>441 </Step>

442 442

443 <Step title="Get code suggestions from visual content">443 <Step title="Get code suggestions from visual content">

444 ```444 ```text theme={null}

445 > Generate CSS to match this design mockup445 Generate CSS to match this design mockup

446 ```446 ```

447 447

448 ```448 ```text theme={null}

449 > What HTML structure would recreate this component?449 What HTML structure would recreate this component?

450 ```450 ```

451 </Step>451 </Step>

452</Steps>452</Steps>

458 * Include screenshots of errors, UI designs, or diagrams for better context458 * Include screenshots of errors, UI designs, or diagrams for better context

459 * You can work with multiple images in a conversation459 * You can work with multiple images in a conversation

460 * Image analysis works with diagrams, screenshots, mockups, and more460 * Image analysis works with diagrams, screenshots, mockups, and more

461 * When Claude references images (for example, `[Image #1]`), `Cmd+Click` (Mac) or `Ctrl+Click` (Windows/Linux) the link to open the image in your default viewer

461</Tip>462</Tip>

462 463

463***464***

468 469

469<Steps>470<Steps>

470 <Step title="Reference a single file">471 <Step title="Reference a single file">

471 ```472 ```text theme={null}

472 > Explain the logic in @src/utils/auth.js473 Explain the logic in @src/utils/auth.js

473 ```474 ```

474 475

475 This includes the full content of the file in the conversation.476 This includes the full content of the file in the conversation.

476 </Step>477 </Step>

477 478

478 <Step title="Reference a directory">479 <Step title="Reference a directory">

479 ```480 ```text theme={null}

480 > What's the structure of @src/components?481 What's the structure of @src/components?

481 ```482 ```

482 483

483 This provides a directory listing with file information.484 This provides a directory listing with file information.

484 </Step>485 </Step>

485 486

486 <Step title="Reference MCP resources">487 <Step title="Reference MCP resources">

487 ```488 ```text theme={null}

488 > Show me the data from @github:repos/owner/repo/issues489 Show me the data from @github:repos/owner/repo/issues

489 ```490 ```

490 491

491 This fetches data from connected MCP servers using the format @server:resource. See [MCP resources](/en/mcp#use-mcp-resources) for details.492 This fetches data from connected MCP servers using the format @server:resource. See [MCP resources](/en/mcp#use-mcp-resources) for details.

496 Tips:497 Tips:

497 498

498 * File paths can be relative or absolute499 * File paths can be relative or absolute

499 * @ file references add CLAUDE.md in the file's directory and parent directories to context500 * @ file references add `CLAUDE.md` in the file's directory and parent directories to context

500 * Directory references show file listings, not contents501 * Directory references show file listings, not contents

501 * You can reference multiple files in a single message (e.g., "@file1.js and @file2.js")502 * You can reference multiple files in a single message (for example, "@file1.js and @file2.js")

502</Tip>503</Tip>

503 504

504***505***

505 506

506## Use extended thinking507## Use extended thinking (thinking mode)

507 508

508Suppose you're working on complex architectural decisions, challenging bugs, or planning multi-step implementations that require deep reasoning.509[Extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) is enabled by default, giving Claude space to reason through complex problems step-by-step before responding. This reasoning is visible in verbose mode, which you can toggle on with `Ctrl+O`.

509 510

510<Note>511Additionally, Opus 4.6 and Sonnet 4.6 support adaptive reasoning: instead of a fixed thinking token budget, the model dynamically allocates thinking based on your [effort level](/en/model-config#adjust-effort-level) setting. Extended thinking and adaptive reasoning work together to give you control over how deeply Claude reasons before responding.

511 [Extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) is disabled by default in Claude Code. You can enable it on-demand by using `Tab` to toggle Thinking on, or by using prompts like "think" or "think hard". You can also enable it permanently by setting the [`MAX_THINKING_TOKENS` environment variable](/en/settings#environment-variables) in your settings.

512</Note>

513 512

514<Steps>513Extended thinking is particularly valuable for complex architectural decisions, challenging bugs, multi-step implementation planning, and evaluating tradeoffs between different approaches.

515 <Step title="Provide context and ask Claude to think">

516 ```

517 > I need to implement a new authentication system using OAuth2 for our API. Think deeply about the best approach for implementing this in our codebase.

518 ```

519 514

520 Claude will gather relevant information from your codebase and515<Note>

521 use extended thinking, which will be visible in the interface.516 Phrases like "think", "think hard", and "think more" are interpreted as regular prompt instructions and don't allocate thinking tokens.

522 </Step>517</Note>

523 518

524 <Step title="Refine the thinking with follow-up prompts">519### Configure thinking mode

525 ```

526 > think about potential security vulnerabilities in this approach

527 ```

528 520

529 ```521Thinking is enabled by default, but you can adjust or disable it.

530 > think hard about edge cases we should handle

531 ```

532 </Step>

533</Steps>

534 522

535<Tip>523| Scope | How to configure | Details |

536 Tips to get the most value out of extended thinking:524| ------------------------ | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

525| **Effort level** | Run `/effort`, adjust in `/model`, or set [`CLAUDE_CODE_EFFORT_LEVEL`](/en/env-vars) | Control thinking depth for Opus 4.6 and Sonnet 4.6. See [Adjust effort level](/en/model-config#adjust-effort-level) |

526| **`ultrathink` keyword** | Include "ultrathink" anywhere in your prompt | Sets effort to high for that turn on Opus 4.6 and Sonnet 4.6. Useful for one-off tasks requiring deep reasoning without permanently changing your effort setting |

527| **Toggle shortcut** | Press `Option+T` (macOS) or `Alt+T` (Windows/Linux) | Toggle thinking on/off for the current session (all models). May require [terminal configuration](/en/terminal-config) to enable Option key shortcuts |

528| **Global default** | Use `/config` to toggle thinking mode | Sets your default across all projects (all models).<br />Saved as `alwaysThinkingEnabled` in `~/.claude/settings.json` |

529| **Limit token budget** | Set [`MAX_THINKING_TOKENS`](/en/env-vars) environment variable | Limit the thinking budget to a specific number of tokens. On Opus 4.6 and Sonnet 4.6, only `0` applies unless adaptive reasoning is disabled. Example: `export MAX_THINKING_TOKENS=10000` |

537 530

538 [Extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) is most valuable for complex tasks such as:531To view Claude's thinking process, press `Ctrl+O` to toggle verbose mode and see the internal reasoning displayed as gray italic text.

539 532

540 * Planning complex architectural changes533### How extended thinking works

541 * Debugging intricate issues

542 * Creating implementation plans for new features

543 * Understanding complex codebases

544 * Evaluating tradeoffs between different approaches

545 534

546 Use `Tab` to toggle Thinking on and off during a session.535Extended thinking controls how much internal reasoning Claude performs before responding. More thinking provides more space to explore solutions, analyze edge cases, and self-correct mistakes.

547 536

548 The way you prompt for thinking results in varying levels of thinking depth:537**With Opus 4.6 and Sonnet 4.6**, thinking uses adaptive reasoning: the model dynamically allocates thinking tokens based on the [effort level](/en/model-config#adjust-effort-level) you select. This is the recommended way to tune the tradeoff between speed and reasoning depth.

549 538

550 * "think" triggers basic extended thinking539**With older models**, thinking uses a fixed token budget drawn from your output allocation. The budget varies by model; see [`MAX_THINKING_TOKENS`](/en/env-vars) for per-model ceilings. You can limit the budget with that environment variable, or disable thinking entirely via `/config` or the `Option+T`/`Alt+T` toggle.

551 * intensifying phrases such as "keep hard", "think more", "think a lot", or "think longer" triggers deeper thinking

552 540

553 For more extended thinking prompting tips, see [Extended thinking tips](https://docs.claude.com/en/docs/build-with-claude/prompt-engineering/extended-thinking-tips).541On Opus 4.6 and Sonnet 4.6, [adaptive reasoning](/en/model-config#adjust-effort-level) controls thinking depth, so `MAX_THINKING_TOKENS` only applies when set to `0` to disable thinking, or when `CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING=1` reverts these models to the fixed budget. See [environment variables](/en/env-vars).

554</Tip>

555 542

556<Note>543<Warning>

557 Claude will display its thinking process as italic gray text above the544 You're charged for all thinking tokens used, even though Claude 4 models show summarized thinking

558 response.545</Warning>

559</Note>

560 546

561***547***

562 548

563## Resume previous conversations549## Resume previous conversations

564 550

565Suppose you've been working on a task with Claude Code and need to continue where you left off in a later session.551When starting Claude Code, you can resume a previous session:

552

553* `claude --continue` continues the most recent conversation in the current directory

554* `claude --resume` opens a conversation picker or resumes by name

555* `claude --from-pr 123` resumes sessions linked to a specific pull request

566 556

567Claude Code provides two options for resuming previous conversations:557From inside an active session, use `/resume` to switch to a different conversation.

568 558

569* `--continue` to automatically continue the most recent conversation559Sessions are stored per project directory. The `/resume` picker shows sessions from the same git repository, including worktrees.

570* `--resume` to display a conversation picker560

561### Name your sessions

562

563Give sessions descriptive names to find them later. This is a best practice when working on multiple tasks or features.

571 564

572<Steps>565<Steps>

573 <Step title="Continue the most recent conversation">566 <Step title="Name the session">

567 Name a session at startup with `-n`:

568

574 ```bash theme={null}569 ```bash theme={null}

575 claude --continue570 claude -n auth-refactor

576 ```571 ```

577 572

578 This immediately resumes your most recent conversation without any prompts.573 Or use `/rename` during a session, which also shows the name on the prompt bar:

579 </Step>

580 574

581 <Step title="Continue in non-interactive mode">575 ```text theme={null}

582 ```bash theme={null}576 /rename auth-refactor

583 claude --continue --print "Continue with my task"

584 ```577 ```

585 578

586 Use `--print` with `--continue` to resume the most recent conversation in non-interactive mode, perfect for scripts or automation.579 You can also rename any session from the picker: run `/resume`, navigate to a session, and press `R`.

587 </Step>580 </Step>

588 581

589 <Step title="Show conversation picker">582 <Step title="Resume by name later">

583 From the command line:

584

590 ```bash theme={null}585 ```bash theme={null}

591 claude --resume586 claude --resume auth-refactor

592 ```587 ```

593 588

594 This displays an interactive conversation selector with a clean list view showing:589 Or from inside an active session:

~~595~~

596 * Session summary (or initial prompt)

597 * Metadata: time elapsed, message count, and git branch

598 590

599 Use arrow keys to navigate and press Enter to select a conversation. Press Esc to exit.591 ```text theme={null}

592 /resume auth-refactor

593 ```

600 </Step>594 </Step>

601</Steps>595</Steps>

602 596

597### Use the session picker

598

599The `/resume` command (or `claude --resume` without arguments) opens an interactive session picker with these features:

600

601**Keyboard shortcuts in the picker:**

602

603| Shortcut | Action |

604| :-------- | :------------------------------------------------ |

605| `↑` / `↓` | Navigate between sessions |

606| `→` / `←` | Expand or collapse grouped sessions |

607| `Enter` | Select and resume the highlighted session |

608| `P` | Preview the session content |

609| `R` | Rename the highlighted session |

610| `/` | Search to filter sessions |

611| `A` | Toggle between current directory and all projects |

612| `B` | Filter to sessions from your current git branch |

613| `Esc` | Exit the picker or search mode |

614

615**Session organization:**

616

617The picker displays sessions with helpful metadata:

618

619* Session name or initial prompt

620* Time elapsed since last activity

621* Message count

622* Git branch (if applicable)

623

624Forked sessions (created with `/branch`, `/rewind`, or `--fork-session`) are grouped together under their root session, making it easier to find related conversations.

625

603<Tip>626<Tip>

604 Tips:627 Tips:

605 628

606 * Conversation history is stored locally on your machine629 * **Name sessions early**: Use `/rename` when starting work on a distinct task: it's much easier to find "payment-integration" than "explain this function" later

607 * Use `--continue` for quick access to your most recent conversation630 * Use `--continue` for quick access to your most recent conversation in the current directory

608 * Use `--resume` when you need to select a specific past conversation631 * Use `--resume session-name` when you know which session you need

609 * When resuming, you'll see the entire conversation history before continuing632 * Use `--resume` (without a name) when you need to browse and select

633 * For scripts, use `claude --continue --print "prompt"` to resume in non-interactive mode

634 * Press `P` in the picker to preview a session before resuming it

610 * The resumed conversation starts with the same model and configuration as the original635 * The resumed conversation starts with the same model and configuration as the original

611 636

612 How it works:637 How it works:

615 2. **Message Deserialization**: When resuming, the entire message history is restored to maintain context640 2. **Message Deserialization**: When resuming, the entire message history is restored to maintain context

616 3. **Tool State**: Tool usage and results from the previous conversation are preserved641 3. **Tool State**: Tool usage and results from the previous conversation are preserved

617 4. **Context Restoration**: The conversation resumes with all previous context intact642 4. **Context Restoration**: The conversation resumes with all previous context intact

643</Tip>

618 644

619 Examples:645***

620 646

621 ```bash theme={null}647## Run parallel Claude Code sessions with Git worktrees

622 # Continue most recent conversation

623 claude --continue

624 648

625 # Continue most recent conversation with a specific prompt649When working on multiple tasks at once, you need each Claude session to have its own copy of the codebase so changes don't collide. Git worktrees solve this by creating separate working directories that each have their own files and branch, while sharing the same repository history and remote connections. This means you can have Claude working on a feature in one worktree while fixing a bug in another, without either session interfering with the other.

626 claude --continue --print "Show me our progress"

627 650

628 # Show conversation picker651Use the `--worktree` (`-w`) flag to create an isolated worktree and start Claude in it. The value you pass becomes the worktree directory name and branch name:

629 claude --resume

630 652

631 # Continue most recent conversation in non-interactive mode653```bash theme={null}

632 claude --continue --print "Run the tests again"654# Start Claude in a worktree named "feature-auth"

633 ```655# Creates .claude/worktrees/feature-auth/ with a new branch

656claude --worktree feature-auth

657

658# Start another session in a separate worktree

659claude --worktree bugfix-123

660```

661

662If you omit the name, Claude generates a random one automatically:

663

664```bash theme={null}

665# Auto-generates a name like "bright-running-fox"

666claude --worktree

667```

668

669Worktrees are created at `<repo>/.claude/worktrees/<name>` and branch from the default remote branch. The worktree branch is named `worktree-<name>`.

670

671You can also ask Claude to "work in a worktree" or "start a worktree" during a session, and it will create one automatically.

672

673### Subagent worktrees

674

675Subagents can also use worktree isolation to work in parallel without conflicts. Ask Claude to "use worktrees for your agents" or configure it in a [custom subagent](/en/sub-agents#supported-frontmatter-fields) by adding `isolation: worktree` to the agent's frontmatter. Each subagent gets its own worktree that is automatically cleaned up when the subagent finishes without changes.

676

677### Worktree cleanup

678

679When you exit a worktree session, Claude handles cleanup based on whether you made changes:

680

681* **No changes**: the worktree and its branch are removed automatically

682* **Changes or commits exist**: Claude prompts you to keep or remove the worktree. Keeping preserves the directory and branch so you can return later. Removing deletes the worktree directory and its branch, discarding all uncommitted changes and commits

683

684To clean up worktrees outside of a Claude session, use [manual worktree management](#manage-worktrees-manually).

685

686<Tip>

687 Add `.claude/worktrees/` to your `.gitignore` to prevent worktree contents from appearing as untracked files in your main repository.

634</Tip>688</Tip>

635 689

636***690### Manage worktrees manually

637 691

638## Run parallel Claude Code sessions with Git worktrees692For more control over worktree location and branch configuration, create worktrees with Git directly. This is useful when you need to check out a specific existing branch or place the worktree outside the repository.

639 693

640Suppose you need to work on multiple tasks simultaneously with complete code isolation between Claude Code instances.694```bash theme={null}

695# Create a worktree with a new branch

696git worktree add ../project-feature-a -b feature-a

641 697

642<Steps>698# Create a worktree with an existing branch

643 <Step title="Understand Git worktrees">699git worktree add ../project-bugfix bugfix-123

644 Git worktrees allow you to check out multiple branches from the same

645 repository into separate directories. Each worktree has its own working

646 directory with isolated files, while sharing the same Git history. Learn

647 more in the [official Git worktree

648 documentation](https://git-scm.com/docs/git-worktree).

649 </Step>

650 700

651 <Step title="Create a new worktree">701# Start Claude in the worktree

652 ```bash theme={null}702cd ../project-feature-a && claude

653 # Create a new worktree with a new branch

654 git worktree add ../project-feature-a -b feature-a

655 703

656 # Or create a worktree with an existing branch704# Clean up when done

657 git worktree add ../project-bugfix bugfix-123705git worktree list

658 ```706git worktree remove ../project-feature-a

707```

659 708

660 This creates a new directory with a separate working copy of your repository.709Learn more in the [official Git worktree documentation](https://git-scm.com/docs/git-worktree).

661 </Step>

662 710

663 <Step title="Run Claude Code in each worktree">711<Tip>

664 ```bash theme={null}712 Remember to initialize your development environment in each new worktree according to your project's setup. Depending on your stack, this might include running dependency installation (`npm install`, `yarn`), setting up virtual environments, or following your project's standard setup process.

665 # Navigate to your worktree 713</Tip>

666 cd ../project-feature-a

667 714

668 # Run Claude Code in this isolated environment715### Non-git version control

669 claude

670 ```

671 </Step>

672 716

673 <Step title="Run Claude in another worktree">717Worktree isolation works with git by default. For other version control systems like SVN, Perforce, or Mercurial, configure [WorktreeCreate and WorktreeRemove hooks](/en/hooks#worktreecreate) to provide custom worktree creation and cleanup logic. When configured, these hooks replace the default git behavior when you use `--worktree`.

674 ```bash theme={null}718

675 cd ../project-bugfix719For automated coordination of parallel sessions with shared tasks and messaging, see [agent teams](/en/agent-teams).

676 claude720

721***

722

723## Get notified when Claude needs your attention

724

725When you kick off a long-running task and switch to another window, you can set up desktop notifications so you know when Claude finishes or needs your input. This uses the `Notification` [hook event](/en/hooks-guide#get-notified-when-claude-needs-input), which fires whenever Claude is waiting for permission, idle and ready for a new prompt, or completing authentication.

726

727<Steps>

728 <Step title="Add the hook to your settings">

729 Open `~/.claude/settings.json` and add a `Notification` hook that calls your platform's native notification command:

730

731 <Tabs>

732 <Tab title="macOS">

733 ```json theme={null}

734 {

735 "hooks": {

736 "Notification": [

737 {

738 "matcher": "",

739 "hooks": [

740 {

741 "type": "command",

742 "command": "osascript -e 'display notification \"Claude Code needs your attention\" with title \"Claude Code\"'"

743 }

744 ]

745 }

746 ]

747 }

748 }

677 ```749 ```

750 </Tab>

751

752 <Tab title="Linux">

753 ```json theme={null}

754 {

755 "hooks": {

756 "Notification": [

757 {

758 "matcher": "",

759 "hooks": [

760 {

761 "type": "command",

762 "command": "notify-send 'Claude Code' 'Claude Code needs your attention'"

763 }

764 ]

765 }

766 ]

767 }

768 }

769 ```

770 </Tab>

771

772 <Tab title="Windows">

773 ```json theme={null}

774 {

775 "hooks": {

776 "Notification": [

777 {

778 "matcher": "",

779 "hooks": [

780 {

781 "type": "command",

782 "command": "powershell.exe -Command \"[System.Reflection.Assembly]::LoadWithPartialName('System.Windows.Forms'); [System.Windows.Forms.MessageBox]::Show('Claude Code needs your attention', 'Claude Code')\""

783 }

784 ]

785 }

786 ]

787 }

788 }

789 ```

790 </Tab>

791 </Tabs>

792

793 If your settings file already has a `hooks` key, merge the `Notification` entry into it rather than overwriting. You can also ask Claude to write the hook for you by describing what you want in the CLI.

678 </Step>794 </Step>

679 795

680 <Step title="Manage your worktrees">796 <Step title="Optionally narrow the matcher">

681 ```bash theme={null}797 By default the hook fires on all notification types. To fire only for specific events, set the `matcher` field to one of these values:

682 # List all worktrees

683 git worktree list

684 798

685 # Remove a worktree when done799 | Matcher | Fires when |

686 git worktree remove ../project-feature-a800 | :------------------- | :---------------------------------------------- |

687 ```801 | `permission_prompt` | Claude needs you to approve a tool use |

802 | `idle_prompt` | Claude is done and waiting for your next prompt |

803 | `auth_success` | Authentication completes |

804 | `elicitation_dialog` | Claude is asking you a question |

688 </Step>805 </Step>

689</Steps>

690 806

691<Tip>807 <Step title="Verify the hook">

692 Tips:808 Type `/hooks` and select `Notification` to confirm the hook appears. Selecting it shows the command that will run. To test it end-to-end, ask Claude to run a command that requires permission and switch away from the terminal, or ask Claude to trigger a notification directly.

809 </Step>

810</Steps>

693 811

694 * Each worktree has its own independent file state, making it perfect for parallel Claude Code sessions812For the complete event schema and notification types, see the [Notification reference](/en/hooks#notification).

695 * Changes made in one worktree won't affect others, preventing Claude instances from interfering with each other

696 * All worktrees share the same Git history and remote connections

697 * For long-running tasks, you can have Claude working in one worktree while you continue development in another

698 * Use descriptive directory names to easily identify which task each worktree is for

699 * Remember to initialize your development environment in each new worktree according to your project's setup. Depending on your stack, this might include:

700 * JavaScript projects: Running dependency installation (`npm install`, `yarn`)

701 * Python projects: Setting up virtual environments or installing with package managers

702 * Other languages: Following your project's standard setup process

703</Tip>

704 813

705***814***

706 815

789 898

790***899***

791 900

792## Create custom slash commands901## Run Claude on a schedule

~~793~~

794Claude Code supports custom slash commands that you can create to quickly execute specific prompts or tasks.

~~795~~

796For more details, see the [Slash commands](/en/slash-commands) reference page.

~~797~~

798### Create project-specific commands

799 902

800Suppose you want to create reusable slash commands for your project that all team members can use.903Suppose you want Claude to handle a task automatically on a recurring basis, like reviewing open PRs every morning, auditing dependencies weekly, or checking for CI failures overnight.

801 904

802<Steps>905Pick a scheduling option based on where you want the task to run:

803 <Step title="Create a commands directory in your project">

804 ```bash theme={null}

805 mkdir -p .claude/commands

806 ```

807 </Step>

808 906

809 <Step title="Create a Markdown file for each command">907| Option | Where it runs | Best for |

810 ```bash theme={null}908| :-------------------------------------------------------------- | :-------------------------------- | :------------------------------------------------------------------------------------------------------------ |

811 echo "Analyze the performance of this code and suggest three specific optimizations:" > .claude/commands/optimize.md 909| [Cloud scheduled tasks](/en/web-scheduled-tasks) | Anthropic-managed infrastructure | Tasks that should run even when your computer is off. Configure at [claude.ai/code](https://claude.ai/code). |

812 ```910| [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) | Your machine, via the desktop app | Tasks that need direct access to local files, tools, or uncommitted changes. |

813 </Step>911| [GitHub Actions](/en/github-actions) | Your CI pipeline | Tasks tied to repo events like opened PRs, or cron schedules that should live alongside your workflow config. |

~~814~~ 912| [`/loop`](/en/scheduled-tasks) | The current CLI session | Quick polling while a session is open. Tasks are cancelled when you exit. |

815 <Step title="Use your custom command in Claude Code">

816 ```

817 > /optimize

818 ```

819 </Step>

820</Steps>

~~821~~

822<Tip>

823 Tips:

~~824~~

825 * Command names are derived from the filename (e.g., `optimize.md` becomes `/optimize`)

826 * You can organize commands in subdirectories (e.g., `.claude/commands/frontend/component.md` creates `/component` with "(project:frontend)" shown in the description)

827 * Project commands are available to everyone who clones the repository

828 * The Markdown file content becomes the prompt sent to Claude when the command is invoked

829</Tip>

~~830~~

831### Add command arguments with \$ARGUMENTS

~~832~~

833Suppose you want to create flexible slash commands that can accept additional input from users.

~~834~~

835<Steps>

836 <Step title="Create a command file with the $ARGUMENTS placeholder">

837 ```bash theme={null}

838 echo 'Find and fix issue #$ARGUMENTS. Follow these steps: 1.

839 Understand the issue described in the ticket 2. Locate the relevant code in

840 our codebase 3. Implement a solution that addresses the root cause 4. Add

841 appropriate tests 5. Prepare a concise PR description' >

842 .claude/commands/fix-issue.md

843 ```

844 </Step>

~~845~~

846 <Step title="Use the command with an issue number">

847 In your Claude session, use the command with arguments.

~~848~~

849 ```

850 > /fix-issue 123

851 ```

~~852~~

853 This will replace \$ARGUMENTS with "123" in the prompt.

854 </Step>

855</Steps>

~~856~~

857<Tip>

858 Tips:

~~859~~

860 * The \$ARGUMENTS placeholder is replaced with any text that follows the command

861 * You can position \$ARGUMENTS anywhere in your command template

862 * Other useful applications: generating test cases for specific functions, creating documentation for components, reviewing code in particular files, or translating content to specified languages

863</Tip>

~~864~~

865### Create personal slash commands

~~866~~

867Suppose you want to create personal slash commands that work across all your projects.

~~868~~

869<Steps>

870 <Step title="Create a commands directory in your home folder">

871 ```bash theme={null}

872 mkdir -p ~/.claude/commands

873 ```

874 </Step>

~~875~~

876 <Step title="Create a Markdown file for each command">

877 ```bash theme={null}

878 echo "Review this code for security vulnerabilities, focusing on:" >

879 ~/.claude/commands/security-review.md

880 ```

881 </Step>

~~882~~

883 <Step title="Use your personal custom command">

884 ```

885 > /security-review

886 ```

887 </Step>

888</Steps>

889 913

890<Tip>914<Tip>

891 Tips:915 When writing prompts for scheduled tasks, be explicit about what success looks like and what to do with results. The task runs autonomously, so it can't ask clarifying questions. For example: "Review open PRs labeled `needs-review`, leave inline comments on any issues, and post a summary in the `#eng-reviews` Slack channel."

~~892~~

893 * Personal commands show "(user)" in their description when listed with `/help`

894 * Personal commands are only available to you and not shared with your team

895 * Personal commands work across all your projects

896 * You can use these for consistent workflows across different codebases

897</Tip>916</Tip>

898 917

899***918***

904 923

905### Example questions924### Example questions

906 925

907```926```text theme={null}

908> can Claude Code create pull requests?927can Claude Code create pull requests?

909```928```

910 929

911```930```text theme={null}

912> how does Claude Code handle permissions?931how does Claude Code handle permissions?

913```932```

914 933

915```934```text theme={null}

916> what slash commands are available?935what skills are available?

917```936```

918 937

919```938```text theme={null}

920> how do I use MCP with Claude Code?939how do I use MCP with Claude Code?

921```940```

922 941

923```942```text theme={null}

924> how do I configure Claude Code for Amazon Bedrock?943how do I configure Claude Code for Amazon Bedrock?

925```944```

926 945

927```946```text theme={null}

928> what are the limitations of Claude Code?947what are the limitations of Claude Code?

929```948```

930 949

931<Note>950<Note>

944 963

945## Next steps964## Next steps

946 965

947<Card title="Claude Code reference implementation" icon="code" href="https://github.com/anthropics/claude-code/tree/main/.devcontainer">966<CardGroup cols={2}>

948 Clone our development container reference implementation.967 <Card title="Best practices" icon="lightbulb" href="/en/best-practices">

949</Card>968 Patterns for getting the most out of Claude Code

969 </Card>

970

971 <Card title="How Claude Code works" icon="gear" href="/en/how-claude-code-works">

972 Understand the agentic loop and context management

973 </Card>

974

975 <Card title="Extend Claude Code" icon="puzzle-piece" href="/en/features-overview">

976 Add skills, hooks, MCP, subagents, and plugins

977 </Card>

978

979 <Card title="Reference implementation" icon="code" href="https://github.com/anthropics/claude-code/tree/main/.devcontainer">

980 Clone the development container reference implementation

981 </Card>

982</CardGroup>

costs.md +130 −59

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Manage costs effectively5# Manage costs effectively

2 6

~~3> Learn how to track and optimize token usage and costs when using Claude Code.~~7> Track token usage, set team spend limits, and reduce Claude Code costs with context management, model selection, extended thinking settings, and preprocessing hooks.

9Claude Code consumes tokens for each interaction. Costs vary based on codebase size, query complexity, and conversation length. The average cost is \$6 per developer per day, with daily costs remaining below \$12 for 90% of users.

4 10

~~5Claude Code consumes tokens for each interaction. The average cost is \$6 per developer per day, with daily costs remaining below \$12 for 90% of users.~~11For team usage, Claude Code charges by API token consumption. On average, Claude Code costs \~\$100-200/developer per month with Sonnet 4.6 though there is large variance depending on how many instances users are running and whether they're using it in automation.

6 12

7For team usage, Claude Code charges by API token consumption. On average, Claude Code costs \~\$100-200/developer per month with Sonnet 4.5 though there is large variance depending on how many instances users are running and whether they're using it in automation.13This page covers how to [track your costs](#track-your-costs), [manage costs for teams](#managing-costs-for-teams), and [reduce token usage](#reduce-token-usage).

8 14

9## Track your costs15## Track your costs

10 16

11### Using the `/cost` command17### Using the `/cost` command

12 18

13<Note>19<Note>

~~14 The `/cost` command is not intended for Claude Max and Pro subscribers.~~20 The `/cost` command shows API token usage and is intended for API users. Claude Max and Pro subscribers have usage included in their subscription, so `/cost` data isn't relevant for billing purposes. Subscribers can use `/stats` to view usage patterns.

15</Note>21</Note>

16 22

17The `/cost` command provides detailed token usage statistics for your current session:23The `/cost` command provides detailed token usage statistics for your current session:

18 24

~~19```~~25```text theme={null}

20Total cost: $0.5526Total cost: $0.55

21Total duration (API): 6m 19.7s27Total duration (API): 6m 19.7s

22Total duration (wall): 6h 33m 10.2s28Total duration (wall): 6h 33m 10.2s

23Total code changes: 0 lines added, 0 lines removed29Total code changes: 0 lines added, 0 lines removed

24```30```

25 31

~~26### Additional tracking options~~32## Managing costs for teams

27 33

28Check [historical usage](https://support.claude.com/en/articles/9534590-cost-and-usage-reporting-in-console) in the Claude Console (requires Admin or Billing role) and set [workspace spend limits](https://support.claude.com/en/articles/9796807-creating-and-managing-workspaces) for the Claude Code workspace (requires Admin role).34When using Claude API, you can [set workspace spend limits](https://platform.claude.com/docs/en/build-with-claude/workspaces#workspace-limits) on the total Claude Code workspace spend. Admins can [view cost and usage reporting](https://platform.claude.com/docs/en/build-with-claude/workspaces#usage-and-cost-tracking) in the Console.

29 35

30<Note>36<Note>

31 When you first authenticate Claude Code with your Claude Console account, a workspace called "Claude Code" is automatically created for you. This workspace provides centralized cost tracking and management for all Claude Code usage in your organization. You cannot create API keys for this workspace - it is exclusively for Claude Code authentication and usage.37 When you first authenticate Claude Code with your Claude Console account, a workspace called "Claude Code" is automatically created for you. This workspace provides centralized cost tracking and management for all Claude Code usage in your organization. You cannot create API keys for this workspace; it is exclusively for Claude Code authentication and usage.

32</Note>38</Note>

33 39

~~34## Managing costs for teams~~40On Bedrock, Vertex, and Foundry, Claude Code does not send metrics from your cloud. To get cost metrics, several large enterprises reported using [LiteLLM](/en/llm-gateway#litellm-configuration), which is an open-source tool that helps companies [track spend by key](https://docs.litellm.ai/docs/proxy/virtual_keys#tracking-spend). This project is unaffiliated with Anthropic and has not been audited for security.

36When using Claude API, you can limit the total Claude Code workspace spend. To configure, [follow these instructions](https://support.claude.com/en/articles/9796807-creating-and-managing-workspaces). Admins can view cost and usage reporting by [following these instructions](https://support.claude.com/en/articles/9534590-cost-and-usage-reporting-in-console).

38On Bedrock and Vertex, Claude Code does not send metrics from your cloud. In order to get cost metrics, several large enterprises reported using [LiteLLM](/en/third-party-integrations#litellm), which is an open-source tool that helps companies [track spend by key](https://docs.litellm.ai/docs/proxy/virtual_keys#tracking-spend). This project is unaffiliated with Anthropic and we have not audited its security.

39 41

40### Rate limit recommendations42### Rate limit recommendations

41 43

52 54

53For example, if you have 200 users, you might request 20k TPM for each user, or 4 million total TPM (200\*20,000 = 4 million).55For example, if you have 200 users, you might request 20k TPM for each user, or 4 million total TPM (200\*20,000 = 4 million).

54 56

55The TPM per user decreases as team size grows because we expect fewer users to use Claude Code concurrently in larger organizations. These rate limits apply at the organization level, not per individual user, which means individual users can temporarily consume more than their calculated share when others aren't actively using the service.57The TPM per user decreases as team size grows because fewer users tend to use Claude Code concurrently in larger organizations. These rate limits apply at the organization level, not per individual user, which means individual users can temporarily consume more than their calculated share when others aren't actively using the service.

56 58

57<Note>59<Note>

58 If you anticipate scenarios with unusually high concurrent usage (such as live training sessions with large groups), you may need higher TPM allocations per user.60 If you anticipate scenarios with unusually high concurrent usage (such as live training sessions with large groups), you may need higher TPM allocations per user.

59</Note>61</Note>

60 62

63### Agent team token costs

65[Agent teams](/en/agent-teams) spawn multiple Claude Code instances, each with its own context window. Token usage scales with the number of active teammates and how long each one runs.

67To keep agent team costs manageable:

69* Use Sonnet for teammates. It balances capability and cost for coordination tasks.

70* Keep teams small. Each teammate runs its own context window, so token usage is roughly proportional to team size.

71* Keep spawn prompts focused. Teammates load CLAUDE.md, MCP servers, and skills automatically, but everything in the spawn prompt adds to their context from the start.

72* Clean up teams when work is done. Active teammates continue consuming tokens even if idle.

73* Agent teams are disabled by default. Set `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1` in your [settings.json](/en/settings) or environment to enable them. See [enable agent teams](/en/agent-teams#enable-agent-teams).

61## Reduce token usage75## Reduce token usage

62 76

~~63* **Compact conversations:**~~77Token costs scale with context size: the more context Claude processes, the more tokens you use. Claude Code automatically optimizes costs through prompt caching (which reduces costs for repeated content like system prompts) and auto-compaction (which summarizes conversation history when approaching context limits).

64 78

~~65 * Claude uses auto-compact by default when context exceeds 95% capacity~~79The following strategies help you keep context small and reduce per-message costs.

~~66 * Toggle auto-compact: Run `/config` and navigate to "Auto-compact enabled"~~

~~67 * Use `/compact` manually when context gets large~~

~~68 * Add custom instructions: `/compact Focus on code samples and API usage`~~

~~69 * Customize compaction by adding to CLAUDE.md:~~

70 80

~~71 ```markdown theme={null}~~81### Manage context proactively

~~72 # Summary instructions~~

73 82

~~74 When you are using compact, please focus on test output and code changes~~83Use `/cost` to check your current token usage, or [configure your status line](/en/statusline#context-window-usage) to display it continuously.

~~75 ```~~

76 84

~~77* **Write specific queries:** Avoid vague requests that trigger unnecessary scanning~~85* **Clear between tasks**: Use `/clear` to start fresh when switching to unrelated work. Stale context wastes tokens on every subsequent message. Use `/rename` before clearing so you can easily find the session later, then `/resume` to return to it.

86* **Add custom compaction instructions**: `/compact Focus on code samples and API usage` tells Claude what to preserve during summarization.

78 87

~~79* **Break down complex tasks:** Split large tasks into focused interactions~~88You can also customize compaction behavior in your CLAUDE.md:

80 89

~~81* **Clear history between tasks:** Use `/clear` to reset context~~90```markdown theme={null}

91# Compact instructions

82 92

~~83Costs can vary significantly based on:~~93When you are using compact, please focus on test output and code changes

94```

84 95

~~85* Size of codebase being analyzed~~96### Choose the right model

~~86* Complexity of queries~~

~~87* Number of files being searched or modified~~

~~88* Length of conversation history~~

~~89* Frequency of compacting conversations~~

90 97

~~91## Background token usage~~98Sonnet handles most coding tasks well and costs less than Opus. Reserve Opus for complex architectural decisions or multi-step reasoning. Use `/model` to switch models mid-session, or set a default in `/config`. For simple subagent tasks, specify `model: haiku` in your [subagent configuration](/en/sub-agents#choose-a-model).

92 99

~~93Claude Code uses tokens for some background functionality even when idle:~~100### Reduce MCP server overhead

94 101

~~95* **Conversation summarization**: Background jobs that summarize previous conversations for the `claude --resume` feature~~102Each MCP server adds tool definitions to your context, even when idle. Run `/context` to see what's consuming space.

~~96* **Command processing**: Some commands like `/cost` may generate requests to check status~~

97 103

~~98These background processes consume a small amount of tokens (typically under \$0.04 per session) even without active interaction.~~104* **Prefer CLI tools when available**: Tools like `gh`, `aws`, `gcloud`, and `sentry-cli` are more context-efficient than MCP servers because they don't add persistent tool definitions. Claude can run CLI commands directly without the overhead.

105* **Disable unused servers**: Run `/mcp` to see configured servers and disable any you're not actively using.

106* **Tool search is automatic**: When MCP tool descriptions exceed 10% of your context window, Claude Code automatically defers them and loads tools on-demand via [tool search](/en/mcp#scale-with-mcp-tool-search). Since deferred tools only enter context when actually used, a lower threshold means fewer idle tool definitions consuming space. Set a lower threshold with `ENABLE_TOOL_SEARCH=auto:<N>` (for example, `auto:5` triggers when tools exceed 5% of your context window).

99 107

100## Tracking version changes and updates108### Install code intelligence plugins for typed languages

101 109

102### Current version information110[Code intelligence plugins](/en/discover-plugins#code-intelligence) give Claude precise symbol navigation instead of text-based search, reducing unnecessary file reads when exploring unfamiliar code. A single "go to definition" call replaces what might otherwise be a grep followed by reading multiple candidate files. Installed language servers also report type errors automatically after edits, so Claude catches mistakes without running a compiler.

103 111

104To check your current Claude Code version and installation details:112### Offload processing to hooks and skills

105 113

106```bash theme={null}114Custom [hooks](/en/hooks) can preprocess data before Claude sees it. Instead of Claude reading a 10,000-line log file to find errors, a hook can grep for `ERROR` and return only matching lines, reducing context from tens of thousands of tokens to hundreds.

107claude doctor

108```

109 115

110This command shows your version, installation type, and system information.116A [skill](/en/skills) can give Claude domain knowledge so it doesn't have to explore. For example, a "codebase-overview" skill could describe your project's architecture, key directories, and naming conventions. When Claude invokes the skill, it gets this context immediately instead of spending tokens reading multiple files to understand the structure.

111 117

112### Understanding changes in Claude Code behavior118For example, this PreToolUse hook filters test output to show only failures:

113 119

114Claude Code regularly receives updates that may change how features work, including cost reporting:120<Tabs>

121 <Tab title="settings.json">

122 Add this to your [settings.json](/en/settings#settings-files) to run the hook before every Bash command:

115 123

116* **Version tracking**: Use `claude doctor` to see your current version124 ```json theme={null}

117* **Behavior changes**: Features like `/cost` may display information differently across versions125 {

118* **Documentation access**: Claude always has access to the latest documentation, which can help explain current feature behavior126 "hooks": {

127 "PreToolUse": [

128 {

129 "matcher": "Bash",

130 "hooks": [

131 {

132 "type": "command",

133 "command": "~/.claude/hooks/filter-test-output.sh"

134 }

135 ]

136 }

137 ]

138 }

139 }

140 ```

141 </Tab>

142

143 <Tab title="filter-test-output.sh">

144 The hook calls this script, which checks if the command is a test runner and modifies it to show only failures:

145

146 ```bash theme={null}

147 #!/bin/bash

148 input=$(cat)

149 cmd=$(echo "$input" | jq -r '.tool_input.command')

150

151 # If running tests, filter to show only failures

152 if [[ "$cmd" =~ ^(npm test|pytest|go test) ]]; then

153 filtered_cmd="$cmd 2>&1 | grep -A 5 -E '(FAIL|ERROR|error:)' | head -100"

154 echo "{\"hookSpecificOutput\":{\"hookEventName\":\"PreToolUse\",\"permissionDecision\":\"allow\",\"updatedInput\":{\"command\":\"$filtered_cmd\"}}}"

155 else

156 echo "{}"

157 fi

158 ```

159 </Tab>

160</Tabs>

119 161

120### When cost reporting changes162### Move instructions from CLAUDE.md to skills

121 163

122If you notice changes in how costs are displayed (such as the `/cost` command showing different information):164Your [CLAUDE.md](/en/memory) file is loaded into context at session start. If it contains detailed instructions for specific workflows (like PR reviews or database migrations), those tokens are present even when you're doing unrelated work. [Skills](/en/skills) load on-demand only when invoked, so moving specialized instructions into skills keeps your base context smaller. Aim to keep CLAUDE.md under \~500 lines by including only essentials.

123 165

1241. **Verify your version**: Run `claude doctor` to confirm your current version166### Adjust extended thinking

1252. **Consult documentation**: Ask Claude directly about current feature behavior, as it has access to up-to-date documentation

1263. **Contact support**: For specific billing questions, contact Anthropic support through your Console account

127 167

128<Note>168Extended thinking is enabled by default because it significantly improves performance on complex planning and reasoning tasks. Thinking tokens are billed as output tokens, and the default budget can be tens of thousands of tokens per request depending on the model. For simpler tasks where deep reasoning isn't needed, you can reduce costs by lowering the [effort level](/en/model-config#adjust-effort-level) with `/effort` or in `/model`, disabling thinking in `/config`, or lowering the budget with `MAX_THINKING_TOKENS=8000`.

129 For team deployments, we recommend starting with a small pilot group to169

130 establish usage patterns before wider rollout.170### Delegate verbose operations to subagents

131</Note>171

172Running tests, fetching documentation, or processing log files can consume significant context. Delegate these to [subagents](/en/sub-agents#isolate-high-volume-operations) so the verbose output stays in the subagent's context while only a summary returns to your main conversation.

173

174### Manage agent team costs

175

176Agent teams use approximately 7x more tokens than standard sessions when teammates run in plan mode, because each teammate maintains its own context window and runs as a separate Claude instance. Keep team tasks small and self-contained to limit per-teammate token usage. See [agent teams](/en/agent-teams) for details.

177

178### Write specific prompts

179

180Vague requests like "improve this codebase" trigger broad scanning. Specific requests like "add input validation to the login function in auth.ts" let Claude work efficiently with minimal file reads.

181

182### Work efficiently on complex tasks

183

184For longer or more complex work, these habits help avoid wasted tokens from going down the wrong path:

185

186* **Use plan mode for complex tasks**: Press Shift+Tab to enter [plan mode](/en/common-workflows#use-plan-mode-for-safe-code-analysis) before implementation. Claude explores the codebase and proposes an approach for your approval, preventing expensive re-work when the initial direction is wrong.

187* **Course-correct early**: If Claude starts heading the wrong direction, press Escape to stop immediately. Use `/rewind` or double-tap Escape to restore conversation and code to a previous checkpoint.

188* **Give verification targets**: Include test cases, paste screenshots, or define expected output in your prompt. When Claude can verify its own work, it catches issues before you need to request fixes.

189* **Test incrementally**: Write one file, test it, then continue. This catches issues early when they're cheap to fix.

190

191## Background token usage

192

193Claude Code uses tokens for some background functionality even when idle:

194

195* **Conversation summarization**: Background jobs that summarize previous conversations for the `claude --resume` feature

196* **Command processing**: Some commands like `/cost` may generate requests to check status

197

198These background processes consume a small amount of tokens (typically under \$0.04 per session) even without active interaction.

199

200## Understanding changes in Claude Code behavior

201

202Claude Code regularly receives updates that may change how features work, including cost reporting. Run `claude --version` to check your current version. For specific billing questions, contact Anthropic support through your [Console account](https://platform.claude.com/login). For team deployments, start with a small pilot group to establish usage patterns before wider rollout.

data-usage.md +35 −33

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Data usage5# Data usage

2 6

3> Learn about Anthropic's data usage policies for Claude7> Learn about Anthropic's data usage policies for Claude

7### Data training policy11### Data training policy

8 12

9**Consumer users (Free, Pro, and Max plans)**:13**Consumer users (Free, Pro, and Max plans)**:

~~10Starting August 28, 2025, we're giving you the choice to allow your data to be used to improve future Claude models.~~14We give you the choice to allow your data to be used to improve future Claude models. We will train new models using data from Free, Pro, and Max accounts when this setting is on (including when you use Claude Code from these accounts).

~~12We will train new models using data from Free, Pro, and Max accounts when this setting is on (including when you use Claude Code from these accounts).~~

~~14* If you're a current user, you can select your preference now and your selection will immediately go into effect.~~

~~15 This setting will only apply to new or resumed chats and coding sessions on Claude. Previous chats with no additional activity will not be used for model training.~~

~~16* You have until October 8, 2025 to make your selection.~~

~~17 If you're a new user, you can pick your setting for model training during the signup process.~~

~~18 You can change your selection at any time in your Privacy Settings.~~

19 15

20**Commercial users**: (Team and Enterprise plans, API, 3rd-party platforms, and Claude Gov) maintain existing policies: Anthropic does not train generative models using code or prompts sent to Claude Code under commercial terms, unless the customer has chosen to provide their data to us for model improvement (e.g. [Developer Partner Program](https://support.claude.com/en/articles/11174108-about-the-development-partner-program)).16**Commercial users**: (Team and Enterprise plans, API, 3rd-party platforms, and Claude Gov) maintain existing policies: Anthropic does not train generative models using code or prompts sent to Claude Code under commercial terms, unless the customer has chosen to provide their data to us for model improvement (for example, the [Developer Partner Program](https://support.claude.com/en/articles/11174108-about-the-development-partner-program)).

21 17

22### Development Partner Program18### Development Partner Program

23 19

24If you explicitly opt in to methods to provide us with materials to train on, such as via the [Development Partner Program](https://support.claude.com/en/articles/11174108-about-the-development-partner-program), we may use those materials provided to train our models. An organization admin can expressly opt-in to the Development Partner Program for their organization. Note that this program is available only for Anthropic first-party API, and not for Bedrock or Vertex users.20If you explicitly opt in to methods to provide us with materials to train on, such as via the [Development Partner Program](https://support.claude.com/en/articles/11174108-about-the-development-partner-program), we may use those materials provided to train our models. An organization admin can expressly opt-in to the Development Partner Program for their organization. Note that this program is available only for Anthropic first-party API, and not for Bedrock or Vertex users.

25 21

~~26### Feedback using the `/bug` command~~22### Feedback using the `/feedback` command

27 23

~~28If you choose to send us feedback about Claude Code using the `/bug` command, we may use your feedback to improve our products and services. Transcripts shared via `/bug` are retained for 5 years.~~24If you choose to send us feedback about Claude Code using the `/feedback` command, we may use your feedback to improve our products and services. Transcripts shared via `/feedback` are retained for 5 years.

29 25

30### Session quality surveys26### Session quality surveys

31 27

32When you see the "How is Claude doing this session?" prompt in Claude Code, responding to this survey (including selecting "Dismiss"), only your numeric rating (1, 2, 3, or dismiss) is recorded. We do not collect or store any conversation transcripts, inputs, outputs, or other session data as part of this survey. Unlike thumbs up/down feedback or `/bug` reports, this session quality survey is a simple product satisfaction metric. Your responses to this survey do not impact your data training preferences and cannot be used to train our AI models.28When you see the "How is Claude doing this session?" prompt in Claude Code, responding to this survey (including selecting "Dismiss"), only your numeric rating (1, 2, 3, or dismiss) is recorded. We do not collect or store any conversation transcripts, inputs, outputs, or other session data as part of this survey. Unlike thumbs up/down feedback or `/feedback` reports, this session quality survey is a simple product satisfaction metric. Your responses to this survey do not impact your data training preferences and cannot be used to train our AI models.

30To disable these surveys, set `CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY=1`. The survey is also disabled when `DISABLE_TELEMETRY` or `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` is set. To control frequency instead of disabling, set [`feedbackSurveyRate`](/en/settings#available-settings) in your settings file to a probability between `0` and `1`.

33 31

34### Data retention32### Data retention

35 33

44**Commercial users (Team, Enterprise, and API)**:42**Commercial users (Team, Enterprise, and API)**:

45 43

46* Standard: 30-day retention period44* Standard: 30-day retention period

~~47* Zero data retention: Available with appropriately configured API keys - Claude Code will not retain chat transcripts on servers~~45* [Zero data retention](/en/zero-data-retention): available for Claude Code on Claude for Enterprise. ZDR is enabled on a per-organization basis; each new organization must have ZDR enabled separately by your account team

48* Local caching: Claude Code clients may store sessions locally for up to 30 days to enable session resumption (configurable)46* Local caching: Claude Code clients may store sessions locally for up to 30 days to enable session resumption (configurable)

49 47

48You can delete individual Claude Code on the web sessions at any time. Deleting a session permanently removes the session's event data. For instructions on how to delete sessions, see [Managing sessions](/en/claude-code-on-the-web#managing-sessions).

50Learn more about data retention practices in our [Privacy Center](https://privacy.anthropic.com/).50Learn more about data retention practices in our [Privacy Center](https://privacy.anthropic.com/).

51 51

52For full details, please review our [Commercial Terms of Service](https://www.anthropic.com/legal/commercial-terms) (for Team, Enterprise, and API users) or [Consumer Terms](https://www.anthropic.com/legal/consumer-terms) (for Free, Pro, and Max users) and [Privacy Policy](https://www.anthropic.com/legal/privacy).52For full details, please review our [Commercial Terms of Service](https://www.anthropic.com/legal/commercial-terms) (for Team, Enterprise, and API users) or [Consumer Terms](https://www.anthropic.com/legal/consumer-terms) (for Free, Pro, and Max users) and [Privacy Policy](https://www.anthropic.com/legal/privacy).

53 53

~~54## Data flow and dependencies~~54## Data access

55 55

56<img src="https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/claude-code-data-flow.png?fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=4672f138596e864633b4b7c7ae4ae812" alt="Claude Code data flow diagram" data-og-width="1597" width="1597" data-og-height="1285" height="1285" data-path="images/claude-code-data-flow.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/claude-code-data-flow.png?w=280&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=5d9bdaf7ea50fc38dc01bbde7b952835 280w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/claude-code-data-flow.png?w=560&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=525736e5860ac9f262de4b40c9c68a0e 560w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/claude-code-data-flow.png?w=840&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=5262f9d1a1d0cffb0d5944e49b2d72be 840w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/claude-code-data-flow.png?w=1100&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=ec74e6b2f87b667f6d0e2278c20944de 1100w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/claude-code-data-flow.png?w=1650&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=05f11b1d061b6ddbb69969d4e535547a 1650w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/claude-code-data-flow.png?w=2500&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=9b9cce0fb5989bd1d27f143825be73ff 2500w" />56For all first party users, you can learn more about what data is logged for [local Claude Code](#local-claude-code-data-flow-and-dependencies) and [remote Claude Code](#cloud-execution-data-flow-and-dependencies). [Remote Control](/en/remote-control) sessions follow the local data flow since all execution happens on your machine. Note for remote Claude Code, Claude accesses the repository where you initiate your Claude Code session. Claude does not access repositories that you have connected but have not started a session in.

58## Local Claude Code: Data flow and dependencies

60The diagram below shows how Claude Code connects to external services during installation and normal operation. Solid lines indicate required connections, while dashed lines represent optional or user-initiated data flows.

62<img src="https://mintcdn.com/claude-code/c5r9_6tjPMzFdDDT/images/claude-code-data-flow.svg?fit=max&auto=format&n=c5r9_6tjPMzFdDDT&q=85&s=b3f71c69d743bff63343207dfb7ad6ce" alt="Diagram showing Claude Code's external connections: install/update connects to NPM, and user requests connect to Anthropic services including Console auth, public-api, and optionally Statsig, Sentry, and bug reporting" width="720" height="520" data-path="images/claude-code-data-flow.svg" />

57 63

58Claude Code is installed from [NPM](https://www.npmjs.com/package/@anthropic-ai/claude-code). Claude Code runs locally. In order to interact with the LLM, Claude Code sends data over the network. This data includes all user prompts and model outputs. The data is encrypted in transit via TLS and is not encrypted at rest. Claude Code is compatible with most popular VPNs and LLM proxies.64Claude Code is installed from [NPM](https://www.npmjs.com/package/@anthropic-ai/claude-code). Claude Code runs locally. In order to interact with the LLM, Claude Code sends data over the network. This data includes all user prompts and model outputs. The data is encrypted in transit via TLS and is not encrypted at rest. Claude Code is compatible with most popular VPNs and LLM proxies.

59 65

60Claude Code is built on Anthropic's APIs. For details regarding our API's security controls, including our API logging procedures, please refer to compliance artifacts offered in the [Anthropic Trust Center](https://trust.anthropic.com).66Claude Code is built on Anthropic's APIs. For details regarding our API's security controls, including our API logging procedures, please refer to compliance artifacts offered in the [Anthropic Trust Center](https://trust.anthropic.com).

61 67

~~62### Cloud execution~~68### Cloud execution: Data flow and dependencies

~~64<Note>~~

~~65 The above data flow diagram and description applies to Claude Code CLI running locally on your machine. For cloud-based sessions using Claude Code on the web, see the section below.~~

~~66</Note>~~

67 69

68When using [Claude Code on the web](/en/claude-code-on-the-web), sessions run in Anthropic-managed virtual machines instead of locally. In cloud environments:70When using [Claude Code on the web](/en/claude-code-on-the-web), sessions run in Anthropic-managed virtual machines instead of locally. In cloud environments:

69 71

~~70* **Code storage**: Your repository is cloned to an isolated VM and automatically deleted after session completion~~72* **Code and data storage:** Your repository is cloned to an isolated VM. Code and session data are subject to the retention and usage policies for your account type (see Data retention section above)

~~71* **Credentials**: GitHub authentication is handled through a secure proxy; your GitHub credentials never enter the sandbox~~73* **Credentials:** GitHub authentication is handled through a secure proxy; your GitHub credentials never enter the sandbox

~~72* **Network traffic**: All outbound traffic goes through a security proxy for audit logging and abuse prevention~~74* **Network traffic:** All outbound traffic goes through a security proxy for audit logging and abuse prevention

~~73* **Data retention**: Code and session data are subject to the retention and usage policies for your account type~~75* **Session data:** Prompts, code changes, and outputs follow the same data policies as local Claude Code usage

~~74* **Session data**: Prompts, code changes, and outputs follow the same data policies as local Claude Code usage~~

75 76

76For security details about cloud execution, see [Security](/en/security#cloud-execution-security).77For security details about cloud execution, see [Security](/en/security#cloud-execution-security).

77 78

81 82

82Claude Code connects from users' machines to Sentry for operational error logging. The data is encrypted in transit using TLS and at rest using 256-bit AES encryption. Read more in the [Sentry security documentation](https://sentry.io/security/). To opt out of error logging, set the `DISABLE_ERROR_REPORTING` environment variable.83Claude Code connects from users' machines to Sentry for operational error logging. The data is encrypted in transit using TLS and at rest using 256-bit AES encryption. Read more in the [Sentry security documentation](https://sentry.io/security/). To opt out of error logging, set the `DISABLE_ERROR_REPORTING` environment variable.

83 84

84When users run the `/bug` command, a copy of their full conversation history including code is sent to Anthropic. The data is encrypted in transit and at rest. Optionally, a Github issue is created in our public repository. To opt out of bug reporting, set the `DISABLE_BUG_COMMAND` environment variable.85When users run the `/feedback` command, a copy of their full conversation history including code is sent to Anthropic. The data is encrypted in transit and at rest. Optionally, a Github issue is created in our public repository. To opt out, set the `DISABLE_FEEDBACK_COMMAND` environment variable.

85 86

86## Default behaviors by API provider87## Default behaviors by API provider

87 88

88By default, we disable all non-essential traffic (including error reporting, telemetry, and bug reporting functionality) when using Bedrock or Vertex. You can also opt out of all of these at once by setting the `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` environment variable. Here are the full default behaviors:89By default, error reporting, telemetry, and bug reporting are disabled when using Bedrock, Vertex, or Foundry. Session quality surveys are the exception and appear regardless of provider. You can opt out of all non-essential traffic, including surveys, at once by setting `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC`. Here are the full default behaviors:

89 90

91| ------------------------------- | -------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------ |92| ------------------------------------ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |

96| **Session quality surveys** | Default on.<br />`CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY=1` to disable. | Default on.<br />`CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY=1` to disable. | Default on.<br />`CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY=1` to disable. | Default on.<br />`CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY=1` to disable. |

95 97

96All environment variables can be checked into `settings.json` ([read more](/en/settings)).98All environment variables can be checked into `settings.json` ([read more](/en/settings)).

desktop.md +680 −37

Details

~~1# Claude Code on desktop~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Run Claude Code tasks locally or on secure cloud infrastructure with the Claude desktop app~~5# Use Claude Code Desktop

4 6

5<img src="https://mintcdn.com/claude-code/zEGbGSbinVtT3BLw/images/desktop-interface.png?fit=max&auto=format&n=zEGbGSbinVtT3BLw&q=85&s=c4e9dc9737b437d36ab253b75a1cc595" alt="Claude Code on desktop interface" data-og-width="4132" width="4132" data-og-height="2620" height="2620" data-path="images/desktop-interface.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/zEGbGSbinVtT3BLw/images/desktop-interface.png?w=280&fit=max&auto=format&n=zEGbGSbinVtT3BLw&q=85&s=b1a8421a544c3e8c78679fa1a7b56190 280w, https://mintcdn.com/claude-code/zEGbGSbinVtT3BLw/images/desktop-interface.png?w=560&fit=max&auto=format&n=zEGbGSbinVtT3BLw&q=85&s=79cf4ea0923098cc429198678ea50903 560w, https://mintcdn.com/claude-code/zEGbGSbinVtT3BLw/images/desktop-interface.png?w=840&fit=max&auto=format&n=zEGbGSbinVtT3BLw&q=85&s=14bcbcd569d179770fe656686ffbf6bf 840w, https://mintcdn.com/claude-code/zEGbGSbinVtT3BLw/images/desktop-interface.png?w=1100&fit=max&auto=format&n=zEGbGSbinVtT3BLw&q=85&s=b873274db1e9ff8585ba545032aa24a5 1100w, https://mintcdn.com/claude-code/zEGbGSbinVtT3BLw/images/desktop-interface.png?w=1650&fit=max&auto=format&n=zEGbGSbinVtT3BLw&q=85&s=25553dced783c3a8c2a1134a53295f7e 1650w, https://mintcdn.com/claude-code/zEGbGSbinVtT3BLw/images/desktop-interface.png?w=2500&fit=max&auto=format&n=zEGbGSbinVtT3BLw&q=85&s=9ad49e6468c2f87b1895093deeea7bb2 2500w" />7> Get more out of Claude Code Desktop: computer use, Dispatch sessions from your phone, parallel sessions with Git isolation, visual diff review, app previews, PR monitoring, connectors, and enterprise configuration.

6 8

~~7## Claude Code on desktop (Preview)~~9The Code tab within the Claude Desktop app lets you use Claude Code through a graphical interface instead of the terminal.

8 10

~~9The Claude desktop app provides a native interface for running multiple Claude Code sessions on your local machine and seamless integration with Claude Code on the web.~~11Desktop adds these capabilities on top of the standard Claude Code experience:

10 12

~~11## Features~~13* [Visual diff review](#review-changes-with-diff-view) with inline comments

14* [Live app preview](#preview-your-app) with dev servers

15* [Computer use](#let-claude-use-your-computer) to open apps and control your screen on macOS

16* [GitHub PR monitoring](#monitor-pull-request-status) with auto-fix and auto-merge

17* [Parallel sessions](#work-in-parallel-with-sessions) with automatic Git worktree isolation

18* [Dispatch](#sessions-from-dispatch) integration: send a task from your phone, get a session here

19* [Scheduled tasks](#schedule-recurring-tasks) that run Claude on a recurring schedule

20* [Connectors](#connect-external-tools) for GitHub, Slack, Linear, and more

21* Local, [SSH](#ssh-sessions), and [cloud](#run-long-running-tasks-remotely) environments

12 22

~~13Claude Code on desktop provides:~~23<Tip>

24 New to Desktop? Start with [Get started](/en/desktop-quickstart) to install the app and make your first edit.

25</Tip>

27This page covers [working with code](#work-with-code), [computer use](#let-claude-use-your-computer), [managing sessions](#manage-sessions), [extending Claude Code](#extend-claude-code), [scheduled tasks](#schedule-recurring-tasks), and [configuration](#environment-configuration). It also includes a [CLI comparison](#coming-from-the-cli) and [troubleshooting](#troubleshooting).

29## Start a session

31Before you send your first message, configure four things in the prompt area:

33* **Environment**: choose where Claude runs. Select **Local** for your machine, **Remote** for Anthropic-hosted cloud sessions, or an [**SSH connection**](#ssh-sessions) for a remote machine you manage. See [environment configuration](#environment-configuration).

34* **Project folder**: select the folder or repository Claude works in. For remote sessions, you can add [multiple repositories](#run-long-running-tasks-remotely).

35* **Model**: pick a [model](/en/model-config#available-models) from the dropdown next to the send button. The model is locked once the session starts.

36* **Permission mode**: choose how much autonomy Claude has from the [mode selector](#choose-a-permission-mode). You can change this during the session.

38Type your task and press **Enter** to start. Each session tracks its own context and changes independently.

40## Work with code

42Give Claude the right context, control how much it does on its own, and review what it changed.

44### Use the prompt box

46Type what you want Claude to do and press **Enter** to send. Claude reads your project files, makes changes, and runs commands based on your [permission mode](#choose-a-permission-mode). You can interrupt Claude at any point: click the stop button or type your correction and press **Enter**. Claude stops what it's doing and adjusts based on your input.

48The **+** button next to the prompt box gives you access to file attachments, [skills](#use-skills), [connectors](#connect-external-tools), and [plugins](#install-plugins).

50### Add files and context to prompts

52The prompt box supports two ways to bring in external context:

54* **@mention files**: type `@` followed by a filename to add a file to the conversation context. Claude can then read and reference that file. @mention is not available in remote sessions.

55* **Attach files**: attach images, PDFs, and other files to your prompt using the attachment button, or drag and drop files directly into the prompt. This is useful for sharing screenshots of bugs, design mockups, or reference documents.

57### Choose a permission mode

59Permission modes control how much autonomy Claude has during a session: whether it asks before editing files, running commands, or both. You can switch modes at any time using the mode selector next to the send button. Start with Ask permissions to see exactly what Claude does, then move to Auto accept edits or Plan mode as you get comfortable.

61| Mode | Settings key | Behavior |

62| ---------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

63| **Ask permissions** | `default` | Claude asks before editing files or running commands. You see a diff and can accept or reject each change. Recommended for new users. |

64| **Auto accept edits** | `acceptEdits` | Claude auto-accepts file edits but still asks before running terminal commands. Use this when you trust file changes and want faster iteration. |

65| **Plan mode** | `plan` | Claude analyzes your code and creates a plan without modifying files or running commands. Good for complex tasks where you want to review the approach first. |

66| **Auto** | `auto` | Claude executes all actions with background safety checks that verify alignment with your request. Reduces permission prompts while maintaining oversight. Currently a research preview. Available on Team plans (Enterprise rolling out shortly). Requires Claude Sonnet 4.6 or Opus 4.6. Enable in your Settings → Claude Code. |

67| **Bypass permissions** | `bypassPermissions` | Claude runs without any permission prompts, equivalent to `--dangerously-skip-permissions` in the CLI. Enable in your Settings → Claude Code under "Allow bypass permissions mode". Only use this in sandboxed containers or VMs. Enterprise admins can disable this option. |

69The `dontAsk` permission mode is available only in the [CLI](/en/permission-modes#allow-only-pre-approved-tools-with-dontask-mode).

71<Tip title="Best practice">

72 Start complex tasks in Plan mode so Claude maps out an approach before making changes. Once you approve the plan, switch to Auto accept edits or Ask permissions to execute it. See [explore first, then plan, then code](/en/best-practices#explore-first-then-plan-then-code) for more on this workflow.

73</Tip>

75Remote sessions support Auto accept edits and Plan mode. Ask permissions is not available because remote sessions auto-accept file edits by default, and Bypass permissions is not available because the remote environment is already sandboxed.

77Enterprise admins can restrict which permission modes are available. See [enterprise configuration](#enterprise-configuration) for details.

79### Preview your app

81Claude can start a dev server and open an embedded browser to verify its changes. This works for frontend web apps as well as backend servers: Claude can test API endpoints, view server logs, and iterate on issues it finds. In most cases, Claude starts the server automatically after editing project files. You can also ask Claude to preview at any time. By default, Claude [auto-verifies](#auto-verify-changes) changes after every edit.

83From the preview panel, you can:

85* Interact with your running app directly in the embedded browser

86* Watch Claude verify its own changes automatically: it takes screenshots, inspects the DOM, clicks elements, fills forms, and fixes issues it finds

87* Start or stop servers from the **Preview** dropdown in the session toolbar

88* Persist cookies and local storage across server restarts by selecting **Persist sessions** in the dropdown, so you don't have to re-login during development

89* Edit the server configuration or stop all servers at once

91Claude creates the initial server configuration based on your project. If your app uses a custom dev command, edit `.claude/launch.json` to match your setup. See [Configure preview servers](#configure-preview-servers) for the full reference.

93To clear saved session data, toggle **Persist preview sessions** off in Settings → Claude Code. To disable preview entirely, toggle off **Preview** in Settings → Claude Code.

14 94

~~15* **Parallel local sessions with `git` worktrees**: Run multiple Claude Code sessions simultaneously in the same repository, each with its own isolated `git` worktree~~95### Review changes with diff view

~~16* **Include `.gitignored` files in your worktrees**: Automatically copy gitignored files like `.env` to new worktrees using `.worktreeinclude`~~

~~17* **Launch Claude Code on the web**: Kick off secure cloud sessions directly from the desktop app~~

18 96

~~19## Installation~~97After Claude makes changes to your code, the diff view lets you review modifications file by file before creating a pull request.

20 98

~~21Download and install the Claude Desktop app from [claude.ai/download](https://claude.ai/download)~~99When Claude changes files, a diff stats indicator appears showing the number of lines added and removed, such as `+12 -1`. Click this indicator to open the diff viewer, which displays a file list on the left and the changes for each file on the right.

100

101To comment on specific lines, click any line in the diff to open a comment box. Type your feedback and press **Enter** to add the comment. After adding comments to multiple lines, submit all comments at once:

102

103* **macOS**: press **Cmd+Enter**

104* **Windows**: press **Ctrl+Enter**

105

106Claude reads your comments and makes the requested changes, which appear as a new diff you can review.

107

108### Review your code

109

110In the diff view, click **Review code** in the top-right toolbar to ask Claude to evaluate the changes before you commit. Claude examines the current diffs and leaves comments directly in the diff view. You can respond to any comment or ask Claude to revise.

111

112The review focuses on high-signal issues: compile errors, definite logic errors, security vulnerabilities, and obvious bugs. It does not flag style, formatting, pre-existing issues, or anything a linter would catch.

113

114### Monitor pull request status

115

116After you open a pull request, a CI status bar appears in the session. Claude Code uses the GitHub CLI to poll check results and surface failures.

117

118* **Auto-fix**: when enabled, Claude automatically attempts to fix failing CI checks by reading the failure output and iterating.

119* **Auto-merge**: when enabled, Claude merges the PR once all checks pass. The merge method is squash. Auto-merge must be [enabled in your GitHub repository settings](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository) for this to work.

120

121Use the **Auto-fix** and **Auto-merge** toggles in the CI status bar to enable either option. Claude Code also sends a desktop notification when CI finishes.

122

123<Note>

124 PR monitoring requires the [GitHub CLI (`gh`)](https://cli.github.com/) to be installed and authenticated on your machine. If `gh` is not installed, Desktop prompts you to install it the first time you try to create a PR.

125</Note>

126

127## Let Claude use your computer

128

129Computer use lets Claude open your apps, control your screen, and work directly on your machine the way you would. Ask Claude to test a native app in the iOS simulator, interact with a desktop tool that has no CLI, or automate something that only works through a GUI.

22 130

23<Note>131<Note>

~~24 Local sessions are not available on Windows arm64 architectures.~~132 Computer use is a research preview on macOS that requires a Pro or Max plan. It is not available on Team or Enterprise plans. The Claude Desktop app must be running.

25</Note>133</Note>

26 134

~~27## Using Git worktrees~~135Computer use is off by default. [Enable it in Settings](#enable-computer-use) and grant the required macOS permissions before Claude can control your screen.

136

137<Warning>

138 Unlike the [sandboxed Bash tool](/en/sandboxing), computer use runs on your actual desktop with access to whatever you approve. Claude checks each action and flags potential prompt injection from on-screen content, but the trust boundary is different. See the [computer use safety guide](https://support.claude.com/en/articles/14128542) for best practices.

139</Warning>

140

141### When computer use applies

142

143Claude has several ways to interact with an app or service, and computer use is the broadest and slowest. It tries the most precise tool first:

144

145* If you have a [connector](#connect-external-tools) for a service, Claude uses the connector.

146* If the task is a shell command, Claude uses Bash.

147* If the task is browser work and you have [Claude in Chrome](/en/chrome) set up, Claude uses that.

148* If none of those apply, Claude uses computer use.

149

150The [per-app access tiers](#app-permissions) reinforce this: browsers are capped at view-only, and terminals and IDEs at click-only, steering Claude toward the dedicated tool even when computer use is active. Screen control is reserved for things nothing else can reach, like native apps, hardware control panels, the iOS simulator, or proprietary tools without an API.

151

152### Enable computer use

153

154Computer use is off by default. If you ask Claude to do something that needs it while it's off, Claude tells you it could do the task if you enable computer use in Settings. To enable it, open **Settings > Desktop app > General** and toggle **Computer use** on. Before the toggle takes effect, you need to grant two macOS system permissions:

155

156* **Accessibility**: lets Claude click, type, and scroll

157* **Screen Recording**: lets Claude see what's on your screen

158

159The Settings page shows the current status of each permission. If either is denied, click the badge to open the relevant System Settings pane.

160

161### App permissions

162

163The first time Claude needs to use an app, a prompt appears in your session. Click **Allow for this session** or **Deny**. Approvals last for the current session, or 30 minutes in [Dispatch-spawned sessions](#sessions-from-dispatch).

164

165The prompt also shows what level of control Claude gets for that app. These tiers are fixed by app category and can't be changed:

166

167| Tier | What Claude can do | Applies to |

168| :----------- | :------------------------------------------------------- | :-------------------------- |

169| View only | See the app in screenshots | Browsers, trading platforms |

170| Click only | Click and scroll, but not type or use keyboard shortcuts | Terminals, IDEs |

171| Full control | Click, type, drag, and use keyboard shortcuts | Everything else |

28 172

29Claude Code on desktop enables running multiple Claude Code sessions in the same repository using Git worktrees. Each session gets its own isolated worktree, allowing Claude to work on different tasks without conflicts. The default location for worktrees is `~/.claude-worktrees` but this can be configured in your settings on the Claude desktop app.173Apps with broad reach like Terminal, Finder, and System Settings show an extra warning in the prompt so you know what approving them grants.

174

175You can configure two settings in **Settings > Desktop app > General**:

176

177* **Denied apps**: add apps here to reject them without prompting. Claude may still affect a denied app indirectly through actions in an allowed app, but it can't interact with the denied app directly.

178* **Unhide apps when Claude finishes**: while Claude is working, your other windows are hidden so it interacts with only the approved app. When Claude finishes, hidden windows are restored unless you turn this setting off.

179

180## Manage sessions

181

182Each session is an independent conversation with its own context and changes. You can run multiple sessions in parallel, send work to the cloud, or let Dispatch start sessions for you from your phone.

183

184### Work in parallel with sessions

185

186Click **+ New session** in the sidebar to work on multiple tasks in parallel. For Git repositories, each session gets its own isolated copy of your project using [Git worktrees](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees), so changes in one session don't affect other sessions until you commit them.

187

188Worktrees are stored in `<project-root>/.claude/worktrees/` by default. You can change this to a custom directory in Settings → Claude Code under "Worktree location". You can also set a branch prefix that gets prepended to every worktree branch name, which is useful for keeping Claude-created branches organized. To remove a worktree when you're done, hover over the session in the sidebar and click the archive icon.

30 189

31<Note>190<Note>

~~32 If you start a local session in a folder that does not have Git initialized, the desktop app will not create a new worktree.~~191 Session isolation requires [Git](https://git-scm.com/downloads). Most Macs include Git by default. Run `git --version` in Terminal to check. On Windows, Git is required for the Code tab to work: [download Git for Windows](https://git-scm.com/downloads/win), install it, and restart the app. If you run into Git errors, try a Cowork session to help troubleshoot your setup.

33</Note>192</Note>

34 193

~~35### Copying files ignored with `.gitignore`~~194Use the filter icon at the top of the sidebar to filter sessions by status (Active, Archived) and environment (Local, Cloud). To rename a session or check context usage, click the session title in the toolbar at the top of the active session. When context fills up, Claude automatically summarizes the conversation and continues working. You can also type `/compact` to trigger summarization earlier and free up context space. See [the context window](/en/how-claude-code-works#the-context-window) for details on how compaction works.

195

196### Run long-running tasks remotely

197

198For large refactors, test suites, migrations, or other long-running tasks, select **Remote** instead of **Local** when starting a session. Remote sessions run on Anthropic's cloud infrastructure and continue even if you close the app or shut down your computer. Check back anytime to see progress or steer Claude in a different direction. You can also monitor remote sessions from [claude.ai/code](https://claude.ai/code) or the Claude iOS app.

199

200Remote sessions also support multiple repositories. After selecting a cloud environment, click the **+** button next to the repo pill to add additional repositories to the session. Each repo gets its own branch selector. This is useful for tasks that span multiple codebases, such as updating a shared library and its consumers.

201

202See [Claude Code on the web](/en/claude-code-on-the-web) for more on how remote sessions work.

203

204### Continue in another surface

205

206The **Continue in** menu, accessible from the VS Code icon in the bottom right of the session toolbar, lets you move your session to another surface:

207

208* **Claude Code on the Web**: sends your local session to continue running remotely. Desktop pushes your branch, generates a summary of the conversation, and creates a new remote session with the full context. You can then choose to archive the local session or keep it. This requires a clean working tree, and is not available for SSH sessions.

209* **Your IDE**: opens your project in a supported IDE at the current working directory.

210

211### Sessions from Dispatch

212

213[Dispatch](https://support.claude.com/en/articles/13947068) is a persistent conversation with Claude that lives in the [Cowork](https://claude.com/product/cowork#dispatch-and-computer-use) tab. You message Dispatch a task, and it decides how to handle it.

214

215A task can end up as a Code session in two ways: you ask for one directly, such as "open a Claude Code session and fix the login bug", or Dispatch decides the task is development work and spawns one on its own. Tasks that typically route to Code include fixing bugs, updating dependencies, running tests, or opening pull requests. Research, document editing, and spreadsheet work stay in Cowork.

216

217Either way, the Code session appears in the Code tab's sidebar with a **Dispatch** badge. You get a push notification on your phone when it finishes or needs your approval.

218

219If you have [computer use](#let-claude-use-your-computer) enabled, Dispatch-spawned Code sessions can use it too. App approvals in those sessions expire after 30 minutes and re-prompt, rather than lasting the full session like regular Code sessions.

220

221For setup, pairing, and Dispatch settings, see the [Dispatch help article](https://support.claude.com/en/articles/13947068). Dispatch requires a Pro or Max plan and is not available on Team or Enterprise plans.

222

223Dispatch is one of several ways to work with Claude when you're away from your terminal. See [Platforms and integrations](/en/platforms#work-when-you-are-away-from-your-terminal) to compare it with Remote Control, Channels, Slack, and scheduled tasks.

224

225## Extend Claude Code

226

227Connect external services, add reusable workflows, customize Claude's behavior, and configure preview servers.

228

229### Connect external tools

230

231For local and [SSH](#ssh-sessions) sessions, click the **+** button next to the prompt box and select **Connectors** to add integrations like Google Calendar, Slack, GitHub, Linear, Notion, and more. You can add connectors before or during a session. The **+** button is not available in remote sessions, but [scheduled tasks](/en/web-scheduled-tasks) configure connectors at task creation time.

232

233To manage or disconnect connectors, go to Settings → Connectors in the desktop app, or select **Manage connectors** from the Connectors menu in the prompt box.

234

235Once connected, Claude can read your calendar, send messages, create issues, and interact with your tools directly. You can ask Claude what connectors are configured in your session.

236

237Connectors are [MCP servers](/en/mcp) with a graphical setup flow. Use them for quick integration with supported services. For integrations not listed in Connectors, add MCP servers manually via [settings files](/en/mcp#installing-mcp-servers). You can also [create custom connectors](https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp).

238

239### Use skills

36 240

37When Claude Code creates a worktree, files ignored via `.gitignore` aren't automatically available. Including a `.worktreeinclude` file solves this by specifying which ignored files should be copied to new worktrees.241[Skills](/en/skills) extend what Claude can do. Claude loads them automatically when relevant, or you can invoke one directly: type `/` in the prompt box or click the **+** button and select **Slash commands** to browse what's available. This includes [built-in commands](/en/commands), your [custom skills](/en/skills#create-custom-skills), project skills from your codebase, and skills from any [installed plugins](/en/plugins). Select one and it appears highlighted in the input field. Type your task after it and send as usual.

38 242

~~39Create a `.worktreeinclude` file in your repository root:~~243### Install plugins

40 244

245[Plugins](/en/plugins) are reusable packages that add skills, agents, hooks, MCP servers, and LSP configurations to Claude Code. You can install plugins from the desktop app without using the terminal.

246

247For local and [SSH](#ssh-sessions) sessions, click the **+** button next to the prompt box and select **Plugins** to see your installed plugins and their commands. To add a plugin, select **Add plugin** from the submenu to open the plugin browser, which shows available plugins from your configured [marketplaces](/en/plugin-marketplaces) including the official Anthropic marketplace. Select **Manage plugins** to enable, disable, or uninstall plugins.

248

249Plugins can be scoped to your user account, a specific project, or local-only. Plugins are not available for remote sessions. For the full plugin reference including creating your own plugins, see [plugins](/en/plugins).

250

251### Configure preview servers

252

253Claude automatically detects your dev server setup and stores the configuration in `.claude/launch.json` at the root of the folder you selected when starting the session. Preview uses this folder as its working directory, so if you selected a parent folder, subfolders with their own dev servers won't be detected automatically. To work with a subfolder's server, either start a session in that folder directly or add a configuration manually.

254

255To customize how your server starts, for example to use `yarn dev` instead of `npm run dev` or to change the port, edit the file manually or click **Edit configuration** in the Preview dropdown to open it in your code editor. The file supports JSON with comments.

256

257```json theme={null}

258{

259 "version": "0.0.1",

260 "configurations": [

261 {

262 "name": "my-app",

263 "runtimeExecutable": "npm",

264 "runtimeArgs": ["run", "dev"],

265 "port": 3000

266 }

267 ]

268}

41```269```

~~42.env~~270

~~43.env.local~~271You can define multiple configurations to run different servers from the same project, such as a frontend and an API. See the [examples](#examples) below.

~~44.env.*~~272

~~45**/.claude/settings.local.json~~273#### Auto-verify changes

274

275When `autoVerify` is enabled, Claude automatically verifies code changes after editing files. It takes screenshots, checks for errors, and confirms changes work before completing its response.

276

277Auto-verify is on by default. Disable it per-project by adding `"autoVerify": false` to `.claude/launch.json`, or toggle it from the **Preview** dropdown menu.

278

279```json theme={null}

280{

281 "version": "0.0.1",

282 "autoVerify": false,

283 "configurations": [...]

284}

46```285```

47 286

~~48The file uses `.gitignore`-style patterns. When a worktree is created, files matching these patterns that are also in your `.gitignore` will be copied from your main repository to the worktree.~~287When disabled, preview tools are still available and you can ask Claude to verify at any time. Auto-verify makes it automatic after every edit.

288

289#### Configuration fields

290

291Each entry in the `configurations` array accepts the following fields:

292

293| Field | Type | Description |

294| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

295| `name` | string | A unique identifier for this server |

296| `runtimeExecutable` | string | The command to run, such as `npm`, `yarn`, or `node` |

297| `runtimeArgs` | string\[] | Arguments passed to `runtimeExecutable`, such as `["run", "dev"]` |

298| `port` | number | The port your server listens on. Defaults to 3000 |

299| `cwd` | string | Working directory relative to your project root. Defaults to the project root. Use `${workspaceFolder}` to reference the project root explicitly |

300| `env` | object | Additional environment variables as key-value pairs, such as `{ "NODE_ENV": "development" }`. Don't put secrets here since this file is committed to your repo. Secrets set in your shell profile are inherited automatically. |

301| `autoPort` | boolean | How to handle port conflicts. See below |

302| `program` | string | A script to run with `node`. See [when to use `program` vs `runtimeExecutable`](#when-to-use-program-vs-runtimeexecutable) |

303| `args` | string\[] | Arguments passed to `program`. Only used when `program` is set |

304

305##### When to use `program` vs `runtimeExecutable`

306

307Use `runtimeExecutable` with `runtimeArgs` to start a dev server through a package manager. For example, `"runtimeExecutable": "npm"` with `"runtimeArgs": ["run", "dev"]` runs `npm run dev`.

308

309Use `program` when you have a standalone script you want to run with `node` directly. For example, `"program": "server.js"` runs `node server.js`. Pass additional flags with `args`.

310

311#### Port conflicts

312

313The `autoPort` field controls what happens when your preferred port is already in use:

314

315* **`true`**: Claude finds and uses a free port automatically. Suitable for most dev servers.

316* **`false`**: Claude fails with an error. Use this when your server must use a specific port, such as for OAuth callbacks or CORS allowlists.

317* **Not set (default)**: Claude asks whether the server needs that exact port, then saves your answer.

318

319When Claude picks a different port, it passes the assigned port to your server via the `PORT` environment variable.

320

321#### Examples

322

323These configurations show common setups for different project types:

324

325<Tabs>

326 <Tab title="Next.js">

327 This configuration runs a Next.js app using Yarn on port 3000:

328

329 ```json theme={null}

330 {

331 "version": "0.0.1",

332 "configurations": [

333 {

334 "name": "web",

335 "runtimeExecutable": "yarn",

336 "runtimeArgs": ["dev"],

337 "port": 3000

338 }

339 ]

340 }

341 ```

342 </Tab>

343

344 <Tab title="Multiple servers">

345 For a monorepo with a frontend and an API server, define multiple configurations. The frontend uses `autoPort: true` so it picks a free port if 3000 is taken, while the API server requires port 8080 exactly:

346

347 ```json theme={null}

348 {

349 "version": "0.0.1",

350 "configurations": [

351 {

352 "name": "frontend",

353 "runtimeExecutable": "npm",

354 "runtimeArgs": ["run", "dev"],

355 "cwd": "apps/web",

356 "port": 3000,

357 "autoPort": true

358 },

359 {

360 "name": "api",

361 "runtimeExecutable": "npm",

362 "runtimeArgs": ["run", "start"],

363 "cwd": "server",

364 "port": 8080,

365 "env": { "NODE_ENV": "development" },

366 "autoPort": false

367 }

368 ]

369 }

370 ```

371 </Tab>

372

373 <Tab title="Node.js script">

374 To run a Node.js script directly instead of using a package manager command, use the `program` field:

375

376 ```json theme={null}

377 {

378 "version": "0.0.1",

379 "configurations": [

380 {

381 "name": "server",

382 "program": "server.js",

383 "args": ["--verbose"],

384 "port": 4000

385 }

386 ]

387 }

388 ```

389 </Tab>

390</Tabs>

391

392## Schedule recurring tasks

393

394By default, scheduled tasks start a new session automatically at a time and frequency you choose. Use them for recurring work like daily code reviews, dependency update checks, or morning briefings that pull from your calendar and inbox.

395

396### Compare scheduling options

397

398Claude Code offers three ways to schedule recurring work:

399

401| :------------------------- | :------------------------------- | :---------------------------------------------- | :----------------------------- |

403| Requires machine on | No | Yes | Yes |

404| Requires open session | No | No | Yes |

405| Persistent across restarts | Yes | Yes | No (session-scoped) |

406| Access to local files | No (fresh clone) | Yes | Yes |

409| Customizable schedule | Via `/schedule` in the CLI | Yes | Yes |

411

412<Tip>

413 Use **cloud tasks** for work that should run reliably without your machine. Use **Desktop tasks** when you need access to local files and tools. Use **`/loop`** for quick polling during a session.

414</Tip>

415

416The Schedule page supports two kinds of tasks:

417

418* **Local tasks**: run on your machine. They have direct access to your local files and tools, but the desktop app must be open and your computer awake for them to run.

419* **Remote tasks**: run on Anthropic-managed cloud infrastructure. They keep running even when your computer is off, but work against a fresh clone of your repository rather than your local checkout.

420

421Both kinds appear in the same task grid. Click **New task** to pick which kind to create. The rest of this section covers local tasks; for remote tasks, see [Cloud scheduled tasks](/en/web-scheduled-tasks).

422

423See [How scheduled tasks run](#how-scheduled-tasks-run) for details on missed runs and catch-up behavior for local tasks.

424

425<Note>

426 By default, local scheduled tasks run against whatever state your working directory is in, including uncommitted changes. Enable the worktree toggle in the prompt input to give each run its own isolated Git worktree, the same way [parallel sessions](#work-in-parallel-with-sessions) work.

427</Note>

428

429To create a local scheduled task, click **Schedule** in the sidebar, click **New task**, and choose **New local task**. Configure these fields:

430

431| Field | Description |

432| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

433| Name | Identifier for the task. Converted to lowercase kebab-case and used as the folder name on disk. Must be unique across your tasks. |

434| Description | Short summary shown in the task list. |

435| Prompt | The instructions sent to Claude when the task runs. Write this the same way you'd write any message in the prompt box. The prompt input also includes controls for model, permission mode, working folder, and worktree. |

436| Frequency | How often the task runs. See [frequency options](#frequency-options) below. |

437

438You can also create a task by describing what you want in any session. For example, "set up a daily code review that runs every morning at 9am."

439

440### Frequency options

441

442* **Manual**: no schedule, only runs when you click **Run now**. Useful for saving a prompt you trigger on demand

443* **Hourly**: runs every hour. Each task gets a fixed offset of up to 10 minutes from the top of the hour to stagger API traffic

444* **Daily**: shows a time picker, defaults to 9:00 AM local time

445* **Weekdays**: same as Daily but skips Saturday and Sunday

446* **Weekly**: shows a time picker and a day picker

447

448For intervals the picker doesn't offer (every 15 minutes, first of each month, etc.), ask Claude in any Desktop session to set the schedule. Use plain language; for example, "schedule a task to run all the tests every 6 hours."

449

450### How scheduled tasks run

451

452Local scheduled tasks run on your machine. Desktop checks the schedule every minute while the app is open and starts a fresh session when a task is due, independent of any manual sessions you have open. Each task gets a fixed delay of up to 10 minutes after the scheduled time to stagger API traffic. The delay is deterministic: the same task always starts at the same offset.

453

454When a task fires, you get a desktop notification and a new session appears under a **Scheduled** section in the sidebar. Open it to see what Claude did, review changes, or respond to permission prompts. The session works like any other: Claude can edit files, run commands, create commits, and open pull requests.

455

456Tasks only run while the desktop app is running and your computer is awake. If your computer sleeps through a scheduled time, the run is skipped. To prevent idle-sleep, enable **Keep computer awake** in Settings under **Desktop app → General**. Closing the laptop lid still puts it to sleep. For tasks that need to run even when your computer is off, use a [remote task](/en/web-scheduled-tasks) instead.

457

458### Missed runs

459

460When the app starts or your computer wakes, Desktop checks whether each task missed any runs in the last seven days. If it did, Desktop starts exactly one catch-up run for the most recently missed time and discards anything older. A daily task that missed six days runs once on wake. Desktop shows a notification when a catch-up run starts.

461

462Keep this in mind when writing prompts. A task scheduled for 9am might run at 11pm if your computer was asleep all day. If timing matters, add guardrails to the prompt itself, for example: "Only review today's commits. If it's after 5pm, skip the review and just post a summary of what was missed."

463

464### Permissions for scheduled tasks

465

466Each task has its own permission mode, which you set when creating or editing the task. Allow rules from `~/.claude/settings.json` also apply to scheduled task sessions. If a task runs in Ask mode and needs to run a tool it doesn't have permission for, the run stalls until you approve it. The session stays open in the sidebar so you can answer later.

467

468To avoid stalls, click **Run now** after creating a task, watch for permission prompts, and select "always allow" for each one. Future runs of that task auto-approve the same tools without prompting. You can review and revoke these approvals from the task's detail page.

469

470### Manage scheduled tasks

471

472Click a task in the **Schedule** list to open its detail page. From here you can:

473

474* **Run now**: start the task immediately without waiting for the next scheduled time

475* **Toggle repeats**: pause or resume scheduled runs without deleting the task

476* **Edit**: change the prompt, frequency, folder, or other settings

477* **Review history**: see every past run, including ones that were skipped because your computer was asleep

478* **Review allowed permissions**: see and revoke saved tool approvals for this task from the **Always allowed** panel

479* **Delete**: remove the task and archive all sessions it created

480

481You can also manage tasks by asking Claude in any Desktop session. For example, "pause my dependency-audit task", "delete the standup-prep task", or "show me my scheduled tasks."

482

483To edit a task's prompt on disk, open `~/.claude/scheduled-tasks/<task-name>/SKILL.md` (or under [`CLAUDE_CONFIG_DIR`](/en/env-vars) if set). The file uses YAML frontmatter for `name` and `description`, with the prompt as the body. Changes take effect on the next run. Schedule, folder, model, and enabled state are not in this file: change them through the Edit form or ask Claude.

484

485## Environment configuration

486

487The environment you pick when [starting a session](#start-a-session) determines where Claude executes and how you connect:

488

489* **Local**: runs on your machine with direct access to your files

490* **Remote**: runs on Anthropic's cloud infrastructure. Sessions continue even if you close the app.

491* **SSH**: runs on a remote machine you connect to over SSH, such as your own servers, cloud VMs, or dev containers

492

493### Local sessions

494

495Local sessions inherit environment variables from your shell. If you need additional variables, set them in your shell profile, such as `~/.zshrc` or `~/.bashrc`, and restart the desktop app. See [environment variables](/en/env-vars) for the full list of supported variables.

496

497[Extended thinking](/en/common-workflows#use-extended-thinking-thinking-mode) is enabled by default, which improves performance on complex reasoning tasks but uses additional tokens. To disable thinking entirely, set `MAX_THINKING_TOKENS=0` in your shell profile. On Opus, `MAX_THINKING_TOKENS` is ignored except for `0` because adaptive reasoning controls thinking depth instead.

498

499### Remote sessions

500

501Remote sessions continue in the background even if you close the app. Usage counts toward your [subscription plan limits](/en/costs) with no separate compute charges.

502

503You can create custom cloud environments with different network access levels and environment variables. Select the environment dropdown when starting a remote session and choose **Add environment**. See [cloud environments](/en/claude-code-on-the-web#cloud-environment) for details on configuring network access and environment variables.

504

505### SSH sessions

506

507SSH sessions let you run Claude Code on a remote machine while using the desktop app as your interface. This is useful for working with codebases that live on cloud VMs, dev containers, or servers with specific hardware or dependencies.

508

509To add an SSH connection, click the environment dropdown before starting a session and select **+ Add SSH connection**. The dialog asks for:

510

511* **Name**: a friendly label for this connection

512* **SSH Host**: `user@hostname` or a host defined in `~/.ssh/config`

513* **SSH Port**: defaults to 22 if left empty, or uses the port from your SSH config

514* **Identity File**: path to your private key, such as `~/.ssh/id_rsa`. Leave empty to use the default key or your SSH config.

515

516Once added, the connection appears in the environment dropdown. Select it to start a session on that machine. Claude runs on the remote machine with access to its files and tools.

517

518Claude Code must be installed on the remote machine. Once connected, SSH sessions support permission modes, connectors, plugins, and MCP servers.

519

520## Enterprise configuration

521

522Organizations on Teams or Enterprise plans can manage desktop app behavior through admin console controls, managed settings files, and device management policies.

523

524### Admin console controls

525

526These settings are configured through the [admin settings console](https://claude.ai/admin-settings/claude-code):

527

528* **Code in the desktop**: control whether users in your organization can access Claude Code in the desktop app

529* **Code in the web**: enable or disable [web sessions](/en/claude-code-on-the-web) for your organization

530* **Remote Control**: enable or disable [Remote Control](/en/remote-control) for your organization

531* **Disable Bypass permissions mode**: prevent users in your organization from enabling bypass permissions mode

532

533### Managed settings

534

535Managed settings override project and user settings and apply when Desktop spawns CLI sessions. You can set these keys in your organization's [managed settings](/en/settings#settings-precedence) file or push them remotely through the admin console.

536

537| Key | Description |

538| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

539| `permissions.disableBypassPermissionsMode` | set to `"disable"` to prevent users from enabling Bypass permissions mode. |

540| `disableAutoMode` | set to `"disable"` to prevent users from enabling [Auto](/en/permission-modes#eliminate-prompts-with-auto-mode) mode. Removes Auto from the mode selector. Also accepted under `permissions`. |

541| `autoMode` | customize what the auto mode classifier trusts and blocks across your organization. See [Configure the auto mode classifier](/en/permissions#configure-the-auto-mode-classifier). |

542

543`permissions.disableBypassPermissionsMode` and `disableAutoMode` also work in user and project settings, but placing them in managed settings prevents users from overriding them. `autoMode` is read from user settings, `.claude/settings.local.json`, and managed settings, but not from the checked-in `.claude/settings.json`: a cloned repo cannot inject its own classifier rules. For the complete list of managed-only settings including `allowManagedPermissionRulesOnly` and `allowManagedHooksOnly`, see [managed-only settings](/en/permissions#managed-only-settings).

544

545Remote managed settings uploaded through the admin console currently apply to CLI and IDE sessions only. For Desktop-specific restrictions, use the admin console controls above.

546

547### Device management policies

548

549IT teams can manage the desktop app through MDM on macOS or group policy on Windows. Available policies include enabling or disabling the Claude Code feature, controlling auto-updates, and setting a custom deployment URL.

550

551* **macOS**: configure via `com.anthropic.Claude` preference domain using tools like Jamf or Kandji

552* **Windows**: configure via registry at `SOFTWARE\Policies\Claude`

553

554### Authentication and SSO

555

556Enterprise organizations can require SSO for all users. See [authentication](/en/authentication) for plan-level details and [Setting up SSO](https://support.claude.com/en/articles/13132885-setting-up-single-sign-on-sso) for SAML and OIDC configuration.

557

558### Data handling

559

560Claude Code processes your code locally in local sessions or on Anthropic's cloud infrastructure in remote sessions. Conversations and code context are sent to Anthropic's API for processing. See [data handling](/en/data-usage) for details on data retention, privacy, and compliance.

561

562### Deployment

563

564Desktop can be distributed through enterprise deployment tools:

565

566* **macOS**: distribute via MDM such as Jamf or Kandji using the `.dmg` installer

567* **Windows**: deploy via MSIX package or `.exe` installer. See [Deploy Claude Desktop for Windows](https://support.claude.com/en/articles/12622703-deploy-claude-desktop-for-windows) for enterprise deployment options including silent installation

568

569For network configuration such as proxy settings, firewall allowlisting, and LLM gateways, see [network configuration](/en/network-config).

570

571For the full enterprise configuration reference, see the [enterprise configuration guide](https://support.claude.com/en/articles/12622667-enterprise-configuration).

572

573## Coming from the CLI?

574

575If you already use the Claude Code CLI, Desktop runs the same underlying engine with a graphical interface. You can run both simultaneously on the same machine, even on the same project. Each maintains separate session history, but they share configuration and project memory via CLAUDE.md files.

576

577To move a CLI session into Desktop, run `/desktop` in the terminal. Claude saves your session and opens it in the desktop app, then exits the CLI. This command is available on macOS and Windows only.

49 578

50<Tip>579<Tip>

~~51 Only files that are both matched by `.worktreeinclude` AND listed in `.gitignore` are copied. This prevents accidentally duplicating tracked files.~~580 When to use Desktop vs CLI: use Desktop when you want visual diff review, file attachments, or session management in a sidebar. Use the CLI when you need scripting, automation, third-party providers, or prefer a terminal workflow.

52</Tip>581</Tip>

53 582

~~54### Launch Claude Code on the web~~583### CLI flag equivalents

55 584

~~56From the desktop app, you can kick off Claude Code sessions that run on Anthropic's secure cloud infrastructure. This is useful for:~~585This table shows the desktop app equivalent for common CLI flags. Flags not listed have no desktop equivalent because they are designed for scripting or automation.

57 586

~~58To start a web session from desktop, select a remote environment when creating a new session.~~587| CLI | Desktop equivalent |

588| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

589| `--model sonnet` | Model dropdown next to the send button, before starting a session |

590| `--resume`, `--continue` | Click a session in the sidebar |

591| `--permission-mode` | Mode selector next to the send button |

592| `--dangerously-skip-permissions` | Bypass permissions mode. Enable in Settings → Claude Code → "Allow bypass permissions mode". Enterprise admins can disable this setting. |

593| `--add-dir` | Add multiple repos with the **+** button in remote sessions |

594| `--allowedTools`, `--disallowedTools` | Not available in Desktop |

595| `--verbose` | Not available. Check system logs: Console.app on macOS, Event Viewer → Windows Logs → Application on Windows |

596| `--print`, `--output-format` | Not available. Desktop is interactive only. |

597| `ANTHROPIC_MODEL` env var | Model dropdown next to the send button |

598| `MAX_THINKING_TOKENS` env var | Set in shell profile; applies to local sessions. See [environment configuration](#environment-configuration). |

59 599

~~60For more details, see [Claude Code on the web](/en/claude-code-on-the-web).~~600### Shared configuration

61 601

~~62## Bundled Claude Code version~~602Desktop and CLI read the same configuration files, so your setup carries over:

63 603

64Claude Code on desktop includes a bundled, stable version of Claude Code to ensure a consistent experience for all desktop users. The bundled version is required and downloaded on first launch even if a version of Claude Code exists on the computer. Desktop automatically manages version updates and cleans up old versions.604* **[CLAUDE.md](/en/memory)** files in your project are used by both

605* **[MCP servers](/en/mcp)** configured in `~/.claude.json` or `.mcp.json` work in both

606* **[Hooks](/en/hooks)** and **[skills](/en/skills)** defined in settings apply to both

607* **[Settings](/en/settings)** in `~/.claude.json` and `~/.claude/settings.json` are shared. Permission rules, allowed tools, and other settings in `settings.json` apply to Desktop sessions.

608* **Models**: Sonnet, Opus, and Haiku are available in both. In Desktop, select the model from the dropdown next to the send button before starting a session. You cannot change the model during an active session.

65 609

66<Note>610<Note>

~~67 The bundled Claude Code version in Desktop may differ from the latest CLI version. Desktop prioritizes stability while the CLI may have newer features.~~611 **MCP servers: desktop chat app vs Claude Code**: MCP servers configured for the Claude Desktop chat app in `claude_desktop_config.json` are separate from Claude Code and will not appear in the Code tab. To use MCP servers in Claude Code, configure them in `~/.claude.json` or your project's `.mcp.json` file. See [MCP configuration](/en/mcp#installing-mcp-servers) for details.

68</Note>612</Note>

69 613

~~70## Related resources~~614### Feature comparison

615

616This table compares core capabilities between the CLI and Desktop. For a full list of CLI flags, see the [CLI reference](/en/cli-reference).

617

618| Feature | CLI | Desktop |

619| ----------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------- |

620| Permission modes | All modes including `dontAsk` | Ask permissions, Auto accept edits, Plan mode, Auto, and Bypass permissions via Settings |

621| `--dangerously-skip-permissions` | CLI flag | Bypass permissions mode. Enable in Settings → Claude Code → "Allow bypass permissions mode" |

622| [Third-party providers](/en/third-party-integrations) | Bedrock, Vertex, Foundry | Not available. Desktop connects to Anthropic's API directly. |

623| [MCP servers](/en/mcp) | Configure in settings files | Connectors UI for local and SSH sessions, or settings files |

624| [Plugins](/en/plugins) | `/plugin` command | Plugin manager UI |

625| @mention files | Text-based | With autocomplete; local and SSH sessions only |

626| File attachments | Not available | Images, PDFs |

627| Session isolation | [`--worktree`](/en/cli-reference) flag | Automatic worktrees |

628| Multiple sessions | Separate terminals | Sidebar tabs |

629| Recurring tasks | Cron jobs, CI pipelines | [Scheduled tasks](#schedule-recurring-tasks) |

630| Computer use | Not available | [App and screen control](#let-claude-use-your-computer) on macOS |

631| Dispatch integration | Not available | [Dispatch sessions](#sessions-from-dispatch) in the sidebar |

632| Scripting and automation | [`--print`](/en/cli-reference), [Agent SDK](/en/headless) | Not available |

633

634### What's not available in Desktop

635

636The following features are only available in the CLI or VS Code extension:

637

638* **Third-party providers**: Desktop connects to Anthropic's API directly. Use the [CLI](/en/quickstart) with Bedrock, Vertex, or Foundry instead.

639* **Linux**: the desktop app is available on macOS and Windows only.

640* **Inline code suggestions**: Desktop does not provide autocomplete-style suggestions. It works through conversational prompts and explicit code changes.

641* **Agent teams**: multi-agent orchestration is available via the [CLI](/en/agent-teams) and [Agent SDK](/en/headless), not in Desktop.

642

643## Troubleshooting

644

645### Check your version

646

647To see which version of the desktop app you're running:

648

649* **macOS**: click **Claude** in the menu bar, then **About Claude**

650* **Windows**: click **Help**, then **About**

651

652Click the version number to copy it to your clipboard.

653

654### 403 or authentication errors in the Code tab

655

656If you see `Error 403: Forbidden` or other authentication failures when using the Code tab:

657

6581. Sign out and back in from the app menu. This is the most common fix.

6592. Verify you have an active paid subscription: Pro, Max, Teams, or Enterprise.

6603. If the CLI works but Desktop does not, quit the desktop app completely, not just close the window, then reopen and sign in again.

6614. Check your internet connection and proxy settings.

662

663### Blank or stuck screen on launch

664

665If the app opens but shows a blank or unresponsive screen:

666

6671. Restart the app.

6682. Check for pending updates. The app auto-updates on launch.

6693. On Windows, check Event Viewer for crash logs under **Windows Logs → Application**.

670

671### "Failed to load session"

672

673If you see `Failed to load session`, the selected folder may no longer exist, a Git repository may require Git LFS that isn't installed, or file permissions may prevent access. Try selecting a different folder or restarting the app.

674

675### Session not finding installed tools

676

677If Claude can't find tools like `npm`, `node`, or other CLI commands, verify the tools work in your regular terminal, check that your shell profile properly sets up PATH, and restart the desktop app to reload environment variables.

678

679### Git and Git LFS errors

680

681On Windows, Git is required for the Code tab to start local sessions. If you see "Git is required," install [Git for Windows](https://git-scm.com/downloads/win) and restart the app.

682

683If you see "Git LFS is required by this repository but is not installed," install Git LFS from [git-lfs.com](https://git-lfs.com/), run `git lfs install`, and restart the app.

684

685### MCP servers not working on Windows

686

687If MCP server toggles don't respond or servers fail to connect on Windows, check that the server is properly configured in your settings, restart the app, verify the server process is running in Task Manager, and review server logs for connection errors.

688

689### App won't quit

690

691* **macOS**: press Cmd+Q. If the app doesn't respond, use Force Quit with Cmd+Option+Esc, select Claude, and click Force Quit.

692* **Windows**: use Task Manager with Ctrl+Shift+Esc to end the Claude process.

693

694### Windows-specific issues

695

696* **PATH not updated after install**: open a new terminal window. PATH updates only apply to new terminal sessions.

697* **Concurrent installation error**: if you see an error about another installation in progress but there isn't one, try running the installer as Administrator.

698* **ARM64**: Windows ARM64 devices are fully supported.

699

700### Cowork tab unavailable on Intel Macs

701

702The Cowork tab requires Apple Silicon (M1 or later) on macOS. On Windows, Cowork is available on all supported hardware. The Chat and Code tabs work normally on Intel Macs.

703

704### "Branch doesn't exist yet" when opening in CLI

705

706Remote sessions can create branches that don't exist on your local machine. Click the branch name in the session toolbar to copy it, then fetch it locally:

707

708```bash theme={null}

709git fetch origin <branch-name>

710git checkout <branch-name>

711```

712

713### Still stuck?

714

715* Search or file a bug on [GitHub Issues](https://github.com/anthropics/claude-code/issues)

716* Visit the [Claude support center](https://support.claude.com/)

71 717

~~72* [Claude Code on the web](/en/claude-code-on-the-web)~~718When filing a bug, include your desktop app version, your operating system, the exact error message, and relevant logs. On macOS, check Console.app. On Windows, check Event Viewer → Windows Logs → Application.

~~73* [Claude Desktop support articles](https://support.claude.com/en/collections/16163169-claude-desktop)~~

~~74* [Common workflows](/en/common-workflows)~~

~~75* [Settings reference](/en/settings)~~

desktop-quickstart.md +139 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Get started with the desktop app

7> Install Claude Code on desktop and start your first coding session

9The desktop app gives you Claude Code with a graphical interface: visual diff review, live app preview, GitHub PR monitoring with auto-merge, parallel sessions with Git worktree isolation, scheduled tasks, and the ability to run tasks remotely. No terminal required.

11This page walks through installing the app and starting your first session. If you're already set up, see [Use Claude Code Desktop](/en/desktop) for the full reference.

13<Frame>

14 <img src="https://mintcdn.com/claude-code/CNLUpFGiXoc9mhvD/images/desktop-code-tab-light.png?fit=max&auto=format&n=CNLUpFGiXoc9mhvD&q=85&s=9a36a7a27b9f4c6f2e1c83bdb34f69ce" className="block dark:hidden" alt="The Claude Code Desktop interface showing the Code tab selected, with a prompt box, permission mode selector set to Ask permissions, model picker, folder selector, and Local environment option" width="2500" height="1376" data-path="images/desktop-code-tab-light.png" />

16 <img src="https://mintcdn.com/claude-code/CNLUpFGiXoc9mhvD/images/desktop-code-tab-dark.png?fit=max&auto=format&n=CNLUpFGiXoc9mhvD&q=85&s=5463defe81c459fb9b1f91f6a958cfb8" className="hidden dark:block" alt="The Claude Code Desktop interface in dark mode showing the Code tab selected, with a prompt box, permission mode selector set to Ask permissions, model picker, folder selector, and Local environment option" width="2504" height="1374" data-path="images/desktop-code-tab-dark.png" />

17</Frame>

19The desktop app has three tabs:

21* **Chat**: General conversation with no file access, similar to claude.ai.

22* **Cowork**: An autonomous background agent that works on tasks in a cloud VM with its own environment. It can run independently while you do other work.

23* **Code**: An interactive coding assistant with direct access to your local files. You review and approve each change in real time.

25Chat and Cowork are covered in the [Claude Desktop support articles](https://support.claude.com/en/collections/16163169-claude-desktop). This page focuses on the **Code** tab.

27<Note>

28 Claude Code requires a [Pro, Max, Teams, or Enterprise subscription](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=desktop_quickstart_pricing).

29</Note>

31## Install

33<Steps>

34 <Step title="Download the app">

35 Download Claude for your platform.

37 <CardGroup cols={2}>

38 <Card title="macOS" icon="apple" href="https://claude.ai/api/desktop/darwin/universal/dmg/latest/redirect?utm_source=claude_code&utm_medium=docs">

39 Universal build for Intel and Apple Silicon

40 </Card>

42 <Card title="Windows" icon="windows" href="https://claude.ai/api/desktop/win32/x64/exe/latest/redirect?utm_source=claude_code&utm_medium=docs">

43 For x64 processors

44 </Card>

45 </CardGroup>

47 For Windows ARM64, [download here](https://claude.ai/api/desktop/win32/arm64/exe/latest/redirect?utm_source=claude_code\&utm_medium=docs).

49 Linux is not currently supported.

50 </Step>

52 <Step title="Sign in">

53 Launch Claude from your Applications folder (macOS) or Start menu (Windows). Sign in with your Anthropic account.

54 </Step>

56 <Step title="Open the Code tab">

57 Click the **Code** tab at the top center. If clicking Code prompts you to upgrade, you need to [subscribe to a paid plan](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=desktop_quickstart_upgrade) first. If it prompts you to sign in online, complete the sign-in and restart the app. If you see a 403 error, see [authentication troubleshooting](/en/desktop#403-or-authentication-errors-in-the-code-tab).

58 </Step>

59</Steps>

61The desktop app includes Claude Code. You don't need to install Node.js or the CLI separately. To use `claude` from the terminal, install the CLI separately. See [Get started with the CLI](/en/quickstart).

63## Start your first session

65With the Code tab open, choose a project and give Claude something to do.

67<Steps>

68 <Step title="Choose an environment and folder">

69 Select **Local** to run Claude on your machine using your files directly. Click **Select folder** and choose your project directory.

71 <Tip>

72 Start with a small project you know well. It's the fastest way to see what Claude Code can do. On Windows, [Git](https://git-scm.com/downloads/win) must be installed for local sessions to work. Most Macs include Git by default.

73 </Tip>

75 You can also select:

77 * **Remote**: Run sessions on Anthropic's cloud infrastructure that continue even if you close the app. Remote sessions use the same infrastructure as [Claude Code on the web](/en/claude-code-on-the-web).

78 * **SSH**: Connect to a remote machine over SSH (your own servers, cloud VMs, or dev containers). Claude Code must be installed on the remote machine.

79 </Step>

81 <Step title="Choose a model">

82 Select a model from the dropdown next to the send button. See [models](/en/model-config#available-models) for a comparison of Opus, Sonnet, and Haiku. You cannot change the model after the session starts.

83 </Step>

85 <Step title="Tell Claude what to do">

86 Type what you want Claude to do:

88 * `Find a TODO comment and fix it`

89 * `Add tests for the main function`

90 * `Create a CLAUDE.md with instructions for this codebase`

92 A [session](/en/desktop#work-in-parallel-with-sessions) is a conversation with Claude about your code. Each session tracks its own context and changes, so you can work on multiple tasks without them interfering with each other.

93 </Step>

95 <Step title="Review and accept changes">

96 By default, the Code tab starts in [Ask permissions mode](/en/desktop#choose-a-permission-mode), where Claude proposes changes and waits for your approval before applying them. You'll see:

98 1. A [diff view](/en/desktop#review-changes-with-diff-view) showing exactly what will change in each file

99 2. Accept/Reject buttons to approve or decline each change

100 3. Real-time updates as Claude works through your request

101

102 If you reject a change, Claude will ask how you'd like to proceed differently. Your files aren't modified until you accept.

103 </Step>

104</Steps>

105

106## Now what?

107

108You've made your first edit. For the full reference on everything Desktop can do, see [Use Claude Code Desktop](/en/desktop). Here are some things to try next.

109

110**Interrupt and steer.** You can interrupt Claude at any point. If it's going down the wrong path, click the stop button or type your correction and press **Enter**. Claude stops what it's doing and adjusts based on your input. You don't have to wait for it to finish or start over.

111

112**Give Claude more context.** Type `@filename` in the prompt box to pull a specific file into the conversation, attach images and PDFs using the attachment button, or drag and drop files directly into the prompt. The more context Claude has, the better the results. See [Add files and context](/en/desktop#add-files-and-context-to-prompts).

113

114**Use skills for repeatable tasks.** Type `/` or click **+** → **Slash commands** to browse [built-in commands](/en/commands), [custom skills](/en/skills), and plugin skills. Skills are reusable prompts you can invoke whenever you need them, like code review checklists or deployment steps.

115

116**Review changes before committing.** After Claude edits files, a `+12 -1` indicator appears. Click it to open the [diff view](/en/desktop#review-changes-with-diff-view), review modifications file by file, and comment on specific lines. Claude reads your comments and revises. Click **Review code** to have Claude evaluate the diffs itself and leave inline suggestions.

117

118**Adjust how much control you have.** Your [permission mode](/en/desktop#choose-a-permission-mode) controls the balance. Ask permissions (default) requires approval before every edit. Auto accept edits auto-accepts file edits for faster iteration. Plan mode lets Claude map out an approach without touching any files, which is useful before a large refactor.

119

120**Add plugins for more capabilities.** Click the **+** button next to the prompt box and select **Plugins** to browse and install [plugins](/en/desktop#install-plugins) that add skills, agents, MCP servers, and more.

121

122**Preview your app.** Click the **Preview** dropdown to run your dev server directly in the desktop. Claude can view the running app, test endpoints, inspect logs, and iterate on what it sees. See [Preview your app](/en/desktop#preview-your-app).

123

124**Track your pull request.** After opening a PR, Claude Code monitors CI check results and can automatically fix failures or merge the PR once all checks pass. See [Monitor pull request status](/en/desktop#monitor-pull-request-status).

125

126**Put Claude on a schedule.** Set up [scheduled tasks](/en/desktop#schedule-recurring-tasks) to run Claude automatically on a recurring basis: a daily code review every morning, a weekly dependency audit, or a briefing that pulls from your connected tools.

127

128**Scale up when you're ready.** Open [parallel sessions](/en/desktop#work-in-parallel-with-sessions) from the sidebar to work on multiple tasks at once, each in its own Git worktree. Send [long-running work to the cloud](/en/desktop#run-long-running-tasks-remotely) so it continues even if you close the app, or [continue a session on the web or in your IDE](/en/desktop#continue-in-another-surface) if a task takes longer than expected. [Connect external tools](/en/desktop#extend-claude-code) like GitHub, Slack, and Linear to bring your workflow together.

129

130## Coming from the CLI?

131

132Desktop runs the same engine as the CLI with a graphical interface. You can run both simultaneously on the same project, and they share configuration (CLAUDE.md files, MCP servers, hooks, skills, and settings). For a full comparison of features, flag equivalents, and what's not available in Desktop, see [CLI comparison](/en/desktop#coming-from-the-cli).

133

134## What's next

135

136* [Use Claude Code Desktop](/en/desktop): permission modes, parallel sessions, diff view, connectors, and enterprise configuration

137* [Troubleshooting](/en/desktop#troubleshooting): solutions to common errors and setup issues

138* [Best practices](/en/best-practices): tips for writing effective prompts and getting the most out of Claude Code

139* [Common workflows](/en/common-workflows): tutorials for debugging, refactoring, testing, and more

devcontainer.md +5 −1

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Development containers5# Development containers

2 6

3> Learn about the Claude Code development container for teams that need consistent, secure environments.7> Learn about the Claude Code development container for teams that need consistent, secure environments.

8 12

9<Warning>13<Warning>

10 While the devcontainer provides substantial protections, no system is completely immune to all attacks.14 While the devcontainer provides substantial protections, no system is completely immune to all attacks.

~~11 When executed with `--dangerously-skip-permissions`, devcontainers do not prevent a malicious project from exfiltrating anything accessible in the devcontainer including Claude Code credentials.~~15 When executed with `--dangerously-skip-permissions`, devcontainers don't prevent a malicious project from exfiltrating anything accessible in the devcontainer including Claude Code credentials.

12 We recommend only using devcontainers when developing with trusted repositories.16 We recommend only using devcontainers when developing with trusted repositories.

13 Always maintain good security practices and monitor Claude's activities.17 Always maintain good security practices and monitor Claude's activities.

14</Warning>18</Warning>

discover-plugins.md +427 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Discover and install prebuilt plugins through marketplaces

7> Find and install plugins from marketplaces to extend Claude Code with new commands, agents, and capabilities.

9Plugins extend Claude Code with skills, agents, hooks, and MCP servers. Plugin marketplaces are catalogs that help you discover and install these extensions without building them yourself.

11Looking to create and distribute your own marketplace? See [Create and distribute a plugin marketplace](/en/plugin-marketplaces).

13## How marketplaces work

15A marketplace is a catalog of plugins that someone else has created and shared. Using a marketplace is a two-step process:

17<Steps>

18 <Step title="Add the marketplace">

19 This registers the catalog with Claude Code so you can browse what's available. No plugins are installed yet.

20 </Step>

22 <Step title="Install individual plugins">

23 Browse the catalog and install the plugins you want.

24 </Step>

25</Steps>

27Think of it like adding an app store: adding the store gives you access to browse its collection, but you still choose which apps to download individually.

29## Official Anthropic marketplace

31The official Anthropic marketplace (`claude-plugins-official`) is automatically available when you start Claude Code. Run `/plugin` and go to the **Discover** tab to browse what's available, or view the catalog at [claude.com/plugins](https://claude.com/plugins).

33To install a plugin from the official marketplace, use `/plugin install <name>@claude-plugins-official`. For example, to install the GitHub integration:

35```shell theme={null}

36/plugin install github@claude-plugins-official

37```

39<Note>

40 The official marketplace is maintained by Anthropic. To submit a plugin to the official marketplace, use one of the in-app submission forms:

42 * **Claude.ai**: [claude.ai/settings/plugins/submit](https://claude.ai/settings/plugins/submit)

43 * **Console**: [platform.claude.com/plugins/submit](https://platform.claude.com/plugins/submit)

45 To distribute plugins independently, [create your own marketplace](/en/plugin-marketplaces) and share it with users.

46</Note>

48The official marketplace includes several categories of plugins:

50### Code intelligence

52Code intelligence plugins enable Claude Code's built-in LSP tool, giving Claude the ability to jump to definitions, find references, and see type errors immediately after edits. These plugins configure [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) connections, the same technology that powers VS Code's code intelligence.

54These plugins require the language server binary to be installed on your system. If you already have a language server installed, Claude may prompt you to install the corresponding plugin when you open a project.

56| Language | Plugin | Binary required |

57| :--------- | :------------------ | :--------------------------- |

58| C/C++ | `clangd-lsp` | `clangd` |

59| C# | `csharp-lsp` | `csharp-ls` |

60| Go | `gopls-lsp` | `gopls` |

61| Java | `jdtls-lsp` | `jdtls` |

62| Kotlin | `kotlin-lsp` | `kotlin-language-server` |

63| Lua | `lua-lsp` | `lua-language-server` |

64| PHP | `php-lsp` | `intelephense` |

65| Python | `pyright-lsp` | `pyright-langserver` |

66| Rust | `rust-analyzer-lsp` | `rust-analyzer` |

67| Swift | `swift-lsp` | `sourcekit-lsp` |

68| TypeScript | `typescript-lsp` | `typescript-language-server` |

70You can also [create your own LSP plugin](/en/plugins-reference#lsp-servers) for other languages.

72<Note>

73 If you see `Executable not found in $PATH` in the `/plugin` Errors tab after installing a plugin, install the required binary from the table above.

74</Note>

76#### What Claude gains from code intelligence plugins

78Once a code intelligence plugin is installed and its language server binary is available, Claude gains two capabilities:

80* **Automatic diagnostics**: after every file edit Claude makes, the language server analyzes the changes and reports errors and warnings back automatically. Claude sees type errors, missing imports, and syntax issues without needing to run a compiler or linter. If Claude introduces an error, it notices and fixes the issue in the same turn. This requires no configuration beyond installing the plugin. You can see diagnostics inline by pressing **Ctrl+O** when the "diagnostics found" indicator appears.

81* **Code navigation**: Claude can use the language server to jump to definitions, find references, get type info on hover, list symbols, find implementations, and trace call hierarchies. These operations give Claude more precise navigation than grep-based search, though availability may vary by language and environment.

83If you run into issues, see [Code intelligence troubleshooting](#code-intelligence-issues).

85### External integrations

87These plugins bundle pre-configured [MCP servers](/en/mcp) so you can connect Claude to external services without manual setup:

89* **Source control**: `github`, `gitlab`

90* **Project management**: `atlassian` (Jira/Confluence), `asana`, `linear`, `notion`

91* **Design**: `figma`

92* **Infrastructure**: `vercel`, `firebase`, `supabase`

93* **Communication**: `slack`

94* **Monitoring**: `sentry`

96### Development workflows

98Plugins that add commands and agents for common development tasks:

100* **commit-commands**: Git commit workflows including commit, push, and PR creation

101* **pr-review-toolkit**: Specialized agents for reviewing pull requests

102* **agent-sdk-dev**: Tools for building with the Claude Agent SDK

103* **plugin-dev**: Toolkit for creating your own plugins

104

105### Output styles

106

107Customize how Claude responds:

108

109* **explanatory-output-style**: Educational insights about implementation choices

110* **learning-output-style**: Interactive learning mode for skill building

111

112## Try it: add the demo marketplace

113

114Anthropic also maintains a [demo plugins marketplace](https://github.com/anthropics/claude-code/tree/main/plugins) (`claude-code-plugins`) with example plugins that show what's possible with the plugin system. Unlike the official marketplace, you need to add this one manually.

115

116<Steps>

117 <Step title="Add the marketplace">

118 From within Claude Code, run the `plugin marketplace add` command for the `anthropics/claude-code` marketplace:

119

120 ```shell theme={null}

121 /plugin marketplace add anthropics/claude-code

122 ```

123

124 This downloads the marketplace catalog and makes its plugins available to you.

125 </Step>

126

127 <Step title="Browse available plugins">

128 Run `/plugin` to open the plugin manager. This opens a tabbed interface with four tabs you can cycle through using **Tab** (or **Shift+Tab** to go backward):

129

130 * **Discover**: browse available plugins from all your marketplaces

131 * **Installed**: view and manage your installed plugins

132 * **Marketplaces**: add, remove, or update your added marketplaces

133 * **Errors**: view any plugin loading errors

134

135 Go to the **Discover** tab to see plugins from the marketplace you just added.

136 </Step>

137

138 <Step title="Install a plugin">

139 Select a plugin to view its details, then choose an installation scope:

140

141 * **User scope**: install for yourself across all projects

142 * **Project scope**: install for all collaborators on this repository

143 * **Local scope**: install for yourself in this repository only

144

145 For example, select **commit-commands** (a plugin that adds git workflow commands) and install it to your user scope.

146

147 You can also install directly from the command line:

148

149 ```shell theme={null}

150 /plugin install commit-commands@anthropics-claude-code

151 ```

152

153 See [Configuration scopes](/en/settings#configuration-scopes) to learn more about scopes.

154 </Step>

155

156 <Step title="Use your new plugin">

157 After installing, run `/reload-plugins` to activate the plugin. Plugin commands are namespaced by the plugin name, so **commit-commands** provides commands like `/commit-commands:commit`.

158

159 Try it out by making a change to a file and running:

160

161 ```shell theme={null}

162 /commit-commands:commit

163 ```

164

165 This stages your changes, generates a commit message, and creates the commit.

166

167 Each plugin works differently. Check the plugin's description in the **Discover** tab or its homepage to learn what commands and capabilities it provides.

168 </Step>

169</Steps>

170

171The rest of this guide covers all the ways you can add marketplaces, install plugins, and manage your configuration.

172

173## Add marketplaces

174

175Use the `/plugin marketplace add` command to add marketplaces from different sources.

176

177<Tip>

178 **Shortcuts**: You can use `/plugin market` instead of `/plugin marketplace`, and `rm` instead of `remove`.

179</Tip>

180

181* **GitHub repositories**: `owner/repo` format (for example, `anthropics/claude-code`)

182* **Git URLs**: any git repository URL (GitLab, Bitbucket, self-hosted)

183* **Local paths**: directories or direct paths to `marketplace.json` files

184* **Remote URLs**: direct URLs to hosted `marketplace.json` files

185

186### Add from GitHub

187

188Add a GitHub repository that contains a `.claude-plugin/marketplace.json` file using the `owner/repo` format—where `owner` is the GitHub username or organization and `repo` is the repository name.

189

190For example, `anthropics/claude-code` refers to the `claude-code` repository owned by `anthropics`:

191

192```shell theme={null}

193/plugin marketplace add anthropics/claude-code

194```

195

196### Add from other Git hosts

197

198Add any git repository by providing the full URL. This works with any Git host, including GitLab, Bitbucket, and self-hosted servers:

199

200Using HTTPS:

201

202```shell theme={null}

203/plugin marketplace add https://gitlab.com/company/plugins.git

204```

205

206Using SSH:

207

208```shell theme={null}

209/plugin marketplace add git@gitlab.com:company/plugins.git

210```

211

212To add a specific branch or tag, append `#` followed by the ref:

213

214```shell theme={null}

215/plugin marketplace add https://gitlab.com/company/plugins.git#v1.0.0

216```

217

218### Add from local paths

219

220Add a local directory that contains a `.claude-plugin/marketplace.json` file:

221

222```shell theme={null}

223/plugin marketplace add ./my-marketplace

224```

225

226You can also add a direct path to a `marketplace.json` file:

227

228```shell theme={null}

229/plugin marketplace add ./path/to/marketplace.json

230```

231

232### Add from remote URLs

233

234Add a remote `marketplace.json` file via URL:

235

236```shell theme={null}

237/plugin marketplace add https://example.com/marketplace.json

238```

239

240<Note>

241 URL-based marketplaces have some limitations compared to Git-based marketplaces. If you encounter "path not found" errors when installing plugins, see [Troubleshooting](/en/plugin-marketplaces#plugins-with-relative-paths-fail-in-url-based-marketplaces).

242</Note>

243

244## Install plugins

245

246Once you've added marketplaces, you can install plugins directly (installs to user scope by default):

247

248```shell theme={null}

249/plugin install plugin-name@marketplace-name

250```

251

252To choose a different [installation scope](/en/settings#configuration-scopes), use the interactive UI: run `/plugin`, go to the **Discover** tab, and press **Enter** on a plugin. You'll see options for:

253

254* **User scope** (default): install for yourself across all projects

255* **Project scope**: install for all collaborators on this repository (adds to `.claude/settings.json`)

256* **Local scope**: install for yourself in this repository only (not shared with collaborators)

257

258You may also see plugins with **managed** scope—these are installed by administrators via [managed settings](/en/settings#settings-files) and cannot be modified.

259

260Run `/plugin` and go to the **Installed** tab to see your plugins grouped by scope.

261

262<Warning>

263 Make sure you trust a plugin before installing it. Anthropic does not control what MCP servers, files, or other software are included in plugins and cannot verify that they work as intended. Check each plugin's homepage for more information.

264</Warning>

265

266## Manage installed plugins

267

268Run `/plugin` and go to the **Installed** tab to view, enable, disable, or uninstall your plugins. Type to filter the list by plugin name or description.

269

270You can also manage plugins with direct commands.

271

272Disable a plugin without uninstalling:

273

274```shell theme={null}

275/plugin disable plugin-name@marketplace-name

276```

277

278Re-enable a disabled plugin:

279

280```shell theme={null}

281/plugin enable plugin-name@marketplace-name

282```

283

284Completely remove a plugin:

285

286```shell theme={null}

287/plugin uninstall plugin-name@marketplace-name

288```

289

290The `--scope` option lets you target a specific scope with CLI commands:

291

292```shell theme={null}

293claude plugin install formatter@your-org --scope project

294claude plugin uninstall formatter@your-org --scope project

295```

296

297### Apply plugin changes without restarting

298

299When you install, enable, or disable plugins during a session, run `/reload-plugins` to pick up all changes without restarting:

300

301```shell theme={null}

302/reload-plugins

303```

304

305Claude Code reloads all active plugins and shows counts for plugins, skills, agents, hooks, plugin MCP servers, and plugin LSP servers.

306

307## Manage marketplaces

308

309You can manage marketplaces through the interactive `/plugin` interface or with CLI commands.

310

311### Use the interactive interface

312

313Run `/plugin` and go to the **Marketplaces** tab to:

314

315* View all your added marketplaces with their sources and status

316* Add new marketplaces

317* Update marketplace listings to fetch the latest plugins

318* Remove marketplaces you no longer need

319

320### Use CLI commands

321

322You can also manage marketplaces with direct commands.

323

324List all configured marketplaces:

325

326```shell theme={null}

327/plugin marketplace list

328```

329

330Refresh plugin listings from a marketplace:

331

332```shell theme={null}

333/plugin marketplace update marketplace-name

334```

335

336Remove a marketplace:

337

338```shell theme={null}

339/plugin marketplace remove marketplace-name

340```

341

342<Warning>

343 Removing a marketplace will uninstall any plugins you installed from it.

344</Warning>

345

346### Configure auto-updates

347

348Claude Code can automatically update marketplaces and their installed plugins at startup. When auto-update is enabled for a marketplace, Claude Code refreshes the marketplace data and updates installed plugins to their latest versions. If any plugins were updated, you'll see a notification prompting you to run `/reload-plugins`.

349

350Toggle auto-update for individual marketplaces through the UI:

351

3521. Run `/plugin` to open the plugin manager

3532. Select **Marketplaces**

3543. Choose a marketplace from the list

3554. Select **Enable auto-update** or **Disable auto-update**

356

357Official Anthropic marketplaces have auto-update enabled by default. Third-party and local development marketplaces have auto-update disabled by default.

358

359To disable all automatic updates entirely for both Claude Code and all plugins, set the `DISABLE_AUTOUPDATER` environment variable. See [Auto updates](/en/setup#auto-updates) for details.

360

361To keep plugin auto-updates enabled while disabling Claude Code auto-updates, set `FORCE_AUTOUPDATE_PLUGINS=true` along with `DISABLE_AUTOUPDATER`:

362

363```shell theme={null}

364export DISABLE_AUTOUPDATER=true

365export FORCE_AUTOUPDATE_PLUGINS=true

366```

367

368This is useful when you want to manage Claude Code updates manually but still receive automatic plugin updates.

369

370## Configure team marketplaces

371

372Team admins can set up automatic marketplace installation for projects by adding marketplace configuration to `.claude/settings.json`. When team members trust the repository folder, Claude Code prompts them to install these marketplaces and plugins.

373

374Add `extraKnownMarketplaces` to your project's `.claude/settings.json`:

375

376```json theme={null}

377{

378 "extraKnownMarketplaces": {

379 "my-team-tools": {

380 "source": {

381 "source": "github",

382 "repo": "your-org/claude-plugins"

383 }

384 }

385 }

386}

387```

388

389For full configuration options including `extraKnownMarketplaces` and `enabledPlugins`, see [Plugin settings](/en/settings#plugin-settings).

390

391## Security

392

393Plugins and marketplaces are highly trusted components that can execute arbitrary code on your machine with your user privileges. Only install plugins and add marketplaces from sources you trust. Organizations can restrict which marketplaces users are allowed to add using [managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions).

394

395## Troubleshooting

396

397### /plugin command not recognized

398

399If you see "unknown command" or the `/plugin` command doesn't appear:

400

4011. **Check your version**: Run `claude --version`. Plugins require version 1.0.33 or later.

4022. **Update Claude Code**:

403 * **Homebrew**: `brew upgrade claude-code`

404 * **npm**: `npm update -g @anthropic-ai/claude-code`

405 * **Native installer**: Re-run the install command from [Setup](/en/setup)

4063. **Restart Claude Code**: After updating, restart your terminal and run `claude` again.

407

408### Common issues

409

410* **Marketplace not loading**: Verify the URL is accessible and that `.claude-plugin/marketplace.json` exists at the path

411* **Plugin installation failures**: Check that plugin source URLs are accessible and repositories are public (or you have access)

412* **Files not found after installation**: Plugins are copied to a cache, so paths referencing files outside the plugin directory won't work

413* **Plugin skills not appearing**: Clear the cache with `rm -rf ~/.claude/plugins/cache`, restart Claude Code, and reinstall the plugin.

414

415For detailed troubleshooting with solutions, see [Troubleshooting](/en/plugin-marketplaces#troubleshooting) in the marketplace guide. For debugging tools, see [Debugging and development tools](/en/plugins-reference#debugging-and-development-tools).

416

417### Code intelligence issues

418

419* **Language server not starting**: verify the binary is installed and available in your `$PATH`. Check the `/plugin` Errors tab for details.

420* **High memory usage**: language servers like `rust-analyzer` and `pyright` can consume significant memory on large projects. If you experience memory issues, disable the plugin with `/plugin disable <plugin-name>` and rely on Claude's built-in search tools instead.

421* **False positive diagnostics in monorepos**: language servers may report unresolved import errors for internal packages if the workspace isn't configured correctly. These don't affect Claude's ability to edit code.

422

423## Next steps

424

425* **Build your own plugins**: See [Plugins](/en/plugins) to create skills, agents, and hooks

426* **Create a marketplace**: See [Create a plugin marketplace](/en/plugin-marketplaces) to distribute plugins to your team or community

427* **Technical reference**: See [Plugins reference](/en/plugins-reference) for complete specifications

env-vars.md +125 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Environment variables

7> Complete reference for environment variables that control Claude Code behavior.

9Claude Code supports the following environment variables to control its behavior. Set them in your shell before launching `claude`, or configure them in [`settings.json`](/en/settings#available-settings) under the `env` key to apply them to every session or roll them out across your team.

11| Variable | Purpose |

12| :--------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

13| `ANTHROPIC_API_KEY` | API key sent as `X-Api-Key` header. When set, this key is used instead of your Claude Pro, Max, Team, or Enterprise subscription even if you are logged in. In non-interactive mode (`-p`), the key is always used when present. In interactive mode, you are prompted to approve the key once before it overrides your subscription. To use your subscription instead, run `unset ANTHROPIC_API_KEY` |

14| `ANTHROPIC_AUTH_TOKEN` | Custom value for the `Authorization` header (the value you set here will be prefixed with `Bearer `) |

15| `ANTHROPIC_BASE_URL` | Override the API endpoint to route requests through a proxy or gateway. When set to a non-first-party host, [MCP tool search](/en/mcp#scale-with-mcp-tool-search) is disabled by default. Set `ENABLE_TOOL_SEARCH=true` if your proxy forwards `tool_reference` blocks |

16| `ANTHROPIC_CUSTOM_HEADERS` | Custom headers to add to requests (`Name: Value` format, newline-separated for multiple headers) |

17| `ANTHROPIC_CUSTOM_MODEL_OPTION` | Model ID to add as a custom entry in the `/model` picker. Use this to make a non-standard or gateway-specific model selectable without replacing built-in aliases. See [Model configuration](/en/model-config#add-a-custom-model-option) |

18| `ANTHROPIC_CUSTOM_MODEL_OPTION_DESCRIPTION` | Display description for the custom model entry in the `/model` picker. Defaults to `Custom model (<model-id>)` when not set |

19| `ANTHROPIC_CUSTOM_MODEL_OPTION_NAME` | Display name for the custom model entry in the `/model` picker. Defaults to the model ID when not set |

20| `ANTHROPIC_DEFAULT_HAIKU_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

21| `ANTHROPIC_DEFAULT_OPUS_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

22| `ANTHROPIC_DEFAULT_SONNET_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

23| `ANTHROPIC_FOUNDRY_API_KEY` | API key for Microsoft Foundry authentication (see [Microsoft Foundry](/en/microsoft-foundry)) |

24| `ANTHROPIC_FOUNDRY_BASE_URL` | Full base URL for the Foundry resource (for example, `https://my-resource.services.ai.azure.com/anthropic`). Alternative to `ANTHROPIC_FOUNDRY_RESOURCE` (see [Microsoft Foundry](/en/microsoft-foundry)) |

25| `ANTHROPIC_FOUNDRY_RESOURCE` | Foundry resource name (for example, `my-resource`). Required if `ANTHROPIC_FOUNDRY_BASE_URL` is not set (see [Microsoft Foundry](/en/microsoft-foundry)) |

26| `ANTHROPIC_MODEL` | Name of the model setting to use (see [Model Configuration](/en/model-config#environment-variables)) |

27| `ANTHROPIC_SMALL_FAST_MODEL` | \[DEPRECATED] Name of [Haiku-class model for background tasks](/en/costs) |

28| `ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION` | Override AWS region for the Haiku-class model when using Bedrock |

29| `AWS_BEARER_TOKEN_BEDROCK` | Bedrock API key for authentication (see [Bedrock API keys](https://aws.amazon.com/blogs/machine-learning/accelerate-ai-development-with-amazon-bedrock-api-keys/)) |

30| `BASH_DEFAULT_TIMEOUT_MS` | Default timeout for long-running bash commands |

31| `BASH_MAX_OUTPUT_LENGTH` | Maximum number of characters in bash outputs before they are middle-truncated |

32| `BASH_MAX_TIMEOUT_MS` | Maximum timeout the model can set for long-running bash commands |

33| `CLAUDECODE` | Set to `1` in shell environments Claude Code spawns (Bash tool, tmux sessions). Not set in [hooks](/en/hooks) or [status line](/en/statusline) commands. Use to detect when a script is running inside a shell spawned by Claude Code |

34| `CLAUDE_AUTOCOMPACT_PCT_OVERRIDE` | Set the percentage of context capacity (1-100) at which auto-compaction triggers. By default, auto-compaction triggers at approximately 95% capacity. Use lower values like `50` to compact earlier. Values above the default threshold have no effect. Applies to both main conversations and subagents. This percentage aligns with the `context_window.used_percentage` field available in [status line](/en/statusline) |

35| `CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR` | Return to the original working directory after each Bash command |

36| `CLAUDE_CODE_ACCOUNT_UUID` | Account UUID for the authenticated user. Used by SDK callers to provide account information synchronously, avoiding a race condition where early telemetry events lack account metadata. Requires `CLAUDE_CODE_USER_EMAIL` and `CLAUDE_CODE_ORGANIZATION_UUID` to also be set |

37| `CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD` | Set to `1` to load CLAUDE.md files from directories specified with `--add-dir`. By default, additional directories do not load memory files |

38| `CLAUDE_CODE_AUTO_COMPACT_WINDOW` | Set the context capacity in tokens used for auto-compaction calculations. Defaults to the model's context window: 200K for standard models or 1M for [extended context](/en/model-config#extended-context) models. Use a lower value like `500000` on a 1M model to treat the window as 500K for compaction purposes. The value is capped at the model's actual context window. `CLAUDE_AUTOCOMPACT_PCT_OVERRIDE` is applied as a percentage of this value. Setting this variable decouples the compaction threshold from the status line's `used_percentage`, which always uses the model's full context window |

39| `CLAUDE_CODE_API_KEY_HELPER_TTL_MS` | Interval in milliseconds at which credentials should be refreshed (when using [`apiKeyHelper`](/en/settings#available-settings)) |

40| `CLAUDE_CODE_CLIENT_CERT` | Path to client certificate file for mTLS authentication |

41| `CLAUDE_CODE_CLIENT_KEY` | Path to client private key file for mTLS authentication |

42| `CLAUDE_CODE_CLIENT_KEY_PASSPHRASE` | Passphrase for encrypted CLAUDE\_CODE\_CLIENT\_KEY (optional) |

43| `CLAUDE_CODE_DISABLE_1M_CONTEXT` | Set to `1` to disable [1M context window](/en/model-config#extended-context) support. When set, 1M model variants are unavailable in the model picker. Useful for enterprise environments with compliance requirements |

44| `CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING` | Set to `1` to disable [adaptive reasoning](/en/model-config#adjust-effort-level) for Opus 4.6 and Sonnet 4.6. When disabled, these models fall back to the fixed thinking budget controlled by `MAX_THINKING_TOKENS` |

45| `CLAUDE_CODE_DISABLE_AUTO_MEMORY` | Set to `1` to disable [auto memory](/en/memory#auto-memory). Set to `0` to force auto memory on during the gradual rollout. When disabled, Claude does not create or load auto memory files |

46| `CLAUDE_CODE_DISABLE_GIT_INSTRUCTIONS` | Set to `1` to remove built-in commit and PR workflow instructions and the git status snapshot from Claude's system prompt. Useful when using your own git workflow skills. Takes precedence over the [`includeGitInstructions`](/en/settings#available-settings) setting when set |

47| `CLAUDE_CODE_DISABLE_BACKGROUND_TASKS` | Set to `1` to disable all background task functionality, including the `run_in_background` parameter on Bash and subagent tools, auto-backgrounding, and the Ctrl+B shortcut |

48| `CLAUDE_CODE_DISABLE_CRON` | Set to `1` to disable [scheduled tasks](/en/scheduled-tasks). The `/loop` skill and cron tools become unavailable and any already-scheduled tasks stop firing, including tasks that are already running mid-session |

49| `CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS` | Set to `1` to strip Anthropic-specific `anthropic-beta` request headers and beta tool-schema fields (such as `defer_loading` and `eager_input_streaming`) from API requests. Use this when a proxy gateway rejects requests with errors like "Unexpected value(s) for the `anthropic-beta` header" or "Extra inputs are not permitted". Standard fields (`name`, `description`, `input_schema`, `cache_control`) are preserved. |

50| `CLAUDE_CODE_DISABLE_FAST_MODE` | Set to `1` to disable [fast mode](/en/fast-mode) |

51| `CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY` | Set to `1` to disable the "How is Claude doing?" session quality surveys. Surveys are also disabled when `DISABLE_TELEMETRY` or `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` is set. See [Session quality surveys](/en/data-usage#session-quality-surveys) |

52| `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | Equivalent of setting `DISABLE_AUTOUPDATER`, `DISABLE_FEEDBACK_COMMAND`, `DISABLE_ERROR_REPORTING`, and `DISABLE_TELEMETRY` |

53| `CLAUDE_CODE_DISABLE_NONSTREAMING_FALLBACK` | Set to `1` to disable the non-streaming fallback when a streaming request fails mid-stream. Streaming errors propagate to the retry layer instead. Useful when a proxy or gateway causes the fallback to produce duplicate tool execution |

54| `CLAUDE_CODE_DISABLE_TERMINAL_TITLE` | Set to `1` to disable automatic terminal title updates based on conversation context |

55| `CLAUDE_CODE_EFFORT_LEVEL` | Set the effort level for supported models. Values: `low`, `medium`, `high`, `max` (Opus 4.6 only), or `auto` to use the model default. Takes precedence over `/effort` and the `effortLevel` setting. See [Adjust effort level](/en/model-config#adjust-effort-level) |

56| `CLAUDE_CODE_ENABLE_PROMPT_SUGGESTION` | Set to `false` to disable prompt suggestions (the "Prompt suggestions" toggle in `/config`). These are the grayed-out predictions that appear in your prompt input after Claude responds. See [Prompt suggestions](/en/interactive-mode#prompt-suggestions) |

57| `CLAUDE_CODE_ENABLE_TASKS` | Set to `true` to enable the task tracking system in non-interactive mode (the `-p` flag). Tasks are on by default in interactive mode. See [Task list](/en/interactive-mode#task-list) |

58| `CLAUDE_CODE_ENABLE_TELEMETRY` | Set to `1` to enable OpenTelemetry data collection for metrics and logging. Required before configuring OTel exporters. See [Monitoring](/en/monitoring-usage) |

59| `CLAUDE_CODE_EXIT_AFTER_STOP_DELAY` | Time in milliseconds to wait after the query loop becomes idle before automatically exiting. Useful for automated workflows and scripts using SDK mode |

60| `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS` | Set to `1` to enable [agent teams](/en/agent-teams). Agent teams are experimental and disabled by default |

61| `CLAUDE_CODE_FILE_READ_MAX_OUTPUT_TOKENS` | Override the default token limit for file reads. Useful when you need to read larger files in full |

62| `CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL` | Skip auto-installation of IDE extensions. Equivalent to setting [`autoInstallIdeExtension`](/en/settings#global-config-settings) to `false` |

63| `CLAUDE_CODE_MAX_OUTPUT_TOKENS` | Set the maximum number of output tokens for most requests. Defaults and caps vary by model; see [max output tokens](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison). Increasing this value reduces the effective context window available before [auto-compaction](/en/costs#reduce-token-usage) triggers. |

64| `CLAUDE_CODE_NEW_INIT` | Set to `true` to make `/init` run an interactive setup flow. The flow asks which files to generate, including CLAUDE.md, skills, and hooks, before exploring the codebase and writing them. Without this variable, `/init` generates a CLAUDE.md automatically without prompting. |

65| `CLAUDE_CODE_ORGANIZATION_UUID` | Organization UUID for the authenticated user. Used by SDK callers to provide account information synchronously. Requires `CLAUDE_CODE_ACCOUNT_UUID` and `CLAUDE_CODE_USER_EMAIL` to also be set |

66| `CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS` | Interval for refreshing dynamic OpenTelemetry headers in milliseconds (default: 1740000 / 29 minutes). See [Dynamic headers](/en/monitoring-usage#dynamic-headers) |

67| `CLAUDE_CODE_PLAN_MODE_REQUIRED` | Auto-set to `true` on [agent team](/en/agent-teams) teammates that require plan approval. Read-only: set by Claude Code when spawning teammates. See [require plan approval](/en/agent-teams#require-plan-approval-for-teammates) |

68| `CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS` | Timeout in milliseconds for git operations when installing or updating plugins (default: 120000). Increase this value for large repositories or slow network connections. See [Git operations time out](/en/plugin-marketplaces#git-operations-time-out) |

69| `CLAUDE_CODE_PLUGIN_SEED_DIR` | Path to one or more read-only plugin seed directories, separated by `:` on Unix or `;` on Windows. Use this to bundle a pre-populated plugins directory into a container image. Claude Code registers marketplaces from these directories at startup and uses pre-cached plugins without re-cloning. See [Pre-populate plugins for containers](/en/plugin-marketplaces#pre-populate-plugins-for-containers) |

70| `CLAUDE_CODE_PROXY_RESOLVES_HOSTS` | Set to `true` to allow the proxy to perform DNS resolution instead of the caller. Opt-in for environments where the proxy should handle hostname resolution |

71| `CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS` | Maximum time in milliseconds for [SessionEnd](/en/hooks#sessionend) hooks to complete (default: `1500`). Applies to session exit, `/clear`, and switching sessions via interactive `/resume`. Per-hook `timeout` values are also capped by this budget |

72| `CLAUDE_CODE_SHELL` | Override automatic shell detection. Useful when your login shell differs from your preferred working shell (for example, `bash` vs `zsh`) |

73| `CLAUDE_CODE_SHELL_PREFIX` | Command prefix to wrap all bash commands (for example, for logging or auditing). Example: `/path/to/logger.sh` will execute `/path/to/logger.sh <command>` |

74| `CLAUDE_CODE_SIMPLE` | Set to `1` to run with a minimal system prompt and only the Bash, file read, and file edit tools. Disables auto-discovery of hooks, skills, plugins, MCP servers, auto memory, and CLAUDE.md. The [`--bare`](/en/headless#start-faster-with-bare-mode) CLI flag sets this |

75| `CLAUDE_CODE_SKIP_BEDROCK_AUTH` | Skip AWS authentication for Bedrock (for example, when using an LLM gateway) |

76| `CLAUDE_CODE_SKIP_FAST_MODE_NETWORK_ERRORS` | Set to `1` to allow [fast mode](/en/fast-mode) when the organization status check fails due to a network error. Useful when a corporate proxy blocks the status endpoint. The API still enforces organization-level disable separately |

77| `CLAUDE_CODE_SKIP_FOUNDRY_AUTH` | Skip Azure authentication for Microsoft Foundry (for example, when using an LLM gateway) |

78| `CLAUDE_CODE_SKIP_VERTEX_AUTH` | Skip Google authentication for Vertex (for example, when using an LLM gateway) |

79| `CLAUDE_CODE_SUBAGENT_MODEL` | See [Model configuration](/en/model-config) |

80| `CLAUDE_CODE_SUBPROCESS_ENV_SCRUB` | Set to `1` to strip Anthropic and cloud provider credentials from subprocess environments (Bash tool, hooks, MCP stdio servers). The parent Claude process keeps these credentials for API calls, but child processes cannot read them, reducing exposure to prompt injection attacks that attempt to exfiltrate secrets via shell expansion. `claude-code-action` sets this automatically when `allowed_non_write_users` is configured |

81| `CLAUDE_CODE_TASK_LIST_ID` | Share a task list across sessions. Set the same ID in multiple Claude Code instances to coordinate on a shared task list. See [Task list](/en/interactive-mode#task-list) |

82| `CLAUDE_CODE_TEAM_NAME` | Name of the agent team this teammate belongs to. Set automatically on [agent team](/en/agent-teams) members |

83| `CLAUDE_CODE_TMPDIR` | Override the temp directory used for internal temp files. Claude Code appends `/claude/` to this path. Default: `/tmp` on Unix/macOS, `os.tmpdir()` on Windows |

84| `CLAUDE_CODE_USER_EMAIL` | Email address for the authenticated user. Used by SDK callers to provide account information synchronously. Requires `CLAUDE_CODE_ACCOUNT_UUID` and `CLAUDE_CODE_ORGANIZATION_UUID` to also be set |

85| `CLAUDE_CODE_USE_BEDROCK` | Use [Bedrock](/en/amazon-bedrock) |

86| `CLAUDE_CODE_USE_FOUNDRY` | Use [Microsoft Foundry](/en/microsoft-foundry) |

87| `CLAUDE_CODE_USE_VERTEX` | Use [Vertex](/en/google-vertex-ai) |

88| `CLAUDE_CONFIG_DIR` | Customize where Claude Code stores its configuration and data files |

89| `CLAUDE_ENV_FILE` | Path to a shell script that Claude Code sources before each Bash command. Use to persist virtualenv or conda activation across commands. Also populated dynamically by [SessionStart](/en/hooks#persist-environment-variables), [CwdChanged](/en/hooks#cwdchanged), and [FileChanged](/en/hooks#filechanged) hooks |

90| `DISABLE_AUTOUPDATER` | Set to `1` to disable automatic updates. |

91| `DISABLE_COST_WARNINGS` | Set to `1` to disable cost warning messages |

92| `DISABLE_ERROR_REPORTING` | Set to `1` to opt out of Sentry error reporting |

93| `DISABLE_FEEDBACK_COMMAND` | Set to `1` to disable the `/feedback` command. The older name `DISABLE_BUG_COMMAND` is also accepted |

94| `DISABLE_INSTALLATION_CHECKS` | Set to `1` to disable installation warnings. Use only when manually managing the installation location, as this can mask issues with standard installations |

95| `DISABLE_PROMPT_CACHING` | Set to `1` to disable prompt caching for all models (takes precedence over per-model settings) |

96| `DISABLE_PROMPT_CACHING_HAIKU` | Set to `1` to disable prompt caching for Haiku models |

97| `DISABLE_PROMPT_CACHING_OPUS` | Set to `1` to disable prompt caching for Opus models |

98| `DISABLE_PROMPT_CACHING_SONNET` | Set to `1` to disable prompt caching for Sonnet models |

99| `DISABLE_TELEMETRY` | Set to `1` to opt out of Statsig telemetry (note that Statsig events do not include user data like code, file paths, or bash commands) |

100| `ENABLE_CLAUDEAI_MCP_SERVERS` | Set to `false` to disable [claude.ai MCP servers](/en/mcp#use-mcp-servers-from-claudeai) in Claude Code. Enabled by default for logged-in users |

101| `ENABLE_TOOL_SEARCH` | Controls [MCP tool search](/en/mcp#scale-with-mcp-tool-search). Unset: enabled by default, but disabled when `ANTHROPIC_BASE_URL` points to a non-first-party host. Values: `true` (always on including proxies), `auto` (enables at 10% context), `auto:N` (custom threshold, e.g., `auto:5` for 5%), `false` (disabled) |

102| `FORCE_AUTOUPDATE_PLUGINS` | Set to `true` to force plugin auto-updates even when the main auto-updater is disabled via `DISABLE_AUTOUPDATER` |

103| `HTTP_PROXY` | Specify HTTP proxy server for network connections |

104| `HTTPS_PROXY` | Specify HTTPS proxy server for network connections |

105| `IS_DEMO` | Set to `true` to enable demo mode: hides email and organization from the UI, skips onboarding, and hides internal commands. Useful for streaming or recording sessions |

106| `MAX_MCP_OUTPUT_TOKENS` | Maximum number of tokens allowed in MCP tool responses. Claude Code displays a warning when output exceeds 10,000 tokens (default: 25000) |

107| `MAX_THINKING_TOKENS` | Override the [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) token budget. The ceiling is the model's [max output tokens](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison) minus one. Set to `0` to disable thinking entirely. On models with adaptive reasoning (Opus 4.6, Sonnet 4.6), the budget is ignored unless adaptive reasoning is disabled via `CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING` |

108| `MCP_CLIENT_SECRET` | OAuth client secret for MCP servers that require [pre-configured credentials](/en/mcp#use-pre-configured-oauth-credentials). Avoids the interactive prompt when adding a server with `--client-secret` |

109| `MCP_OAUTH_CALLBACK_PORT` | Fixed port for the OAuth redirect callback, as an alternative to `--callback-port` when adding an MCP server with [pre-configured credentials](/en/mcp#use-pre-configured-oauth-credentials) |

110| `MCP_TIMEOUT` | Timeout in milliseconds for MCP server startup |

111| `MCP_TOOL_TIMEOUT` | Timeout in milliseconds for MCP tool execution |

112| `NO_PROXY` | List of domains and IPs to which requests will be directly issued, bypassing proxy |

113| `SLASH_COMMAND_TOOL_CHAR_BUDGET` | Override the character budget for skill metadata shown to the [Skill tool](/en/skills#control-who-invokes-a-skill). The budget scales dynamically at 2% of the context window, with a fallback of 16,000 characters. Legacy name kept for backwards compatibility |

114| `USE_BUILTIN_RIPGREP` | Set to `0` to use system-installed `rg` instead of `rg` included with Claude Code |

115| `VERTEX_REGION_CLAUDE_3_5_HAIKU` | Override region for Claude 3.5 Haiku when using Vertex AI |

116| `VERTEX_REGION_CLAUDE_3_7_SONNET` | Override region for Claude 3.7 Sonnet when using Vertex AI |

117| `VERTEX_REGION_CLAUDE_4_0_OPUS` | Override region for Claude 4.0 Opus when using Vertex AI |

118| `VERTEX_REGION_CLAUDE_4_0_SONNET` | Override region for Claude 4.0 Sonnet when using Vertex AI |

119| `VERTEX_REGION_CLAUDE_4_1_OPUS` | Override region for Claude 4.1 Opus when using Vertex AI |

120

121## See also

122

123* [Settings](/en/settings): configure environment variables in `settings.json` so they apply to every session

124* [CLI reference](/en/cli-reference): launch-time flags

125* [Network configuration](/en/network-config): proxy and TLS setup

fast-mode.md +150 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Speed up responses with fast mode

7> Get faster Opus 4.6 responses in Claude Code by toggling fast mode.

9<Note>

10 Fast mode is in [research preview](#research-preview). The feature, pricing, and availability may change based on feedback.

11</Note>

13Fast mode is a high-speed configuration for Claude Opus 4.6, making the model 2.5x faster at a higher cost per token. Toggle it on with `/fast` when you need speed for interactive work like rapid iteration or live debugging, and toggle it off when cost matters more than latency.

15Fast mode is not a different model. It uses the same Opus 4.6 with a different API configuration that prioritizes speed over cost efficiency. You get identical quality and capabilities, just faster responses.

17<Note>

18 Fast mode requires Claude Code v2.1.36 or later. Check your version with `claude --version`.

19</Note>

21What to know:

23* Use `/fast` to toggle on fast mode in Claude Code CLI. Also available via `/fast` in Claude Code VS Code Extension.

24* Fast mode for Opus 4.6 pricing is \$30/150 MTok.

25* Available to all Claude Code users on subscription plans (Pro/Max/Team/Enterprise) and Claude Console.

26* For Claude Code users on subscription plans (Pro/Max/Team/Enterprise), fast mode is available via extra usage only and not included in the subscription rate limits.

28This page covers how to [toggle fast mode](#toggle-fast-mode), its [cost tradeoff](#understand-the-cost-tradeoff), [when to use it](#decide-when-to-use-fast-mode), [requirements](#requirements), [per-session opt-in](#require-per-session-opt-in), and [rate limit behavior](#handle-rate-limits).

30## Toggle fast mode

32Toggle fast mode in either of these ways:

34* Type `/fast` and press Tab to toggle on or off

35* Set `"fastMode": true` in your [user settings file](/en/settings)

37By default, fast mode persists across sessions. Administrators can configure fast mode to reset each session. See [require per-session opt-in](#require-per-session-opt-in) for details.

39For the best cost efficiency, enable fast mode at the start of a session rather than switching mid-conversation. See [understand the cost tradeoff](#understand-the-cost-tradeoff) for details.

41When you enable fast mode:

43* If you're on a different model, Claude Code automatically switches to Opus 4.6

44* You'll see a confirmation message: "Fast mode ON"

45* A small `↯` icon appears next to the prompt while fast mode is active

46* Run `/fast` again at any time to check whether fast mode is on or off

48When you disable fast mode with `/fast` again, you remain on Opus 4.6. The model does not revert to your previous model. To switch to a different model, use `/model`.

50## Understand the cost tradeoff

52Fast mode has higher per-token pricing than standard Opus 4.6:

54| Mode | Input (MTok) | Output (MTok) |

55| --------------------- | ------------ | ------------- |

56| Fast mode on Opus 4.6 | \$30 | \$150 |

58Fast mode pricing is flat across the full 1M token context window.

60When you switch into fast mode mid-conversation, you pay the full fast mode uncached input token price for the entire conversation context. This costs more than if you had enabled fast mode from the start.

62## Decide when to use fast mode

64Fast mode is best for interactive work where response latency matters more than cost:

66* Rapid iteration on code changes

67* Live debugging sessions

68* Time-sensitive work with tight deadlines

70Standard mode is better for:

72* Long autonomous tasks where speed matters less

73* Batch processing or CI/CD pipelines

74* Cost-sensitive workloads

76### Fast mode vs effort level

78Fast mode and effort level both affect response speed, but differently:

80| Setting | Effect |

81| ---------------------- | -------------------------------------------------------------------------------- |

82| **Fast mode** | Same model quality, lower latency, higher cost |

83| **Lower effort level** | Less thinking time, faster responses, potentially lower quality on complex tasks |

85You can combine both: use fast mode with a lower [effort level](/en/model-config#adjust-effort-level) for maximum speed on straightforward tasks.

87## Requirements

89Fast mode requires all of the following:

91* **Not available on third-party cloud providers**: fast mode is not available on Amazon Bedrock, Google Vertex AI, or Microsoft Azure Foundry. Fast mode is available through the Anthropic Console API and for Claude subscription plans using extra usage.

92* **Extra usage enabled**: your account must have extra usage enabled, which allows billing beyond your plan's included usage. For individual accounts, enable this in your [Console billing settings](https://platform.claude.com/settings/organization/billing). For Teams and Enterprise, an admin must enable extra usage for the organization.

94<Note>

95 Fast mode usage is billed directly to extra usage, even if you have remaining usage on your plan. This means fast mode tokens do not count against your plan's included usage and are charged at the fast mode rate from the first token.

96</Note>

98* **Admin enablement for Teams and Enterprise**: fast mode is disabled by default for Teams and Enterprise organizations. An admin must explicitly [enable fast mode](#enable-fast-mode-for-your-organization) before users can access it.

100<Note>

101 If your admin has not enabled fast mode for your organization, the `/fast` command will show "Fast mode has been disabled by your organization."

102</Note>

103

104### Enable fast mode for your organization

105

106Admins can enable fast mode in:

107

108* **Console** (API customers): [Claude Code preferences](https://platform.claude.com/claude-code/preferences)

109* **Claude AI** (Teams and Enterprise): [Admin Settings > Claude Code](https://claude.ai/admin-settings/claude-code)

110

111Another option to disable fast mode entirely is to set `CLAUDE_CODE_DISABLE_FAST_MODE=1`. See [Environment variables](/en/env-vars).

112

113### Require per-session opt-in

114

115By default, fast mode persists across sessions: if a user enables fast mode, it stays on in future sessions. Administrators on [Teams](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=fast_mode_teams#team-&-enterprise) or [Enterprise](https://anthropic.com/contact-sales?utm_source=claude_code\&utm_medium=docs\&utm_content=fast_mode_enterprise) plans can prevent this by setting `fastModePerSessionOptIn` to `true` in [managed settings](/en/settings#settings-files) or [server-managed settings](/en/server-managed-settings). This causes each session to start with fast mode off, requiring users to explicitly enable it with `/fast`.

116

117```json theme={null}

118{

119 "fastModePerSessionOptIn": true

120}

121```

122

123This is useful for controlling costs in organizations where users run multiple concurrent sessions. Users can still enable fast mode with `/fast` when they need speed, but it resets at the start of each new session. The user's fast mode preference is still saved, so removing this setting restores the default persistent behavior.

124

125## Handle rate limits

126

127Fast mode has separate rate limits from standard Opus 4.6. When you hit the fast mode rate limit or run out of extra usage credits:

128

1291. Fast mode automatically falls back to standard Opus 4.6

1302. The `↯` icon turns gray to indicate cooldown

1313. You continue working at standard speed and pricing

1324. When the cooldown expires, fast mode automatically re-enables

133

134To disable fast mode manually instead of waiting for cooldown, run `/fast` again.

135

136## Research preview

137

138Fast mode is a research preview feature. This means:

139

140* The feature may change based on feedback

141* Availability and pricing are subject to change

142* The underlying API configuration may evolve

143

144Report issues or feedback through your usual Anthropic support channels.

145

146## See also

147

148* [Model configuration](/en/model-config): switch models and adjust effort levels

149* [Manage costs effectively](/en/costs): track token usage and reduce costs

150* [Status line configuration](/en/statusline): display model and context information

features-overview.md +294 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Extend Claude Code

7> Understand when to use CLAUDE.md, Skills, subagents, hooks, MCP, and plugins.

9Claude Code combines a model that reasons about your code with [built-in tools](/en/how-claude-code-works#tools) for file operations, search, execution, and web access. The built-in tools cover most coding tasks. This guide covers the extension layer: features you add to customize what Claude knows, connect it to external services, and automate workflows.

11<Note>

12 For how the core agentic loop works, see [How Claude Code works](/en/how-claude-code-works).

13</Note>

15**New to Claude Code?** Start with [CLAUDE.md](/en/memory) for project conventions. Add other extensions as you need them.

17## Overview

19Extensions plug into different parts of the agentic loop:

21* **[CLAUDE.md](/en/memory)** adds persistent context Claude sees every session

22* **[Skills](/en/skills)** add reusable knowledge and invocable workflows

23* **[MCP](/en/mcp)** connects Claude to external services and tools

24* **[Subagents](/en/sub-agents)** run their own loops in isolated context, returning summaries

25* **[Agent teams](/en/agent-teams)** coordinate multiple independent sessions with shared tasks and peer-to-peer messaging

26* **[Hooks](/en/hooks)** run outside the loop entirely as deterministic scripts

27* **[Plugins](/en/plugins)** and **[marketplaces](/en/plugin-marketplaces)** package and distribute these features

29[Skills](/en/skills) are the most flexible extension. A skill is a markdown file containing knowledge, workflows, or instructions. You can invoke skills with a command like `/deploy`, or Claude can load them automatically when relevant. Skills can run in your current conversation or in an isolated context via subagents.

31## Match features to your goal

33Features range from always-on context that Claude sees every session, to on-demand capabilities you or Claude can invoke, to background automation that runs on specific events. The table below shows what's available and when each one makes sense.

36| ---------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |

41| **MCP** | Connect to external services | External data or actions | Query your database, post to Slack, control a browser |

44**[Plugins](/en/plugins)** are the packaging layer. A plugin bundles skills, hooks, subagents, and MCP servers into a single installable unit. Plugin skills are namespaced (like `/my-plugin:review`) so multiple plugins can coexist. Use plugins when you want to reuse the same setup across multiple repositories or distribute to others via a **[marketplace](/en/plugin-marketplaces)**.

46### Compare similar features

48Some features can seem similar. Here's how to tell them apart.

50<Tabs>

51 <Tab title="Skill vs Subagent">

52 Skills and subagents solve different problems:

54 * **Skills** are reusable content you can load into any context

55 * **Subagents** are isolated workers that run separately from your main conversation

57 | Aspect | Skill | Subagent |

58 | --------------- | ---------------------------------------------- | ---------------------------------------------------------------- |

59 | **What it is** | Reusable instructions, knowledge, or workflows | Isolated worker with its own context |

60 | **Key benefit** | Share content across contexts | Context isolation. Work happens separately, only summary returns |

61 | **Best for** | Reference material, invocable workflows | Tasks that read many files, parallel work, specialized workers |

63 **Skills can be reference or action.** Reference skills provide knowledge Claude uses throughout your session (like your API style guide). Action skills tell Claude to do something specific (like `/deploy` that runs your deployment workflow).

65 **Use a subagent** when you need context isolation or when your context window is getting full. The subagent might read dozens of files or run extensive searches, but your main conversation only receives a summary. Since subagent work doesn't consume your main context, this is also useful when you don't need the intermediate work to remain visible. Custom subagents can have their own instructions and can preload skills.

67 **They can combine.** A subagent can preload specific skills (`skills:` field). A skill can run in isolated context using `context: fork`. See [Skills](/en/skills) for details.

68 </Tab>

70 <Tab title="CLAUDE.md vs Skill">

71 Both store instructions, but they load differently and serve different purposes.

73 | Aspect | CLAUDE.md | Skill |

74 | ------------------------- | ---------------------------- | --------------------------------------- |

75 | **Loads** | Every session, automatically | On demand |

76 | **Can include files** | Yes, with `@path` imports | Yes, with `@path` imports |

77 | **Can trigger workflows** | No | Yes, with `/<name>` |

78 | **Best for** | "Always do X" rules | Reference material, invocable workflows |

80 **Put it in CLAUDE.md** if Claude should always know it: coding conventions, build commands, project structure, "never do X" rules.

82 **Put it in a skill** if it's reference material Claude needs sometimes (API docs, style guides) or a workflow you trigger with `/<name>` (deploy, review, release).

84 **Rule of thumb:** Keep CLAUDE.md under 200 lines. If it's growing, move reference content to skills or split into [`.claude/rules/`](/en/memory#organize-rules-with-clauderules) files.

85 </Tab>

87 <Tab title="CLAUDE.md vs Rules vs Skills">

88 All three store instructions, but they load differently:

91 | ------------ | ----------------------------------- | -------------------------------------------------- | ---------------------------------------- |

96 **Use CLAUDE.md** for instructions every session needs: build commands, test conventions, project architecture.

98 **Use rules** to keep CLAUDE.md focused. Rules with [`paths` frontmatter](/en/memory#path-specific-rules) only load when Claude works with matching files, saving context.

100 **Use skills** for content Claude only needs sometimes, like API documentation or a deployment checklist you trigger with `/<name>`.

101 </Tab>

102

103 <Tab title="Subagent vs Agent team">

104 Both parallelize work, but they're architecturally different:

105

106 * **Subagents** run inside your session and report results back to your main context

107 * **Agent teams** are independent Claude Code sessions that communicate with each other

108

109 | Aspect | Subagent | Agent team |

110 | ----------------- | ------------------------------------------------ | --------------------------------------------------- |

111 | **Context** | Own context window; results return to the caller | Own context window; fully independent |

112 | **Communication** | Reports results back to the main agent only | Teammates message each other directly |

113 | **Coordination** | Main agent manages all work | Shared task list with self-coordination |

114 | **Best for** | Focused tasks where only the result matters | Complex work requiring discussion and collaboration |

115 | **Token cost** | Lower: results summarized back to main context | Higher: each teammate is a separate Claude instance |

116

117 **Use a subagent** when you need a quick, focused worker: research a question, verify a claim, review a file. The subagent does the work and returns a summary. Your main conversation stays clean.

118

119 **Use an agent team** when teammates need to share findings, challenge each other, and coordinate independently. Agent teams are best for research with competing hypotheses, parallel code review, and new feature development where each teammate owns a separate piece.

120

121 **Transition point:** If you're running parallel subagents but hitting context limits, or if your subagents need to communicate with each other, agent teams are the natural next step.

122

123 <Note>

124 Agent teams are experimental and disabled by default. See [agent teams](/en/agent-teams) for setup and current limitations.

125 </Note>

126 </Tab>

127

128 <Tab title="MCP vs Skill">

129 MCP connects Claude to external services. Skills extend what Claude knows, including how to use those services effectively.

130

131 | Aspect | MCP | Skill |

132 | -------------- | ---------------------------------------------------- | ------------------------------------------------------- |

133 | **What it is** | Protocol for connecting to external services | Knowledge, workflows, and reference material |

134 | **Provides** | Tools and data access | Knowledge, workflows, reference material |

135 | **Examples** | Slack integration, database queries, browser control | Code review checklist, deploy workflow, API style guide |

136

137 These solve different problems and work well together:

138

139 **MCP** gives Claude the ability to interact with external systems. Without MCP, Claude can't query your database or post to Slack.

140

141 **Skills** give Claude knowledge about how to use those tools effectively, plus workflows you can trigger with `/<name>`. A skill might include your team's database schema and query patterns, or a `/post-to-slack` workflow with your team's message formatting rules.

142

143 Example: An MCP server connects Claude to your database. A skill teaches Claude your data model, common query patterns, and which tables to use for different tasks.

144 </Tab>

145</Tabs>

146

147### Understand how features layer

148

149Features can be defined at multiple levels: user-wide, per-project, via plugins, or through managed policies. You can also nest CLAUDE.md files in subdirectories or place skills in specific packages of a monorepo. When the same feature exists at multiple levels, here's how they layer:

150

151* **CLAUDE.md files** are additive: all levels contribute content to Claude's context simultaneously. Files from your working directory and above load at launch; subdirectories load as you work in them. When instructions conflict, Claude uses judgment to reconcile them, with more specific instructions typically taking precedence. See [how CLAUDE.md files load](/en/memory#how-claude-md-files-load).

152* **Skills and subagents** override by name: when the same name exists at multiple levels, one definition wins based on priority (managed > user > project for skills; managed > CLI flag > project > user > plugin for subagents). Plugin skills are [namespaced](/en/plugins#add-skills-to-your-plugin) to avoid conflicts. See [skill discovery](/en/skills#where-skills-live) and [subagent scope](/en/sub-agents#choose-the-subagent-scope).

153* **MCP servers** override by name: local > project > user. See [MCP scope](/en/mcp#scope-hierarchy-and-precedence).

154* **Hooks** merge: all registered hooks fire for their matching events regardless of source. See [hooks](/en/hooks).

155

156### Combine features

157

158Each extension solves a different problem: CLAUDE.md handles always-on context, skills handle on-demand knowledge and workflows, MCP handles external connections, subagents handle isolation, and hooks handle automation. Real setups combine them based on your workflow.

159

160For example, you might use CLAUDE.md for project conventions, a skill for your deployment workflow, MCP to connect to your database, and a hook to run linting after every edit. Each feature handles what it's best at.

161

162| Pattern | How it works | Example |

163| ---------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |

164| **Skill + MCP** | MCP provides the connection; a skill teaches Claude how to use it well | MCP connects to your database, a skill documents your schema and query patterns |

165| **Skill + Subagent** | A skill spawns subagents for parallel work | `/audit` skill kicks off security, performance, and style subagents that work in isolated context |

166| **CLAUDE.md + Skills** | CLAUDE.md holds always-on rules; skills hold reference material loaded on demand | CLAUDE.md says "follow our API conventions," a skill contains the full API style guide |

167| **Hook + MCP** | A hook triggers external actions through MCP | Post-edit hook sends a Slack notification when Claude modifies critical files |

168

169## Understand context costs

170

171Every feature you add consumes some of Claude's context. Too much can fill up your context window, but it can also add noise that makes Claude less effective; skills may not trigger correctly, or Claude may lose track of your conventions. Understanding these trade-offs helps you build an effective setup.

172

173### Context cost by feature

174

175Each feature has a different loading strategy and context cost:

176

178| --------------- | ------------------------- | --------------------------------------------- | -------------------------------------------- |

184

185\*By default, skill descriptions load at session start so Claude can decide when to use them. Set `disable-model-invocation: true` in a skill's frontmatter to hide it from Claude entirely until you invoke it manually. This reduces context cost to zero for skills you only trigger yourself.

186

187### Understand how features load

188

189Each feature loads at different points in your session. The tabs below explain when each one loads and what goes into context.

190

191<img src="https://mintcdn.com/claude-code/c5r9_6tjPMzFdDDT/images/context-loading.svg?fit=max&auto=format&n=c5r9_6tjPMzFdDDT&q=85&s=729b5b634ba831d1d64772c6c9485b30" alt="Context loading: CLAUDE.md and MCP load at session start and stay in every request. Skills load descriptions at start, full content on invocation. Subagents get isolated context. Hooks run externally." width="720" height="410" data-path="images/context-loading.svg" />

192

193<Tabs>

194 <Tab title="CLAUDE.md">

195 **When:** Session start

196

197 **What loads:** Full content of all CLAUDE.md files (managed, user, and project levels).

198

199 **Inheritance:** Claude reads CLAUDE.md files from your working directory up to the root, and discovers nested ones in subdirectories as it accesses those files. See [How CLAUDE.md files load](/en/memory#how-claude-md-files-load) for details.

200

201 <Tip>Keep CLAUDE.md under \~500 lines. Move reference material to skills, which load on-demand.</Tip>

202 </Tab>

203

204 <Tab title="Skills">

205 Skills are extra capabilities in Claude's toolkit. They can be reference material (like an API style guide) or invocable workflows you trigger with `/<name>` (like `/deploy`). Claude Code ships with [bundled skills](/en/skills#bundled-skills) like `/simplify`, `/batch`, and `/debug` that work out of the box. You can also create your own. Claude uses skills when appropriate, or you can invoke one directly.

206

207 **When:** Depends on the skill's configuration. By default, descriptions load at session start and full content loads when used. For user-only skills (`disable-model-invocation: true`), nothing loads until you invoke them.

208

209 **What loads:** For model-invocable skills, Claude sees names and descriptions in every request. When you invoke a skill with `/<name>` or Claude loads it automatically, the full content loads into your conversation.

210

211 **How Claude chooses skills:** Claude matches your task against skill descriptions to decide which are relevant. If descriptions are vague or overlap, Claude may load the wrong skill or miss one that would help. To tell Claude to use a specific skill, invoke it with `/<name>`. Skills with `disable-model-invocation: true` are invisible to Claude until you invoke them.

212

213 **Context cost:** Low until used. User-only skills have zero cost until invoked.

214

215 **In subagents:** Skills work differently in subagents. Instead of on-demand loading, skills passed to a subagent are fully preloaded into its context at launch. Subagents don't inherit skills from the main session; you must specify them explicitly.

216

217 <Tip>Use `disable-model-invocation: true` for skills with side effects. This saves context and ensures only you trigger them.</Tip>

218 </Tab>

219

220 <Tab title="MCP servers">

221 **When:** Session start.

222

223 **What loads:** All tool definitions and JSON schemas from connected servers.

224

225 **Context cost:** [Tool search](/en/mcp#scale-with-mcp-tool-search) (enabled by default) loads MCP tools up to 10% of context and defers the rest until needed.

226

227 **Reliability note:** MCP connections can fail silently mid-session. If a server disconnects, its tools disappear without warning. Claude may try to use a tool that no longer exists. If you notice Claude failing to use an MCP tool it previously could access, check the connection with `/mcp`.

228

229 <Tip>Run `/mcp` to see token costs per server. Disconnect servers you're not actively using.</Tip>

230 </Tab>

231

232 <Tab title="Subagents">

233 **When:** On demand, when you or Claude spawns one for a task.

234

235 **What loads:** Fresh, isolated context containing:

236

237 * The system prompt (shared with parent for cache efficiency)

238 * Full content of skills listed in the agent's `skills:` field

239 * CLAUDE.md and git status (inherited from parent)

240 * Whatever context the lead agent passes in the prompt

241

242 **Context cost:** Isolated from main session. Subagents don't inherit your conversation history or invoked skills.

243

244 <Tip>Use subagents for work that doesn't need your full conversation context. Their isolation prevents bloating your main session.</Tip>

245 </Tab>

246

247 <Tab title="Hooks">

248 **When:** On trigger. Hooks fire at specific lifecycle events like tool execution, session boundaries, prompt submission, permission requests, and compaction. See [Hooks](/en/hooks) for the full list.

249

250 **What loads:** Nothing by default. Hooks run as external scripts.

251

252 **Context cost:** Zero, unless the hook returns output that gets added as messages to your conversation.

253

254 <Tip>Hooks are ideal for side effects (linting, logging) that don't need to affect Claude's context.</Tip>

255 </Tab>

256</Tabs>

257

258## Learn more

259

260Each feature has its own guide with setup instructions, examples, and configuration options.

261

262<CardGroup cols={2}>

263 <Card title="CLAUDE.md" icon="file-lines" href="/en/memory">

264 Store project context, conventions, and instructions

265 </Card>

266

267 <Card title="Skills" icon="brain" href="/en/skills">

268 Give Claude domain expertise and reusable workflows

269 </Card>

270

271 <Card title="Subagents" icon="users" href="/en/sub-agents">

272 Offload work to isolated context

273 </Card>

274

275 <Card title="Agent teams" icon="network" href="/en/agent-teams">

276 Coordinate multiple sessions working in parallel

277 </Card>

278

279 <Card title="MCP" icon="plug" href="/en/mcp">

280 Connect Claude to external services

281 </Card>

282

283 <Card title="Hooks" icon="bolt" href="/en/hooks-guide">

284 Automate workflows with hooks

285 </Card>

286

287 <Card title="Plugins" icon="puzzle-piece" href="/en/plugins">

288 Bundle and share feature sets

289 </Card>

290

291 <Card title="Marketplaces" icon="store" href="/en/plugin-marketplaces">

292 Host and distribute plugin collections

293 </Card>

294</CardGroup>

github-actions.md +28 −28

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Claude Code GitHub Actions5# Claude Code GitHub Actions

2 6

3> Learn about integrating Claude Code into your development workflow with Claude Code GitHub Actions7> Learn about integrating Claude Code into your development workflow with Claude Code GitHub Actions

4 8

5Claude Code GitHub Actions brings AI-powered automation to your GitHub workflow. With a simple `@claude` mention in any PR or issue, Claude can analyze your code, create pull requests, implement features, and fix bugs - all while following your project's standards.9Claude Code GitHub Actions brings AI-powered automation to your GitHub workflow. With a simple `@claude` mention in any PR or issue, Claude can analyze your code, create pull requests, implement features, and fix bugs - all while following your project's standards. For automatic reviews posted on every PR without a trigger, see [GitHub Code Review](/en/code-review).

6 10

7<Note>11<Note>

~~8 Claude Code GitHub Actions is built on top of the [Claude Code~~12 Claude Code GitHub Actions is built on top of the [Claude Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview), which enables programmatic integration of Claude Code into your applications. You can use the SDK to build custom automation workflows beyond GitHub Actions.

~~9 SDK](https://docs.claude.com/en/docs/agent-sdk), which enables programmatic integration of~~

~~10 Claude Code into your applications. You can use the SDK to build custom~~

~~11 automation workflows beyond GitHub Actions.~~

12</Note>13</Note>

13 14

14<Info>15<Info>

~~15 **Claude Opus 4.5 is now available.** Claude Code GitHub Actions default to Sonnet. To use Opus 4.5, configure the [model parameter](#breaking-changes-reference) to use `claude-opus-4-5-20251101`.~~16 **Claude Opus 4.6 is now available.** Claude Code GitHub Actions default to Sonnet. To use Opus 4.6, configure the [model parameter](#breaking-changes-reference) to use `claude-opus-4-6`.

16</Info>17</Info>

17 18

18## Why use Claude Code GitHub Actions?19## Why use Claude Code GitHub Actions?

673. **Copy the workflow file** from [examples/claude.yml](https://github.com/anthropics/claude-code-action/blob/main/examples/claude.yml) into your repository's `.github/workflows/`683. **Copy the workflow file** from [examples/claude.yml](https://github.com/anthropics/claude-code-action/blob/main/examples/claude.yml) into your repository's `.github/workflows/`

68 69

69<Tip>70<Tip>

~~70 After completing either the quickstart or manual setup, test the action by~~71 After completing either the quickstart or manual setup, test the action by tagging `@claude` in an issue or PR comment.

~~71 tagging `@claude` in an issue or PR comment!~~

72</Tip>72</Tip>

73 73

74## Upgrading from Beta74## Upgrading from Beta

91### Breaking Changes Reference91### Breaking Changes Reference

92 92

93| Old Beta Input | New v1.0 Input |93| Old Beta Input | New v1.0 Input |

~~94| --------------------- | -------------------------------- |~~94| --------------------- | ------------------------------------- |

95| `mode` | *(Removed - auto-detected)* |95| `mode` | *(Removed - auto-detected)* |

96| `direct_prompt` | `prompt` |96| `direct_prompt` | `prompt` |

97| `override_prompt` | `prompt` with GitHub variables |97| `override_prompt` | `prompt` with GitHub variables |

99| `max_turns` | `claude_args: --max-turns` |99| `max_turns` | `claude_args: --max-turns` |

114 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}114 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

115 custom_instructions: "Follow our coding standards"115 custom_instructions: "Follow our coding standards"

116 max_turns: "10"116 max_turns: "10"

117 model: "claude-sonnet-4-5-20250929"117 model: "claude-sonnet-4-6"

118```118```

119 119

120**GA version (v1.0):**120**GA version (v1.0):**

125 prompt: "Review this PR for security issues"125 prompt: "Review this PR for security issues"

126 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}126 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

127 claude_args: |127 claude_args: |

128 --system-prompt "Follow our coding standards"128 --append-system-prompt "Follow our coding standards"

129 --max-turns 10129 --max-turns 10

130 --model claude-sonnet-4-5-20250929130 --model claude-sonnet-4-6

131```131```

132 132

133<Tip>133<Tip>

157 # Responds to @claude mentions in comments157 # Responds to @claude mentions in comments

158```158```

159 159

160### Using slash commands160### Using skills

161 161

162```yaml theme={null}162```yaml theme={null}

163name: Code Review163name: Code Review

171 - uses: anthropics/claude-code-action@v1171 - uses: anthropics/claude-code-action@v1

172 with:172 with:

173 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}173 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

174 prompt: "/review"174 prompt: "Review this pull request for code quality, correctness, and security. Analyze the diff, then post your findings as review comments."

175 claude_args: "--max-turns 5"175 claude_args: "--max-turns 5"

176```176```

177 177

190 with:190 with:

191 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}191 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

192 prompt: "Generate a summary of yesterday's commits and open issues"192 prompt: "Generate a summary of yesterday's commits and open issues"

193 claude_args: "--model claude-opus-4-5-20251101"193 claude_args: "--model opus"

194```194```

195 195

196### Common use cases196### Common use cases

197 197

198In issue or PR comments:198In issue or PR comments:

199 199

200```200```text theme={null}

201@claude implement this feature based on the issue description201@claude implement this feature based on the issue description

202@claude how should I implement user authentication for this endpoint?202@claude how should I implement user authentication for this endpoint?

203@claude fix the TypeError in the user dashboard component203@claude fix the TypeError in the user dashboard component

213 213

214### Security considerations214### Security considerations

215 215

216<Warning>Never commit API keys directly to your repository!</Warning>216<Warning>Never commit API keys directly to your repository.</Warning>

217 217

218For comprehensive security guidance including permissions, authentication, and best practices, see the [Claude Code Action security documentation](https://github.com/anthropics/claude-code-action/blob/main/docs/security.md).218For comprehensive security guidance including permissions, authentication, and best practices, see the [Claude Code Action security documentation](https://github.com/anthropics/claude-code-action/blob/main/docs/security.md).

219 219

224* Limit action permissions to only what's necessary224* Limit action permissions to only what's necessary

225* Review Claude's suggestions before merging225* Review Claude's suggestions before merging

226 226

227Always use GitHub Secrets (e.g., `${{ secrets.ANTHROPIC_API_KEY }}`) rather than hardcoding API keys directly in your workflow files.227Always use GitHub Secrets (for example, `${{ secrets.ANTHROPIC_API_KEY }}`) rather than hardcoding API keys directly in your workflow files.

228 228

229### Optimizing performance229### Optimizing performance

230 230

267Key features:267Key features:

268 268

269* **Unified prompt interface** - Use `prompt` for all instructions269* **Unified prompt interface** - Use `prompt` for all instructions

270* **Slash commands** - Pre-built prompts like `/review` or `/fix`270* **Skills** - Invoke installed [skills](/en/skills) directly from the prompt

271* **CLI passthrough** - Any Claude Code CLI argument via `claude_args`271* **CLI passthrough** - Any Claude Code CLI argument via `claude_args`

272* **Flexible triggers** - Works with any GitHub event272* **Flexible triggers** - Works with any GitHub event

273 273

518 with:518 with:

519 github_token: ${{ steps.app-token.outputs.token }}519 github_token: ${{ steps.app-token.outputs.token }}

520 use_bedrock: "true"520 use_bedrock: "true"

521 claude_args: '--model us.anthropic.claude-sonnet-4-5-20250929-v1:0 --max-turns 10'521 claude_args: '--model us.anthropic.claude-sonnet-4-6 --max-turns 10'

522 ```522 ```

523 523

524 <Tip>524 <Tip>

525 The model ID format for Bedrock includes the region prefix (e.g., `us.anthropic.claude...`) and version suffix.525 The model ID format for Bedrock includes a region prefix (for example, `us.anthropic.claude-sonnet-4-6`).

526 </Tip>526 </Tip>

527 </Accordion>527 </Accordion>

528 528

625The Claude Code Action v1 uses a simplified configuration:625The Claude Code Action v1 uses a simplified configuration:

626 626

628| ------------------- | ----------------------------------------------- | -------- |628| ------------------- | ------------------------------------------------------------------ | -------- |

629| `prompt` | Instructions for Claude (text or slash command) | No\* |629| `prompt` | Instructions for Claude (plain text or a [skill](/en/skills) name) | No\* |

630| `claude_args` | CLI arguments passed to Claude Code | No |630| `claude_args` | CLI arguments passed to Claude Code | No |

631| `anthropic_api_key` | Claude API key | Yes\*\* |631| `anthropic_api_key` | Claude API key | Yes\*\* |

632| `github_token` | GitHub token for API access | No |632| `github_token` | GitHub token for API access | No |

637\*Prompt is optional - when omitted for issue/PR comments, Claude responds to trigger phrase\637\*Prompt is optional - when omitted for issue/PR comments, Claude responds to trigger phrase\

638\*\*Required for direct Claude API, not for Bedrock/Vertex638\*\*Required for direct Claude API, not for Bedrock/Vertex

639 639

640#### Using claude\_args640#### Pass CLI arguments

641 641

642The `claude_args` parameter accepts any Claude Code CLI arguments:642The `claude_args` parameter accepts any Claude Code CLI arguments:

643 643

644```yaml theme={null}644```yaml theme={null}

645claude_args: "--max-turns 5 --model claude-sonnet-4-5-20250929 --mcp-config /path/to/config.json"645claude_args: "--max-turns 5 --model claude-sonnet-4-6 --mcp-config /path/to/config.json"

646```646```

647 647

648Common arguments:648Common arguments:

649 649

650* `--max-turns`: Maximum conversation turns (default: 10)650* `--max-turns`: Maximum conversation turns (default: 10)

651* `--model`: Model to use (e.g., `claude-sonnet-4-5-20250929`)651* `--model`: Model to use (for example, `claude-sonnet-4-6`)

652* `--mcp-config`: Path to MCP configuration652* `--mcp-config`: Path to MCP configuration

653* `--allowed-tools`: Comma-separated list of allowed tools653* `--allowedTools`: Comma-separated list of allowed tools. The `--allowed-tools` alias also works.

654* `--debug`: Enable debug output654* `--debug`: Enable debug output

655 655

656### Alternative integration methods656### Alternative integration methods

gitlab-ci-cd.md +20 −16

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Claude Code GitLab CI/CD5# Claude Code GitLab CI/CD

2 6

3> Learn about integrating Claude Code into your development workflow with GitLab CI/CD7> Learn about integrating Claude Code into your development workflow with GitLab CI/CD

9</Info>13</Info>

10 14

11<Note>15<Note>

12 This integration is built on top of the [Claude Code CLI and SDK](https://docs.claude.com/en/docs/agent-sdk), enabling programmatic use of Claude in your CI/CD jobs and custom automation workflows.16 This integration is built on top of the [Claude Code CLI and Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview), enabling programmatic use of Claude in your CI/CD jobs and custom automation workflows.

13</Note>17</Note>

14 18

15## Why use Claude Code with GitLab?19## Why use Claude Code with GitLab?

77 before_script:81 before_script:

78 - apk update82 - apk update

79 - apk add --no-cache git curl bash83 - apk add --no-cache git curl bash

~~80 - npm install -g @anthropic-ai/claude-code~~84 - curl -fsSL https://claude.ai/install.sh | bash

81 script:85 script:

82 # Optional: start a GitLab MCP server if your setup provides one86 # Optional: start a GitLab MCP server if your setup provides one

83 - /bin/gitlab-mcp-server || true87 - /bin/gitlab-mcp-server || true

87 claude91 claude

88 -p "${AI_FLOW_INPUT:-'Review this MR and implement the requested changes'}"92 -p "${AI_FLOW_INPUT:-'Review this MR and implement the requested changes'}"

89 --permission-mode acceptEdits93 --permission-mode acceptEdits

~~90 --allowedTools "Bash(*) Read(*) Edit(*) Write(*) mcp__gitlab"~~94 --allowedTools "Bash Read Edit Write mcp__gitlab"

91 --debug95 --debug

92```96```

93 97

122 126

123In an issue comment:127In an issue comment:

124 128

125```129```text theme={null}

126@claude implement this feature based on the issue description130@claude implement this feature based on the issue description

127```131```

128 132

132 136

133In an MR discussion:137In an MR discussion:

134 138

135```139```text theme={null}

136@claude suggest a concrete approach to cache the results of this API call140@claude suggest a concrete approach to cache the results of this API call

137```141```

138 142

142 146

143In an issue or MR comment:147In an issue or MR comment:

144 148

145```149```text theme={null}

146@claude fix the TypeError in the user dashboard component150@claude fix the TypeError in the user dashboard component

147```151```

148 152

255 before_script:259 before_script:

256 - apk update260 - apk update

257 - apk add --no-cache git curl bash261 - apk add --no-cache git curl bash

258 - npm install -g @anthropic-ai/claude-code262 - curl -fsSL https://claude.ai/install.sh | bash

259 script:263 script:

260 - /bin/gitlab-mcp-server || true264 - /bin/gitlab-mcp-server || true

261 - >265 - >

262 claude266 claude

263 -p "${AI_FLOW_INPUT:-'Summarize recent changes and suggest improvements'}"267 -p "${AI_FLOW_INPUT:-'Summarize recent changes and suggest improvements'}"

264 --permission-mode acceptEdits268 --permission-mode acceptEdits

265 --allowedTools "Bash(*) Read(*) Edit(*) Write(*) mcp__gitlab"269 --allowedTools "Bash Read Edit Write mcp__gitlab"

266 --debug270 --debug

267 # Claude Code will use ANTHROPIC_API_KEY from CI/CD variables271 # Claude Code will use ANTHROPIC_API_KEY from CI/CD variables

268```272```

289 before_script:293 before_script:

290 - apk add --no-cache bash curl jq git python3 py3-pip294 - apk add --no-cache bash curl jq git python3 py3-pip

291 - pip install --no-cache-dir awscli295 - pip install --no-cache-dir awscli

292 - npm install -g @anthropic-ai/claude-code296 - curl -fsSL https://claude.ai/install.sh | bash

293 # Exchange GitLab OIDC token for AWS credentials297 # Exchange GitLab OIDC token for AWS credentials

294 - export AWS_WEB_IDENTITY_TOKEN_FILE="${CI_JOB_JWT_FILE:-/tmp/oidc_token}"298 - export AWS_WEB_IDENTITY_TOKEN_FILE="${CI_JOB_JWT_FILE:-/tmp/oidc_token}"

295 - if [ -n "${CI_JOB_JWT_V2}" ]; then printf "%s" "$CI_JOB_JWT_V2" > "$AWS_WEB_IDENTITY_TOKEN_FILE"; fi299 - if [ -n "${CI_JOB_JWT_V2}" ]; then printf "%s" "$CI_JOB_JWT_V2" > "$AWS_WEB_IDENTITY_TOKEN_FILE"; fi

308 claude312 claude

309 -p "${AI_FLOW_INPUT:-'Implement the requested changes and open an MR'}"313 -p "${AI_FLOW_INPUT:-'Implement the requested changes and open an MR'}"

310 --permission-mode acceptEdits314 --permission-mode acceptEdits

311 --allowedTools "Bash(*) Read(*) Edit(*) Write(*) mcp__gitlab"315 --allowedTools "Bash Read Edit Write mcp__gitlab"

312 --debug316 --debug

313 variables:317 variables:

314 AWS_REGION: "us-west-2"318 AWS_REGION: "us-west-2"

315```319```

316 320

317<Note>321<Note>

318 Model IDs for Bedrock include region-specific prefixes and version suffixes (for example, `us.anthropic.claude-sonnet-4-5-20250929-v1:0`). Pass the desired model via your job configuration or prompt if your workflow supports it.322 Model IDs for Bedrock include region-specific prefixes (for example, `us.anthropic.claude-sonnet-4-6`). Pass the desired model via your job configuration or prompt if your workflow supports it.

319</Note>323</Note>

320 324

321### Google Vertex AI job example (Workload Identity Federation)325### Google Vertex AI job example (Workload Identity Federation)

339 rules:343 rules:

340 - if: '$CI_PIPELINE_SOURCE == "web"'344 - if: '$CI_PIPELINE_SOURCE == "web"'

341 before_script:345 before_script:

342 - apt-get update && apt-get install -y git nodejs npm && apt-get clean346 - apt-get update && apt-get install -y git && apt-get clean

343 - npm install -g @anthropic-ai/claude-code347 - curl -fsSL https://claude.ai/install.sh | bash

344 # Authenticate to Google Cloud via WIF (no downloaded keys)348 # Authenticate to Google Cloud via WIF (no downloaded keys)

345 - >349 - >

346 gcloud auth login --cred-file=<(cat <<EOF350 gcloud auth login --cred-file=<(cat <<EOF

361 claude365 claude

362 -p "${AI_FLOW_INPUT:-'Review and update code as requested'}"366 -p "${AI_FLOW_INPUT:-'Review and update code as requested'}"

363 --permission-mode acceptEdits367 --permission-mode acceptEdits

364 --allowedTools "Bash(*) Read(*) Edit(*) Write(*) mcp__gitlab"368 --allowedTools "Bash Read Edit Write mcp__gitlab"

365 --debug369 --debug

366 variables:370 variables:

367 CLOUD_ML_REGION: "us-east5"371 CLOUD_ML_REGION: "us-east5"

379 383

380### Security considerations384### Security considerations

381 385

382Never commit API keys or cloud credentials to your repository! Always use GitLab CI/CD variables:386**Never commit API keys or cloud credentials to your repository**. Always use GitLab CI/CD variables:

383 387

384* Add `ANTHROPIC_API_KEY` as a masked variable (and protect it if needed)388* Add `ANTHROPIC_API_KEY` as a masked variable (and protect it if needed)

385* Use provider-specific OIDC where possible (no long-lived keys)389* Use provider-specific OIDC where possible (no long-lived keys)

404* **API costs**:408* **API costs**:

405 * Each Claude interaction consumes tokens based on prompt and response size409 * Each Claude interaction consumes tokens based on prompt and response size

406 * Token usage varies by task complexity and codebase size410 * Token usage varies by task complexity and codebase size

407 * See [Anthropic pricing](https://docs.claude.com/en/docs/about-claude/pricing) for details411 * See [Anthropic pricing](https://platform.claude.com/docs/en/about-claude/pricing) for details

408 412

409* **Cost optimization tips**:413* **Cost optimization tips**:

410 * Use specific `@claude` commands to reduce unnecessary turns414 * Use specific `@claude` commands to reduce unnecessary turns

google-vertex-ai.md +36 −30

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Claude Code on Google Vertex AI5# Claude Code on Google Vertex AI

2 6

3> Learn about configuring Claude Code through Google Vertex AI, including setup, IAM configuration, and troubleshooting.7> Learn about configuring Claude Code through Google Vertex AI, including setup, IAM configuration, and troubleshooting.

8 12

9* A Google Cloud Platform (GCP) account with billing enabled13* A Google Cloud Platform (GCP) account with billing enabled

10* A GCP project with Vertex AI API enabled14* A GCP project with Vertex AI API enabled

~~11* Access to desired Claude models (e.g., Claude Sonnet 4.5)~~15* Access to desired Claude models (for example, Claude Sonnet 4.6)

12* Google Cloud SDK (`gcloud`) installed and configured16* Google Cloud SDK (`gcloud`) installed and configured

13* Quota allocated in desired GCP region17* Quota allocated in desired GCP region

14 18

19<Note>

20 If you are deploying Claude Code to multiple users, [pin your model versions](#5-pin-model-versions) to prevent breakage when Anthropic releases new models.

21</Note>

15## Region Configuration23## Region Configuration

16 24

17Claude Code can be used with both Vertex AI [global](https://cloud.google.com/blog/products/ai-machine-learning/global-endpoint-for-claude-models-generally-available-on-vertex-ai) and regional endpoints.25Claude Code can be used with both Vertex AI [global](https://cloud.google.com/blog/products/ai-machine-learning/global-endpoint-for-claude-models-generally-available-on-vertex-ai) and regional endpoints.

18 26

19<Note>27<Note>

20 Vertex AI may not support the Claude Code default models on all regions. You may need to switch to a [supported region or model](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations#genai-partner-models).28 Vertex AI may not support the Claude Code default models in all [regions](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations#genai-partner-models) or on [global endpoints](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/use-partner-models#supported_models). You may need to switch to a supported region, use a regional endpoint, or specify a supported model.

~~21</Note>~~

~~23<Note>~~

24 Vertex AI may not support the Claude Code default models on global endpoints. You may need to switch to a regional endpoint or [supported model](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/use-partner-models#supported_models).

25</Note>29</Note>

26 30

27## Setup31## Setup

44 48

451. Navigate to the [Vertex AI Model Garden](https://console.cloud.google.com/vertex-ai/model-garden)491. Navigate to the [Vertex AI Model Garden](https://console.cloud.google.com/vertex-ai/model-garden)

462. Search for "Claude" models502. Search for "Claude" models

~~473. Request access to desired Claude models (e.g., Claude Sonnet 4.5)~~513. Request access to desired Claude models (for example, Claude Sonnet 4.6)

484. Wait for approval (may take 24-48 hours)524. Wait for approval (may take 24-48 hours)

49 53

50### 3. Configure GCP credentials54### 3. Configure GCP credentials

81export VERTEX_REGION_CLAUDE_4_1_OPUS=europe-west185export VERTEX_REGION_CLAUDE_4_1_OPUS=europe-west1

82```86```

83 87

~~84<Note>~~88[Prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) is automatically supported when you specify the `cache_control` ephemeral flag. To disable it, set `DISABLE_PROMPT_CACHING=1`. For heightened rate limits, contact Google Cloud support. When using Vertex AI, the `/login` and `/logout` commands are disabled since authentication is handled through Google Cloud credentials.

85 [Prompt caching](https://docs.claude.com/en/docs/build-with-claude/prompt-caching) is automatically supported when you specify the `cache_control` ephemeral flag. To disable it, set `DISABLE_PROMPT_CACHING=1`. For heightened rate limits, contact Google Cloud support.

~~86</Note>~~

87 89

~~88<Note>~~90### 5. Pin model versions

~~89 When using Vertex AI, the `/login` and `/logout` commands are disabled since authentication is handled through Google Cloud credentials.~~

~~90</Note>~~

91 91

~~92### 5. Model configuration~~92<Warning>

93 Pin specific model versions for every deployment. If you use model aliases (`sonnet`, `opus`, `haiku`) without pinning, Claude Code may attempt to use a newer model version that isn't enabled in your Vertex AI project, breaking existing users when Anthropic releases updates.

94</Warning>

93 95

~~94Claude Code uses these default models for Vertex AI:~~96Set these environment variables to specific Vertex AI model IDs:

98```bash theme={null}

99export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6'

100export ANTHROPIC_DEFAULT_SONNET_MODEL='claude-sonnet-4-6'

101export ANTHROPIC_DEFAULT_HAIKU_MODEL='claude-haiku-4-5@20251001'

102```

103

104For current and legacy model IDs, see [Models overview](https://platform.claude.com/docs/en/about-claude/models/overview). See [Model configuration](/en/model-config#pin-models-for-third-party-deployments) for the full list of environment variables.

105

106Claude Code uses these default models when no pinning variables are set:

95 107

96| Model type | Default value |108| Model type | Default value |

~~97| :--------------- | :--------------------------- |~~109| :--------------- | :-------------------------- |

100 112

101<Note>113To customize models further:

102 For Vertex AI users, Claude Code will not automatically upgrade from Haiku 3.5 to Haiku 4.5. To manually switch to a newer Haiku model, set the `ANTHROPIC_DEFAULT_HAIKU_MODEL` environment variable to the full model name (e.g., `claude-haiku-4-5@20251001`).

103</Note>

~~104~~

105To customize models:

106 114

107```bash theme={null}115```bash theme={null}

108export ANTHROPIC_MODEL='claude-opus-4-1@20250805'116export ANTHROPIC_MODEL='claude-opus-4-6'

109export ANTHROPIC_SMALL_FAST_MODEL='claude-haiku-4-5@20251001'117export ANTHROPIC_DEFAULT_HAIKU_MODEL='claude-haiku-4-5@20251001'

110```118```

111 119

112## IAM configuration120## IAM configuration

122For details, see [Vertex IAM documentation](https://cloud.google.com/vertex-ai/docs/general/access-control).130For details, see [Vertex IAM documentation](https://cloud.google.com/vertex-ai/docs/general/access-control).

123 131

124<Note>132<Note>

125 We recommend creating a dedicated GCP project for Claude Code to simplify cost tracking and access control.133 Create a dedicated GCP project for Claude Code to simplify cost tracking and access control.

126</Note>134</Note>

127 135

128## 1M token context window136## 1M token context window

129 137

130Claude Sonnet 4 and Sonnet 4.5 support the [1M token context window](https://docs.claude.com/en/docs/build-with-claude/context-windows#1m-token-context-window) on Vertex AI.138Claude Opus 4.6, Sonnet 4.6, Sonnet 4.5, and Sonnet 4 support the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows#1m-token-context-window) on Vertex AI. Claude Code automatically enables the extended context window when you select a 1M model variant.

131 139

132<Note>140To enable the 1M context window for your pinned model, append `[1m]` to the model ID. See [Pin models for third-party deployments](/en/model-config#pin-models-for-third-party-deployments) for details.

133 The 1M token context window is currently in beta. To use the extended context window, include the `context-1m-2025-08-07` beta header in your Vertex AI requests.

134</Note>

135 141

136## Troubleshooting142## Troubleshooting

137 143

144* Confirm model is Enabled in [Model Garden](https://console.cloud.google.com/vertex-ai/model-garden)150* Confirm model is Enabled in [Model Garden](https://console.cloud.google.com/vertex-ai/model-garden)

145* Verify you have access to the specified region151* Verify you have access to the specified region

146* If using `CLOUD_ML_REGION=global`, check that your models support global endpoints in [Model Garden](https://console.cloud.google.com/vertex-ai/model-garden) under "Supported features". For models that don't support global endpoints, either:152* If using `CLOUD_ML_REGION=global`, check that your models support global endpoints in [Model Garden](https://console.cloud.google.com/vertex-ai/model-garden) under "Supported features". For models that don't support global endpoints, either:

147 * Specify a supported model via `ANTHROPIC_MODEL` or `ANTHROPIC_SMALL_FAST_MODEL`, or153 * Specify a supported model via `ANTHROPIC_MODEL` or `ANTHROPIC_DEFAULT_HAIKU_MODEL`, or

148 * Set a regional endpoint using `VERTEX_REGION_<MODEL_NAME>` environment variables154 * Set a regional endpoint using `VERTEX_REGION_<MODEL_NAME>` environment variables

149 155

150If you encounter 429 errors:156If you encounter 429 errors:

headless.md +132 −136

Details

~~1# Headless mode~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Run Claude Code programmatically without interactive UI~~5# Run Claude Code programmatically

4 6

~~5## Overview~~7> Use the Agent SDK to run Claude Code programmatically from the CLI, Python, or TypeScript.

6 8

~~7The headless mode allows you to run Claude Code programmatically from command line scripts and automation tools without any interactive UI.~~9The [Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview) gives you the same tools, agent loop, and context management that power Claude Code. It's available as a CLI for scripts and CI/CD, or as [Python](https://platform.claude.com/docs/en/agent-sdk/python) and [TypeScript](https://platform.claude.com/docs/en/agent-sdk/typescript) packages for full programmatic control.

8 10

~~9## Basic usage~~11<Note>

12 The CLI was previously called "headless mode." The `-p` flag and all CLI options work the same way.

13</Note>

10 14

~~11The primary command-line interface to Claude Code is the `claude` command. Use the `--print` (or `-p`) flag to run in non-interactive mode and print the final result:~~15To run Claude Code programmatically from the CLI, pass `-p` with your prompt and any [CLI options](/en/cli-reference):

12 16

13```bash theme={null}17```bash theme={null}

~~14claude -p "Stage my changes and write a set of commits for them" \~~18claude -p "Find and fix the bug in auth.py" --allowedTools "Read,Edit,Bash"

~~15 --allowedTools "Bash,Read" \~~

~~16 --permission-mode acceptEdits~~

17```19```

18 20

~~19## Configuration Options~~21This page covers using the Agent SDK via the CLI (`claude -p`). For the Python and TypeScript SDK packages with structured outputs, tool approval callbacks, and native message objects, see the [full Agent SDK documentation](https://platform.claude.com/docs/en/agent-sdk/overview).

~~21Headless mode leverages all the CLI options available in Claude Code. Here are the key ones for automation and scripting:~~

22 22

23| Flag | Description | Example |23## Basic usage

24| :------------------------- | :----------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |

25| `--print`, `-p` | Run in non-interactive mode | `claude -p "query"` |

26| `--output-format` | Specify output format (`text`, `json`, `stream-json`) | `claude -p --output-format json` |

27| `--resume`, `-r` | Resume a conversation by session ID | `claude --resume abc123` |

28| `--continue`, `-c` | Continue the most recent conversation | `claude --continue` |

29| `--verbose` | Enable verbose logging | `claude --verbose` |

30| `--append-system-prompt` | Append to system prompt (only with `--print`) | `claude --append-system-prompt "Custom instruction"` |

31| `--allowedTools` | Space-separated list of allowed tools, or <br /><br /> string of comma-separated list of allowed tools | `claude --allowedTools mcp__slack mcp__filesystem`<br /><br />`claude --allowedTools "Bash(npm install),mcp__filesystem"` |

32| `--disallowedTools` | Space-separated list of denied tools, or <br /><br /> string of comma-separated list of denied tools | `claude --disallowedTools mcp__splunk mcp__github`<br /><br />`claude --disallowedTools "Bash(git commit),mcp__github"` |

33| `--mcp-config` | Load MCP servers from a JSON file | `claude --mcp-config servers.json` |

34| `--permission-prompt-tool` | MCP tool for handling permission prompts (only with `--print`) | `claude --permission-prompt-tool mcp__auth__prompt` |

35 24

~~36For a complete list of CLI options and features, see the [CLI reference](/en/cli-reference) documentation.~~25Add the `-p` (or `--print`) flag to any `claude` command to run it non-interactively. All [CLI options](/en/cli-reference) work with `-p`, including:

37 26

~~38## Multi-turn conversations~~27* `--continue` for [continuing conversations](#continue-conversations)

28* `--allowedTools` for [auto-approving tools](#auto-approve-tools)

29* `--output-format` for [structured output](#get-structured-output)

39 30

~~40For multi-turn conversations, you can resume conversations or continue from the most recent session:~~31This example asks Claude a question about your codebase and prints the response:

41 32

42```bash theme={null}33```bash theme={null}

~~43# Continue the most recent conversation~~34claude -p "What does the auth module do?"

~~44claude --continue "Now refactor this for better performance"~~35```

45 36

~~46# Resume a specific conversation by session ID~~37### Start faster with bare mode

~~47claude --resume 550e8400-e29b-41d4-a716-446655440000 "Update the tests"~~

48 38

~~49# Resume in non-interactive mode~~39Add `--bare` to reduce startup time by skipping auto-discovery of hooks, skills, plugins, MCP servers, auto memory, and CLAUDE.md. Without it, `claude -p` loads the same [context](/en/how-claude-code-works#the-context-window) an interactive session would, including anything configured in the working directory or `~/.claude`.

~~50claude --resume 550e8400-e29b-41d4-a716-446655440000 "Fix all linting issues" --no-interactive~~

~~51```~~

52 40

~~53## Output Formats~~41Bare mode is useful for CI and scripts where you need the same result on every machine. A hook in a teammate's `~/.claude` or an MCP server in the project's `.mcp.json` won't run, because bare mode never reads them. Only flags you pass explicitly take effect.

54 42

~~55### Text Output (Default)~~43This example runs a one-off summarize task in bare mode and pre-approves the Read tool so the call completes without a permission prompt:

56 44

57```bash theme={null}45```bash theme={null}

~~58claude -p "Explain file src/components/Header.tsx"~~46claude --bare -p "Summarize this file" --allowedTools "Read"

~~59# Output: This is a React component showing...~~

60```47```

61 48

~~62### JSON Output~~49In bare mode Claude has access to the Bash, file read, and file edit tools. Pass any context you need with a flag:

63 50

~~64Returns structured data including metadata:~~51| To load | Use |

52| ----------------------- | ------------------------------------------------------- |

53| System prompt additions | `--append-system-prompt`, `--append-system-prompt-file` |

54| Settings | `--settings <file-or-json>` |

55| MCP servers | `--mcp-config <file-or-json>` |

56| Custom agents | `--agents <json>` |

57| A plugin directory | `--plugin-dir <path>` |

65 58

~~66```bash theme={null}~~59Bare mode skips OAuth and keychain reads. Anthropic authentication must come from `ANTHROPIC_API_KEY` or an `apiKeyHelper` in the JSON passed to `--settings`. Bedrock, Vertex, and Foundry use their usual provider credentials.

~~67claude -p "How does the data layer work?" --output-format json~~

~~68```~~

69 60

~~70Response format:~~61<Note>

71 62 `--bare` is the recommended mode for scripted and SDK calls, and will become the default for `-p` in a future release.

~~72```json theme={null}~~63</Note>

~~73{~~

~~74 "type": "result",~~

~~75 "subtype": "success",~~

~~76 "total_cost_usd": 0.003,~~

~~77 "is_error": false,~~

~~78 "duration_ms": 1234,~~

~~79 "duration_api_ms": 800,~~

~~80 "num_turns": 6,~~

~~81 "result": "The response text here...",~~

~~82 "session_id": "abc123"~~

~~83}~~

~~84```~~

85 64

~~86### Streaming JSON Output~~65## Examples

87 66

~~88Streams each message as it is received:~~67These examples highlight common CLI patterns. For CI and other scripted calls, add [`--bare`](#start-faster-with-bare-mode) so they don't pick up whatever happens to be configured locally.

89 68

~~90```bash theme={null}~~69### Get structured output

~~91claude -p "Build an application" --output-format stream-json~~

~~92```~~

93 70

94Each conversation begins with an initial `init` system message, followed by a list of user and assistant messages, followed by a final `result` system message with stats. Each message is emitted as a separate JSON object.71Use `--output-format` to control how responses are returned:

95 72

~~96## Input Formats~~73* `text` (default): plain text output

74* `json`: structured JSON with result, session ID, and metadata

75* `stream-json`: newline-delimited JSON for real-time streaming

97 76

~~98### Text Input (Default)~~77This example returns a project summary as JSON with session metadata, with the text result in the `result` field:

99 78

100```bash theme={null}79```bash theme={null}

101# Direct argument80claude -p "Summarize this project" --output-format json

102claude -p "Explain this code"

~~103~~

104# From stdin

105echo "Explain this code" | claude -p

106```81```

107 82

108### Streaming JSON Input83To get output conforming to a specific schema, use `--output-format json` with `--json-schema` and a [JSON Schema](https://json-schema.org/) definition. The response includes metadata about the request (session ID, usage, etc.) with the structured output in the `structured_output` field.

109 84

110A stream of messages provided via `stdin` where each message represents a user turn. This allows multiple turns of a conversation without re-launching the `claude` binary and allows providing guidance to the model while it is processing a request.85This example extracts function names and returns them as an array of strings:

~~111~~

112Each message is a JSON 'User message' object, following the same format as the output message schema. Messages are formatted using the [jsonl](https://jsonlines.org/) format where each line of input is a complete JSON object. Streaming JSON input requires `-p` and `--output-format stream-json`.

113 86

114```bash theme={null}87```bash theme={null}

115echo '{"type":"user","message":{"role":"user","content":[{"type":"text","text":"Explain this code"}]}}' | claude -p --output-format=stream-json --input-format=stream-json --verbose88claude -p "Extract the main function names from auth.py" \

89 --output-format json \

90 --json-schema '{"type":"object","properties":{"functions":{"type":"array","items":{"type":"string"}}},"required":["functions"]}'

116```91```

117 92

118## Agent Integration Examples93<Tip>

94 Use a tool like [jq](https://jqlang.github.io/jq/) to parse the response and extract specific fields:

119 95

120### SRE Incident Response Bot96 ```bash theme={null}

97 # Extract the text result

98 claude -p "Summarize this project" --output-format json | jq -r '.result'

121 99

122```bash theme={null}100 # Extract structured output

123#!/bin/bash101 claude -p "Extract function names from auth.py" \

102 --output-format json \

103 --json-schema '{"type":"object","properties":{"functions":{"type":"array","items":{"type":"string"}}},"required":["functions"]}' \

104 | jq '.structured_output'

105 ```

106</Tip>

124 107

125# Automated incident response agent108### Stream responses

126investigate_incident() {

127 local incident_description="$1"

128 local severity="${2:-medium}"

129 109

130 claude -p "Incident: $incident_description (Severity: $severity)" \110Use `--output-format stream-json` with `--verbose` and `--include-partial-messages` to receive tokens as they're generated. Each line is a JSON object representing an event:

131 --append-system-prompt "You are an SRE expert. Diagnose the issue, assess impact, and provide immediate action items." \

132 --output-format json \

133 --allowedTools "Bash,Read,WebSearch,mcp__datadog" \

134 --mcp-config monitoring-tools.json

135}

136 111

137# Usage112```bash theme={null}

138investigate_incident "Payment API returning 500 errors" "high"113claude -p "Explain recursion" --output-format stream-json --verbose --include-partial-messages

139```114```

140 115

141### Automated Security Review116The following example uses [jq](https://jqlang.github.io/jq/) to filter for text deltas and display just the streaming text. The `-r` flag outputs raw strings (no quotes) and `-j` joins without newlines so tokens stream continuously:

142 117

143```bash theme={null}118```bash theme={null}

144# Security audit agent for pull requests119claude -p "Write a poem" --output-format stream-json --verbose --include-partial-messages | \

145audit_pr() {120 jq -rj 'select(.type == "stream_event" and .event.delta.type? == "text_delta") | .event.delta.text'

146 local pr_number="$1"121```

147 122

148 gh pr diff "$pr_number" | claude -p \123When an API request fails with a retryable error, Claude Code emits a `system/api_retry` event before retrying. You can use this to surface retry progress or implement custom backoff logic.

149 --append-system-prompt "You are a security engineer. Review this PR for vulnerabilities, insecure patterns, and compliance issues." \

150 --output-format json \

151 --allowedTools "Read,Grep,WebSearch"

152}

153 124

154# Usage and save to file125| Field | Type | Description |

155audit_pr 123 > security-report.json126| ---------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |

156```127| `type` | `"system"` | message type |

128| `subtype` | `"api_retry"` | identifies this as a retry event |

129| `attempt` | integer | current attempt number, starting at 1 |

130| `max_retries` | integer | total retries permitted |

131| `retry_delay_ms` | integer | milliseconds until the next attempt |

132| `error_status` | integer or null | HTTP status code, or `null` for connection errors with no HTTP response |

133| `error` | string | error category: `authentication_failed`, `billing_error`, `rate_limit`, `invalid_request`, `server_error`, `max_output_tokens`, or `unknown` |

134| `uuid` | string | unique event identifier |

135| `session_id` | string | session the event belongs to |

157 136

158### Multi-turn Legal Assistant137For programmatic streaming with callbacks and message objects, see [Stream responses in real-time](https://platform.claude.com/docs/en/agent-sdk/streaming-output) in the Agent SDK documentation.

138

139### Auto-approve tools

140

141Use `--allowedTools` to let Claude use certain tools without prompting. This example runs a test suite and fixes failures, allowing Claude to execute Bash commands and read/edit files without asking for permission:

159 142

160```bash theme={null}143```bash theme={null}

161# Legal document review with session persistence144claude -p "Run the test suite and fix any failures" \

162session_id=$(claude -p "Start legal review session" --output-format json | jq -r '.session_id')145 --allowedTools "Bash,Read,Edit"

146```

163 147

164# Review contract in multiple steps148### Create a commit

165claude -p --resume "$session_id" "Review contract.pdf for liability clauses"149

166claude -p --resume "$session_id" "Check compliance with GDPR requirements"150This example reviews staged changes and creates a commit with an appropriate message:

167claude -p --resume "$session_id" "Generate executive summary of risks"151

152```bash theme={null}

153claude -p "Look at my staged changes and create an appropriate commit" \

154 --allowedTools "Bash(git diff *),Bash(git log *),Bash(git status *),Bash(git commit *)"

168```155```

169 156

170## Best Practices157The `--allowedTools` flag uses [permission rule syntax](/en/settings#permission-rule-syntax). The trailing ` *` enables prefix matching, so `Bash(git diff *)` allows any command starting with `git diff`. The space before `*` is important: without it, `Bash(git diff*)` would also match `git diff-index`.

171 158

172* **Use JSON output format** for programmatic parsing of responses:159<Note>

160 User-invoked [skills](/en/skills) like `/commit` and [built-in commands](/en/commands) are only available in interactive mode. In `-p` mode, describe the task you want to accomplish instead.

161</Note>

173 162

174 ```bash theme={null}163### Customize the system prompt

175 # Parse JSON response with jq

176 result=$(claude -p "Generate code" --output-format json)

177 code=$(echo "$result" | jq -r '.result')

178 cost=$(echo "$result" | jq -r '.cost_usd')

179 ```

180 164

181* **Handle errors gracefully** - check exit codes and stderr:165Use `--append-system-prompt` to add instructions while keeping Claude Code's default behavior. This example pipes a PR diff to Claude and instructs it to review for security vulnerabilities:

182 166

183 ```bash theme={null}167```bash theme={null}

184 if ! claude -p "$prompt" 2>error.log; then168gh pr diff "$1" | claude -p \

185 echo "Error occurred:" >&2169 --append-system-prompt "You are a security engineer. Review for vulnerabilities." \

186 cat error.log >&2170 --output-format json

187 exit 1171```

188 fi

189 ```

190 172

191* **Use session management** for maintaining context in multi-turn conversations173See [system prompt flags](/en/cli-reference#system-prompt-flags) for more options including `--system-prompt` to fully replace the default prompt.

192 174

193* **Consider timeouts** for long-running operations:175### Continue conversations

194 176

195 ```bash theme={null}177Use `--continue` to continue the most recent conversation, or `--resume` with a session ID to continue a specific conversation. This example runs a review, then sends follow-up prompts:

196 timeout 300 claude -p "$complex_prompt" || echo "Timed out after 5 minutes"

197 ```

198 178

199* **Respect rate limits** when making multiple requests by adding delays between calls179```bash theme={null}

180# First request

181claude -p "Review this codebase for performance issues"

182

183# Continue the most recent conversation

184claude -p "Now focus on the database queries" --continue

185claude -p "Generate a summary of all issues found" --continue

186```

187

188If you're running multiple conversations, capture the session ID to resume a specific one:

189

190```bash theme={null}

191session_id=$(claude -p "Start a review" --output-format json | jq -r '.session_id')

192claude -p "Continue that review" --resume "$session_id"

193```

200 194

201## Related Resources195## Next steps

202 196

203* [CLI usage and controls](/en/cli-reference) - Complete CLI documentation197* [Agent SDK quickstart](https://platform.claude.com/docs/en/agent-sdk/quickstart): build your first agent with Python or TypeScript

204* [Common workflows](/en/common-workflows) - Step-by-step guides for common use cases198* [CLI reference](/en/cli-reference): all CLI flags and options

199* [GitHub Actions](/en/github-actions): use the Agent SDK in GitHub workflows

200* [GitLab CI/CD](/en/gitlab-ci-cd): use the Agent SDK in GitLab pipelines

hooks.md +1738 −709

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Hooks reference5# Hooks reference

2 6

~~3> This page provides reference documentation for implementing hooks in Claude Code.~~7> Reference for Claude Code hook events, configuration schema, JSON input/output formats, exit codes, async hooks, HTTP hooks, prompt hooks, and MCP tool hooks.

4 8

5<Tip>9<Tip>

~~6 For a quickstart guide with examples, see [Get started with Claude Code hooks](/en/hooks-guide).~~10 For a quickstart guide with examples, see [Automate workflows with hooks](/en/hooks-guide).

7</Tip>11</Tip>

8 12

~~9## Configuration~~13Hooks are user-defined shell commands, HTTP endpoints, or LLM prompts that execute automatically at specific points in Claude Code's lifecycle. Use this reference to look up event schemas, configuration options, JSON input/output formats, and advanced features like async hooks, HTTP hooks, and MCP tool hooks. If you're setting up hooks for the first time, start with the [guide](/en/hooks-guide) instead.

10 14

~~11Claude Code hooks are configured in your [settings files](/en/settings):~~15## Hook lifecycle

12 16

~~13* `~/.claude/settings.json` - User settings~~17Hooks fire at specific points during a Claude Code session. When an event fires and a matcher matches, Claude Code passes JSON context about the event to your hook handler. For command hooks, input arrives on stdin. For HTTP hooks, it arrives as the POST request body. Your handler can then inspect the input, take action, and optionally return a decision. Some events fire once per session, while others fire repeatedly inside the agentic loop:

~~14* `.claude/settings.json` - Project settings~~18

~~15* `.claude/settings.local.json` - Local project settings (not committed)~~19<div style={{maxWidth: "500px", margin: "0 auto"}}>

~~16* Enterprise managed policy settings~~20 <Frame>

17 21 <img src="https://mintcdn.com/claude-code/JCMefyZyaJwkJgv-/images/hooks-lifecycle.svg?fit=max&auto=format&n=JCMefyZyaJwkJgv-&q=85&s=f004f3fc7324fa2a4630e8d6559cf6dd" alt="Hook lifecycle diagram showing the sequence of hooks from SessionStart through the agentic loop (PreToolUse, PermissionRequest, PostToolUse, SubagentStart/Stop, TaskCompleted) to Stop or StopFailure, TeammateIdle, PreCompact, PostCompact, and SessionEnd, with Elicitation and ElicitationResult nested inside MCP tool execution and WorktreeCreate, WorktreeRemove, Notification, ConfigChange, InstructionsLoaded, CwdChanged, and FileChanged as standalone async events" width="520" height="1100" data-path="images/hooks-lifecycle.svg" />

~~18### Structure~~22 </Frame>

19 23</div>

~~20Hooks are organized by matchers, where each matcher can have multiple hooks:~~24

25The table below summarizes when each event fires. The [Hook events](#hook-events) section documents the full input schema and decision control options for each one.

27| Event | When it fires |

28| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |

29| `SessionStart` | When a session begins or resumes |

30| `UserPromptSubmit` | When you submit a prompt, before Claude processes it |

31| `PreToolUse` | Before a tool call executes. Can block it |

32| `PermissionRequest` | When a permission dialog appears |

33| `PostToolUse` | After a tool call succeeds |

34| `PostToolUseFailure` | After a tool call fails |

35| `Notification` | When Claude Code sends a notification |

36| `SubagentStart` | When a subagent is spawned |

37| `SubagentStop` | When a subagent finishes |

38| `Stop` | When Claude finishes responding |

39| `StopFailure` | When the turn ends due to an API error. Output and exit code are ignored |

40| `TeammateIdle` | When an [agent team](/en/agent-teams) teammate is about to go idle |

41| `TaskCompleted` | When a task is being marked as completed |

42| `InstructionsLoaded` | When a CLAUDE.md or `.claude/rules/*.md` file is loaded into context. Fires at session start and when files are lazily loaded during a session |

43| `ConfigChange` | When a configuration file changes during a session |

44| `CwdChanged` | When the working directory changes, for example when Claude executes a `cd` command. Useful for reactive environment management with tools like direnv |

45| `FileChanged` | When a watched file changes on disk. The `matcher` field specifies which filenames to watch |

46| `WorktreeCreate` | When a worktree is being created via `--worktree` or `isolation: "worktree"`. Replaces default git behavior |

47| `WorktreeRemove` | When a worktree is being removed, either at session exit or when a subagent finishes |

48| `PreCompact` | Before context compaction |

49| `PostCompact` | After context compaction completes |

50| `Elicitation` | When an MCP server requests user input during a tool call |

51| `ElicitationResult` | After a user responds to an MCP elicitation, before the response is sent back to the server |

52| `SessionEnd` | When a session terminates |

54### How a hook resolves

56To see how these pieces fit together, consider this `PreToolUse` hook that blocks destructive shell commands. The hook runs `block-rm.sh` before every Bash tool call:

21 57

22```json theme={null}58```json theme={null}

23{59{

24 "hooks": {60 "hooks": {

~~25 "EventName": [~~61 "PreToolUse": [

26 {62 {

~~27 "matcher": "ToolPattern",~~63 "matcher": "Bash",

28 "hooks": [64 "hooks": [

29 {65 {

30 "type": "command",66 "type": "command",

~~31 "command": "your-command-here"~~67 "command": ".claude/hooks/block-rm.sh"

32 }68 }

33 ]69 ]

34 }70 }

37}73}

38```74```

39 75

~~40* **matcher**: Pattern to match tool names, case-sensitive (only applicable for~~76The script reads the JSON input from stdin, extracts the command, and returns a `permissionDecision` of `"deny"` if it contains `rm -rf`:

~~41 `PreToolUse`, `PermissionRequest`, and `PostToolUse`)~~

~~42 * Simple strings match exactly: `Write` matches only the Write tool~~

~~43 * Supports regex: `Edit|Write` or `Notebook.*`~~

~~44 * Use `*` to match all tools. You can also use empty string (`""`) or leave~~

~~45 `matcher` blank.~~

~~46* **hooks**: Array of hooks to execute when the pattern matches~~

~~47 * `type`: Hook execution type - `"command"` for bash commands or `"prompt"` for LLM-based evaluation~~

~~48 * `command`: (For `type: "command"`) The bash command to execute (can use `$CLAUDE_PROJECT_DIR` environment variable)~~

~~49 * `prompt`: (For `type: "prompt"`) The prompt to send to the LLM for evaluation~~

~~50 * `timeout`: (Optional) How long a hook should run, in seconds, before canceling that specific hook~~

~~52For events like `UserPromptSubmit`, `Stop`, and `SubagentStop`~~

~~53that don't use matchers, you can omit the matcher field:~~

54 77

~~55```json theme={null}~~78```bash theme={null}

~~56{~~79#!/bin/bash

~~57 "hooks": {~~80# .claude/hooks/block-rm.sh

~~58 "UserPromptSubmit": [~~81COMMAND=$(jq -r '.tool_input.command')

~~59 {~~82

~~60 "hooks": [~~83if echo "$COMMAND" | grep -q 'rm -rf'; then

~~61 {~~84 jq -n '{

~~62 "type": "command",~~85 hookSpecificOutput: {

~~63 "command": "/path/to/prompt-validator.py"~~86 hookEventName: "PreToolUse",

87 permissionDecision: "deny",

88 permissionDecisionReason: "Destructive command blocked by hook"

64 }89 }

~~65 ]~~90 }'

91else

92 exit 0 # allow the command

93fi

94```

96Now suppose Claude Code decides to run `Bash "rm -rf /tmp/build"`. Here's what happens:

98<Frame>

99 <img src="https://mintcdn.com/claude-code/c5r9_6tjPMzFdDDT/images/hook-resolution.svg?fit=max&auto=format&n=c5r9_6tjPMzFdDDT&q=85&s=ad667ee6d86ab2276aa48a4e73e220df" alt="Hook resolution flow: PreToolUse event fires, matcher checks for Bash match, hook handler runs, result returns to Claude Code" width="780" height="290" data-path="images/hook-resolution.svg" />

100</Frame>

101

102<Steps>

103 <Step title="Event fires">

104 The `PreToolUse` event fires. Claude Code sends the tool input as JSON on stdin to the hook:

105

106 ```json theme={null}

107 { "tool_name": "Bash", "tool_input": { "command": "rm -rf /tmp/build" }, ... }

108 ```

109 </Step>

110

111 <Step title="Matcher checks">

112 The matcher `"Bash"` matches the tool name, so `block-rm.sh` runs. If you omit the matcher or use `"*"`, the hook runs on every occurrence of the event. Hooks only skip when a matcher is defined and doesn't match.

113 </Step>

114

115 <Step title="Hook handler runs">

116 The script extracts `"rm -rf /tmp/build"` from the input and finds `rm -rf`, so it prints a decision to stdout:

117

118 ```json theme={null}

119 {

120 "hookSpecificOutput": {

121 "hookEventName": "PreToolUse",

122 "permissionDecision": "deny",

123 "permissionDecisionReason": "Destructive command blocked by hook"

66 }124 }

~~67 ]~~

68 }125 }

~~69}~~126 ```

~~70```~~

71 127

~~72### Project-Specific Hook Scripts~~128 If the command had been safe (like `npm test`), the script would hit `exit 0` instead, which tells Claude Code to allow the tool call with no further action.

129 </Step>

73 130

~~74You can use the environment variable `CLAUDE_PROJECT_DIR` (only available when~~131 <Step title="Claude Code acts on the result">

~~75Claude Code spawns the hook command) to reference scripts stored in your project,~~132 Claude Code reads the JSON decision, blocks the tool call, and shows Claude the reason.

~~76ensuring they work regardless of Claude's current directory:~~133 </Step>

134</Steps>

135

136The [Configuration](#configuration) section below documents the full schema, and each [hook event](#hook-events) section documents what input your command receives and what output it can return.

137

138## Configuration

139

140Hooks are defined in JSON settings files. The configuration has three levels of nesting:

141

1421. Choose a [hook event](#hook-events) to respond to, like `PreToolUse` or `Stop`

1432. Add a [matcher group](#matcher-patterns) to filter when it fires, like "only for the Bash tool"

1443. Define one or more [hook handlers](#hook-handler-fields) to run when matched

145

146See [How a hook resolves](#how-a-hook-resolves) above for a complete walkthrough with an annotated example.

147

148<Note>

149 This page uses specific terms for each level: **hook event** for the lifecycle point, **matcher group** for the filter, and **hook handler** for the shell command, HTTP endpoint, prompt, or agent that runs. "Hook" on its own refers to the general feature.

150</Note>

151

152### Hook locations

153

154Where you define a hook determines its scope:

155

156| Location | Scope | Shareable |

157| :--------------------------------------------------------- | :---------------------------- | :--------------------------------- |

158| `~/.claude/settings.json` | All your projects | No, local to your machine |

159| `.claude/settings.json` | Single project | Yes, can be committed to the repo |

160| `.claude/settings.local.json` | Single project | No, gitignored |

161| Managed policy settings | Organization-wide | Yes, admin-controlled |

162| [Plugin](/en/plugins) `hooks/hooks.json` | When plugin is enabled | Yes, bundled with the plugin |

163| [Skill](/en/skills) or [agent](/en/sub-agents) frontmatter | While the component is active | Yes, defined in the component file |

164

165For details on settings file resolution, see [settings](/en/settings). Enterprise administrators can use `allowManagedHooksOnly` to block user, project, and plugin hooks. See [Hook configuration](/en/settings#hook-configuration).

166

167### Matcher patterns

168

169The `matcher` field is a regex string that filters when hooks fire. Use `"*"`, `""`, or omit `matcher` entirely to match all occurrences. Each event type matches on a different field:

170

171| Event | What the matcher filters | Example matcher values |

172| :---------------------------------------------------------------------------------------------- | :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |

174| `SessionStart` | how the session started | `startup`, `resume`, `clear`, `compact` |

175| `SessionEnd` | why the session ended | `clear`, `resume`, `logout`, `prompt_input_exit`, `bypass_permissions_disabled`, `other` |

176| `Notification` | notification type | `permission_prompt`, `idle_prompt`, `auth_success`, `elicitation_dialog` |

177| `SubagentStart` | agent type | `Bash`, `Explore`, `Plan`, or custom agent names |

178| `PreCompact`, `PostCompact` | what triggered compaction | `manual`, `auto` |

179| `SubagentStop` | agent type | same values as `SubagentStart` |

180| `ConfigChange` | configuration source | `user_settings`, `project_settings`, `local_settings`, `policy_settings`, `skills` |

181| `CwdChanged` | no matcher support | always fires on every directory change |

182| `FileChanged` | filename (basename of the changed file) | `.envrc`, `.env`, any filename you want to watch |

183| `StopFailure` | error type | `rate_limit`, `authentication_failed`, `billing_error`, `invalid_request`, `server_error`, `max_output_tokens`, `unknown` |

184| `InstructionsLoaded` | load reason | `session_start`, `nested_traversal`, `path_glob_match`, `include`, `compact` |

185| `Elicitation` | MCP server name | your configured MCP server names |

186| `ElicitationResult` | MCP server name | same values as `Elicitation` |

187| `UserPromptSubmit`, `Stop`, `TeammateIdle`, `TaskCompleted`, `WorktreeCreate`, `WorktreeRemove` | no matcher support | always fires on every occurrence |

188

189The matcher is a regex, so `Edit|Write` matches either tool and `Notebook.*` matches any tool starting with Notebook. The matcher runs against a field from the [JSON input](#hook-input-and-output) that Claude Code sends to your hook on stdin. For tool events, that field is `tool_name`. Each [hook event](#hook-events) section lists the full set of matcher values and the input schema for that event.

190

191This example runs a linting script only when Claude writes or edits a file:

77 192

78```json theme={null}193```json theme={null}

79{194{

80 "hooks": {195 "hooks": {

81 "PostToolUse": [196 "PostToolUse": [

82 {197 {

~~83 "matcher": "Write|Edit",~~198 "matcher": "Edit|Write",

84 "hooks": [199 "hooks": [

85 {200 {

86 "type": "command",201 "type": "command",

~~87 "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/check-style.sh"~~202 "command": "/path/to/lint-check.sh"

88 }203 }

89 ]204 ]

90 }205 }

93}208}

94```209```

95 210

~~96### Plugin hooks~~211`UserPromptSubmit`, `Stop`, `TeammateIdle`, `TaskCompleted`, `WorktreeCreate`, `WorktreeRemove`, and `CwdChanged` don't support matchers and always fire on every occurrence. If you add a `matcher` field to these events, it is silently ignored.

97 212

~~98[Plugins](/en/plugins) can provide hooks that integrate seamlessly with your user and project hooks. Plugin hooks are automatically merged with your configuration when plugins are enabled.~~213#### Match MCP tools

99 214

100**How plugin hooks work**:215[MCP](/en/mcp) server tools appear as regular tools in tool events (`PreToolUse`, `PostToolUse`, `PostToolUseFailure`, `PermissionRequest`), so you can match them the same way you match any other tool name.

101 216

102* Plugin hooks are defined in the plugin's `hooks/hooks.json` file or in a file given by a custom path to the `hooks` field.217MCP tools follow the naming pattern `mcp__<server>__<tool>`, for example:

103* When a plugin is enabled, its hooks are merged with user and project hooks

104* Multiple hooks from different sources can respond to the same event

105* Plugin hooks use the `${CLAUDE_PLUGIN_ROOT}` environment variable to reference plugin files

106 218

107**Example plugin hook configuration**:219* `mcp__memory__create_entities`: Memory server's create entities tool

220* `mcp__filesystem__read_file`: Filesystem server's read file tool

221* `mcp__github__search_repositories`: GitHub server's search tool

222

223Use regex patterns to target specific MCP tools or groups of tools:

224

225* `mcp__memory__.*` matches all tools from the `memory` server

226* `mcp__.*__write.*` matches any tool containing "write" from any server

227

228This example logs all memory server operations and validates write operations from any MCP server:

108 229

109```json theme={null}230```json theme={null}

110{231{

111 "description": "Automatic code formatting",

112 "hooks": {232 "hooks": {

113 "PostToolUse": [233 "PreToolUse": [

114 {234 {

115 "matcher": "Write|Edit",235 "matcher": "mcp__memory__.*",

116 "hooks": [236 "hooks": [

117 {237 {

118 "type": "command",238 "type": "command",

119 "command": "${CLAUDE_PLUGIN_ROOT}/scripts/format.sh",239 "command": "echo 'Memory operation initiated' >> ~/mcp-operations.log"

120 "timeout": 30240 }

241 ]

242 },

243 {

244 "matcher": "mcp__.*__write.*",

245 "hooks": [

246 {

247 "type": "command",

248 "command": "/home/user/scripts/validate-mcp-write.py"

121 }249 }

122 ]250 ]

123 }251 }

126}254}

127```255```

128 256

129<Note>257### Hook handler fields

130 Plugin hooks use the same format as regular hooks with an optional `description` field to explain the hook's purpose.

131</Note>

132 258

133<Note>259Each object in the inner `hooks` array is a hook handler: the shell command, HTTP endpoint, LLM prompt, or agent that runs when the matcher matches. There are four types:

134 Plugin hooks run alongside your custom hooks. If multiple hooks match an event, they all execute in parallel.

135</Note>

136 260

137**Environment variables for plugins**:261* **[Command hooks](#command-hook-fields)** (`type: "command"`): run a shell command. Your script receives the event's [JSON input](#hook-input-and-output) on stdin and communicates results back through exit codes and stdout.

262* **[HTTP hooks](#http-hook-fields)** (`type: "http"`): send the event's JSON input as an HTTP POST request to a URL. The endpoint communicates results back through the response body using the same [JSON output format](#json-output) as command hooks.

263* **[Prompt hooks](#prompt-and-agent-hook-fields)** (`type: "prompt"`): send a prompt to a Claude model for single-turn evaluation. The model returns a yes/no decision as JSON. See [Prompt-based hooks](#prompt-based-hooks).

264* **[Agent hooks](#prompt-and-agent-hook-fields)** (`type: "agent"`): spawn a subagent that can use tools like Read, Grep, and Glob to verify conditions before returning a decision. See [Agent-based hooks](#agent-based-hooks).

138 265

139* `${CLAUDE_PLUGIN_ROOT}`: Absolute path to the plugin directory266#### Common fields

140* `${CLAUDE_PROJECT_DIR}`: Project root directory (same as for project hooks)

141* All standard environment variables are available

142 267

143See the [plugin components reference](/en/plugins-reference#hooks) for details on creating plugin hooks.268These fields apply to all hook types:

144 269

145## Prompt-Based Hooks270| Field | Required | Description |

271| :-------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |

272| `type` | yes | `"command"`, `"http"`, `"prompt"`, or `"agent"` |

273| `timeout` | no | Seconds before canceling. Defaults: 600 for command, 30 for prompt, 60 for agent |

274| `statusMessage` | no | Custom spinner message displayed while the hook runs |

275| `once` | no | If `true`, runs only once per session then is removed. Skills only, not agents. See [Hooks in skills and agents](#hooks-in-skills-and-agents) |

146 276

147In addition to bash command hooks (`type: "command"`), Claude Code supports prompt-based hooks (`type: "prompt"`) that use an LLM to evaluate whether to allow or block an action. Prompt-based hooks are currently only supported for `Stop` and `SubagentStop` hooks, where they enable intelligent, context-aware decisions.277#### Command hook fields

148 278

149### How prompt-based hooks work279In addition to the [common fields](#common-fields), command hooks accept these fields:

150 280

151Instead of executing a bash command, prompt-based hooks:281| Field | Required | Description |

282| :-------- | :------- | :------------------------------------------------------------------------------------------------------------------ |

283| `command` | yes | Shell command to execute |

284| `async` | no | If `true`, runs in the background without blocking. See [Run hooks in the background](#run-hooks-in-the-background) |

152 285

1531. Send the hook input and your prompt to a fast LLM (Haiku)286#### HTTP hook fields

1542. The LLM responds with structured JSON containing a decision287

1553. Claude Code processes the decision automatically288In addition to the [common fields](#common-fields), HTTP hooks accept these fields:

156 289

157### Configuration290| Field | Required | Description |

291| :--------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

292| `url` | yes | URL to send the POST request to |

293| `headers` | no | Additional HTTP headers as key-value pairs. Values support environment variable interpolation using `$VAR_NAME` or `${VAR_NAME}` syntax. Only variables listed in `allowedEnvVars` are resolved |

294| `allowedEnvVars` | no | List of environment variable names that may be interpolated into header values. References to unlisted variables are replaced with empty strings. Required for any env var interpolation to work |

295

296Claude Code sends the hook's [JSON input](#hook-input-and-output) as the POST request body with `Content-Type: application/json`. The response body uses the same [JSON output format](#json-output) as command hooks.

297

298Error handling differs from command hooks: non-2xx responses, connection failures, and timeouts all produce non-blocking errors that allow execution to continue. To block a tool call or deny a permission, return a 2xx response with a JSON body containing `decision: "block"` or a `hookSpecificOutput` with `permissionDecision: "deny"`.

299

300This example sends `PreToolUse` events to a local validation service, authenticating with a token from the `MY_TOKEN` environment variable:

158 301

159```json theme={null}302```json theme={null}

160{303{

161 "hooks": {304 "hooks": {

162 "Stop": [305 "PreToolUse": [

163 {306 {

307 "matcher": "Bash",

164 "hooks": [308 "hooks": [

165 {309 {

166 "type": "prompt",310 "type": "http",

167 "prompt": "Evaluate if Claude should stop: $ARGUMENTS. Check if all tasks are complete."311 "url": "http://localhost:8080/hooks/pre-tool-use",

312 "timeout": 30,

313 "headers": {

314 "Authorization": "Bearer $MY_TOKEN"

315 },

316 "allowedEnvVars": ["MY_TOKEN"]

168 }317 }

169 ]318 ]

170 }319 }

173}322}

174```323```

175 324

176**Fields:**325#### Prompt and agent hook fields

177 326

178* `type`: Must be `"prompt"`327In addition to the [common fields](#common-fields), prompt and agent hooks accept these fields:

179* `prompt`: The prompt text to send to the LLM

180 * Use `$ARGUMENTS` as a placeholder for the hook input JSON

181 * If `$ARGUMENTS` is not present, input JSON is appended to the prompt

182* `timeout`: (Optional) Timeout in seconds (default: 30 seconds)

~~183~~

184### Response schema

~~185~~

186The LLM must respond with JSON containing:

~~187~~

188```json theme={null}

189{

190 "decision": "approve" | "block",

191 "reason": "Explanation for the decision",

192 "continue": false, // Optional: stops Claude entirely

193 "stopReason": "Message shown to user", // Optional: custom stop message

194 "systemMessage": "Warning or context" // Optional: shown to user

195}

196```

197 328

198**Response fields:**329| Field | Required | Description |

330| :------- | :------- | :------------------------------------------------------------------------------------------ |

331| `prompt` | yes | Prompt text to send to the model. Use `$ARGUMENTS` as a placeholder for the hook input JSON |

332| `model` | no | Model to use for evaluation. Defaults to a fast model |

199 333

200* `decision`: `"approve"` allows the action, `"block"` prevents it334All matching hooks run in parallel, and identical handlers are deduplicated automatically. Command hooks are deduplicated by command string, and HTTP hooks are deduplicated by URL. Handlers run in the current directory with Claude Code's environment. The `$CLAUDE_CODE_REMOTE` environment variable is set to `"true"` in remote web environments and not set in the local CLI.

201* `reason`: Explanation shown to Claude when decision is `"block"`

202* `continue`: (Optional) If `false`, stops Claude's execution entirely

203* `stopReason`: (Optional) Message shown when `continue` is false

204* `systemMessage`: (Optional) Additional message shown to the user

205 335

206### Supported hook events336### Reference scripts by path

207 337

208Prompt-based hooks work with any hook event, but are most useful for:338Use environment variables to reference hook scripts relative to the project or plugin root, regardless of the working directory when the hook runs:

209 339

210* **Stop**: Intelligently decide if Claude should continue working340* `$CLAUDE_PROJECT_DIR`: the project root. Wrap in quotes to handle paths with spaces.

211* **SubagentStop**: Evaluate if a subagent has completed its task341* `${CLAUDE_PLUGIN_ROOT}`: the plugin's installation directory, for scripts bundled with a [plugin](/en/plugins). Changes on each plugin update.

212* **UserPromptSubmit**: Validate user prompts with LLM assistance342* `${CLAUDE_PLUGIN_DATA}`: the plugin's [persistent data directory](/en/plugins-reference#persistent-data-directory), for dependencies and state that should survive plugin updates.

213* **PreToolUse**: Make context-aware permission decisions

214* **PermissionRequest**: Intelligently allow or deny permission dialogs

215 343

216### Example: Intelligent Stop hook344<Tabs>

345 <Tab title="Project scripts">

346 This example uses `$CLAUDE_PROJECT_DIR` to run a style checker from the project's `.claude/hooks/` directory after any `Write` or `Edit` tool call:

217 347

218```json theme={null}348 ```json theme={null}

219{349 {

220 "hooks": {350 "hooks": {

221 "Stop": [351 "PostToolUse": [

222 {352 {

353 "matcher": "Write|Edit",

223 "hooks": [354 "hooks": [

224 {355 {

225 "type": "prompt",356 "type": "command",

226 "prompt": "You are evaluating whether Claude should stop working. Context: $ARGUMENTS\n\nAnalyze the conversation and determine if:\n1. All user-requested tasks are complete\n2. Any errors need to be addressed\n3. Follow-up work is needed\n\nRespond with JSON: {\"decision\": \"approve\" or \"block\", \"reason\": \"your explanation\"}",357 "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/check-style.sh"

227 "timeout": 30

228 }358 }

229 ]359 ]

230 }360 }

231 ]361 ]

232 }362 }

233}363 }

234```364 ```

365 </Tab>

235 366

236### Example: SubagentStop with custom logic367 <Tab title="Plugin scripts">

368 Define plugin hooks in `hooks/hooks.json` with an optional top-level `description` field. When a plugin is enabled, its hooks merge with your user and project hooks.

237 369

238```json theme={null}370 This example runs a formatting script bundled with the plugin:

239{371

372 ```json theme={null}

373 {

374 "description": "Automatic code formatting",

240 "hooks": {375 "hooks": {

241 "SubagentStop": [376 "PostToolUse": [

242 {377 {

378 "matcher": "Write|Edit",

243 "hooks": [379 "hooks": [

244 {380 {

245 "type": "prompt",381 "type": "command",

246 "prompt": "Evaluate if this subagent should stop. Input: $ARGUMENTS\n\nCheck if:\n- The subagent completed its assigned task\n- Any errors occurred that need fixing\n- Additional context gathering is needed\n\nReturn: {\"decision\": \"approve\" or \"block\", \"reason\": \"explanation\"}"382 "command": "${CLAUDE_PLUGIN_ROOT}/scripts/format.sh",

383 "timeout": 30

247 }384 }

248 ]385 ]

249 }386 }

250 ]387 ]

251 }388 }

252}389 }

253```390 ```

254 391

255### Comparison with bash command hooks392 See the [plugin components reference](/en/plugins-reference#hooks) for details on creating plugin hooks.

393 </Tab>

394</Tabs>

256 395

257| Feature | Bash Command Hooks | Prompt-Based Hooks |396### Hooks in skills and agents

258| --------------------- | ----------------------- | ------------------------------ |

259| **Execution** | Runs bash script | Queries LLM |

260| **Decision logic** | You implement in code | LLM evaluates context |

261| **Setup complexity** | Requires script file | Just configure prompt |

262| **Context awareness** | Limited to script logic | Natural language understanding |

263| **Performance** | Fast (local execution) | Slower (API call) |

264| **Use case** | Deterministic rules | Context-aware decisions |

265 397

266### Best practices398In addition to settings files and plugins, hooks can be defined directly in [skills](/en/skills) and [subagents](/en/sub-agents) using frontmatter. These hooks are scoped to the component's lifecycle and only run when that component is active.

267 399

268* **Be specific in prompts**: Clearly state what you want the LLM to evaluate400All hook events are supported. For subagents, `Stop` hooks are automatically converted to `SubagentStop` since that is the event that fires when a subagent completes.

269* **Include decision criteria**: List the factors the LLM should consider

270* **Test your prompts**: Verify the LLM makes correct decisions for your use cases

271* **Set appropriate timeouts**: Default is 30 seconds, adjust if needed

272* **Use for complex decisions**: Bash hooks are better for simple, deterministic rules

273 401

274See the [plugin components reference](/en/plugins-reference#hooks) for details on creating plugin hooks.402Hooks use the same configuration format as settings-based hooks but are scoped to the component's lifetime and cleaned up when it finishes.

275 403

276## Hook Events404This skill defines a `PreToolUse` hook that runs a security validation script before each `Bash` command:

277 405

278### PreToolUse406```yaml theme={null}

407---

408name: secure-operations

409description: Perform operations with security checks

410hooks:

411 PreToolUse:

412 - matcher: "Bash"

413 hooks:

414 - type: command

415 command: "./scripts/security-check.sh"

416---

417```

279 418

280Runs after Claude creates tool parameters and before processing the tool call.419Agents use the same format in their YAML frontmatter.

281 420

282**Common matchers:**421### The `/hooks` menu

283 422

284* `Task` - Subagent tasks (see [subagents documentation](/en/sub-agents))423Type `/hooks` in Claude Code to open a read-only browser for your configured hooks. The menu shows every hook event with a count of configured hooks, lets you drill into matchers, and shows the full details of each hook handler. Use it to verify configuration, check which settings file a hook came from, or inspect a hook's command, prompt, or URL.

285* `Bash` - Shell commands

286* `Glob` - File pattern matching

287* `Grep` - Content search

288* `Read` - File reading

289* `Edit` - File editing

290* `Write` - File writing

291* `WebFetch`, `WebSearch` - Web operations

292 424

293Use [PreToolUse decision control](#pretooluse-decision-control) to allow, deny, or ask for permission to use the tool.425The menu displays all four hook types: `command`, `prompt`, `agent`, and `http`. Each hook is labeled with a `[type]` prefix and a source indicating where it was defined:

294 426

295### PermissionRequest427* `User`: from `~/.claude/settings.json`

428* `Project`: from `.claude/settings.json`

429* `Local`: from `.claude/settings.local.json`

430* `Plugin`: from a plugin's `hooks/hooks.json`

431* `Session`: registered in memory for the current session

432* `Built-in`: registered internally by Claude Code

296 433

297Runs when the user is shown a permission dialog.434Selecting a hook opens a detail view showing its event, matcher, type, source file, and the full command, prompt, or URL. The menu is read-only: to add, modify, or remove hooks, edit the settings JSON directly or ask Claude to make the change.

298Use [PermissionRequest decision control](#permissionrequest-decision-control) to allow or deny on behalf of the user.

299 435

300Recognizes the same matcher values as PreToolUse.436### Disable or remove hooks

301 437

302### PostToolUse438To remove a hook, delete its entry from the settings JSON file.

303 439

304Runs immediately after a tool completes successfully.440To temporarily disable all hooks without removing them, set `"disableAllHooks": true` in your settings file. There is no way to disable an individual hook while keeping it in the configuration.

305 441

306Recognizes the same matcher values as PreToolUse.442The `disableAllHooks` setting respects the managed settings hierarchy. If an administrator has configured hooks through managed policy settings, `disableAllHooks` set in user, project, or local settings cannot disable those managed hooks. Only `disableAllHooks` set at the managed settings level can disable managed hooks.

307 443

308### Notification444Direct edits to hooks in settings files are normally picked up automatically by the file watcher.

445

446## Hook input and output

447

448Command hooks receive JSON data via stdin and communicate results through exit codes, stdout, and stderr. HTTP hooks receive the same JSON as the POST request body and communicate results through the HTTP response body. This section covers fields and behavior common to all events. Each event's section under [Hook events](#hook-events) includes its specific input schema and decision control options.

449

450### Common input fields

309 451

310Runs when Claude Code sends notifications. Supports matchers to filter by notification type.452Hook events receive these fields as JSON, in addition to event-specific fields documented in each [hook event](#hook-events) section. For command hooks, this JSON arrives via stdin. For HTTP hooks, it arrives as the POST request body.

311 453

312**Common matchers:**454| Field | Description |

455| :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

456| `session_id` | Current session identifier |

457| `transcript_path` | Path to conversation JSON |

458| `cwd` | Current working directory when the hook is invoked |

459| `permission_mode` | Current [permission mode](/en/permissions#permission-modes): `"default"`, `"plan"`, `"acceptEdits"`, `"auto"`, `"dontAsk"`, or `"bypassPermissions"`. Not all events receive this field: see each event's JSON example below to check |

460| `hook_event_name` | Name of the event that fired |

313 461

314* `permission_prompt` - Permission requests from Claude Code462When running with `--agent` or inside a subagent, two additional fields are included:

315* `idle_prompt` - When Claude is waiting for user input (after 60+ seconds of idle time)

316* `auth_success` - Authentication success notifications

317* `elicitation_dialog` - When Claude Code needs input for MCP tool elicitation

318 463

319You can use matchers to run different hooks for different notification types, or omit the matcher to run hooks for all notifications.464| Field | Description |

465| :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

466| `agent_id` | Unique identifier for the subagent. Present only when the hook fires inside a subagent call. Use this to distinguish subagent hook calls from main-thread calls. |

467| `agent_type` | Agent name (for example, `"Explore"` or `"security-reviewer"`). Present when the session uses `--agent` or the hook fires inside a subagent. For subagents, the subagent's type takes precedence over the session's `--agent` value. |

320 468

321**Example: Different notifications for different types**469For example, a `PreToolUse` hook for a Bash command receives this on stdin:

322 470

323```json theme={null}471```json theme={null}

324{472{

325 "hooks": {473 "session_id": "abc123",

326 "Notification": [474 "transcript_path": "/home/user/.claude/projects/.../transcript.jsonl",

327 {475 "cwd": "/home/user/my-project",

328 "matcher": "permission_prompt",476 "permission_mode": "default",

329 "hooks": [477 "hook_event_name": "PreToolUse",

478 "tool_name": "Bash",

479 "tool_input": {

480 "command": "npm test"

481 }

482}

483```

484

485The `tool_name` and `tool_input` fields are event-specific. Each [hook event](#hook-events) section documents the additional fields for that event.

486

487### Exit code output

488

489The exit code from your hook command tells Claude Code whether the action should proceed, be blocked, or be ignored.

490

491**Exit 0** means success. Claude Code parses stdout for [JSON output fields](#json-output). JSON output is only processed on exit 0. For most events, stdout is only shown in verbose mode (`Ctrl+O`). The exceptions are `UserPromptSubmit` and `SessionStart`, where stdout is added as context that Claude can see and act on.

492

493**Exit 2** means a blocking error. Claude Code ignores stdout and any JSON in it. Instead, stderr text is fed back to Claude as an error message. The effect depends on the event: `PreToolUse` blocks the tool call, `UserPromptSubmit` rejects the prompt, and so on. See [exit code 2 behavior](#exit-code-2-behavior-per-event) for the full list.

494

495**Any other exit code** is a non-blocking error. stderr is shown in verbose mode (`Ctrl+O`) and execution continues.

496

497For example, a hook command script that blocks dangerous Bash commands:

498

499```bash theme={null}

500#!/bin/bash

501# Reads JSON input from stdin, checks the command

502command=$(jq -r '.tool_input.command' < /dev/stdin)

503

504if [[ "$command" == rm* ]]; then

505 echo "Blocked: rm commands are not allowed" >&2

506 exit 2 # Blocking error: tool call is prevented

507fi

508

509exit 0 # Success: tool call proceeds

510```

511

512#### Exit code 2 behavior per event

513

514Exit code 2 is the way a hook signals "stop, don't do this." The effect depends on the event, because some events represent actions that can be blocked (like a tool call that hasn't happened yet) and others represent things that already happened or can't be prevented.

515

516| Hook event | Can block? | What happens on exit 2 |

517| :------------------- | :--------- | :---------------------------------------------------------------------------- |

518| `PreToolUse` | Yes | Blocks the tool call |

519| `PermissionRequest` | Yes | Denies the permission |

520| `UserPromptSubmit` | Yes | Blocks prompt processing and erases the prompt |

521| `Stop` | Yes | Prevents Claude from stopping, continues the conversation |

522| `SubagentStop` | Yes | Prevents the subagent from stopping |

523| `TeammateIdle` | Yes | Prevents the teammate from going idle (teammate continues working) |

524| `TaskCompleted` | Yes | Prevents the task from being marked as completed |

525| `ConfigChange` | Yes | Blocks the configuration change from taking effect (except `policy_settings`) |

526| `StopFailure` | No | Output and exit code are ignored |

527| `PostToolUse` | No | Shows stderr to Claude (tool already ran) |

528| `PostToolUseFailure` | No | Shows stderr to Claude (tool already failed) |

529| `Notification` | No | Shows stderr to user only |

530| `SubagentStart` | No | Shows stderr to user only |

531| `SessionStart` | No | Shows stderr to user only |

532| `SessionEnd` | No | Shows stderr to user only |

533| `CwdChanged` | No | Shows stderr to user only |

534| `FileChanged` | No | Shows stderr to user only |

535| `PreCompact` | No | Shows stderr to user only |

536| `PostCompact` | No | Shows stderr to user only |

537| `Elicitation` | Yes | Denies the elicitation |

538| `ElicitationResult` | Yes | Blocks the response (action becomes decline) |

539| `WorktreeCreate` | Yes | Any non-zero exit code causes worktree creation to fail |

540| `WorktreeRemove` | No | Failures are logged in debug mode only |

541| `InstructionsLoaded` | No | Exit code is ignored |

542

543### HTTP response handling

544

545HTTP hooks use HTTP status codes and response bodies instead of exit codes and stdout:

546

547* **2xx with an empty body**: success, equivalent to exit code 0 with no output

548* **2xx with a plain text body**: success, the text is added as context

549* **2xx with a JSON body**: success, parsed using the same [JSON output](#json-output) schema as command hooks

550* **Non-2xx status**: non-blocking error, execution continues

551* **Connection failure or timeout**: non-blocking error, execution continues

552

553Unlike command hooks, HTTP hooks cannot signal a blocking error through status codes alone. To block a tool call or deny a permission, return a 2xx response with a JSON body containing the appropriate decision fields.

554

555### JSON output

556

557Exit codes let you allow or block, but JSON output gives you finer-grained control. Instead of exiting with code 2 to block, exit 0 and print a JSON object to stdout. Claude Code reads specific fields from that JSON to control behavior, including [decision control](#decision-control) for blocking, allowing, or escalating to the user.

558

559<Note>

560 You must choose one approach per hook, not both: either use exit codes alone for signaling, or exit 0 and print JSON for structured control. Claude Code only processes JSON on exit 0. If you exit 2, any JSON is ignored.

561</Note>

562

563Your hook's stdout must contain only the JSON object. If your shell profile prints text on startup, it can interfere with JSON parsing. See [JSON validation failed](/en/hooks-guide#json-validation-failed) in the troubleshooting guide.

564

565The JSON object supports three kinds of fields:

566

567* **Universal fields** like `continue` work across all events. These are listed in the table below.

568* **Top-level `decision` and `reason`** are used by some events to block or provide feedback.

569* **`hookSpecificOutput`** is a nested object for events that need richer control. It requires a `hookEventName` field set to the event name.

570

571| Field | Default | Description |

572| :--------------- | :------ | :------------------------------------------------------------------------------------------------------------------------- |

573| `continue` | `true` | If `false`, Claude stops processing entirely after the hook runs. Takes precedence over any event-specific decision fields |

574| `stopReason` | none | Message shown to the user when `continue` is `false`. Not shown to Claude |

575| `suppressOutput` | `false` | If `true`, hides stdout from verbose mode output |

576| `systemMessage` | none | Warning message shown to the user |

577

578To stop Claude entirely regardless of event type:

579

580```json theme={null}

581{ "continue": false, "stopReason": "Build failed, fix errors before continuing" }

582```

583

584#### Decision control

585

586Not every event supports blocking or controlling behavior through JSON. The events that do each use a different set of fields to express that decision. Use this table as a quick reference before writing a hook:

587

588| Events | Decision pattern | Key fields |

589| :-------------------------------------------------------------------------------------------------------------------------- | :----------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

590| UserPromptSubmit, PostToolUse, PostToolUseFailure, Stop, SubagentStop, ConfigChange | Top-level `decision` | `decision: "block"`, `reason` |

591| TeammateIdle, TaskCompleted | Exit code or `continue: false` | Exit code 2 blocks the action with stderr feedback. JSON `{"continue": false, "stopReason": "..."}` also stops the teammate entirely, matching `Stop` hook behavior |

592| PreToolUse | `hookSpecificOutput` | `permissionDecision` (allow/deny/ask), `permissionDecisionReason` |

593| PermissionRequest | `hookSpecificOutput` | `decision.behavior` (allow/deny) |

594| WorktreeCreate | stdout path | Hook prints absolute path to created worktree. Non-zero exit fails creation |

595| Elicitation | `hookSpecificOutput` | `action` (accept/decline/cancel), `content` (form field values for accept) |

596| ElicitationResult | `hookSpecificOutput` | `action` (accept/decline/cancel), `content` (form field values override) |

597| WorktreeRemove, Notification, SessionEnd, PreCompact, PostCompact, InstructionsLoaded, StopFailure, CwdChanged, FileChanged | None | No decision control. Used for side effects like logging or cleanup |

598

599Here are examples of each pattern in action:

600

601<Tabs>

602 <Tab title="Top-level decision">

603 Used by `UserPromptSubmit`, `PostToolUse`, `PostToolUseFailure`, `Stop`, `SubagentStop`, and `ConfigChange`. The only value is `"block"`. To allow the action to proceed, omit `decision` from your JSON, or exit 0 without any JSON at all:

604

605 ```json theme={null}

330 {606 {

331 "type": "command",607 "decision": "block",

332 "command": "/path/to/permission-alert.sh"608 "reason": "Test suite must pass before proceeding"

333 }609 }

334 ]610 ```

335 },611 </Tab>

612

613 <Tab title="PreToolUse">

614 Uses `hookSpecificOutput` for richer control: allow, deny, or escalate to the user. You can also modify tool input before it runs or inject additional context for Claude. See [PreToolUse decision control](#pretooluse-decision-control) for the full set of options.

615

616 ```json theme={null}

336 {617 {

337 "matcher": "idle_prompt",618 "hookSpecificOutput": {

338 "hooks": [619 "hookEventName": "PreToolUse",

620 "permissionDecision": "deny",

621 "permissionDecisionReason": "Database writes are not allowed"

622 }

623 }

624 ```

625 </Tab>

626

627 <Tab title="PermissionRequest">

628 Uses `hookSpecificOutput` to allow or deny a permission request on behalf of the user. When allowing, you can also modify the tool's input or apply permission rules so the user isn't prompted again. See [PermissionRequest decision control](#permissionrequest-decision-control) for the full set of options.

629

630 ```json theme={null}

339 {631 {

340 "type": "command",632 "hookSpecificOutput": {

341 "command": "/path/to/idle-notification.sh"633 "hookEventName": "PermissionRequest",

634 "decision": {

635 "behavior": "allow",

636 "updatedInput": {

637 "command": "npm run lint"

342 }638 }

343 ]

344 }639 }

345 ]

346 }640 }

347}641 }

348```642 ```

643 </Tab>

644</Tabs>

349 645

350### UserPromptSubmit646For extended examples including Bash command validation, prompt filtering, and auto-approval scripts, see [What you can automate](/en/hooks-guide#what-you-can-automate) in the guide and the [Bash command validator reference implementation](https://github.com/anthropics/claude-code/blob/main/examples/hooks/bash_command_validator_example.py).

351 647

352Runs when the user submits a prompt, before Claude processes it. This allows you648## Hook events

353to add additional context based on the prompt/conversation, validate prompts, or

354block certain types of prompts.

355 649

356### Stop650Each event corresponds to a point in Claude Code's lifecycle where hooks can run. The sections below are ordered to match the lifecycle: from session setup through the agentic loop to session end. Each section describes when the event fires, what matchers it supports, the JSON input it receives, and how to control behavior through output.

357 651

358Runs when the main Claude Code agent has finished responding. Does not run if652### SessionStart

359the stoppage occurred due to a user interrupt.

360 653

361### SubagentStop654Runs when Claude Code starts a new session or resumes an existing session. Useful for loading development context like existing issues or recent changes to your codebase, or setting up environment variables. For static context that does not require a script, use [CLAUDE.md](/en/memory) instead.

362 655

363Runs when a Claude Code subagent (Task tool call) has finished responding.656SessionStart runs on every session, so keep these hooks fast. Only `type: "command"` hooks are supported.

364 657

365### PreCompact658The matcher value corresponds to how the session was initiated:

366 659

367Runs before Claude Code is about to run a compact operation.660| Matcher | When it fires |

661| :-------- | :------------------------------------- |

662| `startup` | New session |

663| `resume` | `--resume`, `--continue`, or `/resume` |

664| `clear` | `/clear` |

665| `compact` | Auto or manual compaction |

368 666

369**Matchers:**667#### SessionStart input

370 668

371* `manual` - Invoked from `/compact`669In addition to the [common input fields](#common-input-fields), SessionStart hooks receive `source`, `model`, and optionally `agent_type`. The `source` field indicates how the session started: `"startup"` for new sessions, `"resume"` for resumed sessions, `"clear"` after `/clear`, or `"compact"` after compaction. The `model` field contains the model identifier. If you start Claude Code with `claude --agent <name>`, an `agent_type` field contains the agent name.

372* `auto` - Invoked from auto-compact (due to full context window)

373 670

374### SessionStart671```json theme={null}

672{

673 "session_id": "abc123",

674 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

675 "cwd": "/Users/...",

676 "hook_event_name": "SessionStart",

677 "source": "startup",

678 "model": "claude-sonnet-4-6"

679}

680```

681

682#### SessionStart decision control

375 683

376Runs when Claude Code starts a new session or resumes an existing session (which684Any text your hook script prints to stdout is added as context for Claude. In addition to the [JSON output fields](#json-output) available to all hooks, you can return these event-specific fields:

377currently does start a new session under the hood). Useful for loading in

378development context like existing issues or recent changes to your codebase, installing dependencies, or setting up environment variables.

379 685

380**Matchers:**686| Field | Description |

687| :------------------ | :------------------------------------------------------------------------ |

688| `additionalContext` | String added to Claude's context. Multiple hooks' values are concatenated |

381 689

382* `startup` - Invoked from startup690```json theme={null}

383* `resume` - Invoked from `--resume`, `--continue`, or `/resume`691{

384* `clear` - Invoked from `/clear`692 "hookSpecificOutput": {

385* `compact` - Invoked from auto or manual compact.693 "hookEventName": "SessionStart",

694 "additionalContext": "My additional context here"

695 }

696}

697```

386 698

387#### Persisting environment variables699#### Persist environment variables

388 700

389SessionStart hooks have access to the `CLAUDE_ENV_FILE` environment variable, which provides a file path where you can persist environment variables for subsequent bash commands.701SessionStart hooks have access to the `CLAUDE_ENV_FILE` environment variable, which provides a file path where you can persist environment variables for subsequent Bash commands.

390 702

391**Example: Setting individual environment variables**703To set individual environment variables, write `export` statements to `CLAUDE_ENV_FILE`. Use append (`>>`) to preserve variables set by other hooks:

392 704

393```bash theme={null}705```bash theme={null}

394#!/bin/bash706#!/bin/bash

395 707

396if [ -n "$CLAUDE_ENV_FILE" ]; then708if [ -n "$CLAUDE_ENV_FILE" ]; then

397 echo 'export NODE_ENV=production' >> "$CLAUDE_ENV_FILE"709 echo 'export NODE_ENV=production' >> "$CLAUDE_ENV_FILE"

398 echo 'export API_KEY=your-api-key' >> "$CLAUDE_ENV_FILE"710 echo 'export DEBUG_LOG=true' >> "$CLAUDE_ENV_FILE"

399 echo 'export PATH="$PATH:./node_modules/.bin"' >> "$CLAUDE_ENV_FILE"711 echo 'export PATH="$PATH:./node_modules/.bin"' >> "$CLAUDE_ENV_FILE"

400fi712fi

401 713

402exit 0714exit 0

403```715```

404 716

405**Example: Persisting all environment changes from the hook**717To capture all environment changes from setup commands, compare the exported variables before and after:

~~406~~

407When your setup modifies the environment (e.g., `nvm use`), capture and persist all changes by diffing the environment:

408 718

409```bash theme={null}719```bash theme={null}

410#!/bin/bash720#!/bin/bash

423exit 0733exit 0

424```734```

425 735

426Any variables written to this file will be available in all subsequent bash commands that Claude Code executes during the session.736Any variables written to this file will be available in all subsequent Bash commands that Claude Code executes during the session.

427 737

428<Note>738<Note>

429 `CLAUDE_ENV_FILE` is only available for SessionStart hooks. Other hook types do not have access to this variable.739 `CLAUDE_ENV_FILE` is available for SessionStart, [CwdChanged](#cwdchanged), and [FileChanged](#filechanged) hooks. Other hook types do not have access to this variable.

430</Note>740</Note>

431 741

432### SessionEnd742### InstructionsLoaded

433 743

434Runs when a Claude Code session ends. Useful for cleanup tasks, logging session744Fires when a `CLAUDE.md` or `.claude/rules/*.md` file is loaded into context. This event fires at session start for eagerly-loaded files and again later when files are lazily loaded, for example when Claude accesses a subdirectory that contains a nested `CLAUDE.md` or when conditional rules with `paths:` frontmatter match. The hook does not support blocking or decision control. It runs asynchronously for observability purposes.

435statistics, or saving session state.

436 745

437The `reason` field in the hook input will be one of:746The matcher runs against `load_reason`. For example, use `"matcher": "session_start"` to fire only for files loaded at session start, or `"matcher": "path_glob_match|nested_traversal"` to fire only for lazy loads.

438 747

439* `clear` - Session cleared with /clear command748#### InstructionsLoaded input

440* `logout` - User logged out

441* `prompt_input_exit` - User exited while prompt input was visible

442* `other` - Other exit reasons

443 749

444## Hook Input750In addition to the [common input fields](#common-input-fields), InstructionsLoaded hooks receive these fields:

445 751

446Hooks receive JSON data via stdin containing session information and752| Field | Description |

447event-specific data:753| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

754| `file_path` | Absolute path to the instruction file that was loaded |

755| `memory_type` | Scope of the file: `"User"`, `"Project"`, `"Local"`, or `"Managed"` |

756| `load_reason` | Why the file was loaded: `"session_start"`, `"nested_traversal"`, `"path_glob_match"`, `"include"`, or `"compact"`. The `"compact"` value fires when instruction files are re-loaded after a compaction event |

757| `globs` | Path glob patterns from the file's `paths:` frontmatter, if any. Present only for `path_glob_match` loads |

758| `trigger_file_path` | Path to the file whose access triggered this load, for lazy loads |

759| `parent_file_path` | Path to the parent instruction file that included this one, for `include` loads |

448 760

449```typescript theme={null}761```json theme={null}

450{762{

451 // Common fields763 "session_id": "abc123",

452 session_id: string764 "transcript_path": "/Users/.../.claude/projects/.../transcript.jsonl",

453 transcript_path: string // Path to conversation JSON765 "cwd": "/Users/my-project",

454 cwd: string // The current working directory when the hook is invoked766 "hook_event_name": "InstructionsLoaded",

455 permission_mode: string // Current permission mode: "default", "plan", "acceptEdits", or "bypassPermissions"767 "file_path": "/Users/my-project/CLAUDE.md",

~~456~~ 768 "memory_type": "Project",

457 // Event-specific fields769 "load_reason": "session_start"

458 hook_event_name: string

459 ...

460}770}

461```771```

462 772

463### PreToolUse Input773#### InstructionsLoaded decision control

774

775InstructionsLoaded hooks have no decision control. They cannot block or modify instruction loading. Use this event for audit logging, compliance tracking, or observability.

776

777### UserPromptSubmit

778

779Runs when the user submits a prompt, before Claude processes it. This allows you

780to add additional context based on the prompt/conversation, validate prompts, or

781block certain types of prompts.

782

783#### UserPromptSubmit input

464 784

465The exact schema for `tool_input` depends on the tool.785In addition to the [common input fields](#common-input-fields), UserPromptSubmit hooks receive the `prompt` field containing the text the user submitted.

466 786

467```json theme={null}787```json theme={null}

468{788{

470 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",790 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

471 "cwd": "/Users/...",791 "cwd": "/Users/...",

472 "permission_mode": "default",792 "permission_mode": "default",

473 "hook_event_name": "PreToolUse",793 "hook_event_name": "UserPromptSubmit",

474 "tool_name": "Write",794 "prompt": "Write a function to calculate the factorial of a number"

475 "tool_input": {795}

476 "file_path": "/path/to/file.txt",796```

477 "content": "file content"797

478 },798#### UserPromptSubmit decision control

479 "tool_use_id": "toolu_01ABC123..."799

800`UserPromptSubmit` hooks can control whether a user prompt is processed and add context. All [JSON output fields](#json-output) are available.

801

802There are two ways to add context to the conversation on exit code 0:

803

804* **Plain text stdout**: any non-JSON text written to stdout is added as context

805* **JSON with `additionalContext`**: use the JSON format below for more control. The `additionalContext` field is added as context

806

807Plain stdout is shown as hook output in the transcript. The `additionalContext` field is added more discretely.

808

809To block a prompt, return a JSON object with `decision` set to `"block"`:

810

811| Field | Description |

812| :------------------ | :----------------------------------------------------------------------------------------------------------------- |

813| `decision` | `"block"` prevents the prompt from being processed and erases it from context. Omit to allow the prompt to proceed |

814| `reason` | Shown to the user when `decision` is `"block"`. Not added to context |

815| `additionalContext` | String added to Claude's context |

816

817```json theme={null}

818{

819 "decision": "block",

820 "reason": "Explanation for decision",

821 "hookSpecificOutput": {

822 "hookEventName": "UserPromptSubmit",

823 "additionalContext": "My additional context here"

824 }

825}

826```

827

828<Note>

829 The JSON format isn't required for simple use cases. To add context, you can print plain text to stdout with exit code 0. Use JSON when you need to

830 block prompts or want more structured control.

831</Note>

832

833### PreToolUse

834

835Runs after Claude creates tool parameters and before processing the tool call. Matches on tool name: `Bash`, `Edit`, `Write`, `Read`, `Glob`, `Grep`, `Agent`, `WebFetch`, `WebSearch`, and any [MCP tool names](#match-mcp-tools).

836

837Use [PreToolUse decision control](#pretooluse-decision-control) to allow, deny, or ask for permission to use the tool.

838

839#### PreToolUse input

840

841In addition to the [common input fields](#common-input-fields), PreToolUse hooks receive `tool_name`, `tool_input`, and `tool_use_id`. The `tool_input` fields depend on the tool:

842

843##### Bash

844

845Executes shell commands.

846

848| :------------------ | :------ | :----------------- | :-------------------------------------------- |

853

854##### Write

855

856Creates or overwrites a file.

857

859| :---------- | :----- | :-------------------- | :--------------------------------- |

862

863##### Edit

864

865Replaces a string in an existing file.

866

868| :------------ | :------ | :-------------------- | :--------------------------------- |

873

874##### Read

875

876Reads file contents.

877

879| :---------- | :----- | :-------------------- | :----------------------------------------- |

883

884##### Glob

885

886Finds files matching a glob pattern.

887

889| :-------- | :----- | :--------------- | :--------------------------------------------------------------------- |

890| `pattern` | string | `"**/*.ts"` | Glob pattern to match files against |

892

893##### Grep

894

895Searches file contents with regular expressions.

896

898| :------------ | :------ | :--------------- | :------------------------------------------------------------------------------------ |

905

906##### WebFetch

907

908Fetches and processes web content.

909

911| :------- | :----- | :---------------------------- | :----------------------------------- |

914

915##### WebSearch

916

917Searches the web.

918

920| :---------------- | :----- | :----------------------------- | :------------------------------------------------ |

924

925##### Agent

926

927Spawns a [subagent](/en/sub-agents).

928

930| :-------------- | :----- | :------------------------- | :------------------------------------------- |

935

936#### PreToolUse decision control

937

938`PreToolUse` hooks can control whether a tool call proceeds. Unlike other hooks that use a top-level `decision` field, PreToolUse returns its decision inside a `hookSpecificOutput` object. This gives it richer control: three outcomes (allow, deny, or ask) plus the ability to modify tool input before execution.

939

940| Field | Description |

941| :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

942| `permissionDecision` | `"allow"` skips the permission prompt. `"deny"` prevents the tool call. `"ask"` prompts the user to confirm. [Deny and ask rules](/en/permissions#manage-permissions) still apply when a hook returns `"allow"` |

943| `permissionDecisionReason` | For `"allow"` and `"ask"`, shown to the user but not Claude. For `"deny"`, shown to Claude |

944| `updatedInput` | Modifies the tool's input parameters before execution. Combine with `"allow"` to auto-approve, or `"ask"` to show the modified input to the user |

945| `additionalContext` | String added to Claude's context before the tool executes |

946

947When a hook returns `"ask"`, the permission prompt displayed to the user includes a label identifying where the hook came from: for example, `[User]`, `[Project]`, `[Plugin]`, or `[Local]`. This helps users understand which configuration source is requesting confirmation.

948

949```json theme={null}

950{

951 "hookSpecificOutput": {

952 "hookEventName": "PreToolUse",

953 "permissionDecision": "allow",

954 "permissionDecisionReason": "My reason here",

955 "updatedInput": {

956 "field_to_modify": "new value"

957 },

958 "additionalContext": "Current environment: production. Proceed with caution."

959 }

480}960}

481```961```

482 962

483### PostToolUse Input963<Note>

964 PreToolUse previously used top-level `decision` and `reason` fields, but these are deprecated for this event. Use `hookSpecificOutput.permissionDecision` and `hookSpecificOutput.permissionDecisionReason` instead. The deprecated values `"approve"` and `"block"` map to `"allow"` and `"deny"` respectively. Other events like PostToolUse and Stop continue to use top-level `decision` and `reason` as their current format.

965</Note>

966

967### PermissionRequest

968

969Runs when the user is shown a permission dialog.

970Use [PermissionRequest decision control](#permissionrequest-decision-control) to allow or deny on behalf of the user.

971

972Matches on tool name, same values as PreToolUse.

973

974#### PermissionRequest input

975

976PermissionRequest hooks receive `tool_name` and `tool_input` fields like PreToolUse hooks, but without `tool_use_id`. An optional `permission_suggestions` array contains the "always allow" options the user would normally see in the permission dialog. The difference is when the hook fires: PermissionRequest hooks run when a permission dialog is about to be shown to the user, while PreToolUse hooks run before tool execution regardless of permission status.

977

978```json theme={null}

979{

980 "session_id": "abc123",

981 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

982 "cwd": "/Users/...",

983 "permission_mode": "default",

984 "hook_event_name": "PermissionRequest",

985 "tool_name": "Bash",

986 "tool_input": {

987 "command": "rm -rf node_modules",

988 "description": "Remove node_modules directory"

989 },

990 "permission_suggestions": [

991 {

992 "type": "addRules",

993 "rules": [{ "toolName": "Bash", "ruleContent": "rm -rf node_modules" }],

994 "behavior": "allow",

995 "destination": "localSettings"

996 }

997 ]

998}

999```

1000

1001#### PermissionRequest decision control

1002

1003`PermissionRequest` hooks can allow or deny permission requests. In addition to the [JSON output fields](#json-output) available to all hooks, your hook script can return a `decision` object with these event-specific fields:

1004

1005| Field | Description |

1006| :------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

1007| `behavior` | `"allow"` grants the permission, `"deny"` denies it |

1008| `updatedInput` | For `"allow"` only: modifies the tool's input parameters before execution |

1009| `updatedPermissions` | For `"allow"` only: array of [permission update entries](#permission-update-entries) to apply, such as adding an allow rule or changing the session permission mode |

1010| `message` | For `"deny"` only: tells Claude why the permission was denied |

1011| `interrupt` | For `"deny"` only: if `true`, stops Claude |

1012

1013```json theme={null}

1014{

1015 "hookSpecificOutput": {

1016 "hookEventName": "PermissionRequest",

1017 "decision": {

1018 "behavior": "allow",

1019 "updatedInput": {

1020 "command": "npm run lint"

1021 }

1022 }

1023 }

1024}

1025```

1026

1027#### Permission update entries

1028

1029The `updatedPermissions` output field and the [`permission_suggestions` input field](#permissionrequest-input) both use the same array of entry objects. Each entry has a `type` that determines its other fields, and a `destination` that controls where the change is written.

1030

1031| `type` | Fields | Effect |

1032| :------------------ | :--------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

1033| `addRules` | `rules`, `behavior`, `destination` | Adds permission rules. `rules` is an array of `{toolName, ruleContent?}` objects. Omit `ruleContent` to match the whole tool. `behavior` is `"allow"`, `"deny"`, or `"ask"` |

1034| `replaceRules` | `rules`, `behavior`, `destination` | Replaces all rules of the given `behavior` at the `destination` with the provided `rules` |

1035| `removeRules` | `rules`, `behavior`, `destination` | Removes matching rules of the given `behavior` |

1036| `setMode` | `mode`, `destination` | Changes the permission mode. Valid modes are `default`, `acceptEdits`, `dontAsk`, `bypassPermissions`, and `plan` |

1037| `addDirectories` | `directories`, `destination` | Adds working directories. `directories` is an array of path strings |

1038| `removeDirectories` | `directories`, `destination` | Removes working directories |

1039

1040The `destination` field on every entry determines whether the change stays in memory or persists to a settings file.

1041

1042| `destination` | Writes to |

1043| :---------------- | :---------------------------------------------- |

1044| `session` | in-memory only, discarded when the session ends |

1045| `localSettings` | `.claude/settings.local.json` |

1046| `projectSettings` | `.claude/settings.json` |

1047| `userSettings` | `~/.claude/settings.json` |

1048

1049A hook can echo one of the `permission_suggestions` it received as its own `updatedPermissions` output, which is equivalent to the user selecting that "always allow" option in the dialog.

1050

1051### PostToolUse

1052

1053Runs immediately after a tool completes successfully.

1054

1055Matches on tool name, same values as PreToolUse.

1056

1057#### PostToolUse input

1058

1059`PostToolUse` hooks fire after a tool has already executed successfully. The input includes both `tool_input`, the arguments sent to the tool, and `tool_response`, the result it returned. The exact schema for both depends on the tool.

1060

1061```json theme={null}

1062{

1063 "session_id": "abc123",

1064 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1065 "cwd": "/Users/...",

1066 "permission_mode": "default",

1067 "hook_event_name": "PostToolUse",

1068 "tool_name": "Write",

1069 "tool_input": {

1070 "file_path": "/path/to/file.txt",

1071 "content": "file content"

1072 },

1073 "tool_response": {

1074 "filePath": "/path/to/file.txt",

1075 "success": true

1076 },

1077 "tool_use_id": "toolu_01ABC123..."

1078}

1079```

1080

1081#### PostToolUse decision control

1082

1083`PostToolUse` hooks can provide feedback to Claude after tool execution. In addition to the [JSON output fields](#json-output) available to all hooks, your hook script can return these event-specific fields:

1084

1085| Field | Description |

1086| :--------------------- | :----------------------------------------------------------------------------------------- |

1087| `decision` | `"block"` prompts Claude with the `reason`. Omit to allow the action to proceed |

1088| `reason` | Explanation shown to Claude when `decision` is `"block"` |

1089| `additionalContext` | Additional context for Claude to consider |

1090| `updatedMCPToolOutput` | For [MCP tools](#match-mcp-tools) only: replaces the tool's output with the provided value |

1091

1092```json theme={null}

1093{

1094 "decision": "block",

1095 "reason": "Explanation for decision",

1096 "hookSpecificOutput": {

1097 "hookEventName": "PostToolUse",

1098 "additionalContext": "Additional information for Claude"

1099 }

1100}

1101```

1102

1103### PostToolUseFailure

1104

1105Runs when a tool execution fails. This event fires for tool calls that throw errors or return failure results. Use this to log failures, send alerts, or provide corrective feedback to Claude.

1106

1107Matches on tool name, same values as PreToolUse.

1108

1109#### PostToolUseFailure input

1110

1111PostToolUseFailure hooks receive the same `tool_name` and `tool_input` fields as PostToolUse, along with error information as top-level fields:

1112

1113```json theme={null}

1114{

1115 "session_id": "abc123",

1116 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1117 "cwd": "/Users/...",

1118 "permission_mode": "default",

1119 "hook_event_name": "PostToolUseFailure",

1120 "tool_name": "Bash",

1121 "tool_input": {

1122 "command": "npm test",

1123 "description": "Run test suite"

1124 },

1125 "tool_use_id": "toolu_01ABC123...",

1126 "error": "Command exited with non-zero status code 1",

1127 "is_interrupt": false

1128}

1129```

1130

1131| Field | Description |

1132| :------------- | :------------------------------------------------------------------------------ |

1133| `error` | String describing what went wrong |

1134| `is_interrupt` | Optional boolean indicating whether the failure was caused by user interruption |

1135

1136#### PostToolUseFailure decision control

1137

1138`PostToolUseFailure` hooks can provide context to Claude after a tool failure. In addition to the [JSON output fields](#json-output) available to all hooks, your hook script can return these event-specific fields:

1139

1140| Field | Description |

1141| :------------------ | :------------------------------------------------------------ |

1142| `additionalContext` | Additional context for Claude to consider alongside the error |

1143

1144```json theme={null}

1145{

1146 "hookSpecificOutput": {

1147 "hookEventName": "PostToolUseFailure",

1148 "additionalContext": "Additional information about the failure for Claude"

1149 }

1150}

1151```

1152

1153### Notification

1154

1155Runs when Claude Code sends notifications. Matches on notification type: `permission_prompt`, `idle_prompt`, `auth_success`, `elicitation_dialog`. Omit the matcher to run hooks for all notification types.

1156

1157Use separate matchers to run different handlers depending on the notification type. This configuration triggers a permission-specific alert script when Claude needs permission approval and a different notification when Claude has been idle:

1158

1159```json theme={null}

1160{

1161 "hooks": {

1162 "Notification": [

1163 {

1164 "matcher": "permission_prompt",

1165 "hooks": [

1166 {

1167 "type": "command",

1168 "command": "/path/to/permission-alert.sh"

1169 }

1170 ]

1171 },

1172 {

1173 "matcher": "idle_prompt",

1174 "hooks": [

1175 {

1176 "type": "command",

1177 "command": "/path/to/idle-notification.sh"

1178 }

1179 ]

1180 }

1181 ]

1182 }

1183}

1184```

1185

1186#### Notification input

1187

1188In addition to the [common input fields](#common-input-fields), Notification hooks receive `message` with the notification text, an optional `title`, and `notification_type` indicating which type fired.

1189

1190```json theme={null}

1191{

1192 "session_id": "abc123",

1193 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1194 "cwd": "/Users/...",

1195 "hook_event_name": "Notification",

1196 "message": "Claude needs your permission to use Bash",

1197 "title": "Permission needed",

1198 "notification_type": "permission_prompt"

1199}

1200```

1201

1202Notification hooks cannot block or modify notifications. In addition to the [JSON output fields](#json-output) available to all hooks, you can return `additionalContext` to add context to the conversation:

1203

1204| Field | Description |

1205| :------------------ | :------------------------------- |

1206| `additionalContext` | String added to Claude's context |

1207

1208### SubagentStart

1209

1210Runs when a Claude Code subagent is spawned via the Agent tool. Supports matchers to filter by agent type name (built-in agents like `Bash`, `Explore`, `Plan`, or custom agent names from `.claude/agents/`).

1211

1212#### SubagentStart input

1213

1214In addition to the [common input fields](#common-input-fields), SubagentStart hooks receive `agent_id` with the unique identifier for the subagent and `agent_type` with the agent name (built-in agents like `"Bash"`, `"Explore"`, `"Plan"`, or custom agent names).

1215

1216```json theme={null}

1217{

1218 "session_id": "abc123",

1219 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1220 "cwd": "/Users/...",

1221 "hook_event_name": "SubagentStart",

1222 "agent_id": "agent-abc123",

1223 "agent_type": "Explore"

1224}

1225```

1226

1227SubagentStart hooks cannot block subagent creation, but they can inject context into the subagent. In addition to the [JSON output fields](#json-output) available to all hooks, you can return:

1228

1229| Field | Description |

1230| :------------------ | :------------------------------------- |

1231| `additionalContext` | String added to the subagent's context |

1232

1233```json theme={null}

1234{

1235 "hookSpecificOutput": {

1236 "hookEventName": "SubagentStart",

1237 "additionalContext": "Follow security guidelines for this task"

1238 }

1239}

1240```

1241

1242### SubagentStop

1243

1244Runs when a Claude Code subagent has finished responding. Matches on agent type, same values as SubagentStart.

1245

1246#### SubagentStop input

1247

1248In addition to the [common input fields](#common-input-fields), SubagentStop hooks receive `stop_hook_active`, `agent_id`, `agent_type`, `agent_transcript_path`, and `last_assistant_message`. The `agent_type` field is the value used for matcher filtering. The `transcript_path` is the main session's transcript, while `agent_transcript_path` is the subagent's own transcript stored in a nested `subagents/` folder. The `last_assistant_message` field contains the text content of the subagent's final response, so hooks can access it without parsing the transcript file.

1249

1250```json theme={null}

1251{

1252 "session_id": "abc123",

1253 "transcript_path": "~/.claude/projects/.../abc123.jsonl",

1254 "cwd": "/Users/...",

1255 "permission_mode": "default",

1256 "hook_event_name": "SubagentStop",

1257 "stop_hook_active": false,

1258 "agent_id": "def456",

1259 "agent_type": "Explore",

1260 "agent_transcript_path": "~/.claude/projects/.../abc123/subagents/agent-def456.jsonl",

1261 "last_assistant_message": "Analysis complete. Found 3 potential issues..."

1262}

1263```

1264

1265SubagentStop hooks use the same decision control format as [Stop hooks](#stop-decision-control).

1266

1267### Stop

1268

1269Runs when the main Claude Code agent has finished responding. Does not run if

1270the stoppage occurred due to a user interrupt. API errors fire

1271[StopFailure](#stopfailure) instead.

1272

1273#### Stop input

1274

1275In addition to the [common input fields](#common-input-fields), Stop hooks receive `stop_hook_active` and `last_assistant_message`. The `stop_hook_active` field is `true` when Claude Code is already continuing as a result of a stop hook. Check this value or process the transcript to prevent Claude Code from running indefinitely. The `last_assistant_message` field contains the text content of Claude's final response, so hooks can access it without parsing the transcript file.

1276

1277```json theme={null}

1278{

1279 "session_id": "abc123",

1280 "transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1281 "cwd": "/Users/...",

1282 "permission_mode": "default",

1283 "hook_event_name": "Stop",

1284 "stop_hook_active": true,

1285 "last_assistant_message": "I've completed the refactoring. Here's a summary..."

1286}

1287```

1288

1289#### Stop decision control

1290

1291`Stop` and `SubagentStop` hooks can control whether Claude continues. In addition to the [JSON output fields](#json-output) available to all hooks, your hook script can return these event-specific fields:

1292

1293| Field | Description |

1294| :--------- | :------------------------------------------------------------------------- |

1295| `decision` | `"block"` prevents Claude from stopping. Omit to allow Claude to stop |

1296| `reason` | Required when `decision` is `"block"`. Tells Claude why it should continue |

1297

1298```json theme={null}

1299{

1300 "decision": "block",

1301 "reason": "Must be provided when Claude is blocked from stopping"

1302}

1303```

1304

1305### StopFailure

1306

1307Runs instead of [Stop](#stop) when the turn ends due to an API error. Output and exit code are ignored. Use this to log failures, send alerts, or take recovery actions when Claude cannot complete a response due to rate limits, authentication problems, or other API errors.

1308

1309#### StopFailure input

1310

1311In addition to the [common input fields](#common-input-fields), StopFailure hooks receive `error`, optional `error_details`, and optional `last_assistant_message`. The `error` field identifies the error type and is used for matcher filtering.

1312

1313| Field | Description |

1314| :----------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

1315| `error` | Error type: `rate_limit`, `authentication_failed`, `billing_error`, `invalid_request`, `server_error`, `max_output_tokens`, or `unknown` |

1316| `error_details` | Additional details about the error, when available |

1317| `last_assistant_message` | The rendered error text shown in the conversation. Unlike `Stop` and `SubagentStop`, where this field holds Claude's conversational output, for `StopFailure` it contains the API error string itself, such as `"API Error: Rate limit reached"` |

1318

1319```json theme={null}

1320{

1321 "session_id": "abc123",

1322 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1323 "cwd": "/Users/...",

1324 "hook_event_name": "StopFailure",

1325 "error": "rate_limit",

1326 "error_details": "429 Too Many Requests",

1327 "last_assistant_message": "API Error: Rate limit reached"

1328}

1329```

1330

1331StopFailure hooks have no decision control. They run for notification and logging purposes only.

1332

1333### TeammateIdle

1334

1335Runs when an [agent team](/en/agent-teams) teammate is about to go idle after finishing its turn. Use this to enforce quality gates before a teammate stops working, such as requiring passing lint checks or verifying that output files exist.

1336

1337When a `TeammateIdle` hook exits with code 2, the teammate receives the stderr message as feedback and continues working instead of going idle. To stop the teammate entirely instead of re-running it, return JSON with `{"continue": false, "stopReason": "..."}`. TeammateIdle hooks do not support matchers and fire on every occurrence.

1338

1339#### TeammateIdle input

1340

1341In addition to the [common input fields](#common-input-fields), TeammateIdle hooks receive `teammate_name` and `team_name`.

1342

1343```json theme={null}

1344{

1345 "session_id": "abc123",

1346 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1347 "cwd": "/Users/...",

1348 "permission_mode": "default",

1349 "hook_event_name": "TeammateIdle",

1350 "teammate_name": "researcher",

1351 "team_name": "my-project"

1352}

1353```

1354

1355| Field | Description |

1356| :-------------- | :-------------------------------------------- |

1357| `teammate_name` | Name of the teammate that is about to go idle |

1358| `team_name` | Name of the team |

1359

1360#### TeammateIdle decision control

1361

1362TeammateIdle hooks support two ways to control teammate behavior:

1363

1364* **Exit code 2**: the teammate receives the stderr message as feedback and continues working instead of going idle.

1365* **JSON `{"continue": false, "stopReason": "..."}`**: stops the teammate entirely, matching `Stop` hook behavior. The `stopReason` is shown to the user.

1366

1367This example checks that a build artifact exists before allowing a teammate to go idle:

1368

1369```bash theme={null}

1370#!/bin/bash

1371

1372if [ ! -f "./dist/output.js" ]; then

1373 echo "Build artifact missing. Run the build before stopping." >&2

1374 exit 2

1375fi

1376

1377exit 0

1378```

1379

1380### TaskCompleted

1381

1382Runs when a task is being marked as completed. This fires in two situations: when any agent explicitly marks a task as completed through the TaskUpdate tool, or when an [agent team](/en/agent-teams) teammate finishes its turn with in-progress tasks. Use this to enforce completion criteria like passing tests or lint checks before a task can close.

1383

1384When a `TaskCompleted` hook exits with code 2, the task is not marked as completed and the stderr message is fed back to the model as feedback. To stop the teammate entirely instead of re-running it, return JSON with `{"continue": false, "stopReason": "..."}`. TaskCompleted hooks do not support matchers and fire on every occurrence.

1385

1386#### TaskCompleted input

1387

1388In addition to the [common input fields](#common-input-fields), TaskCompleted hooks receive `task_id`, `task_subject`, and optionally `task_description`, `teammate_name`, and `team_name`.

1389

1390```json theme={null}

1391{

1392 "session_id": "abc123",

1393 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1394 "cwd": "/Users/...",

1395 "permission_mode": "default",

1396 "hook_event_name": "TaskCompleted",

1397 "task_id": "task-001",

1398 "task_subject": "Implement user authentication",

1399 "task_description": "Add login and signup endpoints",

1400 "teammate_name": "implementer",

1401 "team_name": "my-project"

1402}

1403```

1404

1405| Field | Description |

1406| :----------------- | :------------------------------------------------------ |

1407| `task_id` | Identifier of the task being completed |

1408| `task_subject` | Title of the task |

1409| `task_description` | Detailed description of the task. May be absent |

1410| `teammate_name` | Name of the teammate completing the task. May be absent |

1411| `team_name` | Name of the team. May be absent |

1412

1413#### TaskCompleted decision control

1414

1415TaskCompleted hooks support two ways to control task completion:

1416

1417* **Exit code 2**: the task is not marked as completed and the stderr message is fed back to the model as feedback.

1418* **JSON `{"continue": false, "stopReason": "..."}`**: stops the teammate entirely, matching `Stop` hook behavior. The `stopReason` is shown to the user.

1419

1420This example runs tests and blocks task completion if they fail:

1421

1422```bash theme={null}

1423#!/bin/bash

1424INPUT=$(cat)

1425TASK_SUBJECT=$(echo "$INPUT" | jq -r '.task_subject')

1426

1427# Run the test suite

1428if ! npm test 2>&1; then

1429 echo "Tests not passing. Fix failing tests before completing: $TASK_SUBJECT" >&2

1430 exit 2

1431fi

1432

1433exit 0

1434```

1435

1436### ConfigChange

1437

1438Runs when a configuration file changes during a session. Use this to audit settings changes, enforce security policies, or block unauthorized modifications to configuration files.

1439

1440ConfigChange hooks fire for changes to settings files, managed policy settings, and skill files. The `source` field in the input tells you which type of configuration changed, and the optional `file_path` field provides the path to the changed file.

1441

1442The matcher filters on the configuration source:

1443

1444| Matcher | When it fires |

1445| :----------------- | :---------------------------------------- |

1446| `user_settings` | `~/.claude/settings.json` changes |

1447| `project_settings` | `.claude/settings.json` changes |

1448| `local_settings` | `.claude/settings.local.json` changes |

1449| `policy_settings` | Managed policy settings change |

1450| `skills` | A skill file in `.claude/skills/` changes |

1451

1452This example logs all configuration changes for security auditing:

1453

1454```json theme={null}

1455{

1456 "hooks": {

1457 "ConfigChange": [

1458 {

1459 "hooks": [

1460 {

1461 "type": "command",

1462 "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/audit-config-change.sh"

1463 }

1464 ]

1465 }

1466 ]

1467 }

1468}

1469```

1470

1471#### ConfigChange input

1472

1473In addition to the [common input fields](#common-input-fields), ConfigChange hooks receive `source` and optionally `file_path`. The `source` field indicates which configuration type changed, and `file_path` provides the path to the specific file that was modified.

1474

1475```json theme={null}

1476{

1477 "session_id": "abc123",

1478 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1479 "cwd": "/Users/...",

1480 "hook_event_name": "ConfigChange",

1481 "source": "project_settings",

1482 "file_path": "/Users/.../my-project/.claude/settings.json"

1483}

1484```

1485

1486#### ConfigChange decision control

1487

1488ConfigChange hooks can block configuration changes from taking effect. Use exit code 2 or a JSON `decision` to prevent the change. When blocked, the new settings are not applied to the running session.

1489

1490| Field | Description |

1491| :--------- | :--------------------------------------------------------------------------------------- |

1492| `decision` | `"block"` prevents the configuration change from being applied. Omit to allow the change |

1493| `reason` | Explanation shown to the user when `decision` is `"block"` |

1494

1495```json theme={null}

1496{

1497 "decision": "block",

1498 "reason": "Configuration changes to project settings require admin approval"

1499}

1500```

1501

1502`policy_settings` changes cannot be blocked. Hooks still fire for `policy_settings` sources, so you can use them for audit logging, but any blocking decision is ignored. This ensures enterprise-managed settings always take effect.

1503

1504### CwdChanged

1505

1506Runs when the working directory changes during a session, for example when Claude executes a `cd` command. Use this to react to directory changes: reload environment variables, activate project-specific toolchains, or run setup scripts automatically. Pairs with [FileChanged](#filechanged) for tools like [direnv](https://direnv.net/) that manage per-directory environment.

1507

1508CwdChanged hooks have access to `CLAUDE_ENV_FILE`. Variables written to that file persist into subsequent Bash commands for the session, just as in [SessionStart hooks](#persist-environment-variables). Only `type: "command"` hooks are supported.

1509

1510CwdChanged does not support matchers and fires on every directory change.

1511

1512#### CwdChanged input

1513

1514In addition to the [common input fields](#common-input-fields), CwdChanged hooks receive `old_cwd` and `new_cwd`.

1515

1516```json theme={null}

1517{

1518 "session_id": "abc123",

1519 "transcript_path": "/Users/.../.claude/projects/.../transcript.jsonl",

1520 "cwd": "/Users/my-project/src",

1521 "hook_event_name": "CwdChanged",

1522 "old_cwd": "/Users/my-project",

1523 "new_cwd": "/Users/my-project/src"

1524}

1525```

1526

1527#### CwdChanged output

1528

1529In addition to the [JSON output fields](#json-output) available to all hooks, CwdChanged hooks can return `watchPaths` to dynamically set which file paths [FileChanged](#filechanged) watches:

1530

1531| Field | Description |

1532| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

1533| `watchPaths` | Array of absolute paths. Replaces the current dynamic watch list (paths from your `matcher` configuration are always watched). Returning an empty array clears the dynamic list, which is typical when entering a new directory |

1534

1535CwdChanged hooks have no decision control. They cannot block the directory change.

1536

1537### FileChanged

1538

1539Runs when a watched file changes on disk. The `matcher` field in your hook configuration controls which filenames to watch: it is a pipe-separated list of basenames (filenames without directory paths, for example `".envrc|.env"`). The same `matcher` value is also used to filter which hooks run when a file changes, matching against the basename of the changed file. Useful for reloading environment variables when project configuration files are modified.

1540

1541FileChanged hooks have access to `CLAUDE_ENV_FILE`. Variables written to that file persist into subsequent Bash commands for the session, just as in [SessionStart hooks](#persist-environment-variables). Only `type: "command"` hooks are supported.

1542

1543#### FileChanged input

1544

1545In addition to the [common input fields](#common-input-fields), FileChanged hooks receive `file_path` and `event`.

1546

1547| Field | Description |

1548| :---------- | :---------------------------------------------------------------------------------------------- |

1549| `file_path` | Absolute path to the file that changed |

1550| `event` | What happened: `"change"` (file modified), `"add"` (file created), or `"unlink"` (file deleted) |

1551

1552```json theme={null}

1553{

1554 "session_id": "abc123",

1555 "transcript_path": "/Users/.../.claude/projects/.../transcript.jsonl",

1556 "cwd": "/Users/my-project",

1557 "hook_event_name": "FileChanged",

1558 "file_path": "/Users/my-project/.envrc",

1559 "event": "change"

1560}

1561```

1562

1563#### FileChanged output

1564

1565In addition to the [JSON output fields](#json-output) available to all hooks, FileChanged hooks can return `watchPaths` to dynamically update which file paths are watched:

1566

1567| Field | Description |

1568| :----------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

1569| `watchPaths` | Array of absolute paths. Replaces the current dynamic watch list (paths from your `matcher` configuration are always watched). Use this when your hook script discovers additional files to watch based on the changed file |

484 1570

485The exact schema for `tool_input` and `tool_response` depends on the tool.1571FileChanged hooks have no decision control. They cannot block the file change from occurring.

1572

1573### WorktreeCreate

1574

1575When you run `claude --worktree` or a [subagent uses `isolation: "worktree"`](/en/sub-agents#choose-the-subagent-scope), Claude Code creates an isolated working copy using `git worktree`. If you configure a WorktreeCreate hook, it replaces the default git behavior, letting you use a different version control system like SVN, Perforce, or Mercurial.

1576

1577The hook must print the absolute path to the created worktree directory on stdout. Claude Code uses this path as the working directory for the isolated session.

1578

1579This example creates an SVN working copy and prints the path for Claude Code to use. Replace the repository URL with your own:

486 1580

487```json theme={null}1581```json theme={null}

488{1582{

489 "session_id": "abc123",1583 "hooks": {

490 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",1584 "WorktreeCreate": [

491 "cwd": "/Users/...",1585 {

492 "permission_mode": "default",1586 "hooks": [

493 "hook_event_name": "PostToolUse",1587 {

494 "tool_name": "Write",1588 "type": "command",

495 "tool_input": {1589 "command": "bash -c 'NAME=$(jq -r .name); DIR=\"$HOME/.claude/worktrees/$NAME\"; svn checkout https://svn.example.com/repo/trunk \"$DIR\" >&2 && echo \"$DIR\"'"

496 "file_path": "/path/to/file.txt",1590 }

497 "content": "file content"1591 ]

498 },1592 }

499 "tool_response": {1593 ]

500 "filePath": "/path/to/file.txt",1594 }

501 "success": true

502 },

503 "tool_use_id": "toolu_01ABC123..."

504}1595}

505```1596```

506 1597

507### Notification Input1598The hook reads the worktree `name` from the JSON input on stdin, checks out a fresh copy into a new directory, and prints the directory path. The `echo` on the last line is what Claude Code reads as the worktree path. Redirect any other output to stderr so it doesn't interfere with the path.

1599

1600#### WorktreeCreate input

1601

1602In addition to the [common input fields](#common-input-fields), WorktreeCreate hooks receive the `name` field. This is a slug identifier for the new worktree, either specified by the user or auto-generated (for example, `bold-oak-a3f2`).

508 1603

509```json theme={null}1604```json theme={null}

510{1605{

511 "session_id": "abc123",1606 "session_id": "abc123",

512 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",1607 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

513 "cwd": "/Users/...",1608 "cwd": "/Users/...",

514 "permission_mode": "default",1609 "hook_event_name": "WorktreeCreate",

515 "hook_event_name": "Notification",1610 "name": "feature-auth"

516 "message": "Claude needs your permission to use Bash",

517 "notification_type": "permission_prompt"

518}1611}

519```1612```

520 1613

521### UserPromptSubmit Input1614#### WorktreeCreate output

1615

1616The hook must print the absolute path to the created worktree directory on stdout. If the hook fails or produces no output, worktree creation fails with an error.

1617

1618WorktreeCreate hooks do not use the standard allow/block decision model. Instead, the hook's success or failure determines the outcome. Only `type: "command"` hooks are supported.

1619

1620### WorktreeRemove

1621

1622The cleanup counterpart to [WorktreeCreate](#worktreecreate). This hook fires when a worktree is being removed, either when you exit a `--worktree` session and choose to remove it, or when a subagent with `isolation: "worktree"` finishes. For git-based worktrees, Claude handles cleanup automatically with `git worktree remove`. If you configured a WorktreeCreate hook for a non-git version control system, pair it with a WorktreeRemove hook to handle cleanup. Without one, the worktree directory is left on disk.

1623

1624Claude Code passes the path that WorktreeCreate printed on stdout as `worktree_path` in the hook input. This example reads that path and removes the directory:

522 1625

523```json theme={null}1626```json theme={null}

524{1627{

525 "session_id": "abc123",1628 "hooks": {

526 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",1629 "WorktreeRemove": [

527 "cwd": "/Users/...",1630 {

528 "permission_mode": "default",1631 "hooks": [

529 "hook_event_name": "UserPromptSubmit",1632 {

530 "prompt": "Write a function to calculate the factorial of a number"1633 "type": "command",

1634 "command": "bash -c 'jq -r .worktree_path | xargs rm -rf'"

1635 }

1636 ]

1637 }

1638 ]

1639 }

531}1640}

532```1641```

533 1642

534### Stop and SubagentStop Input1643#### WorktreeRemove input

535 1644

536`stop_hook_active` is true when Claude Code is already continuing as a result of1645In addition to the [common input fields](#common-input-fields), WorktreeRemove hooks receive the `worktree_path` field, which is the absolute path to the worktree being removed.

537a stop hook. Check this value or process the transcript to prevent Claude Code

538from running indefinitely.

539 1646

540```json theme={null}1647```json theme={null}

541{1648{

542 "session_id": "abc123",1649 "session_id": "abc123",

543 "transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",1650 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

544 "permission_mode": "default",1651 "cwd": "/Users/...",

545 "hook_event_name": "Stop",1652 "hook_event_name": "WorktreeRemove",

546 "stop_hook_active": true1653 "worktree_path": "/Users/.../my-project/.claude/worktrees/feature-auth"

547}1654}

548```1655```

549 1656

550### PreCompact Input1657WorktreeRemove hooks have no decision control. They cannot block worktree removal but can perform cleanup tasks like removing version control state or archiving changes. Hook failures are logged in debug mode only. Only `type: "command"` hooks are supported.

1658

1659### PreCompact

1660

1661Runs before Claude Code is about to run a compact operation.

1662

1663The matcher value indicates whether compaction was triggered manually or automatically:

1664

1665| Matcher | When it fires |

1666| :------- | :------------------------------------------- |

1667| `manual` | `/compact` |

1668| `auto` | Auto-compact when the context window is full |

1669

1670#### PreCompact input

551 1671

552For `manual`, `custom_instructions` comes from what the user passes into1672In addition to the [common input fields](#common-input-fields), PreCompact hooks receive `trigger` and `custom_instructions`. For `manual`, `custom_instructions` contains what the user passes into `/compact`. For `auto`, `custom_instructions` is empty.

553`/compact`. For `auto`, `custom_instructions` is empty.

554 1673

555```json theme={null}1674```json theme={null}

556{1675{

557 "session_id": "abc123",1676 "session_id": "abc123",

558 "transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",1677 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

559 "permission_mode": "default",1678 "cwd": "/Users/...",

560 "hook_event_name": "PreCompact",1679 "hook_event_name": "PreCompact",

561 "trigger": "manual",1680 "trigger": "manual",

562 "custom_instructions": ""1681 "custom_instructions": ""

563}1682}

564```1683```

565 1684

566### SessionStart Input1685### PostCompact

1686

1687Runs after Claude Code completes a compact operation. Use this event to react to the new compacted state, for example to log the generated summary or update external state.

1688

1689The same matcher values apply as for `PreCompact`:

1690

1691| Matcher | When it fires |

1692| :------- | :------------------------------------------------- |

1693| `manual` | After `/compact` |

1694| `auto` | After auto-compact when the context window is full |

1695

1696#### PostCompact input

1697

1698In addition to the [common input fields](#common-input-fields), PostCompact hooks receive `trigger` and `compact_summary`. The `compact_summary` field contains the conversation summary generated by the compact operation.

567 1699

568```json theme={null}1700```json theme={null}

569{1701{

570 "session_id": "abc123",1702 "session_id": "abc123",

571 "transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",1703 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

572 "permission_mode": "default",1704 "cwd": "/Users/...",

573 "hook_event_name": "SessionStart",1705 "hook_event_name": "PostCompact",

574 "source": "startup"1706 "trigger": "manual",

1707 "compact_summary": "Summary of the compacted conversation..."

575}1708}

576```1709```

577 1710

578### SessionEnd Input1711PostCompact hooks have no decision control. They cannot affect the compaction result but can perform follow-up tasks.

1712

1713### SessionEnd

1714

1715Runs when a Claude Code session ends. Useful for cleanup tasks, logging session

1716statistics, or saving session state. Supports matchers to filter by exit reason.

1717

1718The `reason` field in the hook input indicates why the session ended:

1719

1720| Reason | Description |

1721| :---------------------------- | :----------------------------------------- |

1722| `clear` | Session cleared with `/clear` command |

1723| `resume` | Session switched via interactive `/resume` |

1724| `logout` | User logged out |

1725| `prompt_input_exit` | User exited while prompt input was visible |

1726| `bypass_permissions_disabled` | Bypass permissions mode was disabled |

1727| `other` | Other exit reasons |

1728

1729#### SessionEnd input

1730

1731In addition to the [common input fields](#common-input-fields), SessionEnd hooks receive a `reason` field indicating why the session ended. See the [reason table](#sessionend) above for all values.

579 1732

580```json theme={null}1733```json theme={null}

581{1734{

582 "session_id": "abc123",1735 "session_id": "abc123",

583 "transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",1736 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

584 "cwd": "/Users/...",1737 "cwd": "/Users/...",

585 "permission_mode": "default",

586 "hook_event_name": "SessionEnd",1738 "hook_event_name": "SessionEnd",

587 "reason": "exit"1739 "reason": "other"

588}1740}

589```1741```

590 1742

591## Hook Output1743SessionEnd hooks have no decision control. They cannot block session termination but can perform cleanup tasks.

~~592~~

593There are two mutually-exclusive ways for hooks to return output back to Claude Code. The output

594communicates whether to block and any feedback that should be shown to Claude

595and the user.

~~596~~

597### Simple: Exit Code

598 1744

599Hooks communicate status through exit codes, stdout, and stderr:1745SessionEnd hooks have a default timeout of 1.5 seconds. This applies to session exit, `/clear`, and switching sessions via interactive `/resume`. If your hooks need more time, set the `CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS` environment variable to a higher value in milliseconds. Any per-hook `timeout` setting is also capped by this value.

600 1746

601* **Exit code 0**: Success. `stdout` is shown to the user in verbose mode1747```bash theme={null}

602 (ctrl+o), except for `UserPromptSubmit` and `SessionStart`, where stdout is1748CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS=5000 claude

603 added to the context. JSON output in `stdout` is parsed for structured control1749```

604 (see [Advanced: JSON Output](#advanced-json-output)).

605* **Exit code 2**: Blocking error. Only `stderr` is used as the error message

606 and fed back to Claude. The format is `[command]: {stderr}`. JSON in `stdout`

607 is **not** processed for exit code 2. See per-hook-event behavior below.

608* **Other exit codes**: Non-blocking error. `stderr` is shown to the user in verbose mode (ctrl+o) with

609 format `Failed with non-blocking status code: {stderr}`. If `stderr` is empty,

610 it shows `No stderr output`. Execution continues.

~~611~~

612<Warning>

613 Reminder: Claude Code does not see stdout if the exit code is 0, except for

614 the `UserPromptSubmit` hook where stdout is injected as context.

615</Warning>

~~616~~

617#### Exit Code 2 Behavior

618 1750

619| Hook Event | Behavior |1751### Elicitation

620| ------------------- | ------------------------------------------------------------------ |

621| `PreToolUse` | Blocks the tool call, shows stderr to Claude |

622| `PermissionRequest` | Denies the permission, shows stderr to Claude |

623| `PostToolUse` | Shows stderr to Claude (tool already ran) |

624| `Notification` | N/A, shows stderr to user only |

625| `UserPromptSubmit` | Blocks prompt processing, erases prompt, shows stderr to user only |

626| `Stop` | Blocks stoppage, shows stderr to Claude |

627| `SubagentStop` | Blocks stoppage, shows stderr to Claude subagent |

628| `PreCompact` | N/A, shows stderr to user only |

629| `SessionStart` | N/A, shows stderr to user only |

630| `SessionEnd` | N/A, shows stderr to user only |

631 1752

632### Advanced: JSON Output1753Runs when an MCP server requests user input mid-task. By default, Claude Code shows an interactive dialog for the user to respond. Hooks can intercept this request and respond programmatically, skipping the dialog entirely.

633 1754

634Hooks can return structured JSON in `stdout` for more sophisticated control.1755The matcher field matches against the MCP server name.

635 1756

636<Warning>1757#### Elicitation input

637 JSON output is only processed when the hook exits with code 0. If your hook

638 exits with code 2 (blocking error), `stderr` text is used directly—any JSON in `stdout`

639 is ignored. For other non-zero exit codes, only `stderr` is shown to the user in verbose mode (ctrl+o).

640</Warning>

641 1758

642#### Common JSON Fields1759In addition to the [common input fields](#common-input-fields), Elicitation hooks receive `mcp_server_name`, `message`, and optional `mode`, `url`, `elicitation_id`, and `requested_schema` fields.

643 1760

644All hook types can include these optional fields:1761For form-mode elicitation (the most common case):

645 1762

646```json theme={null}1763```json theme={null}

647{1764{

648 "continue": true, // Whether Claude should continue after hook execution (default: true)1765 "session_id": "abc123",

649 "stopReason": "string", // Message shown when continue is false1766 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

~~650~~ 1767 "cwd": "/Users/...",

651 "suppressOutput": true, // Hide stdout from transcript mode (default: false)1768 "permission_mode": "default",

652 "systemMessage": "string" // Optional warning message shown to the user1769 "hook_event_name": "Elicitation",

1770 "mcp_server_name": "my-mcp-server",

1771 "message": "Please provide your credentials",

1772 "mode": "form",

1773 "requested_schema": {

1774 "type": "object",

1775 "properties": {

1776 "username": { "type": "string", "title": "Username" }

1777 }

1778 }

653}1779}

654```1780```

655 1781

656If `continue` is false, Claude stops processing after the hooks run.1782For URL-mode elicitation (browser-based authentication):

~~657~~

658* For `PreToolUse`, this is different from `"permissionDecision": "deny"`, which

659 only blocks a specific tool call and provides automatic feedback to Claude.

660* For `PostToolUse`, this is different from `"decision": "block"`, which

661 provides automated feedback to Claude.

662* For `UserPromptSubmit`, this prevents the prompt from being processed.

663* For `Stop` and `SubagentStop`, this takes precedence over any

664 `"decision": "block"` output.

665* In all cases, `"continue" = false` takes precedence over any

666 `"decision": "block"` output.

667 1783

668`stopReason` accompanies `continue` with a reason shown to the user, not shown1784```json theme={null}

669to Claude.1785{

~~670~~ 1786 "session_id": "abc123",

671#### `PreToolUse` Decision Control1787 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

~~672~~ 1788 "cwd": "/Users/...",

673`PreToolUse` hooks can control whether a tool call proceeds.1789 "permission_mode": "default",

~~674~~ 1790 "hook_event_name": "Elicitation",

675* `"allow"` bypasses the permission system. `permissionDecisionReason` is shown1791 "mcp_server_name": "my-mcp-server",

676 to the user but not to Claude.1792 "message": "Please authenticate",

677* `"deny"` prevents the tool call from executing. `permissionDecisionReason` is1793 "mode": "url",

678 shown to Claude.1794 "url": "https://auth.example.com/login"

679* `"ask"` asks the user to confirm the tool call in the UI.1795}

680 `permissionDecisionReason` is shown to the user but not to Claude.1796```

681 1797

682Additionally, hooks can modify tool inputs before execution using `updatedInput`:1798#### Elicitation output

683 1799

684* `updatedInput` allows you to modify the tool's input parameters before the tool executes.1800To respond programmatically without showing the dialog, return a JSON object with `hookSpecificOutput`:

685* This is most useful with `"permissionDecision": "allow"` to modify and approve tool calls.

686 1801

687```json theme={null}1802```json theme={null}

688{1803{

689 "hookSpecificOutput": {1804 "hookSpecificOutput": {

690 "hookEventName": "PreToolUse",1805 "hookEventName": "Elicitation",

691 "permissionDecision": "allow"1806 "action": "accept",

692 "permissionDecisionReason": "My reason here",1807 "content": {

693 "updatedInput": {1808 "username": "alice"

694 "field_to_modify": "new value"

695 }1809 }

696 }1810 }

697}1811}

698```1812```

699 1813

700<Note>1814| Field | Values | Description |

701 The `decision` and `reason` fields are deprecated for PreToolUse hooks.1815| :-------- | :---------------------------- | :--------------------------------------------------------------- |

702 Use `hookSpecificOutput.permissionDecision` and1816| `action` | `accept`, `decline`, `cancel` | Whether to accept, decline, or cancel the request |

703 `hookSpecificOutput.permissionDecisionReason` instead. The deprecated fields1817| `content` | object | Form field values to submit. Only used when `action` is `accept` |

704 `"approve"` and `"block"` map to `"allow"` and `"deny"` respectively.1818

705</Note>1819Exit code 2 denies the elicitation and shows stderr to the user.

1820

1821### ElicitationResult

1822

1823Runs after a user responds to an MCP elicitation. Hooks can observe, modify, or block the response before it is sent back to the MCP server.

706 1824

707#### `PermissionRequest` Decision Control1825The matcher field matches against the MCP server name.

708 1826

709`PermissionRequest` hooks can allow or deny permission requests shown to the user.1827#### ElicitationResult input

710 1828

711* For `"behavior": "allow"` you can also optionally pass in an `"updatedInput"` that modifies the tool's input parameters before the tool executes.1829In addition to the [common input fields](#common-input-fields), ElicitationResult hooks receive `mcp_server_name`, `action`, and optional `mode`, `elicitation_id`, and `content` fields.

712* For `"behavior": "deny"` you can also optionally pass in a `"message"` string that tells the model why the permission was denied, and a boolean `"interrupt"` which will stop Claude.

713 1830

714```json theme={null}1831```json theme={null}

715{1832{

716 "hookSpecificOutput": {1833 "session_id": "abc123",

717 "hookEventName": "PermissionRequest",1834 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

718 "decision": {1835 "cwd": "/Users/...",

719 "behavior": "allow",1836 "permission_mode": "default",

720 "updatedInput": {1837 "hook_event_name": "ElicitationResult",

721 "command": "npm run lint"1838 "mcp_server_name": "my-mcp-server",

722 }1839 "action": "accept",

723 }1840 "content": { "username": "alice" },

724 }1841 "mode": "form",

1842 "elicitation_id": "elicit-123"

725}1843}

726```1844```

727 1845

728#### `PostToolUse` Decision Control1846#### ElicitationResult output

~~729~~

730`PostToolUse` hooks can provide feedback to Claude after tool execution.

731 1847

732* `"block"` automatically prompts Claude with `reason`.1848To override the user's response, return a JSON object with `hookSpecificOutput`:

733* `undefined` does nothing. `reason` is ignored.

734* `"hookSpecificOutput.additionalContext"` adds context for Claude to consider.

735 1849

736```json theme={null}1850```json theme={null}

737{1851{

738 "decision": "block" | undefined,

739 "reason": "Explanation for decision",

740 "hookSpecificOutput": {1852 "hookSpecificOutput": {

741 "hookEventName": "PostToolUse",1853 "hookEventName": "ElicitationResult",

742 "additionalContext": "Additional information for Claude"1854 "action": "decline",

1855 "content": {}

743 }1856 }

744}1857}

745```1858```

746 1859

747#### `UserPromptSubmit` Decision Control1860| Field | Values | Description |

~~748~~ 1861| :-------- | :---------------------------- | :--------------------------------------------------------------------- |

749`UserPromptSubmit` hooks can control whether a user prompt is processed and add context.1862| `action` | `accept`, `decline`, `cancel` | Overrides the user's action |

1863| `content` | object | Overrides form field values. Only meaningful when `action` is `accept` |

1864

1865Exit code 2 blocks the response, changing the effective action to `decline`.

1866

1867## Prompt-based hooks

1868

1869In addition to command and HTTP hooks, Claude Code supports prompt-based hooks (`type: "prompt"`) that use an LLM to evaluate whether to allow or block an action, and agent hooks (`type: "agent"`) that spawn an agentic verifier with tool access. Not all events support every hook type.

1870

1871Events that support all four hook types (`command`, `http`, `prompt`, and `agent`):

1872

1873* `PermissionRequest`

1874* `PostToolUse`

1875* `PostToolUseFailure`

1876* `PreToolUse`

1877* `Stop`

1878* `SubagentStop`

1879* `TaskCompleted`

1880* `UserPromptSubmit`

1881

1882Events that only support `type: "command"` hooks:

1883

1884* `ConfigChange`

1885* `CwdChanged`

1886* `Elicitation`

1887* `ElicitationResult`

1888* `FileChanged`

1889* `InstructionsLoaded`

1890* `Notification`

1891* `PostCompact`

1892* `PreCompact`

1893* `SessionEnd`

1894* `SessionStart`

1895* `StopFailure`

1896* `SubagentStart`

1897* `TeammateIdle`

1898* `WorktreeCreate`

1899* `WorktreeRemove`

750 1900

751**Adding context (exit code 0):**1901### How prompt-based hooks work

752There are two ways to add context to the conversation:

753 1902

7541. **Plain text stdout** (simpler): Any non-JSON text written to stdout is added1903Instead of executing a Bash command, prompt-based hooks:

755 as context. This is the easiest way to inject information.

756 1904

7572. **JSON with `additionalContext`** (structured): Use the JSON format below for19051. Send the hook input and your prompt to a Claude model, Haiku by default

758 more control. The `additionalContext` field is added as context.19062. The LLM responds with structured JSON containing a decision

19073. Claude Code processes the decision automatically

759 1908

760Both methods work with exit code 0. Plain stdout is shown as hook output in1909### Prompt hook configuration

761the transcript; `additionalContext` is added more discretely.

762 1910

763**Blocking prompts:**1911Set `type` to `"prompt"` and provide a `prompt` string instead of a `command`. Use the `$ARGUMENTS` placeholder to inject the hook's JSON input data into your prompt text. Claude Code sends the combined prompt and input to a fast Claude model, which returns a JSON decision.

764 1912

765* `"decision": "block"` prevents the prompt from being processed. The submitted1913This `Stop` hook asks the LLM to evaluate whether all tasks are complete before allowing Claude to finish:

766 prompt is erased from context. `"reason"` is shown to the user but not added

767 to context.

768* `"decision": undefined` (or omitted) allows the prompt to proceed normally.

769 1914

770```json theme={null}1915```json theme={null}

771{1916{

772 "decision": "block" | undefined,1917 "hooks": {

773 "reason": "Explanation for decision",1918 "Stop": [

774 "hookSpecificOutput": {1919 {

775 "hookEventName": "UserPromptSubmit",1920 "hooks": [

776 "additionalContext": "My additional context here"1921 {

1922 "type": "prompt",

1923 "prompt": "Evaluate if Claude should stop: $ARGUMENTS. Check if all tasks are complete."

1924 }

1925 ]

1926 }

1927 ]

777 }1928 }

778}1929}

779```1930```

780 1931

781<Note>1932| Field | Required | Description |

782 The JSON format is not required for simple use cases. To add context, you can1933| :-------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

783 just print plain text to stdout with exit code 0. Use JSON when you need to1934| `type` | yes | Must be `"prompt"` |

784 block prompts or want more structured control.1935| `prompt` | yes | The prompt text to send to the LLM. Use `$ARGUMENTS` as a placeholder for the hook input JSON. If `$ARGUMENTS` is not present, input JSON is appended to the prompt |

785</Note>1936| `model` | no | Model to use for evaluation. Defaults to a fast model |

~~786~~ 1937| `timeout` | no | Timeout in seconds. Default: 30 |

787#### `Stop`/`SubagentStop` Decision Control

788 1938

789`Stop` and `SubagentStop` hooks can control whether Claude must continue.1939### Response schema

790 1940

791* `"block"` prevents Claude from stopping. You must populate `reason` for Claude1941The LLM must respond with JSON containing:

792 to know how to proceed.

793* `undefined` allows Claude to stop. `reason` is ignored.

794 1942

795```json theme={null}1943```json theme={null}

796{1944{

797 "decision": "block" | undefined,1945 "ok": true | false,

798 "reason": "Must be provided when Claude is blocked from stopping"1946 "reason": "Explanation for the decision"

799}1947}

800```1948```

801 1949

802#### `SessionStart` Decision Control1950| Field | Description |

1951| :------- | :--------------------------------------------------------- |

1952| `ok` | `true` allows the action, `false` prevents it |

1953| `reason` | Required when `ok` is `false`. Explanation shown to Claude |

803 1954

804`SessionStart` hooks allow you to load in context at the start of a session.1955### Example: Multi-criteria Stop hook

805 1956

806* `"hookSpecificOutput.additionalContext"` adds the string to the context.1957This `Stop` hook uses a detailed prompt to check three conditions before allowing Claude to stop. If `"ok"` is `false`, Claude continues working with the provided reason as its next instruction. `SubagentStop` hooks use the same format to evaluate whether a [subagent](/en/sub-agents) should stop:

807* Multiple hooks' `additionalContext` values are concatenated.

808 1958

809```json theme={null}1959```json theme={null}

810{1960{

811 "hookSpecificOutput": {1961 "hooks": {

812 "hookEventName": "SessionStart",1962 "Stop": [

813 "additionalContext": "My additional context here"1963 {

1964 "hooks": [

1965 {

1966 "type": "prompt",

1967 "prompt": "You are evaluating whether Claude should stop working. Context: $ARGUMENTS\n\nAnalyze the conversation and determine if:\n1. All user-requested tasks are complete\n2. Any errors need to be addressed\n3. Follow-up work is needed\n\nRespond with JSON: {\"ok\": true} to allow stopping, or {\"ok\": false, \"reason\": \"your explanation\"} to continue working.",

1968 "timeout": 30

1969 }

1970 ]

1971 }

1972 ]

814 }1973 }

815}1974}

816```1975```

817 1976

818#### `SessionEnd` Decision Control1977## Agent-based hooks

~~819~~

820`SessionEnd` hooks run when a session ends. They cannot block session termination

821but can perform cleanup tasks.

~~822~~

823#### Exit Code Example: Bash Command Validation

~~824~~

825```python theme={null}

826#!/usr/bin/env python3

827import json

828import re

829import sys

~~830~~

831# Define validation rules as a list of (regex pattern, message) tuples

832VALIDATION_RULES = [

833 (

834 r"\bgrep\b(?!.*\|)",

835 "Use 'rg' (ripgrep) instead of 'grep' for better performance and features",

836 ),

837 (

838 r"\bfind\s+\S+\s+-name\b",

839 "Use 'rg --files | rg pattern' or 'rg --files -g pattern' instead of 'find -name' for better performance",

840 ),

841]

~~842~~

~~843~~

844def validate_command(command: str) -> list[str]:

845 issues = []

846 for pattern, message in VALIDATION_RULES:

847 if re.search(pattern, command):

848 issues.append(message)

849 return issues

~~850~~

~~851~~

852try:

853 input_data = json.load(sys.stdin)

854except json.JSONDecodeError as e:

855 print(f"Error: Invalid JSON input: {e}", file=sys.stderr)

856 sys.exit(1)

~~857~~

858tool_name = input_data.get("tool_name", "")

859tool_input = input_data.get("tool_input", {})

860command = tool_input.get("command", "")

~~861~~

862if tool_name != "Bash" or not command:

863 sys.exit(1)

~~864~~

865# Validate the command

866issues = validate_command(command)

~~867~~

868if issues:

869 for message in issues:

870 print(f"• {message}", file=sys.stderr)

871 # Exit code 2 blocks tool call and shows stderr to Claude

872 sys.exit(2)

873```

874 1978

875#### JSON Output Example: UserPromptSubmit to Add Context and Validation1979Agent-based hooks (`type: "agent"`) are like prompt-based hooks but with multi-turn tool access. Instead of a single LLM call, an agent hook spawns a subagent that can read files, search code, and inspect the codebase to verify conditions. Agent hooks support the same events as prompt-based hooks.

876 1980

877<Note>1981### How agent hooks work

878 For `UserPromptSubmit` hooks, you can inject context using either method:

879 1982

880 * **Plain text stdout** with exit code 0: Simplest approach—just print text1983When an agent hook fires:

881 * **JSON output** with exit code 0: Use `"decision": "block"` to reject prompts,

882 or `additionalContext` for structured context injection

883 1984

884 Remember: Exit code 2 only uses `stderr` for the error message. To block using19851. Claude Code spawns a subagent with your prompt and the hook's JSON input

885 JSON (with a custom reason), use `"decision": "block"` with exit code 0.19862. The subagent can use tools like Read, Grep, and Glob to investigate

886</Note>19873. After up to 50 turns, the subagent returns a structured `{ "ok": true/false }` decision

19884. Claude Code processes the decision the same way as a prompt hook

887 1989

888```python theme={null}1990Agent hooks are useful when verification requires inspecting actual files or test output, not just evaluating the hook input data alone.

889#!/usr/bin/env python3

890import json

891import sys

892import re

893import datetime

~~894~~

895# Load input from stdin

896try:

897 input_data = json.load(sys.stdin)

898except json.JSONDecodeError as e:

899 print(f"Error: Invalid JSON input: {e}", file=sys.stderr)

900 sys.exit(1)

~~901~~

902prompt = input_data.get("prompt", "")

~~903~~

904# Check for sensitive patterns

905sensitive_patterns = [

906 (r"(?i)\b(password|secret|key|token)\s*[:=]", "Prompt contains potential secrets"),

907]

~~908~~

909for pattern, message in sensitive_patterns:

910 if re.search(pattern, prompt):

911 # Use JSON output to block with a specific reason

912 output = {

913 "decision": "block",

914 "reason": f"Security policy violation: {message}. Please rephrase your request without sensitive information."

915 }

916 print(json.dumps(output))

917 sys.exit(0)

918 1991

919# Add current time to context1992### Agent hook configuration

920context = f"Current time: {datetime.datetime.now()}"

921print(context)

922 1993

923"""1994Set `type` to `"agent"` and provide a `prompt` string. The configuration fields are the same as [prompt hooks](#prompt-hook-configuration), with a longer default timeout:

924The following is also equivalent:

925print(json.dumps({

926 "hookSpecificOutput": {

927 "hookEventName": "UserPromptSubmit",

928 "additionalContext": context,

929 },

930}))

931"""

932 1995

933# Allow the prompt to proceed with the additional context1996| Field | Required | Description |

934sys.exit(0)1997| :-------- | :------- | :------------------------------------------------------------------------------------------ |

935```1998| `type` | yes | Must be `"agent"` |

1999| `prompt` | yes | Prompt describing what to verify. Use `$ARGUMENTS` as a placeholder for the hook input JSON |

2000| `model` | no | Model to use. Defaults to a fast model |

2001| `timeout` | no | Timeout in seconds. Default: 60 |

936 2002

937#### JSON Output Example: PreToolUse with Approval2003The response schema is the same as prompt hooks: `{ "ok": true }` to allow or `{ "ok": false, "reason": "..." }` to block.

~~938~~

939```python theme={null}

940#!/usr/bin/env python3

941import json

942import sys

~~943~~

944# Load input from stdin

945try:

946 input_data = json.load(sys.stdin)

947except json.JSONDecodeError as e:

948 print(f"Error: Invalid JSON input: {e}", file=sys.stderr)

949 sys.exit(1)

~~950~~

951tool_name = input_data.get("tool_name", "")

952tool_input = input_data.get("tool_input", {})

~~953~~

954# Example: Auto-approve file reads for documentation files

955if tool_name == "Read":

956 file_path = tool_input.get("file_path", "")

957 if file_path.endswith((".md", ".mdx", ".txt", ".json")):

958 # Use JSON output to auto-approve the tool call

959 output = {

960 "decision": "approve",

961 "reason": "Documentation file auto-approved",

962 "suppressOutput": True # Don't show in verbose mode

963 }

964 print(json.dumps(output))

965 sys.exit(0)

~~966~~

967# For other cases, let the normal permission flow proceed

968sys.exit(0)

969```

970 2004

971## Working with MCP Tools2005This `Stop` hook verifies that all unit tests pass before allowing Claude to finish:

972 2006

973Claude Code hooks work seamlessly with2007```json theme={null}

974[Model Context Protocol (MCP) tools](/en/mcp). When MCP servers2008{

975provide tools, they appear with a special naming pattern that you can match in2009 "hooks": {

976your hooks.2010 "Stop": [

2011 {

2012 "hooks": [

2013 {

2014 "type": "agent",

2015 "prompt": "Verify that all unit tests pass. Run the test suite and check the results. $ARGUMENTS",

2016 "timeout": 120

2017 }

2018 ]

2019 }

2020 ]

2021 }

2022}

2023```

977 2024

978### MCP Tool Naming2025## Run hooks in the background

979 2026

980MCP tools follow the pattern `mcp__<server>__<tool>`, for example:2027By default, hooks block Claude's execution until they complete. For long-running tasks like deployments, test suites, or external API calls, set `"async": true` to run the hook in the background while Claude continues working. Async hooks cannot block or control Claude's behavior: response fields like `decision`, `permissionDecision`, and `continue` have no effect, because the action they would have controlled has already completed.

981 2028

982* `mcp__memory__create_entities` - Memory server's create entities tool2029### Configure an async hook

983* `mcp__filesystem__read_file` - Filesystem server's read file tool

984* `mcp__github__search_repositories` - GitHub server's search tool

985 2030

986### Configuring Hooks for MCP Tools2031Add `"async": true` to a command hook's configuration to run it in the background without blocking Claude. This field is only available on `type: "command"` hooks.

987 2032

988You can target specific MCP tools or entire MCP servers:2033This hook runs a test script after every `Write` tool call. Claude continues working immediately while `run-tests.sh` executes for up to 120 seconds. When the script finishes, its output is delivered on the next conversation turn:

989 2034

990```json theme={null}2035```json theme={null}

991{2036{

992 "hooks": {2037 "hooks": {

993 "PreToolUse": [2038 "PostToolUse": [

994 {

995 "matcher": "mcp__memory__.*",

996 "hooks": [

997 {

998 "type": "command",

999 "command": "echo 'Memory operation initiated' >> ~/mcp-operations.log"

1000 }

1001 ]

1002 },

1003 {2039 {

1004 "matcher": "mcp__.*__write.*",2040 "matcher": "Write",

1005 "hooks": [2041 "hooks": [

1006 {2042 {

1007 "type": "command",2043 "type": "command",

1008 "command": "/home/user/scripts/validate-mcp-write.py"2044 "command": "/path/to/run-tests.sh",

2045 "async": true,

2046 "timeout": 120

1009 }2047 }

1010 ]2048 ]

1011 }2049 }

1014}2052}

1015```2053```

1016 2054

1017## Examples2055The `timeout` field sets the maximum time in seconds for the background process. If not specified, async hooks use the same 10-minute default as sync hooks.

~~1018~~

1019<Tip>

1020 For practical examples including code formatting, notifications, and file protection, see [More Examples](/en/hooks-guide#more-examples) in the get started guide.

1021</Tip>

1022 2056

1023## Security Considerations2057### How async hooks execute

1024 2058

1025### Disclaimer2059When an async hook fires, Claude Code starts the hook process and immediately continues without waiting for it to finish. The hook receives the same JSON input via stdin as a synchronous hook.

1026 2060

1027**USE AT YOUR OWN RISK**: Claude Code hooks execute arbitrary shell commands on2061After the background process exits, if the hook produced a JSON response with a `systemMessage` or `additionalContext` field, that content is delivered to Claude as context on the next conversation turn.

1028your system automatically. By using hooks, you acknowledge that:

1029 2062

1030* You are solely responsible for the commands you configure2063Async hook completion notifications are suppressed by default. To see them, enable verbose mode with `Ctrl+O` or start Claude Code with `--verbose`.

1031* Hooks can modify, delete, or access any files your user account can access

1032* Malicious or poorly written hooks can cause data loss or system damage

1033* Anthropic provides no warranty and assumes no liability for any damages

1034 resulting from hook usage

1035* You should thoroughly test hooks in a safe environment before production use

1036 2064

1037Always review and understand any hook commands before adding them to your2065### Example: run tests after file changes

1038configuration.

1039 2066

1040### Security Best Practices2067This hook starts a test suite in the background whenever Claude writes a file, then reports the results back to Claude when the tests finish. Save this script to `.claude/hooks/run-tests-async.sh` in your project and make it executable with `chmod +x`:

1041 2068

1042Here are some key practices for writing more secure hooks:2069```bash theme={null}

2070#!/bin/bash

2071# run-tests-async.sh

1043 2072

10441. **Validate and sanitize inputs** - Never trust input data blindly2073# Read hook input from stdin

10452. **Always quote shell variables** - Use `"$VAR"` not `$VAR`2074INPUT=$(cat)

10463. **Block path traversal** - Check for `..` in file paths2075FILE_PATH=$(echo "$INPUT" | jq -r '.tool_input.file_path // empty')

10474. **Use absolute paths** - Specify full paths for scripts (use

1048 "\$CLAUDE\_PROJECT\_DIR" for the project path)

10495. **Skip sensitive files** - Avoid `.env`, `.git/`, keys, etc.

1050 2076

1051### Configuration Safety2077# Only run tests for source files

2078if [[ "$FILE_PATH" != *.ts && "$FILE_PATH" != *.js ]]; then

2079 exit 0

2080fi

1052 2081

1053Direct edits to hooks in settings files don't take effect immediately. Claude2082# Run tests and report results via systemMessage

1054Code:2083RESULT=$(npm test 2>&1)

2084EXIT_CODE=$?

1055 2085

10561. Captures a snapshot of hooks at startup2086if [ $EXIT_CODE -eq 0 ]; then

10572. Uses this snapshot throughout the session2087 echo "{\"systemMessage\": \"Tests passed after editing $FILE_PATH\"}"

10583. Warns if hooks are modified externally2088else

10594. Requires review in `/hooks` menu for changes to apply2089 echo "{\"systemMessage\": \"Tests failed after editing $FILE_PATH: $RESULT\"}"

2090fi

2091```

1060 2092

1061This prevents malicious hook modifications from affecting your current session.2093Then add this configuration to `.claude/settings.json` in your project root. The `async: true` flag lets Claude keep working while tests run:

1062 2094

1063## Hook Execution Details2095```json theme={null}

2096{

2097 "hooks": {

2098 "PostToolUse": [

2099 {

2100 "matcher": "Write|Edit",

2101 "hooks": [

2102 {

2103 "type": "command",

2104 "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/run-tests-async.sh",

2105 "async": true,

2106 "timeout": 300

2107 }

2108 ]

2109 }

2110 ]

2111 }

2112}

2113```

1064 2114

1065* **Timeout**: 60-second execution limit by default, configurable per command.2115### Limitations

1066 * A timeout for an individual command does not affect the other commands.

1067* **Parallelization**: All matching hooks run in parallel

1068* **Deduplication**: Multiple identical hook commands are deduplicated automatically

1069* **Environment**: Runs in current directory with Claude Code's environment

1070 * The `CLAUDE_PROJECT_DIR` environment variable is available and contains the

1071 absolute path to the project root directory (where Claude Code was started)

1072 * The `CLAUDE_CODE_REMOTE` environment variable indicates whether the hook is running in a remote (web) environment (`"true"`) or local CLI environment (not set or empty). Use this to run different logic based on execution context.

1073* **Input**: JSON via stdin

1074* **Output**:

1075 * PreToolUse/PermissionRequest/PostToolUse/Stop/SubagentStop: Progress shown in verbose mode (ctrl+o)

1076 * Notification/SessionEnd: Logged to debug only (`--debug`)

1077 * UserPromptSubmit/SessionStart: stdout added as context for Claude

1078 2116

1079## Debugging2117Async hooks have several constraints compared to synchronous hooks:

1080 2118

1081### Basic Troubleshooting2119* Only `type: "command"` hooks support `async`. Prompt-based hooks cannot run asynchronously.

2120* Async hooks cannot block tool calls or return decisions. By the time the hook completes, the triggering action has already proceeded.

2121* Hook output is delivered on the next conversation turn. If the session is idle, the response waits until the next user interaction.

2122* Each execution creates a separate background process. There is no deduplication across multiple firings of the same async hook.

1082 2123

1083If your hooks aren't working:2124## Security considerations

1084 2125

10851. **Check configuration** - Run `/hooks` to see if your hook is registered2126### Disclaimer

10862. **Verify syntax** - Ensure your JSON settings are valid

10873. **Test commands** - Run hook commands manually first

10884. **Check permissions** - Make sure scripts are executable

10895. **Review logs** - Use `claude --debug` to see hook execution details

1090 2127

1091Common issues:2128Command hooks run with your system user's full permissions.

1092 2129

1093* **Quotes not escaped** - Use `\"` inside JSON strings2130<Warning>

1094* **Wrong matcher** - Check tool names match exactly (case-sensitive)2131 Command hooks execute shell commands with your full user permissions. They can modify, delete, or access any files your user account can access. Review and test all hook commands before adding them to your configuration.

1095* **Command not found** - Use full paths for scripts2132</Warning>

1096 2133

1097### Advanced Debugging2134### Security best practices

1098 2135

1099For complex hook issues:2136Keep these practices in mind when writing hooks:

1100 2137

11011. **Inspect hook execution** - Use `claude --debug` to see detailed hook2138* **Validate and sanitize inputs**: never trust input data blindly

1102 execution2139* **Always quote shell variables**: use `"$VAR"` not `$VAR`

11032. **Validate JSON schemas** - Test hook input/output with external tools2140* **Block path traversal**: check for `..` in file paths

11043. **Check environment variables** - Verify Claude Code's environment is correct2141* **Use absolute paths**: specify full paths for scripts, using `"$CLAUDE_PROJECT_DIR"` for the project root

11054. **Test edge cases** - Try hooks with unusual file paths or inputs2142* **Skip sensitive files**: avoid `.env`, `.git/`, keys, etc.

11065. **Monitor system resources** - Check for resource exhaustion during hook

1107 execution

11086. **Use structured logging** - Implement logging in your hook scripts

1109 2143

1110### Debug Output Example2144## Debug hooks

1111 2145

1112Use `claude --debug` to see hook execution details:2146Run `claude --debug` to see hook execution details, including which hooks matched, their exit codes, and output. Toggle verbose mode with `Ctrl+O` to see hook progress in the transcript.

1113 2147

1114```2148```text theme={null}

1115[DEBUG] Executing hooks for PostToolUse:Write2149[DEBUG] Executing hooks for PostToolUse:Write

1116[DEBUG] Getting matching hook commands for PostToolUse with query: Write2150[DEBUG] Getting matching hook commands for PostToolUse with query: Write

1117[DEBUG] Found 1 hook matchers in settings2151[DEBUG] Found 1 hook matchers in settings

1118[DEBUG] Matched 1 hooks for query "Write"2152[DEBUG] Matched 1 hooks for query "Write"

1119[DEBUG] Found 1 hook commands to execute2153[DEBUG] Found 1 hook commands to execute

1120[DEBUG] Executing hook command: <Your command> with timeout 60000ms2154[DEBUG] Executing hook command: <Your command> with timeout 600000ms

1121[DEBUG] Hook command completed with status 0: <Your stdout>2155[DEBUG] Hook command completed with status 0: <Your stdout>

1122```2156```

1123 2157

1124Progress messages appear in verbose mode (ctrl+o) showing:2158For troubleshooting common issues like hooks not firing, infinite Stop hook loops, or configuration errors, see [Limitations and troubleshooting](/en/hooks-guide#limitations-and-troubleshooting) in the guide.

~~1125~~

1126* Which hook is running

1127* Command being executed

1128* Success/failure status

1129* Output or error messages

hooks-guide.md +670 −201

Details

~~1# Get started with Claude Code hooks~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Learn how to customize and extend Claude Code's behavior by registering shell commands~~5# Automate workflows with hooks

4 6

~~5Claude Code hooks are user-defined shell commands that execute at various points~~7> Run shell commands automatically when Claude Code edits files, finishes tasks, or needs input. Format code, send notifications, validate commands, and enforce project rules.

~~6in Claude Code's lifecycle. Hooks provide deterministic control over Claude~~8

~~7Code's behavior, ensuring certain actions always happen rather than relying on~~9Hooks are user-defined shell commands that execute at specific points in Claude Code's lifecycle. They provide deterministic control over Claude Code's behavior, ensuring certain actions always happen rather than relying on the LLM to choose to run them. Use hooks to enforce project rules, automate repetitive tasks, and integrate Claude Code with your existing tools.

~~8the LLM to choose to run them.~~10

11For decisions that require judgment rather than deterministic rules, you can also use [prompt-based hooks](#prompt-based-hooks) or [agent-based hooks](#agent-based-hooks) that use a Claude model to evaluate conditions.

13For other ways to extend Claude Code, see [skills](/en/skills) for giving Claude additional instructions and executable commands, [subagents](/en/sub-agents) for running tasks in isolated contexts, and [plugins](/en/plugins) for packaging extensions to share across projects.

9 14

10<Tip>15<Tip>

~~11 For reference documentation on hooks, see [Hooks reference](/en/hooks).~~16 This guide covers common use cases and how to get started. For full event schemas, JSON input/output formats, and advanced features like async hooks and MCP tool hooks, see the [Hooks reference](/en/hooks).

12</Tip>17</Tip>

13 18

~~14Example use cases for hooks include:~~19## Set up your first hook

15 20

~~16* **Notifications**: Customize how you get notified when Claude Code is awaiting~~21To create a hook, add a `hooks` block to a [settings file](#configure-hook-location). This walkthrough creates a desktop notification hook, so you get alerted whenever Claude is waiting for your input instead of watching the terminal.

~~17 your input or permission to run something.~~

~~18* **Automatic formatting**: Run `prettier` on .ts files, `gofmt` on .go files,~~

~~19 etc. after every file edit.~~

~~20* **Logging**: Track and count all executed commands for compliance or~~

~~21 debugging.~~

~~22* **Feedback**: Provide automated feedback when Claude Code produces code that~~

~~23 does not follow your codebase conventions.~~

~~24* **Custom permissions**: Block modifications to production files or sensitive~~

~~25 directories.~~

26 22

~~27By encoding these rules as hooks rather than prompting instructions, you turn~~23<Steps>

~~28suggestions into app-level code that executes every time it is expected to run.~~24 <Step title="Add the hook to your settings">

25 Open `~/.claude/settings.json` and add a `Notification` hook. The example below uses `osascript` for macOS; see [Get notified when Claude needs input](#get-notified-when-claude-needs-input) for Linux and Windows commands.

29 26

~~30<Warning>~~27 ```json theme={null}

~~31 You must consider the security implication of hooks as you add them, because hooks run automatically during the agent loop with your current environment's credentials.~~28 {

~~32 For example, malicious hooks code can exfiltrate your data. Always review your hooks implementation before registering them.~~29 "hooks": {

33 30 "Notification": [

~~34 For full security best practices, see [Security Considerations](/en/hooks#security-considerations) in the hooks reference documentation.~~31 {

~~35</Warning>~~32 "matcher": "",

33 "hooks": [

34 {

35 "type": "command",

36 "command": "osascript -e 'display notification \"Claude Code needs your attention\" with title \"Claude Code\"'"

37 }

38 ]

39 }

40 ]

41 }

42 }

43 ```

36 44

~~37## Hook Events Overview~~45 If your settings file already has a `hooks` key, merge the `Notification` entry into it rather than replacing the whole object. You can also ask Claude to write the hook for you by describing what you want in the CLI.

46 </Step>

38 47

~~39Claude Code provides several hook events that run at different points in the~~48 <Step title="Verify the configuration">

~~40workflow:~~49 Type `/hooks` to open the hooks browser. You'll see a list of all available hook events, with a count next to each event that has hooks configured. Select `Notification` to confirm your new hook appears in the list. Selecting the hook shows its details: the event, matcher, type, source file, and command.

50 </Step>

41 51

~~42* **PreToolUse**: Runs before tool calls (can block them)~~52 <Step title="Test the hook">

~~43* **PermissionRequest**: Runs when a permission dialog is shown (can allow or deny)~~53 Press `Esc` to return to the CLI. Ask Claude to do something that requires permission, then switch away from the terminal. You should receive a desktop notification.

~~44* **PostToolUse**: Runs after tool calls complete~~54 </Step>

~~45* **UserPromptSubmit**: Runs when the user submits a prompt, before Claude processes it~~55</Steps>

~~46* **Notification**: Runs when Claude Code sends notifications~~

~~47* **Stop**: Runs when Claude Code finishes responding~~

~~48* **SubagentStop**: Runs when subagent tasks complete~~

~~49* **PreCompact**: Runs before Claude Code is about to run a compact operation~~

~~50* **SessionStart**: Runs when Claude Code starts a new session or resumes an existing session~~

~~51* **SessionEnd**: Runs when Claude Code session ends~~

52 56

~~53Each event receives different data and can control Claude's behavior in~~57<Tip>

~~54different ways.~~58 The `/hooks` menu is read-only. To add, modify, or remove hooks, edit your settings JSON directly or ask Claude to make the change.

59</Tip>

55 60

~~56## Quickstart~~61## What you can automate

57 62

~~58In this quickstart, you'll add a hook that logs the shell commands that Claude~~63Hooks let you run code at key points in Claude Code's lifecycle: format files after edits, block commands before they execute, send notifications when Claude needs input, inject context at session start, and more. For the full list of hook events, see the [Hooks reference](/en/hooks#hook-lifecycle).

~~59Code runs.~~

60 64

~~61### Prerequisites~~65Each example includes a ready-to-use configuration block that you add to a [settings file](#configure-hook-location). The most common patterns:

62 66

~~63Install `jq` for JSON processing in the command line.~~67* [Get notified when Claude needs input](#get-notified-when-claude-needs-input)

68* [Auto-format code after edits](#auto-format-code-after-edits)

69* [Block edits to protected files](#block-edits-to-protected-files)

70* [Re-inject context after compaction](#re-inject-context-after-compaction)

71* [Audit configuration changes](#audit-configuration-changes)

72* [Reload environment when directory or files change](#reload-environment-when-directory-or-files-change)

73* [Auto-approve specific permission prompts](#auto-approve-specific-permission-prompts)

64 74

~~65### Step 1: Open hooks configuration~~75### Get notified when Claude needs input

66 76

~~67Run the `/hooks` [slash command](/en/slash-commands) and select~~77Get a desktop notification whenever Claude finishes working and needs your input, so you can switch to other tasks without checking the terminal.

~~68the `PreToolUse` hook event.~~

69 78

~~70`PreToolUse` hooks run before tool calls and can block them while providing~~79This hook uses the `Notification` event, which fires when Claude is waiting for input or permission. Each tab below uses the platform's native notification command. Add this to `~/.claude/settings.json`:

~~71Claude feedback on what to do differently.~~

72 80

~~73### Step 2: Add a matcher~~81<Tabs>

82 <Tab title="macOS">

83 ```json theme={null}

84 {

85 "hooks": {

86 "Notification": [

87 {

88 "matcher": "",

89 "hooks": [

90 {

91 "type": "command",

92 "command": "osascript -e 'display notification \"Claude Code needs your attention\" with title \"Claude Code\"'"

93 }

94 ]

95 }

96 ]

97 }

98 }

99 ```

100 </Tab>

74 101

~~75Select `+ Add new matcher…` to run your hook only on Bash tool calls.~~102 <Tab title="Linux">

103 ```json theme={null}

104 {

105 "hooks": {

106 "Notification": [

107 {

108 "matcher": "",

109 "hooks": [

110 {

111 "type": "command",

112 "command": "notify-send 'Claude Code' 'Claude Code needs your attention'"

113 }

114 ]

115 }

116 ]

117 }

118 }

119 ```

120 </Tab>

76 121

~~77Type `Bash` for the matcher.~~122 <Tab title="Windows (PowerShell)">

123 ```json theme={null}

124 {

125 "hooks": {

126 "Notification": [

127 {

128 "matcher": "",

129 "hooks": [

130 {

131 "type": "command",

132 "command": "powershell.exe -Command \"[System.Reflection.Assembly]::LoadWithPartialName('System.Windows.Forms'); [System.Windows.Forms.MessageBox]::Show('Claude Code needs your attention', 'Claude Code')\""

133 }

134 ]

135 }

136 ]

137 }

138 }

139 ```

140 </Tab>

141</Tabs>

78 142

~~79<Note>You can use `*` to match all tools.</Note>~~143### Auto-format code after edits

80 144

~~81### Step 3: Add the hook~~145Automatically run [Prettier](https://prettier.io/) on every file Claude edits, so formatting stays consistent without manual intervention.

82 146

~~83Select `+ Add new hook…` and enter this command:~~147This hook uses the `PostToolUse` event with an `Edit|Write` matcher, so it runs only after file-editing tools. The command extracts the edited file path with [`jq`](https://jqlang.github.io/jq/) and passes it to Prettier. Add this to `.claude/settings.json` in your project root:

84 148

~~85```bash theme={null}~~149```json theme={null}

~~86jq -r '"\(.tool_input.command) - \(.tool_input.description // "No description")"' >> ~/.claude/bash-command-log.txt~~150{

151 "hooks": {

152 "PostToolUse": [

153 {

154 "matcher": "Edit|Write",

155 "hooks": [

156 {

157 "type": "command",

158 "command": "jq -r '.tool_input.file_path' | xargs npx prettier --write"

159 }

160 ]

161 }

162 ]

163 }

164}

87```165```

88 166

~~89### Step 4: Save your configuration~~167<Note>

168 The Bash examples on this page use `jq` for JSON parsing. Install it with `brew install jq` (macOS), `apt-get install jq` (Debian/Ubuntu), or see [`jq` downloads](https://jqlang.github.io/jq/download/).

169</Note>

170

171### Block edits to protected files

172

173Prevent Claude from modifying sensitive files like `.env`, `package-lock.json`, or anything in `.git/`. Claude receives feedback explaining why the edit was blocked, so it can adjust its approach.

174

175This example uses a separate script file that the hook calls. The script checks the target file path against a list of protected patterns and exits with code 2 to block the edit.

176

177<Steps>

178 <Step title="Create the hook script">

179 Save this to `.claude/hooks/protect-files.sh`:

180

181 ```bash theme={null}

182 #!/bin/bash

183 # protect-files.sh

184

185 INPUT=$(cat)

186 FILE_PATH=$(echo "$INPUT" | jq -r '.tool_input.file_path // empty')

187

188 PROTECTED_PATTERNS=(".env" "package-lock.json" ".git/")

189

190 for pattern in "${PROTECTED_PATTERNS[@]}"; do

191 if [[ "$FILE_PATH" == *"$pattern"* ]]; then

192 echo "Blocked: $FILE_PATH matches protected pattern '$pattern'" >&2

193 exit 2

194 fi

195 done

196

197 exit 0

198 ```

199 </Step>

200

201 <Step title="Make the script executable (macOS/Linux)">

202 Hook scripts must be executable for Claude Code to run them:

90 203

~~91For storage location, select `User settings` since you're logging to your home~~204 ```bash theme={null}

~~92directory. This hook will then apply to all projects, not just your current~~205 chmod +x .claude/hooks/protect-files.sh

~~93project.~~206 ```

207 </Step>

208

209 <Step title="Register the hook">

210 Add a `PreToolUse` hook to `.claude/settings.json` that runs the script before any `Edit` or `Write` tool call:

211

212 ```json theme={null}

213 {

214 "hooks": {

215 "PreToolUse": [

216 {

217 "matcher": "Edit|Write",

218 "hooks": [

219 {

220 "type": "command",

221 "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/protect-files.sh"

222 }

223 ]

224 }

225 ]

226 }

227 }

228 ```

229 </Step>

230</Steps>

94 231

~~95Then press Esc until you return to the REPL. Your hook is now registered!~~232### Re-inject context after compaction

96 233

~~97### Step 5: Verify your hook~~234When Claude's context window fills up, compaction summarizes the conversation to free space. This can lose important details. Use a `SessionStart` hook with a `compact` matcher to re-inject critical context after every compaction.

98 235

~~99Run `/hooks` again or check `~/.claude/settings.json` to see your configuration:~~236Any text your command writes to stdout is added to Claude's context. This example reminds Claude of project conventions and recent work. Add this to `.claude/settings.json` in your project root:

100 237

101```json theme={null}238```json theme={null}

102{239{

103 "hooks": {240 "hooks": {

104 "PreToolUse": [241 "SessionStart": [

105 {242 {

106 "matcher": "Bash",243 "matcher": "compact",

107 "hooks": [244 "hooks": [

108 {245 {

109 "type": "command",246 "type": "command",

110 "command": "jq -r '\"\\(.tool_input.command) - \\(.tool_input.description // \"No description\")\"' >> ~/.claude/bash-command-log.txt"247 "command": "echo 'Reminder: use Bun, not npm. Run bun test before committing. Current sprint: auth refactor.'"

111 }248 }

112 ]249 ]

113 }250 }

116}253}

117```254```

118 255

119### Step 6: Test your hook256You can replace the `echo` with any command that produces dynamic output, like `git log --oneline -5` to show recent commits. For injecting context on every session start, consider using [CLAUDE.md](/en/memory) instead. For environment variables, see [`CLAUDE_ENV_FILE`](/en/hooks#persist-environment-variables) in the reference.

120 257

121Ask Claude to run a simple command like `ls` and check your log file:258### Audit configuration changes

122 259

123```bash theme={null}260Track when settings or skills files change during a session. The `ConfigChange` event fires when an external process or editor modifies a configuration file, so you can log changes for compliance or block unauthorized modifications.

124cat ~/.claude/bash-command-log.txt

125```

126 261

127You should see entries like:262This example appends each change to an audit log. Add this to `~/.claude/settings.json`:

128 263

129```264```json theme={null}

130ls - Lists files and directories265{

266 "hooks": {

267 "ConfigChange": [

268 {

269 "matcher": "",

270 "hooks": [

271 {

272 "type": "command",

273 "command": "jq -c '{timestamp: now | todate, source: .source, file: .file_path}' >> ~/claude-config-audit.log"

274 }

275 ]

276 }

277 ]

278 }

279}

131```280```

132 281

133## More Examples282The matcher filters by configuration type: `user_settings`, `project_settings`, `local_settings`, `policy_settings`, or `skills`. To block a change from taking effect, exit with code 2 or return `{"decision": "block"}`. See the [ConfigChange reference](/en/hooks#configchange) for the full input schema.

134 283

135<Note>284### Reload environment when directory or files change

136 For a complete example implementation, see the [bash command validator example](https://github.com/anthropics/claude-code/blob/main/examples/hooks/bash_command_validator_example.py) in our public codebase.

137</Note>

138 285

139### Code Formatting Hook286Some projects set different environment variables depending on which directory you are in. Tools like [direnv](https://direnv.net/) do this automatically in your shell, but Claude's Bash tool does not pick up those changes on its own.

140 287

141Automatically format TypeScript files after editing:288A `CwdChanged` hook fixes this: it runs each time Claude changes directory, so you can reload the correct variables for the new location. The hook writes the updated values to `CLAUDE_ENV_FILE`, which Claude Code applies before each Bash command. Add this to `~/.claude/settings.json`:

142 289

143```json theme={null}290```json theme={null}

144{291{

145 "hooks": {292 "hooks": {

146 "PostToolUse": [293 "CwdChanged": [

147 {294 {

148 "matcher": "Edit|Write",

149 "hooks": [295 "hooks": [

150 {296 {

151 "type": "command",297 "type": "command",

152 "command": "jq -r '.tool_input.file_path' | { read file_path; if echo \"$file_path\" | grep -q '\\.ts$'; then npx prettier --write \"$file_path\"; fi; }"298 "command": "direnv export bash >> \"$CLAUDE_ENV_FILE\""

299 }

300 ]

301 }

302 ]

303 }

304}

305```

306

307To react to specific files instead of every directory change, use `FileChanged` with a `matcher` listing the filenames to watch (pipe-separated). The `matcher` both configures which files to watch and filters which hooks run. This example watches `.envrc` and `.env` for changes in the current directory:

308

309```json theme={null}

310{

311 "hooks": {

312 "FileChanged": [

313 {

314 "matcher": ".envrc|.env",

315 "hooks": [

316 {

317 "type": "command",

318 "command": "direnv export bash >> \"$CLAUDE_ENV_FILE\""

153 }319 }

154 ]320 ]

155 }321 }

158}324}

159```325```

160 326

161### Markdown Formatting Hook327See the [CwdChanged](/en/hooks#cwdchanged) and [FileChanged](/en/hooks#filechanged) reference entries for input schemas, `watchPaths` output, and `CLAUDE_ENV_FILE` details.

162 328

163Automatically fix missing language tags and formatting issues in markdown files:329### Auto-approve specific permission prompts

330

331Skip the approval dialog for tool calls you always allow. This example auto-approves `ExitPlanMode`, the tool Claude calls when it finishes presenting a plan and asks to proceed, so you aren't prompted every time a plan is ready.

332

333Unlike the exit-code examples above, auto-approval requires your hook to write a JSON decision to stdout. A `PermissionRequest` hook fires when Claude Code is about to show a permission dialog, and returning `"behavior": "allow"` answers it on your behalf.

334

335The matcher scopes the hook to `ExitPlanMode` only, so no other prompts are affected. Add this to `~/.claude/settings.json`:

164 336

165```json theme={null}337```json theme={null}

166{338{

167 "hooks": {339 "hooks": {

168 "PostToolUse": [340 "PermissionRequest": [

169 {341 {

170 "matcher": "Edit|Write",342 "matcher": "ExitPlanMode",

171 "hooks": [343 "hooks": [

172 {344 {

173 "type": "command",345 "type": "command",

174 "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/markdown_formatter.py"346 "command": "echo '{\"hookSpecificOutput\": {\"hookEventName\": \"PermissionRequest\", \"decision\": {\"behavior\": \"allow\"}}}'"

175 }347 }

176 ]348 ]

177 }349 }

180}352}

181```353```

182 354

183Create `.claude/hooks/markdown_formatter.py` with this content:355When the hook approves, Claude Code exits plan mode and restores whatever permission mode was active before you entered plan mode. The transcript shows "Allowed by PermissionRequest hook" where the dialog would have appeared. The hook path always keeps the current conversation: it cannot clear context and start a fresh implementation session the way the dialog can.

~~184~~ 356

185````python theme={null}357To set a specific permission mode instead, your hook's output can include an `updatedPermissions` array with a `setMode` entry. The `mode` value is any permission mode like `default`, `acceptEdits`, or `bypassPermissions`, and `destination: "session"` applies it for the current session only.

186#!/usr/bin/env python3358

187"""359To switch the session to `acceptEdits`, your hook writes this JSON to stdout:

188Markdown formatter for Claude Code output.360

189Fixes missing language tags and spacing issues while preserving code content.361```json theme={null}

190"""362{

191import json363 "hookSpecificOutput": {

192import sys364 "hookEventName": "PermissionRequest",

193import re365 "decision": {

194import os366 "behavior": "allow",

~~195~~ 367 "updatedPermissions": [

196def detect_language(code):368 { "type": "setMode", "mode": "acceptEdits", "destination": "session" }

197 """Best-effort language detection from code content."""369 ]

198 s = code.strip()370 }

~~199~~ 371 }

200 # JSON detection372}

201 if re.search(r'^\s*[{\[]', s):373```

202 try:374

203 json.loads(s)375Keep the matcher as narrow as possible. Matching on `.*` or leaving the matcher empty would auto-approve every permission prompt, including file writes and shell commands. See the [PermissionRequest reference](/en/hooks#permissionrequest-decision-control) for the full set of decision fields.

204 return 'json'376

205 except:377## How hooks work

206 pass378

~~207~~ 379Hook events fire at specific lifecycle points in Claude Code. When an event fires, all matching hooks run in parallel, and identical hook commands are automatically deduplicated. The table below shows each event and when it triggers:

208 # Python detection380

209 if re.search(r'^\s*def\s+\w+\s*\(', s, re.M) or \381| Event | When it fires |

210 re.search(r'^\s*(import|from)\s+\w+', s, re.M):382| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |

211 return 'python'383| `SessionStart` | When a session begins or resumes |

~~212~~ 384| `UserPromptSubmit` | When you submit a prompt, before Claude processes it |

213 # JavaScript detection 385| `PreToolUse` | Before a tool call executes. Can block it |

214 if re.search(r'\b(function\s+\w+\s*\(|const\s+\w+\s*=)', s) or \386| `PermissionRequest` | When a permission dialog appears |

216 return 'javascript'388| `PostToolUseFailure` | After a tool call fails |

~~217~~ 389| `Notification` | When Claude Code sends a notification |

218 # Bash detection390| `SubagentStart` | When a subagent is spawned |

219 if re.search(r'^#!.*\b(bash|sh)\b', s, re.M) or \391| `SubagentStop` | When a subagent finishes |

220 re.search(r'\b(if|then|fi|for|in|do|done)\b', s):392| `Stop` | When Claude finishes responding |

221 return 'bash'393| `StopFailure` | When the turn ends due to an API error. Output and exit code are ignored |

~~222~~ 394| `TeammateIdle` | When an [agent team](/en/agent-teams) teammate is about to go idle |

223 # SQL detection395| `TaskCompleted` | When a task is being marked as completed |

224 if re.search(r'\b(SELECT|INSERT|UPDATE|DELETE|CREATE)\s+', s, re.I):396| `InstructionsLoaded` | When a CLAUDE.md or `.claude/rules/*.md` file is loaded into context. Fires at session start and when files are lazily loaded during a session |

225 return 'sql'397| `ConfigChange` | When a configuration file changes during a session |

~~226~~ 398| `CwdChanged` | When the working directory changes, for example when Claude executes a `cd` command. Useful for reactive environment management with tools like direnv |

227 return 'text'399| `FileChanged` | When a watched file changes on disk. The `matcher` field specifies which filenames to watch |

~~228~~ 400| `WorktreeCreate` | When a worktree is being created via `--worktree` or `isolation: "worktree"`. Replaces default git behavior |

229def format_markdown(content):401| `WorktreeRemove` | When a worktree is being removed, either at session exit or when a subagent finishes |

230 """Format markdown content with language detection."""402| `PreCompact` | Before context compaction |

231 # Fix unlabeled code fences403| `PostCompact` | After context compaction completes |

232 def add_lang_to_fence(match):404| `Elicitation` | When an MCP server requests user input during a tool call |

233 indent, info, body, closing = match.groups()405| `ElicitationResult` | After a user responds to an MCP elicitation, before the response is sent back to the server |

234 if not info.strip():406| `SessionEnd` | When a session terminates |

235 lang = detect_language(body)407

236 return f"{indent}```{lang}\n{body}{closing}\n"408Each hook has a `type` that determines how it runs. Most hooks use `"type": "command"`, which runs a shell command. Three other types are available:

237 return match.group(0)409

~~238~~ 410* `"type": "http"`: POST event data to a URL. See [HTTP hooks](#http-hooks).

239 fence_pattern = r'(?ms)^([ \t]{0,3})```([^\n]*)\n(.*?)(\n\1```)\s*$'411* `"type": "prompt"`: single-turn LLM evaluation. See [Prompt-based hooks](#prompt-based-hooks).

240 content = re.sub(fence_pattern, add_lang_to_fence, content)412* `"type": "agent"`: multi-turn verification with tool access. See [Agent-based hooks](#agent-based-hooks).

~~241~~ 413

242 # Fix excessive blank lines (only outside code fences)414### Read input and return output

243 content = re.sub(r'\n{3,}', '\n\n', content)415

~~244~~ 416Hooks communicate with Claude Code through stdin, stdout, stderr, and exit codes. When an event fires, Claude Code passes event-specific data as JSON to your script's stdin. Your script reads that data, does its work, and tells Claude Code what to do next via the exit code.

245 return content.rstrip() + '\n'417

~~246~~ 418#### Hook input

247# Main execution419

248try:420Every event includes common fields like `session_id` and `cwd`, but each event type adds different data. For example, when Claude runs a Bash command, a `PreToolUse` hook receives something like this on stdin:

249 input_data = json.load(sys.stdin)421

250 file_path = input_data.get('tool_input', {}).get('file_path', '')422```json theme={null}

~~251~~ 423{

252 if not file_path.endswith(('.md', '.mdx')):424 "session_id": "abc123", // unique ID for this session

253 sys.exit(0) # Not a markdown file425 "cwd": "/Users/sarah/myproject", // working directory when the event fired

~~254~~ 426 "hook_event_name": "PreToolUse", // which event triggered this hook

255 if os.path.exists(file_path):427 "tool_name": "Bash", // the tool Claude is about to use

256 with open(file_path, 'r', encoding='utf-8') as f:428 "tool_input": { // the arguments Claude passed to the tool

257 content = f.read()429 "command": "npm test" // for Bash, this is the shell command

~~258~~ 430 }

259 formatted = format_markdown(content)431}

~~260~~ 432```

261 if formatted != content:433

262 with open(file_path, 'w', encoding='utf-8') as f:434Your script can parse that JSON and act on any of those fields. `UserPromptSubmit` hooks get the `prompt` text instead, `SessionStart` hooks get the `source` (startup, resume, clear, compact), and so on. See [Common input fields](/en/hooks#common-input-fields) in the reference for shared fields, and each event's section for event-specific schemas.

263 f.write(formatted)435

264 print(f"✓ Fixed markdown formatting in {file_path}")436#### Hook output

~~265~~ 437

266except Exception as e:438Your script tells Claude Code what to do next by writing to stdout or stderr and exiting with a specific code. For example, a `PreToolUse` hook that wants to block a command:

267 print(f"Error formatting markdown: {e}", file=sys.stderr)

268 sys.exit(1)

269````

~~270~~

271Make the script executable:

272 439

273```bash theme={null}440```bash theme={null}

274chmod +x .claude/hooks/markdown_formatter.py441#!/bin/bash

442INPUT=$(cat)

443COMMAND=$(echo "$INPUT" | jq -r '.tool_input.command')

444

445if echo "$COMMAND" | grep -q "drop table"; then

446 echo "Blocked: dropping tables is not allowed" >&2 # stderr becomes Claude's feedback

447 exit 2 # exit 2 = block the action

448fi

449

450exit 0 # exit 0 = let it proceed

451```

452

453The exit code determines what happens next:

454

455* **Exit 0**: the action proceeds. For `UserPromptSubmit` and `SessionStart` hooks, anything you write to stdout is added to Claude's context.

456* **Exit 2**: the action is blocked. Write a reason to stderr, and Claude receives it as feedback so it can adjust.

457* **Any other exit code**: the action proceeds. Stderr is logged but not shown to Claude. Toggle verbose mode with `Ctrl+O` to see these messages in the transcript.

458

459#### Structured JSON output

460

461Exit codes give you two options: allow or block. For more control, exit 0 and print a JSON object to stdout instead.

462

463<Note>

464 Use exit 2 to block with a stderr message, or exit 0 with JSON for structured control. Don't mix them: Claude Code ignores JSON when you exit 2.

465</Note>

466

467For example, a `PreToolUse` hook can deny a tool call and tell Claude why, or escalate it to the user for approval:

468

469```json theme={null}

470{

471 "hookSpecificOutput": {

472 "hookEventName": "PreToolUse",

473 "permissionDecision": "deny",

474 "permissionDecisionReason": "Use rg instead of grep for better performance"

475 }

476}

275```477```

276 478

277This hook automatically:479Claude Code reads `permissionDecision` and cancels the tool call, then feeds `permissionDecisionReason` back to Claude as feedback. These three options are specific to `PreToolUse`:

480

481* `"allow"`: skip the interactive permission prompt. Deny and ask rules, including enterprise managed deny lists, still apply

482* `"deny"`: cancel the tool call and send the reason to Claude

483* `"ask"`: show the permission prompt to the user as normal

484

485Returning `"allow"` skips the interactive prompt but does not override [permission rules](/en/permissions#manage-permissions). If a deny rule matches the tool call, the call is blocked even when your hook returns `"allow"`. If an ask rule matches, the user is still prompted. This means deny rules from any settings scope, including [managed settings](/en/settings#settings-files), always take precedence over hook approvals.

278 486

279* Detects programming languages in unlabeled code blocks487Other events use different decision patterns. For example, `PostToolUse` and `Stop` hooks use a top-level `decision: "block"` field, while `PermissionRequest` uses `hookSpecificOutput.decision.behavior`. See the [summary table](/en/hooks#decision-control) in the reference for a full breakdown by event.

280* Adds appropriate language tags for syntax highlighting

281* Fixes excessive blank lines while preserving code content

282* Only processes markdown files (`.md`, `.mdx`)

283 488

284### Custom Notification Hook489For `UserPromptSubmit` hooks, use `additionalContext` instead to inject text into Claude's context. Prompt-based hooks (`type: "prompt"`) handle output differently: see [Prompt-based hooks](#prompt-based-hooks).

285 490

286Get desktop notifications when Claude needs input:491### Filter hooks with matchers

492

493Without a matcher, a hook fires on every occurrence of its event. Matchers let you narrow that down. For example, if you want to run a formatter only after file edits (not after every tool call), add a matcher to your `PostToolUse` hook:

287 494

288```json theme={null}495```json theme={null}

289{496{

290 "hooks": {497 "hooks": {

291 "Notification": [498 "PostToolUse": [

292 {499 {

293 "matcher": "",500 "matcher": "Edit|Write",

501 "hooks": [

502 { "type": "command", "command": "prettier --write ..." }

503 ]

504 }

505 ]

506 }

507}

508```

509

510The `"Edit|Write"` matcher is a regex pattern that matches the tool name. The hook only fires when Claude uses the `Edit` or `Write` tool, not when it uses `Bash`, `Read`, or any other tool.

511

512Each event type matches on a specific field. Matchers support exact strings and regex patterns:

513

514| Event | What the matcher filters | Example matcher values |

515| :------------------------------------------------------------------------------------------------------------ | :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |

517| `SessionStart` | how the session started | `startup`, `resume`, `clear`, `compact` |

518| `SessionEnd` | why the session ended | `clear`, `resume`, `logout`, `prompt_input_exit`, `bypass_permissions_disabled`, `other` |

519| `Notification` | notification type | `permission_prompt`, `idle_prompt`, `auth_success`, `elicitation_dialog` |

520| `SubagentStart` | agent type | `Bash`, `Explore`, `Plan`, or custom agent names |

521| `PreCompact`, `PostCompact` | what triggered compaction | `manual`, `auto` |

522| `SubagentStop` | agent type | same values as `SubagentStart` |

523| `ConfigChange` | configuration source | `user_settings`, `project_settings`, `local_settings`, `policy_settings`, `skills` |

524| `StopFailure` | error type | `rate_limit`, `authentication_failed`, `billing_error`, `invalid_request`, `server_error`, `max_output_tokens`, `unknown` |

525| `InstructionsLoaded` | load reason | `session_start`, `nested_traversal`, `path_glob_match`, `include`, `compact` |

526| `Elicitation` | MCP server name | your configured MCP server names |

527| `ElicitationResult` | MCP server name | same values as `Elicitation` |

528| `FileChanged` | filename (basename of the changed file) | `.envrc`, `.env`, any filename you want to watch |

529| `UserPromptSubmit`, `Stop`, `TeammateIdle`, `TaskCompleted`, `WorktreeCreate`, `WorktreeRemove`, `CwdChanged` | no matcher support | always fires on every occurrence |

530

531A few more examples showing matchers on different event types:

532

533<Tabs>

534 <Tab title="Log every Bash command">

535 Match only `Bash` tool calls and log each command to a file. The `PostToolUse` event fires after the command completes, so `tool_input.command` contains what ran. The hook receives the event data as JSON on stdin, and `jq -r '.tool_input.command'` extracts just the command string, which `>>` appends to the log file:

536

537 ```json theme={null}

538 {

539 "hooks": {

540 "PostToolUse": [

541 {

542 "matcher": "Bash",

543 "hooks": [

544 {

545 "type": "command",

546 "command": "jq -r '.tool_input.command' >> ~/.claude/command-log.txt"

547 }

548 ]

549 }

550 ]

551 }

552 }

553 ```

554 </Tab>

555

556 <Tab title="Match MCP tools">

557 MCP tools use a different naming convention than built-in tools: `mcp__<server>__<tool>`, where `<server>` is the MCP server name and `<tool>` is the tool it provides. For example, `mcp__github__search_repositories` or `mcp__filesystem__read_file`. Use a regex matcher to target all tools from a specific server, or match across servers with a pattern like `mcp__.*__write.*`. See [Match MCP tools](/en/hooks#match-mcp-tools) in the reference for the full list of examples.

558

559 The command below extracts the tool name from the hook's JSON input with `jq` and writes it to stderr, where it shows up in verbose mode (`Ctrl+O`):

560

561 ```json theme={null}

562 {

563 "hooks": {

564 "PreToolUse": [

565 {

566 "matcher": "mcp__github__.*",

567 "hooks": [

568 {

569 "type": "command",

570 "command": "echo \"GitHub tool called: $(jq -r '.tool_name')\" >&2"

571 }

572 ]

573 }

574 ]

575 }

576 }

577 ```

578 </Tab>

579

580 <Tab title="Clean up on session end">

581 The `SessionEnd` event supports matchers on the reason the session ended. This hook only fires on `clear` (when you run `/clear`), not on normal exits:

582

583 ```json theme={null}

584 {

585 "hooks": {

586 "SessionEnd": [

587 {

588 "matcher": "clear",

294 "hooks": [589 "hooks": [

295 {590 {

296 "type": "command",591 "type": "command",

297 "command": "notify-send 'Claude Code' 'Awaiting your input'"592 "command": "rm -f /tmp/claude-scratch-*.txt"

593 }

594 ]

595 }

596 ]

597 }

598 }

599 ```

600 </Tab>

601</Tabs>

602

603For full matcher syntax, see the [Hooks reference](/en/hooks#configuration).

604

605### Configure hook location

606

607Where you add a hook determines its scope:

608

609| Location | Scope | Shareable |

610| :--------------------------------------------------------- | :--------------------------------- | :--------------------------------- |

611| `~/.claude/settings.json` | All your projects | No, local to your machine |

612| `.claude/settings.json` | Single project | Yes, can be committed to the repo |

613| `.claude/settings.local.json` | Single project | No, gitignored |

614| Managed policy settings | Organization-wide | Yes, admin-controlled |

615| [Plugin](/en/plugins) `hooks/hooks.json` | When plugin is enabled | Yes, bundled with the plugin |

616| [Skill](/en/skills) or [agent](/en/sub-agents) frontmatter | While the skill or agent is active | Yes, defined in the component file |

617

618Run [`/hooks`](/en/hooks#the-hooks-menu) in Claude Code to browse all configured hooks grouped by event. To disable all hooks at once, set `"disableAllHooks": true` in your settings file.

619

620If you edit settings files directly while Claude Code is running, the file watcher normally picks up hook changes automatically.

621

622## Prompt-based hooks

623

624For decisions that require judgment rather than deterministic rules, use `type: "prompt"` hooks. Instead of running a shell command, Claude Code sends your prompt and the hook's input data to a Claude model (Haiku by default) to make the decision. You can specify a different model with the `model` field if you need more capability.

625

626The model's only job is to return a yes/no decision as JSON:

627

628* `"ok": true`: the action proceeds

629* `"ok": false`: the action is blocked. The model's `"reason"` is fed back to Claude so it can adjust.

630

631This example uses a `Stop` hook to ask the model whether all requested tasks are complete. If the model returns `"ok": false`, Claude keeps working and uses the `reason` as its next instruction:

632

633```json theme={null}

634{

635 "hooks": {

636 "Stop": [

637 {

638 "hooks": [

639 {

640 "type": "prompt",

641 "prompt": "Check if all tasks are complete. If not, respond with {\"ok\": false, \"reason\": \"what remains to be done\"}."

298 }642 }

299 ]643 ]

300 }644 }

303}647}

304```648```

305 649

306### File Protection Hook650For full configuration options, see [Prompt-based hooks](/en/hooks#prompt-based-hooks) in the reference.

307 651

308Block edits to sensitive files:652## Agent-based hooks

653

654When verification requires inspecting files or running commands, use `type: "agent"` hooks. Unlike prompt hooks which make a single LLM call, agent hooks spawn a subagent that can read files, search code, and use other tools to verify conditions before returning a decision.

655

656Agent hooks use the same `"ok"` / `"reason"` response format as prompt hooks, but with a longer default timeout of 60 seconds and up to 50 tool-use turns.

657

658This example verifies that tests pass before allowing Claude to stop:

309 659

310```json theme={null}660```json theme={null}

311{661{

312 "hooks": {662 "hooks": {

313 "PreToolUse": [663 "Stop": [

314 {664 {

315 "matcher": "Edit|Write",

316 "hooks": [665 "hooks": [

317 {666 {

318 "type": "command",667 "type": "agent",

319 "command": "python3 -c \"import json, sys; data=json.load(sys.stdin); path=data.get('tool_input',{}).get('file_path',''); sys.exit(2 if any(p in path for p in ['.env', 'package-lock.json', '.git/']) else 0)\""668 "prompt": "Verify that all unit tests pass. Run the test suite and check the results. $ARGUMENTS",

669 "timeout": 120

670 }

671 ]

672 }

673 ]

674 }

675}

676```

677

678Use prompt hooks when the hook input data alone is enough to make a decision. Use agent hooks when you need to verify something against the actual state of the codebase.

679

680For full configuration options, see [Agent-based hooks](/en/hooks#agent-based-hooks) in the reference.

681

682## HTTP hooks

683

684Use `type: "http"` hooks to POST event data to an HTTP endpoint instead of running a shell command. The endpoint receives the same JSON that a command hook would receive on stdin, and returns results through the HTTP response body using the same JSON format.

685

686HTTP hooks are useful when you want a web server, cloud function, or external service to handle hook logic: for example, a shared audit service that logs tool use events across a team.

687

688This example posts every tool use to a local logging service:

689

690```json theme={null}

691{

692 "hooks": {

693 "PostToolUse": [

694 {

695 "hooks": [

696 {

697 "type": "http",

698 "url": "http://localhost:8080/hooks/tool-use",

699 "headers": {

700 "Authorization": "Bearer $MY_TOKEN"

701 },

702 "allowedEnvVars": ["MY_TOKEN"]

320 }703 }

321 ]704 ]

322 }705 }

325}708}

326```709```

327 710

711The endpoint should return a JSON response body using the same [output format](/en/hooks#json-output) as command hooks. To block a tool call, return a 2xx response with the appropriate `hookSpecificOutput` fields. HTTP status codes alone cannot block actions.

712

713Header values support environment variable interpolation using `$VAR_NAME` or `${VAR_NAME}` syntax. Only variables listed in the `allowedEnvVars` array are resolved; all other `$VAR` references remain empty.

714

715For full configuration options and response handling, see [HTTP hooks](/en/hooks#http-hook-fields) in the reference.

716

717## Limitations and troubleshooting

718

719### Limitations

720

721* Command hooks communicate through stdout, stderr, and exit codes only. They cannot trigger commands or tool calls directly. HTTP hooks communicate through the response body instead.

722* Hook timeout is 10 minutes by default, configurable per hook with the `timeout` field (in seconds).

723* `PostToolUse` hooks cannot undo actions since the tool has already executed.

724* `PermissionRequest` hooks do not fire in [non-interactive mode](/en/headless) (`-p`). Use `PreToolUse` hooks for automated permission decisions.

725* `Stop` hooks fire whenever Claude finishes responding, not only at task completion. They do not fire on user interrupts. API errors fire [StopFailure](/en/hooks#stopfailure) instead.

726

727### Hook not firing

728

729The hook is configured but never executes.

730

731* Run `/hooks` and confirm the hook appears under the correct event

732* Check that the matcher pattern matches the tool name exactly (matchers are case-sensitive)

733* Verify you're triggering the right event type (e.g., `PreToolUse` fires before tool execution, `PostToolUse` fires after)

734* If using `PermissionRequest` hooks in non-interactive mode (`-p`), switch to `PreToolUse` instead

735

736### Hook error in output

737

738You see a message like "PreToolUse hook error: ..." in the transcript.

739

740* Your script exited with a non-zero code unexpectedly. Test it manually by piping sample JSON:

741 ```bash theme={null}

742 echo '{"tool_name":"Bash","tool_input":{"command":"ls"}}' | ./my-hook.sh

743 echo $? # Check the exit code

744 ```

745* If you see "command not found", use absolute paths or `$CLAUDE_PROJECT_DIR` to reference scripts

746* If you see "jq: command not found", install `jq` or use Python/Node.js for JSON parsing

747* If the script isn't running at all, make it executable: `chmod +x ./my-hook.sh`

748

749### `/hooks` shows no hooks configured

750

751You edited a settings file but the hooks don't appear in the menu.

752

753* File edits are normally picked up automatically. If they haven't appeared after a few seconds, the file watcher may have missed the change: restart your session to force a reload.

754* Verify your JSON is valid (trailing commas and comments are not allowed)

755* Confirm the settings file is in the correct location: `.claude/settings.json` for project hooks, `~/.claude/settings.json` for global hooks

756

757### Stop hook runs forever

758

759Claude keeps working in an infinite loop instead of stopping.

760

761Your Stop hook script needs to check whether it already triggered a continuation. Parse the `stop_hook_active` field from the JSON input and exit early if it's `true`:

762

763```bash theme={null}

764#!/bin/bash

765INPUT=$(cat)

766if [ "$(echo "$INPUT" | jq -r '.stop_hook_active')" = "true" ]; then

767 exit 0 # Allow Claude to stop

768fi

769# ... rest of your hook logic

770```

771

772### JSON validation failed

773

774Claude Code shows a JSON parsing error even though your hook script outputs valid JSON.

775

776When Claude Code runs a hook, it spawns a shell that sources your profile (`~/.zshrc` or `~/.bashrc`). If your profile contains unconditional `echo` statements, that output gets prepended to your hook's JSON:

777

778```text theme={null}

779Shell ready on arm64

780{"decision": "block", "reason": "Not allowed"}

781```

782

783Claude Code tries to parse this as JSON and fails. To fix this, wrap echo statements in your shell profile so they only run in interactive shells:

784

785```bash theme={null}

786# In ~/.zshrc or ~/.bashrc

787if [[ $- == *i* ]]; then

788 echo "Shell ready"

789fi

790```

791

792The `$-` variable contains shell flags, and `i` means interactive. Hooks run in non-interactive shells, so the echo is skipped.

793

794### Debug techniques

795

796Toggle verbose mode with `Ctrl+O` to see hook output in the transcript, or run `claude --debug` for full execution details including which hooks matched and their exit codes.

797

328## Learn more798## Learn more

329 799

330* For reference documentation on hooks, see [Hooks reference](/en/hooks).800* [Hooks reference](/en/hooks): full event schemas, JSON output format, async hooks, and MCP tool hooks

331* For comprehensive security best practices and safety guidelines, see [Security Considerations](/en/hooks#security-considerations) in the hooks reference documentation.801* [Security considerations](/en/hooks#security-considerations): review before deploying hooks in shared or production environments

332* For troubleshooting steps and debugging techniques, see [Debugging](/en/hooks#debugging) in the hooks reference802* [Bash command validator example](https://github.com/anthropics/claude-code/blob/main/examples/hooks/bash_command_validator_example.py): complete reference implementation

333 documentation.

how-claude-code-works.md +261 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# How Claude Code works

7> Understand the agentic loop, built-in tools, and how Claude Code interacts with your project.

9Claude Code is an agentic assistant that runs in your terminal. While it excels at coding, it can help with anything you can do from the command line: writing docs, running builds, searching files, researching topics, and more.

11This guide covers the core architecture, built-in capabilities, and [tips for working effectively](#work-effectively-with-claude-code). For step-by-step walkthroughs, see [Common workflows](/en/common-workflows). For extensibility features like skills, MCP, and hooks, see [Extend Claude Code](/en/features-overview).

13## The agentic loop

15When you give Claude a task, it works through three phases: **gather context**, **take action**, and **verify results**. These phases blend together. Claude uses tools throughout, whether searching files to understand your code, editing to make changes, or running tests to check its work.

17<img src="https://mintcdn.com/claude-code/c5r9_6tjPMzFdDDT/images/agentic-loop.svg?fit=max&auto=format&n=c5r9_6tjPMzFdDDT&q=85&s=5f1827dec8539f38adee90ead3a85a38" alt="The agentic loop: Your prompt leads to Claude gathering context, taking action, verifying results, and repeating until task complete. You can interrupt at any point." width="720" height="280" data-path="images/agentic-loop.svg" />

19The loop adapts to what you ask. A question about your codebase might only need context gathering. A bug fix cycles through all three phases repeatedly. A refactor might involve extensive verification. Claude decides what each step requires based on what it learned from the previous step, chaining dozens of actions together and course-correcting along the way.

21You're part of this loop too. You can interrupt at any point to steer Claude in a different direction, provide additional context, or ask it to try a different approach. Claude works autonomously but stays responsive to your input.

23The agentic loop is powered by two components: [models](#models) that reason and [tools](#tools) that act. Claude Code serves as the **agentic harness** around Claude: it provides the tools, context management, and execution environment that turn a language model into a capable coding agent.

25### Models

27Claude Code uses Claude models to understand your code and reason about tasks. Claude can read code in any language, understand how components connect, and figure out what needs to change to accomplish your goal. For complex tasks, it breaks work into steps, executes them, and adjusts based on what it learns.

29[Multiple models](/en/model-config) are available with different tradeoffs. Sonnet handles most coding tasks well. Opus provides stronger reasoning for complex architectural decisions. Switch with `/model` during a session or start with `claude --model <name>`.

31When this guide says "Claude chooses" or "Claude decides," it's the model doing the reasoning.

33### Tools

35Tools are what make Claude Code agentic. Without tools, Claude can only respond with text. With tools, Claude can act: read your code, edit files, run commands, search the web, and interact with external services. Each tool use returns information that feeds back into the loop, informing Claude's next decision.

37The built-in tools generally fall into five categories, each representing a different kind of agency.

39| Category | What Claude can do |

40| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |

41| **File operations** | Read files, edit code, create new files, rename and reorganize |

42| **Search** | Find files by pattern, search content with regex, explore codebases |

43| **Execution** | Run shell commands, start servers, run tests, use git |

44| **Web** | Search the web, fetch documentation, look up error messages |

45| **Code intelligence** | See type errors and warnings after edits, jump to definitions, find references (requires [code intelligence plugins](/en/discover-plugins#code-intelligence)) |

47These are the primary capabilities. Claude also has tools for spawning subagents, asking you questions, and other orchestration tasks. See [Tools available to Claude](/en/tools-reference) for the complete list.

49Claude chooses which tools to use based on your prompt and what it learns along the way. When you say "fix the failing tests," Claude might:

511. Run the test suite to see what's failing

522. Read the error output

533. Search for the relevant source files

544. Read those files to understand the code

555. Edit the files to fix the issue

566. Run the tests again to verify

58Each tool use gives Claude new information that informs the next step. This is the agentic loop in action.

60**Extending the base capabilities:** The built-in tools are the foundation. You can extend what Claude knows with [skills](/en/skills), connect to external services with [MCP](/en/mcp), automate workflows with [hooks](/en/hooks), and offload tasks to [subagents](/en/sub-agents). These extensions form a layer on top of the core agentic loop. See [Extend Claude Code](/en/features-overview) for guidance on choosing the right extension for your needs.

62## What Claude can access

64This guide focuses on the terminal. Claude Code also runs in [VS Code](/en/vs-code), [JetBrains IDEs](/en/jetbrains), and other environments.

66When you run `claude` in a directory, Claude Code gains access to:

68* **Your project.** Files in your directory and subdirectories, plus files elsewhere with your permission.

69* **Your terminal.** Any command you could run: build tools, git, package managers, system utilities, scripts. If you can do it from the command line, Claude can too.

70* **Your git state.** Current branch, uncommitted changes, and recent commit history.

71* **Your [CLAUDE.md](/en/memory).** A markdown file where you store project-specific instructions, conventions, and context that Claude should know every session.

72* **[Auto memory](/en/memory#auto-memory).** Learnings Claude saves automatically as you work, like project patterns and your preferences. The first 200 lines of MEMORY.md are loaded at the start of each session.

73* **Extensions you configure.** [MCP servers](/en/mcp) for external services, [skills](/en/skills) for workflows, [subagents](/en/sub-agents) for delegated work, and [Claude in Chrome](/en/chrome) for browser interaction.

75Because Claude sees your whole project, it can work across it. When you ask Claude to "fix the authentication bug," it searches for relevant files, reads multiple files to understand context, makes coordinated edits across them, runs tests to verify the fix, and commits the changes if you ask. This is different from inline code assistants that only see the current file.

77## Environments and interfaces

79The agentic loop, tools, and capabilities described above are the same everywhere you use Claude Code. What changes is where the code executes and how you interact with it.

81### Execution environments

83Claude Code runs in three environments, each with different tradeoffs for where your code executes.

85| Environment | Where code runs | Use case |

86| ------------------ | --------------------------------------- | ---------------------------------------------------------- |

87| **Local** | Your machine | Default. Full access to your files, tools, and environment |

88| **Cloud** | Anthropic-managed VMs | Offload tasks, work on repos you don't have locally |

89| **Remote Control** | Your machine, controlled from a browser | Use the web UI while keeping everything local |

91### Interfaces

93You can access Claude Code through the terminal, the [desktop app](/en/desktop), [IDE extensions](/en/ide-integrations), [claude.ai/code](https://claude.ai/code), [Remote Control](/en/remote-control), [Slack](/en/slack), and [CI/CD pipelines](/en/github-actions). The interface determines how you see and interact with Claude, but the underlying agentic loop is identical. See [Use Claude Code everywhere](/en/overview#use-claude-code-everywhere) for the full list.

95## Work with sessions

97Claude Code saves your conversation locally as you work. Each message, tool use, and result is stored, which enables [rewinding](#undo-changes-with-checkpoints), [resuming, and forking](#resume-or-fork-sessions) sessions. Before Claude makes code changes, it also snapshots the affected files so you can revert if needed.

99**Sessions are independent.** Each new session starts with a fresh context window, without the conversation history from previous sessions. Claude can persist learnings across sessions using [auto memory](/en/memory#auto-memory), and you can add your own persistent instructions in [CLAUDE.md](/en/memory).

100

101### Work across branches

102

103Each Claude Code conversation is a session tied to your current directory. When you resume, you only see sessions from that directory.

104

105Claude sees your current branch's files. When you switch branches, Claude sees the new branch's files, but your conversation history stays the same. Claude remembers what you discussed even after switching.

106

107Since sessions are tied to directories, you can run parallel Claude sessions by using [git worktrees](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees), which create separate directories for individual branches.

108

109### Resume or fork sessions

110

111When you resume a session with `claude --continue` or `claude --resume`, you pick up where you left off using the same session ID. New messages append to the existing conversation. Your full conversation history is restored, but session-scoped permissions are not. You'll need to re-approve those.

112

113<img src="https://mintcdn.com/claude-code/c5r9_6tjPMzFdDDT/images/session-continuity.svg?fit=max&auto=format&n=c5r9_6tjPMzFdDDT&q=85&s=fa41d12bfb57579cabfeece907151d30" alt="Session continuity: resume continues the same session, fork creates a new branch with a new ID." width="560" height="280" data-path="images/session-continuity.svg" />

114

115To branch off and try a different approach without affecting the original session, use the `--fork-session` flag:

116

117```bash theme={null}

118claude --continue --fork-session

119```

120

121This creates a new session ID while preserving the conversation history up to that point. The original session remains unchanged. Like resume, forked sessions don't inherit session-scoped permissions.

122

123**Same session in multiple terminals**: If you resume the same session in multiple terminals, both terminals write to the same session file. Messages from both get interleaved, like two people writing in the same notebook. Nothing corrupts, but the conversation becomes jumbled. Each terminal only sees its own messages during the session, but if you resume that session later, you'll see everything interleaved. For parallel work from the same starting point, use `--fork-session` to give each terminal its own clean session.

124

125### The context window

126

127Claude's context window holds your conversation history, file contents, command outputs, [CLAUDE.md](/en/memory), [auto memory](/en/memory#auto-memory), loaded skills, and system instructions. As you work, context fills up. Claude compacts automatically, but instructions from early in the conversation can get lost. Put persistent rules in CLAUDE.md, and run `/context` to see what's using space.

128

129#### When context fills up

130

131Claude Code manages context automatically as you approach the limit. It clears older tool outputs first, then summarizes the conversation if needed. Your requests and key code snippets are preserved; detailed instructions from early in the conversation may be lost. Put persistent rules in CLAUDE.md rather than relying on conversation history.

132

133To control what's preserved during compaction, add a "Compact Instructions" section to CLAUDE.md or run `/compact` with a focus (like `/compact focus on the API changes`).

134

135Run `/context` to see what's using space. MCP servers add tool definitions to every request, so a few servers can consume significant context before you start working. Run `/mcp` to check per-server costs.

136

137#### Manage context with skills and subagents

138

139Beyond compaction, you can use other features to control what loads into context.

140

141[Skills](/en/skills) load on demand. Claude sees skill descriptions at session start, but the full content only loads when a skill is used. For skills you invoke manually, set `disable-model-invocation: true` to keep descriptions out of context until you need them.

142

143[Subagents](/en/sub-agents) get their own fresh context, completely separate from your main conversation. Their work doesn't bloat your context. When done, they return a summary. This isolation is why subagents help with long sessions.

144

145See [context costs](/en/features-overview#understand-context-costs) for what each feature costs, and [reduce token usage](/en/costs#reduce-token-usage) for tips on managing context.

146

147## Stay safe with checkpoints and permissions

148

149Claude has two safety mechanisms: checkpoints let you undo file changes, and permissions control what Claude can do without asking.

150

151### Undo changes with checkpoints

152

153**Every file edit is reversible.** Before Claude edits any file, it snapshots the current contents. If something goes wrong, press `Esc` twice to rewind to a previous state, or ask Claude to undo.

154

155Checkpoints are local to your session, separate from git. They only cover file changes. Actions that affect remote systems (databases, APIs, deployments) can't be checkpointed, which is why Claude asks before running commands with external side effects.

156

157### Control what Claude can do

158

159Press `Shift+Tab` to cycle through permission modes:

160

161* **Default**: Claude asks before file edits and shell commands

162* **Auto-accept edits**: Claude edits files without asking, still asks for commands

163* **Plan mode**: Claude uses read-only tools only, creating a plan you can approve before execution

164* **Auto mode**: Claude evaluates all actions with background safety checks. Currently a research preview

165

166You can also allow specific commands in `.claude/settings.json` so Claude doesn't ask each time. This is useful for trusted commands like `npm test` or `git status`. Settings can be scoped from organization-wide policies down to personal preferences. See [Permissions](/en/permissions) for details.

167

168***

169

170## Work effectively with Claude Code

171

172These tips help you get better results from Claude Code.

173

174### Ask Claude Code for help

175

176Claude Code can teach you how to use it. Ask questions like "how do I set up hooks?" or "what's the best way to structure my CLAUDE.md?" and Claude will explain.

177

178Built-in commands also guide you through setup:

179

180* `/init` walks you through creating a CLAUDE.md for your project

181* `/agents` helps you configure custom subagents

182* `/doctor` diagnoses common issues with your installation

183

184### It's a conversation

185

186Claude Code is conversational. You don't need perfect prompts. Start with what you want, then refine:

187

188```text theme={null}

189Fix the login bug

190```

191

192\[Claude investigates, tries something]

193

194```text theme={null}

195That's not quite right. The issue is in the session handling.

196```

197

198\[Claude adjusts approach]

199

200When the first attempt isn't right, you don't start over. You iterate.

201

202#### Interrupt and steer

203

204You can interrupt Claude at any point. If it's going down the wrong path, just type your correction and press Enter. Claude will stop what it's doing and adjust its approach based on your input. You don't have to wait for it to finish or start over.

205

206### Be specific upfront

207

208The more precise your initial prompt, the fewer corrections you'll need. Reference specific files, mention constraints, and point to example patterns.

209

210```text theme={null}

211The checkout flow is broken for users with expired cards.

212Check src/payments/ for the issue, especially token refresh.

213Write a failing test first, then fix it.

214```

215

216Vague prompts work, but you'll spend more time steering. Specific prompts like the one above often succeed on the first attempt.

217

218### Give Claude something to verify against

219

220Claude performs better when it can check its own work. Include test cases, paste screenshots of expected UI, or define the output you want.

221

222```text theme={null}

223Implement validateEmail. Test cases: 'user@example.com' → true,

224'invalid' → false, 'user@.com' → false. Run the tests after.

225```

226

227For visual work, paste a screenshot of the design and ask Claude to compare its implementation against it.

228

229### Explore before implementing

230

231For complex problems, separate research from coding. Use plan mode (`Shift+Tab` twice) to analyze the codebase first:

232

233```text theme={null}

234Read src/auth/ and understand how we handle sessions.

235Then create a plan for adding OAuth support.

236```

237

238Review the plan, refine it through conversation, then let Claude implement. This two-phase approach produces better results than jumping straight to code.

239

240### Delegate, don't dictate

241

242Think of delegating to a capable colleague. Give context and direction, then trust Claude to figure out the details:

243

244```text theme={null}

245The checkout flow is broken for users with expired cards.

246The relevant code is in src/payments/. Can you investigate and fix it?

247```

248

249You don't need to specify which files to read or what commands to run. Claude figures that out.

250

251## What's next

252

253<CardGroup cols={2}>

254 <Card title="Extend with features" icon="puzzle-piece" href="/en/features-overview">

255 Add Skills, MCP connections, and custom commands

256 </Card>

257

258 <Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">

259 Step-by-step guides for typical tasks

260 </Card>

261</CardGroup>

iam.md +0 −201 deleted

File DeletedView Diff

~~1# Identity and Access Management~~

~~3> Learn how to configure user authentication, authorization, and access controls for Claude Code in your organization.~~

~~5## Authentication methods~~

~~7Setting up Claude Code requires access to Anthropic models. For teams, you can set up Claude Code access in one of four ways:~~

~~9* Claude API via the Claude Console~~

~~10* Amazon Bedrock~~

~~11* Microsoft Foundry~~

~~12* Google Vertex AI~~

~~14### Claude API authentication~~

~~16**To set up Claude Code access for your team via Claude API:**~~

~~181. Use your existing Claude Console account or create a new Claude Console account~~

~~192. You can add users through either method below:~~

~~20 * Bulk invite users from within the Console (Console -> Settings -> Members -> Invite)~~

~~21 * [Set up SSO](https://support.claude.com/en/articles/10280258-setting-up-single-sign-on-on-the-api-console)~~

~~223. When inviting users, they need one of the following roles:~~

~~23 * "Claude Code" role means users can only create Claude Code API keys~~

~~24 * "Developer" role means users can create any kind of API key~~

~~254. Each invited user needs to complete these steps:~~

~~26 * Accept the Console invite~~

~~27 * [Check system requirements](/en/setup#system-requirements)~~

~~28 * [Install Claude Code](/en/setup#installation)~~

~~29 * Login with Console account credentials~~

~~31### Cloud provider authentication~~

~~33**To set up Claude Code access for your team via Bedrock, Vertex, or Azure:**~~

~~351. Follow the [Bedrock docs](/en/amazon-bedrock), [Vertex docs](/en/google-vertex-ai), or [Microsoft Foundry docs](/en/microsoft-foundry)~~

~~362. Distribute the environment variables and instructions for generating cloud credentials to your users. Read more about how to [manage configuration here](/en/settings).~~

~~373. Users can [install Claude Code](/en/setup#installation)~~

~~39## Access control and permissions~~

41We support fine-grained permissions so that you're able to specify exactly what the agent is allowed to do (e.g. run tests, run linter) and what it is not allowed to do (e.g. update cloud infrastructure). These permission settings can be checked into version control and distributed to all developers in your organization, as well as customized by individual developers.

~~43### Permission system~~

~~45Claude Code uses a tiered permission system to balance power and safety:~~

~~48| :---------------- | :------------------- | :---------------- | :-------------------------------------------- |~~

~~49| Read-only | File reads, LS, Grep | No | N/A |~~

~~50| Bash Commands | Shell execution | Yes | Permanently per project directory and command |~~

~~51| File Modification | Edit/write files | Yes | Until session end |~~

~~53### Configuring permissions~~

~~55You can view & manage Claude Code's tool permissions with `/permissions`. This UI lists all permission rules and the settings.json file they are sourced from.~~

~~57* **Allow** rules will allow Claude Code to use the specified tool without further manual approval.~~

~~58* **Ask** rules will ask the user for confirmation whenever Claude Code tries to use the specified tool. Ask rules take precedence over allow rules.~~

~~59* **Deny** rules will prevent Claude Code from using the specified tool. Deny rules take precedence over allow and ask rules.~~

~~60* **Additional directories** extend Claude's file access to directories beyond the initial working directory.~~

~~61* **Default mode** controls Claude's permission behavior when encountering new requests.~~

~~63Permission rules use the format: `Tool` or `Tool(optional-specifier)`~~

~~65A rule that is just the tool name matches any use of that tool. For example, adding `Bash` to the list of allow rules would allow Claude Code to use the Bash tool without requiring user approval.~~

~~67#### Permission modes~~

~~69Claude Code supports several permission modes that can be set as the `defaultMode` in [settings files](/en/settings#settings-files):~~

~~71| Mode | Description |~~

~~72| :------------------ | :--------------------------------------------------------------------------- |~~

~~73| `default` | Standard behavior - prompts for permission on first use of each tool |~~

~~74| `acceptEdits` | Automatically accepts file edit permissions for the session |~~

~~75| `plan` | Plan Mode - Claude can analyze but not modify files or execute commands |~~

~~76| `bypassPermissions` | Skips all permission prompts (requires safe environment - see warning below) |~~

~~78#### Working directories~~

~~80By default, Claude has access to files in the directory where it was launched. You can extend this access:~~

~~82* **During startup**: Use `--add-dir <path>` CLI argument~~

~~83* **During session**: Use `/add-dir` slash command~~

~~84* **Persistent configuration**: Add to `additionalDirectories` in [settings files](/en/settings#settings-files)~~

86Files in additional directories follow the same permission rules as the original working directory - they become readable without prompts, and file editing permissions follow the current permission mode.

~~88#### Tool-specific permission rules~~

~~90Some tools support more fine-grained permission controls:~~

~~92**Bash**~~

~~94* `Bash(npm run build)` Matches the exact Bash command `npm run build`~~

~~95* `Bash(npm run test:*)` Matches Bash commands starting with `npm run test`~~

~~96* `Bash(curl http://site.com/:*)` Matches curl commands that start with exactly `curl http://site.com/`~~

~~98<Tip>~~

~~99 Claude Code is aware of shell operators (like `&&`) so a prefix match rule like `Bash(safe-cmd:*)` won't give it permission to run the command `safe-cmd && other-cmd`~~

100</Tip>

~~101~~

102<Warning>

103 Important limitations of Bash permission patterns:

~~104~~

105 1. This tool uses **prefix matches**, not regex or glob patterns

106 2. The wildcard `:*` only works at the end of a pattern to match any continuation

107 3. Patterns like `Bash(curl http://github.com/:*)` can be bypassed in many ways:

108 * Options before URL: `curl -X GET http://github.com/...` won't match

109 * Different protocol: `curl https://github.com/...` won't match

110 * Redirects: `curl -L http://bit.ly/xyz` (redirects to github)

111 * Variables: `URL=http://github.com && curl $URL` won't match

112 * Extra spaces: `curl http://github.com` won't match

~~113~~

114 For more reliable URL filtering, consider:

~~115~~

116 * Using the WebFetch tool with `WebFetch(domain:github.com)` permission

117 * Instructing Claude Code about your allowed curl patterns via CLAUDE.md

118 * Using hooks for custom permission validation

119</Warning>

~~120~~

121**Read & Edit**

~~122~~

123`Edit` rules apply to all built-in tools that edit files. Claude will make a best-effort attempt to apply `Read` rules to all built-in tools that read files like Grep, Glob, and LS.

~~124~~

125Read & Edit rules both follow the [gitignore](https://git-scm.com/docs/gitignore) specification with four distinct pattern types:

~~126~~

128| ------------------ | -------------------------------------- | -------------------------------- | ---------------------------------- |

129| `//path` | **Absolute** path from filesystem root | `Read(//Users/alice/secrets/**)` | `/Users/alice/secrets/**` |

130| `~/path` | Path from **home** directory | `Read(~/Documents/*.pdf)` | `/Users/alice/Documents/*.pdf` |

131| `/path` | Path **relative to settings file** | `Edit(/src/**/*.ts)` | `<settings file path>/src/**/*.ts` |

132| `path` or `./path` | Path **relative to current directory** | `Read(*.env)` | `<cwd>/*.env` |

~~133~~

134<Warning>

135 A pattern like `/Users/alice/file` is NOT an absolute path - it's relative to your settings file! Use `//Users/alice/file` for absolute paths.

136</Warning>

~~137~~

138* `Edit(/docs/**)` - Edits in `<project>/docs/` (NOT `/docs/`!)

139* `Read(~/.zshrc)` - Reads your home directory's `.zshrc`

140* `Edit(//tmp/scratch.txt)` - Edits the absolute path `/tmp/scratch.txt`

141* `Read(src/**)` - Reads from `<current-directory>/src/`

~~142~~

143**WebFetch**

~~144~~

145* `WebFetch(domain:example.com)` Matches fetch requests to example.com

~~146~~

147**MCP**

~~148~~

149* `mcp__puppeteer` Matches any tool provided by the `puppeteer` server (name configured in Claude Code)

150* `mcp__puppeteer__puppeteer_navigate` Matches the `puppeteer_navigate` tool provided by the `puppeteer` server

~~151~~

152<Warning>

153 Unlike other permission types, MCP permissions do NOT support wildcards (`*`).

~~154~~

155 To approve all tools from an MCP server:

~~156~~

157 * ✅ Use: `mcp__github` (approves ALL GitHub tools)

158 * ❌ Don't use: `mcp__github__*` (wildcards are not supported)

~~159~~

160 To approve specific tools only, list each one:

~~161~~

162 * ✅ Use: `mcp__github__get_issue`

163 * ✅ Use: `mcp__github__list_issues`

164</Warning>

~~165~~

166### Additional permission control with hooks

~~167~~

168[Claude Code hooks](/en/hooks-guide) provide a way to register custom shell commands to perform permission evaluation at runtime. When Claude Code makes a tool call, PreToolUse hooks run before the permission system runs, and the hook output can determine whether to approve or deny the tool call in place of the permission system.

~~169~~

170### Enterprise managed policy settings

~~171~~

172For enterprise deployments of Claude Code, we support enterprise managed policy settings that take precedence over user and project settings. This allows system administrators to enforce security policies that users cannot override.

~~173~~

174System administrators can deploy policies to:

~~175~~

176* macOS: `/Library/Application Support/ClaudeCode/managed-settings.json`

177* Linux and WSL: `/etc/claude-code/managed-settings.json`

178* Windows: `C:\ProgramData\ClaudeCode\managed-settings.json`

~~179~~

180These policy files follow the same format as regular [settings files](/en/settings#settings-files) but cannot be overridden by user or project settings. This ensures consistent security policies across your organization.

~~181~~

182### Settings precedence

~~183~~

184When multiple settings sources exist, they are applied in the following order (highest to lowest precedence):

~~185~~

1861. Enterprise policies

1872. Command line arguments

1883. Local project settings (`.claude/settings.local.json`)

1894. Shared project settings (`.claude/settings.json`)

1905. User settings (`~/.claude/settings.json`)

~~191~~

192This hierarchy ensures that organizational policies are always enforced while still allowing flexibility at the project and user levels where appropriate.

~~193~~

194## Credential management

~~195~~

196Claude Code securely manages your authentication credentials:

~~197~~

198* **Storage location**: On macOS, API keys, OAuth tokens, and other credentials are stored in the encrypted macOS Keychain.

199* **Supported authentication types**: Claude.ai credentials, Claude API credentials, Azure Auth, Bedrock Auth, and Vertex Auth.

200* **Custom credential scripts**: The [`apiKeyHelper`](/en/settings#available-settings) setting can be configured to run a shell script that returns an API key.

201* **Refresh intervals**: By default, `apiKeyHelper` is called after 5 minutes or on HTTP 401 response. Set `CLAUDE_CODE_API_KEY_HELPER_TTL_MS` environment variable for custom refresh intervals.

interactive-mode.md +181 −22

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Interactive mode5# Interactive mode

2 6

3> Complete reference for keyboard shortcuts, input modes, and interactive features in Claude Code sessions.7> Complete reference for keyboard shortcuts, input modes, and interactive features in Claude Code sessions.

6 10

7<Note>11<Note>

8 Keyboard shortcuts may vary by platform and terminal. Press `?` to see available shortcuts for your environment.12 Keyboard shortcuts may vary by platform and terminal. Press `?` to see available shortcuts for your environment.

14 **macOS users**: Option/Alt key shortcuts (`Alt+B`, `Alt+F`, `Alt+Y`, `Alt+M`, `Alt+P`) require configuring Option as Meta in your terminal:

16 * **iTerm2**: settings → Profiles → Keys → set Left/Right Option key to "Esc+"

17 * **Terminal.app**: settings → Profiles → Keyboard → check "Use Option as Meta Key"

18 * **VS Code**: settings → Profiles → Keys → set Left/Right Option key to "Esc+"

20 See [Terminal configuration](/en/terminal-config) for details.

9</Note>21</Note>

10 22

11### General controls23### General controls

12 24

14| :------------------------------------------- | :---------------------------------------------------------------------------------------------- | :---------------------------------------------------------- |26| :------------------------------------------------ | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

28| `Ctrl+X Ctrl+K` | Kill all background agents. Press twice within 3 seconds to confirm | Background agent control |

30| `Ctrl+G` or `Ctrl+X Ctrl+E` | Open in default text editor | Edit your prompt or custom response in your default text editor. `Ctrl+X Ctrl+E` is the readline-native binding |

35| `Ctrl+B` | Background running tasks | Backgrounds bash commands and agents. Tmux users press twice |

36| `Ctrl+T` | Toggle task list | Show or hide the [task list](#task-list) in the terminal status area |

37| `Left/Right arrows` | Cycle through dialog tabs | Navigate between tabs in permission dialogs and menus |

23| `Tab` | Toggle [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) | Switch between Thinking on and Thinking off |40| `Shift+Tab` or `Alt+M` (some configurations) | Cycle permission modes | Cycle through `default`, `acceptEdits`, `plan`, and any modes you have enabled, such as `auto` or `bypassPermissions`. See [permission modes](/en/permission-modes). |

42| `Option+T` (macOS) or `Alt+T` (Windows/Linux) | Toggle extended thinking | Enable or disable extended thinking mode. Run `/terminal-setup` first to enable this shortcut |

43| `Option+O` (macOS) or `Alt+O` (Windows/Linux) | Toggle fast mode | Enable or disable [fast mode](/en/fast-mode) |

45### Text editing

47| Shortcut | Description | Context |

48| :----------------------- | :--------------------------- | :------------------------------------------------------------------------------------------------------------ |

49| `Ctrl+K` | Delete to end of line | Stores deleted text for pasting |

50| `Ctrl+U` | Delete entire line | Stores deleted text for pasting |

51| `Ctrl+Y` | Paste deleted text | Paste text deleted with `Ctrl+K` or `Ctrl+U` |

52| `Alt+Y` (after `Ctrl+Y`) | Cycle paste history | After pasting, cycle through previously deleted text. Requires [Option as Meta](#keyboard-shortcuts) on macOS |

53| `Alt+B` | Move cursor back one word | Word navigation. Requires [Option as Meta](#keyboard-shortcuts) on macOS |

54| `Alt+F` | Move cursor forward one word | Word navigation. Requires [Option as Meta](#keyboard-shortcuts) on macOS |

56### Theme and display

58| Shortcut | Description | Context |

59| :------- | :----------------------------------------- | :----------------------------------------------------------------------------------------------------------- |

60| `Ctrl+T` | Toggle syntax highlighting for code blocks | Only works inside the `/theme` picker menu. Controls whether code in Claude's responses uses syntax coloring |

62<Note>

63 Syntax highlighting is only available in the native build of Claude Code.

64</Note>

25 65

26### Multiline input66### Multiline input

27 67

~~29| :--------------- | :------------- | :-------------------------------- |~~69| :--------------- | :------------- | :------------------------------------------------------ |

35 75

36<Tip>76<Tip>

~~37 Configure your preferred line break behavior in terminal settings. Run `/terminal-setup` to install Shift+Enter binding for iTerm2 and VS Code terminals.~~77 Shift+Enter works without configuration in iTerm2, WezTerm, Ghostty, and Kitty. For other terminals (VS Code, Alacritty, Zed, Warp), run `/terminal-setup` to install the binding.

38</Tip>78</Tip>

39 79

40### Quick commands80### Quick commands

41 81

~~43| :----------- | :--------------------------------- | :------------------------------------------------------------ |~~83| :----------- | :---------------- | :------------------------------------------------------------------- |

~~45| `/` at start | Slash command | See [slash commands](/en/slash-commands) |~~

47| `@` | File path mention | Trigger file path autocomplete |86| `@` | File path mention | Trigger file path autocomplete |

48 87

88### Transcript viewer

90When the transcript viewer is open (toggled with `Ctrl+O`), these shortcuts are available. `Ctrl+E` can be rebound via [`transcript:toggleShowAll`](/en/keybindings).

92| Shortcut | Description |

93| :------------------- | :---------------------------------------------------------------------------------------------------------------------- |

94| `Ctrl+E` | Toggle show all content |

95| `q`, `Ctrl+C`, `Esc` | Exit transcript view. `Ctrl+C` and `Esc` can be rebound via [`transcript:exit`](/en/keybindings); `q` is not rebindable |

97### Voice input

99| Shortcut | Description | Notes |

100| :----------- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |

101| Hold `Space` | Push-to-talk dictation | Requires [voice dictation](/en/voice-dictation) to be enabled. Transcript inserts at cursor. [Rebindable](/en/voice-dictation#rebind-the-push-to-talk-key) |

102

103## Built-in commands

104

105Type `/` in Claude Code to see all available commands, or type `/` followed by any letters to filter. The `/` menu shows both built-in commands and [bundled skills](/en/skills#bundled-skills) like `/simplify`. Not all commands are visible to every user since some depend on your platform or plan.

106

107See the [commands reference](/en/commands) for the full list of built-in commands. To create your own commands, see [skills](/en/skills).

108

49## Vim editor mode109## Vim editor mode

50 110

51Enable vim-style editing with `/vim` command or configure permanently via `/config`.111Enable vim-style editing with `/vim` command or configure permanently via `/config`.

65### Navigation (NORMAL mode)125### Navigation (NORMAL mode)

66 126

67| Command | Action |127| Command | Action |

~~68| :-------------- | :------------------------ |~~128| :-------------- | :-------------------------------------------------- |

70| `w` | Next word |130| `w` | Next word |

71| `e` | End of word |131| `e` | End of word |

75| `^` | First non-blank character |135| `^` | First non-blank character |

76| `gg` | Beginning of input |136| `gg` | Beginning of input |

77| `G` | End of input |137| `G` | End of input |

138| `f{char}` | Jump to next occurrence of character |

139| `F{char}` | Jump to previous occurrence of character |

140| `t{char}` | Jump to just before next occurrence of character |

141| `T{char}` | Jump to just after previous occurrence of character |

142| `;` | Repeat last f/F/t/T motion |

143| `,` | Repeat last f/F/t/T motion in reverse |

144

145<Note>

146 In vim normal mode, if the cursor is at the beginning or end of input and cannot move further, the arrow keys navigate command history instead.

147</Note>

78 148

79### Editing (NORMAL mode)149### Editing (NORMAL mode)

80 150

87| `cc` | Change line |157| `cc` | Change line |

88| `C` | Change to end of line |158| `C` | Change to end of line |

160| `yy`/`Y` | Yank (copy) line |

161| `yw`/`ye`/`yb` | Yank word/to end/back |

162| `p` | Paste after cursor |

163| `P` | Paste before cursor |

164| `>>` | Indent line |

165| `<<` | Dedent line |

166| `J` | Join lines |

90| `.` | Repeat last change |167| `.` | Repeat last change |

91 168

169### Text objects (NORMAL mode)

170

171Text objects work with operators like `d`, `c`, and `y`:

172

173| Command | Action |

174| :-------- | :--------------------------------------- |

175| `iw`/`aw` | Inner/around word |

176| `iW`/`aW` | Inner/around WORD (whitespace-delimited) |

177| `i"`/`a"` | Inner/around double quotes |

178| `i'`/`a'` | Inner/around single quotes |

179| `i(`/`a(` | Inner/around parentheses |

180| `i[`/`a[` | Inner/around brackets |

181| `i{`/`a{` | Inner/around braces |

182

92## Command history183## Command history

93 184

94Claude Code maintains command history for the current session:185Claude Code maintains command history for the current session:

95 186

~~96* History is stored per working directory~~187* Input history is stored per working directory

~~97* Cleared with `/clear` command~~188* Input history resets when you run `/clear` to start a new session. The previous session's conversation is preserved and can be resumed.

98* Use Up/Down arrows to navigate (see keyboard shortcuts above)189* Use Up/Down arrows to navigate (see keyboard shortcuts above)

~~99* **Note**: History expansion (`!`) is disabled by default~~190* **Note**: history expansion (`!`) is disabled by default

100 191

101### Reverse search with Ctrl+R192### Reverse search with Ctrl+R

102 193

103Press `Ctrl+R` to interactively search through your command history:194Press `Ctrl+R` to interactively search through your command history:

104 195

1051. **Start search**: Press `Ctrl+R` to activate reverse history search1961. **Start search**: press `Ctrl+R` to activate reverse history search

1062. **Type query**: Enter text to search for in previous commands - the search term will be highlighted in matching results1972. **Type query**: enter text to search for in previous commands. The search term is highlighted in matching results

1073. **Navigate matches**: Press `Ctrl+R` again to cycle through older matches1983. **Navigate matches**: press `Ctrl+R` again to cycle through older matches

1084. **Accept match**:1994. **Accept match**:

109 * Press `Tab` or `Esc` to accept the current match and continue editing200 * Press `Tab` or `Esc` to accept the current match and continue editing

110 * Press `Enter` to accept and execute the command immediately201 * Press `Enter` to accept and execute the command immediately

112 * Press `Ctrl+C` to cancel and restore your original input203 * Press `Ctrl+C` to cancel and restore your original input

113 * Press `Backspace` on empty search to cancel204 * Press `Backspace` on empty search to cancel

114 205

115The search displays matching commands with the search term highlighted, making it easy to find and reuse previous inputs.206The search displays matching commands with the search term highlighted, so you can find and reuse previous inputs.

116 207

117## Background bash commands208## Background bash commands

118 209

129 220

130**Key features:**221**Key features:**

131 222

132* Output is buffered and Claude can retrieve it using the BashOutput tool223* Output is written to a file and Claude can retrieve it using the Read tool

133* Background tasks have unique IDs for tracking and output retrieval224* Background tasks have unique IDs for tracking and output retrieval

134* Background tasks are automatically cleaned up when Claude Code exits225* Background tasks are automatically cleaned up when Claude Code exits

226* Background tasks are automatically terminated if output exceeds 5GB, with a note in stderr explaining why

227

228To disable all background task functionality, set the `CLAUDE_CODE_DISABLE_BACKGROUND_TASKS` environment variable to `1`. See [Environment variables](/en/env-vars) for details.

135 229

136**Common backgrounded commands:**230**Common backgrounded commands:**

137 231

157* Shows real-time progress and output251* Shows real-time progress and output

158* Supports the same `Ctrl+B` backgrounding for long-running commands252* Supports the same `Ctrl+B` backgrounding for long-running commands

159* Does not require Claude to interpret or approve the command253* Does not require Claude to interpret or approve the command

254* Supports history-based autocomplete: type a partial command and press **Tab** to complete from previous `!` commands in the current project

255* Exit with `Escape`, `Backspace`, or `Ctrl+U` on an empty prompt

160 256

161This is useful for quick shell operations while maintaining conversation context.257This is useful for quick shell operations while maintaining conversation context.

162 258

259## Prompt suggestions

260

261When you first open a session, a grayed-out example command appears in the prompt input to help you get started. Claude Code picks this from your project's git history, so it reflects files you've been working on recently.

262

263After Claude responds, suggestions continue to appear based on your conversation history, such as a follow-up step from a multi-part request or a natural continuation of your workflow.

264

265* Press **Tab** to accept the suggestion, or press **Enter** to accept and submit

266* Start typing to dismiss it

267

268The suggestion runs as a background request that reuses the parent conversation's prompt cache, so the additional cost is minimal. Claude Code skips suggestion generation when the cache is cold to avoid unnecessary cost.

269

270Suggestions are automatically skipped after the first turn of a conversation, in non-interactive mode, and in plan mode.

271

272To disable prompt suggestions entirely, set the environment variable or toggle the setting in `/config`:

273

274```bash theme={null}

275export CLAUDE_CODE_ENABLE_PROMPT_SUGGESTION=false

276```

277

278## Side questions with /btw

279

280Use `/btw` to ask a quick question about your current work without adding to the conversation history. This is useful when you want a fast answer but don't want to clutter the main context or derail Claude from a long-running task.

281

282```

283/btw what was the name of that config file again?

284```

285

286Side questions have full visibility into the current conversation, so you can ask about code Claude has already read, decisions it made earlier, or anything else from the session. The question and answer are ephemeral: they appear in a dismissible overlay and never enter the conversation history.

287

288* **Available while Claude is working**: you can run `/btw` even while Claude is processing a response. The side question runs independently and does not interrupt the main turn.

289* **No tool access**: side questions answer only from what is already in context. Claude cannot read files, run commands, or search when answering a side question.

290* **Single response**: there are no follow-up turns. If you need a back-and-forth, use a normal prompt instead.

291* **Low cost**: the side question reuses the parent conversation's prompt cache, so the additional cost is minimal.

292

293Press **Space**, **Enter**, or **Escape** to dismiss the answer and return to the prompt.

294

295`/btw` is the inverse of a [subagent](/en/sub-agents): it sees your full conversation but has no tools, while a subagent has full tools but starts with an empty context. Use `/btw` to ask about what Claude already knows from this session; use a subagent to go find out something new.

296

297## Task list

298

299When working on complex, multi-step work, Claude creates a task list to track progress. Tasks appear in the status area of your terminal with indicators showing what's pending, in progress, or complete.

300

301* Press `Ctrl+T` to toggle the task list view. The display shows up to 10 tasks at a time

302* To see all tasks or clear them, ask Claude directly: "show me all tasks" or "clear all tasks"

303* Tasks persist across context compactions, helping Claude stay organized on larger projects

304* To share a task list across sessions, set `CLAUDE_CODE_TASK_LIST_ID` to use a named directory in `~/.claude/tasks/`: `CLAUDE_CODE_TASK_LIST_ID=my-project claude`

305

306## PR review status

307

308When working on a branch with an open pull request, Claude Code displays a clickable PR link in the footer (for example, "PR #446"). The link has a colored underline indicating the review state:

309

310* Green: approved

311* Yellow: pending review

312* Red: changes requested

313* Gray: draft

314* Purple: merged

315

316`Cmd+click` (Mac) or `Ctrl+click` (Windows/Linux) the link to open the pull request in your browser. The status updates automatically every 60 seconds.

317

318<Note>

319 PR status requires the `gh` CLI to be installed and authenticated (`gh auth login`).

320</Note>

321

163## See also322## See also

164 323

165* [Slash commands](/en/slash-commands) - Interactive session commands324* [Skills](/en/skills) - Custom prompts and workflows

166* [Checkpointing](/en/checkpointing) - Rewind Claude's edits and restore previous states325* [Checkpointing](/en/checkpointing) - Rewind Claude's edits and restore previous states

167* [CLI reference](/en/cli-reference) - Command-line flags and options326* [CLI reference](/en/cli-reference) - Command-line flags and options

168* [Settings](/en/settings) - Configuration options327* [Settings](/en/settings) - Configuration options

jetbrains.md +12 −7

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# JetBrains IDEs5# JetBrains IDEs

2 6

3> Use Claude Code with JetBrains IDEs including IntelliJ, PyCharm, WebStorm, and more7> Use Claude Code with JetBrains IDEs including IntelliJ, PyCharm, WebStorm, and more

20* **Quick launch**: Use `Cmd+Esc` (Mac) or `Ctrl+Esc` (Windows/Linux) to open Claude Code directly from your editor, or click the Claude Code button in the UI24* **Quick launch**: Use `Cmd+Esc` (Mac) or `Ctrl+Esc` (Windows/Linux) to open Claude Code directly from your editor, or click the Claude Code button in the UI

21* **Diff viewing**: Code changes can be displayed directly in the IDE diff viewer instead of the terminal25* **Diff viewing**: Code changes can be displayed directly in the IDE diff viewer instead of the terminal

22* **Selection context**: The current selection/tab in the IDE is automatically shared with Claude Code26* **Selection context**: The current selection/tab in the IDE is automatically shared with Claude Code

~~23* **File reference shortcuts**: Use `Cmd+Option+K` (Mac) or `Alt+Ctrl+K` (Linux/Windows) to insert file references (e.g., @File#L1-99)~~27* **File reference shortcuts**: Use `Cmd+Option+K` (Mac) or `Alt+Ctrl+K` (Linux/Windows) to insert file references (for example, @File#L1-99)

24* **Diagnostic sharing**: Diagnostic errors (lint, syntax, etc.) from the IDE are automatically shared with Claude as you work28* **Diagnostic sharing**: Diagnostic errors (lint, syntax, etc.) from the IDE are automatically shared with Claude as you work

25 29

26## Installation30## Installation

29 33

30Find and install the [Claude Code plugin](https://plugins.jetbrains.com/plugin/27310-claude-code-beta-) from the JetBrains marketplace and restart your IDE.34Find and install the [Claude Code plugin](https://plugins.jetbrains.com/plugin/27310-claude-code-beta-) from the JetBrains marketplace and restart your IDE.

31 35

~~32### Auto-Installation~~36If you haven't installed Claude Code yet, see [our quickstart guide](/en/quickstart) for installation instructions.

~~34The plugin may also be auto-installed when you run `claude` in the integrated terminal. The IDE must be restarted completely to take effect.~~

35 37

36<Note>38<Note>

~~37 After installing the plugin, you must restart your IDE completely for it to take effect. You may need to restart multiple times.~~39 After installing the plugin, you may need to restart your IDE completely for it to take effect.

38</Note>40</Note>

39 41

40## Usage42## Usage

49 51

50```bash theme={null}52```bash theme={null}

51claude53claude

~~52> /ide~~54```

56```text theme={null}

57/ide

53```58```

54 59

55If you want Claude to have access to the same files as your IDE, start Claude Code from the same directory as your IDE project root.60If you want Claude to have access to the same files as your IDE, start Claude Code from the same directory as your IDE project root.

70 75

71#### General Settings76#### General Settings

72 77

~~73* **Claude command**: Specify a custom command to run Claude (e.g., `claude`, `/usr/local/bin/claude`, or `npx @anthropic/claude`)~~78* **Claude command**: Specify a custom command to run Claude (for example, `claude`, `/usr/local/bin/claude`, or `npx @anthropic/claude`)

74* **Suppress notification for Claude command not found**: Skip notifications about not finding the Claude command79* **Suppress notification for Claude command not found**: Skip notifications about not finding the Claude command

75* **Enable using Option+Enter for multi-line prompts** (macOS only): When enabled, Option+Enter inserts new lines in Claude Code prompts. Disable if experiencing issues with the Option key being captured unexpectedly (requires terminal restart)80* **Enable using Option+Enter for multi-line prompts** (macOS only): When enabled, Option+Enter inserts new lines in Claude Code prompts. Disable if experiencing issues with the Option key being captured unexpectedly (requires terminal restart)

76* **Enable automatic updates**: Automatically check for and install plugin updates (applied on restart)81* **Enable automatic updates**: Automatically check for and install plugin updates (applied on restart)

keybindings.md +396 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Customize keyboard shortcuts

7> Customize keyboard shortcuts in Claude Code with a keybindings configuration file.

9<Note>

10 Customizable keyboard shortcuts require Claude Code v2.1.18 or later. Check your version with `claude --version`.

11</Note>

13Claude Code supports customizable keyboard shortcuts. Run `/keybindings` to create or open your configuration file at `~/.claude/keybindings.json`.

15## Configuration file

17The keybindings configuration file is an object with a `bindings` array. Each block specifies a context and a map of keystrokes to actions.

19<Note>Changes to the keybindings file are automatically detected and applied without restarting Claude Code.</Note>

21| Field | Description |

22| :--------- | :------------------------------------------------- |

23| `$schema` | Optional JSON Schema URL for editor autocompletion |

24| `$docs` | Optional documentation URL |

25| `bindings` | Array of binding blocks by context |

27This example binds `Ctrl+E` to open an external editor in the chat context, and unbinds `Ctrl+U`:

29```json theme={null}

30{

31 "$schema": "https://www.schemastore.org/claude-code-keybindings.json",

32 "$docs": "https://code.claude.com/docs/en/keybindings",

33 "bindings": [

34 {

35 "context": "Chat",

36 "bindings": {

37 "ctrl+e": "chat:externalEditor",

38 "ctrl+u": null

39 }

40 }

41 ]

42}

43```

45## Contexts

47Each binding block specifies a **context** where the bindings apply:

49| Context | Description |

50| :---------------- | :----------------------------------------------- |

51| `Global` | Applies everywhere in the app |

52| `Chat` | Main chat input area |

53| `Autocomplete` | Autocomplete menu is open |

54| `Settings` | Settings menu (escape-only dismiss) |

55| `Confirmation` | Permission and confirmation dialogs |

56| `Tabs` | Tab navigation components |

57| `Help` | Help menu is visible |

58| `Transcript` | Transcript viewer |

59| `HistorySearch` | History search mode (Ctrl+R) |

60| `Task` | Background task is running |

61| `ThemePicker` | Theme picker dialog |

62| `Attachments` | Image/attachment bar navigation |

63| `Footer` | Footer indicator navigation (tasks, teams, diff) |

64| `MessageSelector` | Rewind and summarize dialog message selection |

65| `DiffDialog` | Diff viewer navigation |

66| `ModelPicker` | Model picker effort level |

67| `Select` | Generic select/list components |

68| `Plugin` | Plugin dialog (browse, discover, manage) |

70## Available actions

72Actions follow a `namespace:action` format, such as `chat:submit` to send a message or `app:toggleTodos` to show the task list. Each context has specific actions available.

74### App actions

76Actions available in the `Global` context:

78| Action | Default | Description |

79| :--------------------- | :------ | :-------------------------- |

80| `app:interrupt` | Ctrl+C | Cancel current operation |

81| `app:exit` | Ctrl+D | Exit Claude Code |

82| `app:toggleTodos` | Ctrl+T | Toggle task list visibility |

83| `app:toggleTranscript` | Ctrl+O | Toggle verbose transcript |

85### History actions

87Actions for navigating command history:

89| Action | Default | Description |

90| :----------------- | :------ | :-------------------- |

91| `history:search` | Ctrl+R | Open history search |

92| `history:previous` | Up | Previous history item |

93| `history:next` | Down | Next history item |

95### Chat actions

97Actions available in the `Chat` context:

99| Action | Default | Description |

100| :-------------------- | :------------------------ | :------------------------- |

101| `chat:cancel` | Escape | Cancel current input |

102| `chat:killAgents` | Ctrl+X Ctrl+K | Kill all background agents |

103| `chat:cycleMode` | Shift+Tab\* | Cycle permission modes |

104| `chat:modelPicker` | Cmd+P / Meta+P | Open model picker |

105| `chat:fastMode` | Meta+O | Toggle fast mode |

106| `chat:thinkingToggle` | Cmd+T / Meta+T | Toggle extended thinking |

107| `chat:submit` | Enter | Submit message |

108| `chat:undo` | Ctrl+\_ | Undo last action |

109| `chat:externalEditor` | Ctrl+G, Ctrl+X Ctrl+E | Open in external editor |

110| `chat:stash` | Ctrl+S | Stash current prompt |

111| `chat:imagePaste` | Ctrl+V (Alt+V on Windows) | Paste image |

112

113\*On Windows without VT mode (Node \<24.2.0/\<22.17.0, Bun \<1.2.23), defaults to Meta+M.

114

115### Autocomplete actions

116

117Actions available in the `Autocomplete` context:

118

119| Action | Default | Description |

120| :---------------------- | :------ | :------------------ |

121| `autocomplete:accept` | Tab | Accept suggestion |

122| `autocomplete:dismiss` | Escape | Dismiss menu |

123| `autocomplete:previous` | Up | Previous suggestion |

124| `autocomplete:next` | Down | Next suggestion |

125

126### Confirmation actions

127

128Actions available in the `Confirmation` context:

129

130| Action | Default | Description |

131| :-------------------------- | :-------- | :---------------------------- |

132| `confirm:yes` | Y, Enter | Confirm action |

133| `confirm:no` | N, Escape | Decline action |

134| `confirm:previous` | Up | Previous option |

135| `confirm:next` | Down | Next option |

136| `confirm:nextField` | Tab | Next field |

137| `confirm:previousField` | (unbound) | Previous field |

138| `confirm:cycleMode` | Shift+Tab | Cycle permission modes |

139| `confirm:toggleExplanation` | Ctrl+E | Toggle permission explanation |

140

141### Permission actions

142

143Actions available in the `Confirmation` context for permission dialogs:

144

145| Action | Default | Description |

146| :----------------------- | :------ | :--------------------------- |

147| `permission:toggleDebug` | Ctrl+D | Toggle permission debug info |

148

149### Transcript actions

150

151Actions available in the `Transcript` context:

152

153| Action | Default | Description |

154| :------------------------- | :------------- | :---------------------- |

155| `transcript:toggleShowAll` | Ctrl+E | Toggle show all content |

156| `transcript:exit` | Ctrl+C, Escape | Exit transcript view |

157

158### History search actions

159

160Actions available in the `HistorySearch` context:

161

162| Action | Default | Description |

163| :---------------------- | :---------- | :----------------------- |

164| `historySearch:next` | Ctrl+R | Next match |

165| `historySearch:accept` | Escape, Tab | Accept selection |

166| `historySearch:cancel` | Ctrl+C | Cancel search |

167| `historySearch:execute` | Enter | Execute selected command |

168

169### Task actions

170

171Actions available in the `Task` context:

172

173| Action | Default | Description |

174| :---------------- | :------ | :---------------------- |

175| `task:background` | Ctrl+B | Background current task |

176

177### Theme actions

178

179Actions available in the `ThemePicker` context:

180

181| Action | Default | Description |

182| :------------------------------- | :------ | :------------------------- |

183| `theme:toggleSyntaxHighlighting` | Ctrl+T | Toggle syntax highlighting |

184

185### Help actions

186

187Actions available in the `Help` context:

188

189| Action | Default | Description |

190| :------------- | :------ | :-------------- |

191| `help:dismiss` | Escape | Close help menu |

192

193### Tabs actions

194

195Actions available in the `Tabs` context:

196

197| Action | Default | Description |

198| :-------------- | :-------------- | :----------- |

199| `tabs:next` | Tab, Right | Next tab |

200| `tabs:previous` | Shift+Tab, Left | Previous tab |

201

202### Attachments actions

203

204Actions available in the `Attachments` context:

205

206| Action | Default | Description |

207| :--------------------- | :---------------- | :------------------------- |

208| `attachments:next` | Right | Next attachment |

209| `attachments:previous` | Left | Previous attachment |

210| `attachments:remove` | Backspace, Delete | Remove selected attachment |

211| `attachments:exit` | Down, Escape | Exit attachment bar |

212

213### Footer actions

214

215Actions available in the `Footer` context:

216

217| Action | Default | Description |

218| :---------------------- | :------ | :------------------------ |

219| `footer:next` | Right | Next footer item |

220| `footer:previous` | Left | Previous footer item |

221| `footer:openSelected` | Enter | Open selected footer item |

222| `footer:clearSelection` | Escape | Clear footer selection |

223

224### Message selector actions

225

226Actions available in the `MessageSelector` context:

227

228| Action | Default | Description |

229| :----------------------- | :---------------------------------------- | :---------------- |

230| `messageSelector:up` | Up, K, Ctrl+P | Move up in list |

231| `messageSelector:down` | Down, J, Ctrl+N | Move down in list |

232| `messageSelector:top` | Ctrl+Up, Shift+Up, Meta+Up, Shift+K | Jump to top |

233| `messageSelector:bottom` | Ctrl+Down, Shift+Down, Meta+Down, Shift+J | Jump to bottom |

234| `messageSelector:select` | Enter | Select message |

235

236### Diff actions

237

238Actions available in the `DiffDialog` context:

239

240| Action | Default | Description |

241| :-------------------- | :----------------- | :--------------------- |

242| `diff:dismiss` | Escape | Close diff viewer |

243| `diff:previousSource` | Left | Previous diff source |

244| `diff:nextSource` | Right | Next diff source |

245| `diff:previousFile` | Up | Previous file in diff |

246| `diff:nextFile` | Down | Next file in diff |

247| `diff:viewDetails` | Enter | View diff details |

248| `diff:back` | (context-specific) | Go back in diff viewer |

249

250### Model picker actions

251

252Actions available in the `ModelPicker` context:

253

254| Action | Default | Description |

255| :--------------------------- | :------ | :-------------------- |

256| `modelPicker:decreaseEffort` | Left | Decrease effort level |

257| `modelPicker:increaseEffort` | Right | Increase effort level |

258

259### Select actions

260

261Actions available in the `Select` context:

262

263| Action | Default | Description |

264| :---------------- | :-------------- | :--------------- |

265| `select:next` | Down, J, Ctrl+N | Next option |

266| `select:previous` | Up, K, Ctrl+P | Previous option |

267| `select:accept` | Enter | Accept selection |

268| `select:cancel` | Escape | Cancel selection |

269

270### Plugin actions

271

272Actions available in the `Plugin` context:

273

274| Action | Default | Description |

275| :--------------- | :------ | :----------------------- |

276| `plugin:toggle` | Space | Toggle plugin selection |

277| `plugin:install` | I | Install selected plugins |

278

279### Settings actions

280

281Actions available in the `Settings` context:

282

283| Action | Default | Description |

284| :---------------- | :------ | :---------------------------------- |

285| `settings:search` | / | Enter search mode |

286| `settings:retry` | R | Retry loading usage data (on error) |

287

288### Voice actions

289

290Actions available in the `Chat` context when [voice dictation](/en/voice-dictation) is enabled:

291

292| Action | Default | Description |

293| :----------------- | :------ | :----------------------- |

294| `voice:pushToTalk` | Space | Hold to dictate a prompt |

295

296## Keystroke syntax

297

298### Modifiers

299

300Use modifier keys with the `+` separator:

301

302* `ctrl` or `control` - Control key

303* `alt`, `opt`, or `option` - Alt/Option key

304* `shift` - Shift key

305* `meta`, `cmd`, or `command` - Meta/Command key

306

307For example:

308

309```text theme={null}

310ctrl+k Single key with modifier

311shift+tab Shift + Tab

312meta+p Command/Meta + P

313ctrl+shift+c Multiple modifiers

314```

315

316### Uppercase letters

317

318A standalone uppercase letter implies Shift. For example, `K` is equivalent to `shift+k`. This is useful for vim-style bindings where uppercase and lowercase keys have different meanings.

319

320Uppercase letters with modifiers (e.g., `ctrl+K`) are treated as stylistic and do **not** imply Shift — `ctrl+K` is the same as `ctrl+k`.

321

322### Chords

323

324Chords are sequences of keystrokes separated by spaces:

325

326```text theme={null}

327ctrl+k ctrl+s Press Ctrl+K, release, then Ctrl+S

328```

329

330### Special keys

331

332* `escape` or `esc` - Escape key

333* `enter` or `return` - Enter key

334* `tab` - Tab key

335* `space` - Space bar

336* `up`, `down`, `left`, `right` - Arrow keys

337* `backspace`, `delete` - Delete keys

338

339## Unbind default shortcuts

340

341Set an action to `null` to unbind a default shortcut:

342

343```json theme={null}

344{

345 "bindings": [

346 {

347 "context": "Chat",

348 "bindings": {

349 "ctrl+s": null

350 }

351 }

352 ]

353}

354```

355

356## Reserved shortcuts

357

358These shortcuts cannot be rebound:

359

360| Shortcut | Reason |

361| :------- | :--------------------------------------------- |

362| Ctrl+C | Hardcoded interrupt/cancel |

363| Ctrl+D | Hardcoded exit |

364| Ctrl+M | Identical to Enter in terminals (both send CR) |

365

366## Terminal conflicts

367

368Some shortcuts may conflict with terminal multiplexers:

369

370| Shortcut | Conflict |

371| :------- | :-------------------------------- |

372| Ctrl+B | tmux prefix (press twice to send) |

373| Ctrl+A | GNU screen prefix |

374| Ctrl+Z | Unix process suspend (SIGTSTP) |

375

376## Vim mode interaction

377

378When vim mode is enabled (`/vim`), keybindings and vim mode operate independently:

379

380* **Vim mode** handles input at the text input level (cursor movement, modes, motions)

381* **Keybindings** handle actions at the component level (toggle todos, submit, etc.)

382* The Escape key in vim mode switches INSERT to NORMAL mode; it does not trigger `chat:cancel`

383* Most Ctrl+key shortcuts pass through vim mode to the keybinding system

384* In vim NORMAL mode, `?` shows the help menu (vim behavior)

385

386## Validation

387

388Claude Code validates your keybindings and shows warnings for:

389

390* Parse errors (invalid JSON or structure)

391* Invalid context names

392* Reserved shortcut conflicts

393* Terminal multiplexer conflicts

394* Duplicate bindings in the same context

395

396Run `/doctor` to see any keybinding warnings.

legal-and-compliance.md +23 −2

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Legal and compliance5# Legal and compliance

2 6

3> Legal agreements, compliance certifications, and security information for Claude Code.7> Legal agreements, compliance certifications, and security information for Claude Code.

9Your use of Claude Code is subject to:13Your use of Claude Code is subject to:

10 14

11* [Commercial Terms](https://www.anthropic.com/legal/commercial-terms) - for Team, Enterprise, and Claude API users15* [Commercial Terms](https://www.anthropic.com/legal/commercial-terms) - for Team, Enterprise, and Claude API users

~~12* [Consumer Terms](https://www.anthropic.com/legal/consumer-terms) - for Free, Pro, and Max users~~16* [Consumer Terms of Service](https://www.anthropic.com/legal/consumer-terms) - for Free, Pro, and Max users

13 17

14### Commercial agreements18### Commercial agreements

15 19

19 23

20### Healthcare compliance (BAA)24### Healthcare compliance (BAA)

21 25

22If a customer has a Business Associate Agreement (BAA) with us, and wants to use Claude Code, the BAA will automatically extend to cover Claude Code if the customer has executed a BAA and has Zero Data Retention (ZDR) activated. The BAA will be applicable to that customer's API traffic flowing through Claude Code.26If a customer has a Business Associate Agreement (BAA) with us, and wants to use Claude Code, the BAA will automatically extend to cover Claude Code if the customer has executed a BAA and has [Zero Data Retention (ZDR)](/en/zero-data-retention) activated. The BAA will be applicable to that customer's API traffic flowing through Claude Code. ZDR is enabled on a per-organization basis, so each organization must have ZDR enabled separately to be covered under the BAA.

28## Usage policy

30### Acceptable use

32Claude Code usage is subject to the [Anthropic Usage Policy](https://www.anthropic.com/legal/aup). Advertised usage limits for Pro and Max plans assume ordinary, individual usage of Claude Code and the Agent SDK.

34### Authentication and credential use

36Claude Code authenticates with Anthropic's servers using OAuth tokens or API keys. These authentication methods serve different purposes:

38* **OAuth authentication** (used with Free, Pro, and Max plans) is intended exclusively for Claude Code and Claude.ai. Using OAuth tokens obtained through Claude Free, Pro, or Max accounts in any other product, tool, or service — including the [Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview) — is not permitted and constitutes a violation of the [Consumer Terms of Service](https://www.anthropic.com/legal/consumer-terms).

39* **Developers** building products or services that interact with Claude's capabilities, including those using the [Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview), should use API key authentication through [Claude Console](https://platform.claude.com/) or a supported cloud provider. Anthropic does not permit third-party developers to offer Claude.ai login or to route requests through Free, Pro, or Max plan credentials on behalf of their users.

41Anthropic reserves the right to take measures to enforce these restrictions and may do so without prior notice.

43For questions about permitted authentication methods for your use case, please [contact sales](https://www.anthropic.com/contact-sales?utm_source=claude_code\&utm_medium=docs\&utm_content=legal_compliance_contact_sales).

23 44

24## Security and trust45## Security and trust

25 46

llm-gateway.md +12 −2

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# LLM gateway configuration5# LLM gateway configuration

2 6

3> Learn how to configure Claude Code to work with LLM gateway solutions. Covers gateway requirements, authentication configuration, model selection, and provider-specific endpoint setup.7> Learn how to configure Claude Code to work with LLM gateway solutions. Covers gateway requirements, authentication configuration, model selection, and provider-specific endpoint setup.

43 47

44## LiteLLM configuration48## LiteLLM configuration

45 49

~~46<Note>~~50<Warning>

51 LiteLLM PyPI versions 1.82.7 and 1.82.8 were compromised with credential-stealing malware. Do not install these versions. If you have already installed them:

53 * Remove the package

54 * Rotate all credentials on affected systems

55 * Follow the remediation steps in [BerriAI/litellm#24518](https://github.com/BerriAI/litellm/issues/24518)

47 LiteLLM is a third-party proxy service. Anthropic doesn't endorse, maintain, or audit LiteLLM's security or functionality. This guide is provided for informational purposes and may become outdated. Use at your own discretion.57 LiteLLM is a third-party proxy service. Anthropic doesn't endorse, maintain, or audit LiteLLM's security or functionality. This guide is provided for informational purposes and may become outdated. Use at your own discretion.

~~48</Note>~~58</Warning>

49 59

50### Prerequisites60### Prerequisites

51 61

mcp.md +543 −82

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Connect Claude Code to tools via MCP5# Connect Claude Code to tools via MCP

2 6

3> Learn how to connect Claude Code to your tools with the Model Context Protocol.7> Learn how to connect Claude Code to your tools with the Model Context Protocol.

4 8

5Claude Code can connect to hundreds of external tools and data sources through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction), an open-source standard for AI-tool integrations. MCP servers give Claude Code access to your tools, databases, and APIs.9

10Claude Code can connect to hundreds of external tools and data sources through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction), an open source standard for AI-tool integrations. MCP servers give Claude Code access to your tools, databases, and APIs.

6 11

7## What you can do with MCP12## What you can do with MCP

8 13

10 15

11* **Implement features from issue trackers**: "Add the feature described in JIRA issue ENG-4521 and create a PR on GitHub."16* **Implement features from issue trackers**: "Add the feature described in JIRA issue ENG-4521 and create a PR on GitHub."

12* **Analyze monitoring data**: "Check Sentry and Statsig to check the usage of the feature described in ENG-4521."17* **Analyze monitoring data**: "Check Sentry and Statsig to check the usage of the feature described in ENG-4521."

~~13* **Query databases**: "Find emails of 10 random users who used feature ENG-4521, based on our Postgres database."~~18* **Query databases**: "Find emails of 10 random users who used feature ENG-4521, based on our PostgreSQL database."

14* **Integrate designs**: "Update our standard email template based on the new Figma designs that were posted in Slack"19* **Integrate designs**: "Update our standard email template based on the new Figma designs that were posted in Slack"

15* **Automate workflows**: "Create Gmail drafts inviting these 10 users to a feedback session about the new feature."20* **Automate workflows**: "Create Gmail drafts inviting these 10 users to a feedback session about the new feature."

21* **React to external events**: An MCP server can also act as a [channel](/en/channels) that pushes messages into your session, so Claude reacts to Telegram messages, Discord chats, or webhook events while you're away.

16 22

17## Popular MCP servers23## Popular MCP servers

18 24

76 82

77```bash theme={null}83```bash theme={null}

78# Basic syntax84# Basic syntax

~~79claude mcp add --transport stdio <name> <command> [args...]~~85claude mcp add [options] <name> -- <command> [args...]

80 86

81# Real example: Add Airtable server87# Real example: Add Airtable server

~~82claude mcp add --transport stdio airtable --env AIRTABLE_API_KEY=YOUR_KEY \~~88claude mcp add --transport stdio --env AIRTABLE_API_KEY=YOUR_KEY airtable \

83 -- npx -y airtable-mcp-server89 -- npx -y airtable-mcp-server

84```90```

85 91

86<Note>92<Note>

~~87 **Understanding the "--" parameter:**~~93 **Important: Option ordering**

88 The `--` (double dash) separates Claude's own CLI flags from the command and arguments that get passed to the MCP server. Everything before `--` are options for Claude (like `--env`, `--scope`), and everything after `--` is the actual command to run the MCP server.94

95 All options (`--transport`, `--env`, `--scope`, `--header`) must come **before** the server name. The `--` (double dash) then separates the server name from the command and arguments that get passed to the MCP server.

89 96

90 For example:97 For example:

91 98

92 * `claude mcp add --transport stdio myserver -- npx server` → runs `npx server`99 * `claude mcp add --transport stdio myserver -- npx server` → runs `npx server`

~~93 * `claude mcp add --transport stdio myserver --env KEY=value -- python server.py --port 8080` → runs `python server.py --port 8080` with `KEY=value` in environment~~100 * `claude mcp add --transport stdio --env KEY=value myserver -- python server.py --port 8080` → runs `python server.py --port 8080` with `KEY=value` in environment

94 101

95 This prevents conflicts between Claude's flags and the server's flags.102 This prevents conflicts between Claude's flags and the server's flags.

96</Note>103</Note>

113/mcp120/mcp

114```121```

115 122

123### Dynamic tool updates

124

125Claude Code supports MCP `list_changed` notifications, allowing MCP servers to dynamically update their available tools, prompts, and resources without requiring you to disconnect and reconnect. When an MCP server sends a `list_changed` notification, Claude Code automatically refreshes the available capabilities from that server.

126

127### Push messages with channels

128

129An MCP server can also push messages directly into your session so Claude can react to external events like CI results, monitoring alerts, or chat messages. To enable this, your server declares the `claude/channel` capability and you opt it in with the `--channels` flag at startup. See [Channels](/en/channels) to use an officially supported channel, or [Channels reference](/en/channels-reference) to build your own.

130

116<Tip>131<Tip>

117 Tips:132 Tips:

118 133

120 * `local` (default): Available only to you in the current project (was called `project` in older versions)135 * `local` (default): Available only to you in the current project (was called `project` in older versions)

121 * `project`: Shared with everyone in the project via `.mcp.json` file136 * `project`: Shared with everyone in the project via `.mcp.json` file

122 * `user`: Available to you across all projects (was called `global` in older versions)137 * `user`: Available to you across all projects (was called `global` in older versions)

123 * Set environment variables with `--env` flags (e.g., `--env KEY=value`)138 * Set environment variables with `--env` flags (for example, `--env KEY=value`)

124 * Configure MCP server startup timeout using the MCP\_TIMEOUT environment variable (e.g., `MCP_TIMEOUT=10000 claude` sets a 10-second timeout)139 * Configure MCP server startup timeout using the MCP\_TIMEOUT environment variable (for example, `MCP_TIMEOUT=10000 claude` sets a 10-second timeout)

125 * Claude Code will display a warning when MCP tool output exceeds 10,000 tokens. To increase this limit, set the `MAX_MCP_OUTPUT_TOKENS` environment variable (e.g., `MAX_MCP_OUTPUT_TOKENS=50000`)140 * Claude Code will display a warning when MCP tool output exceeds 10,000 tokens. To increase this limit, set the `MAX_MCP_OUTPUT_TOKENS` environment variable (for example, `MAX_MCP_OUTPUT_TOKENS=50000`)

126 * Use `/mcp` to authenticate with remote servers that require OAuth 2.0 authentication141 * Use `/mcp` to authenticate with remote servers that require OAuth 2.0 authentication

127</Tip>142</Tip>

128 143

154 169

155```json theme={null}170```json theme={null}

156{171{

172 "mcpServers": {

157 "database-tools": {173 "database-tools": {

158 "command": "${CLAUDE_PLUGIN_ROOT}/servers/db-server",174 "command": "${CLAUDE_PLUGIN_ROOT}/servers/db-server",

159 "args": ["--config", "${CLAUDE_PLUGIN_ROOT}/config.json"],175 "args": ["--config", "${CLAUDE_PLUGIN_ROOT}/config.json"],

161 "DB_URL": "${DB_URL}"177 "DB_URL": "${DB_URL}"

162 }178 }

163 }179 }

180 }

164}181}

165```182```

166 183

180 197

181**Plugin MCP features**:198**Plugin MCP features**:

182 199

183* **Automatic lifecycle**: Servers start when plugin enables, but you must restart Claude Code to apply MCP server changes (enabling or disabling)200* **Automatic lifecycle**: At session startup, servers for enabled plugins connect automatically. If you enable or disable a plugin during a session, run `/reload-plugins` to connect or disconnect its MCP servers

184* **Environment variables**: Use `${CLAUDE_PLUGIN_ROOT}` for plugin-relative paths201* **Environment variables**: use `${CLAUDE_PLUGIN_ROOT}` for bundled plugin files and `${CLAUDE_PLUGIN_DATA}` for [persistent state](/en/plugins-reference#persistent-data-directory) that survives plugin updates

185* **User environment access**: Access to same environment variables as manually configured servers202* **User environment access**: Access to same environment variables as manually configured servers

186* **Multiple transport types**: Support stdio, SSE, and HTTP transports (transport support may vary by server)203* **Multiple transport types**: Support stdio, SSE, and HTTP transports (transport support may vary by server)

187 204

208 225

209### Local scope226### Local scope

210 227

211Local-scoped servers represent the default configuration level and are stored in your project-specific user settings. These servers remain private to you and are only accessible when working within the current project directory. This scope is ideal for personal development servers, experimental configurations, or servers containing sensitive credentials that shouldn't be shared.228Local-scoped servers represent the default configuration level and are stored in `~/.claude.json` under your project's path. These servers remain private to you and are only accessible when working within the current project directory. This scope is ideal for personal development servers, experimental configurations, or servers containing sensitive credentials that shouldn't be shared.

229

230<Note>

231 The term "local scope" for MCP servers differs from general local settings. MCP local-scoped servers are stored in `~/.claude.json` (your home directory), while general local settings use `.claude/settings.local.json` (in the project directory). See [Settings](/en/settings#settings-files) for details on settings file locations.

232</Note>

212 233

213```bash theme={null}234```bash theme={null}

214# Add a local-scoped server (default)235# Add a local-scoped server (default)

245 266

246### User scope267### User scope

247 268

248User-scoped servers provide cross-project accessibility, making them available across all projects on your machine while remaining private to your user account. This scope works well for personal utility servers, development tools, or services you frequently use across different projects.269User-scoped servers are stored in `~/.claude.json` and provide cross-project accessibility, making them available across all projects on your machine while remaining private to your user account. This scope works well for personal utility servers, development tools, or services you frequently use across different projects.

249 270

250```bash theme={null}271```bash theme={null}

251# Add a user server272# Add a user server

258 279

259* **Local scope**: Personal servers, experimental configurations, or sensitive credentials specific to one project280* **Local scope**: Personal servers, experimental configurations, or sensitive credentials specific to one project

260* **Project scope**: Team-shared servers, project-specific tools, or services required for collaboration281* **Project scope**: Team-shared servers, project-specific tools, or services required for collaboration

261* **User scope**: Personal utilities needed across multiple projects, development tools, or frequently-used services282* **User scope**: Personal utilities needed across multiple projects, development tools, or frequently used services

283

284<Note>

285 **Where are MCP servers stored?**

286

287 * **User and local scope**: `~/.claude.json` (in the `mcpServers` field or under project paths)

288 * **Project scope**: `.mcp.json` in your project root (checked into source control)

289 * **Managed**: `managed-mcp.json` in system directories (see [Managed MCP configuration](#managed-mcp-configuration))

290</Note>

262 291

263### Scope hierarchy and precedence292### Scope hierarchy and precedence

264 293

305{/* ### Example: Automate browser testing with Playwright334{/* ### Example: Automate browser testing with Playwright

306 335

307 ```bash336 ```bash

308 # 1. Add the Playwright MCP server

309 claude mcp add --transport stdio playwright -- npx -y @playwright/mcp@latest337 claude mcp add --transport stdio playwright -- npx -y @playwright/mcp@latest

338 ```

339

340 Then write and run browser tests:

310 341

311 # 2. Write and run browser tests342 ```text

312 > "Test if the login flow works with test@example.com"343 Test if the login flow works with test@example.com

313 > "Take a screenshot of the checkout page on mobile"344 ```

314 > "Verify that the search feature returns results"345 ```text

346 Take a screenshot of the checkout page on mobile

347 ```

348 ```text

349 Verify that the search feature returns results

315 ``` */}350 ``` */}

316 351

317### Example: Monitor errors with Sentry352### Example: Monitor errors with Sentry

318 353

319```bash theme={null}354```bash theme={null}

320# 1. Add the Sentry MCP server

321claude mcp add --transport http sentry https://mcp.sentry.dev/mcp355claude mcp add --transport http sentry https://mcp.sentry.dev/mcp

356```

322 357

323# 2. Use /mcp to authenticate with your Sentry account358Authenticate with your Sentry account:

324> /mcp

325 359

326# 3. Debug production issues360```text theme={null}

327> "What are the most common errors in the last 24 hours?"361/mcp

328> "Show me the stack trace for error ID abc123"362```

329> "Which deployment introduced these new errors?"363

364Then debug production issues:

365

366```text theme={null}

367What are the most common errors in the last 24 hours?

368```

369

370```text theme={null}

371Show me the stack trace for error ID abc123

372```

373

374```text theme={null}

375Which deployment introduced these new errors?

330```376```

331 377

332### Example: Connect to GitHub for code reviews378### Example: Connect to GitHub for code reviews

333 379

334```bash theme={null}380```bash theme={null}

335# 1. Add the GitHub MCP server

336claude mcp add --transport http github https://api.githubcopilot.com/mcp/381claude mcp add --transport http github https://api.githubcopilot.com/mcp/

382```

383

384Authenticate if needed by selecting "Authenticate" for GitHub:

337 385

338# 2. In Claude Code, authenticate if needed386```text theme={null}

339> /mcp387/mcp

340# Select "Authenticate" for GitHub388```

389

390Then work with GitHub:

391

392```text theme={null}

393Review PR #456 and suggest improvements

394```

395

396```text theme={null}

397Create a new issue for the bug we just found

398```

341 399

342# 3. Now you can ask Claude to work with GitHub400```text theme={null}

343> "Review PR #456 and suggest improvements"401Show me all open PRs assigned to me

344> "Create a new issue for the bug we just found"

345> "Show me all open PRs assigned to me"

346```402```

347 403

348### Example: Query your PostgreSQL database404### Example: Query your PostgreSQL database

349 405

350```bash theme={null}406```bash theme={null}

351# 1. Add the database server with your connection string

352claude mcp add --transport stdio db -- npx -y @bytebase/dbhub \407claude mcp add --transport stdio db -- npx -y @bytebase/dbhub \

353 --dsn "postgresql://readonly:pass@prod.db.com:5432/analytics"408 --dsn "postgresql://readonly:pass@prod.db.com:5432/analytics"

409```

354 410

355# 2. Query your database naturally411Then query your database naturally:

356> "What's our total revenue this month?"412

357> "Show me the schema for the orders table"413```text theme={null}

358> "Find customers who haven't made a purchase in 90 days"414What's our total revenue this month?

415```

416

417```text theme={null}

418Show me the schema for the orders table

419```

420

421```text theme={null}

422Find customers who haven't made a purchase in 90 days

359```423```

360 424

361## Authenticate with remote MCP servers425## Authenticate with remote MCP servers

374 <Step title="Use the /mcp command within Claude Code">438 <Step title="Use the /mcp command within Claude Code">

375 In Claude code, use the command:439 In Claude code, use the command:

376 440

377 ```441 ```text theme={null}

378 > /mcp442 /mcp

379 ```443 ```

380 444

381 Then follow the steps in your browser to login.445 Then follow the steps in your browser to login.

387 451

388 * Authentication tokens are stored securely and refreshed automatically452 * Authentication tokens are stored securely and refreshed automatically

389 * Use "Clear authentication" in the `/mcp` menu to revoke access453 * Use "Clear authentication" in the `/mcp` menu to revoke access

390 * If your browser doesn't open automatically, copy the provided URL454 * If your browser doesn't open automatically, copy the provided URL and open it manually

455 * If the browser redirect fails with a connection error after authenticating, paste the full callback URL from your browser's address bar into the URL prompt that appears in Claude Code

391 * OAuth authentication works with HTTP servers456 * OAuth authentication works with HTTP servers

392</Tip>457</Tip>

393 458

459### Use a fixed OAuth callback port

460

461Some MCP servers require a specific redirect URI registered in advance. By default, Claude Code picks a random available port for the OAuth callback. Use `--callback-port` to fix the port so it matches a pre-registered redirect URI of the form `http://localhost:PORT/callback`.

462

463You can use `--callback-port` on its own (with dynamic client registration) or together with `--client-id` (with pre-configured credentials).

464

465```bash theme={null}

466# Fixed callback port with dynamic client registration

467claude mcp add --transport http \

468 --callback-port 8080 \

469 my-server https://mcp.example.com/mcp

470```

471

472### Use pre-configured OAuth credentials

473

474Some MCP servers don't support automatic OAuth setup via Dynamic Client Registration. If you see an error like "Incompatible auth server: does not support dynamic client registration," the server requires pre-configured credentials. Claude Code also supports servers that use a Client ID Metadata Document (CIMD) instead of Dynamic Client Registration, and discovers these automatically. If automatic discovery fails, register an OAuth app through the server's developer portal first, then provide the credentials when adding the server.

475

476<Steps>

477 <Step title="Register an OAuth app with the server">

478 Create an app through the server's developer portal and note your client ID and client secret.

479

480 Many servers also require a redirect URI. If so, choose a port and register a redirect URI in the format `http://localhost:PORT/callback`. Use that same port with `--callback-port` in the next step.

481 </Step>

482

483 <Step title="Add the server with your credentials">

484 Choose one of the following methods. The port used for `--callback-port` can be any available port. It just needs to match the redirect URI you registered in the previous step.

485

486 <Tabs>

487 <Tab title="claude mcp add">

488 Use `--client-id` to pass your app's client ID. The `--client-secret` flag prompts for the secret with masked input:

489

490 ```bash theme={null}

491 claude mcp add --transport http \

492 --client-id your-client-id --client-secret --callback-port 8080 \

493 my-server https://mcp.example.com/mcp

494 ```

495 </Tab>

496

497 <Tab title="claude mcp add-json">

498 Include the `oauth` object in the JSON config and pass `--client-secret` as a separate flag:

499

500 ```bash theme={null}

501 claude mcp add-json my-server \

502 '{"type":"http","url":"https://mcp.example.com/mcp","oauth":{"clientId":"your-client-id","callbackPort":8080}}' \

503 --client-secret

504 ```

505 </Tab>

506

507 <Tab title="claude mcp add-json (callback port only)">

508 Use `--callback-port` without a client ID to fix the port while using dynamic client registration:

509

510 ```bash theme={null}

511 claude mcp add-json my-server \

512 '{"type":"http","url":"https://mcp.example.com/mcp","oauth":{"callbackPort":8080}}'

513 ```

514 </Tab>

515

516 <Tab title="CI / env var">

517 Set the secret via environment variable to skip the interactive prompt:

518

519 ```bash theme={null}

520 MCP_CLIENT_SECRET=your-secret claude mcp add --transport http \

521 --client-id your-client-id --client-secret --callback-port 8080 \

522 my-server https://mcp.example.com/mcp

523 ```

524 </Tab>

525 </Tabs>

526 </Step>

527

528 <Step title="Authenticate in Claude Code">

529 Run `/mcp` in Claude Code and follow the browser login flow.

530 </Step>

531</Steps>

532

533<Tip>

534 Tips:

535

536 * The client secret is stored securely in your system keychain (macOS) or a credentials file, not in your config

537 * If the server uses a public OAuth client with no secret, use only `--client-id` without `--client-secret`

538 * `--callback-port` can be used with or without `--client-id`

539 * These flags only apply to HTTP and SSE transports. They have no effect on stdio servers

540 * Use `claude mcp get <name>` to verify that OAuth credentials are configured for a server

541</Tip>

542

543### Override OAuth metadata discovery

544

545If your MCP server returns errors on the standard OAuth metadata endpoint (`/.well-known/oauth-authorization-server`) but exposes a working OIDC endpoint, you can tell Claude Code to fetch OAuth metadata directly from a URL you specify, bypassing the standard discovery chain.

546

547Set `authServerMetadataUrl` in the `oauth` object of your server's config in `.mcp.json`:

548

549```json theme={null}

550{

551 "mcpServers": {

552 "my-server": {

553 "type": "http",

554 "url": "https://mcp.example.com/mcp",

555 "oauth": {

556 "authServerMetadataUrl": "https://auth.example.com/.well-known/openid-configuration"

557 }

558 }

559 }

560}

561```

562

563The URL must use `https://`. This option requires Claude Code v2.1.64 or later.

564

565### Use dynamic headers for custom authentication

566

567If your MCP server uses an authentication scheme other than OAuth (such as Kerberos, short-lived tokens, or an internal SSO), use `headersHelper` to generate request headers at connection time. Claude Code runs the command and merges its output into the connection headers.

568

569```json theme={null}

570{

571 "mcpServers": {

572 "internal-api": {

573 "type": "http",

574 "url": "https://mcp.internal.example.com",

575 "headersHelper": "/opt/bin/get-mcp-auth-headers.sh"

576 }

577 }

578}

579```

580

581The command can also be inline:

582

583```json theme={null}

584{

585 "mcpServers": {

586 "internal-api": {

587 "type": "http",

588 "url": "https://mcp.internal.example.com",

589 "headersHelper": "echo '{\"Authorization\": \"Bearer '\"$(get-token)\"'\"}'"

590 }

591 }

592}

593```

594

595**Requirements:**

596

597* The command must write a JSON object of string key-value pairs to stdout

598* The command runs in a shell with a 10-second timeout

599* Dynamic headers override any static `headers` with the same name

600

601The helper runs fresh on each connection (at session start and on reconnect). There is no caching, so your script is responsible for any token reuse.

602

603<Note>

604 `headersHelper` executes arbitrary shell commands. When defined at project or local scope, it only runs after you accept the workspace trust dialog.

605</Note>

606

394## Add MCP servers from JSON configuration607## Add MCP servers from JSON configuration

395 608

396If you have a JSON configuration for an MCP server, you can add it directly:609If you have a JSON configuration for an MCP server, you can add it directly:

406 619

407 # Example: Adding a stdio server with JSON configuration620 # Example: Adding a stdio server with JSON configuration

408 claude mcp add-json local-weather '{"type":"stdio","command":"/path/to/weather-cli","args":["--api-key","abc123"],"env":{"CACHE_DIR":"/tmp"}}'621 claude mcp add-json local-weather '{"type":"stdio","command":"/path/to/weather-cli","args":["--api-key","abc123"],"env":{"CACHE_DIR":"/tmp"}}'

622

623 # Example: Adding an HTTP server with pre-configured OAuth credentials

624 claude mcp add-json my-server '{"type":"http","url":"https://mcp.example.com/mcp","oauth":{"clientId":"your-client-id","callbackPort":8080}}' --client-secret

409 ```625 ```

410 </Step>626 </Step>

411 627

454 * It reads the Claude Desktop configuration file from its standard location on those platforms670 * It reads the Claude Desktop configuration file from its standard location on those platforms

455 * Use the `--scope user` flag to add servers to your user configuration671 * Use the `--scope user` flag to add servers to your user configuration

456 * Imported servers will have the same names as in Claude Desktop672 * Imported servers will have the same names as in Claude Desktop

457 * If servers with the same names already exist, they will get a numerical suffix (e.g., `server_1`)673 * If servers with the same names already exist, they will get a numerical suffix (for example, `server_1`)

458</Tip>674</Tip>

459 675

676## Use MCP servers from Claude.ai

677

678If you've logged into Claude Code with a [Claude.ai](https://claude.ai) account, MCP servers you've added in Claude.ai are automatically available in Claude Code:

679

680<Steps>

681 <Step title="Configure MCP servers in Claude.ai">

682 Add servers at [claude.ai/settings/connectors](https://claude.ai/settings/connectors). On Team and Enterprise plans, only admins can add servers.

683 </Step>

684

685 <Step title="Authenticate the MCP server">

686 Complete any required authentication steps in Claude.ai.

687 </Step>

688

689 <Step title="View and manage servers in Claude Code">

690 In Claude Code, use the command:

691

692 ```text theme={null}

693 /mcp

694 ```

695

696 Claude.ai servers appear in the list with indicators showing they come from Claude.ai.

697 </Step>

698</Steps>

699

700To disable claude.ai MCP servers in Claude Code, set the `ENABLE_CLAUDEAI_MCP_SERVERS` environment variable to `false`:

701

702```bash theme={null}

703ENABLE_CLAUDEAI_MCP_SERVERS=false claude

704```

705

460## Use Claude Code as an MCP server706## Use Claude Code as an MCP server

461 707

462You can use Claude Code itself as an MCP server that other applications can connect to:708You can use Claude Code itself as an MCP server that other applications can connect to:

513 759

514 * The server provides access to Claude's tools like View, Edit, LS, etc.760 * The server provides access to Claude's tools like View, Edit, LS, etc.

515 * In Claude Desktop, try asking Claude to read files in a directory, make edits, and more.761 * In Claude Desktop, try asking Claude to read files in a directory, make edits, and more.

516 * Note that this MCP server is simply exposing Claude Code's tools to your MCP client, so your own client is responsible for implementing user confirmation for individual tool calls.762 * Note that this MCP server is only exposing Claude Code's tools to your MCP client, so your own client is responsible for implementing user confirmation for individual tool calls.

517</Tip>763</Tip>

518 764

519## MCP output limits and warnings765## MCP output limits and warnings

542 If you frequently encounter output warnings with specific MCP servers, consider increasing the limit or configuring the server to paginate or filter its responses.788 If you frequently encounter output warnings with specific MCP servers, consider increasing the limit or configuring the server to paginate or filter its responses.

543</Warning>789</Warning>

544 790

791## Respond to MCP elicitation requests

792

793MCP servers can request structured input from you mid-task using elicitation. When a server needs information it can't get on its own, Claude Code displays an interactive dialog and passes your response back to the server. No configuration is required on your side: elicitation dialogs appear automatically when a server requests them.

794

795Servers can request input in two ways:

796

797* **Form mode**: Claude Code shows a dialog with form fields defined by the server (for example, a username and password prompt). Fill in the fields and submit.

798* **URL mode**: Claude Code opens a browser URL for authentication or approval. Complete the flow in the browser, then confirm in the CLI.

799

800To auto-respond to elicitation requests without showing a dialog, use the [`Elicitation` hook](/en/hooks#elicitation).

801

802If you're building an MCP server that uses elicitation, see the [MCP elicitation specification](https://modelcontextprotocol.io/docs/learn/client-concepts#elicitation) for protocol details and schema examples.

803

545## Use MCP resources804## Use MCP resources

546 805

547MCP servers can expose resources that you can reference using @ mentions, similar to how you reference files.806MCP servers can expose resources that you can reference using @ mentions, similar to how you reference files.

556 <Step title="Reference a specific resource">815 <Step title="Reference a specific resource">

557 Use the format `@server:protocol://resource/path` to reference a resource:816 Use the format `@server:protocol://resource/path` to reference a resource:

558 817

559 ```818 ```text theme={null}

560 > Can you analyze @github:issue://123 and suggest a fix?819 Can you analyze @github:issue://123 and suggest a fix?

561 ```820 ```

562 821

563 ```822 ```text theme={null}

564 > Please review the API documentation at @docs:file://api/authentication823 Please review the API documentation at @docs:file://api/authentication

565 ```824 ```

566 </Step>825 </Step>

567 826

568 <Step title="Multiple resource references">827 <Step title="Multiple resource references">

569 You can reference multiple resources in a single prompt:828 You can reference multiple resources in a single prompt:

570 829

571 ```830 ```text theme={null}

572 > Compare @postgres:schema://users with @docs:file://database/user-model831 Compare @postgres:schema://users with @docs:file://database/user-model

573 ```832 ```

574 </Step>833 </Step>

575</Steps>834</Steps>

583 * Resources can contain any type of content that the MCP server provides (text, JSON, structured data, etc.)842 * Resources can contain any type of content that the MCP server provides (text, JSON, structured data, etc.)

584</Tip>843</Tip>

585 844

586## Use MCP prompts as slash commands845## Scale with MCP Tool Search

846

847When you have many MCP servers configured, tool definitions can consume a significant portion of your context window. MCP Tool Search solves this by dynamically loading tools on-demand instead of preloading all of them.

848

849### How it works

850

851Claude Code automatically enables Tool Search when your MCP tool descriptions would consume more than 10% of the context window. You can [adjust this threshold](#configure-tool-search) or disable tool search entirely. When triggered:

852

8531. MCP tools are deferred rather than loaded into context upfront

8542. Claude uses a search tool to discover relevant MCP tools when needed

8553. Only the tools Claude actually needs are loaded into context

8564. MCP tools continue to work exactly as before from your perspective

587 857

588MCP servers can expose prompts that become available as slash commands in Claude Code.858### For MCP server authors

859

860If you're building an MCP server, the server instructions field becomes more useful with Tool Search enabled. Server instructions help Claude understand when to search for your tools, similar to how [skills](/en/skills) work.

861

862Add clear, descriptive server instructions that explain:

863

864* What category of tasks your tools handle

865* When Claude should search for your tools

866* Key capabilities your server provides

867

868### Configure tool search

869

870Tool search is enabled by default: MCP tools are deferred and discovered on demand. When `ANTHROPIC_BASE_URL` points to a non-first-party host, tool search is disabled by default because most proxies do not forward `tool_reference` blocks. Set `ENABLE_TOOL_SEARCH` explicitly if your proxy does. This feature requires models that support `tool_reference` blocks: Sonnet 4 and later, or Opus 4 and later. Haiku models do not support tool search.

871

872Control tool search behavior with the `ENABLE_TOOL_SEARCH` environment variable:

873

874| Value | Behavior |

875| :--------- | :--------------------------------------------------------------------------------- |

876| (unset) | Enabled by default. Disabled when `ANTHROPIC_BASE_URL` is a non-first-party host |

877| `true` | Always enabled, including for non-first-party `ANTHROPIC_BASE_URL` |

878| `auto` | Activates when MCP tools exceed 10% of context |

879| `auto:<N>` | Activates at custom threshold, where `<N>` is a percentage (e.g., `auto:5` for 5%) |

880| `false` | Disabled, all MCP tools loaded upfront |

881

882```bash theme={null}

883# Use a custom 5% threshold

884ENABLE_TOOL_SEARCH=auto:5 claude

885

886# Disable tool search entirely

887ENABLE_TOOL_SEARCH=false claude

888```

889

890Or set the value in your [settings.json `env` field](/en/settings#available-settings).

891

892You can also disable the MCPSearch tool specifically using the `disallowedTools` setting:

893

894```json theme={null}

895{

896 "permissions": {

897 "deny": ["MCPSearch"]

898 }

899}

900```

901

902## Use MCP prompts as commands

903

904MCP servers can expose prompts that become available as commands in Claude Code.

589 905

590### Execute MCP prompts906### Execute MCP prompts

591 907

595 </Step>911 </Step>

596 912

597 <Step title="Execute a prompt without arguments">913 <Step title="Execute a prompt without arguments">

598 ```914 ```text theme={null}

599 > /mcp__github__list_prs915 /mcp__github__list_prs

600 ```916 ```

601 </Step>917 </Step>

602 918

603 <Step title="Execute a prompt with arguments">919 <Step title="Execute a prompt with arguments">

604 Many prompts accept arguments. Pass them space-separated after the command:920 Many prompts accept arguments. Pass them space-separated after the command:

605 921

606 ```922 ```text theme={null}

607 > /mcp__github__pr_review 456923 /mcp__github__pr_review 456

608 ```924 ```

609 925

610 ```926 ```text theme={null}

611 > /mcp__jira__create_issue "Bug in login flow" high927 /mcp__jira__create_issue "Bug in login flow" high

612 ```928 ```

613 </Step>929 </Step>

614</Steps>930</Steps>

622 * Server and prompt names are normalized (spaces become underscores)938 * Server and prompt names are normalized (spaces become underscores)

623</Tip>939</Tip>

624 940

625## Enterprise MCP configuration941## Managed MCP configuration

626 942

627For organizations that need centralized control over MCP servers, Claude Code supports enterprise-managed MCP configurations. This allows IT administrators to:943For organizations that need centralized control over MCP servers, Claude Code supports two configuration options:

944

9451. **Exclusive control with `managed-mcp.json`**: Deploy a fixed set of MCP servers that users cannot modify or extend

9462. **Policy-based control with allowlists/denylists**: Allow users to add their own servers, but restrict which ones are permitted

947

948These options allow IT administrators to:

628 949

629* **Control which MCP servers employees can access**: Deploy a standardized set of approved MCP servers across the organization950* **Control which MCP servers employees can access**: Deploy a standardized set of approved MCP servers across the organization

630* **Prevent unauthorized MCP servers**: Optionally restrict users from adding their own MCP servers951* **Prevent unauthorized MCP servers**: Restrict users from adding unapproved MCP servers

631* **Disable MCP entirely**: Remove MCP functionality completely if needed952* **Disable MCP entirely**: Remove MCP functionality completely if needed

632 953

633### Setting up enterprise MCP configuration954### Option 1: Exclusive control with managed-mcp.json

634 955

635System administrators can deploy an enterprise MCP configuration file alongside the managed settings file:956When you deploy a `managed-mcp.json` file, it takes **exclusive control** over all MCP servers. Users cannot add, modify, or use any MCP servers other than those defined in this file. This is the simplest approach for organizations that want complete control.

636 957

637* **macOS**: `/Library/Application Support/ClaudeCode/managed-mcp.json`958System administrators deploy the configuration file to a system-wide directory:

638* **Windows**: `C:\ProgramData\ClaudeCode\managed-mcp.json`959

639* **Linux**: `/etc/claude-code/managed-mcp.json`960* macOS: `/Library/Application Support/ClaudeCode/managed-mcp.json`

961* Linux and WSL: `/etc/claude-code/managed-mcp.json`

962* Windows: `C:\Program Files\ClaudeCode\managed-mcp.json`

963

964<Note>

965 These are system-wide paths (not user home directories like `~/Library/...`) that require administrator privileges. They are designed to be deployed by IT administrators.

966</Note>

640 967

641The `managed-mcp.json` file uses the same format as a standard `.mcp.json` file:968The `managed-mcp.json` file uses the same format as a standard `.mcp.json` file:

642 969

663}990}

664```991```

665 992

666### Restricting MCP servers with allowlists and denylists993### Option 2: Policy-based control with allowlists and denylists

667 994

668In addition to providing enterprise-managed servers, administrators can control which MCP servers users are allowed to configure using `allowedMcpServers` and `deniedMcpServers` in the `managed-settings.json` file:995Instead of taking exclusive control, administrators can allow users to configure their own MCP servers while enforcing restrictions on which servers are permitted. This approach uses `allowedMcpServers` and `deniedMcpServers` in the [managed settings file](/en/settings#settings-files).

669 996

670* **macOS**: `/Library/Application Support/ClaudeCode/managed-settings.json`997<Note>

671* **Windows**: `C:\ProgramData\ClaudeCode\managed-settings.json`998 **Choosing between options**: Use Option 1 (`managed-mcp.json`) when you want to deploy a fixed set of servers with no user customization. Use Option 2 (allowlists/denylists) when you want to allow users to add their own servers within policy constraints.

672* **Linux**: `/etc/claude-code/managed-settings.json`999</Note>

1000

1001#### Restriction options

1002

1003Each entry in the allowlist or denylist can restrict servers in three ways:

1004

10051. **By server name** (`serverName`): Matches the configured name of the server

10062. **By command** (`serverCommand`): Matches the exact command and arguments used to start stdio servers

10073. **By URL pattern** (`serverUrl`): Matches remote server URLs with wildcard support

1008

1009**Important**: Each entry must have exactly one of `serverName`, `serverCommand`, or `serverUrl`.

1010

1011#### Example configuration

673 1012

674```json theme={null}1013```json theme={null}

675{1014{

676 "allowedMcpServers": [1015 "allowedMcpServers": [

1016 // Allow by server name

677 { "serverName": "github" },1017 { "serverName": "github" },

678 { "serverName": "sentry" },1018 { "serverName": "sentry" },

679 { "serverName": "company-internal" }1019

1020 // Allow by exact command (for stdio servers)

1021 { "serverCommand": ["npx", "-y", "@modelcontextprotocol/server-filesystem"] },

1022 { "serverCommand": ["python", "/usr/local/bin/approved-server.py"] },

1023

1024 // Allow by URL pattern (for remote servers)

1025 { "serverUrl": "https://mcp.company.com/*" },

1026 { "serverUrl": "https://*.internal.corp/*" }

680 ],1027 ],

681 "deniedMcpServers": [1028 "deniedMcpServers": [

682 { "serverName": "filesystem" }1029 // Block by server name

1030 { "serverName": "dangerous-server" },

1031

1032 // Block by exact command (for stdio servers)

1033 { "serverCommand": ["npx", "-y", "unapproved-package"] },

1034

1035 // Block by URL pattern (for remote servers)

1036 { "serverUrl": "https://*.untrusted.com/*" }

683 ]1037 ]

684}1038}

685```1039```

686 1040

687**Allowlist behavior (`allowedMcpServers`)**:1041#### How command-based restrictions work

1042

1043**Exact matching**:

1044

1045* Command arrays must match **exactly** - both the command and all arguments in the correct order

1046* Example: `["npx", "-y", "server"]` will NOT match `["npx", "server"]` or `["npx", "-y", "server", "--flag"]`

1047

1048**Stdio server behavior**:

1049

1050* When the allowlist contains **any** `serverCommand` entries, stdio servers **must** match one of those commands

1051* Stdio servers cannot pass by name alone when command restrictions are present

1052* This ensures administrators can enforce which commands are allowed to run

1053

1054**Non-stdio server behavior**:

1055

1056* Remote servers (HTTP, SSE, WebSocket) use URL-based matching when `serverUrl` entries exist in the allowlist

1057* If no URL entries exist, remote servers fall back to name-based matching

1058* Command restrictions do not apply to remote servers

1059

1060#### How URL-based restrictions work

1061

1062URL patterns support wildcards using `*` to match any sequence of characters. This is useful for allowing entire domains or subdomains.

1063

1064**Wildcard examples**:

1065

1066* `https://mcp.company.com/*` - Allow all paths on a specific domain

1067* `https://*.example.com/*` - Allow any subdomain of example.com

1068* `http://localhost:*/*` - Allow any port on localhost

1069

1070**Remote server behavior**:

1071

1072* When the allowlist contains **any** `serverUrl` entries, remote servers **must** match one of those URL patterns

1073* Remote servers cannot pass by name alone when URL restrictions are present

1074* This ensures administrators can enforce which remote endpoints are allowed

1075

1076<Accordion title="Example: URL-only allowlist">

1077 ```json theme={null}

1078 {

1079 "allowedMcpServers": [

1080 { "serverUrl": "https://mcp.company.com/*" },

1081 { "serverUrl": "https://*.internal.corp/*" }

1082 ]

1083 }

1084 ```

1085

1086 **Result**:

1087

1088 * HTTP server at `https://mcp.company.com/api`: ✅ Allowed (matches URL pattern)

1089 * HTTP server at `https://api.internal.corp/mcp`: ✅ Allowed (matches wildcard subdomain)

1090 * HTTP server at `https://external.com/mcp`: ❌ Blocked (doesn't match any URL pattern)

1091 * Stdio server with any command: ❌ Blocked (no name or command entries to match)

1092</Accordion>

1093

1094<Accordion title="Example: Command-only allowlist">

1095 ```json theme={null}

1096 {

1097 "allowedMcpServers": [

1098 { "serverCommand": ["npx", "-y", "approved-package"] }

1099 ]

1100 }

1101 ```

1102

1103 **Result**:

1104

1105 * Stdio server with `["npx", "-y", "approved-package"]`: ✅ Allowed (matches command)

1106 * Stdio server with `["node", "server.js"]`: ❌ Blocked (doesn't match command)

1107 * HTTP server named "my-api": ❌ Blocked (no name entries to match)

1108</Accordion>

1109

1110<Accordion title="Example: Mixed name and command allowlist">

1111 ```json theme={null}

1112 {

1113 "allowedMcpServers": [

1114 { "serverName": "github" },

1115 { "serverCommand": ["npx", "-y", "approved-package"] }

1116 ]

1117 }

1118 ```

1119

1120 **Result**:

1121

1122 * Stdio server named "local-tool" with `["npx", "-y", "approved-package"]`: ✅ Allowed (matches command)

1123 * Stdio server named "local-tool" with `["node", "server.js"]`: ❌ Blocked (command entries exist but doesn't match)

1124 * Stdio server named "github" with `["node", "server.js"]`: ❌ Blocked (stdio servers must match commands when command entries exist)

1125 * HTTP server named "github": ✅ Allowed (matches name)

1126 * HTTP server named "other-api": ❌ Blocked (name doesn't match)

1127</Accordion>

1128

1129<Accordion title="Example: Name-only allowlist">

1130 ```json theme={null}

1131 {

1132 "allowedMcpServers": [

1133 { "serverName": "github" },

1134 { "serverName": "internal-tool" }

1135 ]

1136 }

1137 ```

1138

1139 **Result**:

1140

1141 * Stdio server named "github" with any command: ✅ Allowed (no command restrictions)

1142 * Stdio server named "internal-tool" with any command: ✅ Allowed (no command restrictions)

1143 * HTTP server named "github": ✅ Allowed (matches name)

1144 * Any server named "other": ❌ Blocked (name doesn't match)

1145</Accordion>

1146

1147#### Allowlist behavior (`allowedMcpServers`)

688 1148

689* `undefined` (default): No restrictions - users can configure any MCP server1149* `undefined` (default): No restrictions - users can configure any MCP server

690* Empty array `[]`: Complete lockdown - users cannot configure any MCP servers1150* Empty array `[]`: Complete lockdown - users cannot configure any MCP servers

691* List of server names: Users can only configure the specified servers1151* List of entries: Users can only configure servers that match by name, command, or URL pattern

692 1152

693**Denylist behavior (`deniedMcpServers`)**:1153#### Denylist behavior (`deniedMcpServers`)

694 1154

695* `undefined` (default): No servers are blocked1155* `undefined` (default): No servers are blocked

696* Empty array `[]`: No servers are blocked1156* Empty array `[]`: No servers are blocked

697* List of server names: Specified servers are explicitly blocked across all scopes1157* List of entries: Specified servers are explicitly blocked across all scopes

698 1158

699**Important notes**:1159#### Important notes

700 1160

701* These restrictions apply to all scopes: user, project, local, and even enterprise servers from `managed-mcp.json`1161* **Option 1 and Option 2 can be combined**: If `managed-mcp.json` exists, it has exclusive control and users cannot add servers. Allowlists/denylists still apply to the managed servers themselves.

702* **Denylist takes absolute precedence**: If a server appears in both lists, it will be blocked1162* **Denylist takes absolute precedence**: If a server matches a denylist entry (by name, command, or URL), it will be blocked even if it's on the allowlist

1163* Name-based, command-based, and URL-based restrictions work together: a server passes if it matches **either** a name entry, a command entry, or a URL pattern (unless blocked by denylist)

703 1164

704<Note>1165<Note>

705 **Enterprise configuration precedence**: The enterprise MCP configuration has the highest precedence and cannot be overridden by user, local, or project configurations.1166 **When using `managed-mcp.json`**: Users cannot add MCP servers through `claude mcp add` or configuration files. The `allowedMcpServers` and `deniedMcpServers` settings still apply to filter which managed servers are actually loaded.

706</Note>1167</Note>

memory.md +322 −51

Details

~~1# Manage Claude's memory~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Learn how to manage Claude Code's memory across sessions with different memory locations and best practices.~~5# How Claude remembers your project

4 6

~~5Claude Code can remember your preferences across sessions, like style guidelines and common commands in your workflow.~~7> Give Claude persistent instructions with CLAUDE.md files, and let Claude accumulate learnings automatically with auto memory.

6 8

~~7## Determine memory type~~9Each Claude Code session begins with a fresh context window. Two mechanisms carry knowledge across sessions:

8 10

~~9Claude Code offers four memory locations in a hierarchical structure, each serving a different purpose:~~11* **CLAUDE.md files**: instructions you write to give Claude persistent context

12* **Auto memory**: notes Claude writes itself based on your corrections and preferences

10 13

12| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------- |

13| **Enterprise policy** | macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`<br />Linux: `/etc/claude-code/CLAUDE.md`<br />Windows: `C:\ProgramData\ClaudeCode\CLAUDE.md` | Organization-wide instructions managed by IT/DevOps | Company coding standards, security policies, compliance requirements | All users in organization |

17 15

18All memory files are automatically loaded into Claude Code's context when launched. Files higher in the hierarchy take precedence and are loaded first, providing a foundation that more specific memories build upon.16* [Write and organize CLAUDE.md files](#claude-md-files)

17* [Scope rules to specific file types](#organize-rules-with-clauderules) with `.claude/rules/`

18* [Configure auto memory](#auto-memory) so Claude takes notes automatically

19* [Troubleshoot](#troubleshoot-memory-issues) when instructions aren't being followed

19 20

~~20## CLAUDE.md imports~~21## CLAUDE.md vs auto memory

21 22

~~22CLAUDE.md files can import additional files using `@path/to/import` syntax. The following example imports 3 files:~~23Claude Code has two complementary memory systems. Both are loaded at the start of every conversation. Claude treats them as context, not enforced configuration. The more specific and concise your instructions, the more consistently Claude follows them.

23 24

~~24```~~25| | CLAUDE.md files | Auto memory |

26| :------------------- | :------------------------------------------------ | :--------------------------------------------------------------- |

27| **Who writes it** | You | Claude |

28| **What it contains** | Instructions and rules | Learnings and patterns |

29| **Scope** | Project, user, or org | Per working tree |

30| **Loaded into** | Every session | Every session (first 200 lines) |

31| **Use for** | Coding standards, workflows, project architecture | Build commands, debugging insights, preferences Claude discovers |

33Use CLAUDE.md files when you want to guide Claude's behavior. Auto memory lets Claude learn from your corrections without manual effort.

35Subagents can also maintain their own auto memory. See [subagent configuration](/en/sub-agents#enable-persistent-memory) for details.

37## CLAUDE.md files

39CLAUDE.md files are markdown files that give Claude persistent instructions for a project, your personal workflow, or your entire organization. You write these files in plain text; Claude reads them at the start of every session.

41### Choose where to put CLAUDE.md files

43CLAUDE.md files can live in several locations, each with a different scope. More specific locations take precedence over broader ones.

46| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------- |

47| **Managed policy** | • macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`<br />• Linux and WSL: `/etc/claude-code/CLAUDE.md`<br />• Windows: `C:\Program Files\ClaudeCode\CLAUDE.md` | Organization-wide instructions managed by IT/DevOps | Company coding standards, security policies, compliance requirements | All users in organization |

51CLAUDE.md files in the directory hierarchy above the working directory are loaded in full at launch. CLAUDE.md files in subdirectories load on demand when Claude reads files in those directories. See [How CLAUDE.md files load](#how-claude-md-files-load) for the full resolution order.

53For large projects, you can break instructions into topic-specific files using [project rules](#organize-rules-with-clauderules). Rules let you scope instructions to specific file types or subdirectories.

55### Set up a project CLAUDE.md

57A project CLAUDE.md can be stored in either `./CLAUDE.md` or `./.claude/CLAUDE.md`. Create this file and add instructions that apply to anyone working on the project: build and test commands, coding standards, architectural decisions, naming conventions, and common workflows. These instructions are shared with your team through version control, so focus on project-level standards rather than personal preferences.

59<Tip>

60 Run `/init` to generate a starting CLAUDE.md automatically. Claude analyzes your codebase and creates a file with build commands, test instructions, and project conventions it discovers. If a CLAUDE.md already exists, `/init` suggests improvements rather than overwriting it. Refine from there with instructions Claude wouldn't discover on its own.

62 Set `CLAUDE_CODE_NEW_INIT=true` to enable an interactive multi-phase flow. `/init` asks which artifacts to set up: CLAUDE.md files, skills, and hooks. It then explores your codebase with a subagent, fills in gaps via follow-up questions, and presents a reviewable proposal before writing any files.

63</Tip>

65### Write effective instructions

67CLAUDE.md files are loaded into the context window at the start of every session, consuming tokens alongside your conversation. Because they're context rather than enforced configuration, how you write instructions affects how reliably Claude follows them. Specific, concise, well-structured instructions work best.

69**Size**: target under 200 lines per CLAUDE.md file. Longer files consume more context and reduce adherence. If your instructions are growing large, split them using [imports](#import-additional-files) or [`.claude/rules/`](#organize-rules-with-clauderules) files.

71**Structure**: use markdown headers and bullets to group related instructions. Claude scans structure the same way readers do: organized sections are easier to follow than dense paragraphs.

73**Specificity**: write instructions that are concrete enough to verify. For example:

75* "Use 2-space indentation" instead of "Format code properly"

76* "Run `npm test` before committing" instead of "Test your changes"

77* "API handlers live in `src/api/handlers/`" instead of "Keep files organized"

79**Consistency**: if two rules contradict each other, Claude may pick one arbitrarily. Review your CLAUDE.md files, nested CLAUDE.md files in subdirectories, and [`.claude/rules/`](#organize-rules-with-clauderules) periodically to remove outdated or conflicting instructions. In monorepos, use [`claudeMdExcludes`](#exclude-specific-claude-md-files) to skip CLAUDE.md files from other teams that aren't relevant to your work.

81### Import additional files

83CLAUDE.md files can import additional files using `@path/to/import` syntax. Imported files are expanded and loaded into context at launch alongside the CLAUDE.md that references them.

85Both relative and absolute paths are allowed. Relative paths resolve relative to the file containing the import, not the working directory. Imported files can recursively import other files, with a maximum depth of five hops.

87To pull in a README, package.json, and a workflow guide, reference them with `@` syntax anywhere in your CLAUDE.md:

89```text theme={null}

25See @README for project overview and @package.json for available npm commands for this project.90See @README for project overview and @package.json for available npm commands for this project.

26 91

27# Additional Instructions92# Additional Instructions

28- git workflow @docs/git-instructions.md93- git workflow @docs/git-instructions.md

29```94```

30 95

31Both relative and absolute paths are allowed. In particular, importing files in user's home dir is a convenient way for your team members to provide individual instructions that are not checked into the repository. Previously CLAUDE.local.md served a similar purpose, but is now deprecated in favor of imports since they work better across multiple git worktrees.96For personal preferences you don't want to check in, import a file from your home directory. The import goes in the shared CLAUDE.md, but the file it points to stays on your machine:

32 97

~~33```~~98```text theme={null}

34# Individual Preferences99# Individual Preferences

35- @~/.claude/my-project-instructions.md100- @~/.claude/my-project-instructions.md

36```101```

37 102

~~38To avoid potential collisions, imports are not evaluated inside markdown code spans and code blocks.~~103<Warning>

104 The first time Claude Code encounters external imports in a project, it shows an approval dialog listing the files. If you decline, the imports stay disabled and the dialog does not appear again.

105</Warning>

106

107For a more structured approach to organizing instructions, see [`.claude/rules/`](#organize-rules-with-clauderules).

108

109### How CLAUDE.md files load

110

111Claude Code reads CLAUDE.md files by walking up the directory tree from your current working directory, checking each directory along the way. This means if you run Claude Code in `foo/bar/`, it loads instructions from both `foo/bar/CLAUDE.md` and `foo/CLAUDE.md`.

112

113Claude also discovers CLAUDE.md files in subdirectories under your current working directory. Instead of loading them at launch, they are included when Claude reads files in those subdirectories.

114

115If you work in a large monorepo where other teams' CLAUDE.md files get picked up, use [`claudeMdExcludes`](#exclude-specific-claude-md-files) to skip them.

116

117#### Load from additional directories

118

119The `--add-dir` flag gives Claude access to additional directories outside your main working directory. By default, CLAUDE.md files from these directories are not loaded.

120

121To also load CLAUDE.md files from additional directories, including `CLAUDE.md`, `.claude/CLAUDE.md`, and `.claude/rules/*.md`, set the `CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD` environment variable:

122

123```bash theme={null}

124CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1 claude --add-dir ../shared-config

125```

126

127### Organize rules with `.claude/rules/`

128

129For larger projects, you can organize instructions into multiple files using the `.claude/rules/` directory. This keeps instructions modular and easier for teams to maintain. Rules can also be [scoped to specific file paths](#path-specific-rules), so they only load into context when Claude works with matching files, reducing noise and saving context space.

130

131<Note>

132 Rules load into context every session or when matching files are opened. For task-specific instructions that don't need to be in context all the time, use [skills](/en/skills) instead, which only load when you invoke them or when Claude determines they're relevant to your prompt.

133</Note>

134

135#### Set up rules

136

137Place markdown files in your project's `.claude/rules/` directory. Each file should cover one topic, with a descriptive filename like `testing.md` or `api-design.md`. All `.md` files are discovered recursively, so you can organize rules into subdirectories like `frontend/` or `backend/`:

138

139```text theme={null}

140your-project/

141├── .claude/

142│ ├── CLAUDE.md # Main project instructions

143│ └── rules/

144│ ├── code-style.md # Code style guidelines

145│ ├── testing.md # Testing conventions

146│ └── security.md # Security requirements

147```

148

149Rules without [`paths` frontmatter](#path-specific-rules) are loaded at launch with the same priority as `.claude/CLAUDE.md`.

150

151#### Path-specific rules

152

153Rules can be scoped to specific files using YAML frontmatter with the `paths` field. These conditional rules only apply when Claude is working with files matching the specified patterns.

154

155```markdown theme={null}

156---

157paths:

158 - "src/api/**/*.ts"

159---

160

161# API Development Rules

39 162

163- All API endpoints must include input validation

164- Use the standard error response format

165- Include OpenAPI documentation comments

40```166```

~~41This code span will not be treated as an import: `@anthropic-ai/claude-code`~~167

168Rules without a `paths` field are loaded unconditionally and apply to all files. Path-scoped rules trigger when Claude reads files matching the pattern, not on every tool use.

169

170Use glob patterns in the `paths` field to match files by extension, directory, or any combination:

171

172| Pattern | Matches |

173| ---------------------- | ---------------------------------------- |

174| `**/*.ts` | All TypeScript files in any directory |

175| `src/**/*` | All files under `src/` directory |

176| `*.md` | Markdown files in the project root |

177| `src/components/*.tsx` | React components in a specific directory |

178

179You can specify multiple patterns and use brace expansion to match multiple extensions in one pattern:

180

181```markdown theme={null}

182---

183paths:

184 - "src/**/*.{ts,tsx}"

185 - "lib/**/*.ts"

186 - "tests/**/*.test.ts"

187---

42```188```

43 189

~~44Imported files can recursively import additional files, with a max-depth of 5 hops. You can see what memory files are loaded by running `/memory` command.~~190#### Share rules across projects with symlinks

45 191

~~46## How Claude looks up memories~~192The `.claude/rules/` directory supports symlinks, so you can maintain a shared set of rules and link them into multiple projects. Symlinks are resolved and loaded normally, and circular symlinks are detected and handled gracefully.

47 193

48Claude Code reads memories recursively: starting in the cwd, Claude Code recurses up to (but not including) the root directory */* and reads any CLAUDE.md or CLAUDE.local.md files it finds. This is especially convenient when working in large repositories where you run Claude Code in *foo/bar/*, and have memories in both *foo/CLAUDE.md* and *foo/bar/CLAUDE.md*.194This example links both a shared directory and an individual file:

49 195

~~50Claude will also discover CLAUDE.md nested in subtrees under your current working directory. Instead of loading them at launch, they are only included when Claude reads files in those subtrees.~~196```bash theme={null}

197ln -s ~/shared-claude-rules .claude/rules/shared

198ln -s ~/company-standards/security.md .claude/rules/security.md

199```

51 200

~~52## Quickly add memories with the `#` shortcut~~201#### User-level rules

53 202

~~54The fastest way to add a memory is to start your input with the `#` character:~~203Personal rules in `~/.claude/rules/` apply to every project on your machine. Use them for preferences that aren't project-specific:

55 204

205```text theme={null}

206~/.claude/rules/

207├── preferences.md # Your personal coding preferences

208└── workflows.md # Your preferred workflows

56```209```

~~57# Always use descriptive variable names~~210

211User-level rules are loaded before project rules, giving project rules higher priority.

212

213### Manage CLAUDE.md for large teams

214

215For organizations deploying Claude Code across teams, you can centralize instructions and control which CLAUDE.md files are loaded.

216

217#### Deploy organization-wide CLAUDE.md

218

219Organizations can deploy a centrally managed CLAUDE.md that applies to all users on a machine. This file cannot be excluded by individual settings.

220

221<Steps>

222 <Step title="Create the file at the managed policy location">

223 * macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`

224 * Linux and WSL: `/etc/claude-code/CLAUDE.md`

225 * Windows: `C:\Program Files\ClaudeCode\CLAUDE.md`

226 </Step>

227

228 <Step title="Deploy with your configuration management system">

229 Use MDM, Group Policy, Ansible, or similar tools to distribute the file across developer machines. See [managed settings](/en/permissions#managed-settings) for other organization-wide configuration options.

230 </Step>

231</Steps>

232

233A managed CLAUDE.md and [managed settings](/en/settings#settings-files) serve different purposes. Use settings for technical enforcement and CLAUDE.md for behavioral guidance:

234

235| Concern | Configure in |

236| :--------------------------------------------- | :-------------------------------------------------------- |

237| Block specific tools, commands, or file paths | Managed settings: `permissions.deny` |

238| Enforce sandbox isolation | Managed settings: `sandbox.enabled` |

239| Environment variables and API provider routing | Managed settings: `env` |

240| Authentication method and organization lock | Managed settings: `forceLoginMethod`, `forceLoginOrgUUID` |

241| Code style and quality guidelines | Managed CLAUDE.md |

242| Data handling and compliance reminders | Managed CLAUDE.md |

243| Behavioral instructions for Claude | Managed CLAUDE.md |

244

245Settings rules are enforced by the client regardless of what Claude decides to do. CLAUDE.md instructions shape Claude's behavior but are not a hard enforcement layer.

246

247#### Exclude specific CLAUDE.md files

248

249In large monorepos, ancestor CLAUDE.md files may contain instructions that aren't relevant to your work. The `claudeMdExcludes` setting lets you skip specific files by path or glob pattern.

250

251This example excludes a top-level CLAUDE.md and a rules directory from a parent folder. Add it to `.claude/settings.local.json` so the exclusion stays local to your machine:

252

253```json theme={null}

254{

255 "claudeMdExcludes": [

256 "**/monorepo/CLAUDE.md",

257 "/home/user/monorepo/other-team/.claude/rules/**"

258 ]

259}

58```260```

59 261

~~60You'll be prompted to select which memory file to store this in.~~262Patterns are matched against absolute file paths using glob syntax. You can configure `claudeMdExcludes` at any [settings layer](/en/settings#settings-files): user, project, local, or managed policy. Arrays merge across layers.

61 263

~~62## Directly edit memories with `/memory`~~264Managed policy CLAUDE.md files cannot be excluded. This ensures organization-wide instructions always apply regardless of individual settings.

63 265

~~64Use the `/memory` slash command during a session to open any memory file in your system editor for more extensive additions or organization.~~266## Auto memory

65 267

~~66## Set up project memory~~268Auto memory lets Claude accumulate knowledge across sessions without you writing anything. Claude saves notes for itself as it works: build commands, debugging insights, architecture notes, code style preferences, and workflow habits. Claude doesn't save something every session. It decides what's worth remembering based on whether the information would be useful in a future conversation.

67 269

68Suppose you want to set up a CLAUDE.md file to store important project information, conventions, and frequently used commands. Project memory can be stored in either `./CLAUDE.md` or `./.claude/CLAUDE.md`.270<Note>

271 Auto memory requires Claude Code v2.1.59 or later. Check your version with `claude --version`.

272</Note>

69 273

~~70Bootstrap a CLAUDE.md for your codebase with the following command:~~274### Enable or disable auto memory

71 275

276Auto memory is on by default. To toggle it, open `/memory` in a session and use the auto memory toggle, or set `autoMemoryEnabled` in your project settings:

277

278```json theme={null}

279{

280 "autoMemoryEnabled": false

281}

72```282```

~~73> /init~~ 283

284To disable auto memory via environment variable, set `CLAUDE_CODE_DISABLE_AUTO_MEMORY=1`.

285

286### Storage location

287

288Each project gets its own memory directory at `~/.claude/projects/<project>/memory/`. The `<project>` path is derived from the git repository, so all worktrees and subdirectories within the same repo share one auto memory directory. Outside a git repo, the project root is used instead.

289

290To store auto memory in a different location, set `autoMemoryDirectory` in your user or local settings:

291

292```json theme={null}

293{

294 "autoMemoryDirectory": "~/my-custom-memory-dir"

295}

74```296```

75 297

~~76<Tip>~~298This setting is accepted from policy, local, and user settings. It is not accepted from project settings (`.claude/settings.json`) to prevent a shared project from redirecting auto memory writes to sensitive locations.

~~77 Tips:~~299

300The directory contains a `MEMORY.md` entrypoint and optional topic files:

301

302```text theme={null}

303~/.claude/projects/<project>/memory/

304├── MEMORY.md # Concise index, loaded into every session

305├── debugging.md # Detailed notes on debugging patterns

306├── api-conventions.md # API design decisions

307└── ... # Any other topic files Claude creates

308```

309

310`MEMORY.md` acts as an index of the memory directory. Claude reads and writes files in this directory throughout your session, using `MEMORY.md` to keep track of what's stored where.

311

312Auto memory is machine-local. All worktrees and subdirectories within the same git repository share one auto memory directory. Files are not shared across machines or cloud environments.

313

314### How it works

315

316The first 200 lines of `MEMORY.md` are loaded at the start of every conversation. Content beyond line 200 is not loaded at session start. Claude keeps `MEMORY.md` concise by moving detailed notes into separate topic files.

317

318This 200-line limit applies only to `MEMORY.md`. CLAUDE.md files are loaded in full regardless of length, though shorter files produce better adherence.

319

320Topic files like `debugging.md` or `patterns.md` are not loaded at startup. Claude reads them on demand using its standard file tools when it needs the information.

321

322Claude reads and writes memory files during your session. When you see "Writing memory" or "Recalled memory" in the Claude Code interface, Claude is actively updating or reading from `~/.claude/projects/<project>/memory/`.

323

324### Audit and edit your memory

325

326Auto memory files are plain markdown you can edit or delete at any time. Run [`/memory`](#view-and-edit-with-memory) to browse and open memory files from within a session.

78 327

~~79 * Include frequently used commands (build, test, lint) to avoid repeated searches~~328## View and edit with `/memory`

~~80 * Document code style preferences and naming conventions~~329

~~81 * Add important architectural patterns specific to your project~~330The `/memory` command lists all CLAUDE.md and rules files loaded in your current session, lets you toggle auto memory on or off, and provides a link to open the auto memory folder. Select any file to open it in your editor.

~~82 * CLAUDE.md memories can be used for both instructions shared with your team and for your individual preferences.~~331

332When you ask Claude to remember something, like "always use pnpm, not npm" or "remember that the API tests require a local Redis instance," Claude saves it to auto memory. To add instructions to CLAUDE.md instead, ask Claude directly, like "add this to CLAUDE.md," or edit the file yourself via `/memory`.

333

334## Troubleshoot memory issues

335

336These are the most common issues with CLAUDE.md and auto memory, along with steps to debug them.

337

338### Claude isn't following my CLAUDE.md

339

340CLAUDE.md content is delivered as a user message after the system prompt, not as part of the system prompt itself. Claude reads it and tries to follow it, but there's no guarantee of strict compliance, especially for vague or conflicting instructions.

341

342To debug:

343

344* Run `/memory` to verify your CLAUDE.md files are being loaded. If a file isn't listed, Claude can't see it.

345* Check that the relevant CLAUDE.md is in a location that gets loaded for your session (see [Choose where to put CLAUDE.md files](#choose-where-to-put-claude-md-files)).

346* Make instructions more specific. "Use 2-space indentation" works better than "format code nicely."

347* Look for conflicting instructions across CLAUDE.md files. If two files give different guidance for the same behavior, Claude may pick one arbitrarily.

348

349For instructions you want at the system prompt level, use [`--append-system-prompt`](/en/cli-reference#system-prompt-flags). This must be passed every invocation, so it's better suited to scripts and automation than interactive use.

350

351<Tip>

352 Use the [`InstructionsLoaded` hook](/en/hooks#instructionsloaded) to log exactly which instruction files are loaded, when they load, and why. This is useful for debugging path-specific rules or lazy-loaded files in subdirectories.

83</Tip>353</Tip>

84 354

~~85## Organization-level memory management~~355### I don't know what auto memory saved

356

357Run `/memory` and select the auto memory folder to browse what Claude has saved. Everything is plain markdown you can read, edit, or delete.

86 358

~~87Enterprise organizations can deploy centrally managed CLAUDE.md files that apply to all users.~~359### My CLAUDE.md is too large

88 360

~~89To set up organization-level memory management:~~361Files over 200 lines consume more context and may reduce adherence. Move detailed content into separate files referenced with `@path` imports (see [Import additional files](#import-additional-files)), or split your instructions across `.claude/rules/` files.

90 362

~~911. Create the enterprise memory file in the appropriate location for your operating system:~~363### Instructions seem lost after `/compact`

92 364

~~93* macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`~~365CLAUDE.md fully survives compaction. After `/compact`, Claude re-reads your CLAUDE.md from disk and re-injects it fresh into the session. If an instruction disappeared after compaction, it was given only in conversation, not written to CLAUDE.md. Add it to CLAUDE.md to make it persist across sessions.

~~94* Linux/WSL: `/etc/claude-code/CLAUDE.md`~~

~~95* Windows: `C:\ProgramData\ClaudeCode\CLAUDE.md`~~

96 366

~~972. Deploy via your configuration management system (MDM, Group Policy, Ansible, etc.) to ensure consistent distribution across all developer machines.~~367See [Write effective instructions](#write-effective-instructions) for guidance on size, structure, and specificity.

98 368

~~99## Memory best practices~~369## Related resources

100 370

101* **Be specific**: "Use 2-space indentation" is better than "Format code properly".371* [Skills](/en/skills): package repeatable workflows that load on demand

102* **Use structure to organize**: Format each individual memory as a bullet point and group related memories under descriptive markdown headings.372* [Settings](/en/settings): configure Claude Code behavior with settings files

103* **Review periodically**: Update memories as your project evolves to ensure Claude is always using the most up to date information and context.373* [Manage sessions](/en/sessions): manage context, resume conversations, and run parallel sessions

374* [Subagent memory](/en/sub-agents#enable-persistent-memory): let subagents maintain their own auto memory

microsoft-foundry.md +23 −6

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Claude Code on Microsoft Foundry5# Claude Code on Microsoft Foundry

2 6

3> Learn about configuring Claude Code through Microsoft Foundry, including setup, configuration, and troubleshooting.7> Learn about configuring Claude Code through Microsoft Foundry, including setup, configuration, and troubleshooting.

10* RBAC permissions to create Microsoft Foundry resources and deployments14* RBAC permissions to create Microsoft Foundry resources and deployments

11* Azure CLI installed and configured (optional - only needed if you don't have another mechanism for getting credentials)15* Azure CLI installed and configured (optional - only needed if you don't have another mechanism for getting credentials)

12 16

17<Note>

18 If you are deploying Claude Code to multiple users, [pin your model versions](#4-pin-model-versions) to prevent breakage when Anthropic releases new models.

19</Note>

13## Setup21## Setup

14 22

15### 1. Provision Microsoft Foundry resource23### 1. Provision Microsoft Foundry resource

55 63

56### 3. Configure Claude Code64### 3. Configure Claude Code

57 65

58Set the following environment variables to enable Microsoft Foundry. Note that your deployments' names are set as the model identifiers in Claude Code (may be optional if using suggested deployment names).66Set the following environment variables to enable Microsoft Foundry:

59 67

60```bash theme={null}68```bash theme={null}

61# Enable Microsoft Foundry integration69# Enable Microsoft Foundry integration

64# Azure resource name (replace {resource} with your resource name)72# Azure resource name (replace {resource} with your resource name)

65export ANTHROPIC_FOUNDRY_RESOURCE={resource}73export ANTHROPIC_FOUNDRY_RESOURCE={resource}

66# Or provide the full base URL:74# Or provide the full base URL:

~~67# export ANTHROPIC_FOUNDRY_BASE_URL=https://{resource}.services.ai.azure.com~~75# export ANTHROPIC_FOUNDRY_BASE_URL=https://{resource}.services.ai.azure.com/anthropic

76```

68 77

~~69# Set models to your resource's deployment names~~78### 4. Pin model versions

~~70export ANTHROPIC_DEFAULT_SONNET_MODEL='claude-sonnet-4-5'~~79

80<Warning>

81 Pin specific model versions for every deployment. If you use model aliases (`sonnet`, `opus`, `haiku`) without pinning, Claude Code may attempt to use a newer model version that isn't available in your Foundry account, breaking existing users when Anthropic releases updates. When you create Azure deployments, select a specific model version rather than "auto-update to latest."

82</Warning>

84Set the model variables to match the deployment names you created in step 1:

86```bash theme={null}

87export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6'

88export ANTHROPIC_DEFAULT_SONNET_MODEL='claude-sonnet-4-6'

71export ANTHROPIC_DEFAULT_HAIKU_MODEL='claude-haiku-4-5'89export ANTHROPIC_DEFAULT_HAIKU_MODEL='claude-haiku-4-5'

~~72export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-1'~~

73```90```

74 91

~~75For more details on model configuration options, see [Model configuration](/en/model-config).~~92For current and legacy model IDs, see [Models overview](https://platform.claude.com/docs/en/about-claude/models/overview). See [Model configuration](/en/model-config#pin-models-for-third-party-deployments) for the full list of environment variables.

76 93

77## Azure RBAC configuration94## Azure RBAC configuration

78 95

model-config.md +185 −21

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Model configuration5# Model configuration

2 6

3> Learn about the Claude Code model configuration, including model aliases like `opusplan`7> Learn about the Claude Code model configuration, including model aliases like `opusplan`

8 12

9* A **model alias**13* A **model alias**

10* A **model name**14* A **model name**

~~11 * Anthropic API: A full **[model name](https://docs.claude.com/en/docs/about-claude/models/overview#model-names)**~~15 * Anthropic API: A full **[model name](https://platform.claude.com/docs/en/about-claude/models/overview)**

12 * Bedrock: an inference profile ARN16 * Bedrock: an inference profile ARN

13 * Foundry: a deployment name17 * Foundry: a deployment name

14 * Vertex: a version name18 * Vertex: a version name

19remembering exact version numbers:23remembering exact version numbers:

20 24

21| Model alias | Behavior |25| Model alias | Behavior |

~~22| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |~~26| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

23| **`default`** | Recommended model setting, depending on your account type |27| **`default`** | Recommended model setting, depending on your account type |

26| **`haiku`** | Uses the fast and efficient Haiku model for simple tasks |30| **`haiku`** | Uses the fast and efficient Haiku model for simple tasks |

~~27| **`sonnet[1m]`** | Uses Sonnet with a [1 million token context window](https://docs.claude.com/en/docs/build-with-claude/context-windows#1m-token-context-window) window for long sessions |~~31| **`sonnet[1m]`** | Uses Sonnet with a [1 million token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows#1m-token-context-window) for long sessions |

32| **`opus[1m]`** | Uses Opus with a [1 million token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows#1m-token-context-window) for long sessions |

28| **`opusplan`** | Special mode that uses `opus` during plan mode, then switches to `sonnet` for execution |33| **`opusplan`** | Special mode that uses `opus` during plan mode, then switches to `sonnet` for execution |

29 34

35Aliases always point to the latest version. To pin to a specific version, use the full model name (for example, `claude-opus-4-6`) or set the corresponding environment variable like `ANTHROPIC_DEFAULT_OPUS_MODEL`.

30### Setting your model37### Setting your model

31 38

32You can configure your model in several ways, listed in order of priority:39You can configure your model in several ways, listed in order of priority:

49 56

50Example settings file:57Example settings file:

51 58

~~52```~~59```json theme={null}

53{60{

54 "permissions": {61 "permissions": {

55 ...62 ...

58}65}

59```66```

60 67

68## Restrict model selection

70Enterprise administrators can use `availableModels` in [managed or policy settings](/en/settings#settings-files) to restrict which models users can select.

72When `availableModels` is set, users cannot switch to models not in the list via `/model`, `--model` flag, Config tool, or `ANTHROPIC_MODEL` environment variable.

74```json theme={null}

75{

76 "availableModels": ["sonnet", "haiku"]

77}

78```

80### Default model behavior

82The Default option in the model picker is not affected by `availableModels`. It always remains available and represents the system's runtime default [based on the user's subscription tier](#default-model-setting).

84Even with `availableModels: []`, users can still use Claude Code with the Default model for their tier.

86### Control the model users run on

88To fully control the model experience, use `availableModels` together with the `model` setting:

90* **availableModels**: restricts what users can switch to

91* **model**: sets the explicit model override, taking precedence over the Default

93This example ensures all users run Sonnet 4.6 and can only choose between Sonnet and Haiku:

95```json theme={null}

96{

97 "model": "sonnet",

98 "availableModels": ["sonnet", "haiku"]

99}

100```

101

102### Merge behavior

103

104When `availableModels` is set at multiple levels, such as user settings and project settings, arrays are merged and deduplicated. To enforce a strict allowlist, set `availableModels` in managed or policy settings which take highest priority.

105

61## Special model behavior106## Special model behavior

62 107

63### `default` model setting108### `default` model setting

64 109

~~65The behavior of `default` depends on your account type.~~110The behavior of `default` depends on your account type:

111

112* **Max and Team Premium**: defaults to Opus 4.6

113* **Pro and Team Standard**: defaults to Sonnet 4.6

114* **Enterprise**: Opus 4.6 is available but not the default

66 115

~~67For certain Max users, Claude Code will automatically fall back to Sonnet if you~~116Claude Code may automatically fall back to Sonnet if you hit a usage threshold with Opus.

~~68hit a usage threshold with Opus.~~

69 117

70### `opusplan` model setting118### `opusplan` model setting

71 119

79This gives you the best of both worlds: Opus's superior reasoning for planning,127This gives you the best of both worlds: Opus's superior reasoning for planning,

80and Sonnet's efficiency for execution.128and Sonnet's efficiency for execution.

81 129

~~82### Extended context with \[1m]~~130### Adjust effort level

131

132[Effort levels](https://platform.claude.com/docs/en/build-with-claude/effort) control adaptive reasoning, which dynamically allocates thinking based on task complexity. Lower effort is faster and cheaper for straightforward tasks, while higher effort provides deeper reasoning for complex problems.

133

134Three levels persist across sessions: **low**, **medium**, and **high**. A fourth level, **max**, provides the deepest reasoning with no constraint on token spending, so responses are slower and cost more than at `high`. `max` is available on Opus 4.6 only and does not persist across sessions except through the `CLAUDE_CODE_EFFORT_LEVEL` environment variable.

135

136Opus 4.6 and Sonnet 4.6 default to medium effort. This applies to all providers, including Bedrock, Vertex AI, and direct API access.

137

138Medium is the recommended level for most coding tasks: it balances speed and reasoning depth, and higher levels can cause the model to overthink routine work. Reserve `high` or `max` for tasks that genuinely benefit from deeper reasoning, such as hard debugging problems or complex architectural decisions.

139

140For one-off deep reasoning without changing your session setting, include "ultrathink" in your prompt to trigger high effort for that turn.

141

142**Setting effort:**

143

144* **`/effort`**: run `/effort low`, `/effort medium`, `/effort high`, or `/effort max` to change the level, or `/effort auto` to reset to the model default

145* **In `/model`**: use left/right arrow keys to adjust the effort slider when selecting a model

146* **`--effort` flag**: pass `low`, `medium`, `high`, or `max` to set the level for a single session when launching Claude Code

147* **Environment variable**: set `CLAUDE_CODE_EFFORT_LEVEL` to `low`, `medium`, `high`, `max`, or `auto`

148* **Settings**: set `effortLevel` in your settings file to `"low"`, `"medium"`, or `"high"`

149* **Skill and subagent frontmatter**: set `effort` in a [skill](/en/skills#frontmatter-reference) or [subagent](/en/sub-agents#supported-frontmatter-fields) markdown file to override the effort level when that skill or subagent runs

150

151The environment variable takes precedence over all other methods, then your configured level, then the model default. Frontmatter effort applies when that skill or subagent is active, overriding the session level but not the environment variable.

152

153Effort is supported on Opus 4.6 and Sonnet 4.6. The effort slider appears in `/model` when a supported model is selected. The current effort level is also displayed next to the logo and spinner, for example "with low effort", so you can confirm which setting is active without opening `/model`.

154

155To disable adaptive reasoning on Opus 4.6 and Sonnet 4.6 and revert to the previous fixed thinking budget, set `CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING=1`. When disabled, these models use the fixed budget controlled by `MAX_THINKING_TOKENS`. See [environment variables](/en/env-vars).

156

157### Extended context

158

159Opus 4.6 and Sonnet 4.6 support a [1 million token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows#1m-token-context-window) for long sessions with large codebases.

160

161Availability varies by model and plan. On Max, Team, and Enterprise plans, Opus is automatically upgraded to 1M context with no additional configuration. This applies to both Team Standard and Team Premium seats.

162

163| Plan | Opus 4.6 with 1M context | Sonnet 4.6 with 1M context |

164| ------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |

165| Max, Team, and Enterprise | Included with subscription | Requires [extra usage](https://support.claude.com/en/articles/12429409-extra-usage-for-paid-claude-plans) |

166| Pro | Requires [extra usage](https://support.claude.com/en/articles/12429409-extra-usage-for-paid-claude-plans) | Requires [extra usage](https://support.claude.com/en/articles/12429409-extra-usage-for-paid-claude-plans) |

167| API and pay-as-you-go | Full access | Full access |

83 168

~~84For Console/API users, the `[1m]` suffix can be added to full model names to~~169To disable 1M context entirely, set `CLAUDE_CODE_DISABLE_1M_CONTEXT=1`. This removes 1M model variants from the model picker. See [environment variables](/en/env-vars).

~~85enable a~~170

~~86[1 million token context window](https://docs.claude.com/en/docs/build-with-claude/context-windows#1m-token-context-window).~~171The 1M context window uses standard model pricing with no premium for tokens beyond 200K. For plans where extended context is included with your subscription, usage remains covered by your subscription. For plans that access extended context through extra usage, tokens are billed to extra usage.

172

173If your account supports 1M context, the option appears in the model picker (`/model`) in the latest versions of Claude Code. If you don't see it, try restarting your session.

174

175You can also use the `[1m]` suffix with model aliases or full model names:

87 176

88```bash theme={null}177```bash theme={null}

~~89# Example of using a full model name with the [1m] suffix~~178# Use the opus[1m] or sonnet[1m] alias

~~90/model anthropic.claude-sonnet-4-5-20250929-v1:0[1m]~~179/model opus[1m]

~~91```~~180/model sonnet[1m]

92 181

~~93Note: Extended context models have~~182# Or append [1m] to a full model name

~~94[different pricing](https://docs.claude.com/en/docs/about-claude/pricing#long-context-pricing).~~183/model claude-opus-4-6[1m]

184```

95 185

96## Checking your current model186## Checking your current model

97 187

1001. In [status line](/en/statusline) (if configured)1901. In [status line](/en/statusline) (if configured)

1012. In `/status`, which also displays your account information.1912. In `/status`, which also displays your account information.

102 192

193## Add a custom model option

194

195Use `ANTHROPIC_CUSTOM_MODEL_OPTION` to add a single custom entry to the `/model` picker without replacing the built-in aliases. This is useful for LLM gateway deployments or testing model IDs that Claude Code does not list by default.

196

197This example sets all three variables to make a gateway-routed Opus deployment selectable:

198

199```bash theme={null}

200export ANTHROPIC_CUSTOM_MODEL_OPTION="my-gateway/claude-opus-4-6"

201export ANTHROPIC_CUSTOM_MODEL_OPTION_NAME="Opus via Gateway"

202export ANTHROPIC_CUSTOM_MODEL_OPTION_DESCRIPTION="Custom deployment routed through the internal LLM gateway"

203```

204

205The custom entry appears at the bottom of the `/model` picker. `ANTHROPIC_CUSTOM_MODEL_OPTION_NAME` and `ANTHROPIC_CUSTOM_MODEL_OPTION_DESCRIPTION` are optional. If omitted, the model ID is used as the name and the description defaults to `Custom model (<model-id>)`.

206

207Claude Code skips validation for the model ID set in `ANTHROPIC_CUSTOM_MODEL_OPTION`, so you can use any string your API endpoint accepts.

208

103## Environment variables209## Environment variables

104 210

105You can use the following environment variables, which must be full **model211You can use the following environment variables, which must be full **model

106names** (or equivalent for your API provider), to control the model names that the aliases map to.212names** (or equivalent for your API provider), to control the model names that the aliases map to.

107 213

108| Env var | Description |214| Environment variable | Description |

109| -------------------------------- | --------------------------------------------------------------------------------------------- |215| -------------------------------- | --------------------------------------------------------------------------------------------- |

115Note: `ANTHROPIC_SMALL_FAST_MODEL` is deprecated in favor of221Note: `ANTHROPIC_SMALL_FAST_MODEL` is deprecated in favor of

116`ANTHROPIC_DEFAULT_HAIKU_MODEL`.222`ANTHROPIC_DEFAULT_HAIKU_MODEL`.

117 223

224### Pin models for third-party deployments

225

226When deploying Claude Code through [Bedrock](/en/amazon-bedrock), [Vertex AI](/en/google-vertex-ai), or [Foundry](/en/microsoft-foundry), pin model versions before rolling out to users.

227

228Without pinning, Claude Code uses model aliases (`sonnet`, `opus`, `haiku`) that resolve to the latest version. When Anthropic releases a new model, users whose accounts don't have the new version enabled will break silently.

229

230<Warning>

231 Set all three model environment variables to specific version IDs as part of your initial setup. Skipping this step means a Claude Code update can break your users without any action on your part.

232</Warning>

233

234Use the following environment variables with version-specific model IDs for your provider:

235

236| Provider | Example |

237| :-------- | :---------------------------------------------------------------------- |

238| Bedrock | `export ANTHROPIC_DEFAULT_OPUS_MODEL='us.anthropic.claude-opus-4-6-v1'` |

239| Vertex AI | `export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6'` |

240| Foundry | `export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6'` |

241

242Apply the same pattern for `ANTHROPIC_DEFAULT_SONNET_MODEL` and `ANTHROPIC_DEFAULT_HAIKU_MODEL`. For current and legacy model IDs across all providers, see [Models overview](https://platform.claude.com/docs/en/about-claude/models/overview). To upgrade users to a new model version, update these environment variables and redeploy.

243

244To enable [extended context](#extended-context) for a pinned model, append `[1m]` to the model ID in `ANTHROPIC_DEFAULT_OPUS_MODEL` or `ANTHROPIC_DEFAULT_SONNET_MODEL`:

245

246```bash theme={null}

247export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6[1m]'

248```

249

250The `[1m]` suffix applies the 1M context window to all usage of that alias, including `opusplan`. Claude Code strips the suffix before sending the model ID to your provider. Only append `[1m]` when the underlying model supports 1M context, such as Opus 4.6 or Sonnet 4.6.

251

252<Note>

253 The `settings.availableModels` allowlist still applies when using third-party providers. Filtering matches on the model alias (`opus`, `sonnet`, `haiku`), not the provider-specific model ID.

254</Note>

255

256### Override model IDs per version

257

258The family-level environment variables above configure one model ID per family alias. If you need to map several versions within the same family to distinct provider IDs, use the `modelOverrides` setting instead.

259

260`modelOverrides` maps individual Anthropic model IDs to the provider-specific strings that Claude Code sends to your provider's API. When a user selects a mapped model in the `/model` picker, Claude Code uses your configured value instead of the built-in default.

261

262This lets enterprise administrators route each model version to a specific Bedrock inference profile ARN, Vertex AI version name, or Foundry deployment name for governance, cost allocation, or regional routing.

263

264Set `modelOverrides` in your [settings file](/en/settings#settings-files):

265

266```json theme={null}

267{

268 "modelOverrides": {

269 "claude-opus-4-6": "arn:aws:bedrock:us-east-2:123456789012:application-inference-profile/opus-prod",

270 "claude-opus-4-5-20251101": "arn:aws:bedrock:us-east-2:123456789012:application-inference-profile/opus-45-prod",

271 "claude-sonnet-4-6": "arn:aws:bedrock:us-east-2:123456789012:application-inference-profile/sonnet-prod"

272 }

273}

274```

275

276Keys must be Anthropic model IDs as listed in the [Models overview](https://platform.claude.com/docs/en/about-claude/models/overview). For dated model IDs, include the date suffix exactly as it appears there. Unknown keys are ignored.

277

278Overrides replace the built-in model IDs that back each entry in the `/model` picker. On Bedrock, overrides take precedence over any inference profiles that Claude Code discovers automatically at startup. Values you supply directly through `ANTHROPIC_MODEL`, `--model`, or the `ANTHROPIC_DEFAULT_*_MODEL` environment variables are passed to the provider as-is and are not transformed by `modelOverrides`.

279

280`modelOverrides` works alongside `availableModels`. The allowlist is evaluated against the Anthropic model ID, not the override value, so an entry like `"opus"` in `availableModels` continues to match even when Opus versions are mapped to ARNs.

281

118### Prompt caching configuration282### Prompt caching configuration

119 283

120Claude Code automatically uses [prompt caching](https://docs.claude.com/en/docs/build-with-claude/prompt-caching) to optimize performance and reduce costs. You can disable prompt caching globally or for specific model tiers:284Claude Code automatically uses [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) to optimize performance and reduce costs. You can disable prompt caching globally or for specific model tiers:

121 285

122| Env var | Description |286| Environment variable | Description |

123| ------------------------------- | ---------------------------------------------------------------------------------------------- |287| ------------------------------- | ---------------------------------------------------------------------------------------------- |

124| `DISABLE_PROMPT_CACHING` | Set to `1` to disable prompt caching for all models (takes precedence over per-model settings) |288| `DISABLE_PROMPT_CACHING` | Set to `1` to disable prompt caching for all models (takes precedence over per-model settings) |

monitoring-usage.md +138 −99

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Monitoring5# Monitoring

2 6

3> Learn how to enable and configure OpenTelemetry for Claude Code.7> Learn how to enable and configure OpenTelemetry for Claude Code.

4 8

~~5Claude Code supports OpenTelemetry (OTel) metrics and events for monitoring and observability.~~9Track Claude Code usage, costs, and tool activity across your organization by exporting telemetry data through OpenTelemetry (OTel). Claude Code exports metrics as time series data via the standard metrics protocol, and events via the logs/events protocol. Configure your metrics and logs backends to match your monitoring requirements.

7All metrics are time series data exported via OpenTelemetry's standard metrics protocol, and events are exported via OpenTelemetry's logs/events protocol. It is the user's responsibility to ensure their metrics and logs backends are properly configured and that the aggregation granularity meets their monitoring requirements.

8 10

~~9## Quick Start~~11## Quick start

10 12

11Configure OpenTelemetry using environment variables:13Configure OpenTelemetry using environment variables:

12 14

39 41

40For full configuration options, see the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options).42For full configuration options, see the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options).

41 43

~~42## Administrator Configuration~~44## Administrator configuration

44Administrators can configure OpenTelemetry settings for all users through the managed settings file. This allows for centralized control of telemetry settings across an organization. See the [settings precedence](/en/settings#settings-precedence) for more information about how settings are applied.

45 45

~~46The managed settings file is located at:~~46Administrators can configure OpenTelemetry settings for all users through the [managed settings file](/en/settings#settings-files). This allows for centralized control of telemetry settings across an organization. See the [settings precedence](/en/settings#settings-precedence) for more information about how settings are applied.

~~48* macOS: `/Library/Application Support/ClaudeCode/managed-settings.json`~~

~~49* Linux and WSL: `/etc/claude-code/managed-settings.json`~~

~~50* Windows: `C:\ProgramData\ClaudeCode\managed-settings.json`~~

51 47

52Example managed settings configuration:48Example managed settings configuration:

53 49

58 "OTEL_METRICS_EXPORTER": "otlp",54 "OTEL_METRICS_EXPORTER": "otlp",

59 "OTEL_LOGS_EXPORTER": "otlp",55 "OTEL_LOGS_EXPORTER": "otlp",

60 "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",56 "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",

~~61 "OTEL_EXPORTER_OTLP_ENDPOINT": "http://collector.company.com:4317",~~57 "OTEL_EXPORTER_OTLP_ENDPOINT": "http://collector.example.com:4317",

~~62 "OTEL_EXPORTER_OTLP_HEADERS": "Authorization=Bearer company-token"~~58 "OTEL_EXPORTER_OTLP_HEADERS": "Authorization=Bearer example-token"

63 }59 }

64}60}

65```61```

68 Managed settings can be distributed via MDM (Mobile Device Management) or other device management solutions. Environment variables defined in the managed settings file have high precedence and cannot be overridden by users.64 Managed settings can be distributed via MDM (Mobile Device Management) or other device management solutions. Environment variables defined in the managed settings file have high precedence and cannot be overridden by users.

69</Note>65</Note>

70 66

~~71## Configuration Details~~67## Configuration details

72 68

~~73### Common Configuration Variables~~69### Common configuration variables

74 70

~~76| ----------------------------------------------- | --------------------------------------------------------- | ------------------------------------ |~~72| --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |

77| `CLAUDE_CODE_ENABLE_TELEMETRY` | Enables telemetry collection (required) | `1` |73| `CLAUDE_CODE_ENABLE_TELEMETRY` | Enables telemetry collection (required) | `1` |

89| `OTEL_METRIC_EXPORT_INTERVAL` | Export interval in milliseconds (default: 60000) | `5000`, `60000` |85| `OTEL_METRIC_EXPORT_INTERVAL` | Export interval in milliseconds (default: 60000) | `5000`, `60000` |

90| `OTEL_LOGS_EXPORT_INTERVAL` | Logs export interval in milliseconds (default: 5000) | `1000`, `10000` |86| `OTEL_LOGS_EXPORT_INTERVAL` | Logs export interval in milliseconds (default: 5000) | `1000`, `10000` |

88| `OTEL_LOG_TOOL_DETAILS` | Enable logging of tool input arguments, MCP server/tool names, and skill names in tool events (default: disabled) | `1` to enable |

89| `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` | Metrics temporality preference (default: `delta`). Set to `cumulative` if your backend expects cumulative temporality | `delta`, `cumulative` |

90| `CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS` | Interval for refreshing dynamic headers (default: 1740000ms / 29 minutes) | `900000` |

92 91

~~93### Metrics Cardinality Control~~92### Metrics cardinality control

94 93

95The following environment variables control which attributes are included in metrics to manage cardinality:94The following environment variables control which attributes are included in metrics to manage cardinality:

96 95

~~98| ----------------------------------- | ----------------------------------------------- | ------------- | ------------------ |~~97| ----------------------------------- | --------------------------------------------------------------------- | ------------- | ------------------ |

102 101

103These variables help control the cardinality of metrics, which affects storage requirements and query performance in your metrics backend. Lower cardinality generally means better performance and lower storage costs but less granular data for analysis.102These variables help control the cardinality of metrics, which affects storage requirements and query performance in your metrics backend. Lower cardinality generally means better performance and lower storage costs but less granular data for analysis.

104 103

105### Dynamic Headers104### Dynamic headers

106 105

107For enterprise environments that require dynamic authentication, you can configure a script to generate headers dynamically:106For enterprise environments that require dynamic authentication, you can configure a script to generate headers dynamically:

108 107

109#### Settings Configuration108#### Settings configuration

110 109

111Add to your `.claude/settings.json`:110Add to your `.claude/settings.json`:

112 111

116}115}

117```116```

118 117

119#### Script Requirements118#### Script requirements

120 119

121The script must output valid JSON with string key-value pairs representing HTTP headers:120The script must output valid JSON with string key-value pairs representing HTTP headers:

122 121

126echo "{\"Authorization\": \"Bearer $(get-token.sh)\", \"X-API-Key\": \"$(get-api-key.sh)\"}"125echo "{\"Authorization\": \"Bearer $(get-token.sh)\", \"X-API-Key\": \"$(get-api-key.sh)\"}"

127```126```

128 127

129#### Important Limitations128#### Refresh behavior

~~130~~

131**Headers are fetched only at startup, not during runtime.** This is due to OpenTelemetry exporter architecture limitations.

132 129

133For scenarios requiring frequent token refresh, use an OpenTelemetry Collector as a proxy that can refresh its own headers.130The headers helper script runs at startup and periodically thereafter to support token refresh. By default, the script runs every 29 minutes. Customize the interval with the `CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS` environment variable.

134 131

135### Multi-Team Organization Support132### Multi-team organization support

136 133

137Organizations with multiple teams or departments can add custom attributes to distinguish between different groups using the `OTEL_RESOURCE_ATTRIBUTES` environment variable:134Organizations with multiple teams or departments can add custom attributes to distinguish between different groups using the `OTEL_RESOURCE_ATTRIBUTES` environment variable:

138 135

151<Warning>148<Warning>

152 **Important formatting requirements for OTEL\_RESOURCE\_ATTRIBUTES:**149 **Important formatting requirements for OTEL\_RESOURCE\_ATTRIBUTES:**

153 150

154 The `OTEL_RESOURCE_ATTRIBUTES` environment variable follows the [W3C Baggage specification](https://www.w3.org/TR/baggage/), which has strict formatting requirements:151 The `OTEL_RESOURCE_ATTRIBUTES` environment variable uses comma-separated key=value pairs with strict formatting requirements:

155 152

156 * **No spaces allowed**: Values cannot contain spaces. For example, `user.organizationName=My Company` is invalid153 * **No spaces allowed**: Values cannot contain spaces. For example, `user.organizationName=My Company` is invalid

157 * **Format**: Must be comma-separated key=value pairs: `key1=value1,key2=value2`154 * **Format**: Must be comma-separated key=value pairs: `key1=value1,key2=value2`

172 export OTEL_RESOURCE_ATTRIBUTES="org.name=John%27s%20Organization"169 export OTEL_RESOURCE_ATTRIBUTES="org.name=John%27s%20Organization"

173 ```170 ```

174 171

175 Note: Quoting the entire key=value pair (e.g., `"key=value with spaces"`) is not supported by the OpenTelemetry specification and will result in attributes being prefixed with quotes.172 Note: wrapping values in quotes doesn't escape spaces. For example, `org.name="My Company"` results in the literal value `"My Company"` (with quotes included), not `My Company`.

176</Warning>173</Warning>

177 174

178### Example Configurations175### Example configurations

176

177Set these environment variables before running `claude`. Each block shows a complete configuration for a different exporter or deployment scenario:

179 178

180```bash theme={null}179```bash theme={null}

181# Console debugging (1-second intervals)180# Console debugging (1-second intervals)

203export OTEL_METRICS_EXPORTER=otlp202export OTEL_METRICS_EXPORTER=otlp

204export OTEL_LOGS_EXPORTER=otlp203export OTEL_LOGS_EXPORTER=otlp

205export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf204export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf

206export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://metrics.company.com:4318205export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://metrics.example.com:4318

207export OTEL_EXPORTER_OTLP_LOGS_PROTOCOL=grpc206export OTEL_EXPORTER_OTLP_LOGS_PROTOCOL=grpc

208export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://logs.company.com:4317207export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://logs.example.com:4317

209 208

210# Metrics only (no events/logs)209# Metrics only (no events/logs)

211export CLAUDE_CODE_ENABLE_TELEMETRY=1210export CLAUDE_CODE_ENABLE_TELEMETRY=1

220export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317219export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317

221```220```

222 221

223## Available Metrics and Events222## Available metrics and events

224 223

225### Standard Attributes224### Standard attributes

226 225

227All metrics and events share these standard attributes:226All metrics and events share these standard attributes:

228 227

230| ------------------- | ------------------------------------------------------------- | --------------------------------------------------- |229| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |

235| `user.id` | Anonymous device/installation identifier, generated per Claude Code installation | Always included |

236| `user.email` | User email address (when authenticated via OAuth) | Always included when available |

237| `terminal.type` | Terminal type, such as `iTerm.app`, `vscode`, `cursor`, or `tmux` | Always included when detected |

238

239Events additionally include the following attributes. These are never attached to metrics because they would cause unbounded cardinality:

240

241* `prompt.id`: UUID correlating a user prompt with all subsequent events until the next prompt. See [Event correlation attributes](#event-correlation-attributes).

242* `workspace.host_paths`: host workspace directories selected in the desktop app, as a string array

236 243

237### Metrics244### Metrics

238 245

250| `claude_code.active_time.total` | Total active time in seconds | s |257| `claude_code.active_time.total` | Total active time in seconds | s |

251 258

252### Metric Details259### Metric details

260

261Each metric includes the standard attributes listed above. Metrics with additional context-specific attributes are noted below.

253 262

254#### Session Counter263#### Session counter

255 264

256Incremented at the start of each session.265Incremented at the start of each session.

257 266

259 268

260* All [standard attributes](#standard-attributes)269* All [standard attributes](#standard-attributes)

261 270

262#### Lines of Code Counter271#### Lines of code counter

263 272

264Incremented when code is added or removed.273Incremented when code is added or removed.

265 274

268* All [standard attributes](#standard-attributes)277* All [standard attributes](#standard-attributes)

269* `type`: (`"added"`, `"removed"`)278* `type`: (`"added"`, `"removed"`)

270 279

271#### Pull Request Counter280#### Pull request counter

272 281

273Incremented when creating pull requests via Claude Code.282Incremented when creating pull requests via Claude Code.

274 283

276 285

277* All [standard attributes](#standard-attributes)286* All [standard attributes](#standard-attributes)

278 287

279#### Commit Counter288#### Commit counter

280 289

281Incremented when creating git commits via Claude Code.290Incremented when creating git commits via Claude Code.

282 291

284 293

285* All [standard attributes](#standard-attributes)294* All [standard attributes](#standard-attributes)

286 295

287#### Cost Counter296#### Cost counter

288 297

289Incremented after each API request.298Incremented after each API request.

290 299

291**Attributes**:300**Attributes**:

292 301

293* All [standard attributes](#standard-attributes)302* All [standard attributes](#standard-attributes)

294* `model`: Model identifier (e.g., "claude-sonnet-4-5-20250929")303* `model`: Model identifier (for example, "claude-sonnet-4-6")

295 304

296#### Token Counter305#### Token counter

297 306

298Incremented after each API request.307Incremented after each API request.

299 308

301 310

302* All [standard attributes](#standard-attributes)311* All [standard attributes](#standard-attributes)

303* `type`: (`"input"`, `"output"`, `"cacheRead"`, `"cacheCreation"`)312* `type`: (`"input"`, `"output"`, `"cacheRead"`, `"cacheCreation"`)

304* `model`: Model identifier (e.g., "claude-sonnet-4-5-20250929")313* `model`: Model identifier (for example, "claude-sonnet-4-6")

305 314

306#### Code Edit Tool Decision Counter315#### Code edit tool decision counter

307 316

308Incremented when user accepts or rejects Edit, Write, or NotebookEdit tool usage.317Incremented when user accepts or rejects Edit, Write, or NotebookEdit tool usage.

309 318

310**Attributes**:319**Attributes**:

311 320

312* All [standard attributes](#standard-attributes)321* All [standard attributes](#standard-attributes)

313* `tool`: Tool name (`"Edit"`, `"Write"`, `"NotebookEdit"`)322* `tool_name`: Tool name (`"Edit"`, `"Write"`, `"NotebookEdit"`)

314* `decision`: User decision (`"accept"`, `"reject"`)323* `decision`: User decision (`"accept"`, `"reject"`)

315* `language`: Programming language of the edited file (e.g., `"TypeScript"`, `"Python"`, `"JavaScript"`, `"Markdown"`). Returns `"unknown"` for unrecognized file extensions.324* `source`: Decision source - `"config"`, `"hook"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`

325* `language`: Programming language of the edited file, such as `"TypeScript"`, `"Python"`, `"JavaScript"`, or `"Markdown"`. Returns `"unknown"` for unrecognized file extensions.

316 326

317#### Active Time Counter327#### Active time counter

318 328

319Tracks actual time spent actively using Claude Code (not idle time). This metric is incremented during user interactions such as typing prompts or receiving responses.329Tracks actual time spent actively using Claude Code, excluding idle time. This metric is incremented during user interactions (typing, reading responses) and during CLI processing (tool execution, AI response generation).

320 330

321**Attributes**:331**Attributes**:

322 332

323* All [standard attributes](#standard-attributes)333* All [standard attributes](#standard-attributes)

334* `type`: `"user"` for keyboard interactions, `"cli"` for tool execution and AI responses

324 335

325### Events336### Events

326 337

327Claude Code exports the following events via OpenTelemetry logs/events (when `OTEL_LOGS_EXPORTER` is configured):338Claude Code exports the following events via OpenTelemetry logs/events (when `OTEL_LOGS_EXPORTER` is configured):

328 339

329#### User Prompt Event340#### Event correlation attributes

341

342When a user submits a prompt, Claude Code may make multiple API calls and run several tools. The `prompt.id` attribute lets you tie all of those events back to the single prompt that triggered them.

343

344| Attribute | Description |

345| ----------- | ------------------------------------------------------------------------------------ |

346| `prompt.id` | UUID v4 identifier linking all events produced while processing a single user prompt |

347

348To trace all activity triggered by a single prompt, filter your events by a specific `prompt.id` value. This returns the user\_prompt event, any api\_request events, and any tool\_result events that occurred while processing that prompt.

349

350<Note>

351 `prompt.id` is intentionally excluded from metrics because each prompt generates a unique ID, which would create an ever-growing number of time series. Use it for event-level analysis and audit trails only.

352</Note>

353

354#### User prompt event

330 355

331Logged when a user submits a prompt.356Logged when a user submits a prompt.

332 357

337* All [standard attributes](#standard-attributes)362* All [standard attributes](#standard-attributes)

338* `event.name`: `"user_prompt"`363* `event.name`: `"user_prompt"`

339* `event.timestamp`: ISO 8601 timestamp364* `event.timestamp`: ISO 8601 timestamp

365* `event.sequence`: monotonically increasing counter for ordering events within a session

340* `prompt_length`: Length of the prompt366* `prompt_length`: Length of the prompt

341* `prompt`: Prompt content (redacted by default, enable with `OTEL_LOG_USER_PROMPTS=1`)367* `prompt`: Prompt content (redacted by default, enable with `OTEL_LOG_USER_PROMPTS=1`)

342 368

343#### Tool Result Event369#### Tool result event

344 370

345Logged when a tool completes execution.371Logged when a tool completes execution.

346 372

351* All [standard attributes](#standard-attributes)377* All [standard attributes](#standard-attributes)

352* `event.name`: `"tool_result"`378* `event.name`: `"tool_result"`

353* `event.timestamp`: ISO 8601 timestamp379* `event.timestamp`: ISO 8601 timestamp

380* `event.sequence`: monotonically increasing counter for ordering events within a session

354* `tool_name`: Name of the tool381* `tool_name`: Name of the tool

355* `success`: `"true"` or `"false"`382* `success`: `"true"` or `"false"`

356* `duration_ms`: Execution time in milliseconds383* `duration_ms`: Execution time in milliseconds

357* `error`: Error message (if failed)384* `error`: Error message (if failed)

358* `decision`: Either `"accept"` or `"reject"`385* `decision_type`: Either `"accept"` or `"reject"`

359* `source`: Decision source - `"config"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`386* `decision_source`: Decision source - `"config"`, `"hook"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`

387* `tool_result_size_bytes`: Size of the tool result in bytes

388* `mcp_server_scope`: MCP server scope identifier (for MCP tools)

360* `tool_parameters`: JSON string containing tool-specific parameters (when available)389* `tool_parameters`: JSON string containing tool-specific parameters (when available)

361 * For Bash tool: includes `bash_command`, `full_command`, `timeout`, `description`, `sandbox`390 * For Bash tool: includes `bash_command`, `full_command`, `timeout`, `description`, `dangerouslyDisableSandbox`, and `git_commit_id` (the commit SHA, when a `git commit` command succeeds)

391 * For MCP tools (when `OTEL_LOG_TOOL_DETAILS=1`): includes `mcp_server_name`, `mcp_tool_name`

392 * For Skill tool (when `OTEL_LOG_TOOL_DETAILS=1`): includes `skill_name`

393* `tool_input` (when `OTEL_LOG_TOOL_DETAILS=1`): JSON-serialized tool arguments. Individual values over 512 characters are truncated, and the full payload is bounded to \~4 K characters. Applies to all tools including MCP tools.

362 394

363#### API Request Event395#### API request event

364 396

365Logged for each API request to Claude.397Logged for each API request to Claude.

366 398

371* All [standard attributes](#standard-attributes)403* All [standard attributes](#standard-attributes)

372* `event.name`: `"api_request"`404* `event.name`: `"api_request"`

373* `event.timestamp`: ISO 8601 timestamp405* `event.timestamp`: ISO 8601 timestamp

374* `model`: Model used (e.g., "claude-sonnet-4-5-20250929")406* `event.sequence`: monotonically increasing counter for ordering events within a session

407* `model`: Model used (for example, "claude-sonnet-4-6")

375* `cost_usd`: Estimated cost in USD408* `cost_usd`: Estimated cost in USD

376* `duration_ms`: Request duration in milliseconds409* `duration_ms`: Request duration in milliseconds

377* `input_tokens`: Number of input tokens410* `input_tokens`: Number of input tokens

378* `output_tokens`: Number of output tokens411* `output_tokens`: Number of output tokens

379* `cache_read_tokens`: Number of tokens read from cache412* `cache_read_tokens`: Number of tokens read from cache

380* `cache_creation_tokens`: Number of tokens used for cache creation413* `cache_creation_tokens`: Number of tokens used for cache creation

414* `speed`: `"fast"` or `"normal"`, indicating whether fast mode was active

381 415

382#### API Error Event416#### API error event

383 417

384Logged when an API request to Claude fails.418Logged when an API request to Claude fails.

385 419

390* All [standard attributes](#standard-attributes)424* All [standard attributes](#standard-attributes)

391* `event.name`: `"api_error"`425* `event.name`: `"api_error"`

392* `event.timestamp`: ISO 8601 timestamp426* `event.timestamp`: ISO 8601 timestamp

393* `model`: Model used (e.g., "claude-sonnet-4-5-20250929")427* `event.sequence`: monotonically increasing counter for ordering events within a session

428* `model`: Model used (for example, "claude-sonnet-4-6")

394* `error`: Error message429* `error`: Error message

395* `status_code`: HTTP status code (if applicable)430* `status_code`: HTTP status code as a string, or `"undefined"` for non-HTTP errors

396* `duration_ms`: Request duration in milliseconds431* `duration_ms`: Request duration in milliseconds

397* `attempt`: Attempt number (for retried requests)432* `attempt`: Attempt number (for retried requests)

433* `speed`: `"fast"` or `"normal"`, indicating whether fast mode was active

398 434

399#### Tool Decision Event435#### Tool decision event

400 436

401Logged when a tool permission decision is made (accept/reject).437Logged when a tool permission decision is made (accept/reject).

402 438

407* All [standard attributes](#standard-attributes)443* All [standard attributes](#standard-attributes)

408* `event.name`: `"tool_decision"`444* `event.name`: `"tool_decision"`

409* `event.timestamp`: ISO 8601 timestamp445* `event.timestamp`: ISO 8601 timestamp

410* `tool_name`: Name of the tool (e.g., "Read", "Edit", "Write", "NotebookEdit", etc.)446* `event.sequence`: monotonically increasing counter for ordering events within a session

447* `tool_name`: Name of the tool (for example, "Read", "Edit", "Write", "NotebookEdit")

411* `decision`: Either `"accept"` or `"reject"`448* `decision`: Either `"accept"` or `"reject"`

412* `source`: Decision source - `"config"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`449* `source`: Decision source - `"config"`, `"hook"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`

413 450

414## Interpreting Metrics and Events Data451## Interpret metrics and events data

415 452

416The metrics exported by Claude Code provide valuable insights into usage patterns and productivity. Here are some common visualizations and analyses you can create:453The exported metrics and events support a range of analyses:

417 454

418### Usage Monitoring455### Usage monitoring

419 456

420| Metric | Analysis Opportunity |457| Metric | Analysis Opportunity |

421| ------------------------------------------------------------- | --------------------------------------------------------- |458| ------------------------------------------------------------- | --------------------------------------------------------- |

426 463

427### Cost Monitoring464### Cost monitoring

428 465

429The `claude_code.cost.usage` metric helps with:466The `claude_code.cost.usage` metric helps with:

430 467

435 Cost metrics are approximations. For official billing data, refer to your API provider (Claude Console, AWS Bedrock, or Google Cloud Vertex).472 Cost metrics are approximations. For official billing data, refer to your API provider (Claude Console, AWS Bedrock, or Google Cloud Vertex).

436</Note>473</Note>

437 474

438### Alerting and Segmentation475### Alerting and segmentation

439 476

440Common alerts to consider:477Common alerts to consider:

441 478

443* Unusual token consumption480* Unusual token consumption

444* High session volume from specific users481* High session volume from specific users

445 482

446All metrics can be segmented by `user.account_uuid`, `organization.id`, `session.id`, `model`, and `app.version`.483All metrics can be segmented by `user.account_uuid`, `user.account_id`, `organization.id`, `session.id`, `model`, and `app.version`.

447 484

448### Event Analysis485### Event analysis

449 486

450The event data provides detailed insights into Claude Code interactions:487The event data provides detailed insights into Claude Code interactions:

451 488

452**Tool Usage Patterns**: Analyze tool result events to identify:489**Tool Usage Patterns**: analyze tool result events to identify:

453 490

454* Most frequently used tools491* Most frequently used tools

455* Tool success rates492* Tool success rates

456* Average tool execution times493* Average tool execution times

457* Error patterns by tool type494* Error patterns by tool type

458 495

459**Performance Monitoring**: Track API request durations and tool execution times to identify performance bottlenecks.496**Performance Monitoring**: track API request durations and tool execution times to identify performance bottlenecks.

460 497

461## Backend Considerations498## Backend considerations

462 499

463Your choice of metrics and logs backends will determine the types of analyses you can perform:500Your choice of metrics and logs backends determines the types of analyses you can perform:

464 501

465### For Metrics:502### For metrics

466 503

467* **Time series databases (e.g., Prometheus)**: Rate calculations, aggregated metrics504* **Time series databases (for example, Prometheus)**: Rate calculations, aggregated metrics

468* **Columnar stores (e.g., ClickHouse)**: Complex queries, unique user analysis505* **Columnar stores (for example, ClickHouse)**: Complex queries, unique user analysis

469* **Full-featured observability platforms (e.g., Honeycomb, Datadog)**: Advanced querying, visualization, alerting506* **Full-featured observability platforms (for example, Honeycomb, Datadog)**: Advanced querying, visualization, alerting

470 507

471### For Events/Logs:508### For events/logs

472 509

473* **Log aggregation systems (e.g., Elasticsearch, Loki)**: Full-text search, log analysis510* **Log aggregation systems (for example, Elasticsearch, Loki)**: Full-text search, log analysis

474* **Columnar stores (e.g., ClickHouse)**: Structured event analysis511* **Columnar stores (for example, ClickHouse)**: Structured event analysis

475* **Full-featured observability platforms (e.g., Honeycomb, Datadog)**: Correlation between metrics and events512* **Full-featured observability platforms (for example, Honeycomb, Datadog)**: Correlation between metrics and events

476 513

477For organizations requiring Daily/Weekly/Monthly Active User (DAU/WAU/MAU) metrics, consider backends that support efficient unique value queries.514For organizations requiring Daily/Weekly/Monthly Active User (DAU/WAU/MAU) metrics, consider backends that support efficient unique value queries.

478 515

479## Service Information516## Service information

480 517

481All metrics and events are exported with the following resource attributes:518All metrics and events are exported with the following resource attributes:

482 519

483* `service.name`: `claude-code`520* `service.name`: `claude-code`

484* `service.version`: Current Claude Code version521* `service.version`: Current Claude Code version

485* `os.type`: Operating system type (e.g., `linux`, `darwin`, `windows`)522* `os.type`: Operating system type (for example, `linux`, `darwin`, `windows`)

486* `os.version`: Operating system version string523* `os.version`: Operating system version string

487* `host.arch`: Host architecture (e.g., `amd64`, `arm64`)524* `host.arch`: Host architecture (for example, `amd64`, `arm64`)

488* `wsl.version`: WSL version number (only present when running on Windows Subsystem for Linux)525* `wsl.version`: WSL version number (only present when running on Windows Subsystem for Linux)

489* Meter Name: `com.anthropic.claude_code`526* Meter Name: `com.anthropic.claude_code`

490 527

491## ROI Measurement Resources528## ROI measurement resources

492 529

493For a comprehensive guide on measuring return on investment for Claude Code, including telemetry setup, cost analysis, productivity metrics, and automated reporting, see the [Claude Code ROI Measurement Guide](https://github.com/anthropics/claude-code-monitoring-guide). This repository provides ready-to-use Docker Compose configurations, Prometheus and OpenTelemetry setups, and templates for generating productivity reports integrated with tools like Linear.530For a comprehensive guide on measuring return on investment for Claude Code, including telemetry setup, cost analysis, productivity metrics, and automated reporting, see the [Claude Code ROI Measurement Guide](https://github.com/anthropics/claude-code-monitoring-guide). This repository provides ready-to-use Docker Compose configurations, Prometheus and OpenTelemetry setups, and templates for generating productivity reports integrated with tools like Linear.

494 531

495## Security/Privacy Considerations532## Security and privacy

496 533

497* Telemetry is opt-in and requires explicit configuration534* Telemetry is opt-in and requires explicit configuration

498* Sensitive information like API keys or file contents are never included in metrics or events535* Raw file contents and code snippets are not included in metrics or events. Tool execution events include bash commands and file paths in the `tool_parameters` field, which may contain sensitive values. If your commands may include secrets, configure your telemetry backend to filter or redact `tool_parameters`

499* User prompt content is redacted by default - only prompt length is recorded. To enable user prompt logging, set `OTEL_LOG_USER_PROMPTS=1`536* When authenticated via OAuth, `user.email` is included in telemetry attributes. If this is a concern for your organization, work with your telemetry backend to filter or redact this field

537* User prompt content is not collected by default. Only prompt length is recorded. To include prompt content, set `OTEL_LOG_USER_PROMPTS=1`

538* Tool input arguments are not logged by default. To include them, set `OTEL_LOG_TOOL_DETAILS=1`. When enabled, `tool_result` events include MCP server/tool names and skill names plus a `tool_input` attribute with file paths, URLs, search patterns, and other arguments. Individual values over 512 characters are truncated and the total is bounded to \~4 K characters, but the arguments may still contain sensitive values. Configure your telemetry backend to filter or redact `tool_input` as needed

500 539

501## Monitoring Claude Code on Amazon Bedrock540## Monitor Claude Code on Amazon Bedrock

502 541

503For detailed Claude Code usage monitoring guidance for Amazon Bedrock, see [Claude Code Monitoring Implementation (Bedrock)](https://github.com/aws-solutions-library-samples/guidance-for-claude-code-with-amazon-bedrock/blob/main/assets/docs/MONITORING.md).542For detailed Claude Code usage monitoring guidance for Amazon Bedrock, see [Claude Code Monitoring Implementation (Bedrock)](https://github.com/aws-solutions-library-samples/guidance-for-claude-code-with-amazon-bedrock/blob/main/assets/docs/MONITORING.md).

network-config.md +15 −5

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Enterprise network configuration5# Enterprise network configuration

2 6

3> Configure Claude Code for enterprise environments with proxy servers, custom Certificate Authorities (CA), and mutual Transport Layer Security (mTLS) authentication.7> Configure Claude Code for enterprise environments with proxy servers, custom Certificate Authorities (CA), and mutual Transport Layer Security (mTLS) authentication.

76 80

77Claude Code requires access to the following URLs:81Claude Code requires access to the following URLs:

78 82

~~79* `api.anthropic.com` - Claude API endpoints~~83* `api.anthropic.com`: Claude API endpoints

~~80* `claude.ai` - WebFetch safeguards~~84* `claude.ai`: authentication for claude.ai accounts

~~81* `statsig.anthropic.com` - Telemetry and metrics~~85* `platform.claude.com`: authentication for Anthropic Console accounts

~~82* `sentry.io` - Error reporting~~

83 86

84Ensure these URLs are allowlisted in your proxy configuration and firewall rules. This is especially important when using Claude Code in containerized or restricted network environments.87Ensure these URLs are allowlisted in your proxy configuration and firewall rules. This is especially important when using Claude Code in containerized or restricted network environments.

85 88

89The native installer and update checks also require the following URLs. If you install Claude Code through npm or manage your own binary distribution, end users may not need access:

91* `downloads.claude.ai`: CDN hosting the install script, version pointers, manifests, and executables

92* `storage.googleapis.com`: legacy download bucket, deprecation in progress

94[Claude Code on the web](/en/claude-code-on-the-web) and [Code Review](/en/code-review) connect to your repositories from Anthropic-managed infrastructure. If your GitHub Enterprise Cloud organization restricts access by IP address, enable [IP allow list inheritance for installed GitHub Apps](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#allowing-access-by-github-apps). The Claude GitHub App registers its IP ranges, so enabling this setting allows access without manual configuration. To [add the ranges to your allow list manually](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#adding-an-allowed-ip-address) instead, or to configure other firewalls, see the [Anthropic API IP addresses](https://platform.claude.com/docs/en/api/ip-addresses).

86## Additional resources96## Additional resources

87 97

88* [Claude Code settings](/en/settings)98* [Claude Code settings](/en/settings)

~~89* [Environment variables reference](/en/settings#environment-variables)~~99* [Environment variables reference](/en/env-vars)

90* [Troubleshooting guide](/en/troubleshooting)100* [Troubleshooting guide](/en/troubleshooting)

output-styles.md +22 −14

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Output styles5# Output styles

2 6

3> Adapt Claude Code for uses beyond software engineering7> Adapt Claude Code for uses beyond software engineering

38 42

39## Change your output style43## Change your output style

40 44

~~41You can either:~~45Run `/config` and select **Output style** to pick a style from a menu. Your

46selection is saved to `.claude/settings.local.json` at the

47[local project level](/en/settings).

42 48

~~43* Run `/output-style` to access a menu and select your output style (this can~~49To set a style without the menu, edit the `outputStyle` field directly in a

~~44 also be accessed from the `/config` menu)~~50settings file:

45 51

~~46* Run `/output-style [style]`, such as `/output-style explanatory`, to directly~~52```json theme={null}

~~47 switch to a style~~53{

54 "outputStyle": "Explanatory"

55}

56```

48 57

~~49These changes apply to the [local project level](/en/settings) and are saved in~~58Because the output style is set in the system prompt at session start,

~~50`.claude/settings.local.json`. You can also directly edit the `outputStyle`~~59changes take effect the next time you start a new session. This keeps the system

~~51field in a settings file at a different level.~~60prompt stable throughout a conversation so prompt caching can reduce latency and

61cost.

52 62

53## Create a custom output style63## Create a custom output style

54 64

77 87

78### Frontmatter88### Frontmatter

79 89

~~80Output style files support frontmatter, useful for specifying metadata about the~~90Output style files support frontmatter for specifying metadata:

~~81command:~~

82 91

84| :------------------------- | :-------------------------------------------------------------------------- | :---------------------- |93| :------------------------- | :-------------------------------------------------------------------------- | :---------------------- |

88 97

89## Comparisons to related features98## Comparisons to related features

103settings like the model to use, the tools they have available, and some context112settings like the model to use, the tools they have available, and some context

104about when to use the agent.113about when to use the agent.

105 114

106### Output Styles vs. [Custom Slash Commands](/en/slash-commands)115### Output Styles vs. [Skills](/en/skills)

107 116

108You can think of output styles as "stored system prompts" and custom slash117Output styles modify how Claude responds (formatting, tone, structure) and are always active once selected. Skills are task-specific prompts that you invoke with `/skill-name` or that Claude loads automatically when relevant. Use output styles for consistent formatting preferences; use skills for reusable workflows and tasks.

109commands as "stored prompts".

overview.md +186 −73

Details

~~1# Claude Code overview~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Learn about Claude Code, Anthropic's agentic coding tool that lives in your terminal and helps you turn ideas into code faster than ever before.~~5# Claude Code overview

4 6

~~5## Get started in 30 seconds~~7> Claude Code is an agentic coding tool that reads your codebase, edits files, runs commands, and integrates with your development tools. Available in your terminal, IDE, desktop app, and browser.

6 8

~~7Prerequisites:~~9Claude Code is an AI-powered coding assistant that helps you build features, fix bugs, and automate development tasks. It understands your entire codebase and can work across multiple files and tools to get things done.

8 10

~~9* A [Claude.ai](https://claude.ai) (recommended) or [Claude Console](https://console.anthropic.com/) account~~11## Get started

10 12

~~11**Install Claude Code:**~~13Choose your environment to get started. Most surfaces require a [Claude subscription](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=overview_pricing) or [Anthropic Console](https://console.anthropic.com/) account. The Terminal CLI and VS Code also support [third-party providers](/en/third-party-integrations).

12 14

13<Tabs>15<Tabs>

~~14 <Tab title="macOS/Linux">~~16 <Tab title="Terminal">

17 The full-featured CLI for working with Claude Code directly in your terminal. Edit files, run commands, and manage your entire project from the command line.

19 To install Claude Code, use one of the following methods:

21 <Tabs>

22 <Tab title="Native Install (Recommended)">

23 **macOS, Linux, WSL:**

15 ```bash theme={null}25 ```bash theme={null}

16 curl -fsSL https://claude.ai/install.sh | bash26 curl -fsSL https://claude.ai/install.sh | bash

17 ```27 ```

29 **Windows PowerShell:**

31 ```powershell theme={null}

32 irm https://claude.ai/install.ps1 | iex

33 ```

35 **Windows CMD:**

37 ```batch theme={null}

38 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

39 ```

41 **Windows requires [Git for Windows](https://git-scm.com/downloads/win).** Install it first if you don't have it.

43 <Info>

44 Native installations automatically update in the background to keep you on the latest version.

45 </Info>

18 </Tab>46 </Tab>

19 47

20 <Tab title="Homebrew">48 <Tab title="Homebrew">

21 ```bash theme={null}49 ```bash theme={null}

22 brew install --cask claude-code50 brew install --cask claude-code

23 ```51 ```

53 <Info>

54 Homebrew installations do not auto-update. Run `brew upgrade claude-code` periodically to get the latest features and security fixes.

55 </Info>

24 </Tab>56 </Tab>

25 57

~~26 <Tab title="Windows">~~58 <Tab title="WinGet">

27 ```powershell theme={null}59 ```powershell theme={null}

~~28 irm https://claude.ai/install.ps1 | iex~~60 winget install Anthropic.ClaudeCode

29 ```61 ```

63 <Info>

64 WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.

65 </Info>

30 </Tab>66 </Tab>

67 </Tabs>

69 Then start Claude Code in any project:

31 70

~~32 <Tab title="NPM">~~

33 ```bash theme={null}71 ```bash theme={null}

~~34 npm install -g @anthropic-ai/claude-code~~72 cd your-project

73 claude

35 ```74 ```

36 75

~~37 Requires [Node.js 18+](https://nodejs.org/en/download/)~~76 You'll be prompted to log in on first use. That's it! [Continue with the Quickstart →](/en/quickstart)

78 <Tip>

79 See [advanced setup](/en/setup) for installation options, manual updates, or uninstallation instructions. Visit [troubleshooting](/en/troubleshooting) if you hit issues.

80 </Tip>

81 </Tab>

83 <Tab title="VS Code">

84 The VS Code extension provides inline diffs, @-mentions, plan review, and conversation history directly in your editor.

86 * [Install for VS Code](vscode:extension/anthropic.claude-code)

87 * [Install for Cursor](cursor:extension/anthropic.claude-code)

89 Or search for "Claude Code" in the Extensions view (`Cmd+Shift+X` on Mac, `Ctrl+Shift+X` on Windows/Linux). After installing, open the Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`), type "Claude Code", and select **Open in New Tab**.

91 [Get started with VS Code →](/en/vs-code#get-started)

92 </Tab>

94 <Tab title="Desktop app">

95 A standalone app for running Claude Code outside your IDE or terminal. Review diffs visually, run multiple sessions side by side, schedule recurring tasks, and kick off cloud sessions.

97 Download and install:

99 * [macOS](https://claude.ai/api/desktop/darwin/universal/dmg/latest/redirect?utm_source=claude_code\&utm_medium=docs) (Intel and Apple Silicon)

100 * [Windows](https://claude.ai/api/desktop/win32/x64/exe/latest/redirect?utm_source=claude_code\&utm_medium=docs) (x64)

101 * [Windows ARM64](https://claude.ai/api/desktop/win32/arm64/exe/latest/redirect?utm_source=claude_code\&utm_medium=docs) (remote sessions only)

102

103 After installing, launch Claude, sign in, and click the **Code** tab to start coding. A [paid subscription](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=overview_desktop_pricing) is required.

104

105 [Learn more about the desktop app →](/en/desktop-quickstart)

106 </Tab>

107

108 <Tab title="Web">

109 Run Claude Code in your browser with no local setup. Kick off long-running tasks and check back when they're done, work on repos you don't have locally, or run multiple tasks in parallel. Available on desktop browsers and the Claude iOS app.

110

111 Start coding at [claude.ai/code](https://claude.ai/code).

112

113 [Get started on the web →](/en/claude-code-on-the-web#getting-started)

114 </Tab>

115

116 <Tab title="JetBrains">

117 A plugin for IntelliJ IDEA, PyCharm, WebStorm, and other JetBrains IDEs with interactive diff viewing and selection context sharing.

118

119 Install the [Claude Code plugin](https://plugins.jetbrains.com/plugin/27310-claude-code-beta-) from the JetBrains Marketplace and restart your IDE.

120

121 [Get started with JetBrains →](/en/jetbrains)

38 </Tab>122 </Tab>

39</Tabs>123</Tabs>

40 124

~~41**Start using Claude Code:**~~125## What you can do

126

127Here are some of the ways you can use Claude Code:

128

129<AccordionGroup>

130 <Accordion title="Automate the work you keep putting off" icon="wand-magic-sparkles">

131 Claude Code handles the tedious tasks that eat up your day: writing tests for untested code, fixing lint errors across a project, resolving merge conflicts, updating dependencies, and writing release notes.

132

133 ```bash theme={null}

134 claude "write tests for the auth module, run them, and fix any failures"

135 ```

136 </Accordion>

42 137

~~43```bash theme={null}~~138 <Accordion title="Build features and fix bugs" icon="hammer">

~~44cd your-project~~139 Describe what you want in plain language. Claude Code plans the approach, writes the code across multiple files, and verifies it works.

~~45claude~~

~~46```~~

47 140

~~48You'll be prompted to log in on first use. That's it! [Continue with Quickstart (5 mins) →](/en/quickstart)~~141 For bugs, paste an error message or describe the symptom. Claude Code traces the issue through your codebase, identifies the root cause, and implements a fix. See [common workflows](/en/common-workflows) for more examples.

142 </Accordion>

49 143

~~50<Tip>~~144 <Accordion title="Create commits and pull requests" icon="code-branch">

~~51 See [advanced setup](/en/setup) for installation options or [troubleshooting](/en/troubleshooting) if you hit issues.~~145 Claude Code works directly with git. It stages changes, writes commit messages, creates branches, and opens pull requests.

~~52</Tip>~~

53 146

~~54<Note>~~147 ```bash theme={null}

55 **New VS Code Extension (Beta)**: Prefer a graphical interface? Our new [VS Code extension](/en/vs-code) provides an easy-to-use native IDE experience without requiring terminal familiarity. Simply install from the marketplace and start coding with Claude directly in your sidebar.148 claude "commit my changes with a descriptive message"

~~56</Note>~~149 ```

57 150

~~58## What Claude Code does for you~~151 In CI, you can automate code review and issue triage with [GitHub Actions](/en/github-actions) or [GitLab CI/CD](/en/gitlab-ci-cd).

152 </Accordion>

59 153

~~60* **Build features from descriptions**: Tell Claude what you want to build in plain English. It will make a plan, write the code, and ensure it works.~~154 <Accordion title="Connect your tools with MCP" icon="plug">

~~61* **Debug and fix issues**: Describe a bug or paste an error message. Claude Code will analyze your codebase, identify the problem, and implement a fix.~~155 The [Model Context Protocol (MCP)](/en/mcp) is an open standard for connecting AI tools to external data sources. With MCP, Claude Code can read your design docs in Google Drive, update tickets in Jira, pull data from Slack, or use your own custom tooling.

62* **Navigate any codebase**: Ask anything about your team's codebase, and get a thoughtful answer back. Claude Code maintains awareness of your entire project structure, can find up-to-date information from the web, and with [MCP](/en/mcp) can pull from external datasources like Google Drive, Figma, and Slack.156 </Accordion>

~~63* **Automate tedious tasks**: Fix fiddly lint issues, resolve merge conflicts, and write release notes. Do all this in a single command from your developer machines, or automatically in CI.~~

64 157

~~65## Why developers love Claude Code~~158 <Accordion title="Customize with instructions, skills, and hooks" icon="sliders">

159 [`CLAUDE.md`](/en/memory) is a markdown file you add to your project root that Claude Code reads at the start of every session. Use it to set coding standards, architecture decisions, preferred libraries, and review checklists. Claude also builds [auto memory](/en/memory#auto-memory) as it works, saving learnings like build commands and debugging insights across sessions without you writing anything.

66 160

~~67* **Works in your terminal**: Not another chat window. Not another IDE. Claude Code meets you where you already work, with the tools you already love.~~161 Create [custom commands](/en/skills) to package repeatable workflows your team can share, like `/review-pr` or `/deploy-staging`.

68* **Takes action**: Claude Code can directly edit files, run commands, and create commits. Need more? [MCP](/en/mcp) lets Claude read your design docs in Google Drive, update your tickets in Jira, or use *your* custom developer tooling.

69* **Unix philosophy**: Claude Code is composable and scriptable. `tail -f app.log | claude -p "Slack me if you see any anomalies appear in this log stream"` *works*. Your CI can run `claude -p "If there are new text strings, translate them into French and raise a PR for @lang-fr-team to review"`.

~~70* **Enterprise-ready**: Use the Claude API, or host on AWS or GCP. Enterprise-grade [security](/en/security), [privacy](/en/data-usage), and [compliance](https://trust.anthropic.com/) is built-in.~~

71 162

~~72## Next steps~~163 [Hooks](/en/hooks) let you run shell commands before or after Claude Code actions, like auto-formatting after every file edit or running lint before a commit.

164 </Accordion>

165

166 <Accordion title="Run agent teams and build custom agents" icon="users">

167 Spawn [multiple Claude Code agents](/en/sub-agents) that work on different parts of a task simultaneously. A lead agent coordinates the work, assigns subtasks, and merges results.

168

169 For fully custom workflows, the [Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview) lets you build your own agents powered by Claude Code's tools and capabilities, with full control over orchestration, tool access, and permissions.

170 </Accordion>

73 171

~~74<CardGroup>~~172 <Accordion title="Pipe, script, and automate with the CLI" icon="terminal">

~~75 <Card title="Quickstart" icon="rocket" href="/en/quickstart">~~173 Claude Code is composable and follows the Unix philosophy. Pipe logs into it, run it in CI, or chain it with other tools:

~~76 See Claude Code in action with practical examples~~

~~77 </Card>~~

78 174

~~79 <Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">~~175 ```bash theme={null}

~~80 Step-by-step guides for common workflows~~176 # Analyze recent log output

~~81 </Card>~~177 tail -200 app.log | claude -p "Slack me if you see any anomalies"

178

179 # Automate translations in CI

180 claude -p "translate new strings into French and raise a PR for review"

181

182 # Bulk operations across files

183 git diff main --name-only | claude -p "review these changed files for security issues"

184 ```

82 185

~~83 <Card title="Troubleshooting" icon="wrench" href="/en/troubleshooting">~~186 See the [CLI reference](/en/cli-reference) for the full set of commands and flags.

~~84 Solutions for common issues with Claude Code~~187 </Accordion>

~~85 </Card>~~

86 188

~~87 <Card title="IDE setup" icon="laptop" href="/en/vs-code">~~189 <Accordion title="Schedule recurring tasks" icon="clock">

~~88 Add Claude Code to your IDE~~190 Run Claude on a schedule to automate work that repeats: morning PR reviews, overnight CI failure analysis, weekly dependency audits, or syncing docs after PRs merge.

~~89 </Card>~~

~~90</CardGroup>~~

91 191

~~92## Additional resources~~192 * [Cloud scheduled tasks](/en/web-scheduled-tasks) run on Anthropic-managed infrastructure, so they keep running even when your computer is off. Create them from the web, the Desktop app, or by running `/schedule` in the CLI.

193 * [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) run on your machine, with direct access to your local files and tools

194 * [`/loop`](/en/scheduled-tasks) repeats a prompt within a CLI session for quick polling

195 </Accordion>

93 196

~~94<CardGroup>~~197 <Accordion title="Work from anywhere" icon="globe">

~~95 <Card title="Build with the Agent SDK" icon="code-branch" href="https://docs.claude.com/en/docs/agent-sdk/overview">~~198 Sessions aren't tied to a single surface. Move work between environments as your context changes:

~~96 Create custom AI agents with the Claude Agent SDK~~

~~97 </Card>~~

98 199

~~99 <Card title="Host on AWS or GCP" icon="cloud" href="/en/third-party-integrations">~~200 * Step away from your desk and keep working from your phone or any browser with [Remote Control](/en/remote-control)

100 Configure Claude Code with Amazon Bedrock or Google Vertex AI201 * Message [Dispatch](/en/desktop#sessions-from-dispatch) a task from your phone and open the Desktop session it creates

101 </Card>202 * Kick off a long-running task on the [web](/en/claude-code-on-the-web) or [iOS app](https://apps.apple.com/app/claude-by-anthropic/id6473753684), then pull it into your terminal with `/teleport`

203 * Hand off a terminal session to the [Desktop app](/en/desktop) with `/desktop` for visual diff review

204 * Route tasks from team chat: mention `@Claude` in [Slack](/en/slack) with a bug report and get a pull request back

205 </Accordion>

206</AccordionGroup>

102 207

103 <Card title="Settings" icon="gear" href="/en/settings">208## Use Claude Code everywhere

104 Customize Claude Code for your workflow

105 </Card>

106 209

107 <Card title="Commands" icon="terminal" href="/en/cli-reference">210Each surface connects to the same underlying Claude Code engine, so your CLAUDE.md files, settings, and MCP servers work across all of them.

108 Learn about CLI commands and controls

109 </Card>

110 211

111 <Card title="Reference implementation" icon="code" href="https://github.com/anthropics/claude-code/tree/main/.devcontainer">212Beyond the [Terminal](/en/quickstart), [VS Code](/en/vs-code), [JetBrains](/en/jetbrains), [Desktop](/en/desktop), and [Web](/en/claude-code-on-the-web) environments above, Claude Code integrates with CI/CD, chat, and browser workflows:

112 Clone our development container reference implementation213

113 </Card>214| I want to... | Best option |

215| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |

216| Continue a local session from my phone or another device | [Remote Control](/en/remote-control) |

217| Push events from Telegram, Discord, iMessage, or my own webhooks into a session | [Channels](/en/channels) |

218| Start a task locally, continue on mobile | [Web](/en/claude-code-on-the-web) or [Claude iOS app](https://apps.apple.com/app/claude-by-anthropic/id6473753684) |

219| Run Claude on a recurring schedule | [Cloud scheduled tasks](/en/web-scheduled-tasks) or [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) |

220| Automate PR reviews and issue triage | [GitHub Actions](/en/github-actions) or [GitLab CI/CD](/en/gitlab-ci-cd) |

221| Get automatic code review on every PR | [GitHub Code Review](/en/code-review) |

222| Route bug reports from Slack to pull requests | [Slack](/en/slack) |

223| Debug live web applications | [Chrome](/en/chrome) |

224| Build custom agents for your own workflows | [Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview) |

225

226## Next steps

114 227

115 <Card title="Security" icon="shield" href="/en/security">228Once you've installed Claude Code, these guides help you go deeper.

116 Discover Claude Code's safeguards and best practices for safe usage

117 </Card>

118 229

119 <Card title="Privacy and data usage" icon="lock" href="/en/data-usage">230* [Quickstart](/en/quickstart): walk through your first real task, from exploring a codebase to committing a fix

120 Understand how Claude Code handles your data231* [Store instructions and memories](/en/memory): give Claude persistent instructions with CLAUDE.md files and auto memory

121 </Card>232* [Common workflows](/en/common-workflows) and [best practices](/en/best-practices): patterns for getting the most out of Claude Code

122</CardGroup>233* [Settings](/en/settings): customize Claude Code for your workflow

234* [Troubleshooting](/en/troubleshooting): solutions for common issues

235* [code.claude.com](https://code.claude.com/): demos, pricing, and product details

permission-modes.md +290 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Choose a permission mode

7> Switch between supervised editing, read-only planning, and auto mode where a background classifier replaces manual permission prompts. Cycle modes with Shift+Tab in the CLI or use the mode selector in VS Code, Desktop, and claude.ai.

9Permission modes control whether Claude asks before acting. Different tasks call for different levels of autonomy: you might want full oversight for sensitive work, minimal interruptions for a long refactor, or read-only access while exploring a codebase.

11This page covers how to:

13* [Switch modes](#switch-permission-modes) during a session, at startup, or as a default

14* [Choose a mode](#available-modes) based on what Claude should be able to do without asking

15* [Run auto mode](#eliminate-prompts-with-auto-mode) with background safety checks, and see what it [blocks by default](#what-the-classifier-blocks-by-default)

16* [Plan changes read-only](#analyze-before-you-edit-with-plan-mode) before approving edits

17* [Restrict Claude to pre-approved tools](#allow-only-pre-approved-tools-with-dontask-mode) for locked-down environments

18* [Skip checks entirely](#skip-all-checks-with-bypasspermissions-mode) in isolated environments

20## Switch permission modes

22You can switch modes at any time during a session, at startup, or as a persistent default. The mechanism depends on where you're running Claude Code.

24<Tabs>

25 <Tab title="CLI">

26 **During a session**: press `Shift+Tab` to cycle through `default` → `acceptEdits` → `plan` → `auto`. The current mode appears in the status bar. `auto` does not appear in the cycle until you pass `--enable-auto-mode` at startup. Auto also requires a Team (or Enterprise/API once available) plan and Claude Sonnet 4.6 or Opus 4.6, so the option may remain unavailable even with the flag. If `bypassPermissions` is also enabled, it appears in the cycle between `plan` and `auto`.

28 **At startup**: pass the mode as a CLI flag:

30 ```bash theme={null}

31 claude --permission-mode plan

32 ```

34 **As a default**: set `defaultMode` in your [settings file](/en/settings#settings-files):

36 ```json theme={null}

37 {

38 "permissions": {

39 "defaultMode": "acceptEdits"

40 }

41 }

42 ```

44 **Non-interactively**: the same flag works with `-p` for scripted runs:

46 ```bash theme={null}

47 claude -p "refactor auth" --permission-mode acceptEdits

48 ```

50 `dontAsk` is never in the `Shift+Tab` cycle. `bypassPermissions` appears in the cycle only if you started the session with `--permission-mode bypassPermissions`, `--dangerously-skip-permissions`, or `--allow-dangerously-skip-permissions`. The third flag adds the mode to the cycle without activating it, so you can compose it with a different starting mode like `--permission-mode plan`. Set any of these at startup or in your settings file.

51 </Tab>

53 <Tab title="JetBrains">

54 The JetBrains plugin launches Claude Code in the IDE terminal, so switching modes works the same as in the CLI: press `Shift+Tab` to cycle, or pass `--permission-mode` when launching.

55 </Tab>

57 <Tab title="VS Code">

58 **During a session**: click the mode indicator at the bottom of the prompt box to switch modes.

60 **As a default**: set `claudeCode.initialPermissionMode` in VS Code settings, or use the Claude Code extension settings panel.

62 The VS Code UI uses friendly labels that map to the settings keys below:

64 | UI label | Settings key |

65 | :----------------- | :------------------ |

66 | Ask permissions | `default` |

67 | Auto accept edits | `acceptEdits` |

68 | Plan mode | `plan` |

69 | Auto | `auto` |

70 | Bypass permissions | `bypassPermissions` |

72 Auto and Bypass permissions appear only after you enable **Allow dangerously skip permissions** in the extension settings. Auto also requires a Team plan and Claude Sonnet 4.6 or Opus 4.6, so the option may remain unavailable even with the toggle on.

74 See the [VS Code guide](/en/vs-code) for extension-specific details.

75 </Tab>

77 <Tab title="Desktop">

78 **During a session**: use the mode selector next to the send button. You can change it before or during a session.

80 The Desktop UI uses friendly labels that map to the settings keys below:

82 | UI label | Settings key |

83 | :----------------- | :------------------ |

84 | Ask permissions | `default` |

85 | Auto accept edits | `acceptEdits` |

86 | Plan mode | `plan` |

87 | Auto | `auto` |

88 | Bypass permissions | `bypassPermissions` |

90 Auto and Bypass permissions appear in the selector only after you enable them in Desktop settings. See the [Desktop guide](/en/desktop#choose-a-permission-mode) for details.

91 </Tab>

93 <Tab title="Web and mobile">

94 **During a session**: use the mode dropdown next to the prompt box on [claude.ai/code](https://claude.ai/code) or in the Claude mobile app.

96 For [Claude Code on the web](/en/claude-code-on-the-web) sessions running on Anthropic's cloud VMs, the dropdown offers Auto accept edits and Plan mode. Ask permissions and Auto are not available for cloud sessions.

98 For [Remote Control](/en/remote-control) sessions running on your local machine, the dropdown offers Ask permissions, Auto accept edits, and Plan mode. You can also set the starting mode when you launch the local host:

100 ```bash theme={null}

101 claude remote-control --permission-mode acceptEdits

102 ```

103

104 Permission prompts appear in claude.ai for approval.

105 </Tab>

106</Tabs>

107

108Permission modes are set through the UI, CLI flags, or settings files. Telling Claude "stop asking for permission" in the chat does not change the mode. See [Permissions](/en/permissions) for how modes interact with allow, ask, and deny rules.

109

110## Available modes

111

112Each mode makes a different tradeoff between convenience and oversight. Pick the one that matches your task.

113

114| Mode | What Claude can do without asking | Best for |

115| :------------------------------------------------------------------ | :----------------------------------------- | :------------------------------------------ |

116| `default` | Read files | Getting started, sensitive work |

117| `acceptEdits` | Read and edit files | Iterating on code you're reviewing |

118| [`plan`](#analyze-before-you-edit-with-plan-mode) | Read files | Exploring a codebase, planning a refactor |

119| [`auto`](#eliminate-prompts-with-auto-mode) | All actions, with background safety checks | Long-running tasks, reducing prompt fatigue |

120| [`bypassPermissions`](#skip-all-checks-with-bypasspermissions-mode) | All actions, no checks | Isolated containers and VMs only |

121| [`dontAsk`](#allow-only-pre-approved-tools-with-dontask-mode) | Only pre-approved tools | Locked-down environments |

122

123## Analyze before you edit with plan mode

124

125Plan mode tells Claude to research and propose changes without making them. Claude reads files, runs shell commands to explore, asks clarifying questions, and writes a plan file, but does not edit your source code. Permission prompts work the same as default mode: you still approve Bash commands, network requests, and other actions that would normally prompt.

126

127### When to use plan mode

128

129Plan mode is useful when you want Claude to research and propose an approach before making changes:

130

131* **Multi-step implementation**: when a feature requires edits across many files

132* **Code exploration**: when you want to research the codebase before changing anything

133* **Interactive development**: when you want to iterate on the direction with Claude

134

135### Start and use plan mode

136

137Enter plan mode for a single request by prefixing your prompt with `/plan`, or switch the whole session into plan mode by pressing `Shift+Tab` to [cycle through permission modes](#switch-permission-modes). You can also start in plan mode from the CLI:

138

139```bash theme={null}

140claude --permission-mode plan

141```

142

143This example starts a planning session for a complex refactor:

144

145```text theme={null}

146I need to refactor our authentication system to use OAuth2. Create a detailed migration plan.

147```

148

149Claude analyzes the current implementation and creates a plan. Refine with follow-ups:

150

151```text theme={null}

152What about backward compatibility?

153How should we handle database migration?

154```

155

156When the plan is ready, Claude presents it and asks how to proceed. From that prompt you can:

157

158* Approve and start in auto mode

159* Approve and accept edits

160* Approve and manually review each edit

161* Keep planning, which sends your feedback back to Claude for another round

162

163Each approve option also offers to clear the planning context first.

164

165## Eliminate prompts with auto mode

166

167Auto mode is available on Team plans, with Enterprise and API support rolling out shortly. On Team and Enterprise, an admin must enable it in [Claude Code admin settings](https://claude.ai/admin-settings/claude-code) before users can turn it on. It requires Claude Sonnet 4.6 or Claude Opus 4.6, and is not available on Haiku, claude-3 models, or third-party providers (Bedrock, Vertex, Foundry).

168

169Auto mode lets Claude execute actions without showing permission prompts. Before each action runs, a separate classifier model reviews the conversation and decides whether the action matches what you asked for: it blocks actions that escalate beyond the task scope, target infrastructure the classifier doesn't recognize as trusted, or appear to be driven by hostile content encountered in a file or web page. For a deeper look at how the classifier is designed, see the [auto mode announcement](https://claude.com/blog/auto-mode).

170

171<Warning>

172 Auto mode is a research preview. It reduces prompts but does not guarantee safety. It provides more protection than `bypassPermissions` but is not as thorough as manually reviewing each action. Use it for tasks where you trust the general direction, not as a replacement for review on sensitive operations.

173</Warning>

174

175**Model**: the classifier runs on Claude Sonnet 4.6, even if your main session uses a different model.

176

177**Cost**: classifier calls count toward your token usage the same as main-session calls. Each checked action sends a portion of the conversation transcript plus the pending action to the classifier. The extra cost comes mainly from shell commands and network operations, since read-only actions and file edits in your working directory don't trigger a classifier call.

178

179**Latency**: each classifier check adds a round-trip before the action executes.

180

181### How actions are evaluated

182

183Each action goes through a fixed decision order. The first matching step wins:

184

1851. Actions matching your [allow or deny rules](/en/permissions#manage-permissions) resolve immediately

1862. Read-only actions and file edits in your working directory are auto-approved

1873. Everything else goes to the classifier

1884. If the classifier blocks, Claude receives the reason and attempts an alternative approach

189

190On entering auto mode, Claude Code drops any allow rule that is known to grant arbitrary code execution: blanket shell access like `Bash(*)`, wildcarded script interpreters like `Bash(python*)` or `Bash(node*)`, package-manager run commands, and any `Agent` allow rule. These rules would auto-approve the commands and subagent delegations most capable of causing damage before the classifier ever sees them. Narrow rules like `Bash(npm test)` carry over. The dropped rules are restored when you leave auto mode.

191

192The classifier receives user messages and tool calls as input, with Claude's own text and tool results stripped out. It also receives your CLAUDE.md content, so actions described in your project instructions are factored into allow and block decisions. Because tool results never reach the classifier, hostile content in a file or web page cannot manipulate it directly. The classifier evaluates the pending action against a customizable set of block and allow rules, checking whether the action is an overeager escalation beyond what you asked for, a mistake about what's safe to touch, or a sudden departure from your stated intent that suggests Claude may have been steered by something it read.

193

194Unlike your permission rules, which match tool names and argument patterns, the classifier reads prose descriptions of what to block and allow: it reasons about the action in context rather than matching syntax.

195

196### How auto mode handles subagents

197

198When Claude spawns a [subagent](/en/sub-agents), the classifier evaluates the delegated task before the subagent starts. A task description that looks dangerous on its own, like "delete all remote branches matching this pattern", is blocked at spawn time.

199

200Inside the subagent, auto mode runs with the same block and allow rules as the parent session. Any `permissionMode` the subagent defines in its own frontmatter is ignored. The subagent's own tool calls go through the classifier independently.

201

202When the subagent finishes, the classifier reviews its full action history. A subagent that was benign at spawn could have been compromised mid-run by content it read. If the return check flags a concern, a security warning is prepended to the subagent's results so the main agent can decide how to proceed.

203

204### What the classifier blocks by default

205

206Out of the box, the classifier trusts your working directory and, if you're in a git repo, that repo's configured remotes. Everything else is treated as external: your company's source control orgs, cloud buckets, and internal services are unknown until you tell the classifier about them.

207

208**Blocked by default**:

209

210* Downloading and executing code, like `curl | bash` or scripts from cloned repos

211* Sending sensitive data to external endpoints

212* Production deploys and migrations

213* Mass deletion on cloud storage

214* Granting IAM or repo permissions

215* Modifying shared infrastructure

216* Irreversibly destroying files that existed before the session started

217* Destructive source control operations like force push or pushing directly to `main`

218

219**Allowed by default**:

220

221* Local file operations in your working directory

222* Installing dependencies already declared in your lock files or manifests

223* Reading `.env` and sending credentials to their matching API

224* Read-only HTTP requests

225* Pushing to the branch you started on or one Claude created

226

227To see the full default rule lists as the classifier receives them, run `claude auto-mode defaults`.

228

229If auto mode blocks something routine for your team, like pushing to your own org's repo or writing to a company bucket, it's because the classifier doesn't know those are trusted. Administrators can add trusted repos, buckets, and internal services via the `autoMode.environment` setting: see [Configure the auto mode classifier](/en/permissions#configure-the-auto-mode-classifier) for the full configuration guide.

230

231### When auto mode falls back

232

233The fallback design keeps false positives from derailing a session: a mistaken block costs Claude a retry, not your progress. If the classifier blocks an action 3 times in a row or 20 times total in one session, auto mode pauses and Claude Code resumes prompting for each action. These thresholds are not configurable.

234

235* **CLI**: you see a notification in the status area. Approving the prompted action resets the denial counters, so you can continue in auto mode

236* **Non-interactive mode** with the `-p` flag: aborts the session, since there is no user to prompt

237

238Repeated blocks usually mean one of two things: the task genuinely requires actions the classifier is built to stop, or the classifier is missing context about your trusted infrastructure and treating safe actions as risky. If the blocks look like false positives, or if the classifier misses something it should have caught, use `/feedback` to report it. If blocks are happening because the classifier doesn't recognize your repos or services as trusted, have an administrator [configure trusted infrastructure](/en/permissions#configure-the-auto-mode-classifier) in managed settings.

239

240## Allow only pre-approved tools with dontAsk mode

241

242`dontAsk` mode auto-denies every tool that is not explicitly allowed. Only actions matching your `/permissions` allow rules or `permissions.allow` settings can execute. If a tool has an explicit `ask` rule, the action is also denied rather than prompting. This makes the mode fully non-interactive, suitable for CI pipelines or restricted environments where you pre-define exactly what Claude is permitted to do.

243

244```bash theme={null}

245claude --permission-mode dontAsk

246```

247

248## Skip all checks with bypassPermissions mode

249

250`bypassPermissions` mode disables all permission prompts and safety checks. Every tool call executes immediately without any verification. Only use this in isolated environments like containers, VMs, or devcontainers without internet access, where Claude Code cannot cause damage to your host system.

251

252```bash theme={null}

253claude --permission-mode bypassPermissions

254```

255

256The `--dangerously-skip-permissions` flag is equivalent to `--permission-mode bypassPermissions`:

257

258```bash theme={null}

259claude -p "refactor the auth module" --dangerously-skip-permissions

260```

261

262<Warning>

263 `bypassPermissions` mode offers no protection against prompt injection or unintended actions. For a safer alternative that still maintains background safety checks, use [auto mode](#eliminate-prompts-with-auto-mode). Administrators can block this mode by setting `permissions.disableBypassPermissionsMode` to `"disable"` in [managed settings](/en/permissions#managed-settings).

264</Warning>

265

266## Compare permission approaches

267

268The table below summarizes the key differences in how each mode handles approvals. `plan` is omitted since it restricts what Claude can do rather than how approvals work.

269

271| :----------------- | :---------------------- | :------------------ | :---------------------------- | :------------------------------- | :------------------ |

275

276## Customize permissions further

277

278Permission modes set the baseline approval behavior. For control over individual tools or commands, layer additional configuration on top of the active mode.

279

280**Permission rules** are the first stop. Add `allow`, `ask`, or `deny` entries to your settings file to pre-approve safe commands, force a prompt for risky ones, or block specific tools entirely. Rules apply in every mode except `bypassPermissions`, which skips the permission layer entirely, and are matched by tool name and argument pattern. See [Manage permissions](/en/permissions#manage-permissions) for syntax and examples.

281

282**Hooks** cover logic that pattern-matching rules can't express. A [`PreToolUse` hook](/en/hooks#pretooluse-decision-control) runs before every tool call and can allow, deny, or escalate based on command content, file paths, time of day, or a response from an external policy service. A [`PermissionRequest` hook](/en/hooks#permissionrequest) intercepts the permission dialog itself and answers on your behalf. See [Hooks](/en/hooks) for configuration.

283

284## See also

285

286* [Permissions](/en/permissions): permission rules, syntax, managed policies

287* [Hooks](/en/hooks): custom permission logic, lifecycle scripting

288* [Security](/en/security): security safeguards and best practices

289* [Sandboxing](/en/sandboxing): filesystem and network isolation for Bash commands

290* [Non-interactive mode](/en/headless): run Claude Code programmatically with the `-p` flag

permissions.md +384 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Configure permissions

7> Control what Claude Code can access and do with fine-grained permission rules, modes, and managed policies.

9Claude Code supports fine-grained permissions so that you can specify exactly what the agent is allowed to do and what it cannot. Permission settings can be checked into version control and distributed to all developers in your organization, as well as customized by individual developers.

11## Permission system

13Claude Code uses a tiered permission system to balance power and safety:

16| :---------------- | :--------------- | :---------------- | :-------------------------------------------- |

17| Read-only | File reads, Grep | No | N/A |

18| Bash commands | Shell execution | Yes | Permanently per project directory and command |

19| File modification | Edit/write files | Yes | Until session end |

21## Manage permissions

23You can view and manage Claude Code's tool permissions with `/permissions`. This UI lists all permission rules and the settings.json file they are sourced from.

25* **Allow** rules let Claude Code use the specified tool without manual approval.

26* **Ask** rules prompt for confirmation whenever Claude Code tries to use the specified tool.

27* **Deny** rules prevent Claude Code from using the specified tool.

29Rules are evaluated in order: **deny -> ask -> allow**. The first matching rule wins, so deny rules always take precedence.

31## Permission modes

33Claude Code supports several permission modes that control how tools are approved. See [Permission modes](/en/permission-modes) for when to use each one. Set the `defaultMode` in your [settings files](/en/settings#settings-files):

35| Mode | Description |

36| :------------------ | :------------------------------------------------------------------------------------------------------------------------------- |

37| `default` | Standard behavior: prompts for permission on first use of each tool |

38| `acceptEdits` | Automatically accepts file edit permissions for the session |

39| `plan` | Plan Mode: Claude can analyze but not modify files or execute commands |

40| `auto` | Auto-approves tool calls with background safety checks that verify actions align with your request. Currently a research preview |

41| `dontAsk` | Auto-denies tools unless pre-approved via `/permissions` or `permissions.allow` rules |

42| `bypassPermissions` | Skips permission prompts except for writes to protected directories (see warning below) |

44<Warning>

45 `bypassPermissions` mode skips permission prompts. Writes to `.git`, `.claude`, `.vscode`, and `.idea` directories still prompt for confirmation to prevent accidental corruption of repository state and local configuration. Writes to `.claude/commands`, `.claude/agents`, and `.claude/skills` are exempt and do not prompt, because Claude routinely writes there when creating skills, subagents, and commands. Only use this mode in isolated environments like containers or VMs where Claude Code cannot cause damage. Administrators can prevent this mode by setting `disableBypassPermissionsMode` to `"disable"` in [managed settings](#managed-settings).

46</Warning>

48To prevent `bypassPermissions` or `auto` mode from being used, set `permissions.disableBypassPermissionsMode` or `disableAutoMode` to `"disable"` in any [settings file](/en/settings#settings-files). These are most useful in [managed settings](#managed-settings) where they cannot be overridden.

50## Permission rule syntax

52Permission rules follow the format `Tool` or `Tool(specifier)`.

54### Match all uses of a tool

56To match all uses of a tool, use just the tool name without parentheses:

58| Rule | Effect |

59| :--------- | :----------------------------- |

60| `Bash` | Matches all Bash commands |

61| `WebFetch` | Matches all web fetch requests |

62| `Read` | Matches all file reads |

64`Bash(*)` is equivalent to `Bash` and matches all Bash commands.

66### Use specifiers for fine-grained control

68Add a specifier in parentheses to match specific tool uses:

70| Rule | Effect |

71| :----------------------------- | :------------------------------------------------------- |

72| `Bash(npm run build)` | Matches the exact command `npm run build` |

73| `Read(./.env)` | Matches reading the `.env` file in the current directory |

74| `WebFetch(domain:example.com)` | Matches fetch requests to example.com |

76### Wildcard patterns

78Bash rules support glob patterns with `*`. Wildcards can appear at any position in the command. This configuration allows npm and git commit commands while blocking git push:

80```json theme={null}

81{

82 "permissions": {

83 "allow": [

84 "Bash(npm run *)",

85 "Bash(git commit *)",

86 "Bash(git * main)",

87 "Bash(* --version)",

88 "Bash(* --help *)"

89 ],

90 "deny": [

91 "Bash(git push *)"

92 ]

93 }

94}

95```

97The space before `*` matters: `Bash(ls *)` matches `ls -la` but not `lsof`, while `Bash(ls*)` matches both. The legacy `:*` suffix syntax is equivalent to ` *` but is deprecated.

99## Tool-specific permission rules

100

101### Bash

102

103Bash permission rules support wildcard matching with `*`. Wildcards can appear at any position in the command, including at the beginning, middle, or end:

104

105* `Bash(npm run build)` matches the exact Bash command `npm run build`

106* `Bash(npm run test *)` matches Bash commands starting with `npm run test`

107* `Bash(npm *)` matches any command starting with `npm `

108* `Bash(* install)` matches any command ending with ` install`

109* `Bash(git * main)` matches commands like `git checkout main`, `git merge main`

110

111When `*` appears at the end with a space before it (like `Bash(ls *)`), it enforces a word boundary, requiring the prefix to be followed by a space or end-of-string. For example, `Bash(ls *)` matches `ls -la` but not `lsof`. In contrast, `Bash(ls*)` without a space matches both `ls -la` and `lsof` because there's no word boundary constraint.

112

113<Tip>

114 Claude Code is aware of shell operators (like `&&`) so a prefix match rule like `Bash(safe-cmd *)` won't give it permission to run the command `safe-cmd && other-cmd`.

115</Tip>

116

117When you approve a compound command with "Yes, don't ask again", Claude Code saves a separate rule for each subcommand that requires approval, rather than a single rule for the full compound string. For example, approving `git status && npm test` saves a rule for `npm test`, so future `npm test` invocations are recognized regardless of what precedes the `&&`. Subcommands like `cd` into a subdirectory generate their own Read rule for that path. Up to 5 rules may be saved for a single compound command.

118

119<Warning>

120 Bash permission patterns that try to constrain command arguments are fragile. For example, `Bash(curl http://github.com/ *)` intends to restrict curl to GitHub URLs, but won't match variations like:

121

122 * Options before URL: `curl -X GET http://github.com/...`

123 * Different protocol: `curl https://github.com/...`

124 * Redirects: `curl -L http://bit.ly/xyz` (redirects to github)

125 * Variables: `URL=http://github.com && curl $URL`

126 * Extra spaces: `curl http://github.com`

127

128 For more reliable URL filtering, consider:

129

130 * **Restrict Bash network tools**: use deny rules to block `curl`, `wget`, and similar commands, then use the WebFetch tool with `WebFetch(domain:github.com)` permission for allowed domains

131 * **Use PreToolUse hooks**: implement a hook that validates URLs in Bash commands and blocks disallowed domains

132 * Instructing Claude Code about your allowed curl patterns via CLAUDE.md

133

134 Note that using WebFetch alone does not prevent network access. If Bash is allowed, Claude can still use `curl`, `wget`, or other tools to reach any URL.

135</Warning>

136

137### Read and Edit

138

139`Edit` rules apply to all built-in tools that edit files. Claude makes a best-effort attempt to apply `Read` rules to all built-in tools that read files like Grep and Glob.

140

141<Warning>

142 Read and Edit deny rules apply to Claude's built-in file tools, not to Bash subprocesses. A `Read(./.env)` deny rule blocks the Read tool but does not prevent `cat .env` in Bash. For OS-level enforcement that blocks all processes from accessing a path, [enable the sandbox](/en/sandboxing).

143</Warning>

144

145Read and Edit rules both follow the [gitignore](https://git-scm.com/docs/gitignore) specification with four distinct pattern types:

146

148| ------------------ | -------------------------------------- | -------------------------------- | ------------------------------ |

149| `//path` | **Absolute** path from filesystem root | `Read(//Users/alice/secrets/**)` | `/Users/alice/secrets/**` |

150| `~/path` | Path from **home** directory | `Read(~/Documents/*.pdf)` | `/Users/alice/Documents/*.pdf` |

151| `/path` | Path **relative to project root** | `Edit(/src/**/*.ts)` | `<project root>/src/**/*.ts` |

152| `path` or `./path` | Path **relative to current directory** | `Read(*.env)` | `<cwd>/*.env` |

153

154<Warning>

155 A pattern like `/Users/alice/file` is NOT an absolute path. It's relative to the project root. Use `//Users/alice/file` for absolute paths.

156</Warning>

157

158On Windows, paths are normalized to POSIX form before matching. `C:\Users\alice` becomes `/c/Users/alice`, so use `//c/**/.env` to match `.env` files anywhere on that drive. To match across all drives, use `//**/.env`.

159

160Examples:

161

162* `Edit(/docs/**)`: edits in `<project>/docs/` (NOT `/docs/` and NOT `<project>/.claude/docs/`)

163* `Read(~/.zshrc)`: reads your home directory's `.zshrc`

164* `Edit(//tmp/scratch.txt)`: edits the absolute path `/tmp/scratch.txt`

165* `Read(src/**)`: reads from `<current-directory>/src/`

166

167<Note>

168 In gitignore patterns, `*` matches files in a single directory while `**` matches recursively across directories. To allow all file access, use just the tool name without parentheses: `Read`, `Edit`, or `Write`.

169</Note>

170

171### WebFetch

172

173* `WebFetch(domain:example.com)` matches fetch requests to example.com

174

175### MCP

176

177* `mcp__puppeteer` matches any tool provided by the `puppeteer` server (name configured in Claude Code)

178* `mcp__puppeteer__*` wildcard syntax that also matches all tools from the `puppeteer` server

179* `mcp__puppeteer__puppeteer_navigate` matches the `puppeteer_navigate` tool provided by the `puppeteer` server

180

181### Agent (subagents)

182

183Use `Agent(AgentName)` rules to control which [subagents](/en/sub-agents) Claude can use:

184

185* `Agent(Explore)` matches the Explore subagent

186* `Agent(Plan)` matches the Plan subagent

187* `Agent(my-custom-agent)` matches a custom subagent named `my-custom-agent`

188

189Add these rules to the `deny` array in your settings or use the `--disallowedTools` CLI flag to disable specific agents. To disable the Explore agent:

190

191```json theme={null}

192{

193 "permissions": {

194 "deny": ["Agent(Explore)"]

195 }

196}

197```

198

199## Extend permissions with hooks

200

201[Claude Code hooks](/en/hooks-guide) provide a way to register custom shell commands to perform permission evaluation at runtime. When Claude Code makes a tool call, PreToolUse hooks run before the permission prompt. The hook output can deny the tool call, force a prompt, or skip the prompt to let the call proceed.

202

203Skipping the prompt does not bypass permission rules. Deny and ask rules are still evaluated after a hook returns `"allow"`, so a matching deny rule still blocks the call. This preserves the deny-first precedence described in [Manage permissions](#manage-permissions), including deny rules set in managed settings.

204

205A blocking hook also takes precedence over allow rules. A hook that exits with code 2 stops the tool call before permission rules are evaluated, so the block applies even when an allow rule would otherwise let the call proceed. To run all Bash commands without prompts except for a few you want blocked, add `"Bash"` to your allow list and register a PreToolUse hook that rejects those specific commands. See [Block edits to protected files](/en/hooks-guide#block-edits-to-protected-files) for a hook script you can adapt.

206

207## Working directories

208

209By default, Claude has access to files in the directory where it was launched. You can extend this access:

210

211* **During startup**: use `--add-dir <path>` CLI argument

212* **During session**: use `/add-dir` command

213* **Persistent configuration**: add to `additionalDirectories` in [settings files](/en/settings#settings-files)

214

215Files in additional directories follow the same permission rules as the original working directory: they become readable without prompts, and file editing permissions follow the current permission mode.

216

217## How permissions interact with sandboxing

218

219Permissions and [sandboxing](/en/sandboxing) are complementary security layers:

220

221* **Permissions** control which tools Claude Code can use and which files or domains it can access. They apply to all tools (Bash, Read, Edit, WebFetch, MCP, and others).

222* **Sandboxing** provides OS-level enforcement that restricts the Bash tool's filesystem and network access. It applies only to Bash commands and their child processes.

223

224Use both for defense-in-depth:

225

226* Permission deny rules block Claude from even attempting to access restricted resources

227* Sandbox restrictions prevent Bash commands from reaching resources outside defined boundaries, even if a prompt injection bypasses Claude's decision-making

228* Filesystem restrictions in the sandbox use Read and Edit deny rules, not separate sandbox configuration

229* Network restrictions combine WebFetch permission rules with the sandbox's `allowedDomains` list

230

231## Managed settings

232

233For organizations that need centralized control over Claude Code configuration, administrators can deploy managed settings that cannot be overridden by user or project settings. These policy settings follow the same format as regular settings files and can be delivered through MDM/OS-level policies, managed settings files, or [server-managed settings](/en/server-managed-settings). See [settings files](/en/settings#settings-files) for delivery mechanisms and file locations.

234

235### Managed-only settings

236

237Some settings are only effective in managed settings:

238

239| Setting | Description |

240| :--------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

241| `allowManagedPermissionRulesOnly` | When `true`, prevents user and project settings from defining `allow`, `ask`, or `deny` permission rules. Only rules in managed settings apply |

242| `allowManagedHooksOnly` | When `true`, prevents loading of user, project, and plugin hooks. Only managed hooks and SDK hooks are allowed |

243| `allowManagedMcpServersOnly` | When `true`, only `allowedMcpServers` from managed settings are respected. `deniedMcpServers` still merges from all sources. See [Managed MCP configuration](/en/mcp#managed-mcp-configuration) |

244| `blockedMarketplaces` | Blocklist of marketplace sources. Blocked sources are checked before downloading, so they never touch the filesystem. See [managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions) |

245| `sandbox.network.allowManagedDomainsOnly` | When `true`, only `allowedDomains` and `WebFetch(domain:...)` allow rules from managed settings are respected. Non-allowed domains are blocked automatically without prompting the user. Denied domains still merge from all sources |

246| `sandbox.filesystem.allowManagedReadPathsOnly` | When `true`, only `allowRead` paths from managed settings are respected. `allowRead` entries from user, project, and local settings are ignored |

247| `strictKnownMarketplaces` | Controls which plugin marketplaces users can add. See [managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions) |

248

249<Note>

250 Access to [Remote Control](/en/remote-control) and [web sessions](/en/claude-code-on-the-web) is not controlled by a managed settings key. On Team and Enterprise plans, an admin enables or disables these features in [Claude Code admin settings](https://claude.ai/admin-settings/claude-code).

251</Note>

252

253## Configure the auto mode classifier

254

255[Auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) uses a classifier model to decide whether each action is safe to run without prompting. Out of the box it trusts only the working directory and, if present, the current repo's remotes. Actions like pushing to your company's source control org or writing to a team cloud bucket will be blocked as potential data exfiltration. The `autoMode` settings block lets you tell the classifier which infrastructure your organization trusts.

256

257The classifier reads `autoMode` from user settings, `.claude/settings.local.json`, and managed settings. It does not read from shared project settings in `.claude/settings.json`, because a checked-in repo could otherwise inject its own allow rules.

258

259| Scope | File | Use for |

260| :------------------------- | :---------------------------- | :-------------------------------------------------- |

261| One developer | `~/.claude/settings.json` | Personal trusted infrastructure |

262| One project, one developer | `.claude/settings.local.json` | Per-project trusted buckets or services, gitignored |

263| Organization-wide | Managed settings | Trusted infrastructure enforced for all developers |

264

265Entries from each scope are combined. A developer can extend `environment`, `allow`, and `soft_deny` with personal entries but cannot remove entries that managed settings provide. Because allow rules act as exceptions to block rules inside the classifier, a developer-added `allow` entry can override an organization `soft_deny` entry: the combination is additive, not a hard policy boundary. If you need a rule that developers cannot work around, use `permissions.deny` in managed settings instead, which blocks actions before the classifier is consulted.

266

267### Define trusted infrastructure

268

269For most organizations, `autoMode.environment` is the only field you need to set. It tells the classifier which repos, buckets, and domains are trusted, without touching the built-in block and allow rules. The classifier uses `environment` to decide what "external" means: any destination not listed is a potential exfiltration target.

270

271```json theme={null}

272{

273 "autoMode": {

274 "environment": [

275 "Source control: github.example.com/acme-corp and all repos under it",

276 "Trusted cloud buckets: s3://acme-build-artifacts, gs://acme-ml-datasets",

277 "Trusted internal domains: *.corp.example.com, api.internal.example.com",

278 "Key internal services: Jenkins at ci.example.com, Artifactory at artifacts.example.com"

279 ]

280 }

281}

282```

283

284Entries are prose, not regex or tool patterns. The classifier reads them as natural-language rules. Write them the way you would describe your infrastructure to a new engineer. A thorough environment section covers:

285

286* **Organization**: your company name and what Claude Code is primarily used for, like software development, infrastructure automation, or data engineering

287* **Source control**: every GitHub, GitLab, or Bitbucket org your developers push to

288* **Cloud providers and trusted buckets**: bucket names or prefixes that Claude should be able to read from and write to

289* **Trusted internal domains**: hostnames for APIs, dashboards, and services inside your network, like `*.internal.example.com`

290* **Key internal services**: CI, artifact registries, internal package indexes, incident tooling

291* **Additional context**: regulated-industry constraints, multi-tenant infrastructure, or compliance requirements that affect what the classifier should treat as risky

292

293A useful starting template: fill in the bracketed fields and remove any lines that don't apply:

294

295```json theme={null}

296{

297 "autoMode": {

298 "environment": [

299 "Organization: {COMPANY_NAME}. Primary use: {PRIMARY_USE_CASE, e.g. software development, infrastructure automation}",

300 "Source control: {SOURCE_CONTROL, e.g. GitHub org github.example.com/acme-corp}",

301 "Cloud provider(s): {CLOUD_PROVIDERS, e.g. AWS, GCP, Azure}",

302 "Trusted cloud buckets: {TRUSTED_BUCKETS, e.g. s3://acme-builds, gs://acme-datasets}",

303 "Trusted internal domains: {TRUSTED_DOMAINS, e.g. *.internal.example.com, api.example.com}",

304 "Key internal services: {SERVICES, e.g. Jenkins at ci.example.com, Artifactory at artifacts.example.com}",

305 "Additional context: {EXTRA, e.g. regulated industry, multi-tenant infrastructure, compliance requirements}"

306 ]

307 }

308}

309```

310

311The more specific context you give, the better the classifier can distinguish routine internal operations from exfiltration attempts.

312

313You don't need to fill everything in at once. A reasonable rollout: start with the defaults and add your source control org and key internal services, which resolves the most common false positives like pushing to your own repos. Add trusted domains and cloud buckets next. Fill the rest as blocks come up.

314

315### Override the block and allow rules

316

317Two additional fields let you replace the classifier's built-in rule lists: `autoMode.soft_deny` controls what gets blocked, and `autoMode.allow` controls which exceptions apply. Each is an array of prose descriptions, read as natural-language rules.

318

319Inside the classifier, the precedence is: `soft_deny` rules block first, then `allow` rules override as exceptions, then explicit user intent overrides both. If the user's message directly and specifically describes the exact action Claude is about to take, the classifier allows it even if a `soft_deny` rule matches. General requests don't count: asking Claude to "clean up the repo" does not authorize force-pushing, but asking Claude to "force-push this branch" does.

320

321To loosen: remove rules from `soft_deny` when the defaults block something your pipeline already guards against with PR review, CI, or staging environments, or add to `allow` when the classifier repeatedly flags a routine pattern the default exceptions don't cover. To tighten: add to `soft_deny` for risks specific to your environment that the defaults miss, or remove from `allow` to hold a default exception to the block rules. In all cases, run `claude auto-mode defaults` to get the full default lists, then copy and edit: never start from an empty list.

322

323```json theme={null}

324{

325 "autoMode": {

326 "environment": [

327 "Source control: github.example.com/acme-corp and all repos under it"

328 ],

329 "allow": [

330 "Deploying to the staging namespace is allowed: staging is isolated from production and resets nightly",

331 "Writing to s3://acme-scratch/ is allowed: ephemeral bucket with a 7-day lifecycle policy"

332 ],

333 "soft_deny": [

334 "Never run database migrations outside the migrations CLI, even against dev databases",

335 "Never modify files under infra/terraform/prod/: production infrastructure changes go through the review workflow",

336 "...copy full default soft_deny list here first, then add your rules..."

337 ]

338 }

339}

340```

341

342<Danger>

343 Setting `allow` or `soft_deny` replaces the entire default list for that section. If you set `soft_deny` with a single entry, every built-in block rule is discarded: force push, data exfiltration, `curl | bash`, production deploys, and all other default block rules become allowed. To customize safely, run `claude auto-mode defaults` to print the built-in rules, copy them into your settings file, then review each rule against your own pipeline and risk tolerance. Only remove rules for risks your infrastructure already mitigates.

344</Danger>

345

346The three sections are evaluated independently, so setting `environment` alone leaves the default `allow` and `soft_deny` lists intact.

347

348### Inspect the defaults and your effective config

349

350Because setting `allow` or `soft_deny` replaces the defaults, start any customization by copying the full default lists. Three CLI subcommands help you inspect and validate:

351

352```bash theme={null}

353claude auto-mode defaults # the built-in environment, allow, and soft_deny rules

354claude auto-mode config # what the classifier actually uses: your settings where set, defaults otherwise

355claude auto-mode critique # get AI feedback on your custom allow and soft_deny rules

356```

357

358Save the output of `claude auto-mode defaults` to a file, edit the lists to match your policy, and paste the result into your settings file. After saving, run `claude auto-mode config` to confirm the effective rules are what you expect. If you've written custom rules, `claude auto-mode critique` reviews them and flags entries that are ambiguous, redundant, or likely to cause false positives.

359

360## Settings precedence

361

362Permission rules follow the same [settings precedence](/en/settings#settings-precedence) as all other Claude Code settings:

363

3641. **Managed settings**: cannot be overridden by any other level, including command line arguments

3652. **Command line arguments**: temporary session overrides

3663. **Local project settings** (`.claude/settings.local.json`)

3674. **Shared project settings** (`.claude/settings.json`)

3685. **User settings** (`~/.claude/settings.json`)

369

370If a tool is denied at any level, no other level can allow it. For example, a managed settings deny cannot be overridden by `--allowedTools`, and `--disallowedTools` can add restrictions beyond what managed settings define.

371

372If a permission is allowed in user settings but denied in project settings, the project setting takes precedence and the permission is blocked.

373

374## Example configurations

375

376This [repository](https://github.com/anthropics/claude-code/tree/main/examples/settings) includes starter settings configurations for common deployment scenarios. Use these as starting points and adjust them to fit your needs.

377

378## See also

379

380* [Settings](/en/settings): complete configuration reference including the permission settings table

381* [Sandboxing](/en/sandboxing): OS-level filesystem and network isolation for Bash commands

382* [Authentication](/en/authentication): set up user access to Claude Code

383* [Security](/en/security): security safeguards and best practices

384* [Hooks](/en/hooks-guide): automate workflows and extend permission evaluation

platforms.md +78 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Platforms and integrations

7> Choose where to run Claude Code and what to connect it to. Compare the CLI, Desktop, VS Code, JetBrains, web, and integrations like Chrome, Slack, and CI/CD.

9Claude Code runs the same underlying engine everywhere, but each surface is tuned for a different way of working. This page helps you pick the right platform for your workflow and connect the tools you already use.

11## Where to run Claude Code

13Choose a platform based on how you like to work and where your project lives.

15| Platform | Best for | What you get |

16| :-------------------------------- | :------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |

17| [CLI](/en/quickstart) | Terminal workflows, scripting, remote servers | Full feature set, [Agent SDK](/en/headless), third-party providers |

18| [Desktop](/en/desktop) | Visual review, parallel sessions, managed setup | Diff viewer, app preview, [computer use](/en/desktop#let-claude-use-your-computer) and [Dispatch](/en/desktop#sessions-from-dispatch) on Pro and Max |

19| [VS Code](/en/vs-code) | Working inside VS Code without switching to a terminal | Inline diffs, integrated terminal, file context |

20| [JetBrains](/en/jetbrains) | Working inside IntelliJ, PyCharm, WebStorm, or other JetBrains IDEs | Diff viewer, selection sharing, terminal session |

21| [Web](/en/claude-code-on-the-web) | Long-running tasks that don't need much steering, or work that should continue when you're offline | Anthropic-managed cloud, continues after you disconnect |

23The CLI is the most complete surface for terminal-native work: scripting, third-party providers, and the Agent SDK are CLI-only. Desktop and the IDE extensions trade some CLI-only features for visual review and tighter editor integration. The web runs in Anthropic's cloud, so tasks keep going after you disconnect.

25You can mix surfaces on the same project. Configuration, project memory, and MCP servers are shared across the local surfaces.

27## Connect your tools

29Integrations let Claude work with services outside your codebase.

31| Integration | What it does | Use it for |

32| :----------------------------------- | :------------------------------------------------- | :--------------------------------------------------------------- |

33| [Chrome](/en/chrome) | Controls your browser with your logged-in sessions | Testing web apps, filling forms, automating sites without an API |

34| [GitHub Actions](/en/github-actions) | Runs Claude in your CI pipeline | Automated PR reviews, issue triage, scheduled maintenance |

35| [GitLab CI/CD](/en/gitlab-ci-cd) | Same as GitHub Actions for GitLab | CI-driven automation on GitLab |

36| [Code Review](/en/code-review) | Reviews every PR automatically | Catching bugs before human review |

37| [Slack](/en/slack) | Responds to `@Claude` mentions in your channels | Turning bug reports into pull requests from team chat |

39For integrations not listed here, [MCP servers](/en/mcp) and [connectors](/en/desktop#connect-external-tools) let you connect almost anything: Linear, Notion, Google Drive, or your own internal APIs.

41## Work when you are away from your terminal

43Claude Code offers several ways to work when you're not at your terminal. They differ in what triggers the work, where Claude runs, and how much you need to set up.

46| :--------------------------------------------- | :--------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |

53If you're not sure where to start, [install the CLI](/en/quickstart) and run it in a project directory. If you'd rather not use a terminal, [Desktop](/en/desktop-quickstart) gives you the same engine with a graphical interface.

55## Related resources

57### Platforms

59* [CLI quickstart](/en/quickstart): install and run your first command in the terminal

60* [Desktop](/en/desktop): visual diff review, parallel sessions, computer use, and Dispatch

61* [VS Code](/en/vs-code): the Claude Code extension inside your editor

62* [JetBrains](/en/jetbrains): the extension for IntelliJ, PyCharm, and other JetBrains IDEs

63* [Claude Code on the web](/en/claude-code-on-the-web): cloud sessions that keep running when you disconnect

65### Integrations

67* [Chrome](/en/chrome): automate browser tasks with your logged-in sessions

68* [GitHub Actions](/en/github-actions): run Claude in your CI pipeline

69* [GitLab CI/CD](/en/gitlab-ci-cd): the same for GitLab

70* [Code Review](/en/code-review): automatic review on every pull request

71* [Slack](/en/slack): send tasks from team chat, get PRs back

73### Remote access

75* [Dispatch](/en/desktop#sessions-from-dispatch): message a task from your phone and it can spawn a Desktop session

76* [Remote Control](/en/remote-control): drive a running session from your phone or browser

77* [Channels](/en/channels): push events from chat apps or your own servers into a session

78* [Scheduled tasks](/en/scheduled-tasks): run prompts on a recurring schedule

plugin-marketplaces.md +645 −184

Details

~~1# Plugin marketplaces~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Create and manage plugin marketplaces to distribute Claude Code extensions across teams and communities.~~5# Create and distribute a plugin marketplace

4 6

5Plugin marketplaces are catalogs of available plugins that make it easy to discover, install, and manage Claude Code extensions. This guide shows you how to use existing marketplaces and create your own for team distribution.7> Build and host plugin marketplaces to distribute Claude Code extensions across teams and communities.

6 8

~~7## Overview~~9A **plugin marketplace** is a catalog that lets you distribute plugins to others. Marketplaces provide centralized discovery, version tracking, automatic updates, and support for multiple source types (git repositories, local paths, and more). This guide shows you how to create your own marketplace to share plugins with your team or community.

~~9A marketplace is a JSON file that lists available plugins and describes where to find them. Marketplaces provide:~~

~~11* **Centralized discovery**: Browse plugins from multiple sources in one place~~

~~12* **Version management**: Track and update plugin versions automatically~~

~~13* **Team distribution**: Share required plugins across your organization~~

~~14* **Flexible sources**: Support for git repositories, GitHub repos, local paths, and package managers~~

~~16### Prerequisites~~

~~18* Claude Code installed and running~~

~~19* Basic familiarity with JSON file format~~

~~20* For creating marketplaces: Git repository or local development environment~~

~~22## Add and use marketplaces~~

23 10

~~24Add marketplaces using the `/plugin marketplace` commands to access plugins from different sources:~~11Looking to install plugins from an existing marketplace? See [Discover and install prebuilt plugins](/en/discover-plugins).

25 12

~~26### Add GitHub marketplaces~~13## Overview

~~28```shell Add a GitHub repository containing .claude-plugin/marketplace.json theme={null}~~

~~29/plugin marketplace add owner/repo~~

~~30```~~

~~32### Add Git repositories~~

~~34```shell Add any git repository theme={null}~~

~~35/plugin marketplace add https://gitlab.com/company/plugins.git~~

~~36```~~

37 14

~~38### Add local marketplaces for development~~15Creating and distributing a marketplace involves:

39 16

~~40```shell Add local directory containing .claude-plugin/marketplace.json theme={null}~~171. **Creating plugins**: build one or more plugins with commands, agents, hooks, MCP servers, or LSP servers. This guide assumes you already have plugins to distribute; see [Create plugins](/en/plugins) for details on how to create them.

~~41/plugin marketplace add ./my-marketplace~~182. **Creating a marketplace file**: define a `marketplace.json` that lists your plugins and where to find them (see [Create the marketplace file](#create-the-marketplace-file)).

~~42```~~193. **Host the marketplace**: push to GitHub, GitLab, or another git host (see [Host and distribute marketplaces](#host-and-distribute-marketplaces)).

204. **Share with users**: users add your marketplace with `/plugin marketplace add` and install individual plugins (see [Discover and install plugins](/en/discover-plugins)).

43 21

~~44```shell Add direct path to marketplace.json file theme={null}~~22Once your marketplace is live, you can update it by pushing changes to your repository. Users refresh their local copy with `/plugin marketplace update`.

~~45/plugin marketplace add ./path/to/marketplace.json~~

~~46```~~

47 23

~~48```shell Add remote marketplace.json via URL theme={null}~~24## Walkthrough: create a local marketplace

~~49/plugin marketplace add https://url.of/marketplace.json~~

~~50```~~

51 25

~~52### Install plugins from marketplaces~~26This example creates a marketplace with one plugin: a `/quality-review` skill for code reviews. You'll create the directory structure, add a skill, create the plugin manifest and marketplace catalog, then install and test it.

53 27

~~54Once you've added marketplaces, install plugins directly:~~28<Steps>

29 <Step title="Create the directory structure">

30 ```bash theme={null}

31 mkdir -p my-marketplace/.claude-plugin

32 mkdir -p my-marketplace/plugins/quality-review-plugin/.claude-plugin

33 mkdir -p my-marketplace/plugins/quality-review-plugin/skills/quality-review

34 ```

35 </Step>

55 36

~~56```shell Install from any known marketplace theme={null}~~37 <Step title="Create the skill">

~~57/plugin install plugin-name@marketplace-name~~38 Create a `SKILL.md` file that defines what the `/quality-review` skill does.

~~58```~~

59 39

~~60```shell Browse available plugins interactively theme={null}~~40 ```markdown my-marketplace/plugins/quality-review-plugin/skills/quality-review/SKILL.md theme={null}

~~61/plugin~~41 ---

~~62```~~42 description: Review code for bugs, security, and performance

43 disable-model-invocation: true

44 ---

63 45

~~64### Verify marketplace installation~~46 Review the code I've selected or the recent changes for:

47 - Potential bugs or edge cases

48 - Security concerns

49 - Performance issues

50 - Readability improvements

65 51

~~66After adding a marketplace:~~52 Be concise and actionable.

53 ```

54 </Step>

67 55

~~681. **List marketplaces**: Run `/plugin marketplace list` to confirm it's added~~56 <Step title="Create the plugin manifest">

~~692. **Browse plugins**: Use `/plugin` to see available plugins from your marketplace~~57 Create a `plugin.json` file that describes the plugin. The manifest goes in the `.claude-plugin/` directory.

~~703. **Test installation**: Try installing a plugin to verify the marketplace works correctly~~

71 58

~~72## Configure team marketplaces~~59 ```json my-marketplace/plugins/quality-review-plugin/.claude-plugin/plugin.json theme={null}

60 {

61 "name": "quality-review-plugin",

62 "description": "Adds a /quality-review skill for quick code reviews",

63 "version": "1.0.0"

64 }

65 ```

66 </Step>

73 67

~~74Set up automatic marketplace installation for team projects by specifying required marketplaces in `.claude/settings.json`:~~68 <Step title="Create the marketplace file">

69 Create the marketplace catalog that lists your plugin.

75 70

~~76```json theme={null}~~71 ```json my-marketplace/.claude-plugin/marketplace.json theme={null}

~~77{~~72 {

~~78 "extraKnownMarketplaces": {~~73 "name": "my-plugins",

~~79 "team-tools": {~~74 "owner": {

~~80 "source": {~~75 "name": "Your Name"

~~81 "source": "github",~~

~~82 "repo": "your-org/claude-plugins"~~

~~83 }~~

84 },76 },

~~85 "project-specific": {~~77 "plugins": [

~~86 "source": {~~78 {

~~87 "source": "git",~~79 "name": "quality-review-plugin",

~~88 "url": "https://git.company.com/project-plugins.git"~~80 "source": "./plugins/quality-review-plugin",

~~89 }~~81 "description": "Adds a /quality-review skill for quick code reviews"

90 }82 }

83 ]

91 }84 }

~~92}~~85 ```

~~93```~~86 </Step>

88 <Step title="Add and install">

89 Add the marketplace and install the plugin.

94 90

~~95When team members trust the repository folder, Claude Code automatically installs these marketplaces and any plugins specified in the `enabledPlugins` field.~~91 ```shell theme={null}

92 /plugin marketplace add ./my-marketplace

93 /plugin install quality-review-plugin@my-plugins

94 ```

95 </Step>

96 96

~~97***~~97 <Step title="Try it out">

98 Select some code in your editor and run your new command.

98 99

~~99## Create your own marketplace~~100 ```shell theme={null}

101 /quality-review

102 ```

103 </Step>

104</Steps>

100 105

101Build and distribute custom plugin collections for your team or community.106To learn more about what plugins can do, including hooks, agents, MCP servers, and LSP servers, see [Plugins](/en/plugins).

102 107

103### Prerequisites for marketplace creation108<Note>

109 **How plugins are installed**: When users install a plugin, Claude Code copies the plugin directory to a cache location. This means plugins can't reference files outside their directory using paths like `../shared-utils`, because those files won't be copied.

110

111 If you need to share files across plugins, use symlinks (which are followed during copying). See [Plugin caching and file resolution](/en/plugins-reference#plugin-caching-and-file-resolution) for details.

112</Note>

104 113

105* Git repository (GitHub, GitLab, or other git hosting)114## Create the marketplace file

106* Understanding of JSON file format

107* One or more plugins to distribute

108 115

109### Create the marketplace file116Create `.claude-plugin/marketplace.json` in your repository root. This file defines your marketplace's name, owner information, and a list of plugins with their sources.

110 117

111Create `.claude-plugin/marketplace.json` in your repository root:118Each plugin entry needs at minimum a `name` and `source` (where to fetch it from). See the [full schema](#marketplace-schema) below for all available fields.

112 119

113```json theme={null}120```json theme={null}

114{121{

115 "name": "company-tools",122 "name": "company-tools",

116 "owner": {123 "owner": {

117 "name": "DevTools Team",124 "name": "DevTools Team",

118 "email": "devtools@company.com"125 "email": "devtools@example.com"

119 },126 },

120 "plugins": [127 "plugins": [

121 {128 {

139}146}

140```147```

141 148

142### Marketplace schema149## Marketplace schema

143 150

144#### Required fields151### Required fields

145 152

147| :-------- | :----- | :--------------------------------------------- |154| :-------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------- |

151 158

152#### Optional metadata159<Note>

160 **Reserved names**: The following marketplace names are reserved for official Anthropic use and cannot be used by third-party marketplaces: `claude-code-marketplace`, `claude-code-plugins`, `claude-plugins-official`, `anthropic-marketplace`, `anthropic-plugins`, `agent-skills`, `knowledge-work-plugins`, `life-sciences`. Names that impersonate official marketplaces (like `official-claude-plugins` or `anthropic-tools-v2`) are also blocked.

161</Note>

162

163### Owner fields

164

166| :------ | :----- | :------- | :------------------------------- |

169

170### Optional metadata

153 171

155| :--------------------- | :----- | :------------------------------------ |173| :--------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

159 177

160### Plugin entries178## Plugin entries

161 179

162<Note>180Each plugin entry in the `plugins` array describes a plugin and where to find it. You can include any field from the [plugin manifest schema](/en/plugins-reference#plugin-manifest-schema) (like `description`, `version`, `author`, `commands`, `hooks`, etc.), plus these marketplace-specific fields: `source`, `category`, `tags`, and `strict`.

163 Plugin entries are based on the *plugin manifest schema* (with all fields made optional) plus marketplace-specific fields (`source`, `category`, `tags`, `strict`), with `name` being required.

164</Note>

165 181

166**Required fields:**182### Required fields

167 183

169| :------- | :------------- | :---------------------------------------- |185| :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |

172 188

173#### Optional plugin fields189### Optional plugin fields

174 190

175**Standard metadata fields:**191**Standard metadata fields:**

176 192

178| :------------ | :------ | :---------------------------------------------------------------- |194| :------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------------- |

189 205

190**Component configuration fields:**206**Component configuration fields:**

191 207

198 215

199*<sup>1 - When `strict: true` (default), the plugin must include a `plugin.json` manifest file, and marketplace fields supplement those values. When `strict: false`, the plugin.json is optional. If it's missing, the marketplace entry serves as the complete plugin manifest.</sup>*216## Plugin sources

200 217

201### Plugin sources218Plugin sources tell Claude Code where to fetch each individual plugin listed in your marketplace. These are set in the `source` field of each plugin entry in `marketplace.json`.

202 219

203#### Relative paths220Once a plugin is cloned or copied into the local machine, it is copied into the local versioned plugin cache at `~/.claude/plugins/cache`.

204 221

223| ------------- | ------------------------------- | ---------------------------------- | ----------------------------------------------------------------------------------- |

229

230<Note>

231 **Marketplace sources vs plugin sources**: These are different concepts that control different things.

232

233 * **Marketplace source** — where to fetch the `marketplace.json` catalog itself. Set when users run `/plugin marketplace add` or in `extraKnownMarketplaces` settings. Supports `ref` (branch/tag) but not `sha`.

234 * **Plugin source** — where to fetch an individual plugin listed in the marketplace. Set in the `source` field of each plugin entry inside `marketplace.json`. Supports both `ref` (branch/tag) and `sha` (exact commit).

235

236 For example, a marketplace hosted at `acme-corp/plugin-catalog` (marketplace source) can list a plugin fetched from `acme-corp/code-formatter` (plugin source). The marketplace source and plugin source point to different repositories and are pinned independently.

237</Note>

238

239### Relative paths

240

241For plugins in the same repository, use a path starting with `./`:

206 242

207```json theme={null}243```json theme={null}

208{244{

211}247}

212```248```

213 249

214#### GitHub repositories250Paths resolve relative to the marketplace root, which is the directory containing `.claude-plugin/`. In the example above, `./plugins/my-plugin` points to `<repo>/plugins/my-plugin`, even though `marketplace.json` lives at `<repo>/.claude-plugin/marketplace.json`. Do not use `../` to climb out of `.claude-plugin/`.

251

252<Note>

253 Relative paths only work when users add your marketplace via Git (GitHub, GitLab, or git URL). If users add your marketplace via a direct URL to the `marketplace.json` file, relative paths will not resolve correctly. For URL-based distribution, use GitHub, npm, or git URL sources instead. See [Troubleshooting](#plugins-with-relative-paths-fail-in-url-based-marketplaces) for details.

254</Note>

255

256### GitHub repositories

215 257

216```json theme={null}258```json theme={null}

217{259{

223}265}

224```266```

225 267

226#### Git repositories268You can pin to a specific branch, tag, or commit:

269

270```json theme={null}

271{

272 "name": "github-plugin",

273 "source": {

274 "source": "github",

275 "repo": "owner/plugin-repo",

276 "ref": "v2.0.0",

277 "sha": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0"

278 }

279}

280```

281

282| Field | Type | Description |

283| :----- | :----- | :-------------------------------------------------------------------- |

284| `repo` | string | Required. GitHub repository in `owner/repo` format |

285| `ref` | string | Optional. Git branch or tag (defaults to repository default branch) |

286| `sha` | string | Optional. Full 40-character git commit SHA to pin to an exact version |

287

288### Git repositories

227 289

228```json theme={null}290```json theme={null}

229{291{

235}297}

236```298```

237 299

238#### Advanced plugin entries300You can pin to a specific branch, tag, or commit:

301

302```json theme={null}

303{

304 "name": "git-plugin",

305 "source": {

306 "source": "url",

307 "url": "https://gitlab.com/team/plugin.git",

308 "ref": "main",

309 "sha": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0"

310 }

311}

312```

313

314| Field | Type | Description |

315| :---- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |

316| `url` | string | Required. Full git repository URL (`https://` or `git@`). The `.git` suffix is optional, so Azure DevOps and AWS CodeCommit URLs without the suffix work |

317| `ref` | string | Optional. Git branch or tag (defaults to repository default branch) |

318| `sha` | string | Optional. Full 40-character git commit SHA to pin to an exact version |

319

320### Git subdirectories

321

322Use `git-subdir` to point to a plugin that lives inside a subdirectory of a git repository. Claude Code uses a sparse, partial clone to fetch only the subdirectory, minimizing bandwidth for large monorepos.

323

324```json theme={null}

325{

326 "name": "my-plugin",

327 "source": {

328 "source": "git-subdir",

329 "url": "https://github.com/acme-corp/monorepo.git",

330 "path": "tools/claude-plugin"

331 }

332}

333```

334

335You can pin to a specific branch, tag, or commit:

336

337```json theme={null}

338{

339 "name": "my-plugin",

340 "source": {

341 "source": "git-subdir",

342 "url": "https://github.com/acme-corp/monorepo.git",

343 "path": "tools/claude-plugin",

344 "ref": "v2.0.0",

345 "sha": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0"

346 }

347}

348```

349

350The `url` field also accepts a GitHub shorthand (`owner/repo`) or SSH URLs (`git@github.com:owner/repo.git`).

351

352| Field | Type | Description |

353| :----- | :----- | :------------------------------------------------------------------------------------------------------- |

354| `url` | string | Required. Git repository URL, GitHub `owner/repo` shorthand, or SSH URL |

355| `path` | string | Required. Subdirectory path within the repo containing the plugin (for example, `"tools/claude-plugin"`) |

356| `ref` | string | Optional. Git branch or tag (defaults to repository default branch) |

357| `sha` | string | Optional. Full 40-character git commit SHA to pin to an exact version |

358

359### npm packages

360

361Plugins distributed as npm packages are installed using `npm install`. This works with any package on the public npm registry or a private registry your team hosts.

362

363```json theme={null}

364{

365 "name": "my-npm-plugin",

366 "source": {

367 "source": "npm",

368 "package": "@acme/claude-plugin"

369 }

370}

371```

372

373To pin to a specific version, add the `version` field:

239 374

240Plugin entries can override default component locations and provide additional metadata. Note that `${CLAUDE_PLUGIN_ROOT}` is an environment variable that resolves to the plugin's installation directory (for details see [Environment variables](/en/plugins-reference#environment-variables)):375```json theme={null}

376{

377 "name": "my-npm-plugin",

378 "source": {

379 "source": "npm",

380 "package": "@acme/claude-plugin",

381 "version": "2.1.0"

382 }

383}

384```

385

386To install from a private or internal registry, add the `registry` field:

387

388```json theme={null}

389{

390 "name": "my-npm-plugin",

391 "source": {

392 "source": "npm",

393 "package": "@acme/claude-plugin",

394 "version": "^2.0.0",

395 "registry": "https://npm.example.com"

396 }

397}

398```

399

400| Field | Type | Description |

401| :--------- | :----- | :------------------------------------------------------------------------------------------- |

402| `package` | string | Required. Package name or scoped package (for example, `@org/plugin`) |

403| `version` | string | Optional. Version or version range (for example, `2.1.0`, `^2.0.0`, `~1.5.0`) |

404| `registry` | string | Optional. Custom npm registry URL. Defaults to the system npm registry (typically npmjs.org) |

405

406### Advanced plugin entries

407

408This example shows a plugin entry using many of the optional fields, including custom paths for commands, agents, hooks, and MCP servers:

241 409

242```json theme={null}410```json theme={null}

243{411{

250 "version": "2.1.0",418 "version": "2.1.0",

251 "author": {419 "author": {

252 "name": "Enterprise Team",420 "name": "Enterprise Team",

253 "email": "enterprise@company.com"421 "email": "enterprise@example.com"

254 },422 },

255 "homepage": "https://docs.company.com/plugins/enterprise-tools",423 "homepage": "https://docs.example.com/plugins/enterprise-tools",

256 "repository": "https://github.com/company/enterprise-plugin",424 "repository": "https://github.com/company/enterprise-plugin",

257 "license": "MIT",425 "license": "MIT",

258 "keywords": ["enterprise", "workflow", "automation"],426 "keywords": ["enterprise", "workflow", "automation"],

262 "./commands/enterprise/",430 "./commands/enterprise/",

263 "./commands/experimental/preview.md"431 "./commands/experimental/preview.md"

264 ],432 ],

265 "agents": [433 "agents": ["./agents/security-reviewer.md", "./agents/compliance-checker.md"],

266 "./agents/security-reviewer.md",

267 "./agents/compliance-checker.md"

268 ],

269 "hooks": {434 "hooks": {

270 "PostToolUse": [435 "PostToolUse": [

271 {436 {

272 "matcher": "Write|Edit",437 "matcher": "Write|Edit",

273 "hooks": [{"type": "command", "command": "${CLAUDE_PLUGIN_ROOT}/scripts/validate.sh"}]438 "hooks": [

439 {

440 "type": "command",

441 "command": "${CLAUDE_PLUGIN_ROOT}/scripts/validate.sh"

442 }

443 ]

274 }444 }

275 ]445 ]

276 },446 },

284}454}

285```455```

286 456

287<Note>457Key things to notice:

288 **Schema relationship**: Plugin entries use the plugin manifest schema with all fields made optional, plus marketplace-specific fields (`source`, `strict`, `category`, `tags`). This means any field valid in a `plugin.json` file can also be used in a marketplace entry. When `strict: false`, the marketplace entry serves as the complete plugin manifest if no `plugin.json` exists. When `strict: true` (default), marketplace fields supplement the plugin's own manifest file.

289</Note>

290 458

291***459* **`commands` and `agents`**: You can specify multiple directories or individual files. Paths are relative to the plugin root.

460* **`${CLAUDE_PLUGIN_ROOT}`**: use this variable in hooks and MCP server configs to reference files within the plugin's installation directory. This is necessary because plugins are copied to a cache location when installed. For dependencies or state that should survive plugin updates, use [`${CLAUDE_PLUGIN_DATA}`](/en/plugins-reference#persistent-data-directory) instead.

461* **`strict: false`**: Since this is set to false, the plugin doesn't need its own `plugin.json`. The marketplace entry defines everything. See [Strict mode](#strict-mode) below.

292 462

293## Host and distribute marketplaces463### Strict mode

464

465The `strict` field controls whether `plugin.json` is the authority for component definitions (commands, agents, hooks, skills, MCP servers, output styles).

466

467| Value | Behavior |

468| :--------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- |

469| `true` (default) | `plugin.json` is the authority. The marketplace entry can supplement it with additional components, and both sources are merged. |

470| `false` | The marketplace entry is the entire definition. If the plugin also has a `plugin.json` that declares components, that's a conflict and the plugin fails to load. |

294 471

295Choose the best hosting strategy for your plugin distribution needs.472**When to use each mode:**

473

474* **`strict: true`**: the plugin has its own `plugin.json` and manages its own components. The marketplace entry can add extra commands or hooks on top. This is the default and works for most plugins.

475* **`strict: false`**: the marketplace operator wants full control. The plugin repo provides raw files, and the marketplace entry defines which of those files are exposed as commands, agents, hooks, etc. Useful when the marketplace restructures or curates a plugin's components differently than the plugin author intended.

476

477## Host and distribute marketplaces

296 478

297### Host on GitHub (recommended)479### Host on GitHub (recommended)

298 480

300 482

3011. **Create a repository**: Set up a new repository for your marketplace4831. **Create a repository**: Set up a new repository for your marketplace

3022. **Add marketplace file**: Create `.claude-plugin/marketplace.json` with your plugin definitions4842. **Add marketplace file**: Create `.claude-plugin/marketplace.json` with your plugin definitions

3033. **Share with teams**: Team members add with `/plugin marketplace add owner/repo`4853. **Share with teams**: Users add your marketplace with `/plugin marketplace add owner/repo`

304 486

305**Benefits**: Built-in version control, issue tracking, and team collaboration features.487**Benefits**: Built-in version control, issue tracking, and team collaboration features.

306 488

307### Host on other git services489### Host on other git services

308 490

309Any git hosting service works for marketplace distribution, using a URL to an arbitrary git repository.491Any git hosting service works, such as GitLab, Bitbucket, and self-hosted servers. Users add with the full repository URL:

~~310~~

311For example, using GitLab:

312 492

313```shell theme={null}493```shell theme={null}

314/plugin marketplace add https://gitlab.com/company/plugins.git494/plugin marketplace add https://gitlab.com/company/plugins.git

315```495```

316 496

317### Use local marketplaces for development497### Private repositories

318 498

319Test your marketplace locally before distribution:499Claude Code supports installing plugins from private repositories. For manual installation and updates, Claude Code uses your existing git credential helpers. If `git clone` works for a private repository in your terminal, it works in Claude Code too. Common credential helpers include `gh auth login` for GitHub, macOS Keychain, and `git-credential-store`.

320 500

321```shell Add local marketplace for testing theme={null}501Background auto-updates run at startup without credential helpers, since interactive prompts would block Claude Code from starting. To enable auto-updates for private marketplaces, set the appropriate authentication token in your environment:

322/plugin marketplace add ./my-local-marketplace502

503| Provider | Environment variables | Notes |

504| :-------- | :--------------------------- | :---------------------------------------- |

505| GitHub | `GITHUB_TOKEN` or `GH_TOKEN` | Personal access token or GitHub App token |

506| GitLab | `GITLAB_TOKEN` or `GL_TOKEN` | Personal access token or project token |

507| Bitbucket | `BITBUCKET_TOKEN` | App password or repository access token |

508

509Set the token in your shell configuration (for example, `.bashrc`, `.zshrc`) or pass it when running Claude Code:

510

511```bash theme={null}

512export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxx

323```513```

324 514

325```shell Test plugin installation theme={null}515<Note>

516 For CI/CD environments, configure the token as a secret environment variable. GitHub Actions automatically provides `GITHUB_TOKEN` for repositories in the same organization.

517</Note>

518

519### Test locally before distribution

520

521Test your marketplace locally before sharing:

522

523```shell theme={null}

524/plugin marketplace add ./my-local-marketplace

326/plugin install test-plugin@my-local-marketplace525/plugin install test-plugin@my-local-marketplace

327```526```

328 527

329## Manage marketplace operations528For the full range of add commands (GitHub, Git URLs, local paths, remote URLs), see [Add marketplaces](/en/discover-plugins#add-marketplaces).

529

530### Require marketplaces for your team

531

532You can configure your repository so team members are automatically prompted to install your marketplace when they trust the project folder. Add your marketplace to `.claude/settings.json`:

533

534```json theme={null}

535{

536 "extraKnownMarketplaces": {

537 "company-tools": {

538 "source": {

539 "source": "github",

540 "repo": "your-org/claude-plugins"

541 }

542 }

543 }

544}

545```

546

547You can also specify which plugins should be enabled by default:

548

549```json theme={null}

550{

551 "enabledPlugins": {

552 "code-formatter@company-tools": true,

553 "deployment-tools@company-tools": true

554 }

555}

556```

330 557

331### List known marketplaces558For full configuration options, see [Plugin settings](/en/settings#plugin-settings).

332 559

333```shell List all configured marketplaces theme={null}560### Pre-populate plugins for containers

334/plugin marketplace list561

562For container images and CI environments, you can pre-populate a plugins directory at build time so Claude Code starts with marketplaces and plugins already available, without cloning anything at runtime. Set the `CLAUDE_CODE_PLUGIN_SEED_DIR` environment variable to point at this directory.

563

564To layer multiple seed directories, separate paths with `:` on Unix or `;` on Windows. Claude Code searches each directory in order, and the first seed that contains a given marketplace or plugin cache wins.

565

566The seed directory mirrors the structure of `~/.claude/plugins`:

567

568```

569$CLAUDE_CODE_PLUGIN_SEED_DIR/

570 known_marketplaces.json

571 marketplaces/<name>/...

572 cache/<marketplace>/<plugin>/<version>/...

335```573```

336 574

337Shows all configured marketplaces with their sources and status.575The simplest way to build a seed directory is to run Claude Code once during image build, install the plugins you need, then copy the resulting `~/.claude/plugins` directory into your image and point `CLAUDE_CODE_PLUGIN_SEED_DIR` at it.

576

577At startup, Claude Code registers marketplaces found in the seed's `known_marketplaces.json` into the primary configuration, and uses plugin caches found under `cache/` in place without re-cloning. This works in both interactive mode and non-interactive mode with the `-p` flag.

578

579Behavior details:

580

581* **Read-only**: the seed directory is never written to. Auto-updates are disabled for seed marketplaces since git pull would fail on a read-only filesystem.

582* **Seed entries take precedence**: marketplaces declared in the seed overwrite any matching entries in the user's configuration on each startup. To opt out of a seed plugin, use `/plugin disable` rather than removing the marketplace.

583* **Path resolution**: Claude Code locates marketplace content by probing `$CLAUDE_CODE_PLUGIN_SEED_DIR/marketplaces/<name>/` at runtime, not by trusting paths stored inside the seed's JSON. This means the seed works correctly even when mounted at a different path than where it was built.

584* **Composes with settings**: if `extraKnownMarketplaces` or `enabledPlugins` declare a marketplace that already exists in the seed, Claude Code uses the seed copy instead of cloning.

585

586### Managed marketplace restrictions

587

588For organizations requiring strict control over plugin sources, administrators can restrict which plugin marketplaces users are allowed to add using the [`strictKnownMarketplaces`](/en/settings#strictknownmarketplaces) setting in managed settings.

338 589

339### Update marketplace metadata590When `strictKnownMarketplaces` is configured in managed settings, the restriction behavior depends on the value:

340 591

341```shell Refresh marketplace metadata theme={null}592| Value | Behavior |

342/plugin marketplace update marketplace-name593| ------------------- | ---------------------------------------------------------------- |

594| Undefined (default) | No restrictions. Users can add any marketplace |

595| Empty array `[]` | Complete lockdown. Users cannot add any new marketplaces |

596| List of sources | Users can only add marketplaces that match the allowlist exactly |

597

598#### Common configurations

599

600Disable all marketplace additions:

601

602```json theme={null}

603{

604 "strictKnownMarketplaces": []

605}

343```606```

344 607

345Refreshes plugin listings and metadata from the marketplace source.608Allow specific marketplaces only:

609

610```json theme={null}

611{

612 "strictKnownMarketplaces": [

613 {

614 "source": "github",

615 "repo": "acme-corp/approved-plugins"

616 },

617 {

618 "source": "github",

619 "repo": "acme-corp/security-tools",

620 "ref": "v2.0"

621 },

622 {

623 "source": "url",

624 "url": "https://plugins.example.com/marketplace.json"

625 }

626 ]

627}

628```

346 629

347### Remove a marketplace630Allow all marketplaces from an internal git server using regex pattern matching on the host:

348 631

349```shell Remove a marketplace theme={null}632```json theme={null}

350/plugin marketplace remove marketplace-name633{

634 "strictKnownMarketplaces": [

635 {

636 "source": "hostPattern",

637 "hostPattern": "^github\\.example\\.com$"

638 }

639 ]

640}

351```641```

352 642

353Removes the marketplace from your configuration.643Allow filesystem-based marketplaces from a specific directory using regex pattern matching on the path:

644

645```json theme={null}

646{

647 "strictKnownMarketplaces": [

648 {

649 "source": "pathPattern",

650 "pathPattern": "^/opt/approved/"

651 }

652 ]

653}

654```

655

656Use `".*"` as the `pathPattern` to allow any filesystem path while still controlling network sources with `hostPattern`.

657

658<Note>

659 `strictKnownMarketplaces` restricts what users can add, but does not register marketplaces on its own. To make allowed marketplaces available automatically without users running `/plugin marketplace add`, pair it with [`extraKnownMarketplaces`](/en/settings#extraknownmarketplaces) in the same `managed-settings.json`. See [Using both together](/en/settings#strictknownmarketplaces).

660</Note>

661

662#### How restrictions work

663

664Restrictions are validated early in the plugin installation process, before any network requests or filesystem operations occur. This prevents unauthorized marketplace access attempts.

665

666The allowlist uses exact matching for most source types. For a marketplace to be allowed, all specified fields must match exactly:

667

668* For GitHub sources: `repo` is required, and `ref` or `path` must also match if specified in the allowlist

669* For URL sources: the full URL must match exactly

670* For `hostPattern` sources: the marketplace host is matched against the regex pattern

671* For `pathPattern` sources: the marketplace's filesystem path is matched against the regex pattern

672

673Because `strictKnownMarketplaces` is set in [managed settings](/en/settings#settings-files), individual users and project configurations cannot override these restrictions.

674

675For complete configuration details including all supported source types and comparison with `extraKnownMarketplaces`, see the [strictKnownMarketplaces reference](/en/settings#strictknownmarketplaces).

676

677### Version resolution and release channels

678

679Plugin versions determine cache paths and update detection. You can specify the version in the plugin manifest (`plugin.json`) or in the marketplace entry (`marketplace.json`).

680

681<Warning>

682 When possible, avoid setting the version in both places. The plugin manifest always wins silently, which can cause the marketplace version to be ignored. For relative-path plugins, set the version in the marketplace entry. For all other plugin sources, set it in the plugin manifest.

683</Warning>

684

685#### Set up release channels

686

687To support "stable" and "latest" release channels for your plugins, you can set up two marketplaces that point to different refs or SHAs of the same repo. You can then assign the two marketplaces to different user groups through [managed settings](/en/settings#settings-files).

354 688

355<Warning>689<Warning>

356 Removing a marketplace will uninstall any plugins you installed from it.690 The plugin's `plugin.json` must declare a different `version` at each pinned ref or commit. If two refs or commits have the same manifest version, Claude Code treats them as identical and skips the update.

357</Warning>691</Warning>

358 692

359***693##### Example

694

695```json theme={null}

696{

697 "name": "stable-tools",

698 "plugins": [

699 {

700 "name": "code-formatter",

701 "source": {

702 "source": "github",

703 "repo": "acme-corp/code-formatter",

704 "ref": "stable"

705 }

706 }

707 ]

708}

709```

710

711```json theme={null}

712{

713 "name": "latest-tools",

714 "plugins": [

715 {

716 "name": "code-formatter",

717 "source": {

718 "source": "github",

719 "repo": "acme-corp/code-formatter",

720 "ref": "latest"

721 }

722 }

723 ]

724}

725```

726

727##### Assign channels to user groups

728

729Assign each marketplace to the appropriate user group through managed settings. For example, the stable group receives:

730

731```json theme={null}

732{

733 "extraKnownMarketplaces": {

734 "stable-tools": {

735 "source": {

736 "source": "github",

737 "repo": "acme-corp/stable-tools"

738 }

739 }

740 }

741}

742```

743

744The early-access group receives `latest-tools` instead:

360 745

361## Troubleshooting marketplaces746```json theme={null}

747{

748 "extraKnownMarketplaces": {

749 "latest-tools": {

750 "source": {

751 "source": "github",

752 "repo": "acme-corp/latest-tools"

753 }

754 }

755 }

756}

757```

362 758

363### Common marketplace issues759## Validation and testing

364 760

365#### Marketplace not loading761Test your marketplace before sharing.

762

763Validate your marketplace JSON syntax:

764

765```bash theme={null}

766claude plugin validate .

767```

768

769Or from within Claude Code:

770

771```shell theme={null}

772/plugin validate .

773```

774

775Add the marketplace for testing:

776

777```shell theme={null}

778/plugin marketplace add ./path/to/marketplace

779```

780

781Install a test plugin to verify everything works:

782

783```shell theme={null}

784/plugin install test-plugin@marketplace-name

785```

786

787For complete plugin testing workflows, see [Test your plugins locally](/en/plugins#test-your-plugins-locally). For technical troubleshooting, see [Plugins reference](/en/plugins-reference).

788

789## Troubleshooting

790

791### Marketplace not loading

366 792

367**Symptoms**: Can't add marketplace or see plugins from it793**Symptoms**: Can't add marketplace or see plugins from it

368 794

370 796

371* Verify the marketplace URL is accessible797* Verify the marketplace URL is accessible

372* Check that `.claude-plugin/marketplace.json` exists at the specified path798* Check that `.claude-plugin/marketplace.json` exists at the specified path

373* Ensure JSON syntax is valid using `claude plugin validate`799* Ensure JSON syntax is valid and frontmatter is well-formed using `claude plugin validate` or `/plugin validate`

374* For private repositories, confirm you have access permissions800* For private repositories, confirm you have access permissions

375 801

376#### Plugin installation failures802### Marketplace validation errors

803

804Run `claude plugin validate .` or `/plugin validate .` from your marketplace directory to check for issues. The validator checks `plugin.json`, skill/agent/command frontmatter, and `hooks/hooks.json` for syntax and schema errors. Common errors:

805

806| Error | Cause | Solution |

807| :------------------------------------------------ | :---------------------------------------------- | :--------------------------------------------------------------------------------------------- |

808| `File not found: .claude-plugin/marketplace.json` | Missing manifest | Create `.claude-plugin/marketplace.json` with required fields |

809| `Invalid JSON syntax: Unexpected token...` | JSON syntax error in marketplace.json | Check for missing commas, extra commas, or unquoted strings |

810| `Duplicate plugin name "x" found in marketplace` | Two plugins share the same name | Give each plugin a unique `name` value |

811| `plugins[0].source: Path contains ".."` | Source path contains `..` | Use paths relative to the marketplace root without `..`. See [Relative paths](#relative-paths) |

812| `YAML frontmatter failed to parse: ...` | Invalid YAML in a skill, agent, or command file | Fix the YAML syntax in the frontmatter block. At runtime this file loads with no metadata. |

813| `Invalid JSON syntax: ...` (hooks.json) | Malformed `hooks/hooks.json` | Fix JSON syntax. A malformed `hooks/hooks.json` prevents the entire plugin from loading. |

814

815**Warnings** (non-blocking):

816

817* `Marketplace has no plugins defined`: add at least one plugin to the `plugins` array

818* `No marketplace description provided`: add `metadata.description` to help users understand your marketplace

819* `Plugin name "x" is not kebab-case`: the plugin name contains uppercase letters, spaces, or special characters. Rename to lowercase letters, digits, and hyphens only (for example, `my-plugin`). Claude Code accepts other forms, but the Claude.ai marketplace sync rejects them.

820

821### Plugin installation failures

377 822

378**Symptoms**: Marketplace appears but plugin installation fails823**Symptoms**: Marketplace appears but plugin installation fails

379 824

384* For GitHub sources, ensure repositories are public or you have access829* For GitHub sources, ensure repositories are public or you have access

385* Test plugin sources manually by cloning/downloading830* Test plugin sources manually by cloning/downloading

386 831

387### Validation and testing832### Private repository authentication fails

388 833

389Test your marketplace before sharing:834**Symptoms**: Authentication errors when installing plugins from private repositories

390 835

391```bash Validate marketplace JSON syntax theme={null}836**Solutions**:

392claude plugin validate .

393```

394 837

395```shell Add marketplace for testing theme={null}838For manual installation and updates:

396/plugin marketplace add ./path/to/marketplace

397```

398 839

399```shell Install test plugin theme={null}840* Verify you're authenticated with your git provider (for example, run `gh auth status` for GitHub)

400/plugin install test-plugin@marketplace-name841* Check that your credential helper is configured correctly: `git config --global credential.helper`

842* Try cloning the repository manually to verify your credentials work

843

844For background auto-updates:

845

846* Set the appropriate token in your environment: `echo $GITHUB_TOKEN`

847* Check that the token has the required permissions (read access to the repository)

848* For GitHub, ensure the token has the `repo` scope for private repositories

849* For GitLab, ensure the token has at least `read_repository` scope

850* Verify the token hasn't expired

851

852### Git operations time out

853

854**Symptoms**: Plugin installation or marketplace updates fail with a timeout error like "Git clone timed out after 120s" or "Git pull timed out after 120s".

855

856**Cause**: Claude Code uses a 120-second timeout for all git operations, including cloning plugin repositories and pulling marketplace updates. Large repositories or slow network connections may exceed this limit.

857

858**Solution**: Increase the timeout using the `CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS` environment variable. The value is in milliseconds:

859

860```bash theme={null}

861export CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS=300000 # 5 minutes

401```862```

402 863

403For complete plugin testing workflows, see [Test your plugins locally](/en/plugins#test-your-plugins-locally). For technical troubleshooting, see [Plugins reference](/en/plugins-reference).864### Plugins with relative paths fail in URL-based marketplaces

404 865

405***866**Symptoms**: Added a marketplace via URL (such as `https://example.com/marketplace.json`), but plugins with relative path sources like `"./plugins/my-plugin"` fail to install with "path not found" errors.

406 867

407## Next steps868**Cause**: URL-based marketplaces only download the `marketplace.json` file itself. They do not download plugin files from the server. Relative paths in the marketplace entry reference files on the remote server that were not downloaded.

869

870**Solutions**:

408 871

409### For marketplace users872* **Use external sources**: Change plugin entries to use GitHub, npm, or git URL sources instead of relative paths:

873 ```json theme={null}

874 { "name": "my-plugin", "source": { "source": "github", "repo": "owner/repo" } }

875 ```

876* **Use a Git-based marketplace**: Host your marketplace in a Git repository and add it with the git URL. Git-based marketplaces clone the entire repository, making relative paths work correctly.

410 877

411* **Discover community marketplaces**: Search GitHub for Claude Code plugin collections878### Files not found after installation

412* **Contribute feedback**: Report issues and suggest improvements to marketplace maintainers

413* **Share useful marketplaces**: Help your team discover valuable plugin collections

414 879

415### For marketplace creators880**Symptoms**: Plugin installs but references to files fail, especially files outside the plugin directory

416 881

417* **Build plugin collections**: Create themed marketplace around specific use cases882**Cause**: Plugins are copied to a cache directory rather than used in-place. Paths that reference files outside the plugin's directory (such as `../shared-utils`) won't work because those files aren't copied.

418* **Establish versioning**: Implement clear versioning and update policies

419* **Community engagement**: Gather feedback and maintain active marketplace communities

420* **Documentation**: Provide clear README files explaining your marketplace contents

421 883

422### For organizations884**Solutions**: See [Plugin caching and file resolution](/en/plugins-reference#plugin-caching-and-file-resolution) for workarounds including symlinks and directory restructuring.

423 885

424* **Private marketplaces**: Set up internal marketplaces for proprietary tools886For additional debugging tools and common issues, see [Debugging and development tools](/en/plugins-reference#debugging-and-development-tools).

425* **Governance policies**: Establish guidelines for plugin approval and security review

426* **Training resources**: Help teams discover and adopt useful plugins effectively

427 887

428## See also888## See also

429 889

430* [Plugins](/en/plugins) - Installing and using plugins890* [Discover and install prebuilt plugins](/en/discover-plugins) - Installing plugins from existing marketplaces

891* [Plugins](/en/plugins) - Creating your own plugins

431* [Plugins reference](/en/plugins-reference) - Complete technical specifications and schemas892* [Plugins reference](/en/plugins-reference) - Complete technical specifications and schemas

432* [Plugin development](/en/plugins#develop-more-complex-plugins) - Creating your own plugins893* [Plugin settings](/en/settings#plugin-settings) - Plugin configuration options

433* [Settings](/en/settings#plugin-configuration) - Plugin configuration options894* [strictKnownMarketplaces reference](/en/settings#strictknownmarketplaces) - Managed marketplace restrictions

plugins.md +292 −249

Details

~~1# Plugins~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Extend Claude Code with custom commands, agents, hooks, Skills, and MCP servers through the plugin system.~~5# Create plugins

7> Create custom plugins to extend Claude Code with skills, agents, hooks, and MCP servers.

9Plugins let you extend Claude Code with custom functionality that can be shared across projects and teams. This guide covers creating your own plugins with skills, agents, hooks, and MCP servers.

11Looking to install existing plugins? See [Discover and install plugins](/en/discover-plugins). For complete technical specifications, see [Plugins reference](/en/plugins-reference).

13## When to use plugins vs standalone configuration

15Claude Code supports two ways to add custom skills, agents, and hooks:

17| Approach | Skill names | Best for |

18| :---------------------------------------------------------- | :------------------- | :---------------------------------------------------------------------------------------------- |

19| **Standalone** (`.claude/` directory) | `/hello` | Personal workflows, project-specific customizations, quick experiments |

20| **Plugins** (directories with `.claude-plugin/plugin.json`) | `/plugin-name:hello` | Sharing with teammates, distributing to community, versioned releases, reusable across projects |

22**Use standalone configuration when**:

24* You're customizing Claude Code for a single project

25* The configuration is personal and doesn't need to be shared

26* You're experimenting with skills or hooks before packaging them

27* You want short skill names like `/hello` or `/deploy`

29**Use plugins when**:

31* You want to share functionality with your team or community

32* You need the same skills/agents across multiple projects

33* You want version control and easy updates for your extensions

34* You're distributing through a marketplace

35* You're okay with namespaced skills like `/my-plugin:hello` (namespacing prevents conflicts between plugins)

4 36

5<Tip>37<Tip>

~~6 For complete technical specifications and schemas, see [Plugins reference](/en/plugins-reference). For marketplace management, see [Plugin marketplaces](/en/plugin-marketplaces).~~38 Start with standalone configuration in `.claude/` for quick iteration, then [convert to a plugin](#convert-existing-configurations-to-plugins) when you're ready to share.

7</Tip>39</Tip>

8 40

9Plugins let you extend Claude Code with custom functionality that can be shared across projects and teams. Install plugins from [marketplaces](/en/plugin-marketplaces) to add pre-built commands, agents, hooks, Skills, and MCP servers, or create your own to automate your workflows.

11## Quickstart41## Quickstart

12 42

~~13Let's create a simple greeting plugin to get you familiar with the plugin system. We'll build a working plugin that adds a custom command, test it locally, and understand the core concepts.~~43This quickstart walks you through creating a plugin with a custom skill. You'll create a manifest (the configuration file that defines your plugin), add a skill, and test it locally using the `--plugin-dir` flag.

14 44

15### Prerequisites45### Prerequisites

16 46

~~17* Claude Code installed on your machine~~47* Claude Code [installed and authenticated](/en/quickstart#step-1-install-claude-code)

~~18* Basic familiarity with command-line tools~~48* Claude Code version 1.0.33 or later (run `claude --version` to check)

50<Note>

51 If you don't see the `/plugin` command, update Claude Code to the latest version. See [Troubleshooting](/en/troubleshooting) for upgrade instructions.

52</Note>

19 53

20### Create your first plugin54### Create your first plugin

21 55

22<Steps>56<Steps>

~~23 <Step title="Create the marketplace structure">~~

~~24 ```bash theme={null}~~

~~25 mkdir test-marketplace~~

~~26 cd test-marketplace~~

~~27 ```~~

~~28 </Step>~~

30 <Step title="Create the plugin directory">57 <Step title="Create the plugin directory">

58 Every plugin lives in its own directory containing a manifest and your skills, agents, or hooks. Create one now:

31 ```bash theme={null}60 ```bash theme={null}

32 mkdir my-first-plugin61 mkdir my-first-plugin

~~33 cd my-first-plugin~~

34 ```62 ```

35 </Step>63 </Step>

36 64

37 <Step title="Create the plugin manifest">65 <Step title="Create the plugin manifest">

~~38 ```bash Create .claude-plugin/plugin.json theme={null}~~66 The manifest file at `.claude-plugin/plugin.json` defines your plugin's identity: its name, description, and version. Claude Code uses this metadata to display your plugin in the plugin manager.

~~39 mkdir .claude-plugin~~67

~~40 cat > .claude-plugin/plugin.json << 'EOF'~~68 Create the `.claude-plugin` directory inside your plugin folder:

70 ```bash theme={null}

71 mkdir my-first-plugin/.claude-plugin

72 ```

74 Then create `my-first-plugin/.claude-plugin/plugin.json` with this content:

76 ```json my-first-plugin/.claude-plugin/plugin.json theme={null}

41 {77 {

42 "name": "my-first-plugin",78 "name": "my-first-plugin",

~~43 "description": "A simple greeting plugin to learn the basics",~~79 "description": "A greeting plugin to learn the basics",

44 "version": "1.0.0",80 "version": "1.0.0",

45 "author": {81 "author": {

46 "name": "Your Name"82 "name": "Your Name"

47 }83 }

48 }84 }

~~49 EOF~~

50 ```85 ```

87 | Field | Purpose |

88 | :------------ | :----------------------------------------------------------------------------------------------------- |

89 | `name` | Unique identifier and skill namespace. Skills are prefixed with this (e.g., `/my-first-plugin:hello`). |

90 | `description` | Shown in the plugin manager when browsing or installing plugins. |

91 | `version` | Track releases using [semantic versioning](/en/plugins-reference#version-management). |

92 | `author` | Optional. Helpful for attribution. |

94 For additional fields like `homepage`, `repository`, and `license`, see the [full manifest schema](/en/plugins-reference#plugin-manifest-schema).

51 </Step>95 </Step>

52 96

~~53 <Step title="Add a custom command">~~97 <Step title="Add a skill">

~~54 ```bash Create commands/hello.md theme={null}~~98 Skills live in the `skills/` directory. Each skill is a folder containing a `SKILL.md` file. The folder name becomes the skill name, prefixed with the plugin's namespace (`hello/` in a plugin named `my-first-plugin` creates `/my-first-plugin:hello`).

~~55 mkdir commands~~

~~56 cat > commands/hello.md << 'EOF'~~

~~57 ---~~

~~58 description: Greet the user with a personalized message~~

~~59 ---~~

60 99

~~61 # Hello Command~~100 Create a skill directory in your plugin folder:

62 101

~~63 Greet the user warmly and ask how you can help them today. Make the greeting personal and encouraging.~~102 ```bash theme={null}

~~64 EOF~~103 mkdir -p my-first-plugin/skills/hello

65 ```104 ```

~~66 </Step>~~

67 105

~~68 <Step title="Create the marketplace manifest">~~106 Then create `my-first-plugin/skills/hello/SKILL.md` with this content:

~~69 ```bash Create marketplace.json theme={null}~~107

~~70 cd ..~~108 ```markdown my-first-plugin/skills/hello/SKILL.md theme={null}

~~71 mkdir .claude-plugin~~109 ---

~~72 cat > .claude-plugin/marketplace.json << 'EOF'~~110 description: Greet the user with a friendly message

~~73 {~~111 disable-model-invocation: true

~~74 "name": "test-marketplace",~~112 ---

~~75 "owner": {~~113

~~76 "name": "Test User"~~114 Greet the user warmly and ask how you can help them today.

~~77 },~~

~~78 "plugins": [~~

~~79 {~~

~~80 "name": "my-first-plugin",~~

~~81 "source": "./my-first-plugin",~~

~~82 "description": "My first test plugin"~~

~~83 }~~

~~84 ]~~

~~85 }~~

~~86 EOF~~

87 ```115 ```

88 </Step>116 </Step>

89 117

~~90 <Step title="Install and test your plugin">~~118 <Step title="Test your plugin">

~~91 ```bash Start Claude Code from parent directory theme={null}~~119 Run Claude Code with the `--plugin-dir` flag to load your plugin:

~~92 cd ..~~120

~~93 claude~~121 ```bash theme={null}

122 claude --plugin-dir ./my-first-plugin

94 ```123 ```

95 124

~~96 ```shell Add the test marketplace theme={null}~~125 Once Claude Code starts, try your new skill:

~~97 /plugin marketplace add ./test-marketplace~~126

127 ```shell theme={null}

128 /my-first-plugin:hello

98 ```129 ```

99 130

100 ```shell Install your plugin theme={null}131 You'll see Claude respond with a greeting. Run `/help` to see your skill listed under the plugin namespace.

101 /plugin install my-first-plugin@test-marketplace132

133 <Note>

134 **Why namespacing?** Plugin skills are always namespaced (like `/greet:hello`) to prevent conflicts when multiple plugins have skills with the same name.

135

136 To change the namespace prefix, update the `name` field in `plugin.json`.

137 </Note>

138 </Step>

139

140 <Step title="Add skill arguments">

141 Make your skill dynamic by accepting user input. The `$ARGUMENTS` placeholder captures any text the user provides after the skill name.

142

143 Update your `SKILL.md` file:

144

145 ```markdown my-first-plugin/skills/hello/SKILL.md theme={null}

146 ---

147 description: Greet the user with a personalized message

148 ---

149

150 # Hello Skill

151

152 Greet the user named "$ARGUMENTS" warmly and ask how you can help them today. Make the greeting personal and encouraging.

102 ```153 ```

103 154

104 Select "Install now". You'll then need to restart Claude Code in order to use the new plugin.155 Run `/reload-plugins` to pick up the changes, then try the skill with your name:

105 156

106 ```shell Try your new command theme={null}157 ```shell theme={null}

107 /hello158 /my-first-plugin:hello Alex

108 ```159 ```

109 160

110 You'll see Claude use your greeting command! Check `/help` to see your new command listed.161 Claude will greet you by name. For more on passing arguments to skills, see [Skills](/en/skills#pass-arguments-to-skills).

111 </Step>162 </Step>

112</Steps>163</Steps>

113 164

114You've successfully created and tested a plugin with these key components:165You've successfully created and tested a plugin with these key components:

115 166

116* **Plugin manifest** (`.claude-plugin/plugin.json`) - Describes your plugin's metadata167* **Plugin manifest** (`.claude-plugin/plugin.json`): describes your plugin's metadata

117* **Commands directory** (`commands/`) - Contains your custom slash commands168* **Skills directory** (`skills/`): contains your custom skills

118* **Test marketplace** - Allows you to test your plugin locally169* **Skill arguments** (`$ARGUMENTS`): captures user input for dynamic behavior

119 170

120### Plugin structure overview171<Tip>

172 The `--plugin-dir` flag is useful for development and testing. When you're ready to share your plugin with others, see [Create and distribute a plugin marketplace](/en/plugin-marketplaces).

173</Tip>

121 174

122Your plugin follows this basic structure:175## Plugin structure overview

123 176

124```177You've created a plugin with a skill, but plugins can include much more: custom agents, hooks, MCP servers, and LSP servers.

125my-first-plugin/

126├── .claude-plugin/

127│ └── plugin.json # Plugin metadata

128├── commands/ # Custom slash commands (optional)

129│ └── hello.md

130├── agents/ # Custom agents (optional)

131│ └── helper.md

132├── skills/ # Agent Skills (optional)

133│ └── my-skill/

134│ └── SKILL.md

135└── hooks/ # Event handlers (optional)

136 └── hooks.json

137```

138 178

139**Additional components you can add:**179<Warning>

180 **Common mistake**: Don't put `commands/`, `agents/`, `skills/`, or `hooks/` inside the `.claude-plugin/` directory. Only `plugin.json` goes inside `.claude-plugin/`. All other directories must be at the plugin root level.

181</Warning>

140 182

141* **Commands**: Create markdown files in `commands/` directory183| Directory | Location | Purpose |

142* **Agents**: Create agent definitions in `agents/` directory184| :---------------- | :---------- | :----------------------------------------------------------------------------- |

143* **Skills**: Create `SKILL.md` files in `skills/` directory185| `.claude-plugin/` | Plugin root | Contains `plugin.json` manifest (optional if components use default locations) |

144* **Hooks**: Create `hooks/hooks.json` for event handling186| `commands/` | Plugin root | Skills as Markdown files |

145* **MCP servers**: Create `.mcp.json` for external tool integration187| `agents/` | Plugin root | Custom agent definitions |

188| `skills/` | Plugin root | Agent Skills with `SKILL.md` files |

189| `hooks/` | Plugin root | Event handlers in `hooks.json` |

190| `.mcp.json` | Plugin root | MCP server configurations |

191| `.lsp.json` | Plugin root | LSP server configurations for code intelligence |

192| `settings.json` | Plugin root | Default [settings](/en/settings) applied when the plugin is enabled |

146 193

147<Note>194<Note>

148 **Next steps**: Ready to add more features? Jump to [Develop more complex plugins](#develop-more-complex-plugins) to add agents, hooks, and MCP servers. For complete technical specifications of all plugin components, see [Plugins reference](/en/plugins-reference).195 **Next steps**: Ready to add more features? Jump to [Develop more complex plugins](#develop-more-complex-plugins) to add agents, hooks, MCP servers, and LSP servers. For complete technical specifications of all plugin components, see [Plugins reference](/en/plugins-reference).

149</Note>196</Note>

150 197

151***198## Develop more complex plugins

152 199

153## Install and manage plugins200Once you're comfortable with basic plugins, you can create more sophisticated extensions.

154 201

155Learn how to discover, install, and manage plugins to extend your Claude Code capabilities.202### Add Skills to your plugin

156 203

157### Prerequisites204Plugins can include [Agent Skills](/en/skills) to extend Claude's capabilities. Skills are model-invoked: Claude automatically uses them based on the task context.

158 205

159* Claude Code installed and running206Add a `skills/` directory at your plugin root with Skill folders containing `SKILL.md` files:

160* Basic familiarity with command-line interfaces

161 207

162### Add marketplaces208```text theme={null}

209my-plugin/

210├── .claude-plugin/

211│ └── plugin.json

212└── skills/

213 └── code-review/

214 └── SKILL.md

215```

163 216

164Marketplaces are catalogs of available plugins. Add them to discover and install plugins:217Each `SKILL.md` needs frontmatter with `name` and `description` fields, followed by instructions:

165 218

166```shell Add a marketplace theme={null}219```yaml theme={null}

167/plugin marketplace add your-org/claude-plugins220---

168```221name: code-review

222description: Reviews code for best practices and potential issues. Use when reviewing code, checking PRs, or analyzing code quality.

223---

169 224

170```shell Browse available plugins theme={null}225When reviewing code, check for:

171/plugin2261. Code organization and structure

2272. Error handling

2283. Security concerns

2294. Test coverage

172```230```

173 231

174For detailed marketplace management including Git repositories, local development, and team distribution, see [Plugin marketplaces](/en/plugin-marketplaces).232After installing the plugin, run `/reload-plugins` to load the Skills. For complete Skill authoring guidance including progressive disclosure and tool restrictions, see [Agent Skills](/en/skills).

175 233

176### Install plugins234### Add LSP servers to your plugin

177 235

178#### Via interactive menu (recommended for discovery)236<Tip>

237 For common languages like TypeScript, Python, and Rust, install the pre-built LSP plugins from the official marketplace. Create custom LSP plugins only when you need support for languages not already covered.

238</Tip>

179 239

180```shell Open the plugin management interface theme={null}240LSP (Language Server Protocol) plugins give Claude real-time code intelligence. If you need to support a language that doesn't have an official LSP plugin, you can create your own by adding an `.lsp.json` file to your plugin:

181/plugin241

242```json .lsp.json theme={null}

243{

244 "go": {

245 "command": "gopls",

246 "args": ["serve"],

247 "extensionToLanguage": {

248 ".go": "go"

249 }

250 }

251}

182```252```

183 253

184Select "Browse Plugins" to see available options with descriptions, features, and installation options.254Users installing your plugin must have the language server binary installed on their machine.

185 255

186#### Via direct commands (for quick installation)256For complete LSP configuration options, see [LSP servers](/en/plugins-reference#lsp-servers).

187 257

188```shell Install a specific plugin theme={null}258### Ship default settings with your plugin

189/plugin install formatter@your-org

190```

191 259

192```shell Enable a disabled plugin theme={null}260Plugins can include a `settings.json` file at the plugin root to apply default configuration when the plugin is enabled. Currently, only the `agent` key is supported.

193/plugin enable plugin-name@marketplace-name261

194```262Setting `agent` activates one of the plugin's [custom agents](/en/sub-agents) as the main thread, applying its system prompt, tool restrictions, and model. This lets a plugin change how Claude Code behaves by default when enabled.

195 263

196```shell Disable without uninstalling theme={null}264```json settings.json theme={null}

197/plugin disable plugin-name@marketplace-name265{

266 "agent": "security-reviewer"

267}

198```268```

199 269

200```shell Completely remove a plugin theme={null}270This example activates the `security-reviewer` agent defined in the plugin's `agents/` directory. Settings from `settings.json` take priority over `settings` declared in `plugin.json`. Unknown keys are silently ignored.

201/plugin uninstall plugin-name@marketplace-name271

272### Organize complex plugins

273

274For plugins with many components, organize your directory structure by functionality. For complete directory layouts and organization patterns, see [Plugin directory structure](/en/plugins-reference#plugin-directory-structure).

275

276### Test your plugins locally

277

278Use the `--plugin-dir` flag to test plugins during development. This loads your plugin directly without requiring installation.

279

280```bash theme={null}

281claude --plugin-dir ./my-plugin

202```282```

203 283

204### Verify installation284When a `--plugin-dir` plugin has the same name as an installed marketplace plugin, the local copy takes precedence for that session. This lets you test changes to a plugin you already have installed without uninstalling it first. Marketplace plugins force-enabled by managed settings are the only exception and cannot be overridden.

205 285

206After installing a plugin:286As you make changes to your plugin, run `/reload-plugins` to pick up the updates without restarting. This reloads plugins, skills, agents, hooks, plugin MCP servers, and plugin LSP servers. Test your plugin components:

207 287

2081. **Check available commands**: Run `/help` to see new commands288* Try your skills with `/plugin-name:skill-name`

2092. **Test plugin features**: Try the plugin's commands and features289* Check that agents appear in `/agents`

2103. **Review plugin details**: Use `/plugin` → "Manage Plugins" to see what the plugin provides290* Verify hooks work as expected

211 291

212## Set up team plugin workflows292<Tip>

293 You can load multiple plugins at once by specifying the flag multiple times:

213 294

214Configure plugins at the repository level to ensure consistent tooling across your team. When team members trust your repository folder, Claude Code automatically installs specified marketplaces and plugins.295 ```bash theme={null}

296 claude --plugin-dir ./plugin-one --plugin-dir ./plugin-two

297 ```

298</Tip>

215 299

216**To set up team plugins:**300### Debug plugin issues

217 301

2181. Add marketplace and plugin configuration to your repository's `.claude/settings.json`302If your plugin isn't working as expected:

2192. Team members trust the repository folder

2203. Plugins install automatically for all team members

221 303

222For complete instructions including configuration examples, marketplace setup, and rollout best practices, see [Configure team marketplaces](/en/plugin-marketplaces#how-to-configure-team-marketplaces).3041. **Check the structure**: Ensure your directories are at the plugin root, not inside `.claude-plugin/`

3052. **Test components individually**: Check each command, agent, and hook separately

3063. **Use validation and debugging tools**: See [Debugging and development tools](/en/plugins-reference#debugging-and-development-tools) for CLI commands and troubleshooting techniques

223 307

224***308### Share your plugins

225 309

226## Develop more complex plugins310When your plugin is ready to share:

227 311

228Once you're comfortable with basic plugins, you can create more sophisticated extensions.3121. **Add documentation**: Include a `README.md` with installation and usage instructions

3132. **Version your plugin**: Use [semantic versioning](/en/plugins-reference#version-management) in your `plugin.json`

3143. **Create or use a marketplace**: Distribute through [plugin marketplaces](/en/plugin-marketplaces) for installation

3154. **Test with others**: Have team members test the plugin before wider distribution

229 316

230### Add Skills to your plugin317Once your plugin is in a marketplace, others can install it using the instructions in [Discover and install plugins](/en/discover-plugins).

231 318

232Plugins can include [Agent Skills](/en/skills) to extend Claude's capabilities. Skills are model-invoked—Claude autonomously uses them based on the task context.319### Submit your plugin to the official marketplace

233 320

234To add Skills to your plugin, create a `skills/` directory at your plugin root and add Skill folders with `SKILL.md` files. Plugin Skills are automatically available when the plugin is installed.321To submit a plugin to the official Anthropic marketplace, use one of the in-app submission forms:

235 322

236For complete Skill authoring guidance, see [Agent Skills](/en/skills).323* **Claude.ai**: [claude.ai/settings/plugins/submit](https://claude.ai/settings/plugins/submit)

324* **Console**: [platform.claude.com/plugins/submit](https://platform.claude.com/plugins/submit)

237 325

238### Organize complex plugins326<Note>

327 For complete technical specifications, debugging techniques, and distribution strategies, see [Plugins reference](/en/plugins-reference).

328</Note>

239 329

240For plugins with many components, organize your directory structure by functionality. For complete directory layouts and organization patterns, see [Plugin directory structure](/en/plugins-reference#plugin-directory-structure).330## Convert existing configurations to plugins

241 331

242### Test your plugins locally332If you already have skills or hooks in your `.claude/` directory, you can convert them into a plugin for easier sharing and distribution.

243 333

244When developing plugins, use a local marketplace to test changes iteratively. This workflow builds on the quickstart pattern and works for plugins of any complexity.334### Migration steps

245 335

246<Steps>336<Steps>

247 <Step title="Set up your development structure">337 <Step title="Create the plugin structure">

248 Organize your plugin and marketplace for testing:338 Create a new plugin directory:

249 339

250 ```bash Create directory structure theme={null}340 ```bash theme={null}

251 mkdir dev-marketplace341 mkdir -p my-plugin/.claude-plugin

252 cd dev-marketplace

253 mkdir my-plugin

254 ```342 ```

255 343

256 This creates:344 Create the manifest file at `my-plugin/.claude-plugin/plugin.json`:

257 345

258 ```346 ```json my-plugin/.claude-plugin/plugin.json theme={null}

259 dev-marketplace/

260 ├── .claude-plugin/marketplace.json (you'll create this)

261 └── my-plugin/ (your plugin under development)

262 ├── .claude-plugin/plugin.json

263 ├── commands/

264 ├── agents/

265 └── hooks/

266 ```

267 </Step>

~~268~~

269 <Step title="Create the marketplace manifest">

270 ```bash Create marketplace.json theme={null}

271 mkdir .claude-plugin

272 cat > .claude-plugin/marketplace.json << 'EOF'

273 {

274 "name": "dev-marketplace",

275 "owner": {

276 "name": "Developer"

277 },

278 "plugins": [

279 {347 {

280 "name": "my-plugin",348 "name": "my-plugin",

281 "source": "./my-plugin",349 "description": "Migrated from standalone configuration",

282 "description": "Plugin under development"350 "version": "1.0.0"

283 }351 }

284 ]

285 }

286 EOF

287 ```352 ```

288 </Step>353 </Step>

289 354

290 <Step title="Install and test">355 <Step title="Copy your existing files">

291 ```bash Start Claude Code from parent directory theme={null}356 Copy your existing configurations to the plugin directory:

292 cd ..

293 claude

294 ```

~~295~~

296 ```shell Add your development marketplace theme={null}

297 /plugin marketplace add ./dev-marketplace

298 ```

299 357

300 ```shell Install your plugin theme={null}358 ```bash theme={null}

301 /plugin install my-plugin@dev-marketplace359 # Copy commands

302 ```360 cp -r .claude/commands my-plugin/

303 361

304 Test your plugin components:362 # Copy agents (if any)

363 cp -r .claude/agents my-plugin/

305 364

306 * Try your commands with `/command-name`365 # Copy skills (if any)

307 * Check that agents appear in `/agents`366 cp -r .claude/skills my-plugin/

308 * Verify hooks work as expected367 ```

309 </Step>368 </Step>

310 369

311 <Step title="Iterate on your plugin">370 <Step title="Migrate hooks">

312 After making changes to your plugin code:371 If you have hooks in your settings, create a hooks directory:

313 372

314 ```shell Uninstall the current version theme={null}373 ```bash theme={null}

315 /plugin uninstall my-plugin@dev-marketplace374 mkdir my-plugin/hooks

316 ```375 ```

317 376

318 ```shell Reinstall to test changes theme={null}377 Create `my-plugin/hooks/hooks.json` with your hooks configuration. Copy the `hooks` object from your `.claude/settings.json` or `settings.local.json`, since the format is the same. The command receives hook input as JSON on stdin, so use `jq` to extract the file path:

319 /plugin install my-plugin@dev-marketplace

320 ```

321 378

322 Repeat this cycle as you develop and refine your plugin.379 ```json my-plugin/hooks/hooks.json theme={null}

380 {

381 "hooks": {

382 "PostToolUse": [

383 {

384 "matcher": "Write|Edit",

385 "hooks": [{ "type": "command", "command": "jq -r '.tool_input.file_path' | xargs npm run lint:fix" }]

386 }

387 ]

388 }

389 }

390 ```

323 </Step>391 </Step>

324</Steps>

325 392

326<Note>393 <Step title="Test your migrated plugin">

327 **For multiple plugins**: Organize plugins in subdirectories like `./plugins/plugin-name` and update your marketplace.json accordingly. See [Plugin sources](/en/plugin-marketplaces#plugin-sources) for organization patterns.394 Load your plugin to verify everything works:

328</Note>

329 395

330### Debug plugin issues396 ```bash theme={null}

~~331~~ 397 claude --plugin-dir ./my-plugin

332If your plugin isn't working as expected:398 ```

~~333~~

3341. **Check the structure**: Ensure your directories are at the plugin root, not inside `.claude-plugin/`

3352. **Test components individually**: Check each command, agent, and hook separately

3363. **Use validation and debugging tools**: See [Debugging and development tools](/en/plugins-reference#debugging-and-development-tools) for CLI commands and troubleshooting techniques

337 399

338### Share your plugins400 Test each component: run your commands, check agents appear in `/agents`, and verify hooks trigger correctly.

401 </Step>

402</Steps>

339 403

340When your plugin is ready to share:404### What changes when migrating

341 405

3421. **Add documentation**: Include a README.md with installation and usage instructions406| Standalone (`.claude/`) | Plugin |

3432. **Version your plugin**: Use semantic versioning in your `plugin.json`407| :---------------------------- | :------------------------------- |

3443. **Create or use a marketplace**: Distribute through plugin marketplaces for easy installation408| Only available in one project | Can be shared via marketplaces |

3454. **Test with others**: Have team members test the plugin before wider distribution409| Files in `.claude/commands/` | Files in `plugin-name/commands/` |

410| Hooks in `settings.json` | Hooks in `hooks/hooks.json` |

411| Must manually copy to share | Install with `/plugin install` |

346 412

347<Note>413<Note>

348 For complete technical specifications, debugging techniques, and distribution strategies, see [Plugins reference](/en/plugins-reference).414 After migrating, you can remove the original files from `.claude/` to avoid duplicates. The plugin version will take precedence when loaded.

349</Note>415</Note>

350 416

351***

~~352~~

353## Next steps417## Next steps

354 418

355Now that you understand Claude Code's plugin system, here are suggested paths for different goals:419Now that you understand Claude Code's plugin system, here are suggested paths for different goals:

356 420

357### For plugin users421### For plugin users

358 422

359* **Discover plugins**: Browse community marketplaces for useful tools423* [Discover and install plugins](/en/discover-plugins): browse marketplaces and install plugins

360* **Team adoption**: Set up repository-level plugins for your projects424* [Configure team marketplaces](/en/discover-plugins#configure-team-marketplaces): set up repository-level plugins for your team

361* **Marketplace management**: Learn to manage multiple plugin sources

362* **Advanced usage**: Explore plugin combinations and workflows

363 425

364### For plugin developers426### For plugin developers

365 427

366* **Create your first marketplace**: [Plugin marketplaces guide](/en/plugin-marketplaces)428* [Create and distribute a marketplace](/en/plugin-marketplaces): package and share your plugins

367* **Advanced components**: Dive deeper into specific plugin components:429* [Plugins reference](/en/plugins-reference): complete technical specifications

368 * [Slash commands](/en/slash-commands) - Command development details430* Dive deeper into specific plugin components:

369 * [Subagents](/en/sub-agents) - Agent configuration and capabilities431 * [Skills](/en/skills): skill development details

370 * [Agent Skills](/en/skills) - Extend Claude's capabilities432 * [Subagents](/en/sub-agents): agent configuration and capabilities

371 * [Hooks](/en/hooks) - Event handling and automation433 * [Hooks](/en/hooks): event handling and automation

372 * [MCP](/en/mcp) - External tool integration434 * [MCP](/en/mcp): external tool integration

373* **Distribution strategies**: Package and share your plugins effectively

374* **Community contribution**: Consider contributing to community plugin collections

~~375~~

376### For team leads and administrators

~~377~~

378* **Repository configuration**: Set up automatic plugin installation for team projects

379* **Plugin governance**: Establish guidelines for plugin approval and security review

380* **Marketplace maintenance**: Create and maintain organization-specific plugin catalogs

381* **Training and documentation**: Help team members adopt plugin workflows effectively

~~382~~

383## See also

~~384~~

385* [Plugin marketplaces](/en/plugin-marketplaces) - Creating and managing plugin catalogs

386* [Slash commands](/en/slash-commands) - Understanding custom commands

387* [Subagents](/en/sub-agents) - Creating and using specialized agents

388* [Agent Skills](/en/skills) - Extend Claude's capabilities

389* [Hooks](/en/hooks) - Automating workflows with event handlers

390* [MCP](/en/mcp) - Connecting to external tools and services

391* [Settings](/en/settings) - Configuration options for plugins

plugins-reference.md +550 −97

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Plugins reference5# Plugins reference

2 6

3> Complete technical reference for Claude Code plugin system, including schemas, CLI commands, and component specifications.7> Complete technical reference for Claude Code plugin system, including schemas, CLI commands, and component specifications.

4 8

5<Tip>9<Tip>

~~6 For hands-on tutorials and practical usage, see [Plugins](/en/plugins). For plugin management across teams and communities, see [Plugin marketplaces](/en/plugin-marketplaces).~~10 Looking to install plugins? See [Discover and install plugins](/en/discover-plugins). For creating plugins, see [Plugins](/en/plugins). For distributing plugins, see [Plugin marketplaces](/en/plugin-marketplaces).

7</Tip>11</Tip>

8 12

9This reference provides complete technical specifications for the Claude Code plugin system, including component schemas, CLI commands, and development tools.13This reference provides complete technical specifications for the Claude Code plugin system, including component schemas, CLI commands, and development tools.

10 14

15A **plugin** is a self-contained directory of components that extends Claude Code with custom functionality. Plugin components include skills, agents, hooks, MCP servers, and LSP servers.

11## Plugin components reference17## Plugin components reference

12 18

~~13This section documents the five types of components that plugins can provide.~~19### Skills

14 20

~~15### Commands~~21Plugins add skills to Claude Code, creating `/name` shortcuts that you or Claude can invoke.

16 22

~~17Plugins add custom slash commands that integrate seamlessly with Claude Code's command system.~~23**Location**: `skills/` or `commands/` directory in plugin root

18 24

~~19**Location**: `commands/` directory in plugin root~~25**File format**: Skills are directories with `SKILL.md`; commands are simple markdown files

27**Skill structure**:

20 28

~~21**File format**: Markdown files with frontmatter~~29```text theme={null}

30skills/

31├── pdf-processor/

32│ ├── SKILL.md

33│ ├── reference.md (optional)

34│ └── scripts/ (optional)

35└── code-reviewer/

36 └── SKILL.md

37```

39**Integration behavior**:

41* Skills and commands are automatically discovered when the plugin is installed

42* Claude can invoke them automatically based on task context

43* Skills can include supporting files alongside SKILL.md

22 44

~~23For complete details on plugin command structure, invocation patterns, and features, see [Plugin commands](/en/slash-commands#plugin-commands).~~45For complete details, see [Skills](/en/skills).

24 46

25### Agents47### Agents

26 48

34 56

35```markdown theme={null}57```markdown theme={null}

36---58---

~~37description: What this agent specializes in~~59name: agent-name

~~38capabilities: ["task1", "task2", "task3"]~~60description: What this agent specializes in and when Claude should invoke it

61model: sonnet

62effort: medium

63maxTurns: 20

64disallowedTools: Write, Edit

39---65---

40 66

~~41# Agent Name~~67Detailed system prompt for the agent describing its role, expertise, and behavior.

~~43Detailed description of the agent's role, expertise, and when Claude should invoke it.~~

~~45## Capabilities~~

~~46- Specific task the agent excels at~~

~~47- Another specialized capability~~

~~48- When to use this agent vs others~~

~~50## Context and examples~~

~~51Provide examples of when this agent should be used and what kinds of problems it solves.~~

52```68```

53 69

70Plugin agents support `name`, `description`, `model`, `effort`, `maxTurns`, `tools`, `disallowedTools`, `skills`, `memory`, `background`, and `isolation` frontmatter fields. The only valid `isolation` value is `"worktree"`. For security reasons, `hooks`, `mcpServers`, and `permissionMode` are not supported for plugin-shipped agents.

54**Integration points**:72**Integration points**:

55 73

56* Agents appear in the `/agents` interface74* Agents appear in the `/agents` interface

58* Agents can be invoked manually by users76* Agents can be invoked manually by users

59* Plugin agents work alongside built-in Claude agents77* Plugin agents work alongside built-in Claude agents

60 78

~~61### Skills~~79For complete details, see [Subagents](/en/sub-agents).

~~63Plugins can provide Agent Skills that extend Claude's capabilities. Skills are model-invoked—Claude autonomously decides when to use them based on the task context.~~

~~65**Location**: `skills/` directory in plugin root~~

~~67**File format**: Directories containing `SKILL.md` files with frontmatter~~

~~69**Skill structure**:~~

~~71```~~

~~72skills/~~

~~73├── pdf-processor/~~

~~74│ ├── SKILL.md~~

~~75│ ├── reference.md (optional)~~

~~76│ └── scripts/ (optional)~~

~~77└── code-reviewer/~~

~~78 └── SKILL.md~~

~~79```~~

~~81**Integration behavior**:~~

~~83* Plugin Skills are automatically discovered when the plugin is installed~~

~~84* Claude autonomously invokes Skills based on matching task context~~

~~85* Skills can include supporting files alongside SKILL.md~~

~~87For SKILL.md format and complete Skill authoring guidance, see:~~

~~89* [Use Skills in Claude Code](/en/skills)~~

~~90* [Agent Skills overview](https://docs.claude.com/en/docs/agents-and-tools/agent-skills/overview#skill-structure)~~

91 80

92### Hooks81### Hooks

93 82

117}106}

118```107```

119 108

120**Available events**:109Plugin hooks respond to the same lifecycle events as [user-defined hooks](/en/hooks):

~~121~~ 110

122* `PreToolUse`: Before Claude uses any tool111| Event | When it fires |

123* `PermissionRequest`: When a permission dialog is shown112| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |

124* `PostToolUse`: After Claude uses any tool113| `SessionStart` | When a session begins or resumes |

125* `UserPromptSubmit`: When user submits a prompt114| `UserPromptSubmit` | When you submit a prompt, before Claude processes it |

126* `Notification`: When Claude Code sends notifications115| `PreToolUse` | Before a tool call executes. Can block it |

127* `Stop`: When Claude attempts to stop116| `PermissionRequest` | When a permission dialog appears |

128* `SubagentStop`: When a subagent attempts to stop117| `PostToolUse` | After a tool call succeeds |

129* `SessionStart`: At the beginning of sessions118| `PostToolUseFailure` | After a tool call fails |

130* `SessionEnd`: At the end of sessions119| `Notification` | When Claude Code sends a notification |

131* `PreCompact`: Before conversation history is compacted120| `SubagentStart` | When a subagent is spawned |

121| `SubagentStop` | When a subagent finishes |

122| `Stop` | When Claude finishes responding |

123| `StopFailure` | When the turn ends due to an API error. Output and exit code are ignored |

124| `TeammateIdle` | When an [agent team](/en/agent-teams) teammate is about to go idle |

125| `TaskCompleted` | When a task is being marked as completed |

126| `InstructionsLoaded` | When a CLAUDE.md or `.claude/rules/*.md` file is loaded into context. Fires at session start and when files are lazily loaded during a session |

127| `ConfigChange` | When a configuration file changes during a session |

128| `CwdChanged` | When the working directory changes, for example when Claude executes a `cd` command. Useful for reactive environment management with tools like direnv |

129| `FileChanged` | When a watched file changes on disk. The `matcher` field specifies which filenames to watch |

130| `WorktreeCreate` | When a worktree is being created via `--worktree` or `isolation: "worktree"`. Replaces default git behavior |

131| `WorktreeRemove` | When a worktree is being removed, either at session exit or when a subagent finishes |

132| `PreCompact` | Before context compaction |

133| `PostCompact` | After context compaction completes |

134| `Elicitation` | When an MCP server requests user input during a tool call |

135| `ElicitationResult` | After a user responds to an MCP elicitation, before the response is sent back to the server |

136| `SessionEnd` | When a session terminates |

132 137

133**Hook types**:138**Hook types**:

134 139

135* `command`: Execute shell commands or scripts140* `command`: execute shell commands or scripts

136* `validation`: Validate file contents or project state141* `http`: send the event JSON as a POST request to a URL

137* `notification`: Send alerts or status updates142* `prompt`: evaluate a prompt with an LLM (uses `$ARGUMENTS` placeholder for context)

143* `agent`: run an agentic verifier with tools for complex verification tasks

138 144

139### MCP servers145### MCP servers

140 146

172* Server capabilities integrate seamlessly with Claude's existing tools178* Server capabilities integrate seamlessly with Claude's existing tools

173* Plugin servers can be configured independently of user MCP servers179* Plugin servers can be configured independently of user MCP servers

174 180

181### LSP servers

182

183<Tip>

184 Looking to use LSP plugins? Install them from the official marketplace: search for "lsp" in the `/plugin` Discover tab. This section documents how to create LSP plugins for languages not covered by the official marketplace.

185</Tip>

186

187Plugins can provide [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) (LSP) servers to give Claude real-time code intelligence while working on your codebase.

188

189LSP integration provides:

190

191* **Instant diagnostics**: Claude sees errors and warnings immediately after each edit

192* **Code navigation**: go to definition, find references, and hover information

193* **Language awareness**: type information and documentation for code symbols

194

195**Location**: `.lsp.json` in plugin root, or inline in `plugin.json`

196

197**Format**: JSON configuration mapping language server names to their configurations

198

199**`.lsp.json` file format**:

200

201```json theme={null}

202{

203 "go": {

204 "command": "gopls",

205 "args": ["serve"],

206 "extensionToLanguage": {

207 ".go": "go"

208 }

209 }

210}

211```

212

213**Inline in `plugin.json`**:

214

215```json theme={null}

216{

217 "name": "my-plugin",

218 "lspServers": {

219 "go": {

220 "command": "gopls",

221 "args": ["serve"],

222 "extensionToLanguage": {

223 ".go": "go"

224 }

225 }

226 }

227}

228```

229

230**Required fields:**

231

232| Field | Description |

233| :-------------------- | :------------------------------------------- |

234| `command` | The LSP binary to execute (must be in PATH) |

235| `extensionToLanguage` | Maps file extensions to language identifiers |

236

237**Optional fields:**

238

239| Field | Description |

240| :---------------------- | :-------------------------------------------------------- |

241| `args` | Command-line arguments for the LSP server |

242| `transport` | Communication transport: `stdio` (default) or `socket` |

243| `env` | Environment variables to set when starting the server |

244| `initializationOptions` | Options passed to the server during initialization |

245| `settings` | Settings passed via `workspace/didChangeConfiguration` |

246| `workspaceFolder` | Workspace folder path for the server |

247| `startupTimeout` | Max time to wait for server startup (milliseconds) |

248| `shutdownTimeout` | Max time to wait for graceful shutdown (milliseconds) |

249| `restartOnCrash` | Whether to automatically restart the server if it crashes |

250| `maxRestarts` | Maximum number of restart attempts before giving up |

251

252<Warning>

253 **You must install the language server binary separately.** LSP plugins configure how Claude Code connects to a language server, but they don't include the server itself. If you see `Executable not found in $PATH` in the `/plugin` Errors tab, install the required binary for your language.

254</Warning>

255

256**Available LSP plugins:**

257

258| Plugin | Language server | Install command |

259| :--------------- | :------------------------- | :----------------------------------------------------------------------------------------- |

260| `pyright-lsp` | Pyright (Python) | `pip install pyright` or `npm install -g pyright` |

261| `typescript-lsp` | TypeScript Language Server | `npm install -g typescript-language-server typescript` |

262| `rust-lsp` | rust-analyzer | [See rust-analyzer installation](https://rust-analyzer.github.io/manual.html#installation) |

263

264Install the language server first, then install the plugin from the marketplace.

265

266***

267

268## Plugin installation scopes

269

270When you install a plugin, you choose a **scope** that determines where the plugin is available and who else can use it:

271

272| Scope | Settings file | Use case |

273| :-------- | :---------------------------------------------- | :------------------------------------------------------- |

274| `user` | `~/.claude/settings.json` | Personal plugins available across all projects (default) |

275| `project` | `.claude/settings.json` | Team plugins shared via version control |

276| `local` | `.claude/settings.local.json` | Project-specific plugins, gitignored |

277| `managed` | [Managed settings](/en/settings#settings-files) | Managed plugins (read-only, update only) |

278

279Plugins use the same scope system as other Claude Code configurations. For installation instructions and scope flags, see [Install plugins](/en/discover-plugins#install-plugins). For a complete explanation of scopes, see [Configuration scopes](/en/settings#configuration-scopes).

280

175***281***

176 282

177## Plugin manifest schema283## Plugin manifest schema

178 284

179The `plugin.json` file defines your plugin's metadata and configuration. This section documents all supported fields and options.285The `.claude-plugin/plugin.json` file defines your plugin's metadata and configuration. This section documents all supported fields and options.

286

287The manifest is optional. If omitted, Claude Code auto-discovers components in [default locations](#file-locations-reference) and derives the plugin name from the directory name. Use a manifest when you need to provide metadata or custom component paths.

180 288

181### Complete schema289### Complete schema

182 290

196 "keywords": ["keyword1", "keyword2"],304 "keywords": ["keyword1", "keyword2"],

197 "commands": ["./custom/commands/special.md"],305 "commands": ["./custom/commands/special.md"],

198 "agents": "./custom/agents/",306 "agents": "./custom/agents/",

307 "skills": "./custom/skills/",

199 "hooks": "./config/hooks.json",308 "hooks": "./config/hooks.json",

200 "mcpServers": "./mcp-config.json"309 "mcpServers": "./mcp-config.json",

310 "outputStyles": "./styles/",

311 "lspServers": "./.lsp.json"

201}312}

202```313```

203 314

204### Required fields315### Required fields

205 316

317If you include a manifest, `name` is the only required field.

318

207| :----- | :----- | :---------------------------------------- | :------------------- |320| :----- | :----- | :---------------------------------------- | :------------------- |

209 322

323This name is used for namespacing components. For example, in the UI, the

324agent `agent-creator` for the plugin with name `plugin-dev` will appear as

325`plugin-dev:agent-creator`.

326

210### Metadata fields327### Metadata fields

211 328

213| :------------ | :----- | :---------------------------------- | :------------------------------------------------- |330| :------------ | :----- | :-------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |

216| `author` | object | Author information | `{"name": "Dev Team", "email": "dev@company.com"}` |333| `author` | object | Author information | `{"name": "Dev Team", "email": "dev@company.com"}` |

222### Component path fields339### Component path fields

223 340

225| :----------- | :------------- | :----------------------------------- | :------------------------------------- |342| :------------- | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------- |

352

353### User configuration

354

355The `userConfig` field declares values that Claude Code prompts the user for when the plugin is enabled. Use this instead of requiring users to hand-edit `settings.json`.

356

357```json theme={null}

358{

359 "userConfig": {

360 "api_endpoint": {

361 "description": "Your team's API endpoint",

362 "sensitive": false

363 },

364 "api_token": {

365 "description": "API authentication token",

366 "sensitive": true

367 }

368 }

369}

370```

371

372Keys must be valid identifiers. Each value is available for substitution as `${user_config.KEY}` in MCP and LSP server configs, hook commands, and (for non-sensitive values only) skill and agent content. Values are also exported to plugin subprocesses as `CLAUDE_PLUGIN_OPTION_<KEY>` environment variables.

373

374Non-sensitive values are stored in `settings.json` under `pluginConfigs[<plugin-id>].options`. Sensitive values go to the system keychain (or `~/.claude/.credentials.json` where the keychain is unavailable). Keychain storage is shared with OAuth tokens and has an approximately 2 KB total limit, so keep sensitive values small.

375

376### Channels

377

378The `channels` field lets a plugin declare one or more message channels that inject content into the conversation. Each channel binds to an MCP server that the plugin provides.

379

380```json theme={null}

381{

382 "channels": [

383 {

384 "server": "telegram",

385 "userConfig": {

386 "bot_token": { "description": "Telegram bot token", "sensitive": true },

387 "owner_id": { "description": "Your Telegram user ID", "sensitive": false }

388 }

389 }

390 ]

391}

392```

393

394The `server` field is required and must match a key in the plugin's `mcpServers`. The optional per-channel `userConfig` uses the same schema as the top-level field, letting the plugin prompt for bot tokens or owner IDs when the plugin is enabled.

230 395

231### Path behavior rules396### Path behavior rules

232 397

254 419

255### Environment variables420### Environment variables

256 421

257**`${CLAUDE_PLUGIN_ROOT}`**: Contains the absolute path to your plugin directory. Use this in hooks, MCP servers, and scripts to ensure correct paths regardless of installation location.422Claude Code provides two variables for referencing plugin paths. Both are substituted inline anywhere they appear in skill content, agent content, hook commands, and MCP or LSP server configs. Both are also exported as environment variables to hook processes and MCP or LSP server subprocesses.

423

424**`${CLAUDE_PLUGIN_ROOT}`**: the absolute path to your plugin's installation directory. Use this to reference scripts, binaries, and config files bundled with the plugin. This path changes when the plugin updates, so files you write here do not survive an update.

425

426**`${CLAUDE_PLUGIN_DATA}`**: a persistent directory for plugin state that survives updates. Use this for installed dependencies such as `node_modules` or Python virtual environments, generated code, caches, and any other files that should persist across plugin versions. The directory is created automatically the first time this variable is referenced.

258 427

259```json theme={null}428```json theme={null}

260{429{

273}442}

274```443```

275 444

445#### Persistent data directory

446

447The `${CLAUDE_PLUGIN_DATA}` directory resolves to `~/.claude/plugins/data/{id}/`, where `{id}` is the plugin identifier with characters outside `a-z`, `A-Z`, `0-9`, `_`, and `-` replaced by `-`. For a plugin installed as `formatter@my-marketplace`, the directory is `~/.claude/plugins/data/formatter-my-marketplace/`.

448

449A common use is installing language dependencies once and reusing them across sessions and plugin updates. Because the data directory outlives any single plugin version, a check for directory existence alone cannot detect when an update changes the plugin's dependency manifest. The recommended pattern compares the bundled manifest against a copy in the data directory and reinstalls when they differ.

450

451This `SessionStart` hook installs `node_modules` on the first run and again whenever a plugin update includes a changed `package.json`:

452

453```json theme={null}

454{

455 "hooks": {

456 "SessionStart": [

457 {

458 "hooks": [

459 {

460 "type": "command",

461 "command": "diff -q \"${CLAUDE_PLUGIN_ROOT}/package.json\" \"${CLAUDE_PLUGIN_DATA}/package.json\" >/dev/null 2>&1 || (cd \"${CLAUDE_PLUGIN_DATA}\" && cp \"${CLAUDE_PLUGIN_ROOT}/package.json\" . && npm install) || rm -f \"${CLAUDE_PLUGIN_DATA}/package.json\""

462 }

463 ]

464 }

465 ]

466 }

467}

468```

469

470The `diff` exits nonzero when the stored copy is missing or differs from the bundled one, covering both first run and dependency-changing updates. If `npm install` fails, the trailing `rm` removes the copied manifest so the next session retries.

471

472Scripts bundled in `${CLAUDE_PLUGIN_ROOT}` can then run against the persisted `node_modules`:

473

474```json theme={null}

475{

476 "mcpServers": {

477 "routines": {

478 "command": "node",

479 "args": ["${CLAUDE_PLUGIN_ROOT}/server.js"],

480 "env": {

481 "NODE_PATH": "${CLAUDE_PLUGIN_DATA}/node_modules"

482 }

483 }

484 }

485}

486```

487

488The data directory is deleted automatically when you uninstall the plugin from the last scope where it is installed. The `/plugin` interface shows the directory size and prompts before deleting. The CLI deletes by default; pass [`--keep-data`](#plugin-uninstall) to preserve it.

489

490***

491

492## Plugin caching and file resolution

493

494Plugins are specified in one of two ways:

495

496* Through `claude --plugin-dir`, for the duration of a session.

497* Through a marketplace, installed for future sessions.

498

499For security and verification purposes, Claude Code copies *marketplace* plugins to the user's local **plugin cache** (`~/.claude/plugins/cache`) rather than using them in-place. Understanding this behavior is important when developing plugins that reference external files.

500

501### Path traversal limitations

502

503Installed plugins cannot reference files outside their directory. Paths that traverse outside the plugin root (such as `../shared-utils`) will not work after installation because those external files are not copied to the cache.

504

505### Working with external dependencies

506

507If your plugin needs to access files outside its directory, you can create symbolic links to external files within your plugin directory. Symlinks are honored during the copy process:

508

509```bash theme={null}

510# Inside your plugin directory

511ln -s /path/to/shared-utils ./shared-utils

512```

513

514The symlinked content will be copied into the plugin cache. This provides flexibility while maintaining the security benefits of the caching system.

515

276***516***

277 517

278## Plugin directory structure518## Plugin directory structure

281 521

282A complete plugin follows this structure:522A complete plugin follows this structure:

283 523

284```524```text theme={null}

285enterprise-plugin/525enterprise-plugin/

286├── .claude-plugin/ # Metadata directory526├── .claude-plugin/ # Metadata directory (optional)

287│ └── plugin.json # Required: plugin manifest527│ └── plugin.json # plugin manifest

288├── commands/ # Default command location528├── commands/ # Default command location

289│ ├── status.md529│ ├── status.md

290│ └── logs.md530│ └── logs.md

301├── hooks/ # Hook configurations541├── hooks/ # Hook configurations

302│ ├── hooks.json # Main hook config542│ ├── hooks.json # Main hook config

303│ └── security-hooks.json # Additional hooks543│ └── security-hooks.json # Additional hooks

544├── settings.json # Default settings for the plugin

304├── .mcp.json # MCP server definitions545├── .mcp.json # MCP server definitions

546├── .lsp.json # LSP server configurations

305├── scripts/ # Hook and utility scripts547├── scripts/ # Hook and utility scripts

306│ ├── security-scan.sh548│ ├── security-scan.sh

307│ ├── format-code.py549│ ├── format-code.py

317### File locations reference559### File locations reference

318 560

320| :-------------- | :--------------------------- | :------------------------------- |562| :-------------- | :--------------------------- | :------------------------------------------------------------------------------------------------------------------------ |

569| **LSP servers** | `.lsp.json` | Language server configurations |

570| **Settings** | `settings.json` | Default configuration applied when the plugin is enabled. Only [`agent`](/en/sub-agents) settings are currently supported |

327 571

328***572***

329 573

330## Debugging and development tools574## CLI commands reference

331 575

332### Debugging commands576Claude Code provides CLI commands for non-interactive plugin management, useful for scripting and automation.

577

578### plugin install

579

580Install a plugin from available marketplaces.

581

582```bash theme={null}

583claude plugin install <plugin> [options]

584```

585

586**Arguments:**

587

588* `<plugin>`: Plugin name or `plugin-name@marketplace-name` for a specific marketplace

589

590**Options:**

591

592| Option | Description | Default |

593| :-------------------- | :------------------------------------------------ | :------ |

594| `-s, --scope <scope>` | Installation scope: `user`, `project`, or `local` | `user` |

595| `-h, --help` | Display help for command | |

596

597Scope determines which settings file the installed plugin is added to. For example, --scope project writes to `enabledPlugins` in .claude/settings.json, making the plugin available to everyone who clones the project repository.

598

599**Examples:**

600

601```bash theme={null}

602# Install to user scope (default)

603claude plugin install formatter@my-marketplace

604

605# Install to project scope (shared with team)

606claude plugin install formatter@my-marketplace --scope project

333 607

334Use `claude --debug` to see plugin loading details:608# Install to local scope (gitignored)

609claude plugin install formatter@my-marketplace --scope local

610```

611

612### plugin uninstall

613

614Remove an installed plugin.

615

616```bash theme={null}

617claude plugin uninstall <plugin> [options]

618```

619

620**Arguments:**

621

622* `<plugin>`: Plugin name or `plugin-name@marketplace-name`

623

624**Options:**

625

626| Option | Description | Default |

627| :-------------------- | :---------------------------------------------------------------------------- | :------ |

628| `-s, --scope <scope>` | Uninstall from scope: `user`, `project`, or `local` | `user` |

629| `--keep-data` | Preserve the plugin's [persistent data directory](#persistent-data-directory) | |

630| `-h, --help` | Display help for command | |

631

632**Aliases:** `remove`, `rm`

633

634By default, uninstalling from the last remaining scope also deletes the plugin's `${CLAUDE_PLUGIN_DATA}` directory. Use `--keep-data` to preserve it, for example when reinstalling after testing a new version.

635

636### plugin enable

637

638Enable a disabled plugin.

335 639

336```bash theme={null}640```bash theme={null}

337claude --debug641claude plugin enable <plugin> [options]

338```642```

339 643

644**Arguments:**

645

646* `<plugin>`: Plugin name or `plugin-name@marketplace-name`

647

648**Options:**

649

650| Option | Description | Default |

651| :-------------------- | :--------------------------------------------- | :------ |

652| `-s, --scope <scope>` | Scope to enable: `user`, `project`, or `local` | `user` |

653| `-h, --help` | Display help for command | |

654

655### plugin disable

656

657Disable a plugin without uninstalling it.

658

659```bash theme={null}

660claude plugin disable <plugin> [options]

661```

662

663**Arguments:**

664

665* `<plugin>`: Plugin name or `plugin-name@marketplace-name`

666

667**Options:**

668

669| Option | Description | Default |

670| :-------------------- | :---------------------------------------------- | :------ |

671| `-s, --scope <scope>` | Scope to disable: `user`, `project`, or `local` | `user` |

672| `-h, --help` | Display help for command | |

673

674### plugin update

675

676Update a plugin to the latest version.

677

678```bash theme={null}

679claude plugin update <plugin> [options]

680```

681

682**Arguments:**

683

684* `<plugin>`: Plugin name or `plugin-name@marketplace-name`

685

686**Options:**

687

688| Option | Description | Default |

689| :-------------------- | :-------------------------------------------------------- | :------ |

690| `-s, --scope <scope>` | Scope to update: `user`, `project`, `local`, or `managed` | `user` |

691| `-h, --help` | Display help for command | |

692

693***

694

695## Debugging and development tools

696

697### Debugging commands

698

699Use `claude --debug` (or `/debug` within the TUI) to see plugin loading details:

700

340This shows:701This shows:

341 702

342* Which plugins are being loaded703* Which plugins are being loaded

347### Common issues708### Common issues

348 709

350| :--------------------- | :------------------------------ | :--------------------------------------------------- |711| :---------------------------------- | :------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |

354| MCP server fails | Missing `${CLAUDE_PLUGIN_ROOT}` | Use variable for all plugin paths |715| MCP server fails | Missing `${CLAUDE_PLUGIN_ROOT}` | Use variable for all plugin paths |

717| LSP `Executable not found in $PATH` | Language server not installed | Install the binary (e.g., `npm install -g typescript-language-server typescript`) |

718

719### Example error messages

720

721**Manifest validation errors**:

722

723* `Invalid JSON syntax: Unexpected token } in JSON at position 142`: check for missing commas, extra commas, or unquoted strings

724* `Plugin has an invalid manifest file at .claude-plugin/plugin.json. Validation errors: name: Required`: a required field is missing

725* `Plugin has a corrupt manifest file at .claude-plugin/plugin.json. JSON parse error: ...`: JSON syntax error

726

727**Plugin loading errors**:

728

729* `Warning: No commands found in plugin my-plugin custom directory: ./cmds. Expected .md files or SKILL.md in subdirectories.`: command path exists but contains no valid command files

730* `Plugin directory not found at path: ./plugins/my-plugin. Check that the marketplace entry has the correct path.`: the `source` path in marketplace.json points to a non-existent directory

731* `Plugin my-plugin has conflicting manifests: both plugin.json and marketplace entry specify components.`: remove duplicate component definitions or remove `strict: false` in marketplace entry

732

733### Hook troubleshooting

734

735**Hook script not executing**:

736

7371. Check the script is executable: `chmod +x ./scripts/your-script.sh`

7382. Verify the shebang line: First line should be `#!/bin/bash` or `#!/usr/bin/env bash`

7393. Check the path uses `${CLAUDE_PLUGIN_ROOT}`: `"command": "${CLAUDE_PLUGIN_ROOT}/scripts/your-script.sh"`

7404. Test the script manually: `./scripts/your-script.sh`

741

742**Hook not triggering on expected events**:

743

7441. Verify the event name is correct (case-sensitive): `PostToolUse`, not `postToolUse`

7452. Check the matcher pattern matches your tools: `"matcher": "Write|Edit"` for file operations

7463. Confirm the hook type is valid: `command`, `http`, `prompt`, or `agent`

747

748### MCP server troubleshooting

749

750**Server not starting**:

751

7521. Check the command exists and is executable

7532. Verify all paths use `${CLAUDE_PLUGIN_ROOT}` variable

7543. Check the MCP server logs: `claude --debug` shows initialization errors

7554. Test the server manually outside of Claude Code

756

757**Server tools not appearing**:

758

7591. Ensure the server is properly configured in `.mcp.json` or `plugin.json`

7602. Verify the server implements the MCP protocol correctly

7613. Check for connection timeouts in debug output

762

763### Directory structure mistakes

764

765**Symptoms**: Plugin loads but components (commands, agents, hooks) are missing.

766

767**Correct structure**: Components must be at the plugin root, not inside `.claude-plugin/`. Only `plugin.json` belongs in `.claude-plugin/`.

768

769```text theme={null}

770my-plugin/

771├── .claude-plugin/

772│ └── plugin.json ← Only manifest here

773├── commands/ ← At root level

774├── agents/ ← At root level

775└── hooks/ ← At root level

776```

777

778If your components are inside `.claude-plugin/`, move them to the plugin root.

779

780**Debug checklist**:

781

7821. Run `claude --debug` and look for "loading plugin" messages

7832. Check that each component directory is listed in the debug output

7843. Verify file permissions allow reading the plugin files

356 785

357***786***

358 787

363Follow semantic versioning for plugin releases:792Follow semantic versioning for plugin releases:

364 793

365```json theme={null}794```json theme={null}

795{

796 "name": "my-plugin",

797 "version": "2.1.0"

798}

799```

800

801**Version format**: `MAJOR.MINOR.PATCH`

802

803* **MAJOR**: Breaking changes (incompatible API changes)

804* **MINOR**: New features (backward-compatible additions)

805* **PATCH**: Bug fixes (backward-compatible fixes)

806

807**Best practices**:

808

809* Start at `1.0.0` for your first stable release

810* Update the version in `plugin.json` before distributing changes

811* Document changes in a `CHANGELOG.md` file

812* Use pre-release versions like `2.0.0-beta.1` for testing

813

814<Warning>

815 Claude Code uses the version to determine whether to update your plugin. If you change your plugin's code but don't bump the version in `plugin.json`, your plugin's existing users won't see your changes due to caching.

816

817 If your plugin is within a [marketplace](/en/plugin-marketplaces) directory, you can manage the version through `marketplace.json` instead and omit the `version` field from `plugin.json`.

818</Warning>

819

820***

366 821

367## See also822## See also

368 823

369- [Plugins](/en/plugins) - Tutorials and practical usage824* [Plugins](/en/plugins) - Tutorials and practical usage

370- [Plugin marketplaces](/en/plugin-marketplaces) - Creating and managing marketplaces825* [Plugin marketplaces](/en/plugin-marketplaces) - Creating and managing marketplaces

371- [Slash commands](/en/slash-commands) - Command development details826* [Skills](/en/skills) - Skill development details

372- [Subagents](/en/sub-agents) - Agent configuration and capabilities827* [Subagents](/en/sub-agents) - Agent configuration and capabilities

373- [Agent Skills](/en/skills) - Extend Claude's capabilities828* [Hooks](/en/hooks) - Event handling and automation

374- [Hooks](/en/hooks) - Event handling and automation829* [MCP](/en/mcp) - External tool integration

375- [MCP](/en/mcp) - External tool integration830* [Settings](/en/settings) - Configuration options for plugins

376- [Settings](/en/settings) - Configuration options for plugins

377```

quickstart.md +108 −94

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Quickstart5# Quickstart

2 6

3> Welcome to Claude Code!7> Welcome to Claude Code!

4 8

~~5This quickstart guide will have you using AI-powered coding assistance in just a few minutes. By the end, you'll understand how to use Claude Code for common development tasks.~~9

11This quickstart guide will have you using AI-powered coding assistance in a few minutes. By the end, you'll understand how to use Claude Code for common development tasks.

13<Experiment flag="quickstart-install-configurator" treatment={<InstallConfigurator />} />

6 14

7## Before you begin15## Before you begin

8 16

9Make sure you have:17Make sure you have:

10 18

11* A terminal or command prompt open19* A terminal or command prompt open

20 * If you've never used the terminal before, check out the [terminal guide](/en/terminal-guide)

12* A code project to work with21* A code project to work with

~~13* A [Claude.ai](https://claude.ai) (recommended) or [Claude Console](https://console.anthropic.com/) account~~22* A [Claude subscription](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=quickstart_prereq) (Pro, Max, Teams, or Enterprise), [Claude Console](https://console.anthropic.com/) account, or access through a [supported cloud provider](/en/third-party-integrations)

24<Note>

25 This guide covers the terminal CLI. Claude Code is also available on the [web](https://claude.ai/code), as a [desktop app](/en/desktop), in [VS Code](/en/vs-code) and [JetBrains IDEs](/en/jetbrains), in [Slack](/en/slack), and in CI/CD with [GitHub Actions](/en/github-actions) and [GitLab](/en/gitlab-ci-cd). See [all interfaces](/en/overview#use-claude-code-everywhere).

26</Note>

14 27

15## Step 1: Install Claude Code28## Step 1: Install Claude Code

16 29

18 31

19<Tabs>32<Tabs>

20 <Tab title="Native Install (Recommended)">33 <Tab title="Native Install (Recommended)">

~~21 **Homebrew (macOS, Linux):**~~

~~23 ```sh theme={null}~~

~~24 brew install --cask claude-code~~

~~25 ```~~

27 **macOS, Linux, WSL:**34 **macOS, Linux, WSL:**

28 35

29 ```bash theme={null}36 ```bash theme={null}

41 ```batch theme={null}48 ```batch theme={null}

42 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd49 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

43 ```50 ```

52 **Windows requires [Git for Windows](https://git-scm.com/downloads/win).** Install it first if you don't have it.

54 <Info>

55 Native installations automatically update in the background to keep you on the latest version.

56 </Info>

44 </Tab>57 </Tab>

45 58

~~46 <Tab title="NPM">~~59 <Tab title="Homebrew">

~~47 If you have [Node.js 18 or newer installed](https://nodejs.org/en/download/):~~60 ```bash theme={null}

61 brew install --cask claude-code

62 ```

64 <Info>

65 Homebrew installations do not auto-update. Run `brew upgrade claude-code` periodically to get the latest features and security fixes.

66 </Info>

67 </Tab>

48 68

~~49 ```sh theme={null}~~69 <Tab title="WinGet">

~~50 npm install -g @anthropic-ai/claude-code~~70 ```powershell theme={null}

71 winget install Anthropic.ClaudeCode

51 ```72 ```

74 <Info>

75 WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.

76 </Info>

52 </Tab>77 </Tab>

53</Tabs>78</Tabs>

54 79

66# Follow the prompts to log in with your account91# Follow the prompts to log in with your account

67```92```

68 93

~~69You can log in using either account type:~~94You can log in using any of these account types:

~~71* [Claude.ai](https://claude.ai) (subscription plans - recommended)~~

~~72* [Claude Console](https://console.anthropic.com/) (API access with pre-paid credits)~~

73 95

~~74Once logged in, your credentials are stored and you won't need to log in again.~~96* [Claude Pro, Max, Teams, or Enterprise](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=quickstart_login) (recommended)

97* [Claude Console](https://console.anthropic.com/) (API access with pre-paid credits). On first login, a "Claude Code" workspace is automatically created in the Console for centralized cost tracking.

98* [Amazon Bedrock, Google Vertex AI, or Microsoft Foundry](/en/third-party-integrations) (enterprise cloud providers)

75 99

~~76<Note>~~100Once logged in, your credentials are stored and you won't need to log in again. To switch accounts later, use the `/login` command.

77 When you first authenticate Claude Code with your Claude Console account, a workspace called "Claude Code" is automatically created for you. This workspace provides centralized cost tracking and management for all Claude Code usage in your organization.

~~78</Note>~~

~~80<Note>~~

~~81 You can have both account types under the same email address. If you need to log in again or switch accounts, use the `/login` command within Claude Code.~~

~~82</Note>~~

83 101

84## Step 3: Start your first session102## Step 3: Start your first session

85 103

93You'll see the Claude Code welcome screen with your session information, recent conversations, and latest updates. Type `/help` for available commands or `/resume` to continue a previous conversation.111You'll see the Claude Code welcome screen with your session information, recent conversations, and latest updates. Type `/help` for available commands or `/resume` to continue a previous conversation.

94 112

95<Tip>113<Tip>

~~96 After logging in (Step 2), your credentials are stored on your system. Learn more in [Credential Management](/en/iam#credential-management).~~114 After logging in (Step 2), your credentials are stored on your system. Learn more in [Credential Management](/en/authentication#credential-management).

97</Tip>115</Tip>

98 116

99## Step 4: Ask your first question117## Step 4: Ask your first question

100 118

101Let's start with understanding your codebase. Try one of these commands:119Let's start with understanding your codebase. Try one of these commands:

102 120

103```121```text theme={null}

104> what does this project do?122what does this project do?

105```123```

106 124

107Claude will analyze your files and provide a summary. You can also ask more specific questions:125Claude will analyze your files and provide a summary. You can also ask more specific questions:

108 126

109```127```text theme={null}

110> what technologies does this project use?128what technologies does this project use?

111```129```

112 130

113```131```text theme={null}

114> where is the main entry point?132where is the main entry point?

115```133```

116 134

117```135```text theme={null}

118> explain the folder structure136explain the folder structure

119```137```

120 138

121You can also ask Claude about its own capabilities:139You can also ask Claude about its own capabilities:

122 140

123```141```text theme={null}

124> what can Claude Code do?142what can Claude Code do?

125```143```

126 144

127```145```text theme={null}

128> how do I use slash commands in Claude Code?146how do I create custom skills in Claude Code?

129```147```

130 148

131```149```text theme={null}

132> can Claude Code work with Docker?150can Claude Code work with Docker?

133```151```

134 152

135<Note>153<Note>

136 Claude Code reads your files as needed - you don't have to manually add context. Claude also has access to its own documentation and can answer questions about its features and capabilities.154 Claude Code reads your project files as needed. You don't have to manually add context.

137</Note>155</Note>

138 156

139## Step 5: Make your first code change157## Step 5: Make your first code change

140 158

141Now let's make Claude Code do some actual coding. Try a simple task:159Now let's make Claude Code do some actual coding. Try a simple task:

142 160

143```161```text theme={null}

144> add a hello world function to the main file162add a hello world function to the main file

145```163```

146 164

147Claude Code will:165Claude Code will:

159 177

160Claude Code makes Git operations conversational:178Claude Code makes Git operations conversational:

161 179

162```180```text theme={null}

163> what files have I changed?181what files have I changed?

164```182```

165 183

166```184```text theme={null}

167> commit my changes with a descriptive message185commit my changes with a descriptive message

168```186```

169 187

170You can also prompt for more complex Git operations:188You can also prompt for more complex Git operations:

171 189

172```190```text theme={null}

173> create a new branch called feature/quickstart191create a new branch called feature/quickstart

174```192```

175 193

176```194```text theme={null}

177> show me the last 5 commits195show me the last 5 commits

178```196```

179 197

180```198```text theme={null}

181> help me resolve merge conflicts199help me resolve merge conflicts

182```200```

183 201

184## Step 7: Fix a bug or add a feature202## Step 7: Fix a bug or add a feature

187 205

188Describe what you want in natural language:206Describe what you want in natural language:

189 207

190```208```text theme={null}

191> add input validation to the user registration form209add input validation to the user registration form

192```210```

193 211

194Or fix existing issues:212Or fix existing issues:

195 213

196```214```text theme={null}

197> there's a bug where users can submit empty forms - fix it215there's a bug where users can submit empty forms - fix it

198```216```

199 217

200Claude Code will:218Claude Code will:

210 228

211**Refactor code**229**Refactor code**

212 230

213```231```text theme={null}

214> refactor the authentication module to use async/await instead of callbacks232refactor the authentication module to use async/await instead of callbacks

215```233```

216 234

217**Write tests**235**Write tests**

218 236

219```237```text theme={null}

220> write unit tests for the calculator functions238write unit tests for the calculator functions

221```239```

222 240

223**Update documentation**241**Update documentation**

224 242

225```243```text theme={null}

226> update the README with installation instructions244update the README with installation instructions

227```245```

228 246

229**Code review**247**Code review**

230 248

231```249```text theme={null}

232> review my changes and suggest improvements250review my changes and suggest improvements

233```251```

234 252

235<Tip>253<Tip>

236 **Remember**: Claude Code is your AI pair programmer. Talk to it like you would a helpful colleague - describe what you want to achieve, and it will help you get there.254 Talk to Claude like you would a helpful colleague. Describe what you want to achieve, and it will help you get there.

237</Tip>255</Tip>

238 256

239## Essential commands257## Essential commands

241Here are the most important commands for daily use:259Here are the most important commands for daily use:

242 260

244| ------------------- | --------------------------------- | ----------------------------------- |262| ------------------- | ------------------------------------------------------ | ----------------------------------- |

254 272

255See the [CLI reference](/en/cli-reference) for a complete list of commands.273See the [CLI reference](/en/cli-reference) for a complete list of commands.

256 274

257## Pro tips for beginners275## Pro tips for beginners

258 276

277For more, see [best practices](/en/best-practices) and [common workflows](/en/common-workflows).

278

259<AccordionGroup>279<AccordionGroup>

260 <Accordion title="Be specific with your requests">280 <Accordion title="Be specific with your requests">

261 Instead of: "fix the bug"281 Instead of: "fix the bug"

266 <Accordion title="Use step-by-step instructions">286 <Accordion title="Use step-by-step instructions">

267 Break complex tasks into steps:287 Break complex tasks into steps:

268 288

269 ```289 ```text theme={null}

270 > 1. create a new database table for user profiles290 1. create a new database table for user profiles

271 ```291 2. create an API endpoint to get and update user profiles

~~272~~ 292 3. build a webpage that allows users to see and edit their information

273 ```

274 > 2. create an API endpoint to get and update user profiles

275 ```

~~276~~

277 ```

278 > 3. build a webpage that allows users to see and edit their information

279 ```293 ```

280 </Accordion>294 </Accordion>

281 295

282 <Accordion title="Let Claude explore first">296 <Accordion title="Let Claude explore first">

283 Before making changes, let Claude understand your code:297 Before making changes, let Claude understand your code:

284 298

285 ```299 ```text theme={null}

286 > analyze the database schema300 analyze the database schema

287 ```301 ```

288 302

289 ```303 ```text theme={null}

290 > build a dashboard showing products that are most frequently returned by our UK customers304 build a dashboard showing products that are most frequently returned by our UK customers

291 ```305 ```

292 </Accordion>306 </Accordion>

293 307

295 * Press `?` to see all available keyboard shortcuts309 * Press `?` to see all available keyboard shortcuts

296 * Use Tab for command completion310 * Use Tab for command completion

297 * Press ↑ for command history311 * Press ↑ for command history

298 * Type `/` to see all slash commands312 * Type `/` to see all commands and skills

299 </Accordion>313 </Accordion>

300</AccordionGroup>314</AccordionGroup>

301 315

303 317

304Now that you've learned the basics, explore more advanced features:318Now that you've learned the basics, explore more advanced features:

305 319

306<CardGroup cols={3}>320<CardGroup cols={2}>

307 <Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">321 <Card title="How Claude Code works" icon="microchip" href="/en/how-claude-code-works">

308 Step-by-step guides for common tasks322 Understand the agentic loop, built-in tools, and how Claude Code interacts with your project

309 </Card>323 </Card>

310 324

311 <Card title="CLI reference" icon="terminal" href="/en/cli-reference">325 <Card title="Best practices" icon="star" href="/en/best-practices">

312 Master all commands and options326 Get better results with effective prompting and project setup

313 </Card>327 </Card>

314 328

315 <Card title="Configuration" icon="gear" href="/en/settings">329 <Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">

316 Customize Claude Code for your workflow330 Step-by-step guides for common tasks

317 </Card>331 </Card>

318 332

319 <Card title="Claude Code on the web" icon="cloud" href="/en/claude-code-on-the-web">333 <Card title="Extend Claude Code" icon="puzzle-piece" href="/en/features-overview">

320 Run tasks asynchronously in the cloud334 Customize with CLAUDE.md, skills, hooks, MCP, and more

321 </Card>335 </Card>

322</CardGroup>336</CardGroup>

323 337

remote-control.md +191 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Continue local sessions from any device with Remote Control

7> Continue a local Claude Code session from your phone, tablet, or any browser using Remote Control. Works with claude.ai/code and the Claude mobile app.

9<Note>

10 Remote Control is available on all plans. On Team and Enterprise, it is off by default until an admin enables the Remote Control toggle in [Claude Code admin settings](https://claude.ai/admin-settings/claude-code).

11</Note>

13Remote Control connects [claude.ai/code](https://claude.ai/code) or the Claude app for [iOS](https://apps.apple.com/us/app/claude-by-anthropic/id6473753684) and [Android](https://play.google.com/store/apps/details?id=com.anthropic.claude) to a Claude Code session running on your machine. Start a task at your desk, then pick it up from your phone on the couch or a browser on another computer.

15When you start a Remote Control session on your machine, Claude keeps running locally the entire time, so nothing moves to the cloud. With Remote Control you can:

17* **Use your full local environment remotely**: your filesystem, [MCP servers](/en/mcp), tools, and project configuration all stay available

18* **Work from both surfaces at once**: the conversation stays in sync across all connected devices, so you can send messages from your terminal, browser, and phone interchangeably

19* **Survive interruptions**: if your laptop sleeps or your network drops, the session reconnects automatically when your machine comes back online

21Unlike [Claude Code on the web](/en/claude-code-on-the-web), which runs on cloud infrastructure, Remote Control sessions run directly on your machine and interact with your local filesystem. The web and mobile interfaces are just a window into that local session.

23<Note>

24 Remote Control requires Claude Code v2.1.51 or later. Check your version with `claude --version`.

25</Note>

27This page covers setup, how to start and connect to sessions, and how Remote Control compares to Claude Code on the web.

29## Requirements

31Before using Remote Control, confirm that your environment meets these conditions:

33* **Subscription**: available on Pro, Max, Team, and Enterprise plans. API keys are not supported. On Team and Enterprise, an admin must first enable the Remote Control toggle in [Claude Code admin settings](https://claude.ai/admin-settings/claude-code).

34* **Authentication**: run `claude` and use `/login` to sign in through claude.ai if you haven't already.

35* **Workspace trust**: run `claude` in your project directory at least once to accept the workspace trust dialog.

37## Start a Remote Control session

39You can start a dedicated Remote Control server, start an interactive session with Remote Control enabled, or connect a session that's already running.

41<Tabs>

42 <Tab title="Server mode">

43 Navigate to your project directory and run:

45 ```bash theme={null}

46 claude remote-control

47 ```

49 The process stays running in your terminal in server mode, waiting for remote connections. It displays a session URL you can use to [connect from another device](#connect-from-another-device), and you can press spacebar to show a QR code for quick access from your phone. While a remote session is active, the terminal shows connection status and tool activity.

51 Available flags:

53 | Flag | Description |

54 | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

55 | `--name "My Project"` | Set a custom session title visible in the session list at claude.ai/code. |

56 | `--spawn <mode>` | How concurrent sessions are created. Press `w` at runtime to toggle.<br />• `same-dir` (default): all sessions share the current working directory, so they can conflict if editing the same files.<br />• `worktree`: each on-demand session gets its own [git worktree](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees). Requires a git repository. |

57 | `--capacity <N>` | Maximum number of concurrent sessions. Default is 32. |

58 | `--verbose` | Show detailed connection and session logs. |

59 | `--sandbox` / `--no-sandbox` | Enable or disable [sandboxing](/en/sandboxing) for filesystem and network isolation. Off by default. |

60 </Tab>

62 <Tab title="Interactive session">

63 To start a normal interactive Claude Code session with Remote Control enabled, use the `--remote-control` flag (or `--rc`):

65 ```bash theme={null}

66 claude --remote-control

67 ```

69 Optionally pass a name for the session:

71 ```bash theme={null}

72 claude --remote-control "My Project"

73 ```

75 This gives you a full interactive session in your terminal that you can also control from claude.ai or the Claude app. Unlike `claude remote-control` (server mode), you can type messages locally while the session is also available remotely.

76 </Tab>

78 <Tab title="From an existing session">

79 If you're already in a Claude Code session and want to continue it remotely, use the `/remote-control` (or `/rc`) command:

81 ```text theme={null}

82 /remote-control

83 ```

85 Pass a name as an argument to set a custom session title:

87 ```text theme={null}

88 /remote-control My Project

89 ```

91 This starts a Remote Control session that carries over your current conversation history and displays a session URL and QR code you can use to [connect from another device](#connect-from-another-device). The `--verbose`, `--sandbox`, and `--no-sandbox` flags are not available with this command.

92 </Tab>

93</Tabs>

95### Connect from another device

97Once a Remote Control session is active, you have a few ways to connect from another device:

99* **Open the session URL** in any browser to go directly to the session on [claude.ai/code](https://claude.ai/code). Both `claude remote-control` and `/remote-control` display this URL in the terminal.

100* **Scan the QR code** shown alongside the session URL to open it directly in the Claude app. With `claude remote-control`, press spacebar to toggle the QR code display.

101* **Open [claude.ai/code](https://claude.ai/code) or the Claude app** and find the session by name in the session list. Remote Control sessions show a computer icon with a green status dot when online.

102

103The remote session title is chosen in this order:

104

1051. The name you passed to `--name`, `--remote-control`, or `/remote-control`

1062. The title you set with `/rename`

1073. The last meaningful message in existing conversation history

1084. Your first prompt once you send one

109

110If the environment already has an active session, you'll be asked whether to continue it or start a new one.

111

112If you don't have the Claude app yet, use the `/mobile` command inside Claude Code to display a download QR code for [iOS](https://apps.apple.com/us/app/claude-by-anthropic/id6473753684) or [Android](https://play.google.com/store/apps/details?id=com.anthropic.claude).

113

114### Enable Remote Control for all sessions

115

116By default, Remote Control only activates when you explicitly run `claude remote-control`, `claude --remote-control`, or `/remote-control`. To enable it automatically for every interactive session, run `/config` inside Claude Code and set **Enable Remote Control for all sessions** to `true`. Set it back to `false` to disable.

117

118With this setting on, each interactive Claude Code process registers one remote session. If you run multiple instances, each one gets its own environment and session. To run multiple concurrent sessions from a single process, use server mode with `--spawn` instead.

119

120## Connection and security

121

122Your local Claude Code session makes outbound HTTPS requests only and never opens inbound ports on your machine. When you start Remote Control, it registers with the Anthropic API and polls for work. When you connect from another device, the server routes messages between the web or mobile client and your local session over a streaming connection.

123

124All traffic travels through the Anthropic API over TLS, the same transport security as any Claude Code session. The connection uses multiple short-lived credentials, each scoped to a single purpose and expiring independently.

125

126## Remote Control vs Claude Code on the web

127

128Remote Control and [Claude Code on the web](/en/claude-code-on-the-web) both use the claude.ai/code interface. The key difference is where the session runs: Remote Control executes on your machine, so your local MCP servers, tools, and project configuration stay available. Claude Code on the web executes in Anthropic-managed cloud infrastructure.

129

130Use Remote Control when you're in the middle of local work and want to keep going from another device. Use Claude Code on the web when you want to kick off a task without any local setup, work on a repo you don't have cloned, or run multiple tasks in parallel.

131

132## Limitations

133

134* **One remote session per interactive process**: outside of server mode, each Claude Code instance supports one remote session at a time. Use server mode with `--spawn` to run multiple concurrent sessions from a single process.

135* **Terminal must stay open**: Remote Control runs as a local process. If you close the terminal or stop the `claude` process, the session ends. Run `claude remote-control` again to start a new one.

136* **Extended network outage**: if your machine is awake but unable to reach the network for more than roughly 10 minutes, the session times out and the process exits. Run `claude remote-control` again to start a new session.

137

138## Troubleshooting

139

140### "Remote Control is not yet enabled for your account"

141

142The eligibility check can fail with certain environment variables present:

143

144* `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` or `DISABLE_TELEMETRY`: unset them and try again.

145* `CLAUDE_CODE_USE_BEDROCK`, `CLAUDE_CODE_USE_VERTEX`, or `CLAUDE_CODE_USE_FOUNDRY`: Remote Control requires claude.ai authentication and does not work with third-party providers.

146

147If none of these are set, run `/logout` then `/login` to refresh.

148

149### "Remote Control is disabled by your organization's policy"

150

151This error has three distinct causes. Run `/status` first to see which login method and subscription you're using.

152

153* **You're authenticated with an API key or Console account**: Remote Control requires claude.ai OAuth. Run `/login` and choose the claude.ai option. If `ANTHROPIC_API_KEY` is set in your environment, unset it.

154* **Your Team or Enterprise admin hasn't enabled it**: Remote Control is off by default on these plans. An admin can enable it at [claude.ai/admin-settings/claude-code](https://claude.ai/admin-settings/claude-code) by turning on the **Remote Control** toggle. This is a server-side organization setting, not a [managed settings](/en/permissions#managed-only-settings) key.

155* **The admin toggle is grayed out**: your organization has a data retention or compliance configuration that is incompatible with Remote Control. This cannot be changed from the admin panel. Contact Anthropic support to discuss options.

156

157### "Remote credentials fetch failed"

158

159Claude Code could not obtain a short-lived credential from the Anthropic API to establish the connection. Re-run with `--verbose` to see the full error:

160

161```bash theme={null}

162claude remote-control --verbose

163```

164

165Common causes:

166

167* Not signed in: run `claude` and use `/login` to authenticate with your claude.ai account. API key authentication is not supported for Remote Control.

168* Network or proxy issue: a firewall or proxy may be blocking the outbound HTTPS request. Remote Control requires access to the Anthropic API on port 443.

169* Session creation failed: if you also see `Session creation failed — see debug log`, the failure happened earlier in setup. Check that your subscription is active.

170

171## Choose the right approach

172

173Claude Code offers several ways to work when you're not at your terminal. They differ in what triggers the work, where Claude runs, and how much you need to set up.

174

176| :--------------------------------------------- | :--------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |

182

183## Related resources

184

185* [Claude Code on the web](/en/claude-code-on-the-web): run sessions in Anthropic-managed cloud environments instead of on your machine

186* [Channels](/en/channels): forward Telegram, Discord, or iMessage into a session so Claude reacts to messages while you're away

187* [Dispatch](/en/desktop#sessions-from-dispatch): message a task from your phone and it can spawn a Desktop session to handle it

188* [Authentication](/en/authentication): set up `/login` and manage credentials for claude.ai

189* [CLI reference](/en/cli-reference): full list of flags and commands including `claude remote-control`

190* [Security](/en/security): how Remote Control sessions fit into the Claude Code security model

191* [Data usage](/en/data-usage): what data flows through the Anthropic API during local and remote sessions

sandboxing.md +131 −12

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Sandboxing5# Sandboxing

2 6

3> Learn how Claude Code's sandboxed bash tool provides filesystem and network isolation for safer, more autonomous agent execution.7> Learn how Claude Code's sandboxed bash tool provides filesystem and network isolation for safer, more autonomous agent execution.

38* **Blocked access**: Cannot modify files outside the current working directory without explicit permission42* **Blocked access**: Cannot modify files outside the current working directory without explicit permission

39* **Configurable**: Define custom allowed and denied paths through settings43* **Configurable**: Define custom allowed and denied paths through settings

40 44

45You can grant write access to additional paths using `sandbox.filesystem.allowWrite` in your settings. These restrictions are enforced at the OS level (Seatbelt on macOS, bubblewrap on Linux), so they apply to all subprocess commands, including tools like `kubectl`, `terraform`, and `npm`, not just Claude's file tools.

41### Network isolation47### Network isolation

42 48

43Network access is controlled through a proxy server running outside the sandbox:49Network access is controlled through a proxy server running outside the sandbox:

44 50

45* **Domain restrictions**: Only approved domains can be accessed51* **Domain restrictions**: Only approved domains can be accessed

~~46* **User confirmation**: New domain requests trigger permission prompts~~52* **User confirmation**: New domain requests trigger permission prompts (unless [`allowManagedDomainsOnly`](/en/settings#sandbox-settings) is enabled, which blocks non-allowed domains automatically)

47* **Custom proxy support**: Advanced users can implement custom rules on outgoing traffic53* **Custom proxy support**: Advanced users can implement custom rules on outgoing traffic

48* **Comprehensive coverage**: Restrictions apply to all scripts, programs, and subprocesses spawned by commands54* **Comprehensive coverage**: Restrictions apply to all scripts, programs, and subprocesses spawned by commands

49 55

51 57

52The sandboxed bash tool leverages operating system security primitives:58The sandboxed bash tool leverages operating system security primitives:

53 59

~~54* **Linux**: Uses [bubblewrap](https://github.com/containers/bubblewrap) for isolation~~

55* **macOS**: Uses Seatbelt for sandbox enforcement60* **macOS**: Uses Seatbelt for sandbox enforcement

61* **Linux**: Uses [bubblewrap](https://github.com/containers/bubblewrap) for isolation

62* **WSL2**: Uses bubblewrap, same as Linux

64WSL1 is not supported because bubblewrap requires kernel features only available in WSL2.

56 65

57These OS-level restrictions ensure that all child processes spawned by Claude Code's commands inherit the same security boundaries.66These OS-level restrictions ensure that all child processes spawned by Claude Code's commands inherit the same security boundaries.

58 67

59## Getting started68## Getting started

60 69

70### Prerequisites

72On **macOS**, sandboxing works out of the box using the built-in Seatbelt framework.

74On **Linux and WSL2**, install the required packages first:

76<Tabs>

77 <Tab title="Ubuntu/Debian">

78 ```bash theme={null}

79 sudo apt-get install bubblewrap socat

80 ```

81 </Tab>

83 <Tab title="Fedora">

84 ```bash theme={null}

85 sudo dnf install bubblewrap socat

86 ```

87 </Tab>

88</Tabs>

61### Enable sandboxing90### Enable sandboxing

62 91

~~63You can enable sandboxing by running the `/sandbox` slash command:~~92You can enable sandboxing by running the `/sandbox` command:

64 93

94```text theme={null}

95/sandbox

65```96```

~~66> /sandbox~~

~~67```~~

68 97

~~69This activates the sandboxed bash tool with default settings, allowing access to your current working directory while blocking access to sensitive system locations.~~98This opens a menu where you can choose between sandbox modes. If required dependencies are missing (such as `bubblewrap` or `socat` on Linux), the menu displays installation instructions for your platform.

100By default, if the sandbox cannot start (missing dependencies, unsupported platform, or platform restrictions), Claude Code shows a warning and runs commands without sandboxing. To make this a hard failure instead, set [`sandbox.failIfUnavailable`](/en/settings#sandbox-settings) to `true`. This is intended for managed deployments that require sandboxing as a security gate.

101

102### Sandbox modes

103

104Claude Code offers two sandbox modes:

105

106**Auto-allow mode**: Bash commands will attempt to run inside the sandbox and are automatically allowed without requiring permission. Commands that cannot be sandboxed (such as those needing network access to non-allowed hosts) fall back to the regular permission flow. Explicit ask/deny rules you've configured are always respected.

107

108**Regular permissions mode**: All bash commands go through the standard permission flow, even when sandboxed. This provides more control but requires more approvals.

109

110In both modes, the sandbox enforces the same filesystem and network restrictions. The difference is only in whether sandboxed commands are auto-approved or require explicit permission.

111

112<Info>

113 Auto-allow mode works independently of your permission mode setting. Even if you're not in "accept edits" mode, sandboxed bash commands will run automatically when auto-allow is enabled. This means bash commands that modify files within the sandbox boundaries will execute without prompting, even when file edit tools would normally require approval.

114</Info>

70 115

71### Configure sandboxing116### Configure sandboxing

72 117

73Customize sandbox behavior through your `settings.json` file. See [Settings](/en/settings#sandbox-settings) for complete configuration reference.118Customize sandbox behavior through your `settings.json` file. See [Settings](/en/settings#sandbox-settings) for complete configuration reference.

74 119

120#### Granting subprocess write access to specific paths

121

122By default, sandboxed commands can only write to the current working directory. If subprocess commands like `kubectl`, `terraform`, or `npm` need to write outside the project directory, use `sandbox.filesystem.allowWrite` to grant access to specific paths:

123

124```json theme={null}

125{

126 "sandbox": {

127 "enabled": true,

128 "filesystem": {

129 "allowWrite": ["~/.kube", "/tmp/build"]

130 }

131 }

132}

133```

134

135These paths are enforced at the OS level, so all commands running inside the sandbox, including their child processes, respect them. This is the recommended approach when a tool needs write access to a specific location, rather than excluding the tool from the sandbox entirely with `excludedCommands`.

136

137When `allowWrite` (or `denyWrite`/`denyRead`/`allowRead`) is defined in multiple [settings scopes](/en/settings#settings-precedence), the arrays are **merged**, meaning paths from every scope are combined, not replaced. For example, if managed settings allow writes to `/opt/company-tools` and a user adds `~/.kube` in their personal settings, both paths are included in the final sandbox configuration. This means users and projects can extend the list without duplicating or overriding paths set by higher-priority scopes.

138

139Path prefixes control how paths are resolved:

140

141| Prefix | Meaning | Example |

142| :---------------- | :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------ |

143| `/` | Absolute path from filesystem root | `/tmp/build` stays `/tmp/build` |

144| `~/` | Relative to home directory | `~/.kube` becomes `$HOME/.kube` |

145| `./` or no prefix | Relative to the project root for project settings, or to `~/.claude` for user settings | `./output` in `.claude/settings.json` resolves to `<project-root>/output` |

146

147The older `//path` prefix for absolute paths still works. If you previously used single-slash `/path` expecting project-relative resolution, switch to `./path`. This syntax differs from [Read and Edit permission rules](/en/permissions#read-and-edit), which use `//path` for absolute and `/path` for project-relative. Sandbox filesystem paths use standard conventions: `/tmp/build` is an absolute path.

148

149You can also deny write or read access using `sandbox.filesystem.denyWrite` and `sandbox.filesystem.denyRead`. These are merged with any paths from `Edit(...)` and `Read(...)` permission rules. To re-allow reading specific paths within a denied region, use `sandbox.filesystem.allowRead`, which takes precedence over `denyRead`. When `allowManagedReadPathsOnly` is enabled in managed settings, only managed `allowRead` entries are respected; user, project, and local `allowRead` entries are ignored.

150

151For example, to block reading from the entire home directory while still allowing reads from the current project, add this to your project's `.claude/settings.json`:

152

153```json theme={null}

154{

155 "sandbox": {

156 "enabled": true,

157 "filesystem": {

158 "denyRead": ["~/"],

159 "allowRead": ["."]

160 }

161 }

162}

163```

164

165The `.` in `allowRead` resolves to the project root because this configuration lives in project settings. If you placed the same configuration in `~/.claude/settings.json`, `.` would resolve to `~/.claude` instead, and project files would remain blocked by the `denyRead` rule.

166

75<Tip>167<Tip>

76 Not all commands are compatible with sandboxing out of the box. Some notes that may help you make the most out of the sandbox:168 Not all commands are compatible with sandboxing out of the box. Some notes that may help you make the most out of the sandbox:

77 169

96 188

97* Cannot modify critical config files such as `~/.bashrc`189* Cannot modify critical config files such as `~/.bashrc`

98* Cannot modify system-level files in `/bin/`190* Cannot modify system-level files in `/bin/`

~~99* Cannot read files that are denied in your [Claude permission settings](/en/iam#configuring-permissions)~~191* Cannot read files that are denied in your [Claude permission settings](/en/permissions#manage-permissions)

100 192

101**Network protection:**193**Network protection:**

102 194

141 233

142* Privilege Escalation via Unix Sockets: The `allowUnixSockets` configuration can inadvertently grant access to powerful system services that could lead to sandbox bypasses. For example, if it is used to allow access to `/var/run/docker.sock` this would effectively grant access to the host system through exploiting the docker socket. Users are encouraged to carefully consider any unix sockets that they allow through the sandbox.234* Privilege Escalation via Unix Sockets: The `allowUnixSockets` configuration can inadvertently grant access to powerful system services that could lead to sandbox bypasses. For example, if it is used to allow access to `/var/run/docker.sock` this would effectively grant access to the host system through exploiting the docker socket. Users are encouraged to carefully consider any unix sockets that they allow through the sandbox.

143* Filesystem Permission Escalation: Overly broad filesystem write permissions can enable privilege escalation attacks. Allowing writes to directories containing executables in `$PATH`, system configuration directories, or user shell configuration files (`.bashrc`, `.zshrc`) can lead to code execution in different security contexts when other users or system processes access these files.235* Filesystem Permission Escalation: Overly broad filesystem write permissions can enable privilege escalation attacks. Allowing writes to directories containing executables in `$PATH`, system configuration directories, or user shell configuration files (`.bashrc`, `.zshrc`) can lead to code execution in different security contexts when other users or system processes access these files.

144* Linux Sandbox Strength: The Linux implementation provides strong filesystem and network isolation but includes an `enableWeakerNestedSandbox` mode that enables it to work inside of Docker environments without privileged namespaces. This option considerably weakens security and should only be used incases where additional isolation is otherwise enforced.236* Linux Sandbox Strength: The Linux implementation provides strong filesystem and network isolation but includes an `enableWeakerNestedSandbox` mode that enables it to work inside of Docker environments without privileged namespaces. This option considerably weakens security and should only be used in cases where additional isolation is otherwise enforced.

237

238## How sandboxing relates to permissions

239

240Sandboxing and [permissions](/en/permissions) are complementary security layers that work together:

241

242* **Permissions** control which tools Claude Code can use and are evaluated before any tool runs. They apply to all tools: Bash, Read, Edit, WebFetch, MCP, and others.

243* **Sandboxing** provides OS-level enforcement that restricts what Bash commands can access at the filesystem and network level. It applies only to Bash commands and their child processes.

244

245Filesystem and network restrictions are configured through both sandbox settings and permission rules:

246

247* Use `sandbox.filesystem.allowWrite` to grant subprocess write access to paths outside the working directory

248* Use `sandbox.filesystem.denyWrite` and `sandbox.filesystem.denyRead` to block subprocess access to specific paths

249* Use `sandbox.filesystem.allowRead` to re-allow reading specific paths within a `denyRead` region

250* Use `Read` and `Edit` deny rules to block access to specific files or directories

251* Use `WebFetch` allow/deny rules to control domain access

252* Use sandbox `allowedDomains` to control which domains Bash commands can reach

253

254Paths from both `sandbox.filesystem` settings and permission rules are merged together into the final sandbox configuration.

255

256This [repository](https://github.com/anthropics/claude-code/tree/main/examples/settings) includes starter settings configurations for common deployment scenarios, including sandbox-specific examples. Use these as starting points and adjust them to fit your needs.

145 257

146## Advanced usage258## Advanced usage

147 259

169 281

170The sandboxed bash tool works alongside:282The sandboxed bash tool works alongside:

171 283

172* **IAM policies**: Combine with [permission settings](/en/iam) for defense-in-depth284* **Permission rules**: Combine with [permission settings](/en/permissions) for defense-in-depth

173* **Development containers**: Use with [devcontainers](/en/devcontainer) for additional isolation285* **Development containers**: Use with [devcontainers](/en/devcontainer) for additional isolation

174* **Enterprise policies**: Enforce sandbox configurations through [managed settings](/en/settings#settings-precedence)286* **Enterprise policies**: Enforce sandbox configurations through [managed settings](/en/settings#settings-precedence)

175 287

195 307

196* **Performance overhead**: Minimal, but some filesystem operations may be slightly slower308* **Performance overhead**: Minimal, but some filesystem operations may be slightly slower

197* **Compatibility**: Some tools that require specific system access patterns may need configuration adjustments, or may even need to be run outside of the sandbox309* **Compatibility**: Some tools that require specific system access patterns may need configuration adjustments, or may even need to be run outside of the sandbox

198* **Platform support**: Currently supports Linux and macOS; Windows support planned310* **Platform support**: Supports macOS, Linux, and WSL2. WSL1 is not supported. Native Windows support is planned.

311

312## What sandboxing does not cover

313

314The sandbox isolates Bash subprocesses. Other tools operate under different boundaries:

315

316* **Built-in file tools**: Read, Edit, and Write use the permission system directly rather than running through the sandbox. See [permissions](/en/permissions).

317* **Computer use on Desktop**: when Claude opens apps and controls your screen on macOS, it runs on your actual desktop rather than in an isolated environment. Per-app permission prompts gate each application. See [computer use](/en/desktop#let-claude-use-your-computer).

199 318

200## See also319## See also

201 320

202* [Security](/en/security) - Comprehensive security features and best practices321* [Security](/en/security) - Comprehensive security features and best practices

203* [IAM](/en/iam) - Permission configuration and access control322* [Permissions](/en/permissions) - Permission configuration and access control

204* [Settings](/en/settings) - Complete configuration reference323* [Settings](/en/settings) - Complete configuration reference

205* [CLI reference](/en/cli-reference) - Command-line options including `-sb`324* [CLI reference](/en/cli-reference) - Command-line options

scheduled-tasks.md +157 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Run prompts on a schedule

7> Use /loop and the cron scheduling tools to run prompts repeatedly, poll for status, or set one-time reminders within a Claude Code session.

9<Note>

10 Scheduled tasks require Claude Code v2.1.72 or later. Check your version with `claude --version`.

11</Note>

13Scheduled tasks let Claude re-run a prompt automatically on an interval. Use them to poll a deployment, babysit a PR, check back on a long-running build, or remind yourself to do something later in the session. To react to events as they happen instead of polling, see [Channels](/en/channels): your CI can push the failure into the session directly.

15Tasks are session-scoped: they live in the current Claude Code process and are gone when you exit. For durable scheduling that survives restarts, use [Cloud](/en/web-scheduled-tasks) or [Desktop](/en/desktop#schedule-recurring-tasks) scheduled tasks, or [GitHub Actions](/en/github-actions).

17## Compare scheduling options

19Claude Code offers three ways to schedule recurring work:

22| :------------------------- | :------------------------------- | :---------------------------------------------- | :----------------------------- |

24| Requires machine on | No | Yes | Yes |

25| Requires open session | No | No | Yes |

26| Persistent across restarts | Yes | Yes | No (session-scoped) |

27| Access to local files | No (fresh clone) | Yes | Yes |

30| Customizable schedule | Via `/schedule` in the CLI | Yes | Yes |

33<Tip>

34 Use **cloud tasks** for work that should run reliably without your machine. Use **Desktop tasks** when you need access to local files and tools. Use **`/loop`** for quick polling during a session.

35</Tip>

37## Schedule a recurring prompt with /loop

39The `/loop` [bundled skill](/en/skills#bundled-skills) is the quickest way to schedule a recurring prompt. Pass an optional interval and a prompt, and Claude sets up a cron job that fires in the background while the session stays open.

41```text theme={null}

42/loop 5m check if the deployment finished and tell me what happened

43```

45Claude parses the interval, converts it to a cron expression, schedules the job, and confirms the cadence and job ID.

47### Interval syntax

49Intervals are optional. You can lead with them, trail with them, or leave them out entirely.

51| Form | Example | Parsed interval |

52| :---------------------- | :------------------------------------ | :--------------------------- |

53| Leading token | `/loop 30m check the build` | every 30 minutes |

54| Trailing `every` clause | `/loop check the build every 2 hours` | every 2 hours |

55| No interval | `/loop check the build` | defaults to every 10 minutes |

57Supported units are `s` for seconds, `m` for minutes, `h` for hours, and `d` for days. Seconds are rounded up to the nearest minute since cron has one-minute granularity. Intervals that don't divide evenly into their unit, such as `7m` or `90m`, are rounded to the nearest clean interval and Claude tells you what it picked.

59### Loop over another command

61The scheduled prompt can itself be a command or skill invocation. This is useful for re-running a workflow you've already packaged.

63```text theme={null}

64/loop 20m /review-pr 1234

65```

67Each time the job fires, Claude runs `/review-pr 1234` as if you had typed it.

69## Set a one-time reminder

71For one-shot reminders, describe what you want in natural language instead of using `/loop`. Claude schedules a single-fire task that deletes itself after running.

73```text theme={null}

74remind me at 3pm to push the release branch

75```

77```text theme={null}

78in 45 minutes, check whether the integration tests passed

79```

81Claude pins the fire time to a specific minute and hour using a cron expression and confirms when it will fire.

83## Manage scheduled tasks

85Ask Claude in natural language to list or cancel tasks, or reference the underlying tools directly.

87```text theme={null}

88what scheduled tasks do I have?

89```

91```text theme={null}

92cancel the deploy check job

93```

95Under the hood, Claude uses these tools:

97| Tool | Purpose |

98| :----------- | :-------------------------------------------------------------------------------------------------------------- |

99| `CronCreate` | Schedule a new task. Accepts a 5-field cron expression, the prompt to run, and whether it recurs or fires once. |

100| `CronList` | List all scheduled tasks with their IDs, schedules, and prompts. |

101| `CronDelete` | Cancel a task by ID. |

102

103Each scheduled task has an 8-character ID you can pass to `CronDelete`. A session can hold up to 50 scheduled tasks at once.

104

105## How scheduled tasks run

106

107The scheduler checks every second for due tasks and enqueues them at low priority. A scheduled prompt fires between your turns, not while Claude is mid-response. If Claude is busy when a task comes due, the prompt waits until the current turn ends.

108

109All times are interpreted in your local timezone. A cron expression like `0 9 * * *` means 9am wherever you're running Claude Code, not UTC.

110

111### Jitter

112

113To avoid every session hitting the API at the same wall-clock moment, the scheduler adds a small deterministic offset to fire times:

114

115* Recurring tasks fire up to 10% of their period late, capped at 15 minutes. An hourly job might fire anywhere from `:00` to `:06`.

116* One-shot tasks scheduled for the top or bottom of the hour fire up to 90 seconds early.

117

118The offset is derived from the task ID, so the same task always gets the same offset. If exact timing matters, pick a minute that is not `:00` or `:30`, for example `3 9 * * *` instead of `0 9 * * *`, and the one-shot jitter will not apply.

119

120### Three-day expiry

121

122Recurring tasks automatically expire 3 days after creation. The task fires one final time, then deletes itself. This bounds how long a forgotten loop can run. If you need a recurring task to last longer, cancel and recreate it before it expires, or use [Cloud scheduled tasks](/en/web-scheduled-tasks) or [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) for durable scheduling.

123

124## Cron expression reference

125

126`CronCreate` accepts standard 5-field cron expressions: `minute hour day-of-month month day-of-week`. All fields support wildcards (`*`), single values (`5`), steps (`*/15`), ranges (`1-5`), and comma-separated lists (`1,15,30`).

127

128| Example | Meaning |

129| :------------- | :--------------------------- |

130| `*/5 * * * *` | Every 5 minutes |

131| `0 * * * *` | Every hour on the hour |

132| `7 * * * *` | Every hour at 7 minutes past |

133| `0 9 * * *` | Every day at 9am local |

134| `0 9 * * 1-5` | Weekdays at 9am local |

135| `30 14 15 3 *` | March 15 at 2:30pm local |

136

137Day-of-week uses `0` or `7` for Sunday through `6` for Saturday. Extended syntax like `L`, `W`, `?`, and name aliases such as `MON` or `JAN` is not supported.

138

139When both day-of-month and day-of-week are constrained, a date matches if either field matches. This follows standard vixie-cron semantics.

140

141## Disable scheduled tasks

142

143Set `CLAUDE_CODE_DISABLE_CRON=1` in your environment to disable the scheduler entirely. The cron tools and `/loop` become unavailable, and any already-scheduled tasks stop firing. See [Environment variables](/en/env-vars) for the full list of disable flags.

144

145## Limitations

146

147Session-scoped scheduling has inherent constraints:

148

149* Tasks only fire while Claude Code is running and idle. Closing the terminal or letting the session exit cancels everything.

150* No catch-up for missed fires. If a task's scheduled time passes while Claude is busy on a long-running request, it fires once when Claude becomes idle, not once per missed interval.

151* No persistence across restarts. Restarting Claude Code clears all session-scoped tasks.

152

153For cron-driven automation that needs to run unattended:

154

155* [Cloud scheduled tasks](/en/web-scheduled-tasks): run on Anthropic-managed infrastructure

156* [GitHub Actions](/en/github-actions): use a `schedule` trigger in CI

157* [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks): run locally on your machine

sdk/migration-guide.md +0 −329 deleted

File DeletedView Diff

~~1# Migrate to Claude Agent SDK~~

~~3Guide for migrating the Claude Code TypeScript and Python SDKs to the Claude Agent SDK~~

~~6## Overview~~

8The Claude Code SDK has been renamed to the **Claude Agent SDK** and its documentation has been reorganized. This change reflects the SDK's broader capabilities for building AI agents beyond just coding tasks.

~~10## What's Changed~~

~~12| Aspect | Old | New |~~

~~13| :----------------------- | :-------------------------- | :------------------------------- |~~

~~14| **Package Name (TS/JS)** | `@anthropic-ai/claude-code` | `@anthropic-ai/claude-agent-sdk` |~~

~~15| **Python Package** | `claude-code-sdk` | `claude-agent-sdk` |~~

~~16| **Documentation Location** | Claude Code docs | API Guide → Agent SDK section |~~

~~18<Note>~~

19**Documentation Changes:** The Agent SDK documentation has moved from the Claude Code docs to the API Guide under a dedicated [Agent SDK](/docs/en/agent-sdk/overview) section. The Claude Code docs now focus on the CLI tool and automation features.

~~20</Note>~~

~~22## Migration Steps~~

~~24### For TypeScript/JavaScript Projects~~

~~26**1. Uninstall the old package:**~~

~~28```bash~~

~~29npm uninstall @anthropic-ai/claude-code~~

~~30```~~

~~32**2. Install the new package:**~~

~~34```bash~~

~~35npm install @anthropic-ai/claude-agent-sdk~~

~~36```~~

~~38**3. Update your imports:**~~

~~40Change all imports from `@anthropic-ai/claude-code` to `@anthropic-ai/claude-agent-sdk`:~~

~~42```typescript~~

~~43// Before~~

~~44import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-code";~~

~~46// After~~

~~47import {~~

~~48 query,~~

~~49 tool,~~

~~50 createSdkMcpServer,~~

~~51} from "@anthropic-ai/claude-agent-sdk";~~

~~52```~~

~~54**4. Update package.json dependencies:**~~

~~56If you have the package listed in your `package.json`, update it:~~

~~58```json~~

~~59// Before~~

~~60{~~

~~61 "dependencies": {~~

~~62 "@anthropic-ai/claude-code": "^1.0.0"~~

~~63 }~~

~~64}~~

~~66// After~~

~~67{~~

~~68 "dependencies": {~~

~~69 "@anthropic-ai/claude-agent-sdk": "^0.1.0"~~

~~70 }~~

~~71}~~

~~72```~~

~~74That's it! No other code changes are required.~~

~~76### For Python Projects~~

~~78**1. Uninstall the old package:**~~

~~80```bash~~

~~81pip uninstall claude-code-sdk~~

~~82```~~

~~84**2. Install the new package:**~~

~~86```bash~~

~~87pip install claude-agent-sdk~~

~~88```~~

~~90**3. Update your imports:**~~

~~92Change all imports from `claude_code_sdk` to `claude_agent_sdk`:~~

~~94```python~~

~~95# Before~~

~~96from claude_code_sdk import query, ClaudeCodeOptions~~

~~98# After~~

~~99from claude_agent_sdk import query, ClaudeAgentOptions~~

100```

~~101~~

102**4. Update type names:**

~~103~~

104Change `ClaudeCodeOptions` to `ClaudeAgentOptions`:

~~105~~

106```python

107# Before

108from claude_agent_sdk import query, ClaudeCodeOptions

~~109~~

110options = ClaudeCodeOptions(

111 model="claude-sonnet-4-5"

112)

~~113~~

114# After

115from claude_agent_sdk import query, ClaudeAgentOptions

~~116~~

117options = ClaudeAgentOptions(

118 model="claude-sonnet-4-5"

119)

120```

~~121~~

122**5. Review [breaking changes](#breaking-changes)**

~~123~~

124Make any code changes needed to complete the migration.

~~125~~

126## Breaking changes

~~127~~

128<Warning>

129To improve isolation and explicit configuration, Claude Agent SDK v0.1.0 introduces breaking changes for users migrating from Claude Code SDK. Review this section carefully before migrating.

130</Warning>

~~131~~

132### Python: ClaudeCodeOptions renamed to ClaudeAgentOptions

~~133~~

134**What changed:** The Python SDK type `ClaudeCodeOptions` has been renamed to `ClaudeAgentOptions`.

~~135~~

136**Migration:**

~~137~~

138```python

139# BEFORE (v0.0.x)

140from claude_agent_sdk import query, ClaudeCodeOptions

~~141~~

142options = ClaudeCodeOptions(

143 model="claude-sonnet-4-5",

144 permission_mode="acceptEdits"

145)

~~146~~

147# AFTER (v0.1.0)

148from claude_agent_sdk import query, ClaudeAgentOptions

~~149~~

150options = ClaudeAgentOptions(

151 model="claude-sonnet-4-5",

152 permission_mode="acceptEdits"

153)

154```

~~155~~

156**Why this changed:** The type name now matches the "Claude Agent SDK" branding and provides consistency across the SDK's naming conventions.

~~157~~

158### System prompt no longer default

~~159~~

160**What changed:** The SDK no longer uses Claude Code's system prompt by default.

~~161~~

162**Migration:**

~~163~~

164<CodeGroup>

~~165~~

166```typescript TypeScript

167// BEFORE (v0.0.x) - Used Claude Code's system prompt by default

168const result = query({ prompt: "Hello" });

~~169~~

170// AFTER (v0.1.0) - Uses empty system prompt by default

171// To get the old behavior, explicitly request Claude Code's preset:

172const result = query({

173 prompt: "Hello",

174 options: {

175 systemPrompt: { type: "preset", preset: "claude_code" }

176 }

177});

~~178~~

179// Or use a custom system prompt:

180const result = query({

181 prompt: "Hello",

182 options: {

183 systemPrompt: "You are a helpful coding assistant"

184 }

185});

186```

~~187~~

188```python Python

189# BEFORE (v0.0.x) - Used Claude Code's system prompt by default

190async for message in query(prompt="Hello"):

191 print(message)

~~192~~

193# AFTER (v0.1.0) - Uses empty system prompt by default

194# To get the old behavior, explicitly request Claude Code's preset:

195from claude_agent_sdk import query, ClaudeAgentOptions

~~196~~

197async for message in query(

198 prompt="Hello",

199 options=ClaudeAgentOptions(

200 system_prompt={"type": "preset", "preset": "claude_code"} # Use the preset

201 )

202):

203 print(message)

~~204~~

205# Or use a custom system prompt:

206async for message in query(

207 prompt="Hello",

208 options=ClaudeAgentOptions(

209 system_prompt="You are a helpful coding assistant"

210 )

211):

212 print(message)

213```

~~214~~

215</CodeGroup>

~~216~~

217**Why this changed:** Provides better control and isolation for SDK applications. You can now build agents with custom behavior without inheriting Claude Code's CLI-focused instructions.

~~218~~

219### Settings Sources No Longer Loaded by Default

~~220~~

221**What changed:** The SDK no longer reads from filesystem settings (CLAUDE.md, settings.json, slash commands, etc.) by default.

~~222~~

223**Migration:**

~~224~~

225<CodeGroup>

~~226~~

227```typescript TypeScript

228// BEFORE (v0.0.x) - Loaded all settings automatically

229const result = query({ prompt: "Hello" });

230// Would read from:

231// - ~/.claude/settings.json (user)

232// - .claude/settings.json (project)

233// - .claude/settings.local.json (local)

234// - CLAUDE.md files

235// - Custom slash commands

~~236~~

237// AFTER (v0.1.0) - No settings loaded by default

238// To get the old behavior:

239const result = query({

240 prompt: "Hello",

241 options: {

242 settingSources: ["user", "project", "local"]

243 }

244});

~~245~~

246// Or load only specific sources:

247const result = query({

248 prompt: "Hello",

249 options: {

250 settingSources: ["project"] // Only project settings

251 }

252});

253```

~~254~~

255```python Python

256# BEFORE (v0.0.x) - Loaded all settings automatically

257async for message in query(prompt="Hello"):

258 print(message)

259# Would read from:

260# - ~/.claude/settings.json (user)

261# - .claude/settings.json (project)

262# - .claude/settings.local.json (local)

263# - CLAUDE.md files

264# - Custom slash commands

~~265~~

266# AFTER (v0.1.0) - No settings loaded by default

267# To get the old behavior:

268from claude_agent_sdk import query, ClaudeAgentOptions

~~269~~

270async for message in query(

271 prompt="Hello",

272 options=ClaudeAgentOptions(

273 setting_sources=["user", "project", "local"]

274 )

275):

276 print(message)

~~277~~

278# Or load only specific sources:

279async for message in query(

280 prompt="Hello",

281 options=ClaudeAgentOptions(

282 setting_sources=["project"] # Only project settings

283 )

284):

285 print(message)

286```

~~287~~

288</CodeGroup>

~~289~~

290**Why this changed:** Ensures SDK applications have predictable behavior independent of local filesystem configurations. This is especially important for:

291- **CI/CD environments** - Consistent behavior without local customizations

292- **Deployed applications** - No dependency on filesystem settings

293- **Testing** - Isolated test environments

294- **Multi-tenant systems** - Prevent settings leakage between users

~~295~~

296<Note>

297**Backward compatibility:** If your application relied on filesystem settings (custom slash commands, CLAUDE.md instructions, etc.), add `settingSources: ['user', 'project', 'local']` to your options.

298</Note>

~~299~~

300## Why the Rename?

~~301~~

302The Claude Code SDK was originally designed for coding tasks, but it has evolved into a powerful framework for building all types of AI agents. The new name "Claude Agent SDK" better reflects its capabilities:

~~303~~

304- Building business agents (legal assistants, finance advisors, customer support)

305- Creating specialized coding agents (SRE bots, security reviewers, code review agents)

306- Developing custom agents for any domain with tool use, MCP integration, and more

~~307~~

308## Getting Help

~~309~~

310If you encounter any issues during migration:

~~311~~

312**For TypeScript/JavaScript:**

~~313~~

3141. Check that all imports are updated to use `@anthropic-ai/claude-agent-sdk`

3152. Verify your package.json has the new package name

3163. Run `npm install` to ensure dependencies are updated

~~317~~

318**For Python:**

~~319~~

3201. Check that all imports are updated to use `claude_agent_sdk`

3212. Verify your requirements.txt or pyproject.toml has the new package name

3223. Run `pip install claude-agent-sdk` to ensure the package is installed

~~323~~

324## Next Steps

~~325~~

326- Explore the [Agent SDK Overview](/docs/en/agent-sdk/overview) to learn about available features

327- Check out the [TypeScript SDK Reference](/docs/en/agent-sdk/typescript) for detailed API documentation

328- Review the [Python SDK Reference](/docs/en/agent-sdk/python) for Python-specific documentation

329- Learn about [Custom Tools](/docs/en/agent-sdk/custom-tools) and [MCP Integration](/docs/en/agent-sdk/mcp)

security.md +14 −7

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Security5# Security

2 6

3> Learn about Claude Code's security safeguards and best practices for safe usage.7> Learn about Claude Code's security safeguards and best practices for safe usage.

14 18

15We designed Claude Code to be transparent and secure. For example, we require approval for bash commands before executing them, giving you direct control. This approach enables users and organizations to configure permissions directly.19We designed Claude Code to be transparent and secure. For example, we require approval for bash commands before executing them, giving you direct control. This approach enables users and organizations to configure permissions directly.

16 20

~~17For detailed permission configuration, see [Identity and Access Management](/en/iam).~~21For detailed permission configuration, see [Permissions](/en/permissions).

18 22

19### Built-in protections23### Built-in protections

20 24

38* **Permission system**: Sensitive operations require explicit approval42* **Permission system**: Sensitive operations require explicit approval

39* **Context-aware analysis**: Detects potentially harmful instructions by analyzing the full request43* **Context-aware analysis**: Detects potentially harmful instructions by analyzing the full request

40* **Input sanitization**: Prevents command injection by processing user inputs44* **Input sanitization**: Prevents command injection by processing user inputs

41* **Command blocklist**: Blocks risky commands that fetch arbitrary content from the web like `curl` and `wget` by default. When explicitly allowed, be aware of [permission pattern limitations](/en/iam#tool-specific-permission-rules)45* **Command blocklist**: Blocks risky commands that fetch arbitrary content from the web like `curl` and `wget` by default. When explicitly allowed, be aware of [permission pattern limitations](/en/permissions#tool-specific-permission-rules)

42 46

43### Privacy safeguards47### Privacy safeguards

44 48

59* **Command injection detection**: Suspicious bash commands require manual approval even if previously allowlisted63* **Command injection detection**: Suspicious bash commands require manual approval even if previously allowlisted

60* **Fail-closed matching**: Unmatched commands default to requiring manual approval64* **Fail-closed matching**: Unmatched commands default to requiring manual approval

61* **Natural language descriptions**: Complex bash commands include explanations for user understanding65* **Natural language descriptions**: Complex bash commands include explanations for user understanding

~~62* **Secure credential storage**: API keys and tokens are encrypted. See [Credential Management](/en/iam#credential-management)~~66* **Secure credential storage**: API keys and tokens are encrypted. See [Credential Management](/en/authentication#credential-management)

63 67

64<Warning>68<Warning>

65 **Windows WebDAV security risk**: When running Claude Code on Windows, we recommend against enabling WebDAV or allowing Claude Code to access paths such as `\\*` that may contain WebDAV subdirectories. [WebDAV has been deprecated by Microsoft](https://learn.microsoft.com/en-us/windows/whats-new/deprecated-features#:~:text=The%20Webclient%20$WebDAV$%20service%20is%20deprecated) due to security risks. Enabling WebDAV may allow Claude Code to trigger network requests to remote hosts, bypassing the permission system.69 **Windows WebDAV security risk**: When running Claude Code on Windows, we recommend against enabling WebDAV or allowing Claude Code to access paths such as `\\*` that may contain WebDAV subdirectories. [WebDAV has been deprecated by Microsoft](https://learn.microsoft.com/en-us/windows/whats-new/deprecated-features#:~:text=The%20Webclient%20$WebDAV$%20service%20is%20deprecated) due to security risks. Enabling WebDAV may allow Claude Code to trigger network requests to remote hosts, bypassing the permission system.

712. Avoid piping untrusted content directly to Claude752. Avoid piping untrusted content directly to Claude

723. Verify proposed changes to critical files763. Verify proposed changes to critical files

734. Use virtual machines (VMs) to run scripts and make tool calls, especially when interacting with external web services774. Use virtual machines (VMs) to run scripts and make tool calls, especially when interacting with external web services

~~745. Report suspicious behavior with `/bug`~~785. Report suspicious behavior with `/feedback`

75 79

76<Warning>80<Warning>

77 While these protections significantly reduce risk, no system is completely81 While these protections significantly reduce risk, no system is completely

87 91

88## IDE security92## IDE security

89 93

~~90See [here](/en/vs-code#security) for more information on the security of running Claude Code in an IDE.~~94See [VS Code security and privacy](/en/vs-code#security-and-privacy) for more information on running Claude Code in an IDE.

91 95

92## Cloud execution security96## Cloud execution security

93 97

102 106

103For more details on cloud execution, see [Claude Code on the web](/en/claude-code-on-the-web).107For more details on cloud execution, see [Claude Code on the web](/en/claude-code-on-the-web).

104 108

109[Remote Control](/en/remote-control) sessions work differently: the web interface connects to a Claude Code process running on your local machine. All code execution and file access stays local, and the same data that flows during any local Claude Code session travels through the Anthropic API over TLS. No cloud VMs or sandboxing are involved. The connection uses multiple short-lived, narrowly scoped credentials, each limited to a specific purpose and expiring independently, to limit the blast radius of any single compromised credential.

110

105## Security best practices111## Security best practices

106 112

107### Working with sensitive code113### Working with sensitive code

113 119

114### Team security120### Team security

115 121

116* Use [enterprise managed policies](/en/iam#enterprise-managed-policy-settings) to enforce organizational standards122* Use [managed settings](/en/settings#settings-files) to enforce organizational standards

117* Share approved permission configurations through version control123* Share approved permission configurations through version control

118* Train team members on security best practices124* Train team members on security best practices

119* Monitor Claude Code usage through [OpenTelemetry metrics](/en/monitoring-usage)125* Monitor Claude Code usage through [OpenTelemetry metrics](/en/monitoring-usage)

126* Audit or block settings changes during sessions with [`ConfigChange` hooks](/en/hooks#configchange)

120 127

121### Reporting security issues128### Reporting security issues

122 129

130## Related resources137## Related resources

131 138

132* [Sandboxing](/en/sandboxing) - Filesystem and network isolation for bash commands139* [Sandboxing](/en/sandboxing) - Filesystem and network isolation for bash commands

133* [Identity and Access Management](/en/iam) - Configure permissions and access controls140* [Permissions](/en/permissions) - Configure permissions and access controls

134* [Monitoring usage](/en/monitoring-usage) - Track and audit Claude Code activity141* [Monitoring usage](/en/monitoring-usage) - Track and audit Claude Code activity

135* [Development containers](/en/devcontainer) - Secure, isolated environments142* [Development containers](/en/devcontainer) - Secure, isolated environments

136* [Anthropic Trust Center](https://trust.anthropic.com) - Security certifications and compliance143* [Anthropic Trust Center](https://trust.anthropic.com) - Security certifications and compliance

server-managed-settings.md +199 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Configure server-managed settings (public beta)

7> Centrally configure Claude Code for your organization through server-delivered settings, without requiring device management infrastructure.

9Server-managed settings allow administrators to centrally configure Claude Code through a web-based interface on Claude.ai. Claude Code clients automatically receive these settings when users authenticate with their organization credentials.

11This approach is designed for organizations that do not have device management infrastructure in place, or need to manage settings for users on unmanaged devices.

13<Note>

14 Server-managed settings are in public beta and available for [Claude for Teams](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=server_settings_teams#team-&-enterprise) and [Claude for Enterprise](https://anthropic.com/contact-sales?utm_source=claude_code\&utm_medium=docs\&utm_content=server_settings_enterprise) customers. Features may evolve before general availability.

15</Note>

17## Requirements

19To use server-managed settings, you need:

21* Claude for Teams or Claude for Enterprise plan

22* Claude Code version 2.1.38 or later for Claude for Teams, or version 2.1.30 or later for Claude for Enterprise

23* Network access to `api.anthropic.com`

25## Choose between server-managed and endpoint-managed settings

27Claude Code supports two approaches for centralized configuration. Server-managed settings deliver configuration from Anthropic's servers. [Endpoint-managed settings](/en/settings#settings-files) are deployed directly to devices through native OS policies (macOS managed preferences, Windows registry) or managed settings files.

29| Approach | Best for | Security model |

30| :----------------------------------------------------------- | :------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- |

31| **Server-managed settings** | Organizations without MDM, or users on unmanaged devices | Settings delivered from Anthropic's servers at authentication time |

32| **[Endpoint-managed settings](/en/settings#settings-files)** | Organizations with MDM or endpoint management | Settings deployed to devices via MDM configuration profiles, registry policies, or managed settings files |

34If your devices are enrolled in an MDM or endpoint management solution, endpoint-managed settings provide stronger security guarantees because the settings file can be protected from user modification at the OS level.

36## Configure server-managed settings

38<Steps>

39 <Step title="Open the admin console">

40 In [Claude.ai](https://claude.ai), navigate to **Admin Settings > Claude Code > Managed settings**.

41 </Step>

43 <Step title="Define your settings">

44 Add your configuration as JSON. All [settings available in `settings.json`](/en/settings#available-settings) are supported, including [hooks](/en/hooks), [environment variables](/en/env-vars), and [managed-only settings](/en/permissions#managed-only-settings) like `allowManagedPermissionRulesOnly`.

46 This example enforces a permission deny list and prevents users from bypassing permissions:

48 ```json theme={null}

49 {

50 "permissions": {

51 "deny": [

52 "Bash(curl *)",

53 "Read(./.env)",

54 "Read(./.env.*)",

55 "Read(./secrets/**)"

56 ],

57 "disableBypassPermissionsMode": "disable"

58 }

59 }

60 ```

62 Hooks use the same format as in `settings.json`.

64 This example runs an audit script after every file edit across the organization:

66 ```json theme={null}

67 {

68 "hooks": {

69 "PostToolUse": [

70 {

71 "matcher": "Edit|Write",

72 "hooks": [

73 { "type": "command", "command": "/usr/local/bin/audit-edit.sh" }

74 ]

75 }

76 ]

77 }

78 }

79 ```

81 To configure the [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) classifier so it knows which repos, buckets, and domains your organization trusts:

83 ```json theme={null}

84 {

85 "autoMode": {

86 "environment": [

87 "Source control: github.example.com/acme-corp and all repos under it",

88 "Trusted cloud buckets: s3://acme-build-artifacts, gs://acme-ml-datasets",

89 "Trusted internal domains: *.corp.example.com"

90 ]

91 }

92 }

93 ```

95 Because hooks execute shell commands, users see a [security approval dialog](#security-approval-dialogs) before they're applied. See [Configure the auto mode classifier](/en/permissions#configure-the-auto-mode-classifier) for how the `autoMode` entries affect what the classifier blocks and important warnings about the `allow` and `soft_deny` fields.

96 </Step>

98 <Step title="Save and deploy">

99 Save your changes. Claude Code clients receive the updated settings on their next startup or hourly polling cycle.

100 </Step>

101</Steps>

102

103### Verify settings delivery

104

105To confirm that settings are being applied, ask a user to restart Claude Code. If the configuration includes settings that trigger the [security approval dialog](#security-approval-dialogs), the user sees a prompt describing the managed settings on startup. You can also verify that managed permission rules are active by having a user run `/permissions` to view their effective permission rules.

106

107### Access control

108

109The following roles can manage server-managed settings:

110

111* **Primary Owner**

112* **Owner**

113

114Restrict access to trusted personnel, as settings changes apply to all users in the organization.

115

116### Current limitations

117

118Server-managed settings have the following limitations during the beta period:

119

120* Settings apply uniformly to all users in the organization. Per-group configurations are not yet supported.

121* [MCP server configurations](/en/mcp#managed-mcp-configuration) cannot be distributed through server-managed settings.

122

123## Settings delivery

124

125### Settings precedence

126

127Server-managed settings and [endpoint-managed settings](/en/settings#settings-files) both occupy the highest tier in the Claude Code [settings hierarchy](/en/settings#settings-precedence). No other settings level can override them, including command line arguments. When both are present, server-managed settings take precedence and endpoint-managed settings are not used.

128

129### Fetch and caching behavior

130

131Claude Code fetches settings from Anthropic's servers at startup and polls for updates hourly during active sessions.

132

133**First launch without cached settings:**

134

135* Claude Code fetches settings asynchronously

136* If the fetch fails, Claude Code continues without managed settings

137* There is a brief window before settings load where restrictions are not yet enforced

138

139**Subsequent launches with cached settings:**

140

141* Cached settings apply immediately at startup

142* Claude Code fetches fresh settings in the background

143* Cached settings persist through network failures

144

145Claude Code applies settings updates automatically without a restart, except for advanced settings like OpenTelemetry configuration, which require a full restart to take effect.

146

147### Security approval dialogs

148

149Certain settings that could pose security risks require explicit user approval before being applied:

150

151* **Shell command settings**: settings that execute shell commands

152* **Custom environment variables**: variables not in the known safe allowlist

153* **Hook configurations**: any hook definition

154

155When these settings are present, users see a security dialog explaining what is being configured. Users must approve to proceed. If a user rejects the settings, Claude Code exits.

156

157<Note>

158 In non-interactive mode with the `-p` flag, Claude Code skips security dialogs and applies settings without user approval.

159</Note>

160

161## Platform availability

162

163Server-managed settings require a direct connection to `api.anthropic.com` and are not available when using third-party model providers:

164

165* Amazon Bedrock

166* Google Vertex AI

167* Microsoft Foundry

168* Custom API endpoints via `ANTHROPIC_BASE_URL` or [LLM gateways](/en/llm-gateway)

169

170## Audit logging

171

172Audit log events for settings changes are available through the compliance API or audit log export. Contact your Anthropic account team for access.

173

174Audit events include the type of action performed, the account and device that performed the action, and references to the previous and new values.

175

176## Security considerations

177

178Server-managed settings provide centralized policy enforcement, but they operate as a client-side control. On unmanaged devices, users with admin or sudo access can modify the Claude Code binary, filesystem, or network configuration.

179

180| Scenario | Behavior |

181| :----------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- |

182| User edits the cached settings file | Tampered file applies at startup, but correct settings restore on the next server fetch |

183| User deletes the cached settings file | First-launch behavior occurs: settings fetch asynchronously with a brief unenforced window |

184| API is unavailable | Cached settings apply if available, otherwise managed settings are not enforced until the next successful fetch |

185| User authenticates with a different organization | Settings are not delivered for accounts outside the managed organization |

186| User sets a non-default `ANTHROPIC_BASE_URL` | Server-managed settings are bypassed when using third-party API providers |

187

188To detect runtime configuration changes, use [`ConfigChange` hooks](/en/hooks#configchange) to log modifications or block unauthorized changes before they take effect.

189

190For stronger enforcement guarantees, use [endpoint-managed settings](/en/settings#settings-files) on devices enrolled in an MDM solution.

191

192## See also

193

194Related pages for managing Claude Code configuration:

195

196* [Settings](/en/settings): complete configuration reference including all available settings

197* [Endpoint-managed settings](/en/settings#settings-files): managed settings deployed to devices by IT

198* [Authentication](/en/authentication): set up user access to Claude Code

199* [Security](/en/security): security safeguards and best practices

settings.md +637 −168

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Claude Code settings5# Claude Code settings

2 6

3> Configure Claude Code with global and project-level settings, and environment variables.7> Configure Claude Code with global and project-level settings, and environment variables.

4 8

5Claude Code offers a variety of settings to configure its behavior to meet your needs. You can configure Claude Code by running the `/config` command when using the interactive REPL, which opens a tabbed Settings interface where you can view status information and modify configuration options.9Claude Code offers a variety of settings to configure its behavior to meet your needs. You can configure Claude Code by running the `/config` command when using the interactive REPL, which opens a tabbed Settings interface where you can view status information and modify configuration options.

6 10

11## Configuration scopes

13Claude Code uses a **scope system** to determine where configurations apply and who they're shared with. Understanding scopes helps you decide how to configure Claude Code for personal use, team collaboration, or enterprise deployment.

15### Available scopes

18| :---------- | :--------------------------------------------------------------------------------- | :----------------------------------- | :--------------------- |

24### When to use each scope

26**Managed scope** is for:

28* Security policies that must be enforced organization-wide

29* Compliance requirements that can't be overridden

30* Standardized configurations deployed by IT/DevOps

32**User scope** is best for:

34* Personal preferences you want everywhere (themes, editor settings)

35* Tools and plugins you use across all projects

36* API keys and authentication (stored securely)

38**Project scope** is best for:

40* Team-shared settings (permissions, hooks, MCP servers)

41* Plugins the whole team should have

42* Standardizing tooling across collaborators

44**Local scope** is best for:

46* Personal overrides for a specific project

47* Testing configurations before sharing with the team

48* Machine-specific settings that won't work for others

50### How scopes interact

52When the same setting is configured in multiple scopes, more specific scopes take precedence:

541. **Managed** (highest) - can't be overridden by anything

552. **Command line arguments** - temporary session overrides

563. **Local** - overrides project and user settings

574. **Project** - overrides user settings

585. **User** (lowest) - applies when nothing else specifies the setting

60For example, if a permission is allowed in user settings but denied in project settings, the project setting takes precedence and the permission is blocked.

62### What uses scopes

64Scopes apply to many Claude Code features:

67| :-------------- | :------------------------ | :--------------------------------- | :----------------------------- |

74***

7## Settings files76## Settings files

8 77

~~9The `settings.json` file is our official mechanism for configuring Claude~~78The `settings.json` file is the official mechanism for configuring Claude

10Code through hierarchical settings:79Code through hierarchical settings:

11 80

12* **User settings** are defined in `~/.claude/settings.json` and apply to all81* **User settings** are defined in `~/.claude/settings.json` and apply to all

14* **Project settings** are saved in your project directory:83* **Project settings** are saved in your project directory:

15 * `.claude/settings.json` for settings that are checked into source control and shared with your team84 * `.claude/settings.json` for settings that are checked into source control and shared with your team

16 * `.claude/settings.local.json` for settings that are not checked in, useful for personal preferences and experimentation. Claude Code will configure git to ignore `.claude/settings.local.json` when it is created.85 * `.claude/settings.local.json` for settings that are not checked in, useful for personal preferences and experimentation. Claude Code will configure git to ignore `.claude/settings.local.json` when it is created.

~~17* For enterprise deployments of Claude Code, we also support **enterprise~~86* **Managed settings**: For organizations that need centralized control, Claude Code supports multiple delivery mechanisms for managed settings. All use the same JSON format and cannot be overridden by user or project settings:

~~18 managed policy settings**. These take precedence over user and project~~87

~~19 settings. System administrators can deploy policies to:~~88 * **Server-managed settings**: delivered from Anthropic's servers via the Claude.ai admin console. See [server-managed settings](/en/server-managed-settings).

~~20 * macOS: `/Library/Application Support/ClaudeCode/managed-settings.json`~~89 * **MDM/OS-level policies**: delivered through native device management on macOS and Windows:

~~21 * Linux and WSL: `/etc/claude-code/managed-settings.json`~~90 * macOS: `com.anthropic.claudecode` managed preferences domain (deployed via configuration profiles in Jamf, Kandji, or other MDM tools)

~~22 * Windows: `C:\ProgramData\ClaudeCode\managed-settings.json`~~91 * Windows: `HKLM\SOFTWARE\Policies\ClaudeCode` registry key with a `Settings` value (REG\_SZ or REG\_EXPAND\_SZ) containing JSON (deployed via Group Policy or Intune)

~~23* Enterprise deployments can also configure **managed MCP servers** that override~~92 * Windows (user-level): `HKCU\SOFTWARE\Policies\ClaudeCode` (lowest policy priority, only used when no admin-level source exists)

~~24 user-configured servers. See [Enterprise MCP configuration](/en/mcp#enterprise-mcp-configuration):~~93 * **File-based**: `managed-settings.json` and `managed-mcp.json` deployed to system directories:

~~25 * macOS: `/Library/Application Support/ClaudeCode/managed-mcp.json`~~94

~~26 * Linux and WSL: `/etc/claude-code/managed-mcp.json`~~95 * macOS: `/Library/Application Support/ClaudeCode/`

~~27 * Windows: `C:\ProgramData\ClaudeCode\managed-mcp.json`~~96 * Linux and WSL: `/etc/claude-code/`

97 * Windows: `C:\Program Files\ClaudeCode\`

99 <Warning>

100 The legacy Windows path `C:\ProgramData\ClaudeCode\managed-settings.json` is no longer supported as of v2.1.75. Administrators who deployed settings to that location must migrate files to `C:\Program Files\ClaudeCode\managed-settings.json`.

101 </Warning>

102

103 File-based managed settings also support a drop-in directory at `managed-settings.d/` in the same system directory alongside `managed-settings.json`. This lets separate teams deploy independent policy fragments without coordinating edits to a single file.

104

105 Following the systemd convention, `managed-settings.json` is merged first as the base, then all `*.json` files in the drop-in directory are sorted alphabetically and merged on top. Later files override earlier ones for scalar values; arrays are concatenated and de-duplicated; objects are deep-merged. Hidden files starting with `.` are ignored.

106

107 Use numeric prefixes to control merge order, for example `10-telemetry.json` and `20-security.json`.

108

109 See [managed settings](/en/permissions#managed-only-settings) and [Managed MCP configuration](/en/mcp#managed-mcp-configuration) for details.

110

111 <Note>

112 Managed deployments can also restrict **plugin marketplace additions** using

113 `strictKnownMarketplaces`. For more information, see [Managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions).

114 </Note>

115* **Other configuration** is stored in `~/.claude.json`. This file contains your preferences (theme, notification settings, editor mode), OAuth session, [MCP server](/en/mcp) configurations for user and local scopes, per-project state (allowed tools, trust settings), and various caches. Project-scoped MCP servers are stored separately in `.mcp.json`.

116

117<Note>

118 Claude Code automatically creates timestamped backups of configuration files and retains the five most recent backups to prevent data loss.

119</Note>

28 120

29```JSON Example settings.json theme={null}121```JSON Example settings.json theme={null}

30{122{

123 "$schema": "https://json.schemastore.org/claude-code-settings.json",

31 "permissions": {124 "permissions": {

32 "allow": [125 "allow": [

33 "Bash(npm run lint)",126 "Bash(npm run lint)",

~~34 "Bash(npm run test:*)",~~127 "Bash(npm run test *)",

35 "Read(~/.zshrc)"128 "Read(~/.zshrc)"

36 ],129 ],

37 "deny": [130 "deny": [

~~38 "Bash(curl:*)",~~131 "Bash(curl *)",

39 "Read(./.env)",132 "Read(./.env)",

40 "Read(./.env.*)",133 "Read(./.env.*)",

41 "Read(./secrets/**)"134 "Read(./secrets/**)"

53}146}

54```147```

55 148

149The `$schema` line in the example above points to the [official JSON schema](https://json.schemastore.org/claude-code-settings.json) for Claude Code settings. Adding it to your `settings.json` enables autocomplete and inline validation in VS Code, Cursor, and any other editor that supports JSON schema validation.

150

56### Available settings151### Available settings

57 152

58`settings.json` supports a number of options:153`settings.json` supports a number of options:

59 154

60| Key | Description | Example |155| Key | Description | Example |

61| :--------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- |156| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- |

62| `apiKeyHelper` | Custom script, to be executed in `/bin/sh`, to generate an auth value. This value will be sent as `X-Api-Key` and `Authorization: Bearer` headers for model requests | `/bin/generate_temp_api_key.sh` |157| `apiKeyHelper` | Custom script, to be executed in `/bin/sh`, to generate an auth value. This value will be sent as `X-Api-Key` and `Authorization: Bearer` headers for model requests | `/bin/generate_temp_api_key.sh` |

63| `cleanupPeriodDays` | How long to locally retain chat transcripts based on last activity date (default: 30 days) | `20` |158| `autoMemoryDirectory` | Custom directory for [auto memory](/en/memory#storage-location) storage. Accepts `~/`-expanded paths. Not accepted in project settings (`.claude/settings.json`) to prevent shared repos from redirecting memory writes to sensitive locations. Accepted from policy, local, and user settings | `"~/my-memory-dir"` |

159| `cleanupPeriodDays` | Sessions inactive for longer than this period are deleted at startup (default: 30 days).<br /><br />Setting to `0` deletes all existing transcripts at startup and disables session persistence entirely. No new `.jsonl` files are written, `/resume` shows no conversations, and hooks receive an empty `transcript_path`. | `20` |

64| `companyAnnouncements` | Announcement to display to users at startup. If multiple announcements are provided, they will be cycled through at random. | `["Welcome to Acme Corp! Review our code guidelines at docs.acme.com"]` |160| `companyAnnouncements` | Announcement to display to users at startup. If multiple announcements are provided, they will be cycled through at random. | `["Welcome to Acme Corp! Review our code guidelines at docs.acme.com"]` |

65| `env` | Environment variables that will be applied to every session | `{"FOO": "bar"}` |161| `env` | Environment variables that will be applied to every session | `{"FOO": "bar"}` |

66| `includeCoAuthoredBy` | Whether to include the `co-authored-by Claude` byline in git commits and pull requests (default: `true`) | `false` |162| `attribution` | Customize attribution for git commits and pull requests. See [Attribution settings](#attribution-settings) | `{"commit": "🤖 Generated with Claude Code", "pr": ""}` |

163| `includeCoAuthoredBy` | **Deprecated**: Use `attribution` instead. Whether to include the `co-authored-by Claude` byline in git commits and pull requests (default: `true`) | `false` |

164| `includeGitInstructions` | Include built-in commit and PR workflow instructions and the git status snapshot in Claude's system prompt (default: `true`). Set to `false` to remove both, for example when using your own git workflow skills. The `CLAUDE_CODE_DISABLE_GIT_INSTRUCTIONS` environment variable takes precedence over this setting when set | `false` |

68| `hooks` | Configure custom commands to run before or after tool executions. See [hooks documentation](/en/hooks) | `{"PreToolUse": {"Bash": "echo 'Running command...'"}}` |166| `autoMode` | Customize what the [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) classifier blocks and allows. Contains `environment`, `allow`, and `soft_deny` arrays of prose rules. See [Configure the auto mode classifier](/en/permissions#configure-the-auto-mode-classifier). Not read from shared project settings | `{"environment": ["Trusted repo: github.example.com/acme"]}` |

69| `disableAllHooks` | Disable all [hooks](/en/hooks) | `true` |167| `disableAutoMode` | Set to `"disable"` to prevent [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode) from being activated. Removes `auto` from the `Shift+Tab` cycle and rejects `--permission-mode auto` at startup. Most useful in [managed settings](/en/permissions#managed-settings) where users cannot override it | `"disable"` |

71| `statusLine` | Configure a custom status line to display context. See [statusLine documentation](/en/statusline) | `{"type": "command", "command": "~/.claude/statusline.sh"}` |169| `hooks` | Configure custom commands to run at lifecycle events. See [hooks documentation](/en/hooks) for format | See [hooks](/en/hooks) |

170| `disableAllHooks` | Disable all [hooks](/en/hooks) and any custom [status line](/en/statusline) | `true` |

171| `allowManagedHooksOnly` | (Managed settings only) Prevent loading of user, project, and plugin hooks. Only allows managed hooks and SDK hooks. See [Hook configuration](#hook-configuration) | `true` |

172| `allowedHttpHookUrls` | Allowlist of URL patterns that HTTP hooks may target. Supports `*` as a wildcard. When set, hooks with non-matching URLs are blocked. Undefined = no restriction, empty array = block all HTTP hooks. Arrays merge across settings sources. See [Hook configuration](#hook-configuration) | `["https://hooks.example.com/*"]` |

173| `httpHookAllowedEnvVars` | Allowlist of environment variable names HTTP hooks may interpolate into headers. When set, each hook's effective `allowedEnvVars` is the intersection with this list. Undefined = no restriction. Arrays merge across settings sources. See [Hook configuration](#hook-configuration) | `["MY_TOKEN", "HOOK_SECRET"]` |

174| `allowManagedPermissionRulesOnly` | (Managed settings only) Prevent user and project settings from defining `allow`, `ask`, or `deny` permission rules. Only rules in managed settings apply. See [Managed-only settings](/en/permissions#managed-only-settings) | `true` |

175| `allowManagedMcpServersOnly` | (Managed settings only) Only `allowedMcpServers` from managed settings are respected. `deniedMcpServers` still merges from all sources. Users can still add MCP servers, but only the admin-defined allowlist applies. See [Managed MCP configuration](/en/mcp#managed-mcp-configuration) | `true` |

176| `model` | Override the default model to use for Claude Code | `"claude-sonnet-4-6"` |

177| `availableModels` | Restrict which models users can select via `/model`, `--model`, Config tool, or `ANTHROPIC_MODEL`. Does not affect the Default option. See [Restrict model selection](/en/model-config#restrict-model-selection) | `["sonnet", "haiku"]` |

178| `modelOverrides` | Map Anthropic model IDs to provider-specific model IDs such as Bedrock inference profile ARNs. Each model picker entry uses its mapped value when calling the provider API. See [Override model IDs per version](/en/model-config#override-model-ids-per-version) | `{"claude-opus-4-6": "arn:aws:bedrock:..."}` |

179| `effortLevel` | Persist the [effort level](/en/model-config#adjust-effort-level) across sessions. Accepts `"low"`, `"medium"`, or `"high"`. Written automatically when you run `/effort low`, `/effort medium`, or `/effort high`. Supported on Opus 4.6 and Sonnet 4.6 | `"medium"` |

180| `otelHeadersHelper` | Script to generate dynamic OpenTelemetry headers. Runs at startup and periodically (see [Dynamic headers](/en/monitoring-usage#dynamic-headers)) | `/bin/generate_otel_headers.sh` |

181| `statusLine` | Configure a custom status line to display context. See [`statusLine` documentation](/en/statusline) | `{"type": "command", "command": "~/.claude/statusline.sh"}` |

182| `fileSuggestion` | Configure a custom script for `@` file autocomplete. See [File suggestion settings](#file-suggestion-settings) | `{"type": "command", "command": "~/.claude/file-suggestion.sh"}` |

183| `respectGitignore` | Control whether the `@` file picker respects `.gitignore` patterns. When `true` (default), files matching `.gitignore` patterns are excluded from suggestions | `false` |

185| `agent` | Run the main thread as a named subagent. Applies that subagent's system prompt, tool restrictions, and model. See [Invoke subagents explicitly](/en/sub-agents#invoke-subagents-explicitly) | `"code-reviewer"` |

74| `forceLoginOrgUUID` | Specify the UUID of an organization to automatically select it during login, bypassing the organization selection step. Requires `forceLoginMethod` to be set | `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"` |187| `forceLoginOrgUUID` | Specify the UUID of an organization to automatically select it during login, bypassing the organization selection step. Requires `forceLoginMethod` to be set | `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"` |

78| `allowedMcpServers` | When set in managed-settings.json, allowlist of MCP servers users can configure. Undefined = no restrictions, empty array = lockdown. Applies to all scopes. Denylist takes precedence. See [Enterprise MCP configuration](/en/mcp#enterprise-mcp-configuration) | `[{ "serverName": "github" }]` |191| `channelsEnabled` | (Managed settings only) Allow [channels](/en/channels) for Team and Enterprise users. Unset or `false` blocks channel message delivery regardless of what users pass to `--channels` | `true` |

79| `deniedMcpServers` | When set in managed-settings.json, denylist of MCP servers that are explicitly blocked. Applies to all scopes including enterprise servers. Denylist takes precedence over allowlist. See [Enterprise MCP configuration](/en/mcp#enterprise-mcp-configuration) | `[{ "serverName": "filesystem" }]` |192| `allowedChannelPlugins` | (Managed settings only) Allowlist of channel plugins that may push messages. Replaces the default Anthropic allowlist when set. Undefined = fall back to the default, empty array = block all channel plugins. Requires `channelsEnabled: true`. See [Restrict which channel plugins can run](/en/channels#restrict-which-channel-plugins-can-run) | `[{ "marketplace": "claude-plugins-official", "plugin": "telegram" }]` |

193| `allowedMcpServers` | When set in managed-settings.json, allowlist of MCP servers users can configure. Undefined = no restrictions, empty array = lockdown. Applies to all scopes. Denylist takes precedence. See [Managed MCP configuration](/en/mcp#managed-mcp-configuration) | `[{ "serverName": "github" }]` |

194| `deniedMcpServers` | When set in managed-settings.json, denylist of MCP servers that are explicitly blocked. Applies to all scopes including managed servers. Denylist takes precedence over allowlist. See [Managed MCP configuration](/en/mcp#managed-mcp-configuration) | `[{ "serverName": "filesystem" }]` |

195| `strictKnownMarketplaces` | When set in managed-settings.json, allowlist of plugin marketplaces users can add. Undefined = no restrictions, empty array = lockdown. Applies to marketplace additions only. See [Managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions) | `[{ "source": "github", "repo": "acme-corp/plugins" }]` |

196| `blockedMarketplaces` | (Managed settings only) Blocklist of marketplace sources. Blocked sources are checked before downloading, so they never touch the filesystem. See [Managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions) | `[{ "source": "github", "repo": "untrusted/plugins" }]` |

197| `pluginTrustMessage` | (Managed settings only) Custom message appended to the plugin trust warning shown before installation. Use this to add organization-specific context, for example to confirm that plugins from your internal marketplace are vetted. | `"All plugins from our marketplace are approved by IT"` |

80| `awsAuthRefresh` | Custom script that modifies the `.aws` directory (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `aws sso login --profile myprofile` |198| `awsAuthRefresh` | Custom script that modifies the `.aws` directory (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `aws sso login --profile myprofile` |

81| `awsCredentialExport` | Custom script that outputs JSON with AWS credentials (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `/bin/generate_aws_grant.sh` |199| `awsCredentialExport` | Custom script that outputs JSON with AWS credentials (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `/bin/generate_aws_grant.sh` |

200| `alwaysThinkingEnabled` | Enable [extended thinking](/en/common-workflows#use-extended-thinking-thinking-mode) by default for all sessions. Typically configured via the `/config` command rather than editing directly | `true` |

201| `plansDirectory` | Customize where plan files are stored. Path is relative to project root. Default: `~/.claude/plans` | `"./plans"` |

202| `showClearContextOnPlanAccept` | Show the "clear context" option on the plan accept screen. Defaults to `false`. Set to `true` to restore the option | `true` |

203| `spinnerVerbs` | Customize the action verbs shown in the spinner and turn duration messages. Set `mode` to `"replace"` to use only your verbs, or `"append"` to add them to the defaults | `{"mode": "append", "verbs": ["Pondering", "Crafting"]}` |

204| `language` | Configure Claude's preferred response language (e.g., `"japanese"`, `"spanish"`, `"french"`). Claude will respond in this language by default. Also sets the [voice dictation](/en/voice-dictation#change-the-dictation-language) language | `"japanese"` |

205| `voiceEnabled` | Enable push-to-talk [voice dictation](/en/voice-dictation). Written automatically when you run `/voice`. Requires a Claude.ai account | `true` |

206| `autoUpdatesChannel` | Release channel to follow for updates. Use `"stable"` for a version that is typically about one week old and skips versions with major regressions, or `"latest"` (default) for the most recent release | `"stable"` |

207| `spinnerTipsEnabled` | Show tips in the spinner while Claude is working. Set to `false` to disable tips (default: `true`) | `false` |

208| `spinnerTipsOverride` | Override spinner tips with custom strings. `tips`: array of tip strings. `excludeDefault`: if `true`, only show custom tips; if `false` or absent, custom tips are merged with built-in tips | `{ "excludeDefault": true, "tips": ["Use our internal tool X"] }` |

209| `prefersReducedMotion` | Reduce or disable UI animations (spinners, shimmer, flash effects) for accessibility | `true` |

210| `fastModePerSessionOptIn` | When `true`, fast mode does not persist across sessions. Each session starts with fast mode off, requiring users to enable it with `/fast`. The user's fast mode preference is still saved. See [Require per-session opt-in](/en/fast-mode#require-per-session-opt-in) | `true` |

211| `teammateMode` | How [agent team](/en/agent-teams) teammates display: `auto` (picks split panes in tmux or iTerm2, in-process otherwise), `in-process`, or `tmux`. See [set up agent teams](/en/agent-teams#set-up-agent-teams) | `"in-process"` |

212| `feedbackSurveyRate` | Probability (0–1) that the [session quality survey](/en/data-usage#session-quality-surveys) appears when eligible. Set to `0` to suppress entirely. Useful when using Bedrock, Vertex, or Foundry where the default sample rate does not apply | `0.05` |

213

214### Global config settings

215

216These settings are stored in `~/.claude.json` rather than `settings.json`. Adding them to `settings.json` will trigger a schema validation error.

217

218| Key | Description | Example |

219| :--------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ |

220| `autoConnectIde` | Automatically connect to a running IDE when Claude Code starts from an external terminal. Default: `false`. Appears in `/config` as **Auto-connect to IDE (external terminal)** when running outside a VS Code or JetBrains terminal | `true` |

221| `autoInstallIdeExtension` | Automatically install the Claude Code IDE extension when running from a VS Code terminal. Default: `true`. Appears in `/config` as **Auto-install IDE extension** when running inside a VS Code or JetBrains terminal. You can also set the [`CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL`](/en/env-vars) environment variable | `false` |

222| `editorMode` | Key binding mode for the input prompt: `"normal"` or `"vim"`. Default: `"normal"`. Written automatically when you run `/vim`. Appears in `/config` as **Key binding mode** | `"vim"` |

223| `showTurnDuration` | Show turn duration messages after responses, e.g. "Cooked for 1m 6s". Default: `true`. Appears in `/config` as **Show turn duration** | `false` |

224| `terminalProgressBarEnabled` | Show the terminal progress bar in supported terminals: ConEmu, Ghostty 1.2.0+, and iTerm2 3.6.6+. Default: `true`. Appears in `/config` as **Terminal progress bar** | `false` |

225

226### Worktree settings

227

228Configure how `--worktree` creates and manages git worktrees. Use these settings to reduce disk usage and startup time in large monorepos.

229

230| Key | Description | Example |

231| :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------ |

232| `worktree.symlinkDirectories` | Directories to symlink from the main repository into each worktree to avoid duplicating large directories on disk. No directories are symlinked by default | `["node_modules", ".cache"]` |

233| `worktree.sparsePaths` | Directories to check out in each worktree via git sparse-checkout (cone mode). Only the listed paths are written to disk, which is faster in large monorepos | `["packages/my-app", "shared/utils"]` |

82 234

83### Permission settings235### Permission settings

84 236

86| :----------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------- |238| :----------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------- |

87| `allow` | Array of [permission rules](/en/iam#configuring-permissions) to allow tool use. **Note:** Bash rules use prefix matching, not regex | `[ "Bash(git diff:*)" ]` |239| `allow` | Array of permission rules to allow tool use. See [Permission rule syntax](#permission-rule-syntax) below for pattern matching details | `[ "Bash(git diff *)" ]` |

88| `ask` | Array of [permission rules](/en/iam#configuring-permissions) to ask for confirmation upon tool use. | `[ "Bash(git push:*)" ]` |240| `ask` | Array of permission rules to ask for confirmation upon tool use. See [Permission rule syntax](#permission-rule-syntax) below | `[ "Bash(git push *)" ]` |

89| `deny` | Array of [permission rules](/en/iam#configuring-permissions) to deny tool use. Use this to also exclude sensitive files from Claude Code access. **Note:** Bash patterns are prefix matches and can be bypassed (see [Bash permission limitations](/en/iam#tool-specific-permission-rules)) | `[ "WebFetch", "Bash(curl:*)", "Read(./.env)", "Read(./secrets/**)" ]` |241| `deny` | Array of permission rules to deny tool use. Use this to exclude sensitive files from Claude Code access. See [Permission rule syntax](#permission-rule-syntax) and [Bash permission limitations](/en/permissions#tool-specific-permission-rules) | `[ "WebFetch", "Bash(curl *)", "Read(./.env)", "Read(./secrets/**)" ]` |

92| `disableBypassPermissionsMode` | Set to `"disable"` to prevent `bypassPermissions` mode from being activated. This disables the `--dangerously-skip-permissions` command-line flag. See [managed policy settings](/en/iam#enterprise-managed-policy-settings) | `"disable"` |244| `disableBypassPermissionsMode` | Set to `"disable"` to prevent `bypassPermissions` mode from being activated. Disables the `--dangerously-skip-permissions` flag. Most useful in [managed settings](/en/permissions#managed-settings) where users cannot override it | `"disable"` |

245

246### Permission rule syntax

247

248Permission rules follow the format `Tool` or `Tool(specifier)`. Rules are evaluated in order: deny rules first, then ask, then allow. The first matching rule wins.

249

250Quick examples:

251

252| Rule | Effect |

253| :----------------------------- | :--------------------------------------- |

254| `Bash` | Matches all Bash commands |

255| `Bash(npm run *)` | Matches commands starting with `npm run` |

256| `Read(./.env)` | Matches reading the `.env` file |

257| `WebFetch(domain:example.com)` | Matches fetch requests to example.com |

258

259For the complete rule syntax reference, including wildcard behavior, tool-specific patterns for Read, Edit, WebFetch, MCP, and Agent rules, and security limitations of Bash patterns, see [Permission rule syntax](/en/permissions#permission-rule-syntax).

93 260

94### Sandbox settings261### Sandbox settings

95 262

96Configure advanced sandboxing behavior. Sandboxing isolates bash commands from your filesystem and network. See [Sandboxing](/en/sandboxing) for details.263Configure advanced sandboxing behavior. Sandboxing isolates bash commands from your filesystem and network. See [Sandboxing](/en/sandboxing) for details.

97 264

~~98**Filesystem and network restrictions** are configured via Read, Edit, and WebFetch permission rules, not via these sandbox settings.~~

101| :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------ |266| :------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------ |

268| `failIfUnavailable` | Exit with an error at startup if `sandbox.enabled` is true but the sandbox cannot start (missing dependencies, unsupported platform, or platform restrictions). When false (default), a warning is shown and commands run unsandboxed. Intended for managed settings deployments that require sandboxing as a hard gate | `true` |

105| `allowUnsandboxedCommands` | Allow commands to run outside the sandbox via the `dangerouslyDisableSandbox` parameter. When set to `false`, the `dangerouslyDisableSandbox` escape hatch is completely disabled and all commands must run sandboxed (or be in `excludedCommands`). Useful for enterprise policies that require strict sandboxing. Default: true | `false` |271| `allowUnsandboxedCommands` | Allow commands to run outside the sandbox via the `dangerouslyDisableSandbox` parameter. When set to `false`, the `dangerouslyDisableSandbox` escape hatch is completely disabled and all commands must run sandboxed (or be in `excludedCommands`). Useful for enterprise policies that require strict sandboxing. Default: true | `false` |

272| `filesystem.allowWrite` | Additional paths where sandboxed commands can write. Arrays are merged across all settings scopes: user, project, and managed paths are combined, not replaced. Also merged with paths from `Edit(...)` allow permission rules. See [path prefixes](#sandbox-path-prefixes) below. | `["/tmp/build", "~/.kube"]` |

273| `filesystem.denyWrite` | Paths where sandboxed commands cannot write. Arrays are merged across all settings scopes. Also merged with paths from `Edit(...)` deny permission rules. | `["/etc", "/usr/local/bin"]` |

274| `filesystem.denyRead` | Paths where sandboxed commands cannot read. Arrays are merged across all settings scopes. Also merged with paths from `Read(...)` deny permission rules. | `["~/.aws/credentials"]` |

275| `filesystem.allowRead` | Paths to re-allow reading within `denyRead` regions. Takes precedence over `denyRead`. Arrays are merged across all settings scopes. Use this to create workspace-only read access patterns. | `["."]` |

276| `filesystem.allowManagedReadPathsOnly` | (Managed settings only) Only `allowRead` paths from managed settings are respected. `allowRead` entries from user, project, and local settings are ignored. Default: false | `true` |

279| `network.allowLocalBinding` | Allow binding to localhost ports (macOS only). Default: false | `true` |

280| `network.allowedDomains` | Array of domains to allow for outbound network traffic. Supports wildcards (e.g., `*.example.com`). | `["github.com", "*.npmjs.org"]` |

281| `network.allowManagedDomainsOnly` | (Managed settings only) Only `allowedDomains` and `WebFetch(domain:...)` allow rules from managed settings are respected. Domains from user, project, and local settings are ignored. Non-allowed domains are blocked automatically without prompting the user. Denied domains are still respected from all sources. Default: false | `true` |

108| `network.httpProxyPort` | HTTP proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8080` |282| `network.httpProxyPort` | HTTP proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8080` |

109| `network.socksProxyPort` | SOCKS5 proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8081` |283| `network.socksProxyPort` | SOCKS5 proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8081` |

285| `enableWeakerNetworkIsolation` | (macOS only) Allow access to the system TLS trust service (`com.apple.trustd.agent`) in the sandbox. Required for Go-based tools like `gh`, `gcloud`, and `terraform` to verify TLS certificates when using `httpProxyPort` with a MITM proxy and custom CA. **Reduces security** by opening a potential data exfiltration path. Default: false | `true` |

286

287#### Sandbox path prefixes

288

289Paths in `filesystem.allowWrite`, `filesystem.denyWrite`, `filesystem.denyRead`, and `filesystem.allowRead` support these prefixes:

290

291| Prefix | Meaning | Example |

292| :---------------- | :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------ |

293| `/` | Absolute path from filesystem root | `/tmp/build` stays `/tmp/build` |

294| `~/` | Relative to home directory | `~/.kube` becomes `$HOME/.kube` |

295| `./` or no prefix | Relative to the project root for project settings, or to `~/.claude` for user settings | `./output` in `.claude/settings.json` resolves to `<project-root>/output` |

296

297The older `//path` prefix for absolute paths still works. If you previously used single-slash `/path` expecting project-relative resolution, switch to `./path`. This syntax differs from [Read and Edit permission rules](/en/permissions#read-and-edit), which use `//path` for absolute and `/path` for project-relative. Sandbox filesystem paths use standard conventions: `/tmp/build` is an absolute path.

111 298

112**Configuration example:**299**Configuration example:**

113 300

117 "enabled": true,304 "enabled": true,

118 "autoAllowBashIfSandboxed": true,305 "autoAllowBashIfSandboxed": true,

119 "excludedCommands": ["docker"],306 "excludedCommands": ["docker"],

307 "filesystem": {

308 "allowWrite": ["/tmp/build", "~/.kube"],

309 "denyRead": ["~/.aws/credentials"]

310 },

120 "network": {311 "network": {

312 "allowedDomains": ["github.com", "*.npmjs.org", "registry.yarnpkg.com"],

121 "allowUnixSockets": [313 "allowUnixSockets": [

122 "/var/run/docker.sock"314 "/var/run/docker.sock"

123 ],315 ],

124 "allowLocalBinding": true316 "allowLocalBinding": true

125 }317 }

126 },

127 "permissions": {

128 "deny": [

129 "Read(.envrc)",

130 "Read(~/.aws/**)"

131 ]

132 }318 }

133}319}

134```320```

135 321

136**Filesystem access** is controlled via Read/Edit permissions:322**Filesystem and network restrictions** can be configured in two ways that are merged together:

323

324* **`sandbox.filesystem` settings** (shown above): Control paths at the OS-level sandbox boundary. These restrictions apply to all subprocess commands (e.g., `kubectl`, `terraform`, `npm`), not just Claude's file tools.

325* **Permission rules**: Use `Edit` allow/deny rules to control Claude's file tool access, `Read` deny rules to block reads, and `WebFetch` allow/deny rules to control network domains. Paths from these rules are also merged into the sandbox configuration.

326

327### Attribution settings

328

329Claude Code adds attribution to git commits and pull requests. These are configured separately:

330

331* Commits use [git trailers](https://git-scm.com/docs/git-interpret-trailers) (like `Co-Authored-By`) by default, which can be customized or disabled

332* Pull request descriptions are plain text

333

334| Keys | Description |

335| :------- | :----------------------------------------------------------------------------------------- |

336| `commit` | Attribution for git commits, including any trailers. Empty string hides commit attribution |

337| `pr` | Attribution for pull request descriptions. Empty string hides pull request attribution |

338

339**Default commit attribution:**

340

341```text theme={null}

342🤖 Generated with [Claude Code](https://claude.com/claude-code)

343

344 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

345```

346

347**Default pull request attribution:**

348

349```text theme={null}

350🤖 Generated with [Claude Code](https://claude.com/claude-code)

351```

352

353**Example:**

354

355```json theme={null}

356{

357 "attribution": {

358 "commit": "Generated with AI\n\nCo-Authored-By: AI <ai@example.com>",

359 "pr": ""

360 }

361}

362```

363

364<Note>

365 The `attribution` setting takes precedence over the deprecated `includeCoAuthoredBy` setting. To hide all attribution, set `commit` and `pr` to empty strings.

366</Note>

367

368### File suggestion settings

369

370Configure a custom command for `@` file path autocomplete. The built-in file suggestion uses fast filesystem traversal, but large monorepos may benefit from project-specific indexing such as a pre-built file index or custom tooling.

371

372```json theme={null}

373{

374 "fileSuggestion": {

375 "type": "command",

376 "command": "~/.claude/file-suggestion.sh"

377 }

378}

379```

380

381The command runs with the same environment variables as [hooks](/en/hooks), including `CLAUDE_PROJECT_DIR`. It receives JSON via stdin with a `query` field:

382

383```json theme={null}

384{"query": "src/comp"}

385```

386

387Output newline-separated file paths to stdout (currently limited to 15):

388

389```text theme={null}

390src/components/Button.tsx

391src/components/Modal.tsx

392src/components/Form.tsx

393```

394

395**Example:**

396

397```bash theme={null}

398#!/bin/bash

399query=$(cat | jq -r '.query')

400your-repo-file-index --query "$query" | head -20

401```

402

403### Hook configuration

404

405These settings control which hooks are allowed to run and what HTTP hooks can access. The `allowManagedHooksOnly` setting can only be configured in [managed settings](#settings-files). The URL and env var allowlists can be set at any settings level and merge across sources.

406

407**Behavior when `allowManagedHooksOnly` is `true`:**

137 408

138* Read deny rules block file reads in sandbox409* Managed hooks and SDK hooks are loaded

139* Edit allow rules permit file writes (in addition to the defaults, e.g. the current working directory)410* User hooks, project hooks, and plugin hooks are blocked

140* Edit deny rules block writes within allowed paths

141 411

142**Network access** is controlled via WebFetch permissions:412**Restrict HTTP hook URLs:**

143 413

144* WebFetch allow rules permit network domains414Limit which URLs HTTP hooks can target. Supports `*` as a wildcard for matching. When the array is defined, HTTP hooks targeting non-matching URLs are silently blocked.

145* WebFetch deny rules block network domains415

416```json theme={null}

417{

418 "allowedHttpHookUrls": ["https://hooks.example.com/*", "http://localhost:*"]

419}

420```

421

422**Restrict HTTP hook environment variables:**

423

424Limit which environment variable names HTTP hooks can interpolate into header values. Each hook's effective `allowedEnvVars` is the intersection of its own list and this setting.

425

426```json theme={null}

427{

428 "httpHookAllowedEnvVars": ["MY_TOKEN", "HOOK_SECRET"]

429}

430```

146 431

147### Settings precedence432### Settings precedence

148 433

149Settings are applied in order of precedence (highest to lowest):434Settings apply in order of precedence. From highest to lowest:

150 435

1511. **Enterprise managed policies** (`managed-settings.json`)4361. **Managed settings** ([server-managed](/en/server-managed-settings), [MDM/OS-level policies](#configuration-scopes), or [managed settings](/en/settings#settings-files))

152 * Deployed by IT/DevOps437 * Policies deployed by IT through server delivery, MDM configuration profiles, registry policies, or managed settings files

153 * Cannot be overridden438 * Cannot be overridden by any other level, including command line arguments

439 * Within the managed tier, precedence is: server-managed > MDM/OS-level policies > file-based (`managed-settings.d/*.json` + `managed-settings.json`) > HKCU registry (Windows only). Only one managed source is used; sources do not merge across tiers. Within the file-based tier, drop-in files and the base file are merged together.

154 440

1552. **Command line arguments**4412. **Command line arguments**

156 * Temporary overrides for a specific session442 * Temporary overrides for a specific session

1645. **User settings** (`~/.claude/settings.json`)4505. **User settings** (`~/.claude/settings.json`)

165 * Personal global settings451 * Personal global settings

166 452

167This hierarchy ensures that enterprise security policies are always enforced while still allowing teams and individuals to customize their experience.453This hierarchy ensures that organizational policies are always enforced while still allowing teams and individuals to customize their experience. The same precedence applies whether you run Claude Code from the CLI, the [VS Code extension](/en/vs-code), or a [JetBrains IDE](/en/jetbrains).

454

455For example, if your user settings allow `Bash(npm run *)` but a project's shared settings deny it, the project setting takes precedence and the command is blocked.

456

457<Note>

458 **Array settings merge across scopes.** When the same array-valued setting (such as `sandbox.filesystem.allowWrite` or `permissions.allow`) appears in multiple scopes, the arrays are **concatenated and deduplicated**, not replaced. This means lower-priority scopes can add entries without overriding those set by higher-priority scopes, and vice versa. For example, if managed settings set `allowWrite` to `["/opt/company-tools"]` and a user adds `["~/.kube"]`, both paths are included in the final configuration.

459</Note>

460

461### Verify active settings

462

463Run `/status` inside Claude Code to see which settings sources are active and where they come from. The output shows each configuration layer (managed, user, project) along with its origin, such as `Enterprise managed settings (remote)`, `Enterprise managed settings (plist)`, `Enterprise managed settings (HKLM)`, or `Enterprise managed settings (file)`. If a settings file contains errors, `/status` reports the issue so you can fix it.

168 464

169### Key points about the configuration system465### Key points about the configuration system

170 466

171* **Memory files (CLAUDE.md)**: Contain instructions and context that Claude loads at startup467* **Memory files (`CLAUDE.md`)**: Contain instructions and context that Claude loads at startup

172* **Settings files (JSON)**: Configure permissions, environment variables, and tool behavior468* **Settings files (JSON)**: Configure permissions, environment variables, and tool behavior

173* **Slash commands**: Custom commands that can be invoked during a session with `/command-name`469* **Skills**: Custom prompts that can be invoked with `/skill-name` or loaded by Claude automatically

174* **MCP servers**: Extend Claude Code with additional tools and integrations470* **MCP servers**: Extend Claude Code with additional tools and integrations

175* **Precedence**: Higher-level configurations (Enterprise) override lower-level ones (User/Project)471* **Precedence**: Higher-level configurations (Managed) override lower-level ones (User/Project)

176* **Inheritance**: Settings are merged, with more specific settings adding to or overriding broader ones472* **Inheritance**: Settings are merged, with more specific settings adding to or overriding broader ones

177 473

178### System prompt availability474### System prompt

179 475

180<Note>476Claude Code's internal system prompt is not published. To add custom instructions, use `CLAUDE.md` files or the `--append-system-prompt` flag.

181 Unlike for claude.ai, we do not publish Claude Code's internal system prompt on this website. Use CLAUDE.md files or `--append-system-prompt` to add custom instructions to Claude Code's behavior.

182</Note>

183 477

184### Excluding sensitive files478### Excluding sensitive files

185 479

186To prevent Claude Code from accessing files containing sensitive information (e.g., API keys, secrets, environment files), use the `permissions.deny` setting in your `.claude/settings.json` file:480To prevent Claude Code from accessing files containing sensitive information like API keys, secrets, and environment files, use the `permissions.deny` setting in your `.claude/settings.json` file:

187 481

188```json theme={null}482```json theme={null}

189{483{

199}493}

200```494```

201 495

202This replaces the deprecated `ignorePatterns` configuration. Files matching these patterns will be completely invisible to Claude Code, preventing any accidental exposure of sensitive data.496This replaces the deprecated `ignorePatterns` configuration. Files matching these patterns are excluded from file discovery and search results, and read operations on these files are denied.

203 497

204## Subagent configuration498## Subagent configuration

205 499

212 506

213## Plugin configuration507## Plugin configuration

214 508

215Claude Code supports a plugin system that lets you extend functionality with custom commands, agents, hooks, and MCP servers. Plugins are distributed through marketplaces and can be configured at both user and repository levels.509Claude Code supports a plugin system that lets you extend functionality with skills, agents, hooks, and MCP servers. Plugins are distributed through marketplaces and can be configured at both user and repository levels.

216 510

217### Plugin settings511### Plugin settings

218 512

221```json theme={null}515```json theme={null}

222{516{

223 "enabledPlugins": {517 "enabledPlugins": {

224 "formatter@company-tools": true,518 "formatter@acme-tools": true,

225 "deployer@company-tools": true,519 "deployer@acme-tools": true,

226 "analyzer@security-plugins": false520 "analyzer@security-plugins": false

227 },521 },

228 "extraKnownMarketplaces": {522 "extraKnownMarketplaces": {

229 "company-tools": {523 "acme-tools": {

230 "source": "github",524 "source": "github",

231 "repo": "company/claude-plugins"525 "repo": "acme-corp/claude-plugins"

232 }526 }

233 }527 }

234}528}

272```json theme={null}566```json theme={null}

273{567{

274 "extraKnownMarketplaces": {568 "extraKnownMarketplaces": {

275 "company-tools": {569 "acme-tools": {

276 "source": {570 "source": {

277 "source": "github",571 "source": "github",

278 "repo": "company-org/claude-plugins"572 "repo": "acme-corp/claude-plugins"

279 }573 }

280 },574 },

281 "security-plugins": {575 "security-plugins": {

282 "source": {576 "source": {

283 "source": "git",577 "source": "git",

284 "url": "https://git.company.com/security/plugins.git"578 "url": "https://git.example.com/security/plugins.git"

285 }579 }

286 }580 }

287 }581 }

293* `github`: GitHub repository (uses `repo`)587* `github`: GitHub repository (uses `repo`)

294* `git`: Any git URL (uses `url`)588* `git`: Any git URL (uses `url`)

295* `directory`: Local filesystem path (uses `path`, for development only)589* `directory`: Local filesystem path (uses `path`, for development only)

590* `hostPattern`: regex pattern to match marketplace hosts (uses `hostPattern`)

591* `settings`: inline marketplace declared directly in settings.json without a separate hosted repository (uses `name` and `plugins`)

592

593Use `source: 'settings'` to declare a small set of plugins inline without setting up a hosted marketplace repository. Plugins listed here must reference external sources such as GitHub or npm. You still need to enable each plugin separately in `enabledPlugins`.

594

595```json theme={null}

596{

597 "extraKnownMarketplaces": {

598 "team-tools": {

599 "source": {

600 "source": "settings",

601 "name": "team-tools",

602 "plugins": [

603 {

604 "name": "code-formatter",

605 "source": {

606 "source": "github",

607 "repo": "acme-corp/code-formatter"

608 }

609 }

610 ]

611 }

612 }

613 }

614}

615```

616

617#### `strictKnownMarketplaces`

618

619**Managed settings only**: Controls which plugin marketplaces users are allowed to add. This setting can only be configured in [managed settings](/en/settings#settings-files) and provides administrators with strict control over marketplace sources.

620

621**Managed settings file locations**:

622

623* **macOS**: `/Library/Application Support/ClaudeCode/managed-settings.json`

624* **Linux and WSL**: `/etc/claude-code/managed-settings.json`

625* **Windows**: `C:\Program Files\ClaudeCode\managed-settings.json`

626

627**Key characteristics**:

628

629* Only available in managed settings (`managed-settings.json`)

630* Cannot be overridden by user or project settings (highest precedence)

631* Enforced BEFORE network/filesystem operations (blocked sources never execute)

632* Uses exact matching for source specifications (including `ref`, `path` for git sources), except `hostPattern`, which uses regex matching

633

634**Allowlist behavior**:

635

636* `undefined` (default): No restrictions - users can add any marketplace

637* Empty array `[]`: Complete lockdown - users cannot add any new marketplaces

638* List of sources: Users can only add marketplaces that match exactly

639

640**All supported source types**:

641

642The allowlist supports multiple marketplace source types. Most sources use exact matching, while `hostPattern` uses regex matching against the marketplace host.

643

6441. **GitHub repositories**:

645

646```json theme={null}

647{ "source": "github", "repo": "acme-corp/approved-plugins" }

648{ "source": "github", "repo": "acme-corp/security-tools", "ref": "v2.0" }

649{ "source": "github", "repo": "acme-corp/plugins", "ref": "main", "path": "marketplace" }

650```

651

652Fields: `repo` (required), `ref` (optional: branch/tag/SHA), `path` (optional: subdirectory)

653

6542. **Git repositories**:

655

656```json theme={null}

657{ "source": "git", "url": "https://gitlab.example.com/tools/plugins.git" }

658{ "source": "git", "url": "https://bitbucket.org/acme-corp/plugins.git", "ref": "production" }

659{ "source": "git", "url": "ssh://git@git.example.com/plugins.git", "ref": "v3.1", "path": "approved" }

660```

661

662Fields: `url` (required), `ref` (optional: branch/tag/SHA), `path` (optional: subdirectory)

663

6643. **URL-based marketplaces**:

665

666```json theme={null}

667{ "source": "url", "url": "https://plugins.example.com/marketplace.json" }

668{ "source": "url", "url": "https://cdn.example.com/marketplace.json", "headers": { "Authorization": "Bearer ${TOKEN}" } }

669```

670

671Fields: `url` (required), `headers` (optional: HTTP headers for authenticated access)

672

673<Note>

674 URL-based marketplaces only download the `marketplace.json` file. They do not download plugin files from the server. Plugins in URL-based marketplaces must use external sources (GitHub, npm, or git URLs) rather than relative paths. For plugins with relative paths, use a Git-based marketplace instead. See [Troubleshooting](/en/plugin-marketplaces#plugins-with-relative-paths-fail-in-url-based-marketplaces) for details.

675</Note>

676

6774. **NPM packages**:

678

679```json theme={null}

680{ "source": "npm", "package": "@acme-corp/claude-plugins" }

681{ "source": "npm", "package": "@acme-corp/approved-marketplace" }

682```

683

684Fields: `package` (required, supports scoped packages)

685

6865. **File paths**:

687

688```json theme={null}

689{ "source": "file", "path": "/usr/local/share/claude/acme-marketplace.json" }

690{ "source": "file", "path": "/opt/acme-corp/plugins/marketplace.json" }

691```

692

693Fields: `path` (required: absolute path to marketplace.json file)

694

6956. **Directory paths**:

696

697```json theme={null}

698{ "source": "directory", "path": "/usr/local/share/claude/acme-plugins" }

699{ "source": "directory", "path": "/opt/acme-corp/approved-marketplaces" }

700```

701

702Fields: `path` (required: absolute path to directory containing `.claude-plugin/marketplace.json`)

703

7047. **Host pattern matching**:

705

706```json theme={null}

707{ "source": "hostPattern", "hostPattern": "^github\\.example\\.com$" }

708{ "source": "hostPattern", "hostPattern": "^gitlab\\.internal\\.example\\.com$" }

709```

710

711Fields: `hostPattern` (required: regex pattern to match against the marketplace host)

712

713Use host pattern matching when you want to allow all marketplaces from a specific host without enumerating each repository individually. This is useful for organizations with internal GitHub Enterprise or GitLab servers where developers create their own marketplaces.

714

715Host extraction by source type:

716

717* `github`: always matches against `github.com`

718* `git`: extracts hostname from the URL (supports both HTTPS and SSH formats)

719* `url`: extracts hostname from the URL

720* `npm`, `file`, `directory`: not supported for host pattern matching

721

722**Configuration examples**:

723

724Example: allow specific marketplaces only:

725

726```json theme={null}

727{

728 "strictKnownMarketplaces": [

729 {

730 "source": "github",

731 "repo": "acme-corp/approved-plugins"

732 },

733 {

734 "source": "github",

735 "repo": "acme-corp/security-tools",

736 "ref": "v2.0"

737 },

738 {

739 "source": "url",

740 "url": "https://plugins.example.com/marketplace.json"

741 },

742 {

743 "source": "npm",

744 "package": "@acme-corp/compliance-plugins"

745 }

746 ]

747}

748```

749

750Example - Disable all marketplace additions:

751

752```json theme={null}

753{

754 "strictKnownMarketplaces": []

755}

756```

757

758Example: allow all marketplaces from an internal git server:

759

760```json theme={null}

761{

762 "strictKnownMarketplaces": [

763 {

764 "source": "hostPattern",

765 "hostPattern": "^github\\.example\\.com$"

766 }

767 ]

768}

769```

770

771**Exact matching requirements**:

772

773Marketplace sources must match **exactly** for a user's addition to be allowed. For git-based sources (`github` and `git`), this includes all optional fields:

774

775* The `repo` or `url` must match exactly

776* The `ref` field must match exactly (or both be undefined)

777* The `path` field must match exactly (or both be undefined)

778

779Examples of sources that **do NOT match**:

780

781```json theme={null}

782// These are DIFFERENT sources:

783{ "source": "github", "repo": "acme-corp/plugins" }

784{ "source": "github", "repo": "acme-corp/plugins", "ref": "main" }

785

786// These are also DIFFERENT:

787{ "source": "github", "repo": "acme-corp/plugins", "path": "marketplace" }

788{ "source": "github", "repo": "acme-corp/plugins" }

789```

790

791**Comparison with `extraKnownMarketplaces`**:

792

793| Aspect | `strictKnownMarketplaces` | `extraKnownMarketplaces` |

794| --------------------- | ------------------------------------ | ------------------------------------ |

795| **Purpose** | Organizational policy enforcement | Team convenience |

796| **Settings file** | `managed-settings.json` only | Any settings file |

797| **Behavior** | Blocks non-allowlisted additions | Auto-installs missing marketplaces |

798| **When enforced** | Before network/filesystem operations | After user trust prompt |

799| **Can be overridden** | No (highest precedence) | Yes (by higher precedence settings) |

800| **Source format** | Direct source object | Named marketplace with nested source |

801| **Use case** | Compliance, security restrictions | Onboarding, standardization |

802

803**Format difference**:

804

805`strictKnownMarketplaces` uses direct source objects:

806

807```json theme={null}

808{

809 "strictKnownMarketplaces": [

810 { "source": "github", "repo": "acme-corp/plugins" }

811 ]

812}

813```

814

815`extraKnownMarketplaces` requires named marketplaces:

816

817```json theme={null}

818{

819 "extraKnownMarketplaces": {

820 "acme-tools": {

821 "source": { "source": "github", "repo": "acme-corp/plugins" }

822 }

823 }

824}

825```

826

827**Using both together**:

828

829`strictKnownMarketplaces` is a policy gate: it controls what users may add but does not register any marketplaces. To both restrict and pre-register a marketplace for all users, set both in `managed-settings.json`:

830

831```json theme={null}

832{

833 "strictKnownMarketplaces": [

834 { "source": "github", "repo": "acme-corp/plugins" }

835 ],

836 "extraKnownMarketplaces": {

837 "acme-tools": {

838 "source": { "source": "github", "repo": "acme-corp/plugins" }

839 }

840 }

841}

842```

843

844With only `strictKnownMarketplaces` set, users can still add the allowed marketplace manually via `/plugin marketplace add`, but it is not available automatically.

845

846**Important notes**:

847

848* Restrictions are checked BEFORE any network requests or filesystem operations

849* When blocked, users see clear error messages indicating the source is blocked by managed policy

850* The restriction applies only to adding NEW marketplaces; previously installed marketplaces remain accessible

851* Managed settings have the highest precedence and cannot be overridden

852

853See [Managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions) for user-facing documentation.

296 854

297### Managing plugins855### Managing plugins

298 856

308 866

309## Environment variables867## Environment variables

310 868

311Claude Code supports the following environment variables to control its behavior:869Environment variables let you control Claude Code behavior without editing settings files. Any variable can also be configured in [`settings.json`](#available-settings) under the `env` key to apply it to every session or roll it out to your team.

312 870

313<Note>871See the [environment variables reference](/en/env-vars) for the full list.

314 All environment variables can also be configured in [`settings.json`](#available-settings). This is useful as a way to automatically set environment variables for each session, or to roll out a set of environment variables for your whole team or organization.

315</Note>

~~316~~

317| Variable | Purpose |

318| :----------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

319| `ANTHROPIC_API_KEY` | API key sent as `X-Api-Key` header, typically for the Claude SDK (for interactive usage, run `/login`) |

320| `ANTHROPIC_AUTH_TOKEN` | Custom value for the `Authorization` header (the value you set here will be prefixed with `Bearer `) |

321| `ANTHROPIC_CUSTOM_HEADERS` | Custom headers you want to add to the request (in `Name: Value` format) |

322| `ANTHROPIC_DEFAULT_HAIKU_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

323| `ANTHROPIC_DEFAULT_OPUS_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

324| `ANTHROPIC_DEFAULT_SONNET_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

325| `ANTHROPIC_FOUNDRY_API_KEY` | API key for Microsoft Foundry authentication (see [Microsoft Foundry](/en/microsoft-foundry)) |

326| `ANTHROPIC_MODEL` | Name of the model setting to use (see [Model Configuration](/en/model-config#environment-variables)) |

327| `ANTHROPIC_SMALL_FAST_MODEL` | \[DEPRECATED] Name of [Haiku-class model for background tasks](/en/costs) |

328| `ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION` | Override AWS region for the Haiku-class model when using Bedrock |

329| `AWS_BEARER_TOKEN_BEDROCK` | Bedrock API key for authentication (see [Bedrock API keys](https://aws.amazon.com/blogs/machine-learning/accelerate-ai-development-with-amazon-bedrock-api-keys/)) |

330| `BASH_DEFAULT_TIMEOUT_MS` | Default timeout for long-running bash commands |

331| `BASH_MAX_OUTPUT_LENGTH` | Maximum number of characters in bash outputs before they are middle-truncated |

332| `BASH_MAX_TIMEOUT_MS` | Maximum timeout the model can set for long-running bash commands |

333| `CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR` | Return to the original working directory after each Bash command |

334| `CLAUDE_CODE_API_KEY_HELPER_TTL_MS` | Interval in milliseconds at which credentials should be refreshed (when using `apiKeyHelper`) |

335| `CLAUDE_CODE_CLIENT_CERT` | Path to client certificate file for mTLS authentication |

336| `CLAUDE_CODE_CLIENT_KEY_PASSPHRASE` | Passphrase for encrypted CLAUDE\_CODE\_CLIENT\_KEY (optional) |

337| `CLAUDE_CODE_CLIENT_KEY` | Path to client private key file for mTLS authentication |

338| `CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS` | Set to `1` to disable Anthropic API-specific `anthropic-beta` headers. Use this if experiencing issues like "Unexpected value(s) for the `anthropic-beta` header" when using an LLM gateway with third-party providers |

339| `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | Equivalent of setting `DISABLE_AUTOUPDATER`, `DISABLE_BUG_COMMAND`, `DISABLE_ERROR_REPORTING`, and `DISABLE_TELEMETRY` |

340| `CLAUDE_CODE_DISABLE_TERMINAL_TITLE` | Set to `1` to disable automatic terminal title updates based on conversation context |

341| `CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL` | Skip auto-installation of IDE extensions |

342| `CLAUDE_CODE_MAX_OUTPUT_TOKENS` | Set the maximum number of output tokens for most requests |

343| `CLAUDE_CODE_SKIP_BEDROCK_AUTH` | Skip AWS authentication for Bedrock (e.g. when using an LLM gateway) |

344| `CLAUDE_CODE_SKIP_FOUNDRY_AUTH` | Skip Azure authentication for Microsoft Foundry (e.g. when using an LLM gateway) |

345| `CLAUDE_CODE_SKIP_VERTEX_AUTH` | Skip Google authentication for Vertex (e.g. when using an LLM gateway) |

346| `CLAUDE_CODE_SUBAGENT_MODEL` | See [Model configuration](/en/model-config) |

347| `CLAUDE_CODE_USE_BEDROCK` | Use [Bedrock](/en/amazon-bedrock) |

348| `CLAUDE_CODE_USE_FOUNDRY` | Use [Microsoft Foundry](/en/microsoft-foundry) |

349| `CLAUDE_CODE_USE_VERTEX` | Use [Vertex](/en/google-vertex-ai) |

350| `DISABLE_AUTOUPDATER` | Set to `1` to disable automatic updates. |

351| `DISABLE_BUG_COMMAND` | Set to `1` to disable the `/bug` command |

352| `DISABLE_COST_WARNINGS` | Set to `1` to disable cost warning messages |

353| `DISABLE_ERROR_REPORTING` | Set to `1` to opt out of Sentry error reporting |

354| `DISABLE_NON_ESSENTIAL_MODEL_CALLS` | Set to `1` to disable model calls for non-critical paths like flavor text |

355| `DISABLE_PROMPT_CACHING` | Set to `1` to disable prompt caching for all models (takes precedence over per-model settings) |

356| `DISABLE_PROMPT_CACHING_HAIKU` | Set to `1` to disable prompt caching for Haiku models |

357| `DISABLE_PROMPT_CACHING_OPUS` | Set to `1` to disable prompt caching for Opus models |

358| `DISABLE_PROMPT_CACHING_SONNET` | Set to `1` to disable prompt caching for Sonnet models |

359| `DISABLE_TELEMETRY` | Set to `1` to opt out of Statsig telemetry (note that Statsig events do not include user data like code, file paths, or bash commands) |

360| `HTTP_PROXY` | Specify HTTP proxy server for network connections |

361| `HTTPS_PROXY` | Specify HTTPS proxy server for network connections |

362| `MAX_MCP_OUTPUT_TOKENS` | Maximum number of tokens allowed in MCP tool responses. Claude Code displays a warning when output exceeds 10,000 tokens (default: 25000) |

363| `MAX_THINKING_TOKENS` | Enable [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) and set the token budget for the thinking process. Extended thinking improves performance on complex reasoning and coding tasks but impacts [prompt caching efficiency](https://docs.claude.com/en/docs/build-with-claude/prompt-caching#caching-with-thinking-blocks). Disabled by default. |

364| `MCP_TIMEOUT` | Timeout in milliseconds for MCP server startup |

365| `MCP_TOOL_TIMEOUT` | Timeout in milliseconds for MCP tool execution |

366| `NO_PROXY` | List of domains and IPs to which requests will be directly issued, bypassing proxy |

367| `SLASH_COMMAND_TOOL_CHAR_BUDGET` | Maximum number of characters for slash command metadata shown to [SlashCommand tool](/en/slash-commands#slashcommand-tool) (default: 15000) |

368| `USE_BUILTIN_RIPGREP` | Set to `0` to use system-installed `rg` intead of `rg` included with Claude Code |

369| `VERTEX_REGION_CLAUDE_3_5_HAIKU` | Override region for Claude 3.5 Haiku when using Vertex AI |

370| `VERTEX_REGION_CLAUDE_3_7_SONNET` | Override region for Claude 3.7 Sonnet when using Vertex AI |

371| `VERTEX_REGION_CLAUDE_4_0_OPUS` | Override region for Claude 4.0 Opus when using Vertex AI |

372| `VERTEX_REGION_CLAUDE_4_0_SONNET` | Override region for Claude 4.0 Sonnet when using Vertex AI |

373| `VERTEX_REGION_CLAUDE_4_1_OPUS` | Override region for Claude 4.1 Opus when using Vertex AI |

374 872

375## Tools available to Claude873## Tools available to Claude

376 874

377Claude Code has access to a set of powerful tools that help it understand and modify your codebase:875Claude Code has access to a set of tools for reading, editing, searching, running commands, and orchestrating subagents. Tool names are the exact strings you use in permission rules and hook matchers.

~~378~~ 876

379| Tool | Description | Permission Required |877See the [tools reference](/en/tools-reference) for the full list and Bash tool behavior details.

380| :------------------ | :--------------------------------------------------------------------------------- | :------------------ |

381| **AskUserQuestion** | Asks the user multiple choice questions to gather information or clarify ambiguity | No |

382| **Bash** | Executes shell commands in your environment | Yes |

383| **BashOutput** | Retrieves output from a background bash shell | No |

384| **Edit** | Makes targeted edits to specific files | Yes |

385| **ExitPlanMode** | Prompts the user to exit plan mode and start coding | Yes |

386| **Glob** | Finds files based on pattern matching | No |

387| **Grep** | Searches for patterns in file contents | No |

388| **KillShell** | Kills a running background bash shell by its ID | No |

389| **NotebookEdit** | Modifies Jupyter notebook cells | Yes |

390| **Read** | Reads the contents of files | No |

391| **Skill** | Executes a skill within the main conversation | Yes |

392| **SlashCommand** | Runs a [custom slash command](/en/slash-commands#slashcommand-tool) | Yes |

393| **Task** | Runs a sub-agent to handle complex, multi-step tasks | No |

394| **TodoWrite** | Creates and manages structured task lists | No |

395| **WebFetch** | Fetches content from a specified URL | Yes |

396| **WebSearch** | Performs web searches with domain filtering | Yes |

397| **Write** | Creates or overwrites files | Yes |

~~398~~

399Permission rules can be configured using `/allowed-tools` or in [permission settings](/en/settings#available-settings). Also see [Tool-specific permission rules](/en/iam#tool-specific-permission-rules).

~~400~~

401### Extending tools with hooks

~~402~~

403You can run custom commands before or after any tool executes using

404[Claude Code hooks](/en/hooks-guide).

~~405~~

406For example, you could automatically run a Python formatter after Claude

407modifies Python files, or prevent modifications to production configuration

408files by blocking Write operations to certain paths.

409 878

410## See also879## See also

411 880

412* [Identity and Access Management](/en/iam#configuring-permissions) - Learn about Claude Code's permission system881* [Permissions](/en/permissions): permission system, rule syntax, tool-specific patterns, and managed policies

413* [IAM and access control](/en/iam#enterprise-managed-policy-settings) - Enterprise policy management882* [Authentication](/en/authentication): set up user access to Claude Code

414* [Troubleshooting](/en/troubleshooting#auto-updater-issues) - Solutions for common configuration issues883* [Troubleshooting](/en/troubleshooting): solutions for common configuration issues

setup.md +297 −114

Details

~~1# Set up Claude Code~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Install, authenticate, and start using Claude Code on your development machine.~~5# Advanced setup

7> System requirements, platform-specific installation, version management, and uninstallation for Claude Code.

9This page covers system requirements, platform-specific installation details, updates, and uninstallation. For a guided walkthrough of your first session, see the [quickstart](/en/quickstart). If you've never used a terminal before, see the [terminal guide](/en/terminal-guide).

4 10

5## System requirements11## System requirements

6 12

~~7* **Operating Systems**: macOS 10.15+, Ubuntu 20.04+/Debian 10+, or Windows 10+ (with WSL 1, WSL 2, or Git for Windows)~~13Claude Code runs on the following platforms and configurations:

~~8* **Hardware**: 4GB+ RAM~~14

~~9* **Software**: [Node.js 18+](https://nodejs.org/en/download) (only required for NPM installation)~~15* **Operating system**:

~~10* **Network**: Internet connection required for authentication and AI processing~~16 * macOS 13.0+

~~11* **Shell**: Works best in Bash, Zsh or Fish~~17 * Windows 10 1809+ or Windows Server 2019+

18 * Ubuntu 20.04+

19 * Debian 10+

20 * Alpine Linux 3.19+

21* **Hardware**: 4 GB+ RAM

22* **Network**: internet connection required. See [network configuration](/en/network-config#network-access-requirements).

23* **Shell**: Bash, Zsh, PowerShell, or CMD. On Windows, [Git for Windows](https://git-scm.com/downloads/win) is required.

12* **Location**: [Anthropic supported countries](https://www.anthropic.com/supported-countries)24* **Location**: [Anthropic supported countries](https://www.anthropic.com/supported-countries)

13 25

14### Additional dependencies26### Additional dependencies

15 27

~~16* **ripgrep**: Usually included with Claude Code. If search functionality fails, see [search troubleshooting](/en/troubleshooting#search-and-discovery-issues).~~28* **ripgrep**: usually included with Claude Code. If search fails, see [search troubleshooting](/en/troubleshooting#search-and-discovery-issues).

30## Install Claude Code

32<Tip>

33 Prefer a graphical interface? The [Desktop app](/en/desktop-quickstart) lets you use Claude Code without the terminal. Download it for [macOS](https://claude.ai/api/desktop/darwin/universal/dmg/latest/redirect?utm_source=claude_code\&utm_medium=docs) or [Windows](https://claude.ai/api/desktop/win32/x64/exe/latest/redirect?utm_source=claude_code\&utm_medium=docs).

17 34

~~18## Standard installation~~35 New to the terminal? See the [terminal guide](/en/terminal-guide) for step-by-step instructions.

36</Tip>

19 37

20To install Claude Code, use one of the following methods:38To install Claude Code, use one of the following methods:

21 39

22<Tabs>40<Tabs>

23 <Tab title="Native Install (Recommended)">41 <Tab title="Native Install (Recommended)">

~~24 **Homebrew (macOS, Linux):**~~

~~26 ```sh theme={null}~~

~~27 brew install --cask claude-code~~

~~28 ```~~

30 **macOS, Linux, WSL:**42 **macOS, Linux, WSL:**

31 43

32 ```bash theme={null}44 ```bash theme={null}

44 ```batch theme={null}56 ```batch theme={null}

45 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd57 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

46 ```58 ```

60 **Windows requires [Git for Windows](https://git-scm.com/downloads/win).** Install it first if you don't have it.

62 <Info>

63 Native installations automatically update in the background to keep you on the latest version.

64 </Info>

47 </Tab>65 </Tab>

48 66

~~49 <Tab title="NPM">~~67 <Tab title="Homebrew">

~~50 If you have [Node.js 18 or newer installed](https://nodejs.org/en/download/):~~68 ```bash theme={null}

69 brew install --cask claude-code

70 ```

72 <Info>

73 Homebrew installations do not auto-update. Run `brew upgrade claude-code` periodically to get the latest features and security fixes.

74 </Info>

75 </Tab>

51 76

~~52 ```sh theme={null}~~77 <Tab title="WinGet">

~~53 npm install -g @anthropic-ai/claude-code~~78 ```powershell theme={null}

79 winget install Anthropic.ClaudeCode

54 ```80 ```

82 <Info>

83 WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.

84 </Info>

55 </Tab>85 </Tab>

56</Tabs>86</Tabs>

57 87

~~58<Note>~~88After installation completes, open a terminal in the project you want to work in and start Claude Code:

~~59 Some users may be automatically migrated to an improved installation method.~~

~~60</Note>~~

~~62After the installation process completes, navigate to your project and start Claude Code:~~

63 89

64```bash theme={null}90```bash theme={null}

~~65cd your-awesome-project~~

66claude91claude

67```92```

68 93

~~69Claude Code offers the following authentication options:~~94If you encounter any issues during installation, see the [troubleshooting guide](/en/troubleshooting).

711. **Claude Console**: The default option. Connect through the Claude Console and complete the OAuth process. Requires active billing at [console.anthropic.com](https://console.anthropic.com). A "Claude Code" workspace will be automatically created for usage tracking and cost management. Note that you cannot create API keys for the Claude Code workspace - it is dedicated exclusively for Claude Code usage.

722. **Claude App (with Pro or Max plan)**: Subscribe to Claude's [Pro or Max plan](https://claude.com/pricing) for a unified subscription that includes both Claude Code and the web interface. Get more value at the same price point while managing your account in one place. Log in with your Claude.ai account. During launch, choose the option that matches your subscription type.

733. **Enterprise platforms**: Configure Claude Code to use [Amazon Bedrock, Google Vertex AI, or Microsoft Foundry](/en/third-party-integrations) for enterprise deployments with your existing cloud infrastructure.

74 95

~~75<Note>~~96### Set up on Windows

~~76 Claude Code securely stores your credentials. See [Credential Management](/en/iam#credential-management) for details.~~

~~77</Note>~~

78 97

~~79## Windows setup~~98Claude Code on Windows requires [Git for Windows](https://git-scm.com/downloads/win) or WSL. You can launch `claude` from PowerShell, CMD, or Git Bash. Claude Code uses Git Bash internally to run commands. You do not need to run PowerShell as Administrator.

80 99

~~81**Option 1: Claude Code within WSL**~~100**Option 1: Native Windows with Git Bash**

82 101

~~83* Both WSL 1 and WSL 2 are supported~~102Install [Git for Windows](https://git-scm.com/downloads/win), then run the install command from PowerShell or CMD.

84 103

~~85**Option 2: Claude Code on native Windows with Git Bash**~~104If Claude Code can't find your Git Bash installation, set the path in your [settings.json file](/en/settings):

86 105

~~87* Requires [Git for Windows](https://git-scm.com/downloads/win)~~106```json theme={null}

~~88* For portable Git installations, specify the path to your `bash.exe`:~~107{

~~89 ```powershell theme={null}~~108 "env": {

~~90 $env:CLAUDE_CODE_GIT_BASH_PATH="C:\Program Files\Git\bin\bash.exe"~~109 "CLAUDE_CODE_GIT_BASH_PATH": "C:\\Program Files\\Git\\bin\\bash.exe"

~~91 ```~~110 }

111}

112```

92 113

~~93## Alternative installation methods~~114**Option 2: WSL**

94 115

~~95Claude Code offers multiple installation methods to suit different environments.~~116Both WSL 1 and WSL 2 are supported. WSL 2 supports [sandboxing](/en/sandboxing) for enhanced security. WSL 1 does not support sandboxing.

96 117

~~97If you encounter any issues during installation, consult the [troubleshooting guide](/en/troubleshooting#linux-permission-issues).~~118### Alpine Linux and musl-based distributions

98 119

~~99<Tip>~~120The native installer on Alpine and other musl/uClibc-based distributions requires `libgcc`, `libstdc++`, and `ripgrep`. Install these using your distribution's package manager, then set `USE_BUILTIN_RIPGREP=0`.

100 Run `claude doctor` after installation to check your installation type and version.

101</Tip>

102 121

103### Native installation options122This example installs the required packages on Alpine:

104 123

105The native installation is the recommended method and offers several benefits:124```bash theme={null}

125apk add libgcc libstdc++ ripgrep

126```

106 127

107* One self-contained executable128Then set `USE_BUILTIN_RIPGREP` to `0` in your [`settings.json`](/en/settings#available-settings) file:

108* No Node.js dependency

109* Improved auto-updater stability

110 129

111If you have an existing installation of Claude Code, use `claude install` to migrate to the native binary installation.130```json theme={null}

131{

132 "env": {

133 "USE_BUILTIN_RIPGREP": "0"

134 }

135}

136```

112 137

113For advanced installation options with the native installer:138## Verify your installation

114 139

115**macOS, Linux, WSL:**140After installing, confirm Claude Code is working:

116 141

117```bash theme={null}142```bash theme={null}

118# Install stable version (default)143claude --version

119curl -fsSL https://claude.ai/install.sh | bash144```

120 145

121# Install latest version146For a more detailed check of your installation and configuration, run [`claude doctor`](/en/troubleshooting#get-more-help):

122curl -fsSL https://claude.ai/install.sh | bash -s latest

123 147

124# Install specific version number148```bash theme={null}

125curl -fsSL https://claude.ai/install.sh | bash -s 1.0.58149claude doctor

126```150```

127 151

128<Note>152## Authenticate

129 **Alpine Linux and other musl/uClibc-based distributions**: The native build requires you to install `libgcc`, `libstdc++`, and `ripgrep`. Install (Alpine: `apk add libgcc libstdc++ ripgrep`) and set `USE_BUILTIN_RIPGREP=0`.153

130</Note>154Claude Code requires a Pro, Max, Teams, Enterprise, or Console account. The free Claude.ai plan does not include Claude Code access. You can also use Claude Code with a third-party API provider like [Amazon Bedrock](/en/amazon-bedrock), [Google Vertex AI](/en/google-vertex-ai), or [Microsoft Foundry](/en/microsoft-foundry).

155

156After installing, log in by running `claude` and following the browser prompts. See [Authentication](/en/authentication) for all account types and team setup options.

157

158## Update Claude Code

159

160Native installations automatically update in the background. You can [configure the release channel](#configure-release-channel) to control whether you receive updates immediately or on a delayed stable schedule, or [disable auto-updates](#disable-auto-updates) entirely. Homebrew and WinGet installations require manual updates.

161

162### Auto-updates

163

164Claude Code checks for updates on startup and periodically while running. Updates download and install in the background, then take effect the next time you start Claude Code.

131 165

132<Note>166<Note>

133 Claude Code installed via Homebrew will auto-update outside of the brew directory unless explicitly disabled with the `DISABLE_AUTOUPDATER` environment variable (see [Auto updates](#auto-updates) section).167 Homebrew and WinGet installations do not auto-update. Use `brew upgrade claude-code` or `winget upgrade Anthropic.ClaudeCode` to update manually.

168

169 **Known issue:** Claude Code may notify you of updates before the new version is available in these package managers. If an upgrade fails, wait and try again later.

170

171 Homebrew keeps old versions on disk after upgrades. Run `brew cleanup claude-code` periodically to reclaim disk space.

134</Note>172</Note>

135 173

136**Windows PowerShell:**174### Configure release channel

137 175

138```powershell theme={null}176Control which release channel Claude Code follows for auto-updates and `claude update` with the `autoUpdatesChannel` setting:

139# Install stable version (default)177

140irm https://claude.ai/install.ps1 | iex178* `"latest"`, the default: receive new features as soon as they're released

179* `"stable"`: use a version that is typically about one week old, skipping releases with major regressions

141 180

142# Install latest version181Configure this via `/config` → **Auto-update channel**, or add it to your [settings.json file](/en/settings):

143& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) latest

144 182

145# Install specific version number183```json theme={null}

146& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) 1.0.58184{

185 "autoUpdatesChannel": "stable"

186}

147```187```

148 188

149**Windows CMD:**189For enterprise deployments, you can enforce a consistent release channel across your organization using [managed settings](/en/permissions#managed-settings).

150 190

151```batch theme={null}191### Disable auto-updates

152REM Install stable version (default)

153curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

154 192

155REM Install latest version193Set `DISABLE_AUTOUPDATER` to `"1"` in the `env` key of your [`settings.json`](/en/settings#available-settings) file:

156curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd latest && del install.cmd

157 194

158REM Install specific version number195```json theme={null}

159curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd 1.0.58 && del install.cmd196{

197 "env": {

198 "DISABLE_AUTOUPDATER": "1"

199 }

200}

160```201```

161 202

162<Tip>203### Update manually

163 Make sure that you remove any outdated aliases or symlinks before installing.

164</Tip>

165 204

166**Binary integrity and code signing**205To apply an update immediately without waiting for the next background check, run:

167 206

168* SHA256 checksums for all platforms are published in the release manifests, currently located at `https://storage.googleapis.com/claude-code-dist-86c565f3-f756-42ad-8dfa-d59b1c096819/claude-code-releases/{VERSION}/manifest.json` (example: replace `{VERSION}` with `2.0.30`)207```bash theme={null}

169* Signed binaries are distributed for the following platforms:208claude update

170 * macOS: Signed by "Anthropic PBC" and notarized by Apple209```

171 * Windows: Signed by "Anthropic, PBC"210

211## Advanced installation options

212

213These options are for version pinning, migrating from npm, and verifying binary integrity.

214

215### Install a specific version

216

217The native installer accepts either a specific version number or a release channel (`latest` or `stable`). The channel you choose at install time becomes your default for auto-updates. See [configure release channel](#configure-release-channel) for more information.

218

219To install the latest version (default):

220

221<Tabs>

222 <Tab title="macOS, Linux, WSL">

223 ```bash theme={null}

224 curl -fsSL https://claude.ai/install.sh | bash

225 ```

226 </Tab>

227

228 <Tab title="Windows PowerShell">

229 ```powershell theme={null}

230 irm https://claude.ai/install.ps1 | iex

231 ```

232 </Tab>

233

234 <Tab title="Windows CMD">

235 ```batch theme={null}

236 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

237 ```

238 </Tab>

239</Tabs>

240

241To install the stable version:

242

243<Tabs>

244 <Tab title="macOS, Linux, WSL">

245 ```bash theme={null}

246 curl -fsSL https://claude.ai/install.sh | bash -s stable

247 ```

248 </Tab>

249

250 <Tab title="Windows PowerShell">

251 ```powershell theme={null}

252 & ([scriptblock]::Create((irm https://claude.ai/install.ps1))) stable

253 ```

254 </Tab>

255

256 <Tab title="Windows CMD">

257 ```batch theme={null}

258 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd stable && del install.cmd

259 ```

260 </Tab>

261</Tabs>

262

263To install a specific version number:

172 264

173### NPM installation265<Tabs>

266 <Tab title="macOS, Linux, WSL">

267 ```bash theme={null}

268 curl -fsSL https://claude.ai/install.sh | bash -s 1.0.58

269 ```

270 </Tab>

271

272 <Tab title="Windows PowerShell">

273 ```powershell theme={null}

274 & ([scriptblock]::Create((irm https://claude.ai/install.ps1))) 1.0.58

275 ```

276 </Tab>

277

278 <Tab title="Windows CMD">

279 ```batch theme={null}

280 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd 1.0.58 && del install.cmd

281 ```

282 </Tab>

283</Tabs>

284

285### Deprecated npm installation

286

287npm installation is deprecated. The native installer is faster, requires no dependencies, and auto-updates in the background. Use the [native installation](#install-claude-code) method when possible.

288

289#### Migrate from npm to native

290

291If you previously installed Claude Code with npm, switch to the native installer:

292

293```bash theme={null}

294# Install the native binary

295curl -fsSL https://claude.ai/install.sh | bash

296

297# Remove the old npm installation

298npm uninstall -g @anthropic-ai/claude-code

299```

174 300

175For environments where NPM is preferred or required:301You can also run `claude install` from an existing npm installation to install the native binary alongside it, then remove the npm version.

176 302

177```sh theme={null}303#### Install with npm

304

305If you need npm installation for compatibility reasons, you must have [Node.js 18+](https://nodejs.org/en/download) installed. Install the package globally:

306

307```bash theme={null}

178npm install -g @anthropic-ai/claude-code308npm install -g @anthropic-ai/claude-code

179```309```

180 310

181<Warning>311<Warning>

182 Do NOT use `sudo npm install -g` as this can lead to permission issues and security risks.312 Do NOT use `sudo npm install -g` as this can lead to permission issues and security risks. If you encounter permission errors, see [troubleshooting permission errors](/en/troubleshooting#permission-errors-during-installation).

183 If you encounter permission errors, see [configure Claude Code](/en/troubleshooting#linux-permission-issues) for recommended solutions.

184</Warning>313</Warning>

185 314

186### Local installation315### Binary integrity and code signing

187 316

188* After global install via npm, use `claude migrate-installer` to move to local317You can verify the integrity of Claude Code binaries using SHA256 checksums and code signatures.

189* Avoids autoupdater npm permission issues

190* Some users may be automatically migrated to this method

191 318

192## Running on AWS or GCP319* SHA256 checksums for all platforms are published in the release manifests at `https://storage.googleapis.com/claude-code-dist-86c565f3-f756-42ad-8dfa-d59b1c096819/claude-code-releases/{VERSION}/manifest.json`. Replace `{VERSION}` with a version number such as `2.0.30`.

320* Signed binaries are distributed for the following platforms:

321 * **macOS**: signed by "Anthropic PBC" and notarized by Apple

322 * **Windows**: signed by "Anthropic, PBC"

193 323

194By default, Claude Code uses the Claude API.324## Uninstall Claude Code

195 325

196For details on running Claude Code on AWS or GCP, see [third-party integrations](/en/third-party-integrations).326To remove Claude Code, follow the instructions for your installation method.

197 327

198## Update Claude Code328### Native installation

199 329

200### Auto updates330Remove the Claude Code binary and version files:

201 331

202Claude Code automatically keeps itself up to date to ensure you have the latest features and security fixes.332<Tabs>

333 <Tab title="macOS, Linux, WSL">

334 ```bash theme={null}

335 rm -f ~/.local/bin/claude

336 rm -rf ~/.local/share/claude

337 ```

338 </Tab>

203 339

204* **Update checks**: Performed on startup and periodically while running340 <Tab title="Windows PowerShell">

205* **Update process**: Downloads and installs automatically in the background341 ```powershell theme={null}

206* **Notifications**: You'll see a notification when updates are installed342 Remove-Item -Path "$env:USERPROFILE\.local\bin\claude.exe" -Force

207* **Applying updates**: Updates take effect the next time you start Claude Code343 Remove-Item -Path "$env:USERPROFILE\.local\share\claude" -Recurse -Force

344 ```

345 </Tab>

346</Tabs>

208 347

209**Disable auto-updates:**348### Homebrew installation

210 349

211Set the `DISABLE_AUTOUPDATER` environment variable in your shell or [settings.json file](/en/settings):350Remove the Homebrew cask:

212 351

213```bash theme={null}352```bash theme={null}

214export DISABLE_AUTOUPDATER=1353brew uninstall --cask claude-code

215```354```

216 355

217### Update manually356### WinGet installation

357

358Remove the WinGet package:

359

360```powershell theme={null}

361winget uninstall Anthropic.ClaudeCode

362```

363

364### npm

365

366Remove the global npm package:

218 367

219```bash theme={null}368```bash theme={null}

220claude update369npm uninstall -g @anthropic-ai/claude-code

221```370```

371

372### Remove configuration files

373

374<Warning>

375 Removing configuration files will delete all your settings, allowed tools, MCP server configurations, and session history.

376</Warning>

377

378To remove Claude Code settings and cached data:

379

380<Tabs>

381 <Tab title="macOS, Linux, WSL">

382 ```bash theme={null}

383 # Remove user settings and state

384 rm -rf ~/.claude

385 rm ~/.claude.json

386

387 # Remove project-specific settings (run from your project directory)

388 rm -rf .claude

389 rm -f .mcp.json

390 ```

391 </Tab>

392

393 <Tab title="Windows PowerShell">

394 ```powershell theme={null}

395 # Remove user settings and state

396 Remove-Item -Path "$env:USERPROFILE\.claude" -Recurse -Force

397 Remove-Item -Path "$env:USERPROFILE\.claude.json" -Force

398

399 # Remove project-specific settings (run from your project directory)

400 Remove-Item -Path ".claude" -Recurse -Force

401 Remove-Item -Path ".mcp.json" -Force

402 ```

403 </Tab>

404</Tabs>

skills.md +505 −412

Details

~~1# Agent Skills~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Create, manage, and share Skills to extend Claude's capabilities in Claude Code.~~5# Extend Claude with skills

4 6

5This guide shows you how to create, use, and manage Agent Skills in Claude Code. Skills are modular capabilities that extend Claude's functionality through organized folders containing instructions, scripts, and resources.7> Create, manage, and share skills to extend Claude's capabilities in Claude Code. Includes custom commands and bundled skills.

6 8

~~7## Prerequisites~~9Skills extend what Claude can do. Create a `SKILL.md` file with instructions, and Claude adds it to its toolkit. Claude uses skills when relevant, or you can invoke one directly with `/skill-name`.

8 10

~~9* Claude Code version 1.0 or later~~11<Note>

~~10* Basic familiarity with [Claude Code](/en/quickstart)~~12 For built-in commands like `/help` and `/compact`, see the [built-in commands reference](/en/commands).

11 13

~~12## What are Agent Skills?~~14 **Custom commands have been merged into skills.** A file at `.claude/commands/deploy.md` and a skill at `.claude/skills/deploy/SKILL.md` both create `/deploy` and work the same way. Your existing `.claude/commands/` files keep working. Skills add optional features: a directory for supporting files, frontmatter to [control whether you or Claude invokes them](#control-who-invokes-a-skill), and the ability for Claude to load them automatically when relevant.

15</Note>

13 16

14Agent Skills package expertise into discoverable capabilities. Each Skill consists of a `SKILL.md` file with instructions that Claude reads when relevant, plus optional supporting files like scripts and templates.17Claude Code skills follow the [Agent Skills](https://agentskills.io) open standard, which works across multiple AI tools. Claude Code extends the standard with additional features like [invocation control](#control-who-invokes-a-skill), [subagent execution](#run-skills-in-a-subagent), and [dynamic context injection](#inject-dynamic-context).

15 18

16**How Skills are invoked**: Skills are **model-invoked**—Claude autonomously decides when to use them based on your request and the Skill's description. This is different from slash commands, which are **user-invoked** (you explicitly type `/command` to trigger them).19## Bundled skills

17 20

~~18**Benefits**:~~21Bundled skills ship with Claude Code and are available in every session. Unlike [built-in commands](/en/commands), which execute fixed logic directly, bundled skills are prompt-based: they give Claude a detailed playbook and let it orchestrate the work using its tools. This means bundled skills can spawn parallel agents, read files, and adapt to your codebase.

19 22

~~20* Extend Claude's capabilities for your specific workflows~~23You invoke bundled skills the same way as any other skill: type `/` followed by the skill name. In the table below, `<arg>` indicates a required argument and `[arg]` indicates an optional one.

~~21* Share expertise across your team via git~~

~~22* Reduce repetitive prompting~~

~~23* Compose multiple Skills for complex tasks~~

24 24

~~25Learn more in the [Agent Skills overview](https://docs.claude.com/en/docs/agents-and-tools/agent-skills/overview).~~25| Skill | Purpose |

26| :-------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

27| `/batch <instruction>` | Orchestrate large-scale changes across a codebase in parallel. Researches the codebase, decomposes the work into 5 to 30 independent units, and presents a plan. Once approved, spawns one background agent per unit in an isolated [git worktree](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees). Each agent implements its unit, runs tests, and opens a pull request. Requires a git repository. Example: `/batch migrate src/ from Solid to React` |

28| `/claude-api` | Load Claude API reference material for your project's language (Python, TypeScript, Java, Go, Ruby, C#, PHP, or cURL) and Agent SDK reference for Python and TypeScript. Covers tool use, streaming, batches, structured outputs, and common pitfalls. Also activates automatically when your code imports `anthropic`, `@anthropic-ai/sdk`, or `claude_agent_sdk` |

29| `/debug [description]` | Troubleshoot your current Claude Code session by reading the session debug log. Optionally describe the issue to focus the analysis |

30| `/loop [interval] <prompt>` | Run a prompt repeatedly on an interval while the session stays open. Useful for polling a deployment, babysitting a PR, or periodically re-running another skill. Example: `/loop 5m check if the deploy finished`. See [Run prompts on a schedule](/en/scheduled-tasks) |

31| `/simplify [focus]` | Review your recently changed files for code reuse, quality, and efficiency issues, then fix them. Spawns three review agents in parallel, aggregates their findings, and applies fixes. Pass text to focus on specific concerns: `/simplify focus on memory efficiency` |

26 32

~~27<Note>~~33## Getting started

28 For a deep dive into the architecture and real-world applications of Agent Skills, read our engineering blog: [Equipping agents for the real world with Agent Skills](https://www.anthropic.com/engineering/equipping-agents-for-the-real-world-with-agent-skills).

~~29</Note>~~

30 34

~~31## Create a Skill~~35### Create your first skill

32 36

~~33Skills are stored as directories containing a `SKILL.md` file.~~37This example creates a skill that teaches Claude to explain code using visual diagrams and analogies. Since it uses default frontmatter, Claude can load it automatically when you ask how something works, or you can invoke it directly with `/explain-code`.

34 38

~~35### Personal Skills~~39<Steps>

40 <Step title="Create the skill directory">

41 Create a directory for the skill in your personal skills folder. Personal skills are available across all your projects.

36 42

~~37Personal Skills are available across all your projects. Store them in `~/.claude/skills/`:~~43 ```bash theme={null}

44 mkdir -p ~/.claude/skills/explain-code

45 ```

46 </Step>

38 47

~~39```bash theme={null}~~48 <Step title="Write SKILL.md">

~~40mkdir -p ~/.claude/skills/my-skill-name~~49 Every skill needs a `SKILL.md` file with two parts: YAML frontmatter (between `---` markers) that tells Claude when to use the skill, and markdown content with instructions Claude follows when the skill is invoked. The `name` field becomes the `/slash-command`, and the `description` helps Claude decide when to load it automatically.

~~41```~~

42 50

~~43**Use personal Skills for**:~~51 Create `~/.claude/skills/explain-code/SKILL.md`:

44 52

~~45* Your individual workflows and preferences~~53 ```yaml theme={null}

~~46* Experimental Skills you're developing~~54 ---

~~47* Personal productivity tools~~55 name: explain-code

56 description: Explains code with visual diagrams and analogies. Use when explaining how code works, teaching about a codebase, or when the user asks "how does this work?"

57 ---

48 58

~~49### Project Skills~~59 When explaining code, always include:

50 60

~~51Project Skills are shared with your team. Store them in `.claude/skills/` within your project:~~61 1. **Start with an analogy**: Compare the code to something from everyday life

62 2. **Draw a diagram**: Use ASCII art to show the flow, structure, or relationships

63 3. **Walk through the code**: Explain step-by-step what happens

64 4. **Highlight a gotcha**: What's a common mistake or misconception?

52 65

~~53```bash theme={null}~~66 Keep explanations conversational. For complex concepts, use multiple analogies.

~~54mkdir -p .claude/skills/my-skill-name~~67 ```

~~55```~~68 </Step>

56 69

~~57**Use project Skills for**:~~70 <Step title="Test the skill">

71 You can test it two ways:

58 72

~~59* Team workflows and conventions~~73 **Let Claude invoke it automatically** by asking something that matches the description:

~~60* Project-specific expertise~~

~~61* Shared utilities and scripts~~

62 74

~~63Project Skills are checked into git and automatically available to team members.~~75 ```text theme={null}

76 How does this code work?

77 ```

64 78

~~65### Plugin Skills~~79 **Or invoke it directly** with the skill name:

66 80

67Skills can also come from [Claude Code plugins](/en/plugins). Plugins may bundle Skills that are automatically available when the plugin is installed. These Skills work the same way as personal and project Skills.81 ```text theme={null}

82 /explain-code src/auth/login.ts

83 ```

68 84

~~69## Write SKILL.md~~85 Either way, Claude should include an analogy and ASCII diagram in its explanation.

86 </Step>

87</Steps>

70 88

~~71Create a `SKILL.md` file with YAML frontmatter and Markdown content:~~89### Where skills live

72 90

~~73```yaml theme={null}~~91Where you store a skill determines who can use it:

~~74name: your-skill-name~~

~~75description: Brief description of what this Skill does and when to use it~~

76 92

~~77# Your Skill Name~~93| Location | Path | Applies to |

94| :--------- | :-------------------------------------------------- | :----------------------------- |

95| Enterprise | See [managed settings](/en/settings#settings-files) | All users in your organization |

96| Personal | `~/.claude/skills/<skill-name>/SKILL.md` | All your projects |

97| Project | `.claude/skills/<skill-name>/SKILL.md` | This project only |

98| Plugin | `<plugin>/skills/<skill-name>/SKILL.md` | Where plugin is enabled |

78 99

~~79## Instructions~~100When skills share the same name across levels, higher-priority locations win: enterprise > personal > project. Plugin skills use a `plugin-name:skill-name` namespace, so they cannot conflict with other levels. If you have files in `.claude/commands/`, those work the same way, but if a skill and a command share the same name, the skill takes precedence.

~~80Provide clear, step-by-step guidance for Claude.~~

81 101

~~82## Examples~~102#### Automatic discovery from nested directories

~~83Show concrete examples of using this Skill.~~

~~84```~~

85 103

~~86**Field requirements**:~~104When you work with files in subdirectories, Claude Code automatically discovers skills from nested `.claude/skills/` directories. For example, if you're editing a file in `packages/frontend/`, Claude Code also looks for skills in `packages/frontend/.claude/skills/`. This supports monorepo setups where packages have their own skills.

87 105

~~88* `name`: Must use lowercase letters, numbers, and hyphens only (max 64 characters)~~106Each skill is a directory with `SKILL.md` as the entrypoint:

~~89* `description`: Brief description of what the Skill does and when to use it (max 1024 characters)~~

90 107

~~91The `description` field is critical for Claude to discover when to use your Skill. It should include both what the Skill does and when Claude should use it.~~108```text theme={null}

109my-skill/

110├── SKILL.md # Main instructions (required)

111├── template.md # Template for Claude to fill in

112├── examples/

113│ └── sample.md # Example output showing expected format

114└── scripts/

115 └── validate.sh # Script Claude can execute

116```

92 117

~~93See the [best practices guide](https://docs.claude.com/en/docs/agents-and-tools/agent-skills/best-practices) for complete authoring guidance including validation rules.~~118The `SKILL.md` contains the main instructions and is required. Other files are optional and let you build more powerful skills: templates for Claude to fill in, example outputs showing the expected format, scripts Claude can execute, or detailed reference documentation. Reference these files from your `SKILL.md` so Claude knows what they contain and when to load them. See [Add supporting files](#add-supporting-files) for more details.

94 119

~~95## Add supporting files~~120<Note>

121 Files in `.claude/commands/` still work and support the same [frontmatter](#frontmatter-reference). Skills are recommended since they support additional features like supporting files.

122</Note>

96 123

~~97Create additional files alongside SKILL.md:~~124#### Skills from additional directories

98 125

~~99```~~126Skills defined in `.claude/skills/` within directories added via `--add-dir` are loaded automatically and picked up by live change detection, so you can edit them during a session without restarting.

100my-skill/

101├── SKILL.md (required)

102├── reference.md (optional documentation)

103├── examples.md (optional examples)

104├── scripts/

105│ └── helper.py (optional utility)

106└── templates/

107 └── template.txt (optional template)

108```

109 127

110Reference these files from SKILL.md:128<Note>

129 CLAUDE.md files from `--add-dir` directories are not loaded by default. To load them, set `CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1`. See [Load from additional directories](/en/memory#load-from-additional-directories).

130</Note>

111 131

112````markdown theme={null}132## Configure skills

113For advanced usage, see [reference.md](reference.md).

114 133

115Run the helper script:134Skills are configured through YAML frontmatter at the top of `SKILL.md` and the markdown content that follows.

116```bash

117python scripts/helper.py input.txt

118```

119````

120 135

121Claude reads these files only when needed, using progressive disclosure to manage context efficiently.136### Types of skill content

122 137

123## Restrict tool access with allowed-tools138Skill files can contain any instructions, but thinking about how you want to invoke them helps guide what to include:

124 139

125Use the `allowed-tools` frontmatter field to limit which tools Claude can use when a Skill is active:140**Reference content** adds knowledge Claude applies to your current work. Conventions, patterns, style guides, domain knowledge. This content runs inline so Claude can use it alongside your conversation context.

126 141

127```yaml theme={null}142```yaml theme={null}

128---143---

129name: safe-file-reader144name: api-conventions

130description: Read files without making changes. Use when you need read-only file access.145description: API design patterns for this codebase

131allowed-tools: Read, Grep, Glob

132---146---

133 147

134# Safe File Reader148When writing API endpoints:

~~135~~ 149- Use RESTful naming conventions

136This Skill provides read-only file access.150- Return consistent error formats

~~137~~ 151- Include request validation

138## Instructions

1391. Use Read to view file contents

1402. Use Grep to search within files

1413. Use Glob to find files by pattern

142```152```

143 153

144When this Skill is active, Claude can only use the specified tools (Read, Grep, Glob) without needing to ask for permission. This is useful for:154**Task content** gives Claude step-by-step instructions for a specific action, like deployments, commits, or code generation. These are often actions you want to invoke directly with `/skill-name` rather than letting Claude decide when to run them. Add `disable-model-invocation: true` to prevent Claude from triggering it automatically.

~~145~~

146* Read-only Skills that shouldn't modify files

147* Skills with limited scope (e.g., only data analysis, no file writing)

148* Security-sensitive workflows where you want to restrict capabilities

~~149~~

150If `allowed-tools` is not specified, Claude will ask for permission to use tools as normal, following the standard permission model.

~~151~~

152<Note>

153 `allowed-tools` is only supported for Skills in Claude Code.

154</Note>

~~155~~

156## View available Skills

~~157~~

158Skills are automatically discovered by Claude from three sources:

~~159~~

160* Personal Skills: `~/.claude/skills/`

161* Project Skills: `.claude/skills/`

162* Plugin Skills: bundled with installed plugins

163 155

164**To view all available Skills**, ask Claude directly:156```yaml theme={null}

~~165~~ 157---

166```158name: deploy

167What Skills are available?159description: Deploy the application to production

168```160context: fork

~~169~~ 161disable-model-invocation: true

170or162---

171 163

172```164Deploy the application:

173List all available Skills1651. Run the test suite

1662. Build the application

1673. Push to the deployment target

174```168```

175 169

176This will show all Skills from all sources, including plugin Skills.170Your `SKILL.md` can contain anything, but thinking through how you want the skill invoked (by you, by Claude, or both) and where you want it to run (inline or in a subagent) helps guide what to include. For complex skills, you can also [add supporting files](#add-supporting-files) to keep the main skill focused.

177 171

178**To inspect a specific Skill**, you can also check the filesystem:172### Frontmatter reference

179 173

180```bash theme={null}174Beyond the markdown content, you can configure skill behavior using YAML frontmatter fields between `---` markers at the top of your `SKILL.md` file:

181# List personal Skills

182ls ~/.claude/skills/

183 175

184# List project Skills (if in a project directory)176```yaml theme={null}

185ls .claude/skills/177---

178name: my-skill

179description: What this skill does

180disable-model-invocation: true

181allowed-tools: Read, Grep

182---

186 183

187# View a specific Skill's content184Your skill instructions here...

188cat ~/.claude/skills/my-skill/SKILL.md

189```185```

190 186

191## Test a Skill187All fields are optional. Only `description` is recommended so Claude knows when to use the skill.

~~192~~

193After creating a Skill, test it by asking questions that match your description.

~~194~~

195**Example**: If your description mentions "PDF files":

~~196~~

197```

198Can you help me extract text from this PDF?

199```

200 188

201Claude autonomously decides to use your Skill if it matches the request—you don't need to explicitly invoke it. The Skill activates automatically based on the context of your question.189| Field | Required | Description |

190| :------------------------- | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

191| `name` | No | Display name for the skill. If omitted, uses the directory name. Lowercase letters, numbers, and hyphens only (max 64 characters). |

192| `description` | Recommended | What the skill does and when to use it. Claude uses this to decide when to apply the skill. If omitted, uses the first paragraph of markdown content. |

193| `argument-hint` | No | Hint shown during autocomplete to indicate expected arguments. Example: `[issue-number]` or `[filename] [format]`. |

194| `disable-model-invocation` | No | Set to `true` to prevent Claude from automatically loading this skill. Use for workflows you want to trigger manually with `/name`. Default: `false`. |

195| `user-invocable` | No | Set to `false` to hide from the `/` menu. Use for background knowledge users shouldn't invoke directly. Default: `true`. |

196| `allowed-tools` | No | Tools Claude can use without asking permission when this skill is active. |

197| `model` | No | Model to use when this skill is active. |

198| `effort` | No | [Effort level](/en/model-config#adjust-effort-level) when this skill is active. Overrides the session effort level. Default: inherits from session. Options: `low`, `medium`, `high`, `max` (Opus 4.6 only). |

199| `context` | No | Set to `fork` to run in a forked subagent context. |

200| `agent` | No | Which subagent type to use when `context: fork` is set. |

201| `hooks` | No | Hooks scoped to this skill's lifecycle. See [Hooks in skills and agents](/en/hooks#hooks-in-skills-and-agents) for configuration format. |

202 202

203## Debug a Skill203#### Available string substitutions

204 204

205If Claude doesn't use your Skill, check these common issues:205Skills support string substitution for dynamic values in the skill content:

206 206

207### Make description specific207| Variable | Description |

208| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

209| `$ARGUMENTS` | All arguments passed when invoking the skill. If `$ARGUMENTS` is not present in the content, arguments are appended as `ARGUMENTS: <value>`. |

210| `$ARGUMENTS[N]` | Access a specific argument by 0-based index, such as `$ARGUMENTS[0]` for the first argument. |

211| `$N` | Shorthand for `$ARGUMENTS[N]`, such as `$0` for the first argument or `$1` for the second. |

212| `${CLAUDE_SESSION_ID}` | The current session ID. Useful for logging, creating session-specific files, or correlating skill output with sessions. |

213| `${CLAUDE_SKILL_DIR}` | The directory containing the skill's `SKILL.md` file. For plugin skills, this is the skill's subdirectory within the plugin, not the plugin root. Use this in bash injection commands to reference scripts or files bundled with the skill, regardless of the current working directory. |

208 214

209**Too vague**:215**Example using substitutions:**

210 216

211```yaml theme={null}217```yaml theme={null}

212description: Helps with documents218---

213```219name: session-logger

220description: Log activity for this session

221---

214 222

215**Specific**:223Log the following to logs/${CLAUDE_SESSION_ID}.log:

216 224

217```yaml theme={null}225$ARGUMENTS

218description: Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.

219```226```

220 227

221Include both what the Skill does and when to use it in the description.228### Add supporting files

~~222~~

223### Verify file path

~~224~~

225**Personal Skills**: `~/.claude/skills/skill-name/SKILL.md`

226**Project Skills**: `.claude/skills/skill-name/SKILL.md`

227 229

228Check the file exists:230Skills can include multiple files in their directory. This keeps `SKILL.md` focused on the essentials while letting Claude access detailed reference material only when needed. Large reference docs, API specifications, or example collections don't need to load into context every time the skill runs.

~~229~~

230```bash theme={null}

231# Personal

232ls ~/.claude/skills/my-skill/SKILL.md

233 231

234# Project232```text theme={null}

235ls .claude/skills/my-skill/SKILL.md233my-skill/

234├── SKILL.md (required - overview and navigation)

235├── reference.md (detailed API docs - loaded when needed)

236├── examples.md (usage examples - loaded when needed)

237└── scripts/

238 └── helper.py (utility script - executed, not loaded)

236```239```

237 240

238### Check YAML syntax241Reference supporting files from `SKILL.md` so Claude knows what each file contains and when to load it:

239 242

240Invalid YAML prevents the Skill from loading. Verify the frontmatter:243```markdown theme={null}

244## Additional resources

241 245

242```bash theme={null}246- For complete API details, see [reference.md](reference.md)

243cat SKILL.md | head -n 10247- For usage examples, see [examples.md](examples.md)

244```248```

245 249

246Ensure:250<Tip>Keep `SKILL.md` under 500 lines. Move detailed reference material to separate files.</Tip>

~~247~~

248* Opening `---` on line 1

249* Closing `---` before Markdown content

250* Valid YAML syntax (no tabs, correct indentation)

251 251

252### View errors252### Control who invokes a skill

253 253

254Run Claude Code with debug mode to see Skill loading errors:254By default, both you and Claude can invoke any skill. You can type `/skill-name` to invoke it directly, and Claude can load it automatically when relevant to your conversation. Two frontmatter fields let you restrict this:

255 255

256```bash theme={null}256* **`disable-model-invocation: true`**: Only you can invoke the skill. Use this for workflows with side effects or that you want to control timing, like `/commit`, `/deploy`, or `/send-slack-message`. You don't want Claude deciding to deploy because your code looks ready.

257claude --debug

258```

259 257

260## Share Skills with your team258* **`user-invocable: false`**: Only Claude can invoke the skill. Use this for background knowledge that isn't actionable as a command. A `legacy-system-context` skill explains how an old system works. Claude should know this when relevant, but `/legacy-system-context` isn't a meaningful action for users to take.

261 259

262**Recommended approach**: Distribute Skills through [plugins](/en/plugins).260This example creates a deploy skill that only you can trigger. The `disable-model-invocation: true` field prevents Claude from running it automatically:

263 261

264To share Skills via plugin:262```yaml theme={null}

263---

264name: deploy

265description: Deploy the application to production

266disable-model-invocation: true

267---

265 268

2661. Create a plugin with Skills in the `skills/` directory269Deploy $ARGUMENTS to production:

2672. Add the plugin to a marketplace

2683. Team members install the plugin

269 270

270For complete instructions, see [Add Skills to your plugin](/en/plugins#add-skills-to-your-plugin).2711. Run the test suite

2722. Build the application

2733. Push to the deployment target

2744. Verify the deployment succeeded

275```

271 276

272You can also share Skills directly through project repositories:277Here's how the two fields affect invocation and context loading:

273 278

280| :------------------------------- | :------------- | :---------------- | :----------------------------------------------------------- |

281| (default) | Yes | Yes | Description always in context, full skill loads when invoked |

282| `disable-model-invocation: true` | Yes | No | Description not in context, full skill loads when you invoke |

283| `user-invocable: false` | No | Yes | Description always in context, full skill loads when invoked |

275 284

276Create a project Skill:285<Note>

286 In a regular session, skill descriptions are loaded into context so Claude knows what's available, but full skill content only loads when invoked. [Subagents with preloaded skills](/en/sub-agents#preload-skills-into-subagents) work differently: the full skill content is injected at startup.

287</Note>

277 288

278```bash theme={null}289### Restrict tool access

279mkdir -p .claude/skills/team-skill

280# Create SKILL.md

281```

282 290

283### Step 2: Commit to git291Use the `allowed-tools` field to limit which tools Claude can use when a skill is active. This skill creates a read-only mode where Claude can explore files but not modify them:

284 292

285```bash theme={null}293```yaml theme={null}

286git add .claude/skills/294---

287git commit -m "Add team Skill for PDF processing"295name: safe-reader

288git push296description: Read files without making changes

297allowed-tools: Read, Grep, Glob

298---

289```299```

290 300

291### Step 3: Team members get Skills automatically301### Pass arguments to skills

292 302

293When team members pull the latest changes, Skills are immediately available:303Both you and Claude can pass arguments when invoking a skill. Arguments are available via the `$ARGUMENTS` placeholder.

294 304

295```bash theme={null}305This skill fixes a GitHub issue by number. The `$ARGUMENTS` placeholder gets replaced with whatever follows the skill name:

296git pull

297claude # Skills are now available

298```

299 306

300## Update a Skill307```yaml theme={null}

308---

309name: fix-issue

310description: Fix a GitHub issue

311disable-model-invocation: true

312---

301 313

302Edit SKILL.md directly:314Fix GitHub issue $ARGUMENTS following our coding standards.

303 315

304```bash theme={null}3161. Read the issue description

305# Personal Skill3172. Understand the requirements

306code ~/.claude/skills/my-skill/SKILL.md3183. Implement the fix

~~307~~ 3194. Write tests

308# Project Skill3205. Create a commit

309code .claude/skills/my-skill/SKILL.md

310```321```

311 322

312Changes take effect the next time you start Claude Code. If Claude Code is already running, restart it to load the updates.323When you run `/fix-issue 123`, Claude receives "Fix GitHub issue 123 following our coding standards..."

313 324

314## Remove a Skill325If you invoke a skill with arguments but the skill doesn't include `$ARGUMENTS`, Claude Code appends `ARGUMENTS: <your input>` to the end of the skill content so Claude still sees what you typed.

315 326

316Delete the Skill directory:327To access individual arguments by position, use `$ARGUMENTS[N]` or the shorter `$N`:

317 328

318```bash theme={null}329```yaml theme={null}

319# Personal330---

320rm -rf ~/.claude/skills/my-skill331name: migrate-component

332description: Migrate a component from one framework to another

333---

321 334

322# Project335Migrate the $ARGUMENTS[0] component from $ARGUMENTS[1] to $ARGUMENTS[2].

323rm -rf .claude/skills/my-skill336Preserve all existing behavior and tests.

324git commit -m "Remove unused Skill"

325```337```

326 338

327## Best practices339Running `/migrate-component SearchBar React Vue` replaces `$ARGUMENTS[0]` with `SearchBar`, `$ARGUMENTS[1]` with `React`, and `$ARGUMENTS[2]` with `Vue`. The same skill using the `$N` shorthand:

328 340

329### Keep Skills focused341```yaml theme={null}

~~330~~ 342---

331One Skill should address one capability:343name: migrate-component

~~332~~ 344description: Migrate a component from one framework to another

333**Focused**:345---

~~334~~

335* "PDF form filling"

336* "Excel data analysis"

337* "Git commit messages"

338 346

339**Too broad**:347Migrate the $0 component from $1 to $2.

348Preserve all existing behavior and tests.

349```

340 350

341* "Document processing" (split into separate Skills)351## Advanced patterns

342* "Data tools" (split by data type or operation)

343 352

344### Write clear descriptions353### Inject dynamic context

345 354

346Help Claude discover when to use Skills by including specific triggers in your description:355The `` !`<command>` `` syntax runs shell commands before the skill content is sent to Claude. The command output replaces the placeholder, so Claude receives actual data, not the command itself.

347 356

348**Clear**:357This skill summarizes a pull request by fetching live PR data with the GitHub CLI. The `` !`gh pr diff` `` and other commands run first, and their output gets inserted into the prompt:

349 358

350```yaml theme={null}359```yaml theme={null}

351description: Analyze Excel spreadsheets, create pivot tables, and generate charts. Use when working with Excel files, spreadsheets, or analyzing tabular data in .xlsx format.360---

352```361name: pr-summary

362description: Summarize changes in a pull request

363context: fork

364agent: Explore

365allowed-tools: Bash(gh *)

366---

353 367

354**Vague**:368## Pull request context

369- PR diff: !`gh pr diff`

370- PR comments: !`gh pr view --comments`

371- Changed files: !`gh pr diff --name-only`

355 372

356```yaml theme={null}373## Your task

357description: For files374Summarize this pull request...

358```375```

359 376

360### Test with your team377When this skill runs:

~~361~~

362Have teammates use Skills and provide feedback:

~~363~~

364* Does the Skill activate when expected?

365* Are the instructions clear?

366* Are there missing examples or edge cases?

~~367~~

368### Document Skill versions

~~369~~

370You can document Skill versions in your SKILL.md content to track changes over time. Add a version history section:

371 378

372```markdown theme={null}3791. Each `` !`<command>` `` executes immediately (before Claude sees anything)

373# My Skill3802. The output replaces the placeholder in the skill content

3813. Claude receives the fully-rendered prompt with actual PR data

374 382

375## Version History383This is preprocessing, not something Claude executes. Claude only sees the final result.

376- v2.0.0 (2025-10-01): Breaking changes to API

377- v1.1.0 (2025-09-15): Added new features

378- v1.0.0 (2025-09-01): Initial release

379```

380 384

381This helps team members understand what changed between versions.385<Tip>

386 To enable [extended thinking](/en/common-workflows#use-extended-thinking-thinking-mode) in a skill, include the word "ultrathink" anywhere in your skill content.

387</Tip>

382 388

383## Troubleshooting389### Run skills in a subagent

384 390

385### Claude doesn't use my Skill391Add `context: fork` to your frontmatter when you want a skill to run in isolation. The skill content becomes the prompt that drives the subagent. It won't have access to your conversation history.

386 392

387**Symptom**: You ask a relevant question but Claude doesn't use your Skill.393<Warning>

394 `context: fork` only makes sense for skills with explicit instructions. If your skill contains guidelines like "use these API conventions" without a task, the subagent receives the guidelines but no actionable prompt, and returns without meaningful output.

395</Warning>

388 396

389**Check**: Is the description specific enough?397Skills and [subagents](/en/sub-agents) work together in two directions:

390 398

400| :--------------------------- | :---------------------------------------- | :-------------------------- | :--------------------------- |

392 403

393**Too generic**:404With `context: fork`, you write the task in your skill and pick an agent type to execute it. For the inverse (defining a custom subagent that uses skills as reference material), see [Subagents](/en/sub-agents#preload-skills-into-subagents).

394 405

395```yaml theme={null}406#### Example: Research skill using Explore agent

396description: Helps with data

397```

398 407

399**Specific**:408This skill runs research in a forked Explore agent. The skill content becomes the task, and the agent provides read-only tools optimized for codebase exploration:

400 409

401```yaml theme={null}410```yaml theme={null}

402description: Analyze Excel spreadsheets, generate pivot tables, create charts. Use when working with Excel files, spreadsheets, or .xlsx files.411---

403```412name: deep-research

~~404~~ 413description: Research a topic thoroughly

405**Check**: Is the YAML valid?414context: fork

~~406~~ 415agent: Explore

407Run validation to check for syntax errors:416---

408 417

409```bash theme={null}418Research $ARGUMENTS thoroughly:

410# View frontmatter

411cat .claude/skills/my-skill/SKILL.md | head -n 15

412 419

413# Check for common issues4201. Find relevant files using Glob and Grep

414# - Missing opening or closing ---4212. Read and analyze the code

415# - Tabs instead of spaces4223. Summarize findings with specific file references

416# - Unquoted strings with special characters

417```423```

418 424

419**Check**: Is the Skill in the correct location?425When this skill runs:

420 426

421```bash theme={null}4271. A new isolated context is created

422# Personal Skills4282. The subagent receives the skill content as its prompt ("Research \$ARGUMENTS thoroughly...")

423ls ~/.claude/skills/*/SKILL.md4293. The `agent` field determines the execution environment (model, tools, and permissions)

4304. Results are summarized and returned to your main conversation

424 431

425# Project Skills432The `agent` field specifies which subagent configuration to use. Options include built-in agents (`Explore`, `Plan`, `general-purpose`) or any custom subagent from `.claude/agents/`. If omitted, uses `general-purpose`.

426ls .claude/skills/*/SKILL.md

427```

428 433

429### Skill has errors434### Restrict Claude's skill access

430 435

431**Symptom**: The Skill loads but doesn't work correctly.436By default, Claude can invoke any skill that doesn't have `disable-model-invocation: true` set. Skills that define `allowed-tools` grant Claude access to those tools without per-use approval when the skill is active. Your [permission settings](/en/permissions) still govern baseline approval behavior for all other tools. Built-in commands like `/compact` and `/init` are not available through the Skill tool.

432 437

433**Check**: Are dependencies available?438Three ways to control which skills Claude can invoke:

434 439

435Claude will automatically install required dependencies (or ask for permission to install them) when it needs them.440**Disable all skills** by denying the Skill tool in `/permissions`:

436 441

437**Check**: Do scripts have execute permissions?442```text theme={null}

~~438~~ 443# Add to deny rules:

439```bash theme={null}444Skill

440chmod +x .claude/skills/my-skill/scripts/*.py

441```445```

442 446

443**Check**: Are file paths correct?447**Allow or deny specific skills** using [permission rules](/en/permissions):

444 448

445Use forward slashes (Unix style) in all paths:449```text theme={null}

450# Allow only specific skills

451Skill(commit)

452Skill(review-pr *)

446 453

447**Correct**: `scripts/helper.py`454# Deny specific skills

448**Wrong**: `scripts\helper.py` (Windows style)455Skill(deploy *)

~~449~~

450### Multiple Skills conflict

~~451~~

452**Symptom**: Claude uses the wrong Skill or seems confused between similar Skills.

~~453~~

454**Be specific in descriptions**: Help Claude choose the right Skill by using distinct trigger terms in your descriptions.

~~455~~

456Instead of:

~~457~~

458```yaml theme={null}

459# Skill 1

460description: For data analysis

~~461~~

462# Skill 2

463description: For analyzing data

464```456```

465 457

466Use:458Permission syntax: `Skill(name)` for exact match, `Skill(name *)` for prefix match with any arguments.

467 459

468```yaml theme={null}460**Hide individual skills** by adding `disable-model-invocation: true` to their frontmatter. This removes the skill from Claude's context entirely.

469# Skill 1

470description: Analyze sales data in Excel files and CRM exports. Use for sales reports, pipeline analysis, and revenue tracking.

~~471~~

472# Skill 2

473description: Analyze log files and system metrics data. Use for performance monitoring, debugging, and system diagnostics.

474```

475 461

476## Examples462<Note>

463 The `user-invocable` field only controls menu visibility, not Skill tool access. Use `disable-model-invocation: true` to block programmatic invocation.

464</Note>

477 465

478### Simple Skill (single file)466## Share skills

479 467

480```468Skills can be distributed at different scopes depending on your audience:

481commit-helper/

482└── SKILL.md

483```

484 469

485```yaml theme={null}470* **Project skills**: Commit `.claude/skills/` to version control

486name: generating-commit-messages471* **Plugins**: Create a `skills/` directory in your [plugin](/en/plugins)

487description: Generates clear commit messages from git diffs. Use when writing commit messages or reviewing staged changes.472* **Managed**: Deploy organization-wide through [managed settings](/en/settings#settings-files)

488 473

489# Generating Commit Messages474### Generate visual output

490 475

491## Instructions476Skills can bundle and run scripts in any language, giving Claude capabilities beyond what's possible in a single prompt. One powerful pattern is generating visual output: interactive HTML files that open in your browser for exploring data, debugging, or creating reports.

492 477

4931. Run `git diff --staged` to see changes478This example creates a codebase explorer: an interactive tree view where you can expand and collapse directories, see file sizes at a glance, and identify file types by color.

4942. I'll suggest a commit message with:

495 - Summary under 50 characters

496 - Detailed description

497 - Affected components

498 479

499## Best practices480Create the Skill directory:

500 481

501- Use present tense482```bash theme={null}

502- Explain what and why, not how483mkdir -p ~/.claude/skills/codebase-visualizer/scripts

503```484```

504 485

505### Skill with tool permissions486Create `~/.claude/skills/codebase-visualizer/SKILL.md`. The description tells Claude when to activate this Skill, and the instructions tell Claude to run the bundled script:

~~506~~

507```

508code-reviewer/

509└── SKILL.md

510```

511 487

512```yaml theme={null}488````yaml theme={null}

513---489---

514name: code-reviewer490name: codebase-visualizer

515description: Review code for best practices and potential issues. Use when reviewing code, checking PRs, or analyzing code quality.491description: Generate an interactive collapsible tree visualization of your codebase. Use when exploring a new repo, understanding project structure, or identifying large files.

516allowed-tools: Read, Grep, Glob492allowed-tools: Bash(python *)

517---493---

518 494

519# Code Reviewer495# Codebase Visualizer

520 496

521## Review checklist497Generate an interactive HTML tree view that shows your project's file structure with collapsible directories.

522 498

5231. Code organization and structure499## Usage

5242. Error handling

5253. Performance considerations

5264. Security concerns

5275. Test coverage

528 500

529## Instructions501Run the visualization script from your project root:

530 502

5311. Read the target files using Read tool503```bash

5322. Search for patterns using Grep504python ~/.claude/skills/codebase-visualizer/scripts/visualize.py .

5333. Find related files using Glob

5344. Provide detailed feedback on code quality

535```505```

536 506

537### Multi-file Skill507This creates `codebase-map.html` in the current directory and opens it in your default browser.

538 508

539```509## What the visualization shows

540pdf-processing/

541├── SKILL.md

542├── FORMS.md

543├── REFERENCE.md

544└── scripts/

545 ├── fill_form.py

546 └── validate.py

547```

548 510

549**SKILL.md**:511- **Collapsible directories**: Click folders to expand/collapse

~~550~~ 512- **File sizes**: Displayed next to each file

551````yaml theme={null}513- **Colors**: Different colors for different file types

552name: pdf-processing514- **Directory totals**: Shows aggregate size of each folder

553description: Extract text, fill forms, merge PDFs. Use when working with PDF files, forms, or document extraction. Requires pypdf and pdfplumber packages.515````

554 516

555# PDF Processing517Create `~/.claude/skills/codebase-visualizer/scripts/visualize.py`. This script scans a directory tree and generates a self-contained HTML file with:

518

519* A **summary sidebar** showing file count, directory count, total size, and number of file types

520* A **bar chart** breaking down the codebase by file type (top 8 by size)

521* A **collapsible tree** where you can expand and collapse directories, with color-coded file type indicators

522

523The script requires Python but uses only built-in libraries, so there are no packages to install:

524

525```python expandable theme={null}

526#!/usr/bin/env python3

527"""Generate an interactive collapsible tree visualization of a codebase."""

528

529import json

530import sys

531import webbrowser

532from pathlib import Path

533from collections import Counter

534

535IGNORE = {'.git', 'node_modules', '__pycache__', '.venv', 'venv', 'dist', 'build'}

536

537def scan(path: Path, stats: dict) -> dict:

538 result = {"name": path.name, "children": [], "size": 0}

539 try:

540 for item in sorted(path.iterdir()):

541 if item.name in IGNORE or item.name.startswith('.'):

542 continue

543 if item.is_file():

544 size = item.stat().st_size

545 ext = item.suffix.lower() or '(no ext)'

546 result["children"].append({"name": item.name, "size": size, "ext": ext})

547 result["size"] += size

548 stats["files"] += 1

549 stats["extensions"][ext] += 1

550 stats["ext_sizes"][ext] += size

551 elif item.is_dir():

552 stats["dirs"] += 1

553 child = scan(item, stats)

554 if child["children"]:

555 result["children"].append(child)

556 result["size"] += child["size"]

557 except PermissionError:

558 pass

559 return result

560

561def generate_html(data: dict, stats: dict, output: Path) -> None:

562 ext_sizes = stats["ext_sizes"]

563 total_size = sum(ext_sizes.values()) or 1

564 sorted_exts = sorted(ext_sizes.items(), key=lambda x: -x[1])[:8]

565 colors = {

566 '.js': '#f7df1e', '.ts': '#3178c6', '.py': '#3776ab', '.go': '#00add8',

567 '.rs': '#dea584', '.rb': '#cc342d', '.css': '#264de4', '.html': '#e34c26',

568 '.json': '#6b7280', '.md': '#083fa1', '.yaml': '#cb171e', '.yml': '#cb171e',

569 '.mdx': '#083fa1', '.tsx': '#3178c6', '.jsx': '#61dafb', '.sh': '#4eaa25',

570 }

571 lang_bars = "".join(

572 f'<div class="bar-row"><span class="bar-label">{ext}</span>'

573 f'<div class="bar" style="width:{(size/total_size)*100}%;background:{colors.get(ext,"#6b7280")}"></div>'

574 f'<span class="bar-pct">{(size/total_size)*100:.1f}%</span></div>'

575 for ext, size in sorted_exts

576 )

577 def fmt(b):

578 if b < 1024: return f"{b} B"

579 if b < 1048576: return f"{b/1024:.1f} KB"

580 return f"{b/1048576:.1f} MB"

581

582 html = f'''<!DOCTYPE html>

583<html><head>

584 <meta charset="utf-8"><title>Codebase Explorer</title>

585 <style>

586 body {{ font: 14px/1.5 system-ui, sans-serif; margin: 0; background: #1a1a2e; color: #eee; }}

587 .container {{ display: flex; height: 100vh; }}

588 .sidebar {{ width: 280px; background: #252542; padding: 20px; border-right: 1px solid #3d3d5c; overflow-y: auto; flex-shrink: 0; }}

589 .main {{ flex: 1; padding: 20px; overflow-y: auto; }}

590 h1 {{ margin: 0 0 10px 0; font-size: 18px; }}

591 h2 {{ margin: 20px 0 10px 0; font-size: 14px; color: #888; text-transform: uppercase; }}

592 .stat {{ display: flex; justify-content: space-between; padding: 8px 0; border-bottom: 1px solid #3d3d5c; }}

593 .stat-value {{ font-weight: bold; }}

594 .bar-row {{ display: flex; align-items: center; margin: 6px 0; }}

595 .bar-label {{ width: 55px; font-size: 12px; color: #aaa; }}

596 .bar {{ height: 18px; border-radius: 3px; }}

597 .bar-pct {{ margin-left: 8px; font-size: 12px; color: #666; }}

598 .tree {{ list-style: none; padding-left: 20px; }}

599 details {{ cursor: pointer; }}

600 summary {{ padding: 4px 8px; border-radius: 4px; }}

601 summary:hover {{ background: #2d2d44; }}

602 .folder {{ color: #ffd700; }}

603 .file {{ display: flex; align-items: center; padding: 4px 8px; border-radius: 4px; }}

604 .file:hover {{ background: #2d2d44; }}

605 .size {{ color: #888; margin-left: auto; font-size: 12px; }}

606 .dot {{ width: 8px; height: 8px; border-radius: 50%; margin-right: 8px; }}

607 </style>

608</head><body>

609 <div class="container">

610 <div class="sidebar">

611 <h1>📊 Summary</h1>

612 <div class="stat"><span>Files</span><span class="stat-value">{stats["files"]:,}</span></div>

613 <div class="stat"><span>Directories</span><span class="stat-value">{stats["dirs"]:,}</span></div>

614 <div class="stat"><span>Total size</span><span class="stat-value">{fmt(data["size"])}</span></div>

615 <div class="stat"><span>File types</span><span class="stat-value">{len(stats["extensions"])}</span></div>

616 <h2>By file type</h2>

617 {lang_bars}

618 </div>

619 <div class="main">

620 <h1>📁 {data["name"]}</h1>

621 <ul class="tree" id="root"></ul>

622 </div>

623 </div>

624 <script>

625 const data = {json.dumps(data)};

626 const colors = {json.dumps(colors)};

627 function fmt(b) {{ if (b < 1024) return b + ' B'; if (b < 1048576) return (b/1024).toFixed(1) + ' KB'; return (b/1048576).toFixed(1) + ' MB'; }}

628 function render(node, parent) {{

629 if (node.children) {{

630 const det = document.createElement('details');

631 det.open = parent === document.getElementById('root');

632 det.innerHTML = `<summary><span class="folder">📁 ${{node.name}}</span><span class="size">${{fmt(node.size)}}</span></summary>`;

633 const ul = document.createElement('ul'); ul.className = 'tree';

634 node.children.sort((a,b) => (b.children?1:0)-(a.children?1:0) || a.name.localeCompare(b.name));

635 node.children.forEach(c => render(c, ul));

636 det.appendChild(ul);

637 const li = document.createElement('li'); li.appendChild(det); parent.appendChild(li);

638 }} else {{

639 const li = document.createElement('li'); li.className = 'file';

640 li.innerHTML = `<span class="dot" style="background:${{colors[node.ext]||'#6b7280'}}"></span>${{node.name}}<span class="size">${{fmt(node.size)}}</span>`;

641 parent.appendChild(li);

642 }}

643 }}

644 data.children.forEach(c => render(c, document.getElementById('root')));

645 </script>

646</body></html>'''

647 output.write_text(html)

648

649if __name__ == '__main__':

650 target = Path(sys.argv[1] if len(sys.argv) > 1 else '.').resolve()

651 stats = {"files": 0, "dirs": 0, "extensions": Counter(), "ext_sizes": Counter()}

652 data = scan(target, stats)

653 out = Path('codebase-map.html')

654 generate_html(data, stats, out)

655 print(f'Generated {out.absolute()}')

656 webbrowser.open(f'file://{out.absolute()}')

657```

658

659To test, open Claude Code in any project and ask "Visualize this codebase." Claude runs the script, generates `codebase-map.html`, and opens it in your browser.

660

661This pattern works for any visual output: dependency graphs, test coverage reports, API documentation, or database schema visualizations. The bundled script does the heavy lifting while Claude handles orchestration.

556 662

557## Quick start663## Troubleshooting

558 664

559Extract text:665### Skill not triggering

560```python

561import pdfplumber

562with pdfplumber.open("doc.pdf") as pdf:

563 text = pdf.pages[0].extract_text()

564```

565 666

566For form filling, see [FORMS.md](FORMS.md).667If Claude doesn't use your skill when expected:

567For detailed API reference, see [REFERENCE.md](REFERENCE.md).

568 668

569## Requirements6691. Check the description includes keywords users would naturally say

6702. Verify the skill appears in `What skills are available?`

6713. Try rephrasing your request to match the description more closely

6724. Invoke it directly with `/skill-name` if the skill is user-invocable

570 673

571Packages must be installed in your environment:674### Skill triggers too often

572```bash

573pip install pypdf pdfplumber

574```

575````

576 675

577<Note>676If Claude uses your skill when you don't want it:

578 List required packages in the description. Packages must be installed in your environment before Claude can use them.

579</Note>

580 677

581Claude loads additional files only when needed.6781. Make the description more specific

6792. Add `disable-model-invocation: true` if you only want manual invocation

582 680

583## Next steps681### Claude doesn't see all my skills

584 682

585<CardGroup cols={2}>683Skill descriptions are loaded into context so Claude knows what's available. If you have many skills, they may exceed the character budget. The budget scales dynamically at 2% of the context window, with a fallback of 16,000 characters. Run `/context` to check for a warning about excluded skills.

586 <Card title="Authoring best practices" icon="lightbulb" href="https://docs.claude.com/en/docs/agents-and-tools/agent-skills/best-practices">

587 Write Skills that Claude can use effectively

588 </Card>

589 684

590 <Card title="Agent Skills overview" icon="book" href="https://docs.claude.com/en/docs/agents-and-tools/agent-skills/overview">685To override the limit, set the `SLASH_COMMAND_TOOL_CHAR_BUDGET` environment variable.

591 Learn how Skills work across Claude products

592 </Card>

593 686

594 <Card title="Use Skills in the Agent SDK" icon="cube" href="https://docs.claude.com/en/docs/agent-sdk/skills">687## Related resources

595 Use Skills programmatically with TypeScript and Python

596 </Card>

597 688

598 <Card title="Get started with Agent Skills" icon="rocket" href="https://docs.claude.com/en/docs/agents-and-tools/agent-skills/quickstart">689* **[Subagents](/en/sub-agents)**: delegate tasks to specialized agents

599 Create your first Skill690* **[Plugins](/en/plugins)**: package and distribute skills with other extensions

600 </Card>691* **[Hooks](/en/hooks)**: automate workflows around tool events

601</CardGroup>692* **[Memory](/en/memory)**: manage CLAUDE.md files for persistent context

693* **[Built-in commands](/en/commands)**: reference for built-in `/` commands

694* **[Permissions](/en/permissions)**: control tool and skill access

slack.md +235 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Claude Code in Slack

7> Delegate coding tasks directly from your Slack workspace

9Claude Code in Slack brings the power of Claude Code directly into your Slack workspace. When you mention `@Claude` with a coding task, Claude automatically detects the intent and creates a Claude Code session on the web, allowing you to delegate development work without leaving your team conversations.

11This integration is built on the existing Claude for Slack app but adds intelligent routing to Claude Code on the web for coding-related requests.

13## Use cases

15* **Bug investigation and fixes**: Ask Claude to investigate and fix bugs as soon as they're reported in Slack channels.

16* **Quick code reviews and modifications**: Have Claude implement small features or refactor code based on team feedback.

17* **Collaborative debugging**: When team discussions provide crucial context (e.g., error reproductions or user reports), Claude can use that information to inform its debugging approach.

18* **Parallel task execution**: Kick off coding tasks in Slack while you continue other work, receiving notifications when complete.

20## Prerequisites

22Before using Claude Code in Slack, ensure you have the following:

24| Requirement | Details |

25| :--------------------- | :----------------------------------------------------------------------------- |

26| Claude Plan | Pro, Max, Teams, or Enterprise with Claude Code access (premium seats) |

27| Claude Code on the web | Access to [Claude Code on the web](/en/claude-code-on-the-web) must be enabled |

28| GitHub Account | Connected to Claude Code on the web with at least one repository authenticated |

29| Slack Authentication | Your Slack account linked to your Claude account via the Claude app |

31## Setting up Claude Code in Slack

33<Steps>

34 <Step title="Install the Claude App in Slack">

35 A workspace administrator must install the Claude app from the Slack App Marketplace. Visit the [Slack App Marketplace](https://slack.com/marketplace/A08SF47R6P4) and click "Add to Slack" to begin the installation process.

36 </Step>

38 <Step title="Connect your Claude account">

39 After the app is installed, authenticate your individual Claude account:

41 1. Open the Claude app in Slack by clicking on "Claude" in your Apps section

42 2. Navigate to the App Home tab

43 3. Click "Connect" to link your Slack account with your Claude account

44 4. Complete the authentication flow in your browser

45 </Step>

47 <Step title="Configure Claude Code on the web">

48 Ensure your Claude Code on the web is properly configured:

50 * Visit [claude.ai/code](https://claude.ai/code) and sign in with the same account you connected to Slack

51 * Connect your GitHub account if not already connected

52 * Authenticate at least one repository that you want Claude to work with

53 </Step>

55 <Step title="Choose your routing mode">

56 After connecting your accounts, configure how Claude handles your messages in Slack. Navigate to the Claude App Home in Slack to find the **Routing Mode** setting.

58 | Mode | Behavior |

59 | :-------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

60 | **Code only** | Claude routes all @mentions to Claude Code sessions. Best for teams using Claude in Slack exclusively for development tasks. |

61 | **Code + Chat** | Claude analyzes each message and intelligently routes between Claude Code (for coding tasks) and Claude Chat (for writing, analysis, and general questions). Best for teams who want a single @Claude entry point for all types of work. |

63 <Note>

64 In Code + Chat mode, if Claude routes a message to Chat but you wanted a coding session, you can click "Retry as Code" to create a Claude Code session instead. Similarly, if it's routed to Code but you wanted a Chat session, you can choose that option in that thread.

65 </Note>

66 </Step>

68 <Step title="Add Claude to channels">

69 Claude is not automatically added to any channels after installation. To use Claude in a channel, invite it by typing `/invite @Claude` in that channel. Claude can only respond to @mentions in channels where it has been added.

70 </Step>

71</Steps>

73## How it works

75### Automatic detection

77When you mention @Claude in a Slack channel or thread, Claude automatically analyzes your message to determine if it's a coding task. If Claude detects coding intent, it will route your request to Claude Code on the web instead of responding as a regular chat assistant.

79You can also explicitly tell Claude to handle a request as a coding task, even if it doesn't automatically detect it.

81<Note>

82 Claude Code in Slack only works in channels (public or private). It does not work in direct messages (DMs).

83</Note>

85### Context gathering

87**From threads**: When you @mention Claude in a thread, it gathers context from all messages in that thread to understand the full conversation.

89**From channels**: When mentioned directly in a channel, Claude looks at recent channel messages for relevant context.

91This context helps Claude understand the problem, select the appropriate repository, and inform its approach to the task.

93<Warning>

94 When @Claude is invoked in Slack, Claude is given access to the conversation context to better understand your request. Claude may follow directions from other messages in the context, so users should make sure to only use Claude in trusted Slack conversations.

95</Warning>

97### Session flow

991. **Initiation**: You @mention Claude with a coding request

1002. **Detection**: Claude analyzes your message and detects coding intent

1013. **Session creation**: A new Claude Code session is created on claude.ai/code

1024. **Progress updates**: Claude posts status updates to your Slack thread as work progresses

1035. **Completion**: When finished, Claude @mentions you with a summary and action buttons

1046. **Review**: Click "View Session" to see the full transcript, or "Create PR" to open a pull request

105

106## User interface elements

107

108### App Home

109

110The App Home tab shows your connection status and allows you to connect or disconnect your Claude account from Slack.

111

112### Message actions

113

114* **View Session**: Opens the full Claude Code session in your browser where you can see all work performed, continue the session, or make additional requests.

115* **Create PR**: Creates a pull request directly from the session's changes.

116* **Retry as Code**: If Claude initially responds as a chat assistant but you wanted a coding session, click this button to retry the request as a Claude Code task.

117* **Change Repo**: Allows you to select a different repository if Claude chose incorrectly.

118

119### Repository selection

120

121Claude automatically selects a repository based on context from your Slack conversation. If multiple repositories could apply, Claude may display a dropdown allowing you to choose the correct one.

122

123## Access and permissions

124

125### User-level access

126

127| Access Type | Requirement |

128| :------------------- | :-------------------------------------------------------------- |

129| Claude Code Sessions | Each user runs sessions under their own Claude account |

130| Usage & Rate Limits | Sessions count against the individual user's plan limits |

131| Repository Access | Users can only access repositories they've personally connected |

132| Session History | Sessions appear in your Claude Code history on claude.ai/code |

133

134### Workspace-level access

135

136Slack workspace administrators control whether the Claude app is available in their workspace:

137

138| Control | Description |

139| :--------------------------- | :---------------------------------------------------------------------------------------------------------------- |

140| App installation | Workspace admins decide whether to install the Claude app from the Slack App Marketplace |

141| Enterprise Grid distribution | For Enterprise Grid organizations, organization admins can control which workspaces have access to the Claude app |

142| App removal | Removing the app from a workspace immediately revokes access for all users in that workspace |

143

144### Channel-based access control

145

146Claude is not automatically added to any channels after installation. Users must explicitly invite Claude to channels where they want to use it:

147

148* **Invite required**: Type `/invite @Claude` in any channel to add Claude to that channel

149* **Channel membership controls access**: Claude can only respond to @mentions in channels where it has been added

150* **Access gating through channels**: Admins can control who uses Claude Code by managing which channels Claude is invited to and who has access to those channels

151* **Private channel support**: Claude works in both public and private channels, giving teams flexibility in controlling visibility

152

153This channel-based model allows teams to restrict Claude Code usage to specific channels, providing an additional layer of access control beyond workspace-level permissions.

154

155## What's accessible where

156

157**In Slack**: You'll see status updates, completion summaries, and action buttons. The full transcript is preserved and always accessible.

158

159**On the web**: The complete Claude Code session with full conversation history, all code changes, file operations, and the ability to continue the session or create pull requests.

160

161For Enterprise and Teams accounts, sessions created from Claude in Slack are

162automatically visible to the organization. See [Claude Code on the Web sharing](/en/claude-code-on-the-web#sharing-sessions)

163for more details.

164

165## Best practices

166

167### Writing effective requests

168

169* **Be specific**: Include file names, function names, or error messages when relevant.

170* **Provide context**: Mention the repository or project if it's not clear from the conversation.

171* **Define success**: Explain what "done" looks like—should Claude write tests? Update documentation? Create a PR?

172* **Use threads**: Reply in threads when discussing bugs or features so Claude can gather the full context.

173

174### When to use Slack vs. web

175

176**Use Slack when**: Context already exists in a Slack discussion, you want to kick off a task asynchronously, or you're collaborating with teammates who need visibility.

177

178**Use the web directly when**: You need to upload files, want real-time interaction during development, or are working on longer, more complex tasks.

179

180## Troubleshooting

181

182### Sessions not starting

183

1841. Verify your Claude account is connected in the Claude App Home

1852. Check that you have Claude Code on the web access enabled

1863. Ensure you have at least one GitHub repository connected to Claude Code

187

188### Repository not showing

189

1901. Connect the repository in Claude Code on the web at [claude.ai/code](https://claude.ai/code)

1912. Verify your GitHub permissions for that repository

1923. Try disconnecting and reconnecting your GitHub account

193

194### Wrong repository selected

195

1961. Click the "Change Repo" button to select a different repository

1972. Include the repository name in your request for more accurate selection

198

199### Authentication errors

200

2011. Disconnect and reconnect your Claude account in the App Home

2022. Ensure you're signed into the correct Claude account in your browser

2033. Check that your Claude plan includes Claude Code access

204

205### Session expiration

206

2071. Sessions remain accessible in your Claude Code history on the web

2082. You can continue or reference past sessions from [claude.ai/code](https://claude.ai/code)

209

210## Current limitations

211

212* **GitHub only**: Currently supports repositories on GitHub.

213* **One PR at a time**: Each session can create one pull request.

214* **Rate limits apply**: Sessions use your individual Claude plan's rate limits.

215* **Web access required**: Users must have Claude Code on the web access; those without it will only get standard Claude chat responses.

216

217## Related resources

218

219<CardGroup>

220 <Card title="Claude Code on the web" icon="globe" href="/en/claude-code-on-the-web">

221 Learn more about Claude Code on the web

222 </Card>

223

224 <Card title="Claude for Slack" icon="slack" href="https://claude.com/claude-and-slack">

225 General Claude for Slack documentation

226 </Card>

227

228 <Card title="Slack App Marketplace" icon="store" href="https://slack.com/marketplace/A08SF47R6P4">

229 Install the Claude app from the Slack Marketplace

230 </Card>

231

232 <Card title="Claude Help Center" icon="circle-question" href="https://support.claude.com">

233 Get additional support

234 </Card>

235</CardGroup>

slash-commands.md +0 −497 deleted

File DeletedView Diff

~~1# Slash commands~~

~~3> Control Claude's behavior during an interactive session with slash commands.~~

~~5## Built-in slash commands~~

~~7| Command | Purpose |~~

~~8| :------------------------ | :-------------------------------------------------------------------------------------------------------------------------- |~~

~~9| `/add-dir` | Add additional working directories |~~

~~10| `/agents` | Manage custom AI subagents for specialized tasks |~~

~~11| `/bashes` | List and manage background tasks |~~

~~12| `/bug` | Report bugs (sends conversation to Anthropic) |~~

~~13| `/clear` | Clear conversation history |~~

~~14| `/compact [instructions]` | Compact conversation with optional focus instructions |~~

~~15| `/config` | Open the Settings interface (Config tab) |~~

~~16| `/context` | Visualize current context usage as a colored grid |~~

~~17| `/cost` | Show token usage statistics (see [cost tracking guide](/en/costs#using-the-cost-command) for subscription-specific details) |~~

~~18| `/doctor` | Checks the health of your Claude Code installation |~~

~~19| `/exit` | Exit the REPL |~~

~~20| `/export [filename]` | Export the current conversation to a file or clipboard |~~

~~21| `/help` | Get usage help |~~

~~22| `/hooks` | Manage hook configurations for tool events |~~

~~23| `/ide` | Manage IDE integrations and show status |~~

~~24| `/init` | Initialize project with CLAUDE.md guide |~~

~~25| `/install-github-app` | Set up Claude GitHub Actions for a repository |~~

~~26| `/login` | Switch Anthropic accounts |~~

~~27| `/logout` | Sign out from your Anthropic account |~~

~~28| `/mcp` | Manage MCP server connections and OAuth authentication |~~

~~29| `/memory` | Edit CLAUDE.md memory files |~~

~~30| `/model` | Select or change the AI model |~~

~~31| `/output-style [style]` | Set the output style directly or from a selection menu |~~

~~32| `/permissions` | View or update [permissions](/en/iam#configuring-permissions) |~~

~~33| `/plugin` | Manage Claude Code plugins |~~

~~34| `/pr-comments` | View pull request comments |~~

~~35| `/privacy-settings` | View and update your privacy settings |~~

~~36| `/release-notes` | View release notes |~~

~~37| `/resume` | Resume a conversation |~~

~~38| `/review` | Request code review |~~

~~39| `/rewind` | Rewind the conversation and/or code |~~

~~40| `/sandbox` | Enable sandboxed bash tool with filesystem and network isolation for safer, more autonomous execution |~~

~~41| `/security-review` | Complete a security review of pending changes on the current branch |~~

~~42| `/status` | Open the Settings interface (Status tab) showing version, model, account, and connectivity |~~

~~43| `/statusline` | Set up Claude Code's status line UI |~~

~~44| `/terminal-setup` | Install Shift+Enter key binding for newlines (iTerm2 and VSCode only) |~~

~~45| `/todos` | List current todo items |~~

~~46| `/usage` | Show plan usage limits and rate limit status (subscription plans only) |~~

~~47| `/vim` | Enter vim mode for alternating insert and command modes |~~

~~49## Custom slash commands~~

51Custom slash commands allow you to define frequently-used prompts as Markdown files that Claude Code can execute. Commands are organized by scope (project-specific or personal) and support namespacing through directory structures.

~~53### Syntax~~

~~55```~~

~~56/<command-name> [arguments]~~

~~57```~~

~~59#### Parameters~~

~~61| Parameter | Description |~~

~~62| :--------------- | :---------------------------------------------------------------- |~~

~~63| `<command-name>` | Name derived from the Markdown filename (without `.md` extension) |~~

~~64| `[arguments]` | Optional arguments passed to the command |~~

~~66### Command types~~

~~68#### Project commands~~

~~70Commands stored in your repository and shared with your team. When listed in `/help`, these commands show "(project)" after their description.~~

~~72**Location**: `.claude/commands/`~~

~~74In the following example, we create the `/optimize` command:~~

~~76```bash theme={null}~~

~~77# Create a project command~~

~~78mkdir -p .claude/commands~~

~~79echo "Analyze this code for performance issues and suggest optimizations:" > .claude/commands/optimize.md~~

~~80```~~

~~82#### Personal commands~~

~~84Commands available across all your projects. When listed in `/help`, these commands show "(user)" after their description.~~

~~86**Location**: `~/.claude/commands/`~~

~~88In the following example, we create the `/security-review` command:~~

~~90```bash theme={null}~~

~~91# Create a personal command~~

~~92mkdir -p ~/.claude/commands~~

~~93echo "Review this code for security vulnerabilities:" > ~/.claude/commands/security-review.md~~

~~94```~~

~~96### Features~~

~~98#### Namespacing~~

100Organize commands in subdirectories. The subdirectories are used for organization and appear in the command description, but they do not affect the command name itself. The description will show whether the command comes from the project directory (`.claude/commands`) or the user-level directory (`~/.claude/commands`), along with the subdirectory name.

~~101~~

102Conflicts between user and project level commands are not supported. Otherwise, multiple commands with the same base file name can coexist.

~~103~~

104For example, a file at `.claude/commands/frontend/component.md` creates the command `/component` with description showing "(project:frontend)".

105Meanwhile, a file at `~/.claude/commands/component.md` creates the command `/component` with description showing "(user)".

~~106~~

107#### Arguments

~~108~~

109Pass dynamic values to commands using argument placeholders:

~~110~~

111##### All arguments with `$ARGUMENTS`

~~112~~

113The `$ARGUMENTS` placeholder captures all arguments passed to the command:

~~114~~

115```bash theme={null}

116# Command definition

117echo 'Fix issue #$ARGUMENTS following our coding standards' > .claude/commands/fix-issue.md

~~118~~

119# Usage

120> /fix-issue 123 high-priority

121# $ARGUMENTS becomes: "123 high-priority"

122```

~~123~~

124##### Individual arguments with `$1`, `$2`, etc.

~~125~~

126Access specific arguments individually using positional parameters (similar to shell scripts):

~~127~~

128```bash theme={null}

129# Command definition

130echo 'Review PR #$1 with priority $2 and assign to $3' > .claude/commands/review-pr.md

~~131~~

132# Usage

133> /review-pr 456 high alice

134# $1 becomes "456", $2 becomes "high", $3 becomes "alice"

135```

~~136~~

137Use positional arguments when you need to:

~~138~~

139* Access arguments individually in different parts of your command

140* Provide defaults for missing arguments

141* Build more structured commands with specific parameter roles

~~142~~

143#### Bash command execution

~~144~~

145Execute bash commands before the slash command runs using the `!` prefix. The output is included in the command context. You *must* include `allowed-tools` with the `Bash` tool, but you can choose the specific bash commands to allow.

~~146~~

147For example:

~~148~~

149```markdown theme={null}

150allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git commit:*)

151description: Create a git commit

~~152~~

153## Context

~~154~~

155- Current git status: !`git status`

156- Current git diff (staged and unstaged changes): !`git diff HEAD`

157- Current branch: !`git branch --show-current`

158- Recent commits: !`git log --oneline -10`

~~159~~

160## Your task

~~161~~

162Based on the above changes, create a single git commit.

163```

~~164~~

165#### File references

~~166~~

167Include file contents in commands using the `@` prefix to [reference files](/en/common-workflows#reference-files-and-directories).

~~168~~

169For example:

~~170~~

171```markdown theme={null}

172# Reference a specific file

~~173~~

174Review the implementation in @src/utils/helpers.js

~~175~~

176# Reference multiple files

~~177~~

178Compare @src/old-version.js with @src/new-version.js

179```

~~180~~

181#### Thinking mode

~~182~~

183Slash commands can trigger extended thinking by including [extended thinking keywords](/en/common-workflows#use-extended-thinking).

~~184~~

185### Frontmatter

~~186~~

187Command files support frontmatter, useful for specifying metadata about the command:

~~188~~

189| Frontmatter | Purpose | Default |

190| :------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------- |

191| `allowed-tools` | List of tools the command can use | Inherits from the conversation |

193| `description` | Brief description of the command | Uses the first line from the prompt |

194| `model` | Specific model string (see [Models overview](https://docs.claude.com/en/docs/about-claude/models/overview)) | Inherits from the conversation |

195| `disable-model-invocation` | Whether to prevent `SlashCommand` tool from calling this command | false |

~~196~~

197For example:

~~198~~

199```markdown theme={null}

200allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git commit:*)

201argument-hint: [message]

202description: Create a git commit

203model: claude-3-5-haiku-20241022

~~204~~

205Create a git commit with message: $ARGUMENTS

206```

~~207~~

208Example using positional arguments:

~~209~~

210```markdown theme={null}

211argument-hint: [pr-number] [priority] [assignee]

212description: Review pull request

~~213~~

214Review PR #$1 with priority $2 and assign to $3.

215Focus on security, performance, and code style.

216```

~~217~~

218## Plugin commands

~~219~~

220[Plugins](/en/plugins) can provide custom slash commands that integrate seamlessly with Claude Code. Plugin commands work exactly like user-defined commands but are distributed through [plugin marketplaces](/en/plugin-marketplaces).

~~221~~

222### How plugin commands work

~~223~~

224Plugin commands are:

~~225~~

226* **Namespaced**: Commands can use the format `/plugin-name:command-name` to avoid conflicts (plugin prefix is optional unless there are name collisions)

227* **Automatically available**: Once a plugin is installed and enabled, its commands appear in `/help`

228* **Fully integrated**: Support all command features (arguments, frontmatter, bash execution, file references)

~~229~~

230### Plugin command structure

~~231~~

232**Location**: `commands/` directory in plugin root

~~233~~

234**File format**: Markdown files with frontmatter

~~235~~

236**Basic command structure**:

~~237~~

238```markdown theme={null}

239description: Brief description of what the command does

~~240~~

241# Command Name

~~242~~

243Detailed instructions for Claude on how to execute this command.

244Include specific guidance on parameters, expected outcomes, and any special considerations.

245```

~~246~~

247**Advanced command features**:

~~248~~

249* **Arguments**: Use placeholders like `{arg1}` in command descriptions

250* **Subdirectories**: Organize commands in subdirectories for namespacing

251* **Bash integration**: Commands can execute shell scripts and programs

252* **File references**: Commands can reference and modify project files

~~253~~

254### Invocation patterns

~~255~~

256```shell Direct command (when no conflicts) theme={null}

257/command-name

258```

~~259~~

260```shell Plugin-prefixed (when needed for disambiguation) theme={null}

261/plugin-name:command-name

262```

~~263~~

264```shell With arguments (if command supports them) theme={null}

265/command-name arg1 arg2

266```

~~267~~

268## MCP slash commands

~~269~~

270MCP servers can expose prompts as slash commands that become available in Claude Code. These commands are dynamically discovered from connected MCP servers.

~~271~~

272### Command format

~~273~~

274MCP commands follow the pattern:

~~275~~

276```

277/mcp__<server-name>__<prompt-name> [arguments]

278```

~~279~~

280### Features

~~281~~

282#### Dynamic discovery

~~283~~

284MCP commands are automatically available when:

~~285~~

286* An MCP server is connected and active

287* The server exposes prompts through the MCP protocol

288* The prompts are successfully retrieved during connection

~~289~~

290#### Arguments

~~291~~

292MCP prompts can accept arguments defined by the server:

~~293~~

294```

295# Without arguments

296> /mcp__github__list_prs

~~297~~

298# With arguments

299> /mcp__github__pr_review 456

300> /mcp__jira__create_issue "Bug title" high

301```

~~302~~

303#### Naming conventions

~~304~~

305* Server and prompt names are normalized

306* Spaces and special characters become underscores

307* Names are lowercased for consistency

~~308~~

309### Managing MCP connections

~~310~~

311Use the `/mcp` command to:

~~312~~

313* View all configured MCP servers

314* Check connection status

315* Authenticate with OAuth-enabled servers

316* Clear authentication tokens

317* View available tools and prompts from each server

~~318~~

319### MCP permissions and wildcards

~~320~~

321When configuring [permissions for MCP tools](/en/iam#tool-specific-permission-rules), note that **wildcards are not supported**:

~~322~~

323* ✅ **Correct**: `mcp__github` (approves ALL tools from the github server)

324* ✅ **Correct**: `mcp__github__get_issue` (approves specific tool)

325* ❌ **Incorrect**: `mcp__github__*` (wildcards not supported)

~~326~~

327To approve all tools from an MCP server, use just the server name: `mcp__servername`. To approve specific tools only, list each tool individually.

~~328~~

329## `SlashCommand` tool

~~330~~

331The `SlashCommand` tool allows Claude to execute [custom slash commands](/en/slash-commands#custom-slash-commands) programmatically

332during a conversation. This gives Claude the ability to invoke custom commands

333on your behalf when appropriate.

~~334~~

335To encourage Claude to trigger `SlashCommand` tool, your instructions (prompts,

336CLAUDE.md, etc.) generally need to reference the command by name with its slash.

~~337~~

338Example:

~~339~~

340```

341> Run /write-unit-test when you are about to start writing tests.

342```

~~343~~

344This tool puts each available custom slash command's metadata into context up to the

345character budget limit. You can use `/context` to monitor token usage and follow

346the operations below to manage context.

~~347~~

348### `SlashCommand` tool supported commands

~~349~~

350`SlashCommand` tool only supports custom slash commands that:

~~351~~

352* Are user-defined. Built-in commands like `/compact` and `/init` are *not* supported.

353* Have the `description` frontmatter field populated. We use the `description` in the context.

~~354~~

355For Claude Code versions >= 1.0.124, you can see which custom slash commands

356`SlashCommand` tool can invoke by running `claude --debug` and triggering a query.

~~357~~

358### Disable `SlashCommand` tool

~~359~~

360To prevent Claude from executing any slash commands via the tool:

~~361~~

362```bash theme={null}

363/permissions

364# Add to deny rules: SlashCommand

365```

~~366~~

367This will also remove SlashCommand tool (and the slash command descriptions) from context.

~~368~~

369### Disable specific commands only

~~370~~

371To prevent a specific slash command from becoming available, add

372`disable-model-invocation: true` to the slash command's frontmatter.

~~373~~

374This will also remove the command's metadata from context.

~~375~~

376### `SlashCommand` permission rules

~~377~~

378The permission rules support:

~~379~~

380* **Exact match**: `SlashCommand:/commit` (allows only `/commit` with no arguments)

381* **Prefix match**: `SlashCommand:/review-pr:*` (allows `/review-pr` with any arguments)

~~382~~

383### Character budget limit

~~384~~

385The `SlashCommand` tool includes a character budget to limit the size of command

386descriptions shown to Claude. This prevents token overflow when many commands

387are available.

~~388~~

389The budget includes each custom slash command's name, args, and description.

~~390~~

391* **Default limit**: 15,000 characters

392* **Custom limit**: Set via `SLASH_COMMAND_TOOL_CHAR_BUDGET` environment variable

~~393~~

394When the character budget is exceeded, Claude will see only a subset of the

395available commands. In `/context`, a warning will show with "M of N commands".

~~396~~

397## Skills vs slash commands

~~398~~

399**Slash commands** and **Agent Skills** serve different purposes in Claude Code:

~~400~~

401### Use slash commands for

~~402~~

403**Quick, frequently-used prompts**:

~~404~~

405* Simple prompt snippets you use often

406* Quick reminders or templates

407* Frequently-used instructions that fit in one file

~~408~~

409**Examples**:

~~410~~

411* `/review` → "Review this code for bugs and suggest improvements"

412* `/explain` → "Explain this code in simple terms"

413* `/optimize` → "Analyze this code for performance issues"

~~414~~

415### Use Skills for

~~416~~

417**Comprehensive capabilities with structure**:

~~418~~

419* Complex workflows with multiple steps

420* Capabilities requiring scripts or utilities

421* Knowledge organized across multiple files

422* Team workflows you want to standardize

~~423~~

424**Examples**:

~~425~~

426* PDF processing Skill with form-filling scripts and validation

427* Data analysis Skill with reference docs for different data types

428* Documentation Skill with style guides and templates

~~429~~

430### Key differences

~~431~~

432| Aspect | Slash Commands | Agent Skills |

433| -------------- | -------------------------------- | ----------------------------------- |

434| **Complexity** | Simple prompts | Complex capabilities |

435| **Structure** | Single .md file | Directory with SKILL.md + resources |

436| **Discovery** | Explicit invocation (`/command`) | Automatic (based on context) |

437| **Files** | One file only | Multiple files, scripts, templates |

438| **Scope** | Project or personal | Project or personal |

439| **Sharing** | Via git | Via git |

~~440~~

441### Example comparison

~~442~~

443**As a slash command**:

~~444~~

445```markdown theme={null}

446# .claude/commands/review.md

447Review this code for:

448- Security vulnerabilities

449- Performance issues

450- Code style violations

451```

~~452~~

453Usage: `/review` (manual invocation)

~~454~~

455**As a Skill**:

~~456~~

457```

458.claude/skills/code-review/

459├── SKILL.md (overview and workflows)

460├── SECURITY.md (security checklist)

461├── PERFORMANCE.md (performance patterns)

462├── STYLE.md (style guide reference)

463└── scripts/

464 └── run-linters.sh

465```

~~466~~

467Usage: "Can you review this code?" (automatic discovery)

~~468~~

469The Skill provides richer context, validation scripts, and organized reference material.

~~470~~

471### When to use each

~~472~~

473**Use slash commands**:

~~474~~

475* You invoke the same prompt repeatedly

476* The prompt fits in a single file

477* You want explicit control over when it runs

~~478~~

479**Use Skills**:

~~480~~

481* Claude should discover the capability automatically

482* Multiple files or scripts are needed

483* Complex workflows with validation steps

484* Team needs standardized, detailed guidance

~~485~~

486Both slash commands and Skills can coexist. Use the approach that fits your needs.

~~487~~

488Learn more about [Agent Skills](/en/skills).

~~489~~

490## See also

~~491~~

492* [Plugins](/en/plugins) - Extend Claude Code with custom commands through plugins

493* [Identity and Access Management](/en/iam) - Complete guide to permissions, including MCP tool permissions

494* [Interactive mode](/en/interactive-mode) - Shortcuts, input modes, and interactive features

495* [CLI reference](/en/cli-reference) - Command-line flags and options

496* [Settings](/en/settings) - Configuration options

497* [Memory management](/en/memory) - Managing Claude's memory across sessions

statusline.md +924 −124

Details

~~1# Status line configuration~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Create a custom status line for Claude Code to display contextual information~~5# Customize your status line

4 6

~~5Make Claude Code your own with a custom status line that displays at the bottom of the Claude Code interface, similar to how terminal prompts (PS1) work in shells like Oh-my-zsh.~~7> Configure a custom status bar to monitor context window usage, costs, and git status in Claude Code

6 8

~~7## Create a custom status line~~9The status line is a customizable bar at the bottom of Claude Code that runs any shell script you configure. It receives JSON session data on stdin and displays whatever your script prints, giving you a persistent, at-a-glance view of context usage, costs, git status, or anything else you want to track.

8 10

~~9You can either:~~11Status lines are useful when you:

10 12

11* Run `/statusline` to ask Claude Code to help you set up a custom status line. By default, it will try to reproduce your terminal's prompt, but you can provide additional instructions about the behavior you want to Claude Code, such as `/statusline show the model name in orange`13* Want to monitor context window usage as you work

14* Need to track session costs

15* Work across multiple sessions and need to distinguish them

16* Want git branch and status always visible

12 17

~~13* Directly add a `statusLine` command to your `.claude/settings.json`:~~18Here's an example of a [multi-line status line](#display-multiple-lines) that displays git info on the first line and a color-coded context bar on the second.

20<Frame>

21 <img src="https://mintcdn.com/claude-code/nibzesLaJVh4ydOq/images/statusline-multiline.png?fit=max&auto=format&n=nibzesLaJVh4ydOq&q=85&s=60f11387658acc9ff75158ae85f2ac87" alt="A multi-line status line showing model name, directory, git branch on the first line, and a context usage progress bar with cost and duration on the second line" width="776" height="212" data-path="images/statusline-multiline.png" />

22</Frame>

24This page walks through [setting up a basic status line](#set-up-a-status-line), explains [how the data flows](#how-status-lines-work) from Claude Code to your script, lists [all the fields you can display](#available-data), and provides [ready-to-use examples](#examples) for common patterns like git status, cost tracking, and progress bars.

26## Set up a status line

28Use the [`/statusline` command](#use-the-statusline-command) to have Claude Code generate a script for you, or [manually create a script](#manually-configure-a-status-line) and add it to your settings.

30### Use the /statusline command

32The `/statusline` command accepts natural language instructions describing what you want displayed. Claude Code generates a script file in `~/.claude/` and updates your settings automatically:

34```text theme={null}

35/statusline show model name and context percentage with a progress bar

36```

38### Manually configure a status line

40Add a `statusLine` field to your user settings (`~/.claude/settings.json`, where `~` is your home directory) or [project settings](/en/settings#settings-files). Set `type` to `"command"` and point `command` to a script path or an inline shell command. For a full walkthrough of creating a script, see [Build a status line step by step](#build-a-status-line-step-by-step).

14 41

15```json theme={null}42```json theme={null}

16{43{

17 "statusLine": {44 "statusLine": {

18 "type": "command",45 "type": "command",

19 "command": "~/.claude/statusline.sh",46 "command": "~/.claude/statusline.sh",

~~20 "padding": 0 // Optional: set to 0 to let status line go to edge~~47 "padding": 2

48 }

49}

50```

52The `command` field runs in a shell, so you can also use inline commands instead of a script file. This example uses `jq` to parse the JSON input and display the model name and context percentage:

54```json theme={null}

55{

56 "statusLine": {

57 "type": "command",

58 "command": "jq -r '\"[\\(.model.display_name)] \\(.context_window.used_percentage // 0)% context\"'"

21 }59 }

22}60}

23```61```

24 62

~~25## How it Works~~63The optional `padding` field adds extra horizontal spacing (in characters) to the status line content. Defaults to `0`. This padding is in addition to the interface's built-in spacing, so it controls relative indentation rather than absolute distance from the terminal edge.

26 64

~~27* The status line is updated when the conversation messages update~~65### Disable the status line

~~28* Updates run at most every 300ms~~

~~29* The first line of stdout from your command becomes the status line text~~

~~30* ANSI color codes are supported for styling your status line~~

~~31* Claude Code passes contextual information about the current session (model, directories, etc.) as JSON to your script via stdin~~

32 66

~~33## JSON Input Structure~~67Run `/statusline` and ask it to remove or clear your status line (e.g., `/statusline delete`, `/statusline clear`, `/statusline remove it`). You can also manually delete the `statusLine` field from your settings.json.

34 68

~~35Your status line command receives structured data via stdin in JSON format:~~69## Build a status line step by step

36 70

~~37```json theme={null}~~71This walkthrough shows what's happening under the hood by manually creating a status line that displays the current model, working directory, and context window usage percentage.

~~38{~~72

~~39 "hook_event_name": "Status",~~73<Note>Running [`/statusline`](#use-the-statusline-command) with a description of what you want configures all of this for you automatically.</Note>

~~40 "session_id": "abc123...",~~74

~~41 "transcript_path": "/path/to/transcript.json",~~75These examples use Bash scripts, which work on macOS and Linux. On Windows, see [Windows configuration](#windows-configuration) for PowerShell and Git Bash examples.

77<Frame>

78 <img src="https://mintcdn.com/claude-code/nibzesLaJVh4ydOq/images/statusline-quickstart.png?fit=max&auto=format&n=nibzesLaJVh4ydOq&q=85&s=696445e59ca0059213250651ad23db6b" alt="A status line showing model name, directory, and context percentage" width="726" height="164" data-path="images/statusline-quickstart.png" />

79</Frame>

81<Steps>

82 <Step title="Create a script that reads JSON and prints output">

83 Claude Code sends JSON data to your script via stdin. This script uses [`jq`](https://jqlang.github.io/jq/), a command-line JSON parser you may need to install, to extract the model name, directory, and context percentage, then prints a formatted line.

85 Save this to `~/.claude/statusline.sh` (where `~` is your home directory, such as `/Users/username` on macOS or `/home/username` on Linux):

87 ```bash theme={null}

88 #!/bin/bash

89 # Read JSON data that Claude Code sends to stdin

90 input=$(cat)

92 # Extract fields using jq

93 MODEL=$(echo "$input" | jq -r '.model.display_name')

94 DIR=$(echo "$input" | jq -r '.workspace.current_dir')

95 # The "// 0" provides a fallback if the field is null

96 PCT=$(echo "$input" | jq -r '.context_window.used_percentage // 0' | cut -d. -f1)

98 # Output the status line - ${DIR##*/} extracts just the folder name

99 echo "[$MODEL] 📁 ${DIR##*/} | ${PCT}% context"

100 ```

101 </Step>

102

103 <Step title="Make it executable">

104 Mark the script as executable so your shell can run it:

105

106 ```bash theme={null}

107 chmod +x ~/.claude/statusline.sh

108 ```

109 </Step>

110

111 <Step title="Add to settings">

112 Tell Claude Code to run your script as the status line. Add this configuration to `~/.claude/settings.json`, which sets `type` to `"command"` (meaning "run this shell command") and points `command` to your script:

113

114 ```json theme={null}

115 {

116 "statusLine": {

117 "type": "command",

118 "command": "~/.claude/statusline.sh"

119 }

120 }

121 ```

122

123 Your status line appears at the bottom of the interface. Settings reload automatically, but changes won't appear until your next interaction with Claude Code.

124 </Step>

125</Steps>

126

127## How status lines work

128

129Claude Code runs your script and pipes [JSON session data](#available-data) to it via stdin. Your script reads the JSON, extracts what it needs, and prints text to stdout. Claude Code displays whatever your script prints.

130

131**When it updates**

132

133Your script runs after each new assistant message, when the permission mode changes, or when vim mode toggles. Updates are debounced at 300ms, meaning rapid changes batch together and your script runs once things settle. If a new update triggers while your script is still running, the in-flight execution is cancelled. If you edit your script, the changes won't appear until your next interaction with Claude Code triggers an update.

134

135**What your script can output**

136

137* **Multiple lines**: each `echo` or `print` statement displays as a separate row. See the [multi-line example](#display-multiple-lines).

138* **Colors**: use [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors) like `\033[32m` for green (terminal must support them). See the [git status example](#git-status-with-colors).

139* **Links**: use [OSC 8 escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code#OSC) to make text clickable (Cmd+click on macOS, Ctrl+click on Windows/Linux). Requires a terminal that supports hyperlinks like iTerm2, Kitty, or WezTerm. See the [clickable links example](#clickable-links).

140

141<Note>The status line runs locally and does not consume API tokens. It temporarily hides during certain UI interactions, including autocomplete suggestions, the help menu, and permission prompts.</Note>

142

143## Available data

144

145Claude Code sends the following JSON fields to your script via stdin:

146

147| Field | Description |

148| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

149| `model.id`, `model.display_name` | Current model identifier and display name |

150| `cwd`, `workspace.current_dir` | Current working directory. Both fields contain the same value; `workspace.current_dir` is preferred for consistency with `workspace.project_dir`. |

151| `workspace.project_dir` | Directory where Claude Code was launched, which may differ from `cwd` if the working directory changes during a session |

152| `cost.total_cost_usd` | Total session cost in USD |

153| `cost.total_duration_ms` | Total wall-clock time since the session started, in milliseconds |

154| `cost.total_api_duration_ms` | Total time spent waiting for API responses in milliseconds |

155| `cost.total_lines_added`, `cost.total_lines_removed` | Lines of code changed |

156| `context_window.total_input_tokens`, `context_window.total_output_tokens` | Cumulative token counts across the session |

157| `context_window.context_window_size` | Maximum context window size in tokens. 200000 by default, or 1000000 for models with extended context. |

158| `context_window.used_percentage` | Pre-calculated percentage of context window used |

159| `context_window.remaining_percentage` | Pre-calculated percentage of context window remaining |

160| `context_window.current_usage` | Token counts from the last API call, described in [context window fields](#context-window-fields) |

161| `exceeds_200k_tokens` | Whether the total token count (input, cache, and output tokens combined) from the most recent API response exceeds 200k. This is a fixed threshold regardless of actual context window size. |

162| `rate_limits.five_hour.used_percentage`, `rate_limits.seven_day.used_percentage` | Percentage of the 5-hour or 7-day rate limit consumed, from 0 to 100 |

163| `rate_limits.five_hour.resets_at`, `rate_limits.seven_day.resets_at` | Unix epoch seconds when the 5-hour or 7-day rate limit window resets |

164| `session_id` | Unique session identifier |

165| `transcript_path` | Path to conversation transcript file |

166| `version` | Claude Code version |

167| `output_style.name` | Name of the current output style |

168| `vim.mode` | Current vim mode (`NORMAL` or `INSERT`) when [vim mode](/en/interactive-mode#vim-editor-mode) is enabled |

169| `agent.name` | Agent name when running with the `--agent` flag or agent settings configured |

170| `worktree.name` | Name of the active worktree. Present only during `--worktree` sessions |

171| `worktree.path` | Absolute path to the worktree directory |

172| `worktree.branch` | Git branch name for the worktree (for example, `"worktree-my-feature"`). Absent for hook-based worktrees |

173| `worktree.original_cwd` | The directory Claude was in before entering the worktree |

174| `worktree.original_branch` | Git branch checked out before entering the worktree. Absent for hook-based worktrees |

175

176<Accordion title="Full JSON schema">

177 Your status line command receives this JSON structure via stdin:

178

179 ```json theme={null}

180 {

42 "cwd": "/current/working/directory",181 "cwd": "/current/working/directory",

182 "session_id": "abc123...",

183 "transcript_path": "/path/to/transcript.jsonl",

43 "model": {184 "model": {

~~44 "id": "claude-opus-4-1",~~185 "id": "claude-opus-4-6",

45 "display_name": "Opus"186 "display_name": "Opus"

46 },187 },

47 "workspace": {188 "workspace": {

58 "total_api_duration_ms": 2300,199 "total_api_duration_ms": 2300,

59 "total_lines_added": 156,200 "total_lines_added": 156,

60 "total_lines_removed": 23201 "total_lines_removed": 23

202 },

203 "context_window": {

204 "total_input_tokens": 15234,

205 "total_output_tokens": 4521,

206 "context_window_size": 200000,

207 "used_percentage": 8,

208 "remaining_percentage": 92,

209 "current_usage": {

210 "input_tokens": 8500,

211 "output_tokens": 1200,

212 "cache_creation_input_tokens": 5000,

213 "cache_read_input_tokens": 2000

61 }214 }

~~62}~~215 },

~~63```~~216 "exceeds_200k_tokens": false,

217 "rate_limits": {

218 "five_hour": {

219 "used_percentage": 23.5,

220 "resets_at": 1738425600

221 },

222 "seven_day": {

223 "used_percentage": 41.2,

224 "resets_at": 1738857600

225 }

226 },

227 "vim": {

228 "mode": "NORMAL"

229 },

230 "agent": {

231 "name": "security-reviewer"

232 },

233 "worktree": {

234 "name": "my-feature",

235 "path": "/path/to/.claude/worktrees/my-feature",

236 "branch": "worktree-my-feature",

237 "original_cwd": "/path/to/project",

238 "original_branch": "main"

239 }

240 }

241 ```

64 242

~~65## Example Scripts~~243 **Fields that may be absent** (not present in JSON):

66 244

~~67### Simple Status Line~~245 * `vim`: appears only when vim mode is enabled

246 * `agent`: appears only when running with the `--agent` flag or agent settings configured

247 * `worktree`: appears only during `--worktree` sessions. When present, `branch` and `original_branch` may also be absent for hook-based worktrees

248 * `rate_limits`: appears only for Claude.ai subscribers (Pro/Max) after the first API response in the session. Each window (`five_hour`, `seven_day`) may be independently absent. Use `jq -r '.rate_limits.five_hour.used_percentage // empty'` to handle absence gracefully.

68 249

~~69```bash theme={null}~~250 **Fields that may be `null`**:

~~70#!/bin/bash~~

~~71# Read JSON input from stdin~~

~~72input=$(cat)~~

73 251

~~74# Extract values using jq~~252 * `context_window.current_usage`: `null` before the first API call in a session

~~75MODEL_DISPLAY=$(echo "$input" | jq -r '.model.display_name')~~253 * `context_window.used_percentage`, `context_window.remaining_percentage`: may be `null` early in the session

~~76CURRENT_DIR=$(echo "$input" | jq -r '.workspace.current_dir')~~

77 254

~~78echo "[$MODEL_DISPLAY] 📁 ${CURRENT_DIR##*/}"~~255 Handle missing fields with conditional access and null values with fallback defaults in your scripts.

~~79```~~256</Accordion>

257

258### Context window fields

259

260The `context_window` object provides two ways to track context usage:

261

262* **Cumulative totals** (`total_input_tokens`, `total_output_tokens`): sum of all tokens across the entire session, useful for tracking total consumption

263* **Current usage** (`current_usage`): token counts from the most recent API call, use this for accurate context percentage since it reflects the actual context state

264

265The `current_usage` object contains:

266

267* `input_tokens`: input tokens in current context

268* `output_tokens`: output tokens generated

269* `cache_creation_input_tokens`: tokens written to cache

270* `cache_read_input_tokens`: tokens read from cache

271

272The `used_percentage` field is calculated from input tokens only: `input_tokens + cache_creation_input_tokens + cache_read_input_tokens`. It does not include `output_tokens`.

273

274If you calculate context percentage manually from `current_usage`, use the same input-only formula to match `used_percentage`.

275

276The `current_usage` object is `null` before the first API call in a session.

277

278## Examples

80 279

~~81### Git-Aware Status Line~~280These examples show common status line patterns. To use any example:

82 281

~~83```bash theme={null}~~2821. Save the script to a file like `~/.claude/statusline.sh` (or `.py`/`.js`)

~~84#!/bin/bash~~2832. Make it executable: `chmod +x ~/.claude/statusline.sh`

~~85# Read JSON input from stdin~~2843. Add the path to your [settings](#manually-configure-a-status-line)

~~86input=$(cat)~~

87 285

~~88# Extract values using jq~~286The Bash examples use [`jq`](https://jqlang.github.io/jq/) to parse JSON. Python and Node.js have built-in JSON parsing.

~~89MODEL_DISPLAY=$(echo "$input" | jq -r '.model.display_name')~~

~~90CURRENT_DIR=$(echo "$input" | jq -r '.workspace.current_dir')~~

91 287

~~92# Show git branch if in a git repo~~288### Context window usage

~~93GIT_BRANCH=""~~289

~~94if git rev-parse --git-dir > /dev/null 2>&1; then~~290Display the current model and context window usage with a visual progress bar. Each script reads JSON from stdin, extracts the `used_percentage` field, and builds a 10-character bar where filled blocks (▓) represent usage:

291

292<Frame>

293 <img src="https://mintcdn.com/claude-code/nibzesLaJVh4ydOq/images/statusline-context-window-usage.png?fit=max&auto=format&n=nibzesLaJVh4ydOq&q=85&s=15b58ab3602f036939145dde3165c6f7" alt="A status line showing model name and a progress bar with percentage" width="448" height="152" data-path="images/statusline-context-window-usage.png" />

294</Frame>

295

296<CodeGroup>

297 ```bash Bash theme={null}

298 #!/bin/bash

299 # Read all of stdin into a variable

300 input=$(cat)

301

302 # Extract fields with jq, "// 0" provides fallback for null

303 MODEL=$(echo "$input" | jq -r '.model.display_name')

304 PCT=$(echo "$input" | jq -r '.context_window.used_percentage // 0' | cut -d. -f1)

305

306 # Build progress bar: printf -v creates a run of spaces, then

307 # ${var// /▓} replaces each space with a block character

308 BAR_WIDTH=10

309 FILLED=$((PCT * BAR_WIDTH / 100))

310 EMPTY=$((BAR_WIDTH - FILLED))

311 BAR=""

312 [ "$FILLED" -gt 0 ] && printf -v FILL "%${FILLED}s" && BAR="${FILL// /▓}"

313 [ "$EMPTY" -gt 0 ] && printf -v PAD "%${EMPTY}s" && BAR="${BAR}${PAD// /░}"

314

315 echo "[$MODEL] $BAR $PCT%"

316 ```

317

318 ```python Python theme={null}

319 #!/usr/bin/env python3

320 import json, sys

321

322 # json.load reads and parses stdin in one step

323 data = json.load(sys.stdin)

324 model = data['model']['display_name']

325 # "or 0" handles null values

326 pct = int(data.get('context_window', {}).get('used_percentage', 0) or 0)

327

328 # String multiplication builds the bar

329 filled = pct * 10 // 100

330 bar = '▓' * filled + '░' * (10 - filled)

331

332 print(f"[{model}] {bar} {pct}%")

333 ```

334

335 ```javascript Node.js theme={null}

336 #!/usr/bin/env node

337 // Node.js reads stdin asynchronously with events

338 let input = '';

339 process.stdin.on('data', chunk => input += chunk);

340 process.stdin.on('end', () => {

341 const data = JSON.parse(input);

342 const model = data.model.display_name;

343 // Optional chaining (?.) safely handles null fields

344 const pct = Math.floor(data.context_window?.used_percentage || 0);

345

346 // String.repeat() builds the bar

347 const filled = Math.floor(pct * 10 / 100);

348 const bar = '▓'.repeat(filled) + '░'.repeat(10 - filled);

349

350 console.log(`[${model}] ${bar} ${pct}%`);

351 });

352 ```

353</CodeGroup>

354

355### Git status with colors

356

357Show git branch with color-coded indicators for staged and modified files. This script uses [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors) for terminal colors: `\033[32m` is green, `\033[33m` is yellow, and `\033[0m` resets to default.

358

359<Frame>

360 <img src="https://mintcdn.com/claude-code/nibzesLaJVh4ydOq/images/statusline-git-context.png?fit=max&auto=format&n=nibzesLaJVh4ydOq&q=85&s=e656f34f90d1d9a1d0e220988914345f" alt="A status line showing model, directory, git branch, and colored indicators for staged and modified files" width="742" height="178" data-path="images/statusline-git-context.png" />

361</Frame>

362

363Each script checks if the current directory is a git repository, counts staged and modified files, and displays color-coded indicators:

364

365<CodeGroup>

366 ```bash Bash theme={null}

367 #!/bin/bash

368 input=$(cat)

369

370 MODEL=$(echo "$input" | jq -r '.model.display_name')

371 DIR=$(echo "$input" | jq -r '.workspace.current_dir')

372

373 GREEN='\033[32m'

374 YELLOW='\033[33m'

375 RESET='\033[0m'

376

377 if git rev-parse --git-dir > /dev/null 2>&1; then

95 BRANCH=$(git branch --show-current 2>/dev/null)378 BRANCH=$(git branch --show-current 2>/dev/null)

~~96 if [ -n "$BRANCH" ]; then~~379 STAGED=$(git diff --cached --numstat 2>/dev/null | wc -l | tr -d ' ')

~~97 GIT_BRANCH=" | 🌿 $BRANCH"~~380 MODIFIED=$(git diff --numstat 2>/dev/null | wc -l | tr -d ' ')

381

382 GIT_STATUS=""

383 [ "$STAGED" -gt 0 ] && GIT_STATUS="${GREEN}+${STAGED}${RESET}"

384 [ "$MODIFIED" -gt 0 ] && GIT_STATUS="${GIT_STATUS}${YELLOW}~${MODIFIED}${RESET}"

385

386 echo -e "[$MODEL] 📁 ${DIR##*/} | 🌿 $BRANCH $GIT_STATUS"

387 else

388 echo "[$MODEL] 📁 ${DIR##*/}"

98 fi389 fi

~~99fi~~390 ```

100 391

101echo "[$MODEL_DISPLAY] 📁 ${CURRENT_DIR##*/}$GIT_BRANCH"392 ```python Python theme={null}

102```393 #!/usr/bin/env python3

394 import json, sys, subprocess, os

395

396 data = json.load(sys.stdin)

397 model = data['model']['display_name']

398 directory = os.path.basename(data['workspace']['current_dir'])

399

400 GREEN, YELLOW, RESET = '\033[32m', '\033[33m', '\033[0m'

401

402 try:

403 subprocess.check_output(['git', 'rev-parse', '--git-dir'], stderr=subprocess.DEVNULL)

404 branch = subprocess.check_output(['git', 'branch', '--show-current'], text=True).strip()

405 staged_output = subprocess.check_output(['git', 'diff', '--cached', '--numstat'], text=True).strip()

406 modified_output = subprocess.check_output(['git', 'diff', '--numstat'], text=True).strip()

407 staged = len(staged_output.split('\n')) if staged_output else 0

408 modified = len(modified_output.split('\n')) if modified_output else 0

409

410 git_status = f"{GREEN}+{staged}{RESET}" if staged else ""

411 git_status += f"{YELLOW}~{modified}{RESET}" if modified else ""

412

413 print(f"[{model}] 📁 {directory} | 🌿 {branch} {git_status}")

414 except:

415 print(f"[{model}] 📁 {directory}")

416 ```

417

418 ```javascript Node.js theme={null}

419 #!/usr/bin/env node

420 const { execSync } = require('child_process');

421 const path = require('path');

422

423 let input = '';

424 process.stdin.on('data', chunk => input += chunk);

425 process.stdin.on('end', () => {

426 const data = JSON.parse(input);

427 const model = data.model.display_name;

428 const dir = path.basename(data.workspace.current_dir);

429

430 const GREEN = '\x1b[32m', YELLOW = '\x1b[33m', RESET = '\x1b[0m';

431

432 try {

433 execSync('git rev-parse --git-dir', { stdio: 'ignore' });

434 const branch = execSync('git branch --show-current', { encoding: 'utf8' }).trim();

435 const staged = execSync('git diff --cached --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

436 const modified = execSync('git diff --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

437

438 let gitStatus = staged ? `${GREEN}+${staged}${RESET}` : '';

439 gitStatus += modified ? `${YELLOW}~${modified}${RESET}` : '';

440

441 console.log(`[${model}] 📁 ${dir} | 🌿 ${branch} ${gitStatus}`);

442 } catch {

443 console.log(`[${model}] 📁 ${dir}`);

444 }

445 });

446 ```

447</CodeGroup>

448

449### Cost and duration tracking

450

451Track your session's API costs and elapsed time. The `cost.total_cost_usd` field accumulates the cost of all API calls in the current session. The `cost.total_duration_ms` field measures total elapsed time since the session started, while `cost.total_api_duration_ms` tracks only the time spent waiting for API responses.

452

453Each script formats cost as currency and converts milliseconds to minutes and seconds:

454

455<Frame>

456 <img src="https://mintcdn.com/claude-code/nibzesLaJVh4ydOq/images/statusline-cost-tracking.png?fit=max&auto=format&n=nibzesLaJVh4ydOq&q=85&s=e3444a51fe6f3440c134bd5f1f08ad29" alt="A status line showing model name, session cost, and duration" width="588" height="180" data-path="images/statusline-cost-tracking.png" />

457</Frame>

458

459<CodeGroup>

460 ```bash Bash theme={null}

461 #!/bin/bash

462 input=$(cat)

463

464 MODEL=$(echo "$input" | jq -r '.model.display_name')

465 COST=$(echo "$input" | jq -r '.cost.total_cost_usd // 0')

466 DURATION_MS=$(echo "$input" | jq -r '.cost.total_duration_ms // 0')

467

468 COST_FMT=$(printf '$%.2f' "$COST")

469 DURATION_SEC=$((DURATION_MS / 1000))

470 MINS=$((DURATION_SEC / 60))

471 SECS=$((DURATION_SEC % 60))

472

473 echo "[$MODEL] 💰 $COST_FMT | ⏱️ ${MINS}m ${SECS}s"

474 ```

475

476 ```python Python theme={null}

477 #!/usr/bin/env python3

478 import json, sys

479

480 data = json.load(sys.stdin)

481 model = data['model']['display_name']

482 cost = data.get('cost', {}).get('total_cost_usd', 0) or 0

483 duration_ms = data.get('cost', {}).get('total_duration_ms', 0) or 0

484

485 duration_sec = duration_ms // 1000

486 mins, secs = duration_sec // 60, duration_sec % 60

487

488 print(f"[{model}] 💰 ${cost:.2f} | ⏱️ {mins}m {secs}s")

489 ```

490

491 ```javascript Node.js theme={null}

492 #!/usr/bin/env node

493 let input = '';

494 process.stdin.on('data', chunk => input += chunk);

495 process.stdin.on('end', () => {

496 const data = JSON.parse(input);

497 const model = data.model.display_name;

498 const cost = data.cost?.total_cost_usd || 0;

499 const durationMs = data.cost?.total_duration_ms || 0;

103 500

104### Python Example501 const durationSec = Math.floor(durationMs / 1000);

502 const mins = Math.floor(durationSec / 60);

503 const secs = durationSec % 60;

105 504

106```python theme={null}505 console.log(`[${model}] 💰 $${cost.toFixed(2)} | ⏱️ ${mins}m ${secs}s`);

107#!/usr/bin/env python3506 });

108import json507 ```

109import sys508</CodeGroup>

110import os

111 509

112# Read JSON from stdin510### Display multiple lines

113data = json.load(sys.stdin)

114 511

115# Extract values512Your script can output multiple lines to create a richer display. Each `echo` statement produces a separate row in the status area.

116model = data['model']['display_name']513

117current_dir = os.path.basename(data['workspace']['current_dir'])514<Frame>

515 <img src="https://mintcdn.com/claude-code/nibzesLaJVh4ydOq/images/statusline-multiline.png?fit=max&auto=format&n=nibzesLaJVh4ydOq&q=85&s=60f11387658acc9ff75158ae85f2ac87" alt="A multi-line status line showing model name, directory, git branch on the first line, and a context usage progress bar with cost and duration on the second line" width="776" height="212" data-path="images/statusline-multiline.png" />

516</Frame>

517

518This example combines several techniques: threshold-based colors (green under 70%, yellow 70-89%, red 90%+), a progress bar, and git branch info. Each `print` or `echo` statement creates a separate row:

519

520<CodeGroup>

521 ```bash Bash theme={null}

522 #!/bin/bash

523 input=$(cat)

524

525 MODEL=$(echo "$input" | jq -r '.model.display_name')

526 DIR=$(echo "$input" | jq -r '.workspace.current_dir')

527 COST=$(echo "$input" | jq -r '.cost.total_cost_usd // 0')

528 PCT=$(echo "$input" | jq -r '.context_window.used_percentage // 0' | cut -d. -f1)

529 DURATION_MS=$(echo "$input" | jq -r '.cost.total_duration_ms // 0')

530

531 CYAN='\033[36m'; GREEN='\033[32m'; YELLOW='\033[33m'; RED='\033[31m'; RESET='\033[0m'

532

533 # Pick bar color based on context usage

534 if [ "$PCT" -ge 90 ]; then BAR_COLOR="$RED"

535 elif [ "$PCT" -ge 70 ]; then BAR_COLOR="$YELLOW"

536 else BAR_COLOR="$GREEN"; fi

537

538 FILLED=$((PCT / 10)); EMPTY=$((10 - FILLED))

539 printf -v FILL "%${FILLED}s"; printf -v PAD "%${EMPTY}s"

540 BAR="${FILL// /█}${PAD// /░}"

541

542 MINS=$((DURATION_MS / 60000)); SECS=$(((DURATION_MS % 60000) / 1000))

543

544 BRANCH=""

545 git rev-parse --git-dir > /dev/null 2>&1 && BRANCH=" | 🌿 $(git branch --show-current 2>/dev/null)"

546

547 echo -e "${CYAN}[$MODEL]${RESET} 📁 ${DIR##*/}$BRANCH"

548 COST_FMT=$(printf '$%.2f' "$COST")

549 echo -e "${BAR_COLOR}${BAR}${RESET} ${PCT}% | ${YELLOW}${COST_FMT}${RESET} | ⏱️ ${MINS}m ${SECS}s"

550 ```

551

552 ```python Python theme={null}

553 #!/usr/bin/env python3

554 import json, sys, subprocess, os

555

556 data = json.load(sys.stdin)

557 model = data['model']['display_name']

558 directory = os.path.basename(data['workspace']['current_dir'])

559 cost = data.get('cost', {}).get('total_cost_usd', 0) or 0

560 pct = int(data.get('context_window', {}).get('used_percentage', 0) or 0)

561 duration_ms = data.get('cost', {}).get('total_duration_ms', 0) or 0

562

563 CYAN, GREEN, YELLOW, RED, RESET = '\033[36m', '\033[32m', '\033[33m', '\033[31m', '\033[0m'

564

565 bar_color = RED if pct >= 90 else YELLOW if pct >= 70 else GREEN

566 filled = pct // 10

567 bar = '█' * filled + '░' * (10 - filled)

568

569 mins, secs = duration_ms // 60000, (duration_ms % 60000) // 1000

118 570

119# Check for git branch

120git_branch = ""

121if os.path.exists('.git'):

122 try:571 try:

123 with open('.git/HEAD', 'r') as f:572 branch = subprocess.check_output(['git', 'branch', '--show-current'], text=True, stderr=subprocess.DEVNULL).strip()

124 ref = f.read().strip()573 branch = f" | 🌿 {branch}" if branch else ""

125 if ref.startswith('ref: refs/heads/'):

126 git_branch = f" | 🌿 {ref.replace('ref: refs/heads/', '')}"

127 except:574 except:

128 pass575 branch = ""

129 576

130print(f"[{model}] 📁 {current_dir}{git_branch}")577 print(f"{CYAN}[{model}]{RESET} 📁 {directory}{branch}")

131```578 print(f"{bar_color}{bar}{RESET} {pct}% | {YELLOW}${cost:.2f}{RESET} | ⏱️ {mins}m {secs}s")

579 ```

580

581 ```javascript Node.js theme={null}

582 #!/usr/bin/env node

583 const { execSync } = require('child_process');

584 const path = require('path');

585

586 let input = '';

587 process.stdin.on('data', chunk => input += chunk);

588 process.stdin.on('end', () => {

589 const data = JSON.parse(input);

590 const model = data.model.display_name;

591 const dir = path.basename(data.workspace.current_dir);

592 const cost = data.cost?.total_cost_usd || 0;

593 const pct = Math.floor(data.context_window?.used_percentage || 0);

594 const durationMs = data.cost?.total_duration_ms || 0;

595

596 const CYAN = '\x1b[36m', GREEN = '\x1b[32m', YELLOW = '\x1b[33m', RED = '\x1b[31m', RESET = '\x1b[0m';

597

598 const barColor = pct >= 90 ? RED : pct >= 70 ? YELLOW : GREEN;

599 const filled = Math.floor(pct / 10);

600 const bar = '█'.repeat(filled) + '░'.repeat(10 - filled);

601

602 const mins = Math.floor(durationMs / 60000);

603 const secs = Math.floor((durationMs % 60000) / 1000);

604

605 let branch = '';

606 try {

607 branch = execSync('git branch --show-current', { encoding: 'utf8', stdio: ['pipe', 'pipe', 'ignore'] }).trim();

608 branch = branch ? ` | 🌿 ${branch}` : '';

609 } catch {}

610

611 console.log(`${CYAN}[${model}]${RESET} 📁 ${dir}${branch}`);

612 console.log(`${barColor}${bar}${RESET} ${pct}% | ${YELLOW}$${cost.toFixed(2)}${RESET} | ⏱️ ${mins}m ${secs}s`);

613 });

614 ```

615</CodeGroup>

616

617### Clickable links

618

619This example creates a clickable link to your GitHub repository. It reads the git remote URL, converts SSH format to HTTPS with `sed`, and wraps the repo name in OSC 8 escape codes. Hold Cmd (macOS) or Ctrl (Windows/Linux) and click to open the link in your browser.

620

621<Frame>

622 <img src="https://mintcdn.com/claude-code/nibzesLaJVh4ydOq/images/statusline-links.png?fit=max&auto=format&n=nibzesLaJVh4ydOq&q=85&s=4bcc6e7deb7cf52f41ab85a219b52661" alt="A status line showing a clickable link to a GitHub repository" width="726" height="198" data-path="images/statusline-links.png" />

623</Frame>

624

625Each script gets the git remote URL, converts SSH format to HTTPS, and wraps the repo name in OSC 8 escape codes. The Bash version uses `printf '%b'` which interprets backslash escapes more reliably than `echo -e` across different shells:

132 626

133### Node.js Example627<CodeGroup>

628 ```bash Bash theme={null}

629 #!/bin/bash

630 input=$(cat)

134 631

135```javascript theme={null}632 MODEL=$(echo "$input" | jq -r '.model.display_name')

136#!/usr/bin/env node

137 633

138const fs = require('fs');634 # Convert git SSH URL to HTTPS

139const path = require('path');635 REMOTE=$(git remote get-url origin 2>/dev/null | sed 's/git@github.com:/https:\/\/github.com\//' | sed 's/\.git$//')

140 636

141// Read JSON from stdin637 if [ -n "$REMOTE" ]; then

142let input = '';638 REPO_NAME=$(basename "$REMOTE")

143process.stdin.on('data', chunk => input += chunk);639 # OSC 8 format: \e]8;;URL\a then TEXT then \e]8;;\a

144process.stdin.on('end', () => {640 # printf %b interprets escape sequences reliably across shells

641 printf '%b' "[$MODEL] 🔗 \e]8;;${REMOTE}\a${REPO_NAME}\e]8;;\a\n"

642 else

643 echo "[$MODEL]"

644 fi

645 ```

646

647 ```python Python theme={null}

648 #!/usr/bin/env python3

649 import json, sys, subprocess, re, os

650

651 data = json.load(sys.stdin)

652 model = data['model']['display_name']

653

654 # Get git remote URL

655 try:

656 remote = subprocess.check_output(

657 ['git', 'remote', 'get-url', 'origin'],

658 stderr=subprocess.DEVNULL, text=True

659 ).strip()

660 # Convert SSH to HTTPS format

661 remote = re.sub(r'^git@github\.com:', 'https://github.com/', remote)

662 remote = re.sub(r'\.git$', '', remote)

663 repo_name = os.path.basename(remote)

664 # OSC 8 escape sequences

665 link = f"\033]8;;{remote}\a{repo_name}\033]8;;\a"

666 print(f"[{model}] 🔗 {link}")

667 except:

668 print(f"[{model}]")

669 ```

670

671 ```javascript Node.js theme={null}

672 #!/usr/bin/env node

673 const { execSync } = require('child_process');

674 const path = require('path');

675

676 let input = '';

677 process.stdin.on('data', chunk => input += chunk);

678 process.stdin.on('end', () => {

145 const data = JSON.parse(input);679 const data = JSON.parse(input);

680 const model = data.model.display_name;

681

682 try {

683 let remote = execSync('git remote get-url origin', { encoding: 'utf8', stdio: ['pipe', 'pipe', 'ignore'] }).trim();

684 // Convert SSH to HTTPS format

685 remote = remote.replace(/^git@github\.com:/, 'https://github.com/').replace(/\.git$/, '');

686 const repoName = path.basename(remote);

687 // OSC 8 escape sequences

688 const link = `\x1b]8;;${remote}\x07${repoName}\x1b]8;;\x07`;

689 console.log(`[${model}] 🔗 ${link}`);

690 } catch {

691 console.log(`[${model}]`);

692 }

693 });

694 ```

695</CodeGroup>

696

697### Rate limit usage

698

699Display Claude.ai subscription rate limit usage in the status line. The `rate_limits` object contains `five_hour` (5-hour rolling window) and `seven_day` (weekly) windows. Each window provides `used_percentage` (0-100) and `resets_at` (Unix epoch seconds when the window resets).

700

701This field is only present for Claude.ai subscribers (Pro/Max) after the first API response. Each script handles the absent field gracefully:

146 702

147 // Extract values703<CodeGroup>

704 ```bash Bash theme={null}

705 #!/bin/bash

706 input=$(cat)

707

708 MODEL=$(echo "$input" | jq -r '.model.display_name')

709 # "// empty" produces no output when rate_limits is absent

710 FIVE_H=$(echo "$input" | jq -r '.rate_limits.five_hour.used_percentage // empty')

711 WEEK=$(echo "$input" | jq -r '.rate_limits.seven_day.used_percentage // empty')

712

713 LIMITS=""

714 [ -n "$FIVE_H" ] && LIMITS="5h: $(printf '%.0f' "$FIVE_H")%"

715 [ -n "$WEEK" ] && LIMITS="${LIMITS:+$LIMITS }7d: $(printf '%.0f' "$WEEK")%"

716

717 [ -n "$LIMITS" ] && echo "[$MODEL] | $LIMITS" || echo "[$MODEL]"

718 ```

719

720 ```python Python theme={null}

721 #!/usr/bin/env python3

722 import json, sys

723

724 data = json.load(sys.stdin)

725 model = data['model']['display_name']

726

727 parts = []

728 rate = data.get('rate_limits', {})

729 five_h = rate.get('five_hour', {}).get('used_percentage')

730 week = rate.get('seven_day', {}).get('used_percentage')

731

732 if five_h is not None:

733 parts.append(f"5h: {five_h:.0f}%")

734 if week is not None:

735 parts.append(f"7d: {week:.0f}%")

736

737 if parts:

738 print(f"[{model}] | {' '.join(parts)}")

739 else:

740 print(f"[{model}]")

741 ```

742

743 ```javascript Node.js theme={null}

744 #!/usr/bin/env node

745 let input = '';

746 process.stdin.on('data', chunk => input += chunk);

747 process.stdin.on('end', () => {

748 const data = JSON.parse(input);

148 const model = data.model.display_name;749 const model = data.model.display_name;

149 const currentDir = path.basename(data.workspace.current_dir);

150 750

151 // Check for git branch751 const parts = [];

152 let gitBranch = '';752 const fiveH = data.rate_limits?.five_hour?.used_percentage;

753 const week = data.rate_limits?.seven_day?.used_percentage;

754

755 if (fiveH != null) parts.push(`5h: ${Math.round(fiveH)}%`);

756 if (week != null) parts.push(`7d: ${Math.round(week)}%`);

757

758 console.log(parts.length ? `[${model}] | ${parts.join(' ')}` : `[${model}]`);

759 });

760 ```

761</CodeGroup>

762

763### Cache expensive operations

764

765Your status line script runs frequently during active sessions. Commands like `git status` or `git diff` can be slow, especially in large repositories. This example caches git information to a temp file and only refreshes it every 5 seconds.

766

767Use a stable, fixed filename for the cache file like `/tmp/statusline-git-cache`. Each status line invocation runs as a new process, so process-based identifiers like `$$`, `os.getpid()`, or `process.pid` produce a different value every time and the cache is never reused.

768

769Each script checks if the cache file is missing or older than 5 seconds before running git commands:

770

771<CodeGroup>

772 ```bash Bash theme={null}

773 #!/bin/bash

774 input=$(cat)

775

776 MODEL=$(echo "$input" | jq -r '.model.display_name')

777 DIR=$(echo "$input" | jq -r '.workspace.current_dir')

778

779 CACHE_FILE="/tmp/statusline-git-cache"

780 CACHE_MAX_AGE=5 # seconds

781

782 cache_is_stale() {

783 [ ! -f "$CACHE_FILE" ] || \

784 # stat -f %m is macOS, stat -c %Y is Linux

785 [ $(($(date +%s) - $(stat -f %m "$CACHE_FILE" 2>/dev/null || stat -c %Y "$CACHE_FILE" 2>/dev/null || echo 0))) -gt $CACHE_MAX_AGE ]

786 }

787

788 if cache_is_stale; then

789 if git rev-parse --git-dir > /dev/null 2>&1; then

790 BRANCH=$(git branch --show-current 2>/dev/null)

791 STAGED=$(git diff --cached --numstat 2>/dev/null | wc -l | tr -d ' ')

792 MODIFIED=$(git diff --numstat 2>/dev/null | wc -l | tr -d ' ')

793 echo "$BRANCH|$STAGED|$MODIFIED" > "$CACHE_FILE"

794 else

795 echo "||" > "$CACHE_FILE"

796 fi

797 fi

798

799 IFS='|' read -r BRANCH STAGED MODIFIED < "$CACHE_FILE"

800

801 if [ -n "$BRANCH" ]; then

802 echo "[$MODEL] 📁 ${DIR##*/} | 🌿 $BRANCH +$STAGED ~$MODIFIED"

803 else

804 echo "[$MODEL] 📁 ${DIR##*/}"

805 fi

806 ```

807

808 ```python Python theme={null}

809 #!/usr/bin/env python3

810 import json, sys, subprocess, os, time

811

812 data = json.load(sys.stdin)

813 model = data['model']['display_name']

814 directory = os.path.basename(data['workspace']['current_dir'])

815

816 CACHE_FILE = "/tmp/statusline-git-cache"

817 CACHE_MAX_AGE = 5 # seconds

818

819 def cache_is_stale():

820 if not os.path.exists(CACHE_FILE):

821 return True

822 return time.time() - os.path.getmtime(CACHE_FILE) > CACHE_MAX_AGE

823

824 if cache_is_stale():

825 try:

826 subprocess.check_output(['git', 'rev-parse', '--git-dir'], stderr=subprocess.DEVNULL)

827 branch = subprocess.check_output(['git', 'branch', '--show-current'], text=True).strip()

828 staged = subprocess.check_output(['git', 'diff', '--cached', '--numstat'], text=True).strip()

829 modified = subprocess.check_output(['git', 'diff', '--numstat'], text=True).strip()

830 staged_count = len(staged.split('\n')) if staged else 0

831 modified_count = len(modified.split('\n')) if modified else 0

832 with open(CACHE_FILE, 'w') as f:

833 f.write(f"{branch}|{staged_count}|{modified_count}")

834 except:

835 with open(CACHE_FILE, 'w') as f:

836 f.write("||")

837

838 with open(CACHE_FILE) as f:

839 branch, staged, modified = f.read().strip().split('|')

840

841 if branch:

842 print(f"[{model}] 📁 {directory} | 🌿 {branch} +{staged} ~{modified}")

843 else:

844 print(f"[{model}] 📁 {directory}")

845 ```

846

847 ```javascript Node.js theme={null}

848 #!/usr/bin/env node

849 const { execSync } = require('child_process');

850 const fs = require('fs');

851 const path = require('path');

852

853 let input = '';

854 process.stdin.on('data', chunk => input += chunk);

855 process.stdin.on('end', () => {

856 const data = JSON.parse(input);

857 const model = data.model.display_name;

858 const dir = path.basename(data.workspace.current_dir);

859

860 const CACHE_FILE = '/tmp/statusline-git-cache';

861 const CACHE_MAX_AGE = 5; // seconds

862

863 const cacheIsStale = () => {

864 if (!fs.existsSync(CACHE_FILE)) return true;

865 return (Date.now() / 1000) - fs.statSync(CACHE_FILE).mtimeMs / 1000 > CACHE_MAX_AGE;

866 };

867

868 if (cacheIsStale()) {

153 try {869 try {

154 const headContent = fs.readFileSync('.git/HEAD', 'utf8').trim();870 execSync('git rev-parse --git-dir', { stdio: 'ignore' });

155 if (headContent.startsWith('ref: refs/heads/')) {871 const branch = execSync('git branch --show-current', { encoding: 'utf8' }).trim();

156 gitBranch = ` | 🌿 ${headContent.replace('ref: refs/heads/', '')}`;872 const staged = execSync('git diff --cached --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

873 const modified = execSync('git diff --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

874 fs.writeFileSync(CACHE_FILE, `${branch}|${staged}|${modified}`);

875 } catch {

876 fs.writeFileSync(CACHE_FILE, '||');

157 }877 }

158 } catch (e) {

159 // Not a git repo or can't read HEAD

160 }878 }

161 879

162 console.log(`[${model}] 📁 ${currentDir}${gitBranch}`);880 const [branch, staged, modified] = fs.readFileSync(CACHE_FILE, 'utf8').trim().split('|');

163});

164```

165 881

166### Helper Function Approach882 if (branch) {

~~167~~ 883 console.log(`[${model}] 📁 ${dir} | 🌿 ${branch} +${staged} ~${modified}`);

168For more complex bash scripts, you can create helper functions:884 } else {

~~169~~ 885 console.log(`[${model}] 📁 ${dir}`);

170```bash theme={null}886 }

171#!/bin/bash887 });

172# Read JSON input once888 ```

173input=$(cat)889</CodeGroup>

~~174~~ 890

175# Helper functions for common extractions891### Windows configuration

176get_model_name() { echo "$input" | jq -r '.model.display_name'; }892

177get_current_dir() { echo "$input" | jq -r '.workspace.current_dir'; }893On Windows, Claude Code runs status line commands through Git Bash. You can invoke PowerShell from that shell:

178get_project_dir() { echo "$input" | jq -r '.workspace.project_dir'; }894

179get_version() { echo "$input" | jq -r '.version'; }895<CodeGroup>

180get_cost() { echo "$input" | jq -r '.cost.total_cost_usd'; }896 ```json settings.json theme={null}

181get_duration() { echo "$input" | jq -r '.cost.total_duration_ms'; }897 {

182get_lines_added() { echo "$input" | jq -r '.cost.total_lines_added'; }898 "statusLine": {

183get_lines_removed() { echo "$input" | jq -r '.cost.total_lines_removed'; }899 "type": "command",

~~184~~ 900 "command": "powershell -NoProfile -File C:/Users/username/.claude/statusline.ps1"

185# Use the helpers901 }

186MODEL=$(get_model_name)902 }

187DIR=$(get_current_dir)903 ```

188echo "[$MODEL] 📁 ${DIR##*/}"904

189```905 ```powershell statusline.ps1 theme={null}

906 $input_json = $input | Out-String | ConvertFrom-Json

907 $cwd = $input_json.cwd

908 $model = $input_json.model.display_name

909 $used = $input_json.context_window.used_percentage

910 $dirname = Split-Path $cwd -Leaf

911

912 if ($used) {

913 Write-Host "$dirname [$model] ctx: $used%"

914 } else {

915 Write-Host "$dirname [$model]"

916 }

917 ```

918</CodeGroup>

919

920Or run a Bash script directly:

921

922<CodeGroup>

923 ```json settings.json theme={null}

924 {

925 "statusLine": {

926 "type": "command",

927 "command": "~/.claude/statusline.sh"

928 }

929 }

930 ```

931

932 ```bash statusline.sh theme={null}

933 #!/usr/bin/env bash

934 input=$(cat)

935 cwd=$(echo "$input" | grep -o '"cwd":"[^"]*"' | cut -d'"' -f4)

936 model=$(echo "$input" | grep -o '"display_name":"[^"]*"' | cut -d'"' -f4)

937 dirname="${cwd##*[/\\]}"

938 echo "$dirname [$model]"

939 ```

940</CodeGroup>

190 941

191## Tips942## Tips

192 943

193* Keep your status line concise - it should fit on one line944* **Test with mock input**: `echo '{"model":{"display_name":"Opus"},"context_window":{"used_percentage":25}}' | ./statusline.sh`

194* Use emojis (if your terminal supports them) and colors to make information scannable945* **Keep output short**: the status bar has limited width, so long output may get truncated or wrap awkwardly

195* Use `jq` for JSON parsing in Bash (see examples above)946* **Cache slow operations**: your script runs frequently during active sessions, so commands like `git status` can cause lag. See the [caching example](#cache-expensive-operations) for how to handle this.

196* Test your script by running it manually with mock JSON input: `echo '{"model":{"display_name":"Test"},"workspace":{"current_dir":"/test"}}' | ./statusline.sh`947

197* Consider caching expensive operations (like git status) if needed948Community projects like [ccstatusline](https://github.com/sirmalloc/ccstatusline) and [starship-claude](https://github.com/martinemde/starship-claude) provide pre-built configurations with themes and additional features.

198 949

199## Troubleshooting950## Troubleshooting

200 951

201* If your status line doesn't appear, check that your script is executable (`chmod +x`)952**Status line not appearing**

202* Ensure your script outputs to stdout (not stderr)953

954* Verify your script is executable: `chmod +x ~/.claude/statusline.sh`

955* Check that your script outputs to stdout, not stderr

956* Run your script manually to verify it produces output

957* If `disableAllHooks` is set to `true` in your settings, the status line is also disabled. Remove this setting or set it to `false` to re-enable.

958* Run `claude --debug` to log the exit code and stderr from the first status line invocation in a session

959* Ask Claude to read your settings file and execute the `statusLine` command directly to surface errors

960

961**Status line shows `--` or empty values**

962

963* Fields may be `null` before the first API response completes

964* Handle null values in your script with fallbacks such as `// 0` in jq

965* Restart Claude Code if values remain empty after multiple messages

966

967**Context percentage shows unexpected values**

968

969* Use `used_percentage` for accurate context state rather than cumulative totals

970* The `total_input_tokens` and `total_output_tokens` are cumulative across the session and may exceed the context window size

971* Context percentage may differ from `/context` output due to when each is calculated

972

973**OSC 8 links not clickable**

974

975* Verify your terminal supports OSC 8 hyperlinks (iTerm2, Kitty, WezTerm)

976* Terminal.app does not support clickable links

977* SSH and tmux sessions may strip OSC sequences depending on configuration

978* If escape sequences appear as literal text like `\e]8;;`, use `printf '%b'` instead of `echo -e` for more reliable escape handling

979

980**Display glitches with escape sequences**

981

982* Complex escape sequences (ANSI colors, OSC 8 links) can occasionally cause garbled output if they overlap with other UI updates

983* If you see corrupted text, try simplifying your script to plain text output

984* Multi-line status lines with escape codes are more prone to rendering issues than single-line plain text

985

986**Workspace trust required**

987

988* The status line command only runs if you've accepted the workspace trust dialog for the current directory. Because `statusLine` executes a shell command, it requires the same trust acceptance as hooks and other shell-executing settings.

989* If trust isn't accepted, you'll see the notification `statusline skipped · restart to fix` instead of your status line output. Restart Claude Code and accept the trust prompt to enable it.

990

991**Script errors or hangs**

992

993* Scripts that exit with non-zero codes or produce no output cause the status line to go blank

994* Slow scripts block the status line from updating until they complete. Keep scripts fast to avoid stale output.

995* If a new update triggers while a slow script is running, the in-flight script is cancelled

996* Test your script independently with mock input before configuring it

997

998**Notifications share the status line row**

999

1000* System notifications like MCP server errors, auto-updates, and token warnings display on the right side of the same row as your status line

1001* Enabling verbose mode adds a token counter to this area

1002* On narrow terminals, these notifications may truncate your status line output

sub-agents.md +637 −285

Details

~~1# Subagents~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Create custom subagents

2 6

3> Create and use specialized AI subagents in Claude Code for task-specific workflows and improved context management.7> Create and use specialized AI subagents in Claude Code for task-specific workflows and improved context management.

4 8

5Custom subagents in Claude Code are specialized AI assistants that can be invoked to handle specific types of tasks. They enable more efficient problem-solving by providing task-specific configurations with customized system prompts, tools and a separate context window.9Subagents are specialized AI assistants that handle specific types of tasks. Each subagent runs in its own context window with a custom system prompt, specific tool access, and independent permissions. When Claude encounters a task that matches a subagent's description, it delegates to that subagent, which works independently and returns results.

11<Note>

12 If you need multiple agents working in parallel and communicating with each other, see [agent teams](/en/agent-teams) instead. Subagents work within a single session; agent teams coordinate across separate sessions.

13</Note>

15Subagents help you:

17* **Preserve context** by keeping exploration and implementation out of your main conversation

18* **Enforce constraints** by limiting which tools a subagent can use

19* **Reuse configurations** across projects with user-level subagents

20* **Specialize behavior** with focused system prompts for specific domains

21* **Control costs** by routing tasks to faster, cheaper models like Haiku

23Claude uses each subagent's description to decide when to delegate tasks. When you create a subagent, write a clear description so Claude knows when to use it.

25Claude Code includes several built-in subagents like **Explore**, **Plan**, and **general-purpose**. You can also create custom subagents to handle specific tasks. This page covers the [built-in subagents](#built-in-subagents), [how to create your own](#quickstart-create-your-first-subagent), [full configuration options](#configure-subagents), [patterns for working with subagents](#work-with-subagents), and [example subagents](#example-subagents).

27## Built-in subagents

29Claude Code includes built-in subagents that Claude automatically uses when appropriate. Each inherits the parent conversation's permissions with additional tool restrictions.

31<Tabs>

32 <Tab title="Explore">

33 A fast, read-only agent optimized for searching and analyzing codebases.

35 * **Model**: Haiku (fast, low-latency)

36 * **Tools**: Read-only tools (denied access to Write and Edit tools)

37 * **Purpose**: File discovery, code search, codebase exploration

39 Claude delegates to Explore when it needs to search or understand a codebase without making changes. This keeps exploration results out of your main conversation context.

6 40

~~7## What are subagents?~~41 When invoking Explore, Claude specifies a thoroughness level: **quick** for targeted lookups, **medium** for balanced exploration, or **very thorough** for comprehensive analysis.

42 </Tab>

8 43

~~9Subagents are pre-configured AI personalities that Claude Code can delegate tasks to. Each subagent:~~44 <Tab title="Plan">

45 A research agent used during [plan mode](/en/common-workflows#use-plan-mode-for-safe-code-analysis) to gather context before presenting a plan.

10 46

~~11* Has a specific purpose and expertise area~~47 * **Model**: Inherits from main conversation

~~12* Uses its own context window separate from the main conversation~~48 * **Tools**: Read-only tools (denied access to Write and Edit tools)

~~13* Can be configured with specific tools it's allowed to use~~49 * **Purpose**: Codebase research for planning

~~14* Includes a custom system prompt that guides its behavior~~

15 50

~~16When Claude Code encounters a task that matches a subagent's expertise, it can delegate that task to the specialized subagent, which works independently and returns results.~~51 When you're in plan mode and Claude needs to understand your codebase, it delegates research to the Plan subagent. This prevents infinite nesting (subagents cannot spawn other subagents) while still gathering necessary context.

52 </Tab>

17 53

~~18## Key benefits~~54 <Tab title="General-purpose">

55 A capable agent for complex, multi-step tasks that require both exploration and action.

19 56

~~20<CardGroup cols={2}>~~57 * **Model**: Inherits from main conversation

~~21 <Card title="Context preservation" icon="layer-group">~~58 * **Tools**: All tools

~~22 Each subagent operates in its own context, preventing pollution of the main conversation and keeping it focused on high-level objectives.~~59 * **Purpose**: Complex research, multi-step operations, code modifications

~~23 </Card>~~

24 60

~~25 <Card title="Specialized expertise" icon="brain">~~61 Claude delegates to general-purpose when the task requires both exploration and modification, complex reasoning to interpret results, or multiple dependent steps.

~~26 Subagents can be fine-tuned with detailed instructions for specific domains, leading to higher success rates on designated tasks.~~62 </Tab>

~~27 </Card>~~

28 63

~~29 <Card title="Reusability" icon="rotate">~~64 <Tab title="Other">

~~30 Once created, subagents can be used across different projects and shared with your team for consistent workflows.~~65 Claude Code includes additional helper agents for specific tasks. These are typically invoked automatically, so you don't need to use them directly.

~~31 </Card>~~

32 66

~~33 <Card title="Flexible permissions" icon="shield-check">~~67 | Agent | Model | When Claude uses it |

~~34 Each subagent can have different tool access levels, allowing you to limit powerful tools to specific subagent types.~~68 | :---------------- | :------- | :------------------------------------------------------- |

~~35 </Card>~~69 | Bash | Inherits | Running terminal commands in a separate context |

~~36</CardGroup>~~70 | statusline-setup | Sonnet | When you run `/statusline` to configure your status line |

71 | Claude Code Guide | Haiku | When you ask questions about Claude Code features |

72 </Tab>

73</Tabs>

37 74

~~38## Quick start~~75Beyond these built-in subagents, you can create your own with custom prompts, tool restrictions, permission modes, hooks, and skills. The following sections show how to get started and customize subagents.

39 76

~~40To create your first subagent:~~77## Quickstart: create your first subagent

79Subagents are defined in Markdown files with YAML frontmatter. You can [create them manually](#write-subagent-files) or use the `/agents` command.

81This walkthrough guides you through creating a user-level subagent with the `/agents` command. The subagent reviews code and suggests improvements for the codebase.

41 82

42<Steps>83<Steps>

43 <Step title="Open the subagents interface">84 <Step title="Open the subagents interface">

~~44 Run the following command:~~85 In Claude Code, run:

45 86

~~46 ```~~87 ```text theme={null}

47 /agents88 /agents

48 ```89 ```

49 </Step>90 </Step>

50 91

~~51 <Step title="Select 'Create New Agent'">~~92 <Step title="Choose a location">

~~52 Choose whether to create a project-level or user-level subagent~~93 Select **Create new agent**, then choose **Personal**. This saves the subagent to `~/.claude/agents/` so it's available in all your projects.

94 </Step>

96 <Step title="Generate with Claude">

97 Select **Generate with Claude**. When prompted, describe the subagent:

99 ```text theme={null}

100 A code improvement agent that scans files and suggests improvements

101 for readability, performance, and best practices. It should explain

102 each issue, show the current code, and provide an improved version.

103 ```

104

105 Claude generates the identifier, description, and system prompt for you.

106 </Step>

107

108 <Step title="Select tools">

109 For a read-only reviewer, deselect everything except **Read-only tools**. If you keep all tools selected, the subagent inherits all tools available to the main conversation.

53 </Step>110 </Step>

54 111

~~55 <Step title="Define the subagent">~~112 <Step title="Select model">

~~56 * **Recommended**: Generate with Claude first, then customize to make it yours~~113 Choose which model the subagent uses. For this example agent, select **Sonnet**, which balances capability and speed for analyzing code patterns.

~~57 * Describe your subagent in detail and when it should be used~~

~~58 * Select the tools you want to grant access to (or leave blank to inherit all tools)~~

~~59 * The interface shows all available tools, making selection easy~~

~~60 * If you're generating with Claude, you can also edit the system prompt in your own editor by pressing `e`~~

61 </Step>114 </Step>

62 115

~~63 <Step title="Save and use">~~116 <Step title="Choose a color">

~~64 Your subagent is now available! Claude will use it automatically when appropriate, or you can invoke it explicitly:~~117 Pick a background color for the subagent. This helps you identify which subagent is running in the UI.

118 </Step>

65 119

120 <Step title="Configure memory">

121 Select **User scope** to give the subagent a [persistent memory directory](#enable-persistent-memory) at `~/.claude/agent-memory/`. The subagent uses this to accumulate insights across conversations, such as codebase patterns and recurring issues. Select **None** if you don't want the subagent to persist learnings.

122 </Step>

123

124 <Step title="Save and try it out">

125 Review the configuration summary. Press `s` or `Enter` to save, or press `e` to save and edit the file in your editor. The subagent is available immediately. Try it:

126

127 ```text theme={null}

128 Use the code-improver agent to suggest improvements in this project

66 ```129 ```

~~67 > Use the code-reviewer subagent to check my recent changes~~130

~~68 ```~~131 Claude delegates to your new subagent, which scans the codebase and returns improvement suggestions.

69 </Step>132 </Step>

70</Steps>133</Steps>

71 134

~~72## Subagent configuration~~135You now have a subagent you can use in any project on your machine to analyze codebases and suggest improvements.

73 136

~~74### File locations~~137You can also create subagents manually as Markdown files, define them via CLI flags, or distribute them through plugins. The following sections cover all configuration options.

75 138

~~76Subagents are stored as Markdown files with YAML frontmatter in two possible locations:~~139## Configure subagents

77 140

~~79| :-------------------- | :------------------ | :---------------------------- | :------- |~~

82 142

~~83When subagent names conflict, project-level subagents take precedence over user-level subagents.~~143The `/agents` command provides an interactive interface for managing subagents. Run `/agents` to:

84 144

~~85### Plugin agents~~145* View all available subagents (built-in, user, project, and plugin)

146* Create new subagents with guided setup or Claude generation

147* Edit existing subagent configuration and tool access

148* Delete custom subagents

149* See which subagents are active when duplicates exist

86 150

~~87[Plugins](/en/plugins) can provide custom subagents that integrate seamlessly with Claude Code. Plugin agents work identically to user-defined agents and appear in the `/agents` interface.~~151This is the recommended way to create and manage subagents. For manual creation or automation, you can also add subagent files directly.

88 152

~~89**Plugin agent locations**: Plugins include agents in their `agents/` directory (or custom paths specified in the plugin manifest).~~153To list all configured subagents from the command line without starting an interactive session, run `claude agents`. This shows agents grouped by source and indicates which are overridden by higher-priority definitions.

90 154

~~91**Using plugin agents**:~~155### Choose the subagent scope

92 156

~~93* Plugin agents appear in `/agents` alongside your custom agents~~157Subagents are Markdown files with YAML frontmatter. Store them in different locations depending on scope. When multiple subagents share the same name, the higher-priority location wins.

~~94* Can be invoked explicitly: "Use the code-reviewer agent from the security-plugin"~~

~~95* Can be invoked automatically by Claude when appropriate~~

~~96* Can be managed (viewed, inspected) through `/agents` interface~~

97 158

160| :--------------------------- | :---------------------- | :---------- | :------------------------------------ |

99 165

100### CLI-based configuration166**Project subagents** (`.claude/agents/`) are ideal for subagents specific to a codebase. Check them into version control so your team can use and improve them collaboratively.

101 167

102You can also define subagents dynamically using the `--agents` CLI flag, which accepts a JSON object:168**User subagents** (`~/.claude/agents/`) are personal subagents available in all your projects.

169

170**CLI-defined subagents** are passed as JSON when launching Claude Code. They exist only for that session and aren't saved to disk, making them useful for quick testing or automation scripts. You can define multiple subagents in a single `--agents` call:

103 171

104```bash theme={null}172```bash theme={null}

105claude --agents '{173claude --agents '{

108 "prompt": "You are a senior code reviewer. Focus on code quality, security, and best practices.",176 "prompt": "You are a senior code reviewer. Focus on code quality, security, and best practices.",

109 "tools": ["Read", "Grep", "Glob", "Bash"],177 "tools": ["Read", "Grep", "Glob", "Bash"],

110 "model": "sonnet"178 "model": "sonnet"

179 },

180 "debugger": {

181 "description": "Debugging specialist for errors and test failures.",

182 "prompt": "You are an expert debugger. Analyze errors, identify root causes, and provide fixes."

111 }183 }

112}'184}'

113```185```

114 186

115**Priority**: CLI-defined subagents have lower priority than project-level subagents but higher priority than user-level subagents.187The `--agents` flag accepts JSON with the same [frontmatter](#supported-frontmatter-fields) fields as file-based subagents: `description`, `prompt`, `tools`, `disallowedTools`, `model`, `permissionMode`, `mcpServers`, `hooks`, `maxTurns`, `skills`, `initialPrompt`, `memory`, `effort`, `background`, and `isolation`. Use `prompt` for the system prompt, equivalent to the markdown body in file-based subagents.

116 188

117**Use case**: This approach is useful for:189**Plugin subagents** come from [plugins](/en/plugins) you've installed. They appear in `/agents` alongside your custom subagents. See the [plugin components reference](/en/plugins-reference#agents) for details on creating plugin subagents.

118 190

119* Quick testing of subagent configurations191<Note>

120* Session-specific subagents that don't need to be saved192 For security reasons, plugin subagents do not support the `hooks`, `mcpServers`, or `permissionMode` frontmatter fields. These fields are ignored when loading agents from a plugin. If you need them, copy the agent file into `.claude/agents/` or `~/.claude/agents/`. You can also add rules to [`permissions.allow`](/en/settings#permission-settings) in `settings.json` or `settings.local.json`, but these rules apply to the entire session, not just the plugin subagent.

121* Automation scripts that need custom subagents193</Note>

122* Sharing subagent definitions in documentation or scripts

123 194

124For detailed information about the JSON format and all available options, see the [CLI reference documentation](/en/cli-reference#agents-flag-format).195### Write subagent files

125 196

126### File format197Subagent files use YAML frontmatter for configuration, followed by the system prompt in Markdown:

127 198

128Each subagent is defined in a Markdown file with this structure:199<Note>

200 Subagents are loaded at session start. If you create a subagent by manually adding a file, restart your session or use `/agents` to load it immediately.

201</Note>

129 202

130```markdown theme={null}203```markdown theme={null}

131---204---

132name: your-sub-agent-name205name: code-reviewer

133description: Description of when this subagent should be invoked206description: Reviews code for quality and best practices

134tools: tool1, tool2, tool3 # Optional - inherits all tools if omitted207tools: Read, Glob, Grep

135model: sonnet # Optional - specify model alias or 'inherit'208model: sonnet

136permissionMode: default # Optional - permission mode for the subagent

137skills: skill1, skill2 # Optional - skills to auto-load

138---209---

139 210

140Your subagent's system prompt goes here. This can be multiple paragraphs211You are a code reviewer. When invoked, analyze the code and provide

141and should clearly define the subagent's role, capabilities, and approach212specific, actionable feedback on quality, security, and best practices.

142to solving problems.

~~143~~

144Include specific instructions, best practices, and any constraints

145the subagent should follow.

146```213```

147 214

148#### Configuration fields215The frontmatter defines the subagent's metadata and configuration. The body becomes the system prompt that guides the subagent's behavior. Subagents receive only this system prompt (plus basic environment details like working directory), not the full Claude Code system prompt.

216

217#### Supported frontmatter fields

218

219The following fields can be used in the YAML frontmatter. Only `name` and `description` are required.

149 220

151| :--------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |222| :---------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

152| `name` | Yes | Unique identifier using lowercase letters and hyphens |223| `name` | Yes | Unique identifier using lowercase letters and hyphens |

153| `description` | Yes | Natural language description of the subagent's purpose |224| `description` | Yes | When Claude should delegate to this subagent |

154| `tools` | No | Comma-separated list of specific tools. If omitted, inherits all tools from the main thread |225| `tools` | No | [Tools](#available-tools) the subagent can use. Inherits all tools if omitted |

155| `model` | No | Model to use for this subagent. Can be a model alias (`sonnet`, `opus`, `haiku`) or `'inherit'` to use the main conversation's model. If omitted, defaults to the [configured subagent model](/en/model-config) |226| `disallowedTools` | No | Tools to deny, removed from inherited or specified list |

156| `permissionMode` | No | Permission mode for the subagent. Valid values: `default`, `acceptEdits`, `bypassPermissions`, `plan`, `ignore`. Controls how the subagent handles permission requests |227| `model` | No | [Model](#choose-a-model) to use: `sonnet`, `opus`, `haiku`, a full model ID (for example, `claude-opus-4-6`), or `inherit`. Defaults to `inherit` |

157| `skills` | No | Comma-separated list of skill names to auto-load when the subagent starts. Skills are loaded into the subagent's context automatically |228| `permissionMode` | No | [Permission mode](#permission-modes): `default`, `acceptEdits`, `dontAsk`, `bypassPermissions`, or `plan` |

229| `maxTurns` | No | Maximum number of agentic turns before the subagent stops |

230| `skills` | No | [Skills](/en/skills) to load into the subagent's context at startup. The full skill content is injected, not just made available for invocation. Subagents don't inherit skills from the parent conversation |

231| `mcpServers` | No | [MCP servers](/en/mcp) available to this subagent. Each entry is either a server name referencing an already-configured server (e.g., `"slack"`) or an inline definition with the server name as key and a full [MCP server config](/en/mcp#configure-mcp-servers) as value |

232| `hooks` | No | [Lifecycle hooks](#define-hooks-for-subagents) scoped to this subagent |

233| `memory` | No | [Persistent memory scope](#enable-persistent-memory): `user`, `project`, or `local`. Enables cross-session learning |

234| `background` | No | Set to `true` to always run this subagent as a [background task](#run-subagents-in-foreground-or-background). Default: `false` |

235| `effort` | No | Effort level when this subagent is active. Overrides the session effort level. Default: inherits from session. Options: `low`, `medium`, `high`, `max` (Opus 4.6 only) |

236| `isolation` | No | Set to `worktree` to run the subagent in a temporary [git worktree](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees), giving it an isolated copy of the repository. The worktree is automatically cleaned up if the subagent makes no changes |

237| `initialPrompt` | No | Auto-submitted as the first user turn when this agent runs as the main session agent (via `--agent` or the `agent` setting). [Commands](/en/commands) and [skills](/en/skills) are processed. Prepended to any user-provided prompt |

238

239### Choose a model

240

241The `model` field controls which [AI model](/en/model-config) the subagent uses:

158 242

159### Model selection243* **Model alias**: Use one of the available aliases: `sonnet`, `opus`, or `haiku`

244* **Full model ID**: Use a full model ID such as `claude-opus-4-6` or `claude-sonnet-4-6`. Accepts the same values as the `--model` flag

245* **inherit**: Use the same model as the main conversation

246* **Omitted**: If not specified, defaults to `inherit` (uses the same model as the main conversation)

160 247

161The `model` field allows you to control which [AI model](/en/model-config) the subagent uses:248### Control subagent capabilities

162 249

163* **Model alias**: Use one of the available aliases: `sonnet`, `opus`, or `haiku`250You can control what subagents can do through tool access, permission modes, and conditional rules.

164* **`'inherit'`**: Use the same model as the main conversation (useful for consistency)

165* **Omitted**: If not specified, uses the default model configured for subagents (`sonnet`)

166 251

167<Note>252#### Available tools

168 Using `'inherit'` is particularly useful when you want your subagents to adapt to the model choice of the main conversation, ensuring consistent capabilities and response style throughout your session.

169</Note>

170 253

171### Available tools254Subagents can use any of Claude Code's [internal tools](/en/tools-reference). By default, subagents inherit all tools from the main conversation, including MCP tools.

172 255

173Subagents can be granted access to any of Claude Code's internal tools. See the [tools documentation](/en/settings#tools-available-to-claude) for a complete list of available tools.256To restrict tools, use either the `tools` field (allowlist) or the `disallowedTools` field (denylist). This example uses `tools` to exclusively allow Read, Grep, Glob, and Bash. The subagent can't edit files, write files, or use any MCP tools:

174 257

175<Tip>258```yaml theme={null}

176 **Recommended:** Use the `/agents` command to modify tool access - it provides an interactive interface that lists all available tools, including any connected MCP server tools, making it easier to select the ones you need.259---

177</Tip>260name: safe-researcher

261description: Research agent with restricted capabilities

262tools: Read, Grep, Glob, Bash

263---

264```

265

266This example uses `disallowedTools` to inherit every tool from the main conversation except Write and Edit. The subagent keeps Bash, MCP tools, and everything else:

267

268```yaml theme={null}

269---

270name: no-writes

271description: Inherits every tool except file writes

272disallowedTools: Write, Edit

273---

274```

178 275

179You have two options for configuring tools:276If both are set, `disallowedTools` is applied first, then `tools` is resolved against the remaining pool. A tool listed in both is removed.

180 277

181* **Omit the `tools` field** to inherit all tools from the main thread (default), including MCP tools278#### Restrict which subagents can be spawned

182* **Specify individual tools** as a comma-separated list for more granular control (can be edited manually or via `/agents`)

183 279

184**MCP Tools**: Subagents can access MCP tools from configured MCP servers. When the `tools` field is omitted, subagents inherit all MCP tools available to the main thread.280When an agent runs as the main thread with `claude --agent`, it can spawn subagents using the Agent tool. To restrict which subagent types it can spawn, use `Agent(agent_type)` syntax in the `tools` field.

185 281

186## Managing subagents282<Note>In version 2.1.63, the Task tool was renamed to Agent. Existing `Task(...)` references in settings and agent definitions still work as aliases.</Note>

187 283

188### Using the /agents command (Recommended)284```yaml theme={null}

285---

286name: coordinator

287description: Coordinates work across specialized agents

288tools: Agent(worker, researcher), Read, Bash

289---

290```

291

292This is an allowlist: only the `worker` and `researcher` subagents can be spawned. If the agent tries to spawn any other type, the request fails and the agent sees only the allowed types in its prompt. To block specific agents while allowing all others, use [`permissions.deny`](#disable-specific-subagents) instead.

189 293

190The `/agents` command provides a comprehensive interface for subagent management:294To allow spawning any subagent without restrictions, use `Agent` without parentheses:

191 295

296```yaml theme={null}

297tools: Agent, Read, Bash

192```298```

193/agents299

300If `Agent` is omitted from the `tools` list entirely, the agent cannot spawn any subagents. This restriction only applies to agents running as the main thread with `claude --agent`. Subagents cannot spawn other subagents, so `Agent(agent_type)` has no effect in subagent definitions.

301

302#### Scope MCP servers to a subagent

303

304Use the `mcpServers` field to give a subagent access to [MCP](/en/mcp) servers that aren't available in the main conversation. Inline servers defined here are connected when the subagent starts and disconnected when it finishes. String references share the parent session's connection.

305

306Each entry in the list is either an inline server definition or a string referencing an MCP server already configured in your session:

307

308```yaml theme={null}

309---

310name: browser-tester

311description: Tests features in a real browser using Playwright

312mcpServers:

313 # Inline definition: scoped to this subagent only

314 - playwright:

315 type: stdio

316 command: npx

317 args: ["-y", "@playwright/mcp@latest"]

318 # Reference by name: reuses an already-configured server

319 - github

320---

321

322Use the Playwright tools to navigate, screenshot, and interact with pages.

194```323```

195 324

196This opens an interactive menu where you can:325Inline definitions use the same schema as `.mcp.json` server entries (`stdio`, `http`, `sse`, `ws`), keyed by the server name.

197 326

198* View all available subagents (built-in, user, and project)327To keep an MCP server out of the main conversation entirely and avoid its tool descriptions consuming context there, define it inline here rather than in `.mcp.json`. The subagent gets the tools; the parent conversation does not.

199* Create new subagents with guided setup

200* Edit existing custom subagents, including their tool access

201* Delete custom subagents

202* See which subagents are active when duplicates exist

203* **Easily manage tool permissions** with a complete list of available tools

204 328

205### Direct file management329#### Permission modes

206 330

207You can also manage subagents by working directly with their files:331The `permissionMode` field controls how the subagent handles permission prompts. Subagents inherit the permission context from the main conversation and can override the mode, except when the parent mode takes precedence as described below.

208 332

209```bash theme={null}333| Mode | Behavior |

210# Create a project subagent334| :------------------ | :----------------------------------------------------------------- |

211mkdir -p .claude/agents335| `default` | Standard permission checking with prompts |

212echo '---336| `acceptEdits` | Auto-accept file edits |

213name: test-runner337| `dontAsk` | Auto-deny permission prompts (explicitly allowed tools still work) |

214description: Use proactively to run tests and fix failures338| `bypassPermissions` | Skip permission prompts |

339| `plan` | Plan mode (read-only exploration) |

340

341<Warning>

342 Use `bypassPermissions` with caution. It skips permission prompts, allowing the subagent to execute operations without approval. Writes to `.git`, `.claude`, `.vscode`, and `.idea` directories still prompt for confirmation, except for `.claude/commands`, `.claude/agents`, and `.claude/skills`. See [permission modes](/en/permission-modes#skip-all-checks-with-bypasspermissions-mode) for details.

343</Warning>

344

345If the parent uses `bypassPermissions`, this takes precedence and cannot be overridden. If the parent uses [auto mode](/en/permission-modes#eliminate-prompts-with-auto-mode), the subagent inherits auto mode and any `permissionMode` in its frontmatter is ignored: the classifier evaluates the subagent's tool calls with the same block and allow rules as the parent session.

346

347#### Preload skills into subagents

348

349Use the `skills` field to inject skill content into a subagent's context at startup. This gives the subagent domain knowledge without requiring it to discover and load skills during execution.

350

351```yaml theme={null}

352---

353name: api-developer

354description: Implement API endpoints following team conventions

355skills:

356 - api-conventions

357 - error-handling-patterns

215---358---

216 359

217You are a test automation expert. When you see code changes, proactively run the appropriate tests. If tests fail, analyze the failures and fix them while preserving the original test intent.' > .claude/agents/test-runner.md360Implement API endpoints. Follow the conventions and patterns from the preloaded skills.

361```

362

363The full content of each skill is injected into the subagent's context, not just made available for invocation. Subagents don't inherit skills from the parent conversation; you must list them explicitly.

364

365<Note>

366 This is the inverse of [running a skill in a subagent](/en/skills#run-skills-in-a-subagent). With `skills` in a subagent, the subagent controls the system prompt and loads skill content. With `context: fork` in a skill, the skill content is injected into the agent you specify. Both use the same underlying system.

367</Note>

218 368

219# Create a user subagent369#### Enable persistent memory

220mkdir -p ~/.claude/agents370

221# ... create subagent file371The `memory` field gives the subagent a persistent directory that survives across conversations. The subagent uses this directory to build up knowledge over time, such as codebase patterns, debugging insights, and architectural decisions.

372

373```yaml theme={null}

374---

375name: code-reviewer

376description: Reviews code for quality and best practices

377memory: user

378---

379

380You are a code reviewer. As you review code, update your agent memory with

381patterns, conventions, and recurring issues you discover.

222```382```

223 383

224## Using subagents effectively384Choose a scope based on how broadly the memory should apply:

225 385

226### Automatic delegation386| Scope | Location | Use when |

387| :-------- | :-------------------------------------------- | :------------------------------------------------------------------------------------------ |

388| `user` | `~/.claude/agent-memory/<name-of-agent>/` | the subagent should remember learnings across all projects |

389| `project` | `.claude/agent-memory/<name-of-agent>/` | the subagent's knowledge is project-specific and shareable via version control |

390| `local` | `.claude/agent-memory-local/<name-of-agent>/` | the subagent's knowledge is project-specific but should not be checked into version control |

227 391

228Claude Code proactively delegates tasks based on:392When memory is enabled:

229 393

230* The task description in your request394* The subagent's system prompt includes instructions for reading and writing to the memory directory.

231* The `description` field in subagent configurations395* The subagent's system prompt also includes the first 200 lines of `MEMORY.md` in the memory directory, with instructions to curate `MEMORY.md` if it exceeds 200 lines.

232* Current context and available tools396* Read, Write, and Edit tools are automatically enabled so the subagent can manage its memory files.

233 397

234<Tip>398##### Persistent memory tips

235 To encourage more proactive subagent use, include phrases like "use PROACTIVELY" or "MUST BE USED" in your `description` field.399

236</Tip>400* `project` is the recommended default scope. It makes subagent knowledge shareable via version control. Use `user` when the subagent's knowledge is broadly applicable across projects, or `local` when the knowledge should not be checked into version control.

401* Ask the subagent to consult its memory before starting work: "Review this PR, and check your memory for patterns you've seen before."

402* Ask the subagent to update its memory after completing a task: "Now that you're done, save what you learned to your memory." Over time, this builds a knowledge base that makes the subagent more effective.

403* Include memory instructions directly in the subagent's markdown file so it proactively maintains its own knowledge base:

404

405 ```markdown theme={null}

406 Update your agent memory as you discover codepaths, patterns, library

407 locations, and key architectural decisions. This builds up institutional

408 knowledge across conversations. Write concise notes about what you found

409 and where.

410 ```

237 411

238### Explicit invocation412#### Conditional rules with hooks

239 413

240Request a specific subagent by mentioning it in your command:414For more dynamic control over tool usage, use `PreToolUse` hooks to validate operations before they execute. This is useful when you need to allow some operations of a tool while blocking others.

241 415

416This example creates a subagent that only allows read-only database queries. The `PreToolUse` hook runs the script specified in `command` before each Bash command executes:

417

418```yaml theme={null}

419---

420name: db-reader

421description: Execute read-only database queries

422tools: Bash

423hooks:

424 PreToolUse:

425 - matcher: "Bash"

426 hooks:

427 - type: command

428 command: "./scripts/validate-readonly-query.sh"

429---

242```430```

243> Use the test-runner subagent to fix failing tests431

244> Have the code-reviewer subagent look at my recent changes432Claude Code [passes hook input as JSON](/en/hooks#pretooluse-input) via stdin to hook commands. The validation script reads this JSON, extracts the Bash command, and [exits with code 2](/en/hooks#exit-code-2-behavior-per-event) to block write operations:

245> Ask the debugger subagent to investigate this error433

434```bash theme={null}

435#!/bin/bash

436# ./scripts/validate-readonly-query.sh

437

438INPUT=$(cat)

439COMMAND=$(echo "$INPUT" | jq -r '.tool_input.command // empty')

440

441# Block SQL write operations (case-insensitive)

443 echo "Blocked: Only SELECT queries are allowed" >&2

444 exit 2

445fi

446

447exit 0

246```448```

247 449

248## Built-in subagents450See [Hook input](/en/hooks#pretooluse-input) for the complete input schema and [exit codes](/en/hooks#exit-code-output) for how exit codes affect behavior.

249 451

250Claude Code includes built-in subagents that are available out of the box:452#### Disable specific subagents

251 453

252### General-purpose subagent454You can prevent Claude from using specific subagents by adding them to the `deny` array in your [settings](/en/settings#permission-settings). Use the format `Agent(subagent-name)` where `subagent-name` matches the subagent's name field.

253 455

254The general-purpose subagent is a capable agent for complex, multi-step tasks that require both exploration and action. Unlike the Explore subagent, it can modify files and execute a wider range of operations.456```json theme={null}

457{

458 "permissions": {

459 "deny": ["Agent(Explore)", "Agent(my-custom-agent)"]

460 }

461}

462```

255 463

256**Key characteristics:**464This works for both built-in and custom subagents. You can also use the `--disallowedTools` CLI flag:

257 465

258* **Model**: Uses Sonnet for more capable reasoning466```bash theme={null}

259* **Tools**: Has access to all tools467claude --disallowedTools "Agent(Explore)"

260* **Mode**: Can read and write files, execute commands, make changes468```

261* **Purpose**: Complex research tasks, multi-step operations, code modifications

262 469

263**When Claude uses it:**470See [Permissions documentation](/en/permissions#tool-specific-permission-rules) for more details on permission rules.

264 471

265Claude delegates to the general-purpose subagent when:472### Define hooks for subagents

266 473

267* The task requires both exploration and modification474Subagents can define [hooks](/en/hooks) that run during the subagent's lifecycle. There are two ways to configure hooks:

268* Complex reasoning is needed to interpret search results

269* Multiple strategies may be needed if initial searches fail

270* The task has multiple steps that depend on each other

271 475

272**Example scenario:**4761. **In the subagent's frontmatter**: Define hooks that run only while that subagent is active

4772. **In `settings.json`**: Define hooks that run in the main session when subagents start or stop

273 478

479#### Hooks in subagent frontmatter

480

481Define hooks directly in the subagent's markdown file. These hooks only run while that specific subagent is active and are cleaned up when it finishes.

482

483All [hook events](/en/hooks#hook-events) are supported. The most common events for subagents are:

484

485| Event | Matcher input | When it fires |

486| :------------ | :------------ | :------------------------------------------------------------------ |

487| `PreToolUse` | Tool name | Before the subagent uses a tool |

488| `PostToolUse` | Tool name | After the subagent uses a tool |

489| `Stop` | (none) | When the subagent finishes (converted to `SubagentStop` at runtime) |

490

491This example validates Bash commands with the `PreToolUse` hook and runs a linter after file edits with `PostToolUse`:

492

493```yaml theme={null}

494---

495name: code-reviewer

496description: Review code changes with automatic linting

497hooks:

498 PreToolUse:

499 - matcher: "Bash"

500 hooks:

501 - type: command

502 command: "./scripts/validate-command.sh $TOOL_INPUT"

503 PostToolUse:

504 - matcher: "Edit|Write"

505 hooks:

506 - type: command

507 command: "./scripts/run-linter.sh"

508---

274```509```

275User: Find all the places where we handle authentication and update them to use the new token format

276 510

277Claude: [Invokes general-purpose subagent]511`Stop` hooks in frontmatter are automatically converted to `SubagentStop` events.

278[Agent searches for auth-related code across codebase]512

279[Agent reads and analyzes multiple files]513#### Project-level hooks for subagent events

280[Agent makes necessary edits]514

281[Returns detailed writeup of changes made]515Configure hooks in `settings.json` that respond to subagent lifecycle events in the main session.

516

517| Event | Matcher input | When it fires |

518| :-------------- | :-------------- | :------------------------------- |

519| `SubagentStart` | Agent type name | When a subagent begins execution |

520| `SubagentStop` | Agent type name | When a subagent completes |

521

522Both events support matchers to target specific agent types by name. This example runs a setup script only when the `db-agent` subagent starts, and a cleanup script when any subagent stops:

523

524```json theme={null}

525{

526 "hooks": {

527 "SubagentStart": [

528 {

529 "matcher": "db-agent",

530 "hooks": [

531 { "type": "command", "command": "./scripts/setup-db-connection.sh" }

532 ]

533 }

534 ],

535 "SubagentStop": [

536 {

537 "hooks": [

538 { "type": "command", "command": "./scripts/cleanup-db-connection.sh" }

539 ]

540 }

541 ]

542 }

543}

282```544```

283 545

284### Plan subagent546See [Hooks](/en/hooks) for the complete hook configuration format.

285 547

286The Plan subagent is a specialized built-in agent designed for use during plan mode. When Claude is operating in plan mode (non-execution mode), it uses the Plan subagent to conduct research and gather information about your codebase before presenting a plan.548## Work with subagents

287 549

288**Key characteristics:**550### Understand automatic delegation

289 551

290* **Model**: Uses Sonnet for more capable analysis552Claude automatically delegates tasks based on the task description in your request, the `description` field in subagent configurations, and current context. To encourage proactive delegation, include phrases like "use proactively" in your subagent's description field.

291* **Tools**: Has access to Read, Glob, Grep, and Bash tools for codebase exploration

292* **Purpose**: Searches files, analyzes code structure, and gathers context

293* **Automatic invocation**: Claude automatically uses this agent when in plan mode and needs to research the codebase

294 553

295**How it works:**554### Invoke subagents explicitly

296When you're in plan mode and Claude needs to understand your codebase to create a plan, it delegates research tasks to the Plan subagent. This prevents infinite nesting of agents (subagents cannot spawn other subagents) while still allowing Claude to gather the necessary context.

297 555

298**Example scenario:**556When automatic delegation isn't enough, you can request a subagent yourself. Three patterns escalate from a one-off suggestion to a session-wide default:

299 557

558* **Natural language**: name the subagent in your prompt; Claude decides whether to delegate

559* **@-mention**: guarantees the subagent runs for one task

560* **Session-wide**: the whole session uses that subagent's system prompt, tool restrictions, and model via the `--agent` flag or the `agent` setting

561

562For natural language, there's no special syntax. Name the subagent and Claude typically delegates:

563

564```text theme={null}

565Use the test-runner subagent to fix failing tests

566Have the code-reviewer subagent look at my recent changes

300```567```

301User: [In plan mode] Help me refactor the authentication module

302 568

303Claude: Let me research your authentication implementation first...569**@-mention the subagent.** Type `@` and pick the subagent from the typeahead, the same way you @-mention files. This ensures that specific subagent runs rather than leaving the choice to Claude:

304[Internally invokes Plan subagent to explore auth-related files]570

305[Plan subagent searches codebase and returns findings]571```text theme={null}

306Claude: Based on my research, here's my proposed plan...572@"code-reviewer (agent)" look at the auth changes

307```573```

308 574

309<Tip>575Your full message still goes to Claude, which writes the subagent's task prompt based on what you asked. The @-mention controls which subagent Claude invokes, not what prompt it receives.

310 The Plan subagent is only used in plan mode. In normal execution mode, Claude uses the general-purpose agent or other custom subagents you've created.

311</Tip>

312 576

313### Explore subagent577Subagents provided by an enabled [plugin](/en/plugins) appear in the typeahead as `<plugin-name>:<agent-name>`. You can also type the mention manually without using the picker: `@agent-<name>` for local subagents, or `@agent-<plugin-name>:<agent-name>` for plugin subagents.

314 578

315The Explore subagent is a fast, lightweight agent optimized for searching and analyzing codebases. It operates in strict read-only mode and is designed for rapid file discovery and code exploration.579**Run the whole session as a subagent.** Pass [`--agent <name>`](/en/cli-reference) to start a session where the main thread itself takes on that subagent's system prompt, tool restrictions, and model:

316 580

317**Key characteristics:**581```bash theme={null}

582claude --agent code-reviewer

583```

318 584

319* **Model**: Uses Haiku for fast, low-latency searches585The subagent's system prompt replaces the default Claude Code system prompt entirely, the same way [`--system-prompt`](/en/cli-reference) does. `CLAUDE.md` files and project memory still load through the normal message flow. The agent name appears as `@<name>` in the startup header so you can confirm it's active.

320* **Mode**: Strictly read-only - cannot create, modify, or delete files

321* **Tools available**:

322 * Glob - File pattern matching

323 * Grep - Content searching with regex

324 * Read - Reading file contents

325 * Bash - Read-only commands only (ls, git status, git log, git diff, find, cat, head, tail)

326 586

327**When Claude uses it:**587This works with built-in and custom subagents, and the choice persists when you resume the session.

328 588

329Claude will delegate to the Explore subagent when it needs to search or understand a codebase but doesn't need to make changes. This is more efficient than the main agent running multiple search commands directly, as content found during the exploration process doesn't bloat the main conversation.589For a plugin-provided subagent, pass the scoped name: `claude --agent <plugin-name>:<agent-name>`.

330 590

331**Thoroughness levels:**591To make it the default for every session in a project, set `agent` in `.claude/settings.json`:

332 592

333When invoking the Explore subagent, Claude specifies a thoroughness level:593```json theme={null}

594{

595 "agent": "code-reviewer"

596}

597```

334 598

335* **Quick** - Basic searches, fastest results. Good for simple lookups.599The CLI flag overrides the setting if both are present.

336* **Medium** - Moderate exploration. Balances speed and thoroughness.

337* **Very thorough** - Comprehensive analysis across multiple locations and naming conventions. Used when the target might be in unexpected places.

338 600

339**Example scenarios:**601### Run subagents in foreground or background

340 602

603Subagents can run in the foreground (blocking) or background (concurrent):

604

605* **Foreground subagents** block the main conversation until complete. Permission prompts and clarifying questions (like [`AskUserQuestion`](/en/tools-reference)) are passed through to you.

606* **Background subagents** run concurrently while you continue working. Before launching, Claude Code prompts for any tool permissions the subagent will need, ensuring it has the necessary approvals upfront. Once running, the subagent inherits these permissions and auto-denies anything not pre-approved. If a background subagent needs to ask clarifying questions, that tool call fails but the subagent continues.

607

608If a background subagent fails due to missing permissions, you can start a new foreground subagent with the same task to retry with interactive prompts.

609

610Claude decides whether to run subagents in the foreground or background based on the task. You can also:

611

612* Ask Claude to "run this in the background"

613* Press **Ctrl+B** to background a running task

614

615To disable all background task functionality, set the `CLAUDE_CODE_DISABLE_BACKGROUND_TASKS` environment variable to `1`. See [Environment variables](/en/env-vars).

616

617### Common patterns

618

619#### Isolate high-volume operations

620

621One of the most effective uses for subagents is isolating operations that produce large amounts of output. Running tests, fetching documentation, or processing log files can consume significant context. By delegating these to a subagent, the verbose output stays in the subagent's context while only the relevant summary returns to your main conversation.

622

623```text theme={null}

624Use a subagent to run the test suite and report only the failing tests with their error messages

341```625```

342User: Where are errors from the client handled?

343 626

344Claude: [Invokes Explore subagent with "medium" thoroughness]627#### Run parallel research

345[Explore uses Grep to search for error handling patterns]628

346[Explore uses Read to examine promising files]629For independent investigations, spawn multiple subagents to work simultaneously:

347[Returns findings with absolute file paths]630

348Claude: Client errors are handled in src/services/process.ts:712...631```text theme={null}

632Research the authentication, database, and API modules in parallel using separate subagents

349```633```

350 634

635Each subagent explores its area independently, then Claude synthesizes the findings. This works best when the research paths don't depend on each other.

636

637<Warning>

638 When subagents complete, their results return to your main conversation. Running many subagents that each return detailed results can consume significant context.

639</Warning>

640

641For tasks that need sustained parallelism or exceed your context window, [agent teams](/en/agent-teams) give each worker its own independent context.

642

643#### Chain subagents

644

645For multi-step workflows, ask Claude to use subagents in sequence. Each subagent completes its task and returns results to Claude, which then passes relevant context to the next subagent.

646

647```text theme={null}

648Use the code-reviewer subagent to find performance issues, then use the optimizer subagent to fix them

351```649```

352User: What's the codebase structure?

353 650

354Claude: [Invokes Explore subagent with "quick" thoroughness]651### Choose between subagents and main conversation

355[Explore uses Glob and ls to map directory structure]652

356[Returns overview of key directories and their purposes]653Use the **main conversation** when:

654

655* The task needs frequent back-and-forth or iterative refinement

656* Multiple phases share significant context (planning → implementation → testing)

657* You're making a quick, targeted change

658* Latency matters. Subagents start fresh and may need time to gather context

659

660Use **subagents** when:

661

662* The task produces verbose output you don't need in your main context

663* You want to enforce specific tool restrictions or permissions

664* The work is self-contained and can return a summary

665

666Consider [Skills](/en/skills) instead when you want reusable prompts or workflows that run in the main conversation context rather than isolated subagent context.

667

668For a quick question about something already in your conversation, use [`/btw`](/en/interactive-mode#side-questions-with-btw) instead of a subagent. It sees your full context but has no tool access, and the answer is discarded rather than added to history.

669

670<Note>

671 Subagents cannot spawn other subagents. If your workflow requires nested delegation, use [Skills](/en/skills) or [chain subagents](#chain-subagents) from the main conversation.

672</Note>

673

674### Manage subagent context

675

676#### Resume subagents

677

678Each subagent invocation creates a new instance with fresh context. To continue an existing subagent's work instead of starting over, ask Claude to resume it.

679

680Resumed subagents retain their full conversation history, including all previous tool calls, results, and reasoning. The subagent picks up exactly where it stopped rather than starting fresh.

681

682When a subagent completes, Claude receives its agent ID. Claude uses the `SendMessage` tool with the agent's ID as the `to` field to resume it. To resume a subagent, ask Claude to continue the previous work:

683

684```text theme={null}

685Use the code-reviewer subagent to review the authentication module

686[Agent completes]

687

688Continue that code review and now analyze the authorization logic

689[Claude resumes the subagent with full context from previous conversation]

357```690```

358 691

692If a stopped subagent receives a `SendMessage`, it auto-resumes in the background without requiring a new `Agent` invocation.

693

694You can also ask Claude for the agent ID if you want to reference it explicitly, or find IDs in the transcript files at `~/.claude/projects/{project}/{sessionId}/subagents/`. Each transcript is stored as `agent-{agentId}.jsonl`.

695

696Subagent transcripts persist independently of the main conversation:

697

698* **Main conversation compaction**: When the main conversation compacts, subagent transcripts are unaffected. They're stored in separate files.

699* **Session persistence**: Subagent transcripts persist within their session. You can [resume a subagent](#resume-subagents) after restarting Claude Code by resuming the same session.

700* **Automatic cleanup**: Transcripts are cleaned up based on the `cleanupPeriodDays` setting (default: 30 days).

701

702#### Auto-compaction

703

704Subagents support automatic compaction using the same logic as the main conversation. By default, auto-compaction triggers at approximately 95% capacity. To trigger compaction earlier, set `CLAUDE_AUTOCOMPACT_PCT_OVERRIDE` to a lower percentage (for example, `50`). See [environment variables](/en/env-vars) for details.

705

706Compaction events are logged in subagent transcript files:

707

708```json theme={null}

709{

710 "type": "system",

711 "subtype": "compact_boundary",

712 "compactMetadata": {

713 "trigger": "auto",

714 "preTokens": 167189

715 }

716}

717```

718

719The `preTokens` value shows how many tokens were used before compaction occurred.

720

359## Example subagents721## Example subagents

360 722

723These examples demonstrate effective patterns for building subagents. Use them as starting points, or generate a customized version with Claude.

724

725<Tip>

726 **Best practices:**

727

728 * **Design focused subagents:** each subagent should excel at one specific task

729 * **Write detailed descriptions:** Claude uses the description to decide when to delegate

730 * **Limit tool access:** grant only necessary permissions for security and focus

731 * **Check into version control:** share project subagents with your team

732</Tip>

733

361### Code reviewer734### Code reviewer

362 735

736A read-only subagent that reviews code without modifying it. This example shows how to design a focused subagent with limited tool access (no Edit or Write) and a detailed prompt that specifies exactly what to look for and how to format output.

737

363```markdown theme={null}738```markdown theme={null}

364---739---

365name: code-reviewer740name: code-reviewer

3763. Begin review immediately7513. Begin review immediately

377 752

378Review checklist:753Review checklist:

379- Code is simple and readable754- Code is clear and readable

380- Functions and variables are well-named755- Functions and variables are well-named

381- No duplicated code756- No duplicated code

382- Proper error handling757- Proper error handling

395 770

396### Debugger771### Debugger

397 772

773A subagent that can both analyze and fix issues. Unlike the code reviewer, this one includes Edit because fixing bugs requires modifying code. The prompt provides a clear workflow from diagnosis to verification.

774

398```markdown theme={null}775```markdown theme={null}

399---776---

400name: debugger777name: debugger

425- Testing approach802- Testing approach

426- Prevention recommendations803- Prevention recommendations

427 804

428Focus on fixing the underlying issue, not just symptoms.805Focus on fixing the underlying issue, not the symptoms.

429```806```

430 807

431### Data scientist808### Data scientist

432 809

810A domain-specific subagent for data analysis work. This example shows how to create subagents for specialized workflows outside of typical coding tasks. It explicitly sets `model: sonnet` for more capable analysis.

811

433```markdown theme={null}812```markdown theme={null}

434---813---

435name: data-scientist814name: data-scientist

463Always ensure queries are efficient and cost-effective.842Always ensure queries are efficient and cost-effective.

464```843```

465 844

466## Best practices845### Database query validator

~~467~~

468* **Start with Claude-generated agents**: We highly recommend generating your initial subagent with Claude and then iterating on it to make it personally yours. This approach gives you the best results - a solid foundation that you can customize to your specific needs.

469 846

470* **Design focused subagents**: Create subagents with single, clear responsibilities rather than trying to make one subagent do everything. This improves performance and makes subagents more predictable.847A subagent that allows Bash access but validates commands to permit only read-only SQL queries. This example shows how to use `PreToolUse` hooks for conditional validation when you need finer control than the `tools` field provides.

471 848

472* **Write detailed prompts**: Include specific instructions, examples, and constraints in your system prompts. The more guidance you provide, the better the subagent will perform.849```markdown theme={null}

~~473~~ 850---

474* **Limit tool access**: Only grant tools that are necessary for the subagent's purpose. This improves security and helps the subagent focus on relevant actions.851name: db-reader

~~475~~ 852description: Execute read-only database queries. Use when analyzing data or generating reports.

476* **Version control**: Check project subagents into version control so your team can benefit from and improve them collaboratively.853tools: Bash

~~477~~ 854hooks:

478## Advanced usage855 PreToolUse:

856 - matcher: "Bash"

857 hooks:

858 - type: command

859 command: "./scripts/validate-readonly-query.sh"

860---

479 861

480### Chaining subagents862You are a database analyst with read-only access. Execute SELECT queries to answer questions about the data.

481 863

482For complex workflows, you can chain multiple subagents:864When asked to analyze data:

8651. Identify which tables contain the relevant data

8662. Write efficient SELECT queries with appropriate filters

8673. Present results clearly with context

483 868

484```869You cannot modify data. If asked to INSERT, UPDATE, DELETE, or modify schema, explain that you only have read access.

485> First use the code-analyzer subagent to find performance issues, then use the optimizer subagent to fix them

486```870```

487 871

488### Dynamic subagent selection872Claude Code [passes hook input as JSON](/en/hooks#pretooluse-input) via stdin to hook commands. The validation script reads this JSON, extracts the command being executed, and checks it against a list of SQL write operations. If a write operation is detected, the script [exits with code 2](/en/hooks#exit-code-2-behavior-per-event) to block execution and returns an error message to Claude via stderr.

489 873

490Claude Code intelligently selects subagents based on context. Make your `description` fields specific and action-oriented for best results.874Create the validation script anywhere in your project. The path must match the `command` field in your hook configuration:

491 875

492### Resumable subagents876```bash theme={null}

~~493~~ 877#!/bin/bash

494Subagents can be resumed to continue previous conversations, which is particularly useful for long-running research or analysis tasks that need to be continued across multiple invocations.878# Blocks SQL write operations, allows SELECT queries

~~495~~

496**How it works:**

497 879

498* Each subagent execution is assigned a unique `agentId`880# Read JSON input from stdin

499* The agent's conversation is stored in a separate transcript file: `agent-{agentId}.jsonl`881INPUT=$(cat)

500* You can resume a previous agent by providing its `agentId` via the `resume` parameter

501* When resumed, the agent continues with full context from its previous conversation

502 882

503**Example workflow:**883# Extract the command field from tool_input using jq

884COMMAND=$(echo "$INPUT" | jq -r '.tool_input.command // empty')

504 885

505Initial invocation:886if [ -z "$COMMAND" ]; then

887 exit 0

888fi

506 889

507```890# Block write operations (case-insensitive)

892 echo "Blocked: Write operations not allowed. Use SELECT queries only." >&2

893 exit 2

894fi

509 895

510[Agent completes initial analysis and returns agentId: "abc123"]896exit 0

511```897```

512 898

513Resume the agent:899Make the script executable:

514 900

901```bash theme={null}

902chmod +x ./scripts/validate-readonly-query.sh

515```903```

516> Resume agent abc123 and now analyze the authorization logic as well

~~517~~

518[Agent continues with full context from previous conversation]

519```

~~520~~

521**Use cases:**

~~522~~

523* **Long-running research**: Break down large codebase analysis into multiple sessions

524* **Iterative refinement**: Continue refining a subagent's work without losing context

525* **Multi-step workflows**: Have a subagent work on related tasks sequentially while maintaining context

~~526~~

527**Technical details:**

~~528~~

529* Agent transcripts are stored in your project directory

530* Recording is disabled during resume to avoid duplicating messages

531* Both synchronous and asynchronous agents can be resumed

532* The `resume` parameter accepts the agent ID from a previous execution

~~533~~

534**Programmatic usage:**

~~535~~

536If you're using the Agent SDK or interacting with the AgentTool directly, you can pass the `resume` parameter:

~~537~~

538```typescript theme={null}

539{

540 "description": "Continue analysis",

541 "prompt": "Now examine the error handling patterns",

542 "subagent_type": "code-analyzer",

543 "resume": "abc123" // Agent ID from previous execution

544}

545```

~~546~~

547<Tip>

548 Keep track of agent IDs for tasks you may want to resume later. Claude Code displays the agent ID when a subagent completes its work.

549</Tip>

550 904

551## Performance considerations905The hook receives JSON via stdin with the Bash command in `tool_input.command`. Exit code 2 blocks the operation and feeds the error message back to Claude. See [Hooks](/en/hooks#exit-code-output) for details on exit codes and [Hook input](/en/hooks#pretooluse-input) for the complete input schema.

552 906

553* **Context efficiency**: Agents help preserve main context, enabling longer overall sessions907## Next steps

554* **Latency**: Subagents start off with a clean slate each time they are invoked and may add latency as they gather context that they require to do their job effectively.

555 908

556## Related documentation909Now that you understand subagents, explore these related features:

557 910

558* [Plugins](/en/plugins) - Extend Claude Code with custom agents through plugins911* [Distribute subagents with plugins](/en/plugins) to share subagents across teams or projects

559* [Slash commands](/en/slash-commands) - Learn about other built-in commands912* [Run Claude Code programmatically](/en/headless) with the Agent SDK for CI/CD and automation

560* [Settings](/en/settings) - Configure Claude Code behavior913* [Use MCP servers](/en/mcp) to give subagents access to external tools and data

561* [Hooks](/en/hooks) - Automate workflows with event handlers

terminal-config.md +46 −18

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Optimize your terminal setup5# Optimize your terminal setup

2 6

3> Claude Code works best when your terminal is properly configured. Follow these guidelines to optimize your experience.7> Claude Code works best when your terminal is properly configured. Follow these guidelines to optimize your experience.

10 14

11### Line breaks15### Line breaks

12 16

~~13You have several options for entering linebreaks into Claude Code:~~17You have several options for entering line breaks into Claude Code:

14 18

15* **Quick escape**: Type `\` followed by Enter to create a newline19* **Quick escape**: Type `\` followed by Enter to create a newline

~~16* **Keyboard shortcut**: Set up a keybinding to insert a newline~~20* **Shift+Enter**: Works out of the box in iTerm2, WezTerm, Ghostty, and Kitty

21* **Keyboard shortcut**: Set up a keybinding to insert a newline in other terminals

23**Set up Shift+Enter for other terminals**

17 24

~~18#### Set up Shift+Enter (VS Code or iTerm2):~~25Run `/terminal-setup` within Claude Code to automatically configure Shift+Enter for VS Code, Alacritty, Zed, and Warp.

19 26

~~20Run `/terminal-setup` within Claude Code to automatically configure Shift+Enter.~~27<Note>

28 The `/terminal-setup` command is only visible in terminals that require manual configuration. If you're using iTerm2, WezTerm, Ghostty, or Kitty, you won't see this command because Shift+Enter already works natively.

29</Note>

21 30

~~22#### Set up Option+Enter (VS Code, iTerm2 or macOS Terminal.app):~~31**Set up Option+Enter (VS Code, iTerm2 or macOS Terminal.app)**

23 32

24**For Mac Terminal.app:**33**For Mac Terminal.app:**

25 34

261. Open Settings → Profiles → Keyboard351. Open Settings → Profiles → Keyboard

272. Check "Use Option as Meta Key"362. Check "Use Option as Meta Key"

28 37

~~29**For iTerm2 and VS Code terminal:**~~38**For iTerm2:**

30 39

311. Open Settings → Profiles → Keys401. Open Settings → Profiles → Keys

322. Under General, set Left/Right Option key to "Esc+"412. Under General, set Left/Right Option key to "Esc+"

33 42

43**For VS Code terminal:**

45Set `"terminal.integrated.macOptionIsMeta": true` in VS Code settings.

34### Notification setup47### Notification setup

35 48

~~36Never miss when Claude completes a task with proper notification configuration:~~49When Claude finishes working and is waiting for your input, it fires a notification event. You can surface this event as a desktop notification through your terminal or run custom logic with [notification hooks](/en/hooks#notification).

51#### Terminal notifications

37 52

~~38#### iTerm 2 system notifications~~53Kitty and Ghostty support desktop notifications without additional configuration. iTerm 2 requires setup:

39 54

~~40For iTerm 2 alerts when tasks complete:~~551. Open iTerm 2 Settings → Profiles → Terminal

562. Enable "Notification Center Alerts"

573. Click "Filter Alerts" and check "Send escape sequence-generated alerts"

41 58

~~421. Open iTerm 2 Preferences~~59If notifications aren't appearing, verify that your terminal app has notification permissions in your OS settings.

~~432. Navigate to Profiles → Terminal~~

~~443. Enable "Silence bell" and Filter Alerts → "Send escape sequence-generated alerts"~~

~~454. Set your preferred notification delay~~

46 60

~~47Note that these notifications are specific to iTerm 2 and not available in the default macOS Terminal.~~61When running Claude Code inside tmux, notifications and the [terminal progress bar](/en/settings#global-config-settings) only reach the outer terminal, such as iTerm2, Kitty, or Ghostty, if you enable passthrough in your tmux configuration:

48 62

~~49#### Custom notification hooks~~63```

64set -g allow-passthrough on

65```

50 66

~~51For advanced notification handling, you can create [notification hooks](/en/hooks#notification) to run your own logic.~~67Without this setting, tmux intercepts the escape sequences and they do not reach the terminal application.

69Other terminals, including the default macOS Terminal, do not support native notifications. Use [notification hooks](/en/hooks#notification) instead.

71#### Notification hooks

73To add custom behavior when notifications fire, such as playing a sound or sending a message, configure a [notification hook](/en/hooks#notification). Hooks run alongside terminal notifications, not as a replacement.

52 74

53### Handling large inputs75### Handling large inputs

54 76

60 82

61### Vim Mode83### Vim Mode

62 84

~~63Claude Code supports a subset of Vim keybindings that can be enabled with `/vim` or configured via `/config`.~~85Claude Code supports a subset of Vim keybindings that can be enabled with `/vim` or configured via `/config`. To set the mode directly in your config file, set the [`editorMode`](/en/settings#global-config-settings) global config key to `"vim"` in `~/.claude.json`.

64 86

65The supported subset includes:87The supported subset includes:

66 88

67* Mode switching: `Esc` (to NORMAL), `i`/`I`, `a`/`A`, `o`/`O` (to INSERT)89* Mode switching: `Esc` (to NORMAL), `i`/`I`, `a`/`A`, `o`/`O` (to INSERT)

~~68* Navigation: `h`/`j`/`k`/`l`, `w`/`e`/`b`, `0`/`$`/`^`, `gg`/`G`~~90* Navigation: `h`/`j`/`k`/`l`, `w`/`e`/`b`, `0`/`$`/`^`, `gg`/`G`, `f`/`F`/`t`/`T` with `;`/`,` repeat

69* Editing: `x`, `dw`/`de`/`db`/`dd`/`D`, `cw`/`ce`/`cb`/`cc`/`C`, `.` (repeat)91* Editing: `x`, `dw`/`de`/`db`/`dd`/`D`, `cw`/`ce`/`cb`/`cc`/`C`, `.` (repeat)

92* Yank/paste: `yy`/`Y`, `yw`/`ye`/`yb`, `p`/`P`

93* Text objects: `iw`/`aw`, `iW`/`aW`, `i"`/`a"`, `i'`/`a'`, `i(`/`a(`, `i[`/`a[`, `i{`/`a{`

94* Indentation: `>>`/`<<`

95* Line operations: `J` (join lines)

97See [Interactive mode](/en/interactive-mode#vim-editor-mode) for the complete reference.

third-party-integrations.md +153 −151

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Enterprise deployment overview5# Enterprise deployment overview

2 6

3> Learn how Claude Code can integrate with various third-party services and infrastructure to meet enterprise deployment requirements.7> Learn how Claude Code can integrate with various third-party services and infrastructure to meet enterprise deployment requirements.

4 8

~~5This page provides an overview of available deployment options and helps you choose the right configuration for your organization.~~9Organizations can deploy Claude Code through Anthropic directly or through a cloud provider. This page helps you choose the right configuration.

11## Compare deployment options

13For most organizations, Claude for Teams or Claude for Enterprise provides the best experience. Team members get access to both Claude Code and Claude on the web with a single subscription, centralized billing, and no infrastructure setup required.

15**Claude for Teams** is self-service and includes collaboration features, admin tools, and billing management. Best for smaller teams that need to get started quickly.

17**Claude for Enterprise** adds SSO and domain capture, role-based permissions, compliance API access, and managed policy settings for deploying organization-wide Claude Code configurations. Best for larger organizations with security and compliance requirements.

19Learn more about [Team plans](https://support.claude.com/en/articles/9266767-what-is-the-team-plan) and [Enterprise plans](https://support.claude.com/en/articles/9797531-what-is-the-enterprise-plan).

6 20

~~7## Provider comparison~~21If your organization has specific infrastructure requirements, compare the options below:

8 22

9<table>23<table>

10 <thead>24 <thead>

11 <tr>25 <tr>

12 <th>Feature</th>26 <th>Feature</th>

~~13 <th>Anthropic</th>~~27 <th>Claude for Teams/Enterprise</th>

28 <th>Anthropic Console</th>

14 <th>Amazon Bedrock</th>29 <th>Amazon Bedrock</th>

15 <th>Google Vertex AI</th>30 <th>Google Vertex AI</th>

16 <th>Microsoft Foundry</th>31 <th>Microsoft Foundry</th>

18 </thead>33 </thead>

19 34

20 <tbody>35 <tbody>

36 <tr>

37 <td>Best for</td>

38 <td>Most organizations (recommended)</td>

39 <td>Individual developers</td>

40 <td>AWS-native deployments</td>

41 <td>GCP-native deployments</td>

42 <td>Azure-native deployments</td>

43 </tr>

45 <tr>

46 <td>Billing</td>

47 <td><strong>Teams:</strong> \$150/seat (Premium) with PAYG available<br /><strong>Enterprise:</strong> <a href="https://claude.com/contact-sales?utm_source=claude_code&utm_medium=docs&utm_content=third_party_enterprise">Contact Sales</a></td>

48 <td>PAYG</td>

49 <td>PAYG through AWS</td>

50 <td>PAYG through GCP</td>

51 <td>PAYG through Azure</td>

52 </tr>

21 <tr>54 <tr>

22 <td>Regions</td>55 <td>Regions</td>

23 <td>Supported [countries](https://www.anthropic.com/supported-countries)</td>56 <td>Supported [countries](https://www.anthropic.com/supported-countries)</td>

57 <td>Supported [countries](https://www.anthropic.com/supported-countries)</td>

24 <td>Multiple AWS [regions](https://docs.aws.amazon.com/bedrock/latest/userguide/models-regions.html)</td>58 <td>Multiple AWS [regions](https://docs.aws.amazon.com/bedrock/latest/userguide/models-regions.html)</td>

25 <td>Multiple GCP [regions](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations)</td>59 <td>Multiple GCP [regions](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations)</td>

26 <td>Multiple Azure [regions](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/)</td>60 <td>Multiple Azure [regions](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/)</td>

32 <td>Enabled by default</td>66 <td>Enabled by default</td>

33 <td>Enabled by default</td>67 <td>Enabled by default</td>

34 <td>Enabled by default</td>68 <td>Enabled by default</td>

69 <td>Enabled by default</td>

35 </tr>70 </tr>

36 71

37 <tr>72 <tr>

38 <td>Authentication</td>73 <td>Authentication</td>

74 <td>Claude.ai SSO or email</td>

39 <td>API key</td>75 <td>API key</td>

40 <td>API key or AWS credentials</td>76 <td>API key or AWS credentials</td>

41 <td>GCP credentials</td>77 <td>GCP credentials</td>

44 80

45 <tr>81 <tr>

46 <td>Cost tracking</td>82 <td>Cost tracking</td>

~~47 <td>Dashboard</td>~~83 <td>Usage dashboard</td>

84 <td>Usage dashboard</td>

48 <td>AWS Cost Explorer</td>85 <td>AWS Cost Explorer</td>

49 <td>GCP Billing</td>86 <td>GCP Billing</td>

50 <td>Azure Cost Management</td>87 <td>Azure Cost Management</td>

51 </tr>88 </tr>

52 89

90 <tr>

91 <td>Includes Claude on web</td>

92 <td>Yes</td>

93 <td>No</td>

94 <td>No</td>

95 <td>No</td>

96 <td>No</td>

97 </tr>

53 <tr>99 <tr>

54 <td>Enterprise features</td>100 <td>Enterprise features</td>

~~55 <td>Teams, usage monitoring</td>~~101 <td>Team management, SSO, usage monitoring</td>

102 <td>None</td>

56 <td>IAM policies, CloudTrail</td>103 <td>IAM policies, CloudTrail</td>

57 <td>IAM roles, Cloud Audit Logs</td>104 <td>IAM roles, Cloud Audit Logs</td>

58 <td>RBAC policies, Azure Monitor</td>105 <td>RBAC policies, Azure Monitor</td>

60 </tbody>107 </tbody>

61</table>108</table>

62 109

~~63## Cloud providers~~110Select a deployment option to view setup instructions:

~~65<CardGroup cols={3}>~~

~~66 <Card title="Amazon Bedrock" icon="aws" href="/en/amazon-bedrock">~~

~~67 Use Claude models through AWS infrastructure with API key or IAM-based authentication and AWS-native monitoring~~

~~68 </Card>~~

~~70 <Card title="Google Vertex AI" icon="google" href="/en/google-vertex-ai">~~

~~71 Access Claude models via Google Cloud Platform with enterprise-grade security and compliance~~

~~72 </Card>~~

~~74 <Card title="Microsoft Foundry" icon="microsoft" href="/en/microsoft-foundry">~~

~~75 Access Claude through Azure with API key or Microsoft Entra ID authentication and Azure billing~~

~~76 </Card>~~

~~77</CardGroup>~~

~~79## Corporate infrastructure~~

~~81<CardGroup cols={2}>~~

~~82 <Card title="Enterprise Network" icon="shield" href="/en/network-config">~~

~~83 Configure Claude Code to work with your organization's proxy servers and SSL/TLS requirements~~

~~84 </Card>~~

85 111

~~86 <Card title="LLM Gateway" icon="server" href="/en/llm-gateway">~~112* [Claude for Teams or Enterprise](/en/authentication#claude-for-teams-or-enterprise)

~~87 Deploy centralized model access with usage tracking, budgeting, and audit logging~~113* [Anthropic Console](/en/authentication#claude-console-authentication)

~~88 </Card>~~114* [Amazon Bedrock](/en/amazon-bedrock)

~~89</CardGroup>~~115* [Google Vertex AI](/en/google-vertex-ai)

116* [Microsoft Foundry](/en/microsoft-foundry)

90 117

~~91## Configuration overview~~118## Configure proxies and gateways

92 119

~~93Claude Code supports flexible configuration options that allow you to combine different providers and infrastructure:~~120Most organizations can use a cloud provider directly without additional configuration. However, you may need to configure a corporate proxy or LLM gateway if your organization has specific network or management requirements. These are different configurations that can be used together:

94 121

~~95<Note>~~122* **Corporate proxy**: Routes traffic through an HTTP/HTTPS proxy. Use this if your organization requires all outbound traffic to pass through a proxy server for security monitoring, compliance, or network policy enforcement. Configure with the `HTTPS_PROXY` or `HTTP_PROXY` environment variables. Learn more in [Enterprise network configuration](/en/network-config).

~~96 Understand the difference between:~~123* **LLM Gateway**: A service that sits between Claude Code and the cloud provider to handle authentication and routing. Use this if you need centralized usage tracking across teams, custom rate limiting or budgets, or centralized authentication management. Configure with the `ANTHROPIC_BASE_URL`, `ANTHROPIC_BEDROCK_BASE_URL`, or `ANTHROPIC_VERTEX_BASE_URL` environment variables. Learn more in [LLM gateway configuration](/en/llm-gateway).

97 124

~~98 * **Corporate proxy**: An HTTP/HTTPS proxy for routing traffic (set via `HTTPS_PROXY` or `HTTP_PROXY`)~~125The following examples show the environment variables to set in your shell or shell profile (`.bashrc`, `.zshrc`). See [Settings](/en/settings) for other configuration methods.

~~99 * **LLM Gateway**: A service that handles authentication and provides provider-compatible endpoints (set via `ANTHROPIC_BASE_URL`, `ANTHROPIC_BEDROCK_BASE_URL`, or `ANTHROPIC_VERTEX_BASE_URL`)~~

100 126

101 Both configurations can be used in tandem.127### Amazon Bedrock

102</Note>

103 128

104### Using Bedrock with corporate proxy129<Tabs>

130 <Tab title="Corporate proxy">

131 Route Bedrock traffic through your corporate proxy by setting the following [environment variables](/en/env-vars):

105 132

106Route Bedrock traffic through a corporate HTTP/HTTPS proxy:133 ```bash theme={null}

134 # Enable Bedrock

135 export CLAUDE_CODE_USE_BEDROCK=1

136 export AWS_REGION=us-east-1

107 137

108```bash theme={null}138 # Configure corporate proxy

109# Enable Bedrock139 export HTTPS_PROXY='https://proxy.example.com:8080'

110export CLAUDE_CODE_USE_BEDROCK=1140 ```

111export AWS_REGION=us-east-1141 </Tab>

112 142

113# Configure corporate proxy143 <Tab title="LLM Gateway">

114export HTTPS_PROXY='https://proxy.example.com:8080'144 Route Bedrock traffic through your LLM gateway by setting the following [environment variables](/en/env-vars):

115```

116 145

117### Using Bedrock with LLM Gateway146 ```bash theme={null}

147 # Enable Bedrock

148 export CLAUDE_CODE_USE_BEDROCK=1

118 149

119Use a gateway service that provides Bedrock-compatible endpoints:150 # Configure LLM gateway

151 export ANTHROPIC_BEDROCK_BASE_URL='https://your-llm-gateway.com/bedrock'

152 export CLAUDE_CODE_SKIP_BEDROCK_AUTH=1 # If gateway handles AWS auth

153 ```

154 </Tab>

155</Tabs>

120 156

121```bash theme={null}157### Microsoft Foundry

122# Enable Bedrock

123export CLAUDE_CODE_USE_BEDROCK=1

124 158

125# Configure LLM gateway159<Tabs>

126export ANTHROPIC_BEDROCK_BASE_URL='https://your-llm-gateway.com/bedrock'160 <Tab title="Corporate proxy">

127export CLAUDE_CODE_SKIP_BEDROCK_AUTH=1 # If gateway handles AWS auth161 Route Foundry traffic through your corporate proxy by setting the following [environment variables](/en/env-vars):

128```

129 162

130### Using Foundry with corporate proxy163 ```bash theme={null}

164 # Enable Microsoft Foundry

165 export CLAUDE_CODE_USE_FOUNDRY=1

166 export ANTHROPIC_FOUNDRY_RESOURCE=your-resource

167 export ANTHROPIC_FOUNDRY_API_KEY=your-api-key # Or omit for Entra ID auth

131 168

132Route Azure traffic through a corporate HTTP/HTTPS proxy:169 # Configure corporate proxy

170 export HTTPS_PROXY='https://proxy.example.com:8080'

171 ```

172 </Tab>

133 173

134```bash theme={null}174 <Tab title="LLM Gateway">

135# Enable Microsoft Foundry175 Route Foundry traffic through your LLM gateway by setting the following [environment variables](/en/env-vars):

136export CLAUDE_CODE_USE_FOUNDRY=1

137export ANTHROPIC_FOUNDRY_RESOURCE=your-resource

138export ANTHROPIC_FOUNDRY_API_KEY=your-api-key # Or omit for Entra ID auth

139 176

140# Configure corporate proxy177 ```bash theme={null}

141export HTTPS_PROXY='https://proxy.example.com:8080'178 # Enable Microsoft Foundry

142```179 export CLAUDE_CODE_USE_FOUNDRY=1

143 180

144### Using Foundry with LLM Gateway181 # Configure LLM gateway

182 export ANTHROPIC_FOUNDRY_BASE_URL='https://your-llm-gateway.com'

183 export CLAUDE_CODE_SKIP_FOUNDRY_AUTH=1 # If gateway handles Azure auth

184 ```

185 </Tab>

186</Tabs>

145 187

146Use a gateway service that provides Azure-compatible endpoints:188### Google Vertex AI

147 189

148```bash theme={null}190<Tabs>

149# Enable Microsoft Foundry191 <Tab title="Corporate proxy">

150export CLAUDE_CODE_USE_FOUNDRY=1192 Route Vertex AI traffic through your corporate proxy by setting the following [environment variables](/en/env-vars):

151 193

152# Configure LLM gateway194 ```bash theme={null}

153export ANTHROPIC_FOUNDRY_BASE_URL='https://your-llm-gateway.com'195 # Enable Vertex

154export CLAUDE_CODE_SKIP_FOUNDRY_AUTH=1 # If gateway handles Azure auth196 export CLAUDE_CODE_USE_VERTEX=1

155```197 export CLOUD_ML_REGION=us-east5

198 export ANTHROPIC_VERTEX_PROJECT_ID=your-project-id

156 199

157### Using Vertex AI with corporate proxy200 # Configure corporate proxy

201 export HTTPS_PROXY='https://proxy.example.com:8080'

202 ```

203 </Tab>

158 204

159Route Vertex AI traffic through a corporate HTTP/HTTPS proxy:205 <Tab title="LLM Gateway">

206 Route Vertex AI traffic through your LLM gateway by setting the following [environment variables](/en/env-vars):

160 207

161```bash theme={null}208 ```bash theme={null}

162# Enable Vertex209 # Enable Vertex

163export CLAUDE_CODE_USE_VERTEX=1210 export CLAUDE_CODE_USE_VERTEX=1

164export CLOUD_ML_REGION=us-east5

165export ANTHROPIC_VERTEX_PROJECT_ID=your-project-id

166 211

167# Configure corporate proxy212 # Configure LLM gateway

168export HTTPS_PROXY='https://proxy.example.com:8080'213 export ANTHROPIC_VERTEX_BASE_URL='https://your-llm-gateway.com/vertex'

169```214 export CLAUDE_CODE_SKIP_VERTEX_AUTH=1 # If gateway handles GCP auth

215 ```

216 </Tab>

217</Tabs>

170 218

171### Using Vertex AI with LLM Gateway219<Tip>

~~172~~ 220 Use `/status` in Claude Code to verify your proxy and gateway configuration is applied correctly.

173Combine Google Vertex AI models with an LLM gateway for centralized management:221</Tip>

~~174~~

175```bash theme={null}

176# Enable Vertex

177export CLAUDE_CODE_USE_VERTEX=1

~~178~~

179# Configure LLM gateway

180export ANTHROPIC_VERTEX_BASE_URL='https://your-llm-gateway.com/vertex'

181export CLAUDE_CODE_SKIP_VERTEX_AUTH=1 # If gateway handles GCP auth

182```

~~183~~

184### Authentication configuration

~~185~~

186Claude Code uses the `ANTHROPIC_AUTH_TOKEN` for the `Authorization` header when needed. The `SKIP_AUTH` flags (`CLAUDE_CODE_SKIP_BEDROCK_AUTH`, `CLAUDE_CODE_SKIP_VERTEX_AUTH`) are used in LLM gateway scenarios where the gateway handles provider authentication.

~~187~~

188## Choosing the right deployment configuration

~~189~~

190Consider these factors when selecting your deployment approach:

~~191~~

192### Direct provider access

~~193~~

194Best for organizations that:

~~195~~

196* Want the simplest setup

197* Have existing AWS or GCP infrastructure

198* Need provider-native monitoring and compliance

~~199~~

200### Corporate proxy

~~201~~

202Best for organizations that:

~~203~~

204* Have existing corporate proxy requirements

205* Need traffic monitoring and compliance

206* Must route all traffic through specific network paths

~~207~~

208### LLM Gateway

~~209~~

210Best for organizations that:

~~211~~

212* Need usage tracking across teams

213* Want to dynamically switch between models

214* Require custom rate limiting or budgets

215* Need centralized authentication management

~~216~~

217## Debugging

~~218~~

219When debugging your deployment:

~~220~~

221* Use the `claude /status` [slash command](/en/slash-commands). This command provides observability into any applied authentication, proxy, and URL settings.

222* Set environment variable `export ANTHROPIC_LOG=debug` to log requests.

223 222

224## Best practices for organizations223## Best practices for organizations

225 224

226### 1. Invest in documentation and memory225### Invest in documentation and memory

227 226

228We strongly recommend investing in documentation so that Claude Code understands your codebase. Organizations can deploy CLAUDE.md files at multiple levels:227We strongly recommend investing in documentation so that Claude Code understands your codebase. Organizations can deploy CLAUDE.md files at multiple levels:

229 228

230* **Organization-wide**: Deploy to system directories like `/Library/Application Support/ClaudeCode/CLAUDE.md` (macOS) for company-wide standards229* **Organization-wide**: Deploy to system directories like `/Library/Application Support/ClaudeCode/CLAUDE.md` (macOS) for company-wide standards

231* **Repository-level**: Create `CLAUDE.md` files in repository roots containing project architecture, build commands, and contribution guidelines. Check these into source control so all users benefit230* **Repository-level**: Create `CLAUDE.md` files in repository roots containing project architecture, build commands, and contribution guidelines. Check these into source control so all users benefit

232 231

233 [Learn more](/en/memory).232Learn more in [Memory and CLAUDE.md files](/en/memory).

234 233

235### 2. Simplify deployment234### Simplify deployment

236 235

237If you have a custom development environment, we find that creating a "one click" way to install Claude Code is key to growing adoption across an organization.236If you have a custom development environment, we find that creating a "one click" way to install Claude Code is key to growing adoption across an organization.

238 237

239### 3. Start with guided usage238### Start with guided usage

240 239

241Encourage new users to try Claude Code for codebase Q\&A, or on smaller bug fixes or feature requests. Ask Claude Code to make a plan. Check Claude's suggestions and give feedback if it's off-track. Over time, as users understand this new paradigm better, then they'll be more effective at letting Claude Code run more agentically.240Encourage new users to try Claude Code for codebase Q\&A, or on smaller bug fixes or feature requests. Ask Claude Code to make a plan. Check Claude's suggestions and give feedback if it's off-track. Over time, as users understand this new paradigm better, then they'll be more effective at letting Claude Code run more agentically.

242 241

243### 4. Configure security policies242### Pin model versions for cloud providers

243

244If you deploy through [Bedrock](/en/amazon-bedrock), [Vertex AI](/en/google-vertex-ai), or [Foundry](/en/microsoft-foundry), pin specific model versions using `ANTHROPIC_DEFAULT_OPUS_MODEL`, `ANTHROPIC_DEFAULT_SONNET_MODEL`, and `ANTHROPIC_DEFAULT_HAIKU_MODEL`. Without pinning, Claude Code aliases resolve to the latest version, which can break users when Anthropic releases a new model that isn't yet enabled in your account. See [Model configuration](/en/model-config#pin-models-for-third-party-deployments) for details.

245

246### Configure security policies

244 247

245Security teams can configure managed permissions for what Claude Code is and is not allowed to do, which cannot be overwritten by local configuration. [Learn more](/en/security).248Security teams can configure managed permissions for what Claude Code is and is not allowed to do, which cannot be overwritten by local configuration. [Learn more](/en/security).

246 249

247### 5. Leverage MCP for integrations250### Leverage MCP for integrations

248 251

249MCP is a great way to give Claude Code more information, such as connecting to ticket management systems or error logs. We recommend that one central team configures MCP servers and checks a `.mcp.json` configuration into the codebase so that all users benefit. [Learn more](/en/mcp).252MCP is a great way to give Claude Code more information, such as connecting to ticket management systems or error logs. We recommend that one central team configures MCP servers and checks a `.mcp.json` configuration into the codebase so that all users benefit. [Learn more](/en/mcp).

250 253

251At Anthropic, we trust Claude Code to power development across every Anthropic codebase. We hope you enjoy using Claude Code as much as we do!254At Anthropic, we trust Claude Code to power development across every Anthropic codebase. We hope you enjoy using Claude Code as much as we do.

252 255

253## Next steps256## Next steps

254 257

255* [Set up Amazon Bedrock](/en/amazon-bedrock) for AWS-native deployment258Once you've chosen a deployment option and configured access for your team:

256* [Configure Google Vertex AI](/en/google-vertex-ai) for GCP deployment259

257* [Set up Microsoft Foundry](/en/microsoft-foundry) for Azure deployment2601. **Roll out to your team**: Share installation instructions and have team members [install Claude Code](/en/setup) and authenticate with their credentials.

258* [Configure Enterprise Network](/en/network-config) for network requirements2612. **Set up shared configuration**: Create a [CLAUDE.md file](/en/memory) in your repositories to help Claude Code understand your codebase and coding standards.

259* [Deploy LLM Gateway](/en/llm-gateway) for enterprise management2623. **Configure permissions**: Review [security settings](/en/security) to define what Claude Code can and cannot do in your environment.

260* [Settings](/en/settings) for configuration options and environment variables

tools-reference.md +59 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Tools reference

7> Complete reference for the tools Claude Code can use, including permission requirements.

9Claude Code has access to a set of tools that help it understand and modify your codebase. The tool names below are the exact strings you use in [permission rules](/en/permissions#tool-specific-permission-rules), [subagent tool lists](/en/sub-agents), and [hook matchers](/en/hooks).

11| Tool | Description | Permission Required |

12| :--------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------ |

13| `Agent` | Spawns a [subagent](/en/sub-agents) with its own context window to handle a task | No |

14| `AskUserQuestion` | Asks multiple-choice questions to gather requirements or clarify ambiguity | No |

15| `Bash` | Executes shell commands in your environment. See [Bash tool behavior](#bash-tool-behavior) | Yes |

16| `CronCreate` | Schedules a recurring or one-shot prompt within the current session (gone when Claude exits). See [scheduled tasks](/en/scheduled-tasks) | No |

17| `CronDelete` | Cancels a scheduled task by ID | No |

18| `CronList` | Lists all scheduled tasks in the session | No |

19| `Edit` | Makes targeted edits to specific files | Yes |

20| `EnterPlanMode` | Switches to plan mode to design an approach before coding | No |

21| `EnterWorktree` | Creates an isolated [git worktree](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees) and switches into it | No |

22| `ExitPlanMode` | Presents a plan for approval and exits plan mode | Yes |

23| `ExitWorktree` | Exits a worktree session and returns to the original directory | No |

24| `Glob` | Finds files based on pattern matching | No |

25| `Grep` | Searches for patterns in file contents | No |

26| `ListMcpResourcesTool` | Lists resources exposed by connected [MCP servers](/en/mcp) | No |

27| `LSP` | Code intelligence via language servers. Reports type errors and warnings automatically after file edits. Also supports navigation operations: jump to definitions, find references, get type info, list symbols, find implementations, trace call hierarchies. Requires a [code intelligence plugin](/en/discover-plugins#code-intelligence) and its language server binary | No |

28| `NotebookEdit` | Modifies Jupyter notebook cells | Yes |

29| `Read` | Reads the contents of files | No |

30| `ReadMcpResourceTool` | Reads a specific MCP resource by URI | No |

31| `Skill` | Executes a [skill](/en/skills#control-who-invokes-a-skill) within the main conversation | Yes |

32| `TaskCreate` | Creates a new task in the task list | No |

33| `TaskGet` | Retrieves full details for a specific task | No |

34| `TaskList` | Lists all tasks with their current status | No |

35| `TaskOutput` | (Deprecated) Retrieves output from a background task. Prefer `Read` on the task's output file path | No |

36| `TaskStop` | Kills a running background task by ID | No |

37| `TaskUpdate` | Updates task status, dependencies, details, or deletes tasks | No |

38| `TodoWrite` | Manages the session task checklist. Available in non-interactive mode and the [Agent SDK](/en/headless); interactive sessions use TaskCreate, TaskGet, TaskList, and TaskUpdate instead | No |

39| `ToolSearch` | Searches for and loads deferred tools when [tool search](/en/mcp#scale-with-mcp-tool-search) is enabled | No |

40| `WebFetch` | Fetches content from a specified URL | Yes |

41| `WebSearch` | Performs web searches | Yes |

42| `Write` | Creates or overwrites files | Yes |

44Permission rules can be configured using `/permissions` or in [permission settings](/en/settings#available-settings). Also see [Tool-specific permission rules](/en/permissions#tool-specific-permission-rules).

46## Bash tool behavior

48The Bash tool runs each command in a separate process with the following persistence behavior:

50* Working directory persists across commands. Set `CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR=1` to reset to the project directory after each command.

51* Environment variables do not persist. An `export` in one command will not be available in the next.

53Activate your virtualenv or conda environment before launching Claude Code. To make environment variables persist across Bash commands, set [`CLAUDE_ENV_FILE`](/en/env-vars) to a shell script before launching Claude Code, or use a [SessionStart hook](/en/hooks#persist-environment-variables) to populate it dynamically.

55## See also

57* [Permissions](/en/permissions): permission system, rule syntax, and tool-specific patterns

58* [Subagents](/en/sub-agents): configure tool access for subagents

59* [Hooks](/en/hooks-guide): run custom commands before or after tool execution

troubleshooting.md +661 −91

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

1# Troubleshooting5# Troubleshooting

2 6

3> Discover solutions to common issues with Claude Code installation and usage.7> Discover solutions to common issues with Claude Code installation and usage.

4 8

9## Troubleshoot installation issues

11<Tip>

12 If you'd rather skip the terminal entirely, the [Claude Code Desktop app](/en/desktop-quickstart) lets you install and use Claude Code through a graphical interface. Download it for [macOS](https://claude.ai/api/desktop/darwin/universal/dmg/latest/redirect?utm_source=claude_code\&utm_medium=docs) or [Windows](https://claude.ai/api/desktop/win32/x64/exe/latest/redirect?utm_source=claude_code\&utm_medium=docs) and start coding without any command-line setup.

13</Tip>

15Find the error message or symptom you're seeing:

17| What you see | Solution |

18| :---------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- |

19| `command not found: claude` or `'claude' is not recognized` | [Fix your PATH](#command-not-found-claude-after-installation) |

20| `syntax error near unexpected token '<'` | [Install script returns HTML](#install-script-returns-html-instead-of-a-shell-script) |

21| `curl: (56) Failure writing output to destination` | [Download script first, then run it](#curl-56-failure-writing-output-to-destination) |

22| `Killed` during install on Linux | [Add swap space for low-memory servers](#install-killed-on-low-memory-linux-servers) |

23| `TLS connect error` or `SSL/TLS secure channel` | [Update CA certificates](#tls-or-ssl-connection-errors) |

24| `Failed to fetch version` or can't reach download server | [Check network and proxy settings](#check-network-connectivity) |

25| `irm is not recognized` or `&& is not valid` | [Use the right command for your shell](#windows-irm-or--not-recognized) |

26| `Claude Code on Windows requires git-bash` | [Install or configure Git Bash](#windows-claude-code-on-windows-requires-git-bash) |

27| `Error loading shared library` | [Wrong binary variant for your system](#linux-wrong-binary-variant-installed-muslglibc-mismatch) |

28| `Illegal instruction` on Linux | [Architecture mismatch](#illegal-instruction-on-linux) |

29| `dyld: cannot load` or `Abort trap` on macOS | [Binary incompatibility](#dyld-cannot-load-on-macos) |

30| `Invoke-Expression: Missing argument in parameter list` | [Install script returns HTML](#install-script-returns-html-instead-of-a-shell-script) |

31| `App unavailable in region` | Claude Code is not available in your country. See [supported countries](https://www.anthropic.com/supported-countries). |

32| `unable to get local issuer certificate` | [Configure corporate CA certificates](#tls-or-ssl-connection-errors) |

33| `OAuth error` or `403 Forbidden` | [Fix authentication](#authentication-issues) |

35If your issue isn't listed, work through these diagnostic steps.

37## Debug installation problems

39### Check network connectivity

41The installer downloads from `storage.googleapis.com`. Verify you can reach it:

43```bash theme={null}

44curl -sI https://storage.googleapis.com

45```

47If this fails, your network may be blocking the connection. Common causes:

49* Corporate firewalls or proxies blocking Google Cloud Storage

50* Regional network restrictions: try a VPN or alternative network

51* TLS/SSL issues: update your system's CA certificates, or check if `HTTPS_PROXY` is configured

53If you're behind a corporate proxy, set `HTTPS_PROXY` and `HTTP_PROXY` to your proxy's address before installing. Ask your IT team for the proxy URL if you don't know it, or check your browser's proxy settings.

55This example sets both proxy variables, then runs the installer through your proxy:

57```bash theme={null}

58export HTTP_PROXY=http://proxy.example.com:8080

59export HTTPS_PROXY=http://proxy.example.com:8080

60curl -fsSL https://claude.ai/install.sh | bash

61```

63### Verify your PATH

65If installation succeeded but you get a `command not found` or `not recognized` error when running `claude`, the install directory isn't in your PATH. Your shell searches for programs in directories listed in PATH, and the installer places `claude` at `~/.local/bin/claude` on macOS/Linux or `%USERPROFILE%\.local\bin\claude.exe` on Windows.

67Check if the install directory is in your PATH by listing your PATH entries and filtering for `local/bin`:

69<Tabs>

70 <Tab title="macOS/Linux">

71 ```bash theme={null}

72 echo $PATH | tr ':' '\n' | grep local/bin

73 ```

75 If there's no output, the directory is missing. Add it to your shell configuration:

77 ```bash theme={null}

78 # Zsh (macOS default)

79 echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc

80 source ~/.zshrc

82 # Bash (Linux default)

83 echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc

84 source ~/.bashrc

85 ```

87 Alternatively, close and reopen your terminal.

89 Verify the fix worked:

91 ```bash theme={null}

92 claude --version

93 ```

94 </Tab>

96 <Tab title="Windows PowerShell">

97 ```powershell theme={null}

98 $env:PATH -split ';' | Select-String 'local\\bin'

99 ```

100

101 If there's no output, add the install directory to your User PATH:

102

103 ```powershell theme={null}

104 $currentPath = [Environment]::GetEnvironmentVariable('PATH', 'User')

105 [Environment]::SetEnvironmentVariable('PATH', "$currentPath;$env:USERPROFILE\.local\bin", 'User')

106 ```

107

108 Restart your terminal for the change to take effect.

109

110 Verify the fix worked:

111

112 ```powershell theme={null}

113 claude --version

114 ```

115 </Tab>

116

117 <Tab title="Windows CMD">

118 ```batch theme={null}

119 echo %PATH% | findstr /i "local\bin"

120 ```

121

122 If there's no output, open System Settings, go to Environment Variables, and add `%USERPROFILE%\.local\bin` to your User PATH variable. Restart your terminal.

123

124 Verify the fix worked:

125

126 ```batch theme={null}

127 claude --version

128 ```

129 </Tab>

130</Tabs>

131

132### Check for conflicting installations

133

134Multiple Claude Code installations can cause version mismatches or unexpected behavior. Check what's installed:

135

136<Tabs>

137 <Tab title="macOS/Linux">

138 List all `claude` binaries found in your PATH:

139

140 ```bash theme={null}

141 which -a claude

142 ```

143

144 Check whether the native installer and npm versions are present:

145

146 ```bash theme={null}

147 ls -la ~/.local/bin/claude

148 ```

149

150 ```bash theme={null}

151 ls -la ~/.claude/local/

152 ```

153

154 ```bash theme={null}

155 npm -g ls @anthropic-ai/claude-code 2>/dev/null

156 ```

157 </Tab>

158

159 <Tab title="Windows PowerShell">

160 ```powershell theme={null}

161 where.exe claude

162 Test-Path "$env:LOCALAPPDATA\Claude Code\claude.exe"

163 ```

164 </Tab>

165</Tabs>

166

167If you find multiple installations, keep only one. The native install at `~/.local/bin/claude` is recommended. Remove any extra installations:

168

169Uninstall an npm global install:

170

171```bash theme={null}

172npm uninstall -g @anthropic-ai/claude-code

173```

174

175Remove a Homebrew install on macOS:

176

177```bash theme={null}

178brew uninstall --cask claude-code

179```

180

181### Check directory permissions

182

183The installer needs write access to `~/.local/bin/` and `~/.claude/`. If installation fails with permission errors, check whether these directories are writable:

184

185```bash theme={null}

186test -w ~/.local/bin && echo "writable" || echo "not writable"

187test -w ~/.claude && echo "writable" || echo "not writable"

188```

189

190If either directory isn't writable, create the install directory and set your user as the owner:

191

192```bash theme={null}

193sudo mkdir -p ~/.local/bin

194sudo chown -R $(whoami) ~/.local

195```

196

197### Verify the binary works

198

199If `claude` is installed but crashes or hangs on startup, run these checks to narrow down the cause.

200

201Confirm the binary exists and is executable:

202

203```bash theme={null}

204ls -la $(which claude)

205```

206

207On Linux, check for missing shared libraries. If `ldd` shows missing libraries, you may need to install system packages. On Alpine Linux and other musl-based distributions, see [Alpine Linux setup](/en/setup#alpine-linux-and-musl-based-distributions).

208

209```bash theme={null}

210ldd $(which claude) | grep "not found"

211```

212

213Run a quick sanity check that the binary can execute:

214

215```bash theme={null}

216claude --version

217```

218

5## Common installation issues219## Common installation issues

6 220

221These are the most frequently encountered installation problems and their solutions.

222

223### Install script returns HTML instead of a shell script

224

225When running the install command, you may see one of these errors:

226

227```text theme={null}

228bash: line 1: syntax error near unexpected token `<'

229bash: line 1: `<!DOCTYPE html>'

230```

231

232On PowerShell, the same problem appears as:

233

234```text theme={null}

235Invoke-Expression: Missing argument in parameter list.

236```

237

238This means the install URL returned an HTML page instead of the install script. If the HTML page says "App unavailable in region," Claude Code is not available in your country. See [supported countries](https://www.anthropic.com/supported-countries).

239

240Otherwise, this can happen due to network issues, regional routing, or a temporary service disruption.

241

242**Solutions:**

243

2441. **Use an alternative install method**:

245

246 On macOS or Linux, install via Homebrew:

247

248 ```bash theme={null}

249 brew install --cask claude-code

250 ```

251

252 On Windows, install via WinGet:

253

254 ```powershell theme={null}

255 winget install Anthropic.ClaudeCode

256 ```

257

2582. **Retry after a few minutes**: the issue is often temporary. Wait and try the original command again.

259

260### `command not found: claude` after installation

261

262The install finished but `claude` doesn't work. The exact error varies by platform:

263

264| Platform | Error message |

265| :---------- | :--------------------------------------------------------------------- |

266| macOS | `zsh: command not found: claude` |

267| Linux | `bash: claude: command not found` |

268| Windows CMD | `'claude' is not recognized as an internal or external command` |

269| PowerShell | `claude : The term 'claude' is not recognized as the name of a cmdlet` |

270

271This means the install directory isn't in your shell's search path. See [Verify your PATH](#verify-your-path) for the fix on each platform.

272

273### `curl: (56) Failure writing output to destination`

274

275The `curl ... | bash` command downloads the script and passes it directly to Bash for execution using a pipe (`|`). This error means the connection broke before the script finished downloading. Common causes include network interruptions, the download being blocked mid-stream, or system resource limits.

276

277**Solutions:**

278

2791. **Check network stability**: Claude Code binaries are hosted on Google Cloud Storage. Test that you can reach it:

280 ```bash theme={null}

281 curl -fsSL https://storage.googleapis.com -o /dev/null

282 ```

283 If the command completes silently, your connection is fine and the issue is likely intermittent. Retry the install command. If you see an error, your network may be blocking the download.

284

2852. **Try an alternative install method**:

286

287 On macOS or Linux:

288

289 ```bash theme={null}

290 brew install --cask claude-code

291 ```

292

293 On Windows:

294

295 ```powershell theme={null}

296 winget install Anthropic.ClaudeCode

297 ```

298

299### TLS or SSL connection errors

300

301Errors like `curl: (35) TLS connect error`, `schannel: next InitializeSecurityContext failed`, or PowerShell's `Could not establish trust relationship for the SSL/TLS secure channel` indicate TLS handshake failures.

302

303**Solutions:**

304

3051. **Update your system CA certificates**:

306

307 On Ubuntu/Debian:

308

309 ```bash theme={null}

310 sudo apt-get update && sudo apt-get install ca-certificates

311 ```

312

313 On macOS via Homebrew:

314

315 ```bash theme={null}

316 brew install ca-certificates

317 ```

318

3192. **On Windows, enable TLS 1.2** in PowerShell before running the installer:

320 ```powershell theme={null}

321 [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

322 irm https://claude.ai/install.ps1 | iex

323 ```

324

3253. **Check for proxy or firewall interference**: corporate proxies that perform TLS inspection can cause these errors, including `unable to get local issuer certificate`. Set `NODE_EXTRA_CA_CERTS` to your corporate CA certificate bundle:

326 ```bash theme={null}

327 export NODE_EXTRA_CA_CERTS=/path/to/corporate-ca.pem

328 ```

329 Ask your IT team for the certificate file if you don't have it. You can also try on a direct connection to confirm the proxy is the cause.

330

331### `Failed to fetch version from storage.googleapis.com`

332

333The installer couldn't reach the download server. This typically means `storage.googleapis.com` is blocked on your network.

334

335**Solutions:**

336

3371. **Test connectivity directly**:

338 ```bash theme={null}

339 curl -sI https://storage.googleapis.com

340 ```

341

3422. **If behind a proxy**, set `HTTPS_PROXY` so the installer can route through it. See [proxy configuration](/en/network-config#proxy-configuration) for details.

343 ```bash theme={null}

344 export HTTPS_PROXY=http://proxy.example.com:8080

345 curl -fsSL https://claude.ai/install.sh | bash

346 ```

347

3483. **If on a restricted network**, try a different network or VPN, or use an alternative install method:

349

350 On macOS or Linux:

351

352 ```bash theme={null}

353 brew install --cask claude-code

354 ```

355

356 On Windows:

357

358 ```powershell theme={null}

359 winget install Anthropic.ClaudeCode

360 ```

361

362### Windows: `irm` or `&&` not recognized

363

364If you see `'irm' is not recognized` or `The token '&&' is not valid`, you're running the wrong command for your shell.

365

366* **`irm` not recognized**: you're in CMD, not PowerShell. You have two options:

367

368 Open PowerShell by searching for "PowerShell" in the Start menu, then run the original install command:

369

370 ```powershell theme={null}

371 irm https://claude.ai/install.ps1 | iex

372 ```

373

374 Or stay in CMD and use the CMD installer instead:

375

376 ```batch theme={null}

377 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

378 ```

379

380* **`&&` not valid**: you're in PowerShell but ran the CMD installer command. Use the PowerShell installer:

381 ```powershell theme={null}

382 irm https://claude.ai/install.ps1 | iex

383 ```

384

385### Install killed on low-memory Linux servers

386

387If you see `Killed` during installation on a VPS or cloud instance:

388

389```text theme={null}

390Setting up Claude Code...

391Installing Claude Code native build latest...

392bash: line 142: 34803 Killed "$binary_path" install ${TARGET:+"$TARGET"}

393```

394

395The Linux OOM killer terminated the process because the system ran out of memory. Claude Code requires at least 4 GB of available RAM.

396

397**Solutions:**

398

3991. **Add swap space** if your server has limited RAM. Swap uses disk space as overflow memory, letting the install complete even with low physical RAM.

400

401 Create a 2 GB swap file and enable it:

402

403 ```bash theme={null}

404 sudo fallocate -l 2G /swapfile

405 sudo chmod 600 /swapfile

406 sudo mkswap /swapfile

407 sudo swapon /swapfile

408 ```

409

410 Then retry the installation:

411

412 ```bash theme={null}

413 curl -fsSL https://claude.ai/install.sh | bash

414 ```

415

4162. **Close other processes** to free memory before installing.

417

4183. **Use a larger instance** if possible. Claude Code requires at least 4 GB of RAM.

419

420### Install hangs in Docker

421

422When installing Claude Code in a Docker container, installing as root into `/` can cause hangs.

423

424**Solutions:**

425

4261. **Set a working directory** before running the installer. When run from `/`, the installer scans the entire filesystem, which causes excessive memory usage. Setting `WORKDIR` limits the scan to a small directory:

427 ```dockerfile theme={null}

428 WORKDIR /tmp

429 RUN curl -fsSL https://claude.ai/install.sh | bash

430 ```

431

4322. **Increase Docker memory limits** if using Docker Desktop:

433 ```bash theme={null}

434 docker build --memory=4g .

435 ```

436

437### Windows: Claude Desktop overrides `claude` CLI command

438

439If you installed an older version of Claude Desktop, it may register a `Claude.exe` in the `WindowsApps` directory that takes PATH priority over Claude Code CLI. Running `claude` opens the Desktop app instead of the CLI.

440

441Update Claude Desktop to the latest version to fix this issue.

442

443### Windows: "Claude Code on Windows requires git-bash"

444

445Claude Code on native Windows needs [Git for Windows](https://git-scm.com/downloads/win), which includes Git Bash.

446

447**If Git is not installed**, download and install it from [git-scm.com/downloads/win](https://git-scm.com/downloads/win). During setup, select "Add to PATH." Restart your terminal after installing.

448

449**If Git is already installed** but Claude Code still can't find it, set the path in your [settings.json file](/en/settings):

450

451```json theme={null}

452{

453 "env": {

454 "CLAUDE_CODE_GIT_BASH_PATH": "C:\\Program Files\\Git\\bin\\bash.exe"

455 }

456}

457```

458

459If your Git is installed somewhere else, find the path by running `where.exe git` in PowerShell and use the `bin\bash.exe` path from that directory.

460

461### Linux: wrong binary variant installed (musl/glibc mismatch)

462

463If you see errors about missing shared libraries like `libstdc++.so.6` or `libgcc_s.so.1` after installation, the installer may have downloaded the wrong binary variant for your system.

464

465```text theme={null}

466Error loading shared library libstdc++.so.6: No such file or directory

467```

468

469This can happen on glibc-based systems that have musl cross-compilation packages installed, causing the installer to misdetect the system as musl.

470

471**Solutions:**

472

4731. **Check which libc your system uses**:

474 ```bash theme={null}

475 ldd /bin/ls | head -1

476 ```

477 If it shows `linux-vdso.so` or references to `/lib/x86_64-linux-gnu/`, you're on glibc. If it shows `musl`, you're on musl.

478

4792. **If you're on glibc but got the musl binary**, remove the installation and reinstall. You can also manually download the correct binary from the GCS bucket at `https://storage.googleapis.com/claude-code-dist-86c565f3-f756-42ad-8dfa-d59b1c096819/claude-code-releases/{VERSION}/manifest.json`. File a [GitHub issue](https://github.com/anthropics/claude-code/issues) with the output of `ldd /bin/ls` and `ls /lib/libc.musl*`.

480

4813. **If you're actually on musl** (Alpine Linux), install the required packages:

482 ```bash theme={null}

483 apk add libgcc libstdc++ ripgrep

484 ```

485

486### `Illegal instruction` on Linux

487

488If the installer prints `Illegal instruction` instead of the OOM `Killed` message, the downloaded binary doesn't match your CPU architecture. This commonly happens on ARM servers that receive an x86 binary, or on older CPUs that lack required instruction sets.

489

490```text theme={null}

491bash: line 142: 2238232 Illegal instruction "$binary_path" install ${TARGET:+"$TARGET"}

492```

493

494**Solutions:**

495

4961. **Verify your architecture**:

497 ```bash theme={null}

498 uname -m

499 ```

500 `x86_64` means 64-bit Intel/AMD, `aarch64` means ARM64. If the binary doesn't match, [file a GitHub issue](https://github.com/anthropics/claude-code/issues) with the output.

501

5022. **Try an alternative install method** while the architecture issue is resolved:

503 ```bash theme={null}

504 brew install --cask claude-code

505 ```

506

507### `dyld: cannot load` on macOS

508

509If you see `dyld: cannot load` or `Abort trap: 6` during installation, the binary is incompatible with your macOS version or hardware.

510

511```text theme={null}

512dyld: cannot load 'claude-2.1.42-darwin-x64' (load command 0x80000034 is unknown)

513Abort trap: 6

514```

515

516**Solutions:**

517

5181. **Check your macOS version**: Claude Code requires macOS 13.0 or later. Open the Apple menu and select About This Mac to check your version.

519

5202. **Update macOS** if you're on an older version. The binary uses load commands that older macOS versions don't support.

521

5223. **Try Homebrew** as an alternative install method:

523 ```bash theme={null}

524 brew install --cask claude-code

525 ```

526

7### Windows installation issues: errors in WSL527### Windows installation issues: errors in WSL

8 528

9You might encounter the following issues in WSL:529You might encounter the following issues in WSL:

10 530

~~11**OS/platform detection issues**: If you receive an error during installation, WSL may be using Windows `npm`. Try:~~531**OS/platform detection issues**: if you receive an error during installation, WSL may be using Windows `npm`. Try:

12 532

13* Run `npm config set os linux` before installation533* Run `npm config set os linux` before installation

~~14* Install with `npm install -g @anthropic-ai/claude-code --force --no-os-check` (Do NOT use `sudo`)~~534* Install with `npm install -g @anthropic-ai/claude-code --force --no-os-check`. Do not use `sudo`.

15 535

16**Node not found errors**: If you see `exec: node: not found` when running `claude`, your WSL environment may be using a Windows installation of Node.js. You can confirm this with `which npm` and `which node`, which should point to Linux paths starting with `/usr/` rather than `/mnt/c/`. To fix this, try installing Node via your Linux distribution's package manager or via [`nvm`](https://github.com/nvm-sh/nvm).536**Node not found errors**: if you see `exec: node: not found` when running `claude`, your WSL environment may be using a Windows installation of Node.js. You can confirm this with `which npm` and `which node`, which should point to Linux paths starting with `/usr/` rather than `/mnt/c/`. To fix this, try installing Node via your Linux distribution's package manager or via [`nvm`](https://github.com/nvm-sh/nvm).

17 537

18**nvm version conflicts**: If you have nvm installed in both WSL and Windows, you may experience version conflicts when switching Node versions in WSL. This happens because WSL imports the Windows PATH by default, causing Windows nvm/npm to take priority over the WSL installation.538**nvm version conflicts**: if you have nvm installed in both WSL and Windows, you may experience version conflicts when switching Node versions in WSL. This happens because WSL imports the Windows PATH by default, causing Windows nvm/npm to take priority over the WSL installation.

19 539

20You can identify this issue by:540You can identify this issue by:

21 541

50```570```

51 571

52<Warning>572<Warning>

53 Avoid disabling Windows PATH importing (`appendWindowsPath = false`) as this breaks the ability to easily call Windows executables from WSL. Similarly, avoid uninstalling Node.js from Windows if you use it for Windows development.573 Avoid disabling Windows PATH importing via `appendWindowsPath = false` as this breaks the ability to call Windows executables from WSL. Similarly, avoid uninstalling Node.js from Windows if you use it for Windows development.

54</Warning>574</Warning>

55 575

~~56### Linux and Mac installation issues: permission or command not found errors~~576### WSL2 sandbox setup

577

578[Sandboxing](/en/sandboxing) is supported on WSL2 but requires installing additional packages. If you see an error like "Sandbox requires socat and bubblewrap" when running `/sandbox`, install the dependencies:

57 579

~~58When installing Claude Code with npm, `PATH` problems may prevent access to `claude`.~~580<Tabs>

~~59You may also encounter permission errors if your npm global prefix is not user writable (eg. `/usr`, or `/usr/local`).~~581 <Tab title="Ubuntu/Debian">

582 ```bash theme={null}

583 sudo apt-get install bubblewrap socat

584 ```

585 </Tab>

60 586

~~61#### Recommended solution: Native Claude Code installation~~587 <Tab title="Fedora">

588 ```bash theme={null}

589 sudo dnf install bubblewrap socat

590 ```

591 </Tab>

592</Tabs>

62 593

~~63Claude Code has a native installation that doesn't depend on npm or Node.js.~~594WSL1 does not support sandboxing. If you see "Sandboxing requires WSL2", you need to upgrade to WSL2 or run Claude Code without sandboxing.

64 595

~~65<Note>~~596### Permission errors during installation

~~66 The native Claude Code installer is currently in beta.~~

~~67</Note>~~

68 597

~~69Use the following command to run the native installer.~~598If the native installer fails with permission errors, the target directory may not be writable. See [Check directory permissions](#check-directory-permissions).

70 599

~~71**macOS, Linux, WSL:**~~600If you previously installed with npm and are hitting npm-specific permission errors, switch to the native installer:

72 601

73```bash theme={null}602```bash theme={null}

~~74# Install stable version (default)~~

75curl -fsSL https://claude.ai/install.sh | bash603curl -fsSL https://claude.ai/install.sh | bash

604```

76 605

~~77# Install latest version~~606## Permissions and authentication

~~78curl -fsSL https://claude.ai/install.sh | bash -s latest~~

79 607

~~80# Install specific version number~~608These sections address login failures, token issues, and permission prompt behavior.

~~81curl -fsSL https://claude.ai/install.sh | bash -s 1.0.58~~

~~82```~~

83 609

~~84**Windows PowerShell:**~~610### Repeated permission prompts

85 611

~~86```powershell theme={null}~~612If you find yourself repeatedly approving the same commands, you can allow specific tools

~~87# Install stable version (default)~~613to run without approval using the `/permissions` command. See [Permissions docs](/en/permissions#manage-permissions).

~~88irm https://claude.ai/install.ps1 | iex~~

89 614

~~90# Install latest version~~615### Authentication issues

~~91& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) latest~~

92 616

~~93# Install specific version number~~617If you're experiencing authentication problems:

~~94& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) 1.0.58~~

95 618

~~96```~~6191. Run `/logout` to sign out completely

6202. Close Claude Code

6213. Restart with `claude` and complete the authentication process again

97 622

~~98This command installs the appropriate build of Claude Code for your operating system and architecture and adds a symlink to the installation at `~/.local/bin/claude`.~~623If the browser doesn't open automatically during login, press `c` to copy the OAuth URL to your clipboard, then paste it into your browser manually.

99 624

100<Tip>625### OAuth error: Invalid code

101 Make sure that you have the installation directory in your system PATH.626

102</Tip>627If you see `OAuth error: Invalid code. Please make sure the full code was copied`, the login code expired or was truncated during copy-paste.

103 628

104#### Alternative solution: Migrate to local installation629**Solutions:**

105 630

106Alternatively, if Claude Code will run, you can migrate to a local installation:631* Press Enter to retry and complete the login quickly after the browser opens

632* Type `c` to copy the full URL if the browser doesn't open automatically

633* If using a remote/SSH session, the browser may open on the wrong machine. Copy the URL displayed in the terminal and open it in your local browser instead.

107 634

108```bash theme={null}635### 403 Forbidden after login

109claude migrate-installer636

110```637If you see `API Error: 403 {"error":{"type":"forbidden","message":"Request not allowed"}}` after logging in:

638

639* **Claude Pro/Max users**: verify your subscription is active at [claude.ai/settings](https://claude.ai/settings)

640* **Console users**: confirm your account has the "Claude Code" or "Developer" role assigned by your admin

641* **Behind a proxy**: corporate proxies can interfere with API requests. See [network configuration](/en/network-config) for proxy setup.

111 642

112This moves Claude Code to `~/.claude/local/` and sets up an alias in your shell configuration. No `sudo` is required for future updates.643### "This organization has been disabled" with an active subscription

113 644

114After migration, restart your shell, and then verify your installation:645If you see `API Error: 400 ... "This organization has been disabled"` despite having an active Claude subscription, an `ANTHROPIC_API_KEY` environment variable is overriding your subscription. This commonly happens when an old API key from a previous employer or project is still set in your shell profile.

115 646

116On macOS/Linux/WSL:647When `ANTHROPIC_API_KEY` is present and you have approved it, Claude Code uses that key instead of your subscription's OAuth credentials. In non-interactive mode (`-p`), the key is always used when present. See [authentication precedence](/en/authentication#authentication-precedence) for the full resolution order.

648

649To use your subscription instead, unset the environment variable and remove it from your shell profile:

117 650

118```bash theme={null}651```bash theme={null}

119which claude # Should show an alias to ~/.claude/local/claude652unset ANTHROPIC_API_KEY

653claude

120```654```

121 655

122On Windows:656Check `~/.zshrc`, `~/.bashrc`, or `~/.profile` for `export ANTHROPIC_API_KEY=...` lines and remove them to make the change permanent. Run `/status` inside Claude Code to confirm which authentication method is active.

123 657

124```powershell theme={null}658### OAuth login fails in WSL2

125where claude # Should show path to claude executable

126```

127 659

128Verify installation:660Browser-based login in WSL2 may fail if WSL can't open your Windows browser. Set the `BROWSER` environment variable:

129 661

130```bash theme={null}662```bash theme={null}

131claude doctor # Check installation health663export BROWSER="/mnt/c/Program Files/Google/Chrome/Application/chrome.exe"

664claude

132```665```

133 666

134## Permissions and authentication667Or copy the URL manually: when the login prompt appears, press `c` to copy the OAuth URL, then paste it into your Windows browser.

135 668

136### Repeated permission prompts669### "Not logged in" or token expired

137 670

138If you find yourself repeatedly approving the same commands, you can allow specific tools671If Claude Code prompts you to log in again after a session, your OAuth token may have expired.

139to run without approval using the `/permissions` command. See [Permissions docs](/en/iam#configuring-permissions).

140 672

141### Authentication issues673Run `/login` to re-authenticate. If this happens frequently, check that your system clock is accurate, as token validation depends on correct timestamps.

142 674

143If you're experiencing authentication problems:675## Configuration file locations

144 676

1451. Run `/logout` to sign out completely677Claude Code stores configuration in several locations:

1462. Close Claude Code678

1473. Restart with `claude` and complete the authentication process again679| File | Purpose |

680| :---------------------------- | :----------------------------------------------------------------------------------------------------- |

681| `~/.claude/settings.json` | User settings (permissions, hooks, model overrides) |

682| `.claude/settings.json` | Project settings (checked into source control) |

683| `.claude/settings.local.json` | Local project settings (not committed) |

684| `~/.claude.json` | Global state (theme, OAuth, MCP servers) |

685| `.mcp.json` | Project MCP servers (checked into source control) |

686| `managed-mcp.json` | [Managed MCP servers](/en/mcp#managed-mcp-configuration) |

687| Managed settings | [Managed settings](/en/settings#settings-files) (server-managed, MDM/OS-level policies, or file-based) |

688

689On Windows, `~` refers to your user home directory, such as `C:\Users\YourName`.

690

691For details on configuring these files, see [Settings](/en/settings) and [MCP](/en/mcp).

148 692

149If problems persist, try:693### Resetting configuration

694

695To reset Claude Code to default settings, you can remove the configuration files:

150 696

151```bash theme={null}697```bash theme={null}

152rm -rf ~/.config/claude-code/auth.json698# Reset all user settings and state

153claude699rm ~/.claude.json

700rm -rf ~/.claude/

701

702# Reset project-specific settings

703rm -rf .claude/

704rm .mcp.json

154```705```

155 706

156This removes your stored authentication information and forces a clean login.707<Warning>

708 This will remove all your settings, MCP server configurations, and session history.

709</Warning>

157 710

158## Performance and stability711## Performance and stability

159 712

713These sections cover issues related to resource usage, responsiveness, and search behavior.

714

160### High CPU or memory usage715### High CPU or memory usage

161 716

162Claude Code is designed to work with most development environments, but may consume significant resources when processing large codebases. If you're experiencing performance issues:717Claude Code is designed to work with most development environments, but may consume significant resources when processing large codebases. If you're experiencing performance issues:

174 729

175### Search and discovery issues730### Search and discovery issues

176 731

177If Search tool, `@file` mentions, custom agents, and custom slash commands aren't working, install system `ripgrep`:732If Search tool, `@file` mentions, custom agents, and custom skills aren't working, install system `ripgrep`:

178 733

179```bash theme={null}734```bash theme={null}

180# macOS (Homebrew) 735# macOS (Homebrew)

193pacman -S ripgrep748pacman -S ripgrep

194```749```

195 750

196Then set `USE_BUILTIN_RIPGREP=0` in your [environment](/en/settings#environment-variables).751Then set `USE_BUILTIN_RIPGREP=0` in your [environment](/en/env-vars).

197 752

198### Slow or incomplete search results on WSL753### Slow or incomplete search results on WSL

199 754

200Disk read performance penalties when [working across file systems on WSL](https://learn.microsoft.com/en-us/windows/wsl/filesystems) may result in fewer-than-expected matches (but not a complete lack of search functionality) when using Claude Code on WSL.755Disk read performance penalties when [working across file systems on WSL](https://learn.microsoft.com/en-us/windows/wsl/filesystems) may result in fewer-than-expected matches when using Claude Code on WSL. Search still functions, but returns fewer results than on a native filesystem.

201 756

202<Note>757<Note>

203 `/doctor` will show Search as OK in this case.758 `/doctor` will show Search as OK in this case.

205 760

206**Solutions:**761**Solutions:**

207 762

2081. **Submit more specific searches**: Reduce the number of files searched by specifying directories or file types: "Search for JWT validation logic in the auth-service package" or "Find use of md5 hash in JS files".7631. **Submit more specific searches**: reduce the number of files searched by specifying directories or file types: "Search for JWT validation logic in the auth-service package" or "Find use of md5 hash in JS files".

209 764

2102. **Move project to Linux filesystem**: If possible, ensure your project is located on the Linux filesystem (`/home/`) rather than the Windows filesystem (`/mnt/c/`).7652. **Move project to Linux filesystem**: if possible, ensure your project is located on the Linux filesystem (`/home/`) rather than the Windows filesystem (`/mnt/c/`).

211 766

2123. **Use native Windows instead**: Consider running Claude Code natively on Windows instead of through WSL, for better file system performance.7673. **Use native Windows instead**: consider running Claude Code natively on Windows instead of through WSL, for better file system performance.

213 768

214## IDE integration issues769## IDE integration issues

215 770

771If Claude Code does not connect to your IDE or behaves unexpectedly within an IDE terminal, try the solutions below.

772

216### JetBrains IDE not detected on WSL2773### JetBrains IDE not detected on WSL2

217 774

218If you're using Claude Code on WSL2 with JetBrains IDEs and getting "No available IDEs detected" errors, this is likely due to WSL2's networking configuration or Windows Firewall blocking the connection.775If you're using Claude Code on WSL2 with JetBrains IDEs and getting "No available IDEs detected" errors, this is likely due to WSL2's networking configuration or Windows Firewall blocking the connection.

2261. Find your WSL2 IP address:7831. Find your WSL2 IP address:

227 ```bash theme={null}784 ```bash theme={null}

228 wsl hostname -I785 wsl hostname -I

229 # Example output: 172.21.123.456786 # Example output: 172.21.123.45

230 ```787 ```

231 788

2322. Open PowerShell as Administrator and create a firewall rule:7892. Open PowerShell as Administrator and create a firewall rule:

233 ```powershell theme={null}790 ```powershell theme={null}

234 New-NetFirewallRule -DisplayName "Allow WSL2 Internal Traffic" -Direction Inbound -Protocol TCP -Action Allow -RemoteAddress 172.21.0.0/16 -LocalAddress 172.21.0.0/16791 New-NetFirewallRule -DisplayName "Allow WSL2 Internal Traffic" -Direction Inbound -Protocol TCP -Action Allow -RemoteAddress 172.21.0.0/16 -LocalAddress 172.21.0.0/16

235 ```792 ```

236 (Adjust the IP range based on your WSL2 subnet from step 1)793 Adjust the IP range based on your WSL2 subnet from step 1.

237 794

2383. Restart both your IDE and Claude Code7953. Restart both your IDE and Claude Code

239 796

252 These networking issues only affect WSL2. WSL1 uses the host's network directly and doesn't require these configurations.809 These networking issues only affect WSL2. WSL1 uses the host's network directly and doesn't require these configurations.

253</Note>810</Note>

254 811

255For additional JetBrains configuration tips, see our [IDE integration guide](/en/vs-code#jetbrains-plugin-settings).812For additional JetBrains configuration tips, see the [JetBrains IDE guide](/en/jetbrains#plugin-settings).

813

814### Report Windows IDE integration issues

256 815

257### Reporting Windows IDE integration issues (both native and WSL)816If you're experiencing IDE integration problems on Windows, [create an issue](https://github.com/anthropics/claude-code/issues) with the following information:

258 817

259If you're experiencing IDE integration problems on Windows, please [create an issue](https://github.com/anthropics/claude-code/issues) with the following information: whether you are native (git bash), or WSL1/WSL2, WSL networking mode (NAT or mirrored), IDE name/version, Claude Code extension/plugin version, and shell type (bash/zsh/etc)818* Environment type: native Windows (Git Bash) or WSL1/WSL2

819* WSL networking mode, if applicable: NAT or mirrored

820* IDE name and version

821* Claude Code extension/plugin version

822* Shell type: Bash, Zsh, PowerShell, etc.

260 823

261### ESC key not working in JetBrains (IntelliJ, PyCharm, etc.) terminals824### Escape key not working in JetBrains IDE terminals

262 825

263If you're using Claude Code in JetBrains terminals and the ESC key doesn't interrupt the agent as expected, this is likely due to a keybinding clash with JetBrains' default shortcuts.826If you're using Claude Code in JetBrains terminals and the `Esc` key doesn't interrupt the agent as expected, this is likely due to a keybinding clash with JetBrains' default shortcuts.

264 827

265To fix this issue:828To fix this issue:

266 829

270 * Click "Configure terminal keybindings" and delete the "Switch focus to Editor" shortcut833 * Click "Configure terminal keybindings" and delete the "Switch focus to Editor" shortcut

2713. Apply the changes8343. Apply the changes

272 835

273This allows the ESC key to properly interrupt Claude Code operations.836This allows the `Esc` key to properly interrupt Claude Code operations.

274 837

275## Markdown formatting issues838## Markdown formatting issues

276 839

285function example() {848function example() {

286 return "hello";849 return "hello";

287}850}

288```851```text

289````852````

290 853

291Instead of properly tagged blocks like:854Instead of properly tagged blocks like:

295function example() {858function example() {

296 return "hello";859 return "hello";

297}860}

298```861```text

299````862````

300 863

301**Solutions:**864**Solutions:**

302 865

3031. **Ask Claude to add language tags**: Simply request "Please add appropriate language tags to all code blocks in this markdown file."8661. **Ask Claude to add language tags**: request "Add appropriate language tags to all code blocks in this markdown file."

304 867

3052. **Use post-processing hooks**: Set up automatic formatting hooks to detect and add missing language tags. See the [markdown formatting hook example](/en/hooks-guide#markdown-formatting-hook) for implementation details.8682. **Use post-processing hooks**: set up automatic formatting hooks to detect and add missing language tags. See [Auto-format code after edits](/en/hooks-guide#auto-format-code-after-edits) for an example of a PostToolUse formatting hook.

306 869

3073. **Manual verification**: After generating markdown files, review them for proper code block formatting and request corrections if needed.8703. **Manual verification**: after generating markdown files, review them for proper code block formatting and request corrections if needed.

308 871

309### Inconsistent spacing and formatting872### Inconsistent spacing and formatting

310 873

312 875

313**Solutions:**876**Solutions:**

314 877

3151. **Request formatting corrections**: Ask Claude to "Fix spacing and formatting issues in this markdown file."8781. **Request formatting corrections**: ask Claude to "Fix spacing and formatting issues in this markdown file."

316 879

3172. **Use formatting tools**: Set up hooks to run markdown formatters like `prettier` or custom formatting scripts on generated markdown files.8802. **Use formatting tools**: set up hooks to run markdown formatters like `prettier` or custom formatting scripts on generated markdown files.

318 881

3193. **Specify formatting preferences**: Include formatting requirements in your prompts or project [memory](/en/memory) files.8823. **Specify formatting preferences**: include formatting requirements in your prompts or project [memory](/en/memory) files.

320 883

321### Best practices for markdown generation884### Reduce markdown formatting issues

322 885

323To minimize formatting issues:886To minimize formatting issues:

324 887

325* **Be explicit in requests**: Ask for "properly formatted markdown with language-tagged code blocks"888* **Be explicit in requests**: ask for "properly formatted markdown with language-tagged code blocks"

326* **Use project conventions**: Document your preferred markdown style in [CLAUDE.md](/en/memory)889* **Use project conventions**: document your preferred markdown style in [`CLAUDE.md`](/en/memory)

327* **Set up validation hooks**: Use post-processing hooks to automatically verify and fix common formatting issues890* **Set up validation hooks**: use post-processing hooks to automatically verify and fix common formatting issues

328 891

329## Getting more help892## Get more help

330 893

331If you're experiencing issues not covered here:894If you're experiencing issues not covered here:

332 895

3331. Use the `/bug` command within Claude Code to report problems directly to Anthropic8961. Use the `/feedback` command within Claude Code to report problems directly to Anthropic

3342. Check the [GitHub repository](https://github.com/anthropics/claude-code) for known issues8972. Check the [GitHub repository](https://github.com/anthropics/claude-code) for known issues

3353. Run `/doctor` to check the health of your Claude Code installation8983. Run `/doctor` to diagnose issues. It checks:

899 * Installation type, version, and search functionality

900 * Auto-update status and available versions

901 * Invalid settings files (malformed JSON, incorrect types)

902 * MCP server configuration errors

903 * Keybinding configuration problems

904 * Context usage warnings (large CLAUDE.md files, high MCP token usage, unreachable permission rules)

905 * Plugin and agent loading errors

3364. Ask Claude directly about its capabilities and features - Claude has built-in access to its documentation9064. Ask Claude directly about its capabilities and features - Claude has built-in access to its documentation

voice-dictation.md +138 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Voice dictation

7> Use push-to-talk voice dictation to speak your prompts instead of typing them in the Claude Code CLI.

9Hold a key and speak to dictate your prompts. Your speech is transcribed live into the prompt input, so you can mix voice and typing in the same message. Enable dictation with `/voice`. The default push-to-talk key is `Space`; [rebind to a modifier combination](#rebind-the-push-to-talk-key) to activate on the first keypress rather than after a brief hold.

11<Note>

12 Voice dictation requires Claude Code v2.1.69 or later. Check your version with `claude --version`.

13</Note>

15## Requirements

17Voice dictation uses a streaming speech-to-text service that is only available when you authenticate with a Claude.ai account. It is not available when Claude Code is configured to use an Anthropic API key directly, Amazon Bedrock, Google Vertex AI, or Microsoft Foundry.

19Voice dictation also needs local microphone access, so it does not work in remote environments such as [Claude Code on the web](/en/claude-code-on-the-web) or SSH sessions. In WSL, voice dictation requires WSLg for audio access, which is included with WSL2 on Windows 11. On Windows 10 or WSL1, run Claude Code in native Windows instead.

21Audio recording uses a built-in native module on macOS, Linux, and Windows. On Linux, if the native module cannot load, Claude Code falls back to `arecord` from ALSA utils or `rec` from SoX. If neither is available, `/voice` prints an install command for your package manager.

23## Enable voice dictation

25Run `/voice` to toggle voice dictation on. The first time you enable it, Claude Code runs a microphone check. On macOS, this triggers the system microphone permission prompt for your terminal if it has never been granted.

27```

28/voice

29Voice mode enabled. Hold Space to record. Dictation language: en (/config to change).

30```

32Voice dictation persists across sessions. Run `/voice` again to turn it off, or set it directly in your [user settings file](/en/settings):

34```json theme={null}

35{

36 "voiceEnabled": true

37}

38```

40While voice dictation is enabled, the input footer shows a `hold Space to speak` hint when the prompt is empty. The hint does not appear if you have a [custom status line](/en/statusline) configured.

42## Record a prompt

44Hold `Space` to start recording. Claude Code detects a held key by watching for rapid key-repeat events from your terminal, so there is a brief warmup before recording begins. The footer shows `keep holding…` during warmup, then switches to a live waveform once recording is active.

46The first couple of key-repeat characters type into the input during warmup and are removed automatically when recording activates. A single `Space` tap still types a space, since hold detection only triggers on rapid repeat.

48<Tip>

49 To skip the warmup, [rebind to a modifier combination](#rebind-the-push-to-talk-key) like `meta+k`. Modifier combos start recording on the first keypress.

50</Tip>

52Your speech appears in the prompt as you speak, dimmed until the transcript is finalized. Release `Space` to stop recording and finalize the text. The transcript is inserted at your cursor position and the cursor stays at the end of the inserted text, so you can mix typing and dictation in any order. Hold `Space` again to append another recording, or move the cursor first to insert speech elsewhere in the prompt:

54```

55> refactor the auth middleware to ▮

56 # hold Space, speak "use the new token validation helper"

57> refactor the auth middleware to use the new token validation helper▮

58```

60Transcription is tuned for coding vocabulary. Common development terms like `regex`, `OAuth`, `JSON`, and `localhost` are recognized correctly, and your current project name and git branch name are added as recognition hints automatically.

62## Change the dictation language

64Voice dictation uses the same [`language` setting](/en/settings) that controls Claude's response language. If that setting is empty, dictation defaults to English.

66<Accordion title="Supported dictation languages">

67 | Language | Code |

68 | :--------- | :--- |

69 | Czech | `cs` |

70 | Danish | `da` |

71 | Dutch | `nl` |

72 | English | `en` |

73 | French | `fr` |

74 | German | `de` |

75 | Greek | `el` |

76 | Hindi | `hi` |

77 | Indonesian | `id` |

78 | Italian | `it` |

79 | Japanese | `ja` |

80 | Korean | `ko` |

81 | Norwegian | `no` |

82 | Polish | `pl` |

83 | Portuguese | `pt` |

84 | Russian | `ru` |

85 | Spanish | `es` |

86 | Swedish | `sv` |

87 | Turkish | `tr` |

88 | Ukrainian | `uk` |

89</Accordion>

91Set the language in `/config` or directly in settings. You can use either the [BCP 47 language code](https://en.wikipedia.org/wiki/IETF_language_tag) or the language name:

93```json theme={null}

94{

95 "language": "japanese"

96}

97```

99If your `language` setting is not in the supported list, `/voice` warns you on enable and falls back to English for dictation. Claude's text responses are not affected by this fallback.

100

101## Rebind the push-to-talk key

102

103The push-to-talk key is bound to `voice:pushToTalk` in the `Chat` context and defaults to `Space`. Rebind it in [`~/.claude/keybindings.json`](/en/keybindings):

104

105```json theme={null}

106{

107 "bindings": [

108 {

109 "context": "Chat",

110 "bindings": {

111 "meta+k": "voice:pushToTalk",

112 "space": null

113 }

114 }

115 ]

116}

117```

118

119Setting `"space": null` removes the default binding. Omit it if you want both keys active.

120

121Because hold detection relies on key-repeat, avoid binding a bare letter key like `v` since it types into the prompt during warmup. Use `Space`, or use a modifier combination like `meta+k` to start recording on the first keypress with no warmup. See [customize keyboard shortcuts](/en/keybindings) for the full keybinding syntax.

122

123## Troubleshooting

124

125Common issues when voice dictation does not activate or record:

126

127* **`Voice mode requires a Claude.ai account`**: you are authenticated with an API key or a third-party provider. Run `/login` to sign in with a Claude.ai account.

128* **`Microphone access is denied`**: grant microphone permission to your terminal in system settings. On macOS, go to System Settings → Privacy & Security → Microphone. On Windows, go to Settings → Privacy → Microphone. Then run `/voice` again.

129* **`No audio recording tool found` on Linux**: the native audio module could not load and no fallback is installed. Install SoX with the command shown in the error message, for example `sudo apt-get install sox`.

130* **Nothing happens when holding `Space`**: watch the prompt input while you hold. If spaces keep accumulating, voice dictation is off; run `/voice` to enable it. If only one or two spaces appear and then nothing, voice dictation is on but hold detection is not triggering. Hold detection requires your terminal to send key-repeat events, so it cannot detect a held key if key-repeat is disabled at the OS level.

131* **Transcription is garbled or in the wrong language**: dictation defaults to English. If you are dictating in another language, set it in `/config` first. See [Change the dictation language](#change-the-dictation-language).

132

133## See also

134

135* [Customize keyboard shortcuts](/en/keybindings): rebind `voice:pushToTalk` and other CLI keyboard actions

136* [Configure settings](/en/settings): full reference for `voiceEnabled`, `language`, and other settings keys

137* [Interactive mode](/en/interactive-mode): keyboard shortcuts, input modes, and session controls

138* [Built-in commands](/en/commands): reference for `/voice`, `/config`, and all other commands

vs-code.md +404 −91

Details

~~1# Visual Studio Code~~1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

2 4

~~3> Use Claude Code with Visual Studio Code through our native extension or CLI integration~~5# Use Claude Code in VS Code

4 6

5<img src="https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=300652d5678c63905e6b0ea9e50835f8" alt="Claude Code VS Code Extension Interface" data-og-width="2500" width="2500" data-og-height="1155" height="1155" data-path="images/vs-code-extension-interface.jpg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?w=280&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=87630c671517a3d52e9aee627041696e 280w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?w=560&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=716b093879204beec8d952649ef75292 560w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?w=840&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=c1525d1a01513acd9d83d8b5a8fe2fc8 840w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?w=1100&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=1d90021d58bbb51f871efec13af955c3 1100w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?w=1650&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=7babdd25440099886f193cfa99af88ae 1650w, https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?w=2500&fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=08c92eedfb56fe61a61e480fb63784b6 2500w" />7> Install and configure the Claude Code extension for VS Code. Get AI coding assistance with inline diffs, @-mentions, plan review, and keyboard shortcuts.

6 8

~~7## VS Code Extension (Beta)~~9<img src="https://mintcdn.com/claude-code/-YhHHmtSxwr7W8gy/images/vs-code-extension-interface.jpg?fit=max&auto=format&n=-YhHHmtSxwr7W8gy&q=85&s=300652d5678c63905e6b0ea9e50835f8" alt="VS Code editor with the Claude Code extension panel open on the right side, showing a conversation with Claude" width="2500" height="1155" data-path="images/vs-code-extension-interface.jpg" />

8 10

9The VS Code extension, available in beta, lets you see Claude's changes in real-time through a native graphical interface integrated directly into your IDE. The VS Code extension makes it easier to access and interact with Claude Code for users who prefer a visual interface over the terminal.11The VS Code extension provides a native graphical interface for Claude Code, integrated directly into your IDE. This is the recommended way to use Claude Code in VS Code.

10 12

~~11### Features~~13With the extension, you can review and edit Claude's plans before accepting them, auto-accept edits as they're made, @-mention files with specific line ranges from your selection, access conversation history, and open multiple conversations in separate tabs or windows.

12 14

~~13The VS Code extension provides:~~15## Prerequisites

14 16

~~15* **Native IDE experience**: Dedicated Claude Code sidebar panel accessed via the Spark icon~~17Before installing, make sure you have:

~~16* **Plan mode with editing**: Review and edit Claude's plans before accepting them~~

~~17* **Auto-accept edits mode**: Automatically apply Claude's changes as they're made~~

~~18* **Extended thinking**: Toggle extended thinking on/off using the Extended Thinking button in the bottom-right corner of the prompt input~~

~~19* **File management**: @-mention files or attach files and images using the system file picker~~

~~20* **MCP server usage**: Use Model Context Protocol servers configured through the CLI~~

~~21* **Conversation history**: Easy access to past conversations~~

~~22* **Multiple sessions**: Run multiple Claude Code sessions simultaneously~~

~~23* **Keyboard shortcuts**: Support for most shortcuts from the CLI~~

~~24* **Slash commands**: Access most CLI slash commands directly in the extension~~

~~26### Requirements~~

27 18

28* VS Code 1.98.0 or higher19* VS Code 1.98.0 or higher

20* An Anthropic account (you'll sign in when you first open the extension). If you're using a third-party provider like Amazon Bedrock or Google Vertex AI, see [Use third-party providers](#use-third-party-providers) instead.

22<Tip>

23 The extension includes the CLI (command-line interface), which you can access from VS Code's integrated terminal for advanced features. See [VS Code extension vs. Claude Code CLI](#vs-code-extension-vs-claude-code-cli) for details.

24</Tip>

26## Install the extension

28Click the link for your IDE to install directly:

29 29

~~30### Installation~~30* [Install for VS Code](vscode:extension/anthropic.claude-code)

31* [Install for Cursor](cursor:extension/anthropic.claude-code)

31 32

~~32Download and install the extension from the [Visual Studio Code Extension Marketplace](https://marketplace.visualstudio.com/items?itemName=anthropic.claude-code).~~33Or in VS Code, press `Cmd+Shift+X` (Mac) or `Ctrl+Shift+X` (Windows/Linux) to open the Extensions view, search for "Claude Code", and click **Install**.

33 34

~~34### How It Works~~35<Note>If the extension doesn't appear after installation, restart VS Code or run "Developer: Reload Window" from the Command Palette.</Note>

37## Get started

35 38

36Once installed, you can start using Claude Code through the VS Code interface:39Once installed, you can start using Claude Code through the VS Code interface:

37 40

~~381. Click the Spark icon in your editor's sidebar to open the Claude Code panel~~41<Steps>

~~392. Prompt Claude Code in the same way you would in the terminal~~42 <Step title="Open the Claude Code panel">

~~403. Watch as Claude analyzes your code and suggests changes~~43 Throughout VS Code, the Spark icon indicates Claude Code: <img src="https://mintcdn.com/claude-code/c5r9_6tjPMzFdDDT/images/vs-code-spark-icon.svg?fit=max&auto=format&n=c5r9_6tjPMzFdDDT&q=85&s=3ca45e00deadec8c8f4b4f807da94505" alt="Spark icon" style={{display: "inline", height: "0.85em", verticalAlign: "middle"}} width="16" height="16" data-path="images/vs-code-spark-icon.svg" />

~~414. Review and accept edits directly in the interface~~44

~~42 * **Tip**: Drag the sidebar wider to see inline diffs, then click on them to expand for full details~~45 The quickest way to open Claude is to click the Spark icon in the **Editor Toolbar** (top-right corner of the editor). The icon only appears when you have a file open.

47 <img src="https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-editor-icon.png?fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=eb4540325d94664c51776dbbfec4cf02" alt="VS Code editor showing the Spark icon in the Editor Toolbar" width="2796" height="734" data-path="images/vs-code-editor-icon.png" />

49 Other ways to open Claude Code:

51 * **Activity Bar**: click the Spark icon in the left sidebar to open the sessions list. Click any session to open it as a full editor tab, or start a new one. This icon is always visible in the Activity Bar.

52 * **Command Palette**: `Cmd+Shift+P` (Mac) or `Ctrl+Shift+P` (Windows/Linux), type "Claude Code", and select an option like "Open in New Tab"

53 * **Status Bar**: click **✱ Claude Code** in the bottom-right corner of the window. This works even when no file is open.

55 When you first open the panel, a **Learn Claude Code** checklist appears. Work through each item by clicking **Show me**, or dismiss it with the X. To reopen it later, uncheck **Hide Onboarding** in VS Code settings under Extensions → Claude Code.

57 You can drag the Claude panel to reposition it anywhere in VS Code. See [Customize your workflow](#customize-your-workflow) for details.

58 </Step>

60 <Step title="Send a prompt">

61 Ask Claude to help with your code or files, whether that's explaining how something works, debugging an issue, or making changes.

63 <Tip>Claude automatically sees your selected text. Press `Option+K` (Mac) / `Alt+K` (Windows/Linux) to also insert an @-mention reference (like `@file.ts#5-10`) into your prompt.</Tip>

65 Here's an example of asking about a particular line in a file:

67 <img src="https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-send-prompt.png?fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=ede3ed8d8d5f940e01c5de636d009cfd" alt="VS Code editor with lines 2-3 selected in a Python file, and the Claude Code panel showing a question about those lines with an @-mention reference" width="3288" height="1876" data-path="images/vs-code-send-prompt.png" />

68 </Step>

70 <Step title="Review changes">

71 When Claude wants to edit a file, it shows a side-by-side comparison of the original and proposed changes, then asks for permission. You can accept, reject, or tell Claude what to do instead.

73 <img src="https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-edits.png?fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=e005f9b41c541c5c7c59c082f7c4841c" alt="VS Code showing a diff of Claude's proposed changes with a permission prompt asking whether to make the edit" width="3292" height="1876" data-path="images/vs-code-edits.png" />

74 </Step>

75</Steps>

77For more ideas on what you can do with Claude Code, see [Common workflows](/en/common-workflows).

79<Tip>

80 Run "Claude Code: Open Walkthrough" from the Command Palette for a guided tour of the basics.

81</Tip>

83## Use the prompt box

85The prompt box supports several features:

87* **Permission modes**: click the mode indicator at the bottom of the prompt box to switch modes. In normal mode, Claude asks permission before each action. In Plan mode, Claude describes what it will do and waits for approval before making changes. VS Code automatically opens the plan as a full markdown document where you can add inline comments to give feedback before Claude begins. In auto-accept mode, Claude makes edits without asking. Set the default in VS Code settings under `claudeCode.initialPermissionMode`.

88* **Command menu**: click `/` or type `/` to open the command menu. Options include attaching files, switching models, toggling extended thinking, viewing plan usage (`/usage`), and starting a [Remote Control](/en/remote-control) session (`/remote-control`). The Customize section provides access to MCP servers, hooks, memory, permissions, and plugins. Items with a terminal icon open in the integrated terminal.

89* **Context indicator**: the prompt box shows how much of Claude's context window you're using. Claude automatically compacts when needed, or you can run `/compact` manually.

90* **Extended thinking**: lets Claude spend more time reasoning through complex problems. Toggle it on via the command menu (`/`). See [Extended thinking](/en/common-workflows#use-extended-thinking-thinking-mode) for details.

91* **Multi-line input**: press `Shift+Enter` to add a new line without sending. This also works in the "Other" free-text input of question dialogs.

93### Reference files and folders

95Use @-mentions to give Claude context about specific files or folders. When you type `@` followed by a file or folder name, Claude reads that content and can answer questions about it or make changes to it. Claude Code supports fuzzy matching, so you can type partial names to find what you need:

97```text theme={null}

98> Explain the logic in @auth (fuzzy matches auth.js, AuthService.ts, etc.)

99> What's in @src/components/ (include a trailing slash for folders)

100```

101

102For large PDFs, you can ask Claude to read specific pages instead of the whole file: a single page, a range like pages 1-10, or an open-ended range like page 3 onward.

103

104When you select text in the editor, Claude can see your highlighted code automatically. The prompt box footer shows how many lines are selected. Press `Option+K` (Mac) / `Alt+K` (Windows/Linux) to insert an @-mention with the file path and line numbers (e.g., `@app.ts#5-10`). Click the selection indicator to toggle whether Claude can see your highlighted text - the eye-slash icon means the selection is hidden from Claude.

105

106You can also hold `Shift` while dragging files into the prompt box to add them as attachments. Click the X on any attachment to remove it from context.

107

108### Resume past conversations

109

110Click the dropdown at the top of the Claude Code panel to access your conversation history. You can search by keyword or browse by time (Today, Yesterday, Last 7 days, etc.). Click any conversation to resume it with the full message history. New sessions receive AI-generated titles based on your first message. Hover over a session to reveal rename and remove actions: rename to give it a descriptive title, or remove to delete it from the list. For more on resuming sessions, see [Common workflows](/en/common-workflows#resume-previous-conversations).

111

112### Resume remote sessions from Claude.ai

113

114If you use [Claude Code on the web](/en/claude-code-on-the-web), you can resume those remote sessions directly in VS Code. This requires signing in with **Claude.ai Subscription**, not Anthropic Console.

115

116<Steps>

117 <Step title="Open Past Conversations">

118 Click the **Past Conversations** dropdown at the top of the Claude Code panel.

119 </Step>

120

121 <Step title="Select the Remote tab">

122 The dialog shows two tabs: Local and Remote. Click **Remote** to see sessions from claude.ai.

123 </Step>

124

125 <Step title="Select a session to resume">

126 Browse or search your remote sessions. Click any session to download it and continue the conversation locally.

127 </Step>

128</Steps>

129

130<Note>

131 Only web sessions started with a GitHub repository appear in the Remote tab. Resuming loads the conversation history locally; changes are not synced back to claude.ai.

132</Note>

133

134## Customize your workflow

135

136Once you're up and running, you can reposition the Claude panel, run multiple sessions, or switch to terminal mode.

137

138### Choose where Claude lives

139

140You can drag the Claude panel to reposition it anywhere in VS Code. Grab the panel's tab or title bar and drag it to:

141

142* **Secondary sidebar**: the right side of the window. Keeps Claude visible while you code.

143* **Primary sidebar**: the left sidebar with icons for Explorer, Search, etc.

144* **Editor area**: opens Claude as a tab alongside your files. Useful for side tasks.

145

146<Tip>

147 Use the sidebar for your main Claude session and open additional tabs for side tasks. Claude remembers your preferred location. The Activity Bar sessions list icon is separate from the Claude panel: the sessions list is always visible in the Activity Bar, while the Claude panel icon only appears there when the panel is docked to the left sidebar.

148</Tip>

149

150### Run multiple conversations

151

152Use **Open in New Tab** or **Open in New Window** from the Command Palette to start additional conversations. Each conversation maintains its own history and context, allowing you to work on different tasks in parallel.

153

154When using tabs, a small colored dot on the spark icon indicates status: blue means a permission request is pending, orange means Claude finished while the tab was hidden.

155

156### Switch to terminal mode

157

158By default, the extension opens a graphical chat panel. If you prefer the CLI-style interface, open the [Use Terminal setting](vscode://settings/claudeCode.useTerminal) and check the box.

159

160You can also open VS Code settings (`Cmd+,` on Mac or `Ctrl+,` on Windows/Linux), go to Extensions → Claude Code, and check **Use Terminal**.

161

162## Manage plugins

163

164The VS Code extension includes a graphical interface for installing and managing [plugins](/en/plugins). Type `/plugins` in the prompt box to open the **Manage plugins** interface.

165

166### Install plugins

167

168The plugin dialog shows two tabs: **Plugins** and **Marketplaces**.

169

170In the Plugins tab:

171

172* **Installed plugins** appear at the top with toggle switches to enable or disable them

173* **Available plugins** from your configured marketplaces appear below

174* Search to filter plugins by name or description

175* Click **Install** on any available plugin

176

177When you install a plugin, choose the installation scope:

178

179* **Install for you**: available in all your projects (user scope)

180* **Install for this project**: shared with project collaborators (project scope)

181* **Install locally**: only for you, only in this repository (local scope)

182

183### Manage marketplaces

184

185Switch to the **Marketplaces** tab to add or remove plugin sources:

186

187* Enter a GitHub repo, URL, or local path to add a new marketplace

188* Click the refresh icon to update a marketplace's plugin list

189* Click the trash icon to remove a marketplace

190

191After making changes, a banner prompts you to restart Claude Code to apply the updates.

192

193<Note>

194 Plugin management in VS Code uses the same CLI commands under the hood. Plugins and marketplaces you configure in the extension are also available in the CLI, and vice versa.

195</Note>

196

197For more about the plugin system, see [Plugins](/en/plugins) and [Plugin marketplaces](/en/plugin-marketplaces).

43 198

~~44### Using Third-Party Providers~~199## Automate browser tasks with Chrome

45 200

46The VS Code extension supports using Claude Code with third-party providers like Amazon Bedrock, Microsoft Foundry, and Google Vertex AI. When configured with these providers, the extension will not prompt for login. To use third-party providers, configure environment variables in the VS Code extension settings:201Connect Claude to your Chrome browser to test web apps, debug with console logs, and automate browser workflows without leaving VS Code. This requires the [Claude in Chrome extension](https://chromewebstore.google.com/detail/claude/fcoeoabgfenejglbffodgkkbkcdhcgfn) version 1.0.36 or higher.

47 202

~~481. Open VS Code settings~~203Type `@browser` in the prompt box followed by what you want Claude to do:

~~492. Search for "Claude Code: Environment Variables"~~

~~503. Add the required environment variables~~

51 204

~~52#### Environment Variables~~205```text theme={null}

206@browser go to localhost:3000 and check the console for errors

207```

53 208

~~55| :---------------------------- | :------------------------------------- | :----------------------------- | :----------------------------------------------- |~~

68 210

~~69For detailed setup instructions and additional configuration options, see:~~211Claude opens new tabs for browser tasks and shares your browser's login state, so it can access any site you're already signed into.

70 212

~~71* [Claude Code on Amazon Bedrock](/en/amazon-bedrock)~~213For setup instructions, the full list of capabilities, and troubleshooting, see [Use Claude Code with Chrome](/en/chrome).

~~72* [Claude Code on Microsoft Foundry](/en/microsoft-foundry)~~

~~73* [Claude Code on Google Vertex AI](/en/google-vertex-ai)~~

74 214

~~75### Not Yet Implemented~~215## VS Code commands and shortcuts

76 216

~~77The following features are not yet available in the VS Code extension:~~217Open the Command Palette (`Cmd+Shift+P` on Mac or `Ctrl+Shift+P` on Windows/Linux) and type "Claude Code" to see all available VS Code commands for the Claude Code extension.

78 218

79* **MCP server and Plugin configuration UI**: Type `/mcp` to open the terminal-based MCP server configuration, or `/plugin` for Plugin configuration. Once configured, MCP servers and Plugins will work in the extension. You can also [configure MCP servers through the CLI](/en/mcp) first, then the extension will use them.219Some shortcuts depend on which panel is "focused" (receiving keyboard input). When your cursor is in a code file, the editor is focused. When your cursor is in Claude's prompt box, Claude is focused. Use `Cmd+Esc` / `Ctrl+Esc` to toggle between them.

~~80* **Subagents configuration**: Configure [subagents through the CLI](/en/sub-agents) to use them in VS Code~~

~~81* **Checkpoints**: Save and restore conversation state at specific points~~

~~82* **Conversation rewinding**: The `/rewind` command is coming soon~~

~~83* **Advanced shortcuts**:~~

~~84 * `#` shortcut to add to memory (not supported)~~

~~85 * `!` shortcut to run bash commands directly (not supported)~~

~~86* **Tab completion**: File path completion with tab key~~

87* **Model selection UI for older models**: To use older model versions like `claude-sonnet-4-20250514`, open VS Code settings for Claude Code (the `/General Config` command) and insert the model string directly into the 'Selected Model' field

88 220

~~89We are working on adding these features in future updates.~~221<Note>

222 These are VS Code commands for controlling the extension. Not all built-in Claude Code commands are available in the extension. See [VS Code extension vs. Claude Code CLI](#vs-code-extension-vs-claude-code-cli) for details.

223</Note>

90 224

~~91## Security Considerations~~225| Command | Shortcut | Description |

226| -------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------ |

227| Focus Input | `Cmd+Esc` (Mac) / `Ctrl+Esc` (Windows/Linux) | Toggle focus between editor and Claude |

228| Open in Side Bar | - | Open Claude in the left sidebar |

229| Open in Terminal | - | Open Claude in terminal mode |

230| Open in New Tab | `Cmd+Shift+Esc` (Mac) / `Ctrl+Shift+Esc` (Windows/Linux) | Open a new conversation as an editor tab |

231| Open in New Window | - | Open a new conversation in a separate window |

232| New Conversation | `Cmd+N` (Mac) / `Ctrl+N` (Windows/Linux) | Start a new conversation (requires Claude to be focused) |

233| Insert @-Mention Reference | `Option+K` (Mac) / `Alt+K` (Windows/Linux) | Insert a reference to the current file and selection (requires editor to be focused) |

234| Show Logs | - | View extension debug logs |

235| Logout | - | Sign out of your Anthropic account |

92 236

93When Claude Code runs in VS Code with auto-edit permissions enabled, it may be able to modify IDE configuration files that can be automatically executed by your IDE. This may increase the risk of running Claude Code in auto-edit mode and allow bypassing Claude Code's permission prompts for bash execution.237## Configure settings

94 238

~~95When running in VS Code, consider:~~239The extension has two types of settings:

96 240

~~97* Enabling [VS Code Restricted Mode](https://code.visualstudio.com/docs/editor/workspace-trust#_restricted-mode) for untrusted workspaces~~241* **Extension settings** in VS Code: control the extension's behavior within VS Code. Open with `Cmd+,` (Mac) or `Ctrl+,` (Windows/Linux), then go to Extensions → Claude Code. You can also type `/` and select **General Config** to open settings.

~~98* Using manual approval mode for edits~~242* **Claude Code settings** in `~/.claude/settings.json`: shared between the extension and CLI. Use for allowed commands, environment variables, hooks, and MCP servers. See [Settings](/en/settings) for details.

~~99* Taking extra care to ensure Claude is only used with trusted prompts~~

100 243

101## Legacy CLI Integration244<Tip>

245 Add `"$schema": "https://json.schemastore.org/claude-code-settings.json"` to your `settings.json` to get autocomplete and inline validation for all available settings directly in VS Code.

246</Tip>

102 247

103The first VS Code integration that we released allows Claude Code running in the terminal to interact with your IDE. It provides selection context sharing (current selection/tab is automatically shared with Claude Code), diff viewing in the IDE instead of terminal, file reference shortcuts (`Cmd+Option+K` on Mac or `Alt+Ctrl+K` on Windows/Linux to insert file references like @File#L1-99), and automatic diagnostic sharing (lint and syntax errors).248### Extension settings

104 249

105The legacy integration auto-installs when you run `claude` from VS Code's integrated terminal. Simply run `claude` from the terminal and all features activate. For external terminals, use the `/ide` command to connect Claude Code to your VS Code instance. To configure, run `claude`, enter `/config`, and set the diff tool to `auto` for automatic IDE detection.250| Setting | Default | Description |

251| --------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

252| `selectedModel` | `default` | Model for new conversations. Change per-session with `/model`. |

253| `useTerminal` | `false` | Launch Claude in terminal mode instead of graphical panel |

254| `initialPermissionMode` | `default` | Controls approval prompts for new conversations: `default`, `plan`, `acceptEdits`, `auto`, or `bypassPermissions`. See [permission modes](/en/permission-modes). |

255| `preferredLocation` | `panel` | Where Claude opens: `sidebar` (right) or `panel` (new tab) |

256| `autosave` | `true` | Auto-save files before Claude reads or writes them |

257| `useCtrlEnterToSend` | `false` | Use Ctrl/Cmd+Enter instead of Enter to send prompts |

258| `enableNewConversationShortcut` | `true` | Enable Cmd/Ctrl+N to start a new conversation |

259| `hideOnboarding` | `false` | Hide the onboarding checklist (graduation cap icon) |

260| `respectGitIgnore` | `true` | Exclude .gitignore patterns from file searches |

261| `environmentVariables` | `[]` | Set environment variables for the Claude process. Use Claude Code settings instead for shared config. |

262| `disableLoginPrompt` | `false` | Skip authentication prompts (for third-party provider setups) |

263| `allowDangerouslySkipPermissions` | `false` | Adds [Auto](/en/permission-modes#eliminate-prompts-with-auto-mode) and Bypass permissions to the mode selector. Auto requires a Team plan and Claude Sonnet 4.6 or Opus 4.6, so the option may remain unavailable even with this toggle on. Use Bypass permissions only in sandboxes with no internet access. |

264| `claudeProcessWrapper` | - | Executable path used to launch the Claude process |

106 265

107Both the extension and CLI integration work with Visual Studio Code, Cursor, Windsurf, and VSCodium.266## VS Code extension vs. Claude Code CLI

108 267

109## Troubleshooting268Claude Code is available as both a VS Code extension (graphical panel) and a CLI (command-line interface in the terminal). Some features are only available in the CLI. If you need a CLI-only feature, run `claude` in VS Code's integrated terminal.

110 269

111### Extension Not Installing270| Feature | CLI | VS Code Extension |

271| ------------------- | ------------------- | ------------------------------------------------------------------------------------ |

272| Commands and skills | [All](/en/commands) | Subset (type `/` to see available) |

273| MCP server config | Yes | Partial (add servers via CLI; manage existing servers with `/mcp` in the chat panel) |

274| Checkpoints | Yes | Yes |

275| `!` bash shortcut | Yes | No |

276| Tab completion | Yes | No |

112 277

113* Ensure you have a compatible version of VS Code (1.85.0 or later)278### Rewind with checkpoints

279

280The VS Code extension supports checkpoints, which track Claude's file edits and let you rewind to a previous state. Hover over any message to reveal the rewind button, then choose from three options:

281

282* **Fork conversation from here**: start a new conversation branch from this message while keeping all code changes intact

283* **Rewind code to here**: revert file changes back to this point in the conversation while keeping the full conversation history

284* **Fork conversation and rewind code**: start a new conversation branch and revert file changes to this point

285

286For full details on how checkpoints work and their limitations, see [Checkpointing](/en/checkpointing).

287

288### Run CLI in VS Code

289

290To use the CLI while staying in VS Code, open the integrated terminal (`` Ctrl+` `` on Windows/Linux or `` Cmd+` `` on Mac) and run `claude`. The CLI automatically integrates with your IDE for features like diff viewing and diagnostic sharing.

291

292If using an external terminal, run `/ide` inside Claude Code to connect it to VS Code.

293

294### Switch between extension and CLI

295

296The extension and CLI share the same conversation history. To continue an extension conversation in the CLI, run `claude --resume` in the terminal. This opens an interactive picker where you can search for and select your conversation.

297

298### Include terminal output in prompts

299

300Reference terminal output in your prompts using `@terminal:name` where `name` is the terminal's title. This lets Claude see command output, error messages, or logs without copy-pasting.

301

302### Monitor background processes

303

304When Claude runs long-running commands, the extension shows progress in the status bar. However, visibility for background tasks is limited compared to the CLI. For better visibility, have Claude output the command so you can run it in VS Code's integrated terminal.

305

306### Connect to external tools with MCP

307

308MCP (Model Context Protocol) servers give Claude access to external tools, databases, and APIs.

309

310To add an MCP server, open the integrated terminal (`` Ctrl+` `` or `` Cmd+` ``) and run:

311

312```bash theme={null}

313claude mcp add --transport http github https://api.githubcopilot.com/mcp/

314```

315

316Once configured, ask Claude to use the tools (e.g., "Review PR #456").

317

318To manage MCP servers without leaving VS Code, type `/mcp` in the chat panel. The MCP management dialog lets you enable or disable servers, reconnect to a server, and manage OAuth authentication. See the [MCP documentation](/en/mcp) for available servers.

319

320## Work with git

321

322Claude Code integrates with git to help with version control workflows directly in VS Code. Ask Claude to commit changes, create pull requests, or work across branches.

323

324### Create commits and pull requests

325

326Claude can stage changes, write commit messages, and create pull requests based on your work:

327

328```text theme={null}

329> commit my changes with a descriptive message

330> create a pr for this feature

331> summarize the changes I've made to the auth module

332```

333

334When creating pull requests, Claude generates descriptions based on the actual code changes and can add context about testing or implementation decisions.

335

336### Use git worktrees for parallel tasks

337

338Use the `--worktree` (`-w`) flag to start Claude in an isolated worktree with its own files and branch:

339

340```bash theme={null}

341claude --worktree feature-auth

342```

343

344Each worktree maintains independent file state while sharing git history. This prevents Claude instances from interfering with each other when working on different tasks. For more details, see [Run parallel sessions with Git worktrees](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees).

345

346## Use third-party providers

347

348By default, Claude Code connects directly to Anthropic's API. If your organization uses Amazon Bedrock, Google Vertex AI, or Microsoft Foundry to access Claude, configure the extension to use your provider instead:

349

350<Steps>

351 <Step title="Disable login prompt">

352 Open the [Disable Login Prompt setting](vscode://settings/claudeCode.disableLoginPrompt) and check the box.

353

354 You can also open VS Code settings (`Cmd+,` on Mac or `Ctrl+,` on Windows/Linux), search for "Claude Code login", and check **Disable Login Prompt**.

355 </Step>

356

357 <Step title="Configure your provider">

358 Follow the setup guide for your provider:

359

360 * [Claude Code on Amazon Bedrock](/en/amazon-bedrock)

361 * [Claude Code on Google Vertex AI](/en/google-vertex-ai)

362 * [Claude Code on Microsoft Foundry](/en/microsoft-foundry)

363

364 These guides cover configuring your provider in `~/.claude/settings.json`, which ensures your settings are shared between the VS Code extension and the CLI.

365 </Step>

366</Steps>

367

368## Security and privacy

369

370Your code stays private. Claude Code processes your code to provide assistance but does not use it to train models. For details on data handling and how to opt out of logging, see [Data and privacy](/en/data-usage).

371

372With auto-edit permissions enabled, Claude Code can modify VS Code configuration files (like `settings.json` or `tasks.json`) that VS Code may execute automatically. To reduce risk when working with untrusted code:

373

374* Enable [VS Code Restricted Mode](https://code.visualstudio.com/docs/editor/workspace-trust#_restricted-mode) for untrusted workspaces

375* Use manual approval mode instead of auto-accept for edits

376* Review changes carefully before accepting them

377

378### The built-in IDE MCP server

379

380When the extension is active, it runs a local MCP server that the CLI connects to automatically. This is how the CLI opens diffs in VS Code's native diff viewer, reads your current selection for `@`-mentions, and — when you're working in a Jupyter notebook — asks VS Code to execute cells.

381

382The server is named `ide` and is hidden from `/mcp` because there's nothing to configure. If your organization uses a `PreToolUse` hook to allowlist MCP tools, though, you'll need to know it exists.

383

384**Transport and authentication.** The server binds to `127.0.0.1` on a random high port and is not reachable from other machines. Each extension activation generates a fresh random auth token that the CLI must present to connect. The token is written to a lock file under `~/.claude/ide/` with `0600` permissions in a `0700` directory, so only the user running VS Code can read it.

385

386**Tools exposed to the model.** The server hosts a dozen tools, but only two are visible to the model. The rest are internal RPC the CLI uses for its own UI — opening diffs, reading selections, saving files — and are filtered out before the tool list reaches Claude.

387

388| Tool name (as seen by hooks) | What it does | Writes? |

389| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------- |

390| `mcp__ide__getDiagnostics` | Returns language-server diagnostics — the errors and warnings in VS Code's Problems panel. Optionally scoped to one file. | No |

391| `mcp__ide__executeCode` | Runs Python code in the active Jupyter notebook's kernel. See confirmation flow below. | Yes |

392

393**Jupyter execution always asks first.** `mcp__ide__executeCode` can't run anything silently. On each call, the code is inserted as a new cell at the end of the active notebook, VS Code scrolls it into view, and a native Quick Pick asks you to **Execute** or **Cancel**. Cancelling — or dismissing the picker with `Esc` — returns an error to Claude and nothing runs. The tool also refuses outright when there's no active notebook, when the Jupyter extension (`ms-toolsai.jupyter`) isn't installed, or when the kernel isn't Python.

394

395<Note>

396 The Quick Pick confirmation is separate from `PreToolUse` hooks. An allowlist entry for `mcp__ide__executeCode` lets Claude *propose* running a cell; the Quick Pick inside VS Code is what lets it *actually* run.

397</Note>

398

399## Fix common issues

400

401### Extension won't install

402

403* Ensure you have a compatible version of VS Code (1.98.0 or later)

114* Check that VS Code has permission to install extensions404* Check that VS Code has permission to install extensions

115* Try installing directly from the Marketplace website405* Try installing directly from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=anthropic.claude-code)

406

407### Spark icon not visible

408

409The Spark icon appears in the **Editor Toolbar** (top-right of editor) when you have a file open. If you don't see it:

410

4111. **Open a file**: The icon requires a file to be open. Having just a folder open isn't enough.

4122. **Check VS Code version**: Requires 1.98.0 or higher (Help → About)

4133. **Restart VS Code**: Run "Developer: Reload Window" from the Command Palette

4144. **Disable conflicting extensions**: Temporarily disable other AI extensions (Cline, Continue, etc.)

4155. **Check workspace trust**: The extension doesn't work in Restricted Mode

416

417Alternatively, click "✱ Claude Code" in the **Status Bar** (bottom-right corner). This works even without a file open. You can also use the **Command Palette** (`Cmd+Shift+P` / `Ctrl+Shift+P`) and type "Claude Code".

116 418

117### Claude Code Never Responds419### Claude Code never responds

118 420

119If Claude Code is not responding to your prompts:421If Claude Code isn't responding to your prompts:

120 422

1211. **Check your internet connection**: Ensure you have a stable internet connection4231. **Check your internet connection**: Ensure you have a stable internet connection

1222. **Start a new conversation**: Try starting a fresh conversation to see if the issue persists4242. **Start a new conversation**: Try starting a fresh conversation to see if the issue persists

1233. **Try the CLI**: Run `claude` from the terminal to see if you get more detailed error messages4253. **Try the CLI**: Run `claude` from the terminal to see if you get more detailed error messages

1244. **File a bug report**: If the problem continues, [file an issue on GitHub](https://github.com/anthropics/claude-code/issues) with details about the error

125 426

126### Legacy Integration Not Working427If problems persist, [file an issue on GitHub](https://github.com/anthropics/claude-code/issues) with details about the error.

428

429## Uninstall the extension

430

431To uninstall the Claude Code extension:

432

4331. Open the Extensions view (`Cmd+Shift+X` on Mac or `Ctrl+Shift+X` on Windows/Linux)

4342. Search for "Claude Code"

4353. Click **Uninstall**

436

437To also remove extension data and reset all settings:

438

439```bash theme={null}

440rm -rf ~/.vscode/globalStorage/anthropic.claude-code

441```

442

443For additional help, see the [troubleshooting guide](/en/troubleshooting).

444

445## Next steps

127 446

128* Ensure you're running Claude Code from VS Code's integrated terminal447Now that you have Claude Code set up in VS Code:

129* Ensure the CLI for your IDE variant is installed:

130 * VS Code: `code` command should be available

131 * Cursor: `cursor` command should be available

132 * Windsurf: `windsurf` command should be available

133 * VSCodium: `codium` command should be available

134* If the command isn't installed:

135 1. Open command palette with `Cmd+Shift+P` (Mac) or `Ctrl+Shift+P` (Windows/Linux)

136 2. Search for "Shell Command: Install 'code' command in PATH" (or equivalent for your IDE)

137 448

138For additional help, see our [troubleshooting guide](/en/troubleshooting).449* [Explore common workflows](/en/common-workflows) to get the most out of Claude Code

450* [Set up MCP servers](/en/mcp) to extend Claude's capabilities with external tools. Add servers using the CLI, then manage them with `/mcp` in the chat panel.

451* [Configure Claude Code settings](/en/settings) to customize allowed commands, hooks, and more. These settings are shared between the extension and CLI.

web-scheduled-tasks.md +154 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Schedule tasks on the web

7> Automate recurring work with cloud scheduled tasks

9A scheduled task runs a prompt on a recurring cadence using Anthropic-managed infrastructure. Tasks keep working even when your computer is off.

11A few examples of recurring work you can automate:

13* Reviewing open pull requests each morning

14* Analyzing CI failures overnight and surfacing summaries

15* Syncing documentation after PRs merge

16* Running dependency audits every week

18Scheduled tasks are available to all Claude Code on the web users, including Pro, Max, Team, and Enterprise.

20## Compare scheduling options

22Claude Code offers three ways to schedule recurring work:

25| :------------------------- | :------------------------------- | :---------------------------------------------- | :----------------------------- |

27| Requires machine on | No | Yes | Yes |

28| Requires open session | No | No | Yes |

29| Persistent across restarts | Yes | Yes | No (session-scoped) |

30| Access to local files | No (fresh clone) | Yes | Yes |

33| Customizable schedule | Via `/schedule` in the CLI | Yes | Yes |

36<Tip>

37 Use **cloud tasks** for work that should run reliably without your machine. Use **Desktop tasks** when you need access to local files and tools. Use **`/loop`** for quick polling during a session.

38</Tip>

40## Create a scheduled task

42You can create a scheduled task from three places:

44* **Web**: visit [claude.ai/code/scheduled](https://claude.ai/code/scheduled) and click **New scheduled task**

45* **Desktop app**: open the **Schedule** page, click **New task**, and choose **New remote task**. See [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) for details.

46* **CLI**: run `/schedule` in any session. Claude walks you through the setup conversationally. You can also pass a description directly, like `/schedule daily PR review at 9am`.

48The web and Desktop entry points open a form. The CLI collects the same information through a guided conversation.

50The steps below walk through the web interface.

52<Steps>

53 <Step title="Open the creation form">

54 Visit [claude.ai/code/scheduled](https://claude.ai/code/scheduled) and click **New scheduled task**.

55 </Step>

57 <Step title="Name the task and write the prompt">

58 Give the task a descriptive name and write the prompt Claude runs each time. The prompt is the most important part: the task runs autonomously, so the prompt must be self-contained and explicit about what to do and what success looks like.

60 The prompt input includes a model selector. Claude uses this model for each run of the task.

61 </Step>

63 <Step title="Select repositories">

64 Add one or more GitHub repositories for Claude to work in. Each repository is cloned at the start of a run, starting from the default branch. Claude creates `claude/`-prefixed branches for its changes. To allow pushes to any branch, enable **Allow unrestricted branch pushes** for that repository.

65 </Step>

67 <Step title="Select an environment">

68 Select a [cloud environment](/en/claude-code-on-the-web#cloud-environment) for the task. Environments control what the cloud session has access to:

70 * **Network access**: set the level of internet access available during each run

71 * **Environment variables**: provide API keys, tokens, or other secrets Claude can use

72 * **Setup script**: run install commands before each session starts, like installing dependencies or configuring tools

74 A **Default** environment is available out of the box. To use a custom environment, [create one](/en/claude-code-on-the-web#cloud-environment) before creating the task.

75 </Step>

77 <Step title="Choose a schedule">

78 Pick how often the task runs from the [frequency options](#frequency-options). The default is daily at 9:00 AM in your local time zone. Tasks may run a few minutes after their scheduled time due to stagger.

80 If the preset options don't fit your needs, pick the closest one and update the schedule from the CLI with `/schedule update` to set a specific schedule.

81 </Step>

83 <Step title="Review connectors">

84 All of your connected [MCP connectors](/en/mcp) are included by default. Remove any that the task doesn't need. Connectors give Claude access to external services like Slack, Linear, or Google Drive during each run.

85 </Step>

87 <Step title="Create the task">

88 Click **Create**. The task appears in the scheduled tasks list and runs automatically at the next scheduled time. Each run creates a new session alongside your other sessions, where you can see what Claude did, review changes, and create a pull request. To trigger a run immediately, click **Run now** from the task's detail page.

89 </Step>

90</Steps>

92### Frequency options

94The schedule picker offers preset frequencies that handle time zone conversion for you. Pick a time in your local zone and the task runs at that wall-clock time regardless of where the cloud infrastructure is located.

96<Note>

97 Tasks may run a few minutes after their scheduled time. The offset is consistent for each task.

98</Note>

100| Frequency | Description |

101| :-------- | :------------------------------------------------------------------------- |

102| Hourly | Runs every hour. |

103| Daily | Runs once per day at the time you specify. Defaults to 9:00 AM local time. |

104| Weekdays | Same as Daily but skips Saturday and Sunday. |

105| Weekly | Runs once per week on the day and time you specify. |

106

107For custom intervals like every 2 hours or first of each month, pick the closest preset and update the schedule from the CLI with `/schedule update` to set a specific schedule.

108

109### Repositories and branch permissions

110

111Each repository you add is cloned on every run. Claude starts from the repository's default branch unless your prompt specifies otherwise.

112

113By default, Claude can only push to branches prefixed with `claude/`. This prevents scheduled tasks from accidentally modifying protected or long-lived branches.

114

115To remove this restriction for a specific repository, enable **Allow unrestricted branch pushes** for that repository when creating or editing the task.

116

117### Connectors

118

119Scheduled tasks can use your connected MCP connectors to read from and write to external services during each run. For example, a task that triages support requests might read from a Slack channel and create issues in Linear.

120

121When you create a task, all of your currently connected connectors are included by default. Remove any that aren't needed to limit which tools Claude has access to during the run. You can also add connectors directly from the task form.

122

123To manage or add connectors outside of the task form, visit **Settings > Connectors** on claude.ai or use `/schedule update` in the CLI.

124

125### Environments

126

127Each task runs in a [cloud environment](/en/claude-code-on-the-web#cloud-environment) that controls network access, environment variables, and setup scripts. Configure environments before creating a task to give Claude access to APIs, install dependencies, or restrict network scope. See [cloud environment](/en/claude-code-on-the-web#cloud-environment) for the full setup guide.

128

129## Manage scheduled tasks

130

131Click a task in the **Scheduled** list to open its detail page. The detail page shows the task's repositories, connectors, prompt, schedule, and a list of past runs.

132

133### View and interact with runs

134

135Click any run to open it as a full session. From there you can see what Claude did, review changes, create a pull request, or continue the conversation. Each run session works like any other session: use the dropdown menu next to the session title to rename, archive, or delete it.

136

137### Edit and control tasks

138

139From the task detail page you can:

140

141* Click **Run now** to start a run immediately without waiting for the next scheduled time.

142* Use the toggle in the **Repeats** section to pause or resume the schedule. Paused tasks keep their configuration but don't run until you re-enable them.

143* Click the edit icon to change the name, prompt, schedule, repositories, environment, or connectors.

144* Click the delete icon to remove the task. Past sessions created by the task remain in your session list.

145

146You can also manage tasks from the CLI with `/schedule`. Run `/schedule list` to see all tasks, `/schedule update` to change a task, or `/schedule run` to trigger one immediately.

147

148## Related resources

149

150* [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks): schedule tasks that run on your machine with access to local files. The Desktop app's **Schedule** page shows both local and remote tasks in the same grid.

151* [`/loop` and CLI scheduled tasks](/en/scheduled-tasks): lightweight scheduling within a CLI session

152* [Cloud environment](/en/claude-code-on-the-web#cloud-environment): configure the runtime environment for cloud tasks

153* [MCP connectors](/en/mcp): connect external services like Slack, Linear, and Google Drive

154* [GitHub Actions](/en/github-actions): run Claude in your CI pipeline on repo events

zero-data-retention.md +66 −0 added

Details

1> ## Documentation Index

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

3> Use this file to discover all available pages before exploring further.

5# Zero data retention

7> Learn about Zero Data Retention (ZDR) for Claude Code on Claude for Enterprise, including scope, disabled features, and how to request enablement.

9Zero Data Retention (ZDR) is available for Claude Code when used through Claude for Enterprise. When ZDR is enabled, prompts and model responses generated during Claude Code sessions are processed in real time and not stored by Anthropic after the response is returned, except where needed to comply with law or combat misuse.

11ZDR on Claude for Enterprise gives enterprise customers the ability to use Claude Code with zero data retention and access administrative capabilities:

13* Cost controls per user

14* [Analytics](/en/analytics) dashboard

15* [Server-managed settings](/en/server-managed-settings)

16* Audit logs

18ZDR for Claude Code on Claude for Enterprise applies only to Anthropic's direct platform. For Claude deployments on AWS Bedrock, Google Vertex AI, or Microsoft Foundry, refer to those platforms' data retention policies.

20## ZDR scope

22ZDR covers Claude Code inference on Claude for Enterprise.

24<Warning>

25 ZDR is enabled on a per-organization basis. Each new organization requires ZDR to be enabled separately by your Anthropic account team. ZDR does not automatically apply to new organizations created under the same account. Contact your account team to enable ZDR for any new organizations.

26</Warning>

28### What ZDR covers

30ZDR covers model inference calls made through Claude Code on Claude for Enterprise. When you use Claude Code in your terminal, the prompts you send and the responses Claude generates are not retained by Anthropic. This applies regardless of which Claude model is used.

32### What ZDR does not cover

34ZDR does not extend to the following, even for organizations with ZDR enabled. These features follow [standard data retention policies](/en/data-usage#data-retention):

36| Feature | Details |

37| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

38| Chat on claude.ai | Chat conversations through the Claude for Enterprise web interface are not covered by ZDR. |

39| Cowork | Cowork sessions are not covered by ZDR. |

40| Claude Code Analytics | Does not store prompts or model responses, but collects productivity metadata such as account emails and usage statistics. Contribution metrics are not available for ZDR organizations; the [analytics dashboard](/en/analytics) shows usage metrics only. |

41| User and seat management | Administrative data such as account emails and seat assignments is retained under standard policies. |

42| Third-party integrations | Data processed by third-party tools, MCP servers, or other external integrations is not covered by ZDR. Review those services' data handling practices independently. |

44## Features disabled under ZDR

46When ZDR is enabled for a Claude Code organization on Claude for Enterprise, certain features that require storing prompts or completions are automatically disabled at the backend level:

48| Feature | Reason |

49| ------------------------------------------------------------------- | ----------------------------------------------------------------------- |

50| [Claude Code on the Web](/en/claude-code-on-the-web) | Requires server-side storage of conversation history. |

51| [Remote sessions](/en/desktop#remote-sessions) from the Desktop app | Requires persistent session data that includes prompts and completions. |

52| Feedback submission (`/feedback`) | Submitting feedback sends conversation data to Anthropic. |

54These features are blocked in the backend regardless of client-side display. If you see a disabled feature in the Claude Code terminal during startup, attempting to use it returns an error indicating the organization's policies do not allow that action.

56Future features may also be disabled if they require storing prompts or completions.

58## Data retention for policy violations

60Even with ZDR enabled, Anthropic may retain data where required by law or to address Usage Policy violations. If a session is flagged for a policy violation, Anthropic may retain the associated inputs and outputs for up to 2 years, consistent with Anthropic's standard ZDR policy.

62## Request ZDR

64To request ZDR for Claude Code on Claude for Enterprise, contact your Anthropic account team. Your account team will submit the request internally, and Anthropic will review and enable ZDR on your organization after confirming eligibility. All enablement actions are audit-logged.

66If you are currently using ZDR for Claude Code via pay-as-you-go API keys, you can transition to Claude for Enterprise to gain access to administrative features while maintaining ZDR for Claude Code. Contact your account team to coordinate the migration.

Anthropic - Claude Code Docs Changes 2025-11-24 21:01 UTC → 2026-03-25 21:08 UTC