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 +39 −23

Details

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

12 12

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

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

15* 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)

16* Appropriate IAM permissions16* Appropriate IAM permissions

17 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>

18## Setup22## Setup

19 23

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

120* 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.

121* 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.

122 126

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

128

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:

124 134

125Claude Code uses these default models for Bedrock: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:

126 144

127| Model type | Default value |145| Model type | Default value |

128| :--------------- | :------------------------------------------------- |146| :--------------- | :-------------------------------------------- |

131 149

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

133 For Bedrock users, Claude Code won't 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 (for example, `us.anthropic.claude-haiku-4-5-20251001-v1:0`).

134</Note>

~~135~~

136To customize models, use one of these methods:

137 151

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

139# Using inference profile ID153# Using inference profile ID

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

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

142 156

143# Using application inference profile ARN157# Using application inference profile ARN

149 163

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

151 165

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

~~153~~

154These are the recommended token settings for Claude Code with Amazon Bedrock:

155 167

156```bash theme={null}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.

157# Recommended output token settings for Bedrock

158export CLAUDE_CODE_MAX_OUTPUT_TOKENS=4096

159export MAX_THINKING_TOKENS=1024

160```

161 169

162**Why these values:**170This example maps three Opus versions to distinct ARNs so users can switch between them without bypassing your organization's inference profiles:

163 171

164* **`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.172```json theme={null}

173{

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```

165 181

166* **`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.

167 183

168## IAM configuration184## IAM configuration

169 185

210For 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).

211 227

212<Note>228<Note>

213 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.

214</Note>230</Note>

215 231

216## AWS Guardrails232## AWS Guardrails

analytics.md +4 −0

Details

34 34

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

36 36

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>

37<Steps>41<Steps>

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

39 A GitHub admin installs the Claude GitHub app on your organization's GitHub account at [github.com/apps/claude](https://github.com/apps/claude).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).

authentication.md +30 −17

Details

4 4

5# Authentication5# Authentication

6 6

~~7> Learn how to configure user authentication and credential management for Claude Code in your organization.~~7> Log in to Claude Code and configure authentication for individuals, teams, and organizations.

8 8

~~9## Authentication methods~~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.

10 10

~~11Setting up Claude Code requires access to Anthropic models. For teams, you can set up Claude Code access in one of these ways:~~11## Log in to Claude Code

12 12

~~13* [Claude for Teams or Enterprise](#claude-for-teams-or-enterprise) (recommended)~~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

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

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

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

18 37

19### Claude for Teams or Enterprise38### Claude for Teams or Enterprise

20 39

21[Claude for Teams](https://claude.com/pricing#team-&-enterprise) and [Claude for Enterprise](https://anthropic.com/contact-sales) 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.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.

22 41

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

24* **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.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.

25 44

26<Steps>45<Steps>

27 <Step title="Subscribe">46 <Step title="Subscribe">

~~28 Subscribe to [Claude for Teams](https://claude.com/pricing#team-&-enterprise) or contact sales for [Claude for Enterprise](https://anthropic.com/contact-sales).~~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).

29 </Step>48 </Step>

30 49

31 <Step title="Invite team members">50 <Step title="Invite team members">

49 <Step title="Add users">68 <Step title="Add users">

50 You can add users through either method:69 You can add users through either method:

51 70

~~52 * Bulk invite users from within the Console (Console -> Settings -> Members -> Invite)~~71 * Bulk invite users from within the Console: Settings -> Members -> Invite

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

54 </Step>73 </Step>

55 74

65 84

66 * Accept the Console invite85 * Accept the Console invite

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

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

69 * Log in with Console account credentials88 * Log in with Console account credentials

70 </Step>89 </Step>

71</Steps>90</Steps>

72 91

73### Cloud provider authentication92### Cloud provider authentication

74 93

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

76 95

77<Steps>96<Steps>

78 <Step title="Follow provider setup">97 <Step title="Follow provider setup">

84 </Step>103 </Step>

85 104

86 <Step title="Install Claude Code">105 <Step title="Install Claude Code">

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

88 </Step>107 </Step>

89</Steps>108</Steps>

90 109

92 111

93Claude Code securely manages your authentication credentials:112Claude Code securely manages your authentication credentials:

94 113

~~95* **Storage location**: on macOS, API keys, OAuth tokens, and other credentials are stored in the encrypted macOS Keychain.~~114* **Storage location**: on macOS, credentials are stored in the encrypted macOS Keychain.

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

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

98* **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.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.

100## See also

~~101~~

102* [Permissions](/en/permissions): configure what Claude Code can access and do

103* [Settings](/en/settings): complete configuration reference

104* [Security](/en/security): security safeguards and best practices

best-practices.md +31 −51

Details

20 20

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.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.

22 22

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. For detailed strategies on reducing token usage, see [Reduce token usage](/en/costs#reduce-token-usage).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.

24 24

25***25***

26 26

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

149</Tip>149</Tip>

150 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**.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 152

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

154 154

194 194

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

196 196

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

198* **Project root (`./CLAUDE.md`)**: Check into git to share with your team, or name it `CLAUDE.local.md` and `.gitignore` it198* **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 automatically199* **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 directories200* **Child directories**: Claude pulls in child CLAUDE.md files on demand when working with files in those directories

201 201

202### Configure permissions202### Configure permissions

207 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 two ways to reduce these interruptions: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 two ways to reduce these interruptions:

209 209

210* **Permission allowlists**: Permit specific tools you know are safe (like `npm run lint` or `git commit`)210* **Permission allowlists**: permit specific tools you know are safe (like `npm run lint` or `git commit`)

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

212 212

213Alternatively, use `--dangerously-skip-permissions` to bypass all permission checks for contained workflows like fixing lint errors or generating boilerplate.213Alternatively, use `--dangerously-skip-permissions` to bypass all permission checks for contained workflows like fixing lint errors or generating boilerplate.

214 214

216 Letting Claude run arbitrary commands can result in data loss, system corruption, or data exfiltration via prompt injection. Only use `--dangerously-skip-permissions` in a sandbox without internet access.216 Letting Claude run arbitrary commands can result in data loss, system corruption, or data exfiltration via prompt injection. Only use `--dangerously-skip-permissions` in a sandbox without internet access.

217</Warning>217</Warning>

218 218

219Read more about [configuring permissions](/en/settings) and [enabling sandboxing](/en/sandboxing#sandboxing).219Read more about [configuring permissions](/en/permissions) and [enabling sandboxing](/en/sandboxing).

220 220

221### Use CLI tools221### Use CLI tools

222 222

244 244

245[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.245[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.

246 246

247Claude 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."* Run `/hooks` for interactive configuration, or edit `.claude/settings.json` directly.247Claude 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.

248 248

249### Create skills249### Create skills

250 250

356 356

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

358 358

359```359```text theme={null}

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

361 361

362Ask 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.362Ask 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.

380 380

381The 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.381The 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.

382 382

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

384* **`Esc + Esc` or `/rewind`**: Press `Esc` twice or run `/rewind` to open the rewind menu and restore previous conversation and code state.384* **`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.

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

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

387 387

388If 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.388If 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.

389 389

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

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

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

403* 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.

403* 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 summarization404* 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

405* 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.

404 406

405### Use subagents for investigation407### Use subagents for investigation

406 408

410 412

411Since 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:413Since 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:

412 414

413```415```text theme={null}

414Use subagents to investigate how our authentication system handles token416Use subagents to investigate how our authentication system handles token

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

416```418```

419 421

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

421 423

422```424```text theme={null}

423use a subagent to review this code for edge cases425use a subagent to review this code for edge cases

424```426```

425 427

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

430</Tip>432</Tip>

431 433

432Claude automatically checkpoints before changes. Double-tap `Escape` or run `/rewind` to open the checkpoint menu. You can restore conversation only (keep code changes), restore code only (keep conversation), or restore both.434Claude 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.

433 435

434Instead 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.436Instead 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.

435 437

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

444</Tip>446</Tip>

445 447

446Claude Code saves conversations locally. When a task spans multiple sessions (you start a feature, get interrupted, come back the next day) you don't have to re-explain the context:448Claude Code saves conversations locally. When a task spans multiple sessions, you don't have to re-explain the context:

447 449

448```bash theme={null}450```bash theme={null}

449claude --continue # Resume the most recent conversation451claude --continue # Resume the most recent conversation

450claude --resume # Select from recent conversations452claude --resume # Select from recent conversations

451```453```

452 454

453Use `/rename` to give sessions descriptive names (`"oauth-migration"`, `"debugging-memory-leak"`) so you can find them later. Treat sessions like branches. Different workstreams can have separate, persistent contexts.455Use `/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.

454 456

455***457***

456 458

457## Automate and scale459## Automate and scale

458 460

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

460 462

461Everything 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.463Everything 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.

462 464

463### Run headless mode465### Run non-interactive mode

464 466

465<Tip>467<Tip>

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

467</Tip>469</Tip>

468 470

469With `claude -p "your prompt"`, you can run Claude headlessly, without an interactive session. Headless mode is how you integrate Claude into CI pipelines, pre-commit hooks, or any automated workflow. The output formats (plain text, JSON, streaming JSON) let you parse results programmatically.471With `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.

470 472

471```bash theme={null}473```bash theme={null}

472# One-off queries474# One-off queries

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

486</Tip>488</Tip>

487 489

488There are two main ways to run parallel sessions:490There are three main ways to run parallel sessions:

489 491

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

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

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

492 495

493Beyond 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.496Beyond 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.

494 497

537 540

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

539 542

540### Safe Autonomous Mode

~~541~~

542Use `claude --dangerously-skip-permissions` to bypass all permission checks and let Claude work uninterrupted. This works well for workflows like fixing lint errors or generating boilerplate code.

~~543~~

544<Warning>

545 Letting Claude run arbitrary commands is risky and can result in data loss, system corruption, or data exfiltration (e.g., via prompt injection attacks). To minimize these risks, use `--dangerously-skip-permissions` in a container without internet access.

~~546~~

547 With sandboxing enabled (`/sandbox`), you get similar autonomy with better security. Sandbox defines upfront boundaries rather than bypassing all checks.

548</Warning>

~~549~~

550***543***

551 544

552## Avoid common failure patterns545## Avoid common failure patterns

578 571

579## Related resources572## Related resources

580 573

581<CardGroup cols={2}>574* [How Claude Code works](/en/how-claude-code-works): the agentic loop, tools, and context management

582 <Card title="How Claude Code works" icon="gear" href="/en/how-claude-code-works">575* [Extend Claude Code](/en/features-overview): skills, hooks, MCP, subagents, and plugins

583 Understand the agentic loop, tools, and context management576* [Common workflows](/en/common-workflows): step-by-step recipes for debugging, testing, PRs, and more

584 </Card>577* [CLAUDE.md](/en/memory): store project conventions and persistent context

~~585~~

586 <Card title="Extend Claude Code" icon="puzzle-piece" href="/en/features-overview">

587 Choose between skills, hooks, MCP, subagents, and plugins

588 </Card>

~~589~~

590 <Card title="Common workflows" icon="list-check" href="/en/common-workflows">

591 Step-by-step recipes for debugging, testing, PRs, and more

592 </Card>

~~593~~

594 <Card title="CLAUDE.md" icon="file-lines" href="/en/memory">

595 Store project conventions and persistent context

596 </Card>

597</CardGroup>

checkpointing.md +30 −10

Details

4 4

5# Checkpointing5# Checkpointing

6 6

~~7> 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.

8 8

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.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.

10 10

20* Checkpoints persist across sessions, so you can access them in resumed conversations20* Checkpoints persist across sessions, so you can access them in resumed conversations

21* Automatically cleaned up along with sessions after 30 days (configurable)21* Automatically cleaned up along with sessions after 30 days (configurable)

22 22

~~23### Rewinding changes~~23### Rewind and summarize

24 24

~~25Press `Esc` twice (`Esc` + `Esc`) or use the `/rewind` command to open up the rewind menu. You can choose to restore:~~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:

26 26

~~27* **Conversation only**: Rewind to a user message while keeping code changes~~27* **Restore code and conversation**: revert both code and conversation to that point

~~28* **Code only**: Revert file changes while keeping the conversation~~28* **Restore conversation**: rewind to that message while keeping current code

~~29* **Both code and conversation**: Restore both to a prior point in the session~~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

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.

46<Note>

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`).

48</Note>

30 49

31## Common use cases50## Common use cases

32 51

33Checkpoints are particularly useful when:52Checkpoints are particularly useful when:

34 53

~~35* **Exploring alternatives**: Try different implementation approaches without losing your starting point~~54* **Exploring alternatives**: try different implementation approaches without losing your starting point

~~36* **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

~~37* **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

38 58

39## Limitations59## Limitations

40 60

65## See also85## See also

66 86

67* [Interactive mode](/en/interactive-mode) - Keyboard shortcuts and session controls87* [Interactive mode](/en/interactive-mode) - Keyboard shortcuts and session controls

~~68* [Built-in commands](/en/interactive-mode#built-in-commands) - Accessing checkpoints using `/rewind`~~88* [Built-in commands](/en/commands) - Accessing checkpoints using `/rewind`

69* [CLI reference](/en/cli-reference) - Command-line options89* [CLI reference](/en/cli-reference) - Command-line options

chrome.md +12 −4

Details

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.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.

12 12

13<Note>13<Note>

14 Chrome integration is in beta and currently works with Google Chrome only. It is not yet supported on Brave, Arc, or other Chromium-based browsers. WSL (Windows Subsystem for Linux) is also not supported.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>15</Note>

16 16

17## Capabilities17## Capabilities

30 30

31Before using Claude Code with Chrome, you need:31Before using Claude Code with Chrome, you need:

32 32

~~33* [Google Chrome](https://www.google.com/chrome/) browser~~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~~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 higher35* [Claude Code](/en/quickstart#step-1-install-claude-code) version 2.0.73 or higher

~~36* A direct Anthropic plan (Pro, Max, Team, or Enterprise)~~36* A direct Anthropic plan (Pro, Max, Teams, or Enterprise)

37 37

38<Note>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.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.

180 180

181If the connection still fails, verify the host configuration file exists at:181If the connection still fails, verify the host configuration file exists at:

182 182

183For Chrome:

184

183* **macOS**: `~/Library/Application Support/Google/Chrome/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`185* **macOS**: `~/Library/Application Support/Google/Chrome/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`

184* **Linux**: `~/.config/google-chrome/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`186* **Linux**: `~/.config/google-chrome/NativeMessagingHosts/com.anthropic.claude_code_browser_extension.json`

185* **Windows**: check `HKCU\Software\Google\Chrome\NativeMessagingHosts\` in the Windows Registry187* **Windows**: check `HKCU\Software\Google\Chrome\NativeMessagingHosts\` in the Windows Registry

186 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

187### Browser not responding195### Browser not responding

188 196

189If Claude's browser commands stop working:197If Claude's browser commands stop working:

claude-code-on-the-web.md +109 −49

Details

20* **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

21* **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

22 22

~~23Claude Code is also available on the Claude iOS app for kicking off tasks on the go and monitoring work in progress.~~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.

24 24

25You can move between local and remote development: [send tasks from your terminal to run on the web](#from-terminal-to-web) with the `&` prefix, or [teleport web sessions back to your terminal](#from-web-to-terminal) to continue 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).

26 26

27## Who can use Claude Code on the web?27## Who can use Claude Code on the web?

28 28

30 30

31* **Pro users**31* **Pro users**

32* **Max users**32* **Max users**

~~33* **Team premium seat users**~~33* **Team users**

~~34* **Enterprise premium seat users**~~34* **Enterprise users** with premium seats or Chat + Claude Code seats

35 35

36## Getting started36## Getting started

37 37

47When you start a task on Claude Code on the web:47When you start a task on Claude Code on the web:

48 48

491. **Repository cloning**: Your repository is cloned to an Anthropic-managed virtual machine491. **Repository cloning**: Your repository is cloned to an Anthropic-managed virtual machine

~~502. **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

513. **Network configuration**: Internet access is configured based on your settings513. **Network configuration**: Internet access is configured based on your settings

524. **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

535. **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

69 69

70## Moving tasks between web and terminal70## Moving tasks between web and terminal

71 71

72You can start tasks on the web and continue them in your terminal, or send tasks from your terminal to run on the web. Web sessions persist even if you close your laptop, and you can monitor them from anywhere including the Claude iOS app.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.

73 73

74<Note>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 [`&` prefix](#from-terminal-to-web) creates a *new* web session with your current conversation context.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>76</Note>

77 77

78### From terminal to web78### From terminal to web

79 79

~~80Start a message with `&` inside Claude Code to send a task to run on the web:~~80Start a web session from the command line with the `--remote` flag:

~~82```~~

~~83& Fix the authentication bug in src/auth/login.ts~~

~~84```~~

86This creates a new web session on claude.ai with your current conversation context. 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 iOS app to interact directly. From there you can steer Claude, provide feedback, or answer questions just like any other conversation.

~~88You can also start a web session directly from the command line:~~

89 81

90```bash theme={null}82```bash theme={null}

91claude --remote "Fix the authentication bug in src/auth/login.ts"83claude --remote "Fix the authentication bug in src/auth/login.ts"

92```84```

93 85

~~94#### Tips for background tasks~~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

95 89

~~96**Plan locally, execute remotely**: For complex tasks, start Claude in plan mode to collaborate on the approach before sending work to the web:~~90**Plan locally, execute remotely**: For complex tasks, start Claude in plan mode to collaborate on the approach, then send work to the web:

97 91

98```bash theme={null}92```bash theme={null}

99claude --permission-mode plan93claude --permission-mode plan

100```94```

101 95

102In plan mode, Claude can only read files and explore the codebase. Once you're satisfied with the plan, send it to the web for autonomous execution: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:

103 97

104```98```bash theme={null}

105& Execute the migration plan we discussed99claude --remote "Execute the migration plan in docs/migration-plan.md"

106```100```

107 101

108This pattern gives you control over the strategy while letting Claude execute autonomously in the cloud.102This pattern gives you control over the strategy while letting Claude execute autonomously in the cloud.

109 103

110**Run tasks in parallel**: Each `&` command creates its own web session that runs independently. You can kick off multiple tasks and they'll all run simultaneously in separate sessions: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:

111 105

112```106```bash theme={null}

113& Fix the flaky test in auth.spec.ts107claude --remote "Fix the flaky test in auth.spec.ts"

114& Update the API documentation108claude --remote "Update the API documentation"

115& Refactor the logger to use structured output109claude --remote "Refactor the logger to use structured output"

116```110```

117 111

118Monitor 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.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.

168Enable repository access verification and/or withhold your name from your shared162Enable repository access verification and/or withhold your name from your shared

169sessions by going to Settings > Claude Code > Sharing settings.163sessions by going to Settings > Claude Code > Sharing settings.

170 164

165## Managing sessions

166

167### Archiving sessions

168

169You 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.

170

171To archive a session, hover over the session in the sidebar and click the archive icon.

172

173### Deleting sessions

174

175Deleting a session permanently removes the session and its data. This action cannot be undone. You can delete a session in two ways:

176

177* **From the sidebar**: Filter for archived sessions, then hover over the session you want to delete and click the delete icon

178* **From the session menu**: Open a session, click the dropdown next to the session title, and select **Delete**

179

180You will be asked to confirm before a session is deleted.

181

171## Cloud environment182## Cloud environment

172 183

173### Default image184### Default image

216 227

217When you start a session in Claude Code on the web, here's what happens under the hood:228When you start a session in Claude Code on the web, here's what happens under the hood:

218 229

2191. **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.2301. **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.

220 231

2212. **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.2322. **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.

222 233

228 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.239 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.

229</Note>240</Note>

230 241

231**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.242**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).

232 243

233**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.244**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.

234 245

235**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 `&` or `--remote`. With a single environment, this command shows your current configuration.246**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.

236 247

237<Note>248<Note>

238 Environment variables must be specified as key-value pairs, in [`.env` format](https://www.dotenv.org/). For example:249 Environment variables must be specified as key-value pairs, in [`.env` format](https://www.dotenv.org/). For example:

239 250

240 ```251 ```text theme={null}

241 API_KEY=your_api_key252 API_KEY=your_api_key

242 DEBUG=true253 DEBUG=true

243 ```254 ```

244</Note>255</Note>

245 256

257### Setup scripts

258

259A 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).

260

261Scripts run as root on Ubuntu 24.04, so `apt install` and most language package managers work.

262

263<Tip>

264 To check what's already installed before adding it to your script, ask Claude to run `check-tools` in a cloud session.

265</Tip>

266

267To add a setup script, open the environment settings dialog and enter your script in the **Setup script** field.

268

269This example installs the `gh` CLI, which isn't in the default image:

270

271```bash theme={null}

272#!/bin/bash

273apt update && apt install -y gh

274```

275

276Setup scripts run only when creating a new session. They are skipped when resuming an existing session.

277

278If 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.

279

280<Note>

281 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.

282</Note>

283

284#### Setup scripts vs. SessionStart hooks

285

286Use 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`.

287

288Both run at the start of a session, but they belong to different places:

289

290| | Setup scripts | SessionStart hooks |

291| ------------- | ------------------------------------------------- | -------------------------------------------------------------- |

292| Attached to | The cloud environment | Your repository |

293| Configured in | Cloud environment UI | `.claude/settings.json` in your repo |

294| Runs | Before Claude Code launches, on new sessions only | After Claude Code launches, on every session including resumed |

295| Scope | Cloud environments only | Both local and cloud |

296

297SessionStart 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.

298

246### Dependency management299### Dependency management

247 300

248Configure automatic dependency installation using [SessionStart hooks](/en/hooks#sessionstart). This can be configured in your repository's `.claude/settings.json` file:301Custom 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).

302

303To configure automatic dependency installation with a setup script, open your environment settings and add a script:

304

305```bash theme={null}

306#!/bin/bash

307npm install

308pip install -r requirements.txt

309```

310

311Alternatively, you can use SessionStart hooks in your repository's `.claude/settings.json` file for dependency installation that should also run in local environments:

249 312

250```json theme={null}313```json theme={null}

251{314{

269 332

270```bash theme={null}333```bash theme={null}

271#!/bin/bash334#!/bin/bash

272npm install

273pip install -r requirements.txt

274exit 0

275```

~~276~~

277Make it executable: `chmod +x scripts/install_pkgs.sh`

~~278~~

279#### Local vs remote execution

280 335

281By 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.336# Only run in remote environments

~~282~~

283```bash theme={null}

284#!/bin/bash

~~285~~

286# Example: Only run in remote environments

287if [ "$CLAUDE_CODE_REMOTE" != "true" ]; then337if [ "$CLAUDE_CODE_REMOTE" != "true" ]; then

288 exit 0338 exit 0

289fi339fi

290 340

291npm install341npm install

292pip install -r requirements.txt342pip install -r requirements.txt

343exit 0

293```344```

294 345

295#### Persisting environment variables346Make it executable: `chmod +x scripts/install_pkgs.sh`

347

348#### Persist environment variables

349

350SessionStart 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.

351

352#### Dependency management limitations

296 353

297SessionStart 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.354* **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.

355* **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.

356* **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.

357* **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.

298 358

299## Network access and security359## Network access and security

300 360

601 661

602## Best practices662## Best practices

603 663

6041. **Use Claude Code hooks**: Configure [SessionStart hooks](/en/hooks#sessionstart) to automate environment setup and dependency installation.6641. **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).

6052. **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.6652. **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.

606 666

607## Related resources667## Related resources

cli-reference.md +35 −80

Details

8 8

9## CLI commands9## CLI commands

10 10

11You can start sessions, pipe content, resume conversations, and manage updates with these commands:

~~12| :------------------------------ | :----------------------------------------------------- | :------------------------------------------------ |~~14| :------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |

23| `claude auth login` | Sign in to your Anthropic account. Use `--email` to pre-fill your email address and `--sso` to force SSO authentication | `claude auth login --email user@example.com --sso` |

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` |

28| `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"` |

22 29

23## CLI flags30## CLI flags

24 31

25Customize Claude Code's behavior with these command-line flags:32Customize Claude Code's behavior with these command-line flags:

26 33

28| :------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |35| :------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |

31| `--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| `--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"}}'` |

32| `--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` |39| `--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` |

33| `--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"` |40| `--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"` |

35| `--append-system-prompt-file` | Load additional system prompt text from a file and append to the default prompt (print mode only) | `claude -p --append-system-prompt-file ./extra-rules.txt "query"` |42| `--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` |

50| `--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` |

44| `--fork-session` | When resuming, create a new session ID instead of reusing the original (use with `--resume` or `--continue`) | `claude --resume abc123 --fork-session` |52| `--fork-session` | When resuming, create a new session ID instead of reusing the original (use with `--resume` or `--continue`) | `claude --resume abc123 --fork-session` |

45| `--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` |53| `--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` |

54| `--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"` |62| `--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"` |

56| `--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-5-20250929` |64| `--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` |

65| `--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>`. [`/rename`](/en/commands) changes the name mid-session and also shows it on the prompt bar | `claude -n "my-feature-work"` |

58| `--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"` |67| `--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"` |

63| `--print`, `-p` | Print response without interactive mode (see [Agent SDK documentation](https://platform.claude.com/docs/en/agent-sdk/overview) for programmatic usage details) | `claude -p "query"` |72| `--print`, `-p` | Print response without interactive mode (see [Agent SDK documentation](https://platform.claude.com/docs/en/agent-sdk/overview) for programmatic usage details) | `claude -p "query"` |

74| `--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"` |

73| `--tools` | Restrict which built-in tools Claude can use (works in both interactive and print modes). Use `""` to disable all, `"default"` for all, or tool names like `"Bash,Edit,Read"` | `claude --tools "Bash,Edit,Read"` |83| `--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` |

85| `--verbose` | Enable verbose logging, shows full turn-by-turn output | `claude --verbose` |

76 87| `--worktree`, `-w` | Start Claude in an isolated [git worktree](/en/common-workflows#run-parallel-claude-code-sessions-with-git-worktrees) at `<repo>/.claude/worktrees/<name>`. If no name is given, one is auto-generated | `claude -w feature-auth` |

~~77<Tip>~~

~~78 The `--output-format json` flag is particularly useful for scripting and~~

~~79 automation, allowing you to parse Claude's responses programmatically.~~

~~80</Tip>~~

~~82### Agents flag format~~

~~84The `--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:~~

~~86| Field | Required | Description |~~

~~87| :------------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------- |~~

~~88| `description` | Yes | Natural language description of when the subagent should be invoked |~~

~~89| `prompt` | Yes | The system prompt that guides the subagent's behavior |~~

~~90| `tools` | No | Array of specific tools the subagent can use (for example, `["Read", "Edit", "Bash"]`). If omitted, inherits all tools |~~

~~91| `model` | No | Model alias to use: `sonnet`, `opus`, `haiku`, or `inherit`. If omitted, defaults to `inherit` (uses the main conversation's model) |~~

~~93Example:~~

~~95```bash theme={null}~~

~~96claude --agents '{~~

~~97 "code-reviewer": {~~

~~98 "description": "Expert code reviewer. Use proactively after code changes.",~~

~~99 "prompt": "You are a senior code reviewer. Focus on code quality, security, and best practices.",~~

100 "tools": ["Read", "Grep", "Glob", "Bash"],

101 "model": "sonnet"

102 },

103 "debugger": {

104 "description": "Debugging specialist for errors and test failures.",

105 "prompt": "You are an expert debugger. Analyze errors, identify root causes, and provide fixes."

106 }

107}'

108```

~~109~~

110For more details on creating and using subagents, see the [subagents documentation](/en/sub-agents).

111 88

112### System prompt flags89### System prompt flags

113 90

114Claude Code provides four flags for customizing the system prompt, each serving a different purpose:91Claude Code provides four flags for customizing the system prompt. All four work in both interactive and non-interactive modes.

~~115~~

117| :---------------------------- | :------------------------------------------ | :------------------ | :------------------------------------------------------------------- |

~~122~~

123**When to use each:**

~~124~~

125* **`--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.

126 ```bash theme={null}

127 claude --system-prompt "You are a Python expert who only writes type-annotated code"

128 ```

~~129~~

130* **`--system-prompt-file`**: Use when you want to load a custom prompt from a file, useful for team consistency or version-controlled prompt templates.

131 ```bash theme={null}

132 claude -p --system-prompt-file ./prompts/code-review.txt "Review this PR"

133 ```

~~134~~

135* **`--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.

136 ```bash theme={null}

137 claude --append-system-prompt "Always use TypeScript and include JSDoc comments"

138 ```

139 92

140* **`--append-system-prompt-file`**: Use when you want to append instructions from a file while keeping Claude Code's defaults. Useful for version-controlled additions.93| Flag | Behavior | Example |

141 ```bash theme={null}94| :---------------------------- | :------------------------------------------ | :------------------------------------------------------ |

142 claude -p --append-system-prompt-file ./prompts/style-rules.txt "Review this PR"95| `--system-prompt` | Replaces the entire default prompt | `claude --system-prompt "You are a Python expert"` |

143 ```96| `--system-prompt-file` | Replaces with file contents | `claude --system-prompt-file ./prompts/review.txt` |

97| `--append-system-prompt` | Appends to the default prompt | `claude --append-system-prompt "Always use TypeScript"` |

98| `--append-system-prompt-file` | Appends file contents to the default prompt | `claude --append-system-prompt-file ./style-rules.txt` |

144 99

145`--system-prompt` and `--system-prompt-file` are mutually exclusive. The append flags can be used together with either replacement flag.100`--system-prompt` and `--system-prompt-file` are mutually exclusive. The append flags can be combined with either replacement flag.

146 101

147For most use cases, `--append-system-prompt` or `--append-system-prompt-file` is recommended as they preserve 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.102For 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.

148 103

149## See also104## See also

150 105

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. Reviews average \$15-25, 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 +88 −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` | Copy the last assistant response to clipboard. 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| `/fork [name]` | Create a fork of the current conversation at this point |

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 `CLAUDE.md` guide |

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 what was loaded and notes any changes that require a restart |

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| `/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 |

68| `/skills` | List available [skills](/en/skills) |

69| `/stats` | Visualize daily usage, session history, streaks, and model preferences |

70| `/status` | Open the Settings interface (Status tab) showing version, model, account, and connectivity |

71| `/statusline` | Configure Claude Code's [status line](/en/statusline). Describe what you want, or run without arguments to auto-configure from your shell prompt |

72| `/stickers` | Order Claude Code stickers |

73| `/tasks` | List and manage background tasks |

74| `/terminal-setup` | Configure terminal keybindings for Shift+Enter and other shortcuts. Only visible in terminals that need it, like VS Code, Alacritty, or Warp |

75| `/theme` | Change the color theme. Includes light and dark variants, colorblind-accessible (daltonized) themes, and ANSI themes that use your terminal's color palette |

76| `/upgrade` | Open the upgrade page to switch to a higher plan tier |

77| `/usage` | Show plan usage limits and rate limit status |

78| `/vim` | Toggle between Vim and Normal editing modes |

80## MCP prompts

82MCP 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.

84## See also

86* [Skills](/en/skills): create your own commands

87* [Interactive mode](/en/interactive-mode): keyboard shortcuts, Vim mode, and command history

88* [CLI reference](/en/cli-reference): launch-time flags

common-workflows.md +280 −186

Details

28 </Step>28 </Step>

29 29

30 <Step title="Ask for a high-level overview">30 <Step title="Ask for a high-level overview">

~~31 ```~~31 ```text theme={null}

~~32 > give me an overview of this codebase~~ 32 give me an overview of this codebase

33 ```33 ```

34 </Step>34 </Step>

35 35

36 <Step title="Dive deeper into specific components">36 <Step title="Dive deeper into specific components">

~~37 ```~~37 ```text theme={null}

~~38 > explain the main architecture patterns used here~~ 38 explain the main architecture patterns used here

39 ```39 ```

40 40

~~41 ```~~41 ```text theme={null}

~~42 > what are the key data models?~~42 what are the key data models?

43 ```43 ```

44 44

~~45 ```~~45 ```text theme={null}

~~46 > how is authentication handled?~~46 how is authentication handled?

47 ```47 ```

48 </Step>48 </Step>

49</Steps>49</Steps>

62 62

63<Steps>63<Steps>

64 <Step title="Ask Claude to find relevant files">64 <Step title="Ask Claude to find relevant files">

~~65 ```~~65 ```text theme={null}

~~66 > find the files that handle user authentication~~ 66 find the files that handle user authentication

67 ```67 ```

68 </Step>68 </Step>

69 69

70 <Step title="Get context on how components interact">70 <Step title="Get context on how components interact">

~~71 ```~~71 ```text theme={null}

~~72 > how do these authentication files work together?~~ 72 how do these authentication files work together?

73 ```73 ```

74 </Step>74 </Step>

75 75

76 <Step title="Understand the execution flow">76 <Step title="Understand the execution flow">

~~77 ```~~77 ```text theme={null}

~~78 > trace the login process from front-end to database~~ 78 trace the login process from front-end to database

79 ```79 ```

80 </Step>80 </Step>

81</Steps>81</Steps>

96 96

97<Steps>97<Steps>

98 <Step title="Share the error with Claude">98 <Step title="Share the error with Claude">

~~99 ```~~99 ```text theme={null}

100 > I'm seeing an error when I run npm test 100 I'm seeing an error when I run npm test

101 ```101 ```

102 </Step>102 </Step>

103 103

104 <Step title="Ask for fix recommendations">104 <Step title="Ask for fix recommendations">

105 ```105 ```text theme={null}

106 > 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

107 ```107 ```

108 </Step>108 </Step>

109 109

110 <Step title="Apply the fix">110 <Step title="Apply the fix">

111 ```111 ```text theme={null}

112 > update user.ts to add the null check you suggested 112 update user.ts to add the null check you suggested

113 ```113 ```

114 </Step>114 </Step>

115</Steps>115</Steps>

130 130

131<Steps>131<Steps>

132 <Step title="Identify legacy code for refactoring">132 <Step title="Identify legacy code for refactoring">

133 ```133 ```text theme={null}

134 > find deprecated API usage in our codebase 134 find deprecated API usage in our codebase

135 ```135 ```

136 </Step>136 </Step>

137 137

138 <Step title="Get refactoring recommendations">138 <Step title="Get refactoring recommendations">

139 ```139 ```text theme={null}

140 > suggest how to refactor utils.js to use modern JavaScript features 140 suggest how to refactor utils.js to use modern JavaScript features

141 ```141 ```

142 </Step>142 </Step>

143 143

144 <Step title="Apply the changes safely">144 <Step title="Apply the changes safely">

145 ```145 ```text theme={null}

146 > 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

147 ```147 ```

148 </Step>148 </Step>

149 149

150 <Step title="Verify the refactoring">150 <Step title="Verify the refactoring">

151 ```151 ```text theme={null}

152 > run tests for the refactored code 152 run tests for the refactored code

153 ```153 ```

154 </Step>154 </Step>

155</Steps>155</Steps>

170 170

171<Steps>171<Steps>

172 <Step title="View available subagents">172 <Step title="View available subagents">

173 ```173 ```text theme={null}

174 > /agents174 /agents

175 ```175 ```

176 176

177 This shows all available subagents and lets you create new ones.177 This shows all available subagents and lets you create new ones.

180 <Step title="Use subagents automatically">180 <Step title="Use subagents automatically">

181 Claude Code automatically delegates appropriate tasks to specialized subagents:181 Claude Code automatically delegates appropriate tasks to specialized subagents:

182 182

183 ```183 ```text theme={null}

184 > review my recent code changes for security issues184 review my recent code changes for security issues

185 ```185 ```

186 186

187 ```187 ```text theme={null}

188 > run all tests and fix any failures188 run all tests and fix any failures

189 ```189 ```

190 </Step>190 </Step>

191 191

192 <Step title="Explicitly request specific subagents">192 <Step title="Explicitly request specific subagents">

193 ```193 ```text theme={null}

194 > use the code-reviewer subagent to check the auth module194 use the code-reviewer subagent to check the auth module

195 ```195 ```

196 196

197 ```197 ```text theme={null}

198 > have the debugger subagent investigate why users can't log in198 have the debugger subagent investigate why users can't log in

199 ```199 ```

200 </Step>200 </Step>

201 201

202 <Step title="Create custom subagents for your workflow">202 <Step title="Create custom subagents for your workflow">

203 ```203 ```text theme={null}

204 > /agents204 /agents

205 ```205 ```

206 206

207 Then select "Create New subagent" and follow the prompts to define:207 Then select "Create New subagent" and follow the prompts to define:

226 226

227## Use Plan Mode for safe code analysis227## Use Plan Mode for safe code analysis

228 228

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/settings#tools-available-to-claude) to gather requirements and clarify your goals before proposing a plan.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.

230 230

231### When to use Plan Mode231### When to use Plan Mode

232 232

264claude --permission-mode plan264claude --permission-mode plan

265```265```

266 266

267```267```text theme={null}

268> 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.

269```269```

270 270

271Claude analyzes 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:

272 272

273```text theme={null}

274What about backward compatibility?

273```275```

274> What about backward compatibility?276

275> How should we handle database migration?277```text theme={null}

278How should we handle database migration?

276```279```

277 280

278<Tip>Press `Ctrl+G` to open the plan in your default text editor, where you can edit it directly before Claude proceeds.</Tip>281<Tip>Press `Ctrl+G` to open the plan in your default text editor, where you can edit it directly before Claude proceeds.</Tip>

298 301

299<Steps>302<Steps>

300 <Step title="Identify untested code">303 <Step title="Identify untested code">

301 ```304 ```text theme={null}

302 > find functions in NotificationsService.swift that are not covered by tests 305 find functions in NotificationsService.swift that are not covered by tests

303 ```306 ```

304 </Step>307 </Step>

305 308

306 <Step title="Generate test scaffolding">309 <Step title="Generate test scaffolding">

307 ```310 ```text theme={null}

308 > add tests for the notification service 311 add tests for the notification service

309 ```312 ```

310 </Step>313 </Step>

311 314

312 <Step title="Add meaningful test cases">315 <Step title="Add meaningful test cases">

313 ```316 ```text theme={null}

314 > add test cases for edge conditions in the notification service 317 add test cases for edge conditions in the notification service

315 ```318 ```

316 </Step>319 </Step>

317 320

318 <Step title="Run and verify tests">321 <Step title="Run and verify tests">

319 ```322 ```text theme={null}

320 > run the new tests and fix any failures 323 run the new tests and fix any failures

321 ```324 ```

322 </Step>325 </Step>

323</Steps>326</Steps>

330 333

331## Create pull requests334## Create pull requests

332 335

333You can create pull requests by asking Claude directly ("create a pr for my changes") or by using the `/commit-push-pr` skill, which commits, pushes, and opens a PR in one step.336You can create pull requests by asking Claude directly ("create a pr for my changes"), or guide Claude through it step-by-step:

~~334~~

335```

336> /commit-push-pr

337```

~~338~~

339If you have a Slack MCP server configured and specify channels in your CLAUDE.md (for example, "post PR URLs to #team-prs"), the skill automatically posts the PR URL to those channels.

~~340~~

341For more control over the process, guide Claude through it step-by-step or [create your own skill](/en/skills):

342 337

343<Steps>338<Steps>

344 <Step title="Summarize your changes">339 <Step title="Summarize your changes">

345 ```340 ```text theme={null}

346 > summarize the changes I've made to the authentication module341 summarize the changes I've made to the authentication module

347 ```342 ```

348 </Step>343 </Step>

349 344

350 <Step title="Generate a pull request">345 <Step title="Generate a pull request">

351 ```346 ```text theme={null}

352 > create a pr347 create a pr

353 ```348 ```

354 </Step>349 </Step>

355 350

356 <Step title="Review and refine">351 <Step title="Review and refine">

357 ```352 ```text theme={null}

358 > enhance the PR description with more context about the security improvements353 enhance the PR description with more context about the security improvements

359 ```354 ```

360 </Step>355 </Step>

361</Steps>356</Steps>

372 367

373<Steps>368<Steps>

374 <Step title="Identify undocumented code">369 <Step title="Identify undocumented code">

375 ```370 ```text theme={null}

376 > find functions without proper JSDoc comments in the auth module 371 find functions without proper JSDoc comments in the auth module

377 ```372 ```

378 </Step>373 </Step>

379 374

380 <Step title="Generate documentation">375 <Step title="Generate documentation">

381 ```376 ```text theme={null}

382 > add JSDoc comments to the undocumented functions in auth.js 377 add JSDoc comments to the undocumented functions in auth.js

383 ```378 ```

384 </Step>379 </Step>

385 380

386 <Step title="Review and enhance">381 <Step title="Review and enhance">

387 ```382 ```text theme={null}

388 > improve the generated documentation with more context and examples 383 improve the generated documentation with more context and examples

389 ```384 ```

390 </Step>385 </Step>

391 386

392 <Step title="Verify documentation">387 <Step title="Verify documentation">

393 ```388 ```text theme={null}

394 > check if the documentation follows our project standards 389 check if the documentation follows our project standards

395 ```390 ```

396 </Step>391 </Step>

397</Steps>392</Steps>

420 </Step>415 </Step>

421 416

422 <Step title="Ask Claude to analyze the image">417 <Step title="Ask Claude to analyze the image">

423 ```418 ```text theme={null}

424 > What does this image show?419 What does this image show?

425 ```420 ```

426 421

427 ```422 ```text theme={null}

428 > Describe the UI elements in this screenshot423 Describe the UI elements in this screenshot

429 ```424 ```

430 425

431 ```426 ```text theme={null}

432 > Are there any problematic elements in this diagram?427 Are there any problematic elements in this diagram?

433 ```428 ```

434 </Step>429 </Step>

435 430

436 <Step title="Use images for context">431 <Step title="Use images for context">

437 ```432 ```text theme={null}

438 > Here's a screenshot of the error. What's causing it?433 Here's a screenshot of the error. What's causing it?

439 ```434 ```

440 435

441 ```436 ```text theme={null}

442 > This is our current database schema. How should we modify it for the new feature?437 This is our current database schema. How should we modify it for the new feature?

443 ```438 ```

444 </Step>439 </Step>

445 440

446 <Step title="Get code suggestions from visual content">441 <Step title="Get code suggestions from visual content">

447 ```442 ```text theme={null}

448 > Generate CSS to match this design mockup443 Generate CSS to match this design mockup

449 ```444 ```

450 445

451 ```446 ```text theme={null}

452 > What HTML structure would recreate this component?447 What HTML structure would recreate this component?

453 ```448 ```

454 </Step>449 </Step>

455</Steps>450</Steps>

472 467

473<Steps>468<Steps>

474 <Step title="Reference a single file">469 <Step title="Reference a single file">

475 ```470 ```text theme={null}

476 > Explain the logic in @src/utils/auth.js471 Explain the logic in @src/utils/auth.js

477 ```472 ```

478 473

479 This includes the full content of the file in the conversation.474 This includes the full content of the file in the conversation.

480 </Step>475 </Step>

481 476

482 <Step title="Reference a directory">477 <Step title="Reference a directory">

483 ```478 ```text theme={null}

484 > What's the structure of @src/components?479 What's the structure of @src/components?

485 ```480 ```

486 481

487 This provides a directory listing with file information.482 This provides a directory listing with file information.

488 </Step>483 </Step>

489 484

490 <Step title="Reference MCP resources">485 <Step title="Reference MCP resources">

491 ```486 ```text theme={null}

492 > Show me the data from @github:repos/owner/repo/issues487 Show me the data from @github:repos/owner/repo/issues

493 ```488 ```

494 489

495 This fetches data from connected MCP servers using the format @server:resource. See [MCP resources](/en/mcp#use-mcp-resources) for details.490 This fetches data from connected MCP servers using the format @server:resource. See [MCP resources](/en/mcp#use-mcp-resources) for details.

509 504

510## Use extended thinking (thinking mode)505## Use extended thinking (thinking mode)

511 506

512[Extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) is enabled by default, reserving a portion of the output token budget (up to 31,999 tokens) for Claude to reason through complex problems step-by-step. This reasoning is visible in verbose mode, which you can toggle on with `Ctrl+O`.507[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`.

508

509Additionally, 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.

513 510

514Extended thinking is particularly valuable for complex architectural decisions, challenging bugs, multi-step implementation planning, and evaluating tradeoffs between different approaches. It provides more space for exploring multiple solutions, analyzing edge cases, and self-correcting mistakes.511Extended thinking is particularly valuable for complex architectural decisions, challenging bugs, multi-step implementation planning, and evaluating tradeoffs between different approaches.

515 512

516<Note>513<Note>

517 Phrases like "think", "think hard", "ultrathink", and "think more" are interpreted as regular prompt instructions and don't allocate thinking tokens.514 Phrases like "think", "think hard", and "think more" are interpreted as regular prompt instructions and don't allocate thinking tokens.

518</Note>515</Note>

519 516

520### Configure thinking mode517### Configure thinking mode

522Thinking is enabled by default, but you can adjust or disable it.519Thinking is enabled by default, but you can adjust or disable it.

523 520

525| ---------------------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |522| ------------------------ | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |

526| **Toggle shortcut** | Press `Option+T` (macOS) or `Alt+T` (Windows/Linux) | Toggle thinking on/off for the current session. May require [terminal configuration](/en/terminal-config) to enable Option key shortcuts |523| **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) |

527| **Global default** | Use `/config` to toggle thinking mode | Sets your default across all projects. Saved as `alwaysThinkingEnabled` in `~/.claude/settings.json` |524| **`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 |

528| **Limit token budget** | Set [`MAX_THINKING_TOKENS`](/en/settings#environment-variables) environment variable | Limit the thinking budget to a specific number of tokens. Example: `export MAX_THINKING_TOKENS=10000` |525| **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 |

526| **Global default** | Use `/config` to toggle thinking mode | Sets your default across all projects (all models). Saved as `alwaysThinkingEnabled` in `~/.claude/settings.json` |

527| **Limit token budget** | Set [`MAX_THINKING_TOKENS`](/en/env-vars) environment variable | Limit the thinking budget to a specific number of tokens (ignored on Opus 4.6 and Sonnet 4.6 unless set to 0). Example: `export MAX_THINKING_TOKENS=10000` |

529 528

530To view Claude's thinking process, press `Ctrl+O` to toggle verbose mode and see the internal reasoning displayed as gray italic text.529To view Claude's thinking process, press `Ctrl+O` to toggle verbose mode and see the internal reasoning displayed as gray italic text.

531 530

532### How extended thinking token budgets work531### How extended thinking works

533 532

534Extended thinking uses a **token budget** that controls how much internal reasoning Claude can perform before responding.533Extended 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.

535 534

536A larger thinking token budget provides:535**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.

537 536

538* More space to explore multiple solution approaches step-by-step537**With older models**, thinking uses a fixed budget of up to 31,999 tokens from your output budget. You can limit this with the [`MAX_THINKING_TOKENS`](/en/env-vars) environment variable, or disable thinking entirely via `/config` or the `Option+T`/`Alt+T` toggle.

539* Room to analyze edge cases and evaluate tradeoffs thoroughly

540* Ability to revise reasoning and self-correct mistakes

541 538

542Token budgets for thinking mode:539`MAX_THINKING_TOKENS` is ignored on Opus 4.6 and Sonnet 4.6, since adaptive reasoning controls thinking depth instead. The one exception: setting `MAX_THINKING_TOKENS=0` still disables thinking entirely on any model. To disable adaptive thinking and revert to the fixed thinking budget, set `CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING=1`. See [environment variables](/en/env-vars).

~~543~~

544* When thinking is **enabled**, Claude can use up to **31,999 tokens** from your output budget for internal reasoning

545* When thinking is **disabled** (via toggle or `/config`), Claude uses **0 tokens** for thinking

~~546~~

547**Limit the thinking budget:**

~~548~~

549* Use the [`MAX_THINKING_TOKENS` environment variable](/en/settings#environment-variables) to cap the thinking budget

550* When set, this value limits the maximum tokens Claude can use for thinking

551* See the [extended thinking documentation](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for valid token ranges

552 540

553<Warning>541<Warning>

554 You're charged for all thinking tokens used, even though Claude 4 models show summarized thinking542 You're charged for all thinking tokens used, even though Claude 4 models show summarized thinking

573Give sessions descriptive names to find them later. This is a best practice when working on multiple tasks or features.561Give sessions descriptive names to find them later. This is a best practice when working on multiple tasks or features.

574 562

575<Steps>563<Steps>

576 <Step title="Name the current session">564 <Step title="Name the session">

577 Use `/rename` during a session to give it a memorable name:565 Name a session at startup with `-n`:

578 566

567 ```bash theme={null}

568 claude -n auth-refactor

579 ```569 ```

580 > /rename auth-refactor570

571 Or use `/rename` during a session, which also shows the name on the prompt bar:

572

573 ```text theme={null}

574 /rename auth-refactor

581 ```575 ```

582 576

583 You can also rename any session from the picker: run `/resume`, navigate to a session, and press `R`.577 You can also rename any session from the picker: run `/resume`, navigate to a session, and press `R`.

592 586

593 Or from inside an active session:587 Or from inside an active session:

594 588

595 ```589 ```text theme={null}

596 > /resume auth-refactor590 /resume auth-refactor

597 ```591 ```

598 </Step>592 </Step>

599</Steps>593</Steps>

650 644

651## Run parallel Claude Code sessions with Git worktrees645## Run parallel Claude Code sessions with Git worktrees

652 646

653Suppose you need to work on multiple tasks simultaneously with complete code isolation between Claude Code instances.647When 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.

654 648

655<Steps>649Use 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:

656 <Step title="Understand Git worktrees">

657 Git worktrees allow you to check out multiple branches from the same

658 repository into separate directories. Each worktree has its own working

659 directory with isolated files, while sharing the same Git history. Learn

660 more in the [official Git worktree

661 documentation](https://git-scm.com/docs/git-worktree).

662 </Step>

663 650

664 <Step title="Create a new worktree">651```bash theme={null}

665 ```bash theme={null}652# Start Claude in a worktree named "feature-auth"

666 # Create a new worktree with a new branch 653# Creates .claude/worktrees/feature-auth/ with a new branch

667 git worktree add ../project-feature-a -b feature-a654claude --worktree feature-auth

668 655

669 # Or create a worktree with an existing branch656# Start another session in a separate worktree

670 git worktree add ../project-bugfix bugfix-123657claude --worktree bugfix-123

671 ```658```

672 659

673 This creates a new directory with a separate working copy of your repository.660If you omit the name, Claude generates a random one automatically:

674 </Step>

675 661

676 <Step title="Run Claude Code in each worktree">662```bash theme={null}

677 ```bash theme={null}663# Auto-generates a name like "bright-running-fox"

678 # Navigate to your worktree 664claude --worktree

679 cd ../project-feature-a665```

680 666

681 # Run Claude Code in this isolated environment667Worktrees are created at `<repo>/.claude/worktrees/<name>` and branch from the default remote branch. The worktree branch is named `worktree-<name>`.

682 claude

683 ```

684 </Step>

685 668

686 <Step title="Run Claude in another worktree">669You can also ask Claude to "work in a worktree" or "start a worktree" during a session, and it will create one automatically.

687 ```bash theme={null}670

688 cd ../project-bugfix671### Subagent worktrees

689 claude672

673Subagents 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.

674

675### Worktree cleanup

676

677When you exit a worktree session, Claude handles cleanup based on whether you made changes:

678

679* **No changes**: the worktree and its branch are removed automatically

680* **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

681

682To clean up worktrees outside of a Claude session, use [manual worktree management](#manage-worktrees-manually).

683

684<Tip>

685 Add `.claude/worktrees/` to your `.gitignore` to prevent worktree contents from appearing as untracked files in your main repository.

686</Tip>

687

688### Manage worktrees manually

689

690For 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.

691

692```bash theme={null}

693# Create a worktree with a new branch

694git worktree add ../project-feature-a -b feature-a

695

696# Create a worktree with an existing branch

697git worktree add ../project-bugfix bugfix-123

698

699# Start Claude in the worktree

700cd ../project-feature-a && claude

701

702# Clean up when done

703git worktree list

704git worktree remove ../project-feature-a

705```

706

707Learn more in the [official Git worktree documentation](https://git-scm.com/docs/git-worktree).

708

709<Tip>

710 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.

711</Tip>

712

713### Non-git version control

714

715Worktree 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`.

716

717For automated coordination of parallel sessions with shared tasks and messaging, see [agent teams](/en/agent-teams).

718

719***

720

721## Get notified when Claude needs your attention

722

723When 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.

724

725<Steps>

726 <Step title="Add the hook to your settings">

727 Open `~/.claude/settings.json` and add a `Notification` hook that calls your platform's native notification command:

728

729 <Tabs>

730 <Tab title="macOS">

731 ```json theme={null}

732 {

733 "hooks": {

734 "Notification": [

735 {

736 "matcher": "",

737 "hooks": [

738 {

739 "type": "command",

740 "command": "osascript -e 'display notification \"Claude Code needs your attention\" with title \"Claude Code\"'"

741 }

742 ]

743 }

744 ]

745 }

746 }

747 ```

748 </Tab>

749

750 <Tab title="Linux">

751 ```json theme={null}

752 {

753 "hooks": {

754 "Notification": [

755 {

756 "matcher": "",

757 "hooks": [

758 {

759 "type": "command",

760 "command": "notify-send 'Claude Code' 'Claude Code needs your attention'"

761 }

762 ]

763 }

764 ]

765 }

766 }

767 ```

768 </Tab>

769

770 <Tab title="Windows">

771 ```json theme={null}

772 {

773 "hooks": {

774 "Notification": [

775 {

776 "matcher": "",

777 "hooks": [

778 {

779 "type": "command",

780 "command": "powershell.exe -Command \"[System.Reflection.Assembly]::LoadWithPartialName('System.Windows.Forms'); [System.Windows.Forms.MessageBox]::Show('Claude Code needs your attention', 'Claude Code')\""

781 }

782 ]

783 }

784 ]

785 }

786 }

690 ```787 ```

788 </Tab>

789 </Tabs>

790

791 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.

691 </Step>792 </Step>

692 793

693 <Step title="Manage your worktrees">794 <Step title="Optionally narrow the matcher">

694 ```bash theme={null}795 By default the hook fires on all notification types. To fire only for specific events, set the `matcher` field to one of these values:

695 # List all worktrees

696 git worktree list

697 796

698 # Remove a worktree when done797 | Matcher | Fires when |

699 git worktree remove ../project-feature-a798 | :------------------- | :---------------------------------------------- |

700 ```799 | `permission_prompt` | Claude needs you to approve a tool use |

800 | `idle_prompt` | Claude is done and waiting for your next prompt |

801 | `auth_success` | Authentication completes |

802 | `elicitation_dialog` | Claude is asking you a question |

701 </Step>803 </Step>

702</Steps>

703 804

704<Tip>805 <Step title="Verify the hook">

705 Tips:806 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.

807 </Step>

808</Steps>

706 809

707 * Each worktree has its own independent file state, making it perfect for parallel Claude Code sessions810For the complete event schema and notification types, see the [Notification reference](/en/hooks#notification).

708 * Changes made in one worktree won't affect others, preventing Claude instances from interfering with each other

709 * All worktrees share the same Git history and remote connections

710 * For long-running tasks, you can have Claude working in one worktree while you continue development in another

711 * Use descriptive directory names to easily identify which task each worktree is for

712 * Remember to initialize your development environment in each new worktree according to your project's setup. Depending on your stack, this might include:

713 * JavaScript projects: Running dependency installation (`npm install`, `yarn`)

714 * Python projects: Setting up virtual environments or installing with package managers

715 * Other languages: Following your project's standard setup process

716</Tip>

717 811

718***812***

719 813

808 902

809### Example questions903### Example questions

810 904

811```905```text theme={null}

812> can Claude Code create pull requests?906can Claude Code create pull requests?

813```907```

814 908

815```909```text theme={null}

816> how does Claude Code handle permissions?910how does Claude Code handle permissions?

817```911```

818 912

819```913```text theme={null}

820> what skills are available?914what skills are available?

821```915```

822 916

823```917```text theme={null}

824> how do I use MCP with Claude Code?918how do I use MCP with Claude Code?

825```919```

826 920

827```921```text theme={null}

828> how do I configure Claude Code for Amazon Bedrock?922how do I configure Claude Code for Amazon Bedrock?

829```923```

830 924

831```925```text theme={null}

832> what are the limitations of Claude Code?926what are the limitations of Claude Code?

833```927```

834 928

835<Note>929<Note>

costs.md +21 −5

Details

8 8

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.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.

10 10

11For 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.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.

12 12

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).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).

14 14

22 22

23The `/cost` command provides detailed token usage statistics for your current session:23The `/cost` command provides detailed token usage statistics for your current session:

24 24

~~25```~~25```text theme={null}

26Total cost: $0.5526Total cost: $0.55

27Total duration (API): 6m 19.7s27Total duration (API): 6m 19.7s

28Total duration (wall): 6h 33m 10.2s28Total duration (wall): 6h 33m 10.2s

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.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.

38</Note>38</Note>

39 39

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 we have not audited its security.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.

41 41

42### Rate limit recommendations42### Rate limit recommendations

43 43

54 54

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).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).

56 56

57The 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.

58 58

59<Note>59<Note>

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.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.

61</Note>61</Note>

62 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).

63## Reduce token usage75## Reduce token usage

64 76

65Token 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).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).

153 165

154### Adjust extended thinking166### Adjust extended thinking

155 167

156Extended thinking is enabled by default with a budget of 31,999 tokens because it significantly improves performance on complex planning and reasoning tasks. However, thinking tokens are billed as output tokens, so for simpler tasks where deep reasoning isn't needed, you can reduce costs by disabling it in `/config` or lowering the budget (for example, `MAX_THINKING_TOKENS=8000`).168Extended thinking is enabled by default with a budget of 31,999 tokens because it significantly improves performance on complex planning and reasoning tasks. However, thinking tokens are billed as output tokens, so 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 (for example, `MAX_THINKING_TOKENS=8000`).

157 169

158### Delegate verbose operations to subagents170### Delegate verbose operations to subagents

159 171

160Running 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.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.

161 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

162### Write specific prompts178### Write specific prompts

163 179

164Vague 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.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.

data-usage.md +5 −3

Details

42**Commercial users (Team, Enterprise, and API)**:42**Commercial users (Team, Enterprise, and API)**:

43 43

44* Standard: 30-day retention period44* Standard: 30-day retention period

~~45* 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

46* 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)

47 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).

48Learn 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/).

49 51

50For 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).

51 53

52## Data access54## Data access

53 55

54For 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). 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.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.

55 57

56## Local Claude Code: Data flow and dependencies58## Local Claude Code: Data flow and dependencies

57 59

58The 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.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.

59 61

60<img src="https://mintcdn.com/claude-code/I9Dpo7RZuIbc86cX/images/claude-code-data-flow.svg?fit=max&auto=format&n=I9Dpo7RZuIbc86cX&q=85&s=9e77f476347e7c9983f6e211d27cf6a9" 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" data-og-width="720" width="720" data-og-height="520" height="520" data-path="images/claude-code-data-flow.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/I9Dpo7RZuIbc86cX/images/claude-code-data-flow.svg?w=280&fit=max&auto=format&n=I9Dpo7RZuIbc86cX&q=85&s=94c033b9b6db3d10b9e2d7c6d681d9dc 280w, https://mintcdn.com/claude-code/I9Dpo7RZuIbc86cX/images/claude-code-data-flow.svg?w=560&fit=max&auto=format&n=I9Dpo7RZuIbc86cX&q=85&s=430aaaf77c28c501d5753ffa456ee227 560w, https://mintcdn.com/claude-code/I9Dpo7RZuIbc86cX/images/claude-code-data-flow.svg?w=840&fit=max&auto=format&n=I9Dpo7RZuIbc86cX&q=85&s=63c3c3f160b522220a8291fe2f93f970 840w, https://mintcdn.com/claude-code/I9Dpo7RZuIbc86cX/images/claude-code-data-flow.svg?w=1100&fit=max&auto=format&n=I9Dpo7RZuIbc86cX&q=85&s=a7f6e838482f4a1a0a0b4683439369ea 1100w, https://mintcdn.com/claude-code/I9Dpo7RZuIbc86cX/images/claude-code-data-flow.svg?w=1650&fit=max&auto=format&n=I9Dpo7RZuIbc86cX&q=85&s=5fbf749c2f94babb3ef72edfb7aba1e9 1650w, https://mintcdn.com/claude-code/I9Dpo7RZuIbc86cX/images/claude-code-data-flow.svg?w=2500&fit=max&auto=format&n=I9Dpo7RZuIbc86cX&q=85&s=7a1babbdccc4986957698d9c5c30c4a8 2500w" />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" />

61 63

62Claude 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.

63 65

desktop.md +486 −171

Details

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt2> 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.3> Use this file to discover all available pages before exploring further.

4 4

~~5# Claude Code on desktop~~5# Use Claude Code Desktop

6 6

~~7> Run Claude Code tasks locally or on secure cloud infrastructure with the Claude desktop app~~7> Get more out of Claude Code Desktop: parallel sessions with Git isolation, visual diff review, app previews, PR monitoring, permission modes, connectors, and enterprise configuration.

8 8

~~9<Note>~~9The Code tab within the Claude Desktop app lets you use Claude Code through a graphical interface instead of the terminal.

~~10 Claude Code on desktop is currently in preview.~~

~~11</Note>~~

12 10

13Claude Code is an AI coding assistant that works directly with your codebase. Unlike Claude.ai chat, it can read your project files, edit code, run terminal commands, and understand how different parts of your code connect. You watch changes happen in real time.11Desktop adds these capabilities on top of the standard Claude Code experience:

14 12

15You can use Claude Code through the terminal ([CLI](/en/quickstart)) or through the desktop app described here. Both provide the same core capabilities. The desktop app adds a graphical interface and visual session management.13* [Visual diff review](#review-changes-with-diff-view) with inline comments

14* [Live app preview](#preview-your-app) with dev servers

15* [GitHub PR monitoring](#monitor-pull-request-status) with auto-fix and auto-merge

16* [Parallel sessions](#work-in-parallel-with-sessions) with automatic Git worktree isolation

17* [Scheduled tasks](#schedule-recurring-tasks) that run Claude on a recurring schedule

18* [Connectors](#connect-external-tools) for GitHub, Slack, Linear, and more

19* Local, [SSH](#ssh-sessions), and [cloud](#run-long-running-tasks-remotely) environments

16 20

~~17<CardGroup cols={2}>~~21<Tip>

~~18 <Card title="New to Claude Code?" icon="rocket" href="#installation-and-setup">~~22 New to Desktop? Start with [Get started](/en/desktop-quickstart) to install the app and make your first edit.

~~19 Start here to install and make your first edit~~23</Tip>

~~20 </Card>~~

21 24

~~22 <Card title="Coming from the CLI?" icon="terminal" href="#how-desktop-relates-to-cli">~~25This page covers [working with code](#work-with-code), [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).

~~23 See what's shared and what's different~~

~~24 </Card>~~

~~25</CardGroup>~~

26 26

~~27The desktop app has three tabs:~~27## Start a session

28 28

~~29* **Chat**: A conversational interface for general questions and tasks (like Claude.ai)~~29Before you send your first message, configure four things in the prompt area:

~~30* **Cowork**: An autonomous agent that works on tasks in the background~~

~~31* **Code**: An AI coding assistant that reads and edits your project files directly~~

32 30

~~33This documentation covers the **Code** tab. For the chat interface, see the [Claude Desktop support articles](https://support.claude.com/en/collections/16163169-claude-desktop).~~31* **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).

32* **Project folder**: select the folder or repository Claude works in. For remote sessions, you can add [multiple repositories](#run-long-running-tasks-remotely).

33* **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.

34* **Permission mode**: choose how much autonomy Claude has from the [mode selector](#choose-a-permission-mode). You can change this during the session.

34 35

~~35## Installation and setup~~36Type your task and press **Enter** to start. Each session tracks its own context and changes independently.

36 37

~~37<Steps>~~38## Work with code

~~38 <Step title="Download the app">~~

~~39 Download Claude for your platform. You'll need an Anthropic account ([sign up at claude.ai](https://claude.ai) if you don't have one).~~

40 39

~~41 <CardGroup cols={2}>~~40Give Claude the right context, control how much it does on its own, and review what it changed.

~~42 <Card title="macOS" icon="apple" href="https://claude.ai/api/desktop/darwin/universal/dmg/latest/redirect?utm_source=claude_code&utm_medium=docs">~~

~~43 Universal build for Intel and Apple Silicon~~

~~44 </Card>~~

45 41

~~46 <Card title="Windows" icon="windows" href="https://claude.ai/api/desktop/win32/x64/exe/latest/redirect?utm_source=claude_code&utm_medium=docs">~~42### Use the prompt box

~~47 For x64 processors~~

~~48 </Card>~~

~~49 </CardGroup>~~

50 43

51 For Windows ARM64, [download here](https://claude.ai/api/desktop/win32/arm64/exe/latest/redirect?utm_source=claude_code\&utm_medium=docs). Local sessions are not available on ARM64 devices, so use remote sessions instead.44Type 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.

52 45

~~53 Linux is not currently supported.~~46The **+** button next to the prompt box gives you access to file attachments, [skills](#use-skills), [connectors](#connect-external-tools), and [plugins](#install-plugins).

~~54 </Step>~~

55 47

~~56 <Step title="Open the app and sign in">~~48### Add files and context to prompts

~~57 Launch Claude from your Applications folder (macOS) or Start menu (Windows). Sign in with your Anthropic account.~~

~~58 </Step>~~

59 49

~~60 <Step title="Select the Code tab">~~50The prompt box supports two ways to bring in external context:

~~61 Click the **Code** tab in the top left. If clicking Code prompts you to sign in online, complete the sign-in and restart the app.~~

~~62 </Step>~~

~~63</Steps>~~

64 51

~~65## Getting started~~52* **@mention files**: type `@` followed by a filename to add a file to the conversation context. Claude can then read and reference that file.

53* **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.

55### Choose a permission mode

66 56

~~67If you already use the CLI, you can skip to [How Desktop relates to CLI](#how-desktop-relates-to-cli) for a quick overview of differences.~~57Permission 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.

68 58

~~69<Steps>~~59| Mode | Settings key | Behavior |

~~70 <Step title="Choose a folder and environment">~~60| ---------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

~~71 Select **Local** to run Claude on your machine using your files directly. This is the best choice for getting started. Click **Select folder** and choose your project directory.~~61| **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. |

62| **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. |

63| **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. |

64| **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. |

72 65

~~73 You can also run [remote sessions](/en/claude-code-on-the-web) that continue in the cloud even if you close the app.~~66The `dontAsk` permission mode is available only in the [CLI](/en/permissions#permission-modes).

~~74 </Step>~~

75 67

~~76 <Step title="Start a session">~~68<Tip title="Best practice">

~~77 Type what you want Claude to do:~~69 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.

70</Tip>

78 71

~~79 * "Find a TODO comment and fix it"~~72Remote 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.

~~80 * "Add tests for the main function"~~

~~81 * "Create a CLAUDE.md with instructions for this codebase"~~

82 73

~~83 A **session** 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.~~74Enterprise admins can restrict which permission modes are available. See [enterprise configuration](#enterprise-configuration) for details.

~~84 </Step>~~

85 75

~~86 <Step title="Review and accept changes">~~76### Preview your app

~~87 By default, Code is in **Ask** mode, where Claude proposes changes and waits for your approval before applying them. You'll see:~~

88 77

~~89 1. **A diff view** showing exactly what will change in each file~~78Claude 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.

~~90 2. **Accept/Reject buttons** to approve or decline each change~~

~~91 3. **Real-time updates** as Claude works through your request~~

92 79

~~93 If you reject a change, Claude will ask how you'd like to proceed differently. Your files aren't modified until you accept.~~80From the preview panel, you can:

~~94 </Step>~~

~~95</Steps>~~

96 81

~~97The sections below cover commands, permission modes, parallel sessions, and ways to extend Claude Code with custom workflows and integrations.~~82* Interact with your running app directly in the embedded browser

83* Watch Claude verify its own changes automatically: it takes screenshots, inspects the DOM, clicks elements, fills forms, and fixes issues it finds

84* Start or stop servers from the **Preview** dropdown in the session toolbar

85* 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

86* Edit the server configuration or stop all servers at once

98 87

~~99## What you can do~~88Claude 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.

100 89

101Claude Code can edit files, run terminal commands, and understand how your code connects. Try prompts like:90To clear saved session data, toggle **Persist preview sessions** off in Settings → Claude Code. To disable preview entirely, toggle off **Preview** in Settings → Claude Code.

102 91

103* `Fix the bug in the login function`92### Review changes with diff view

104* `Run the tests and fix any failures`

105* `How does the authentication flow work?`

106 93

107You can rename, resume, and archive sessions through the sidebar.94After Claude makes changes to your code, the diff view lets you review modifications file by file before creating a pull request.

108 95

109### Choose a permission mode96When 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.

110 97

111Control how Claude works using the mode selector next to the send button:98To 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:

112 99

113* **Ask** (recommended for new users): Claude asks for your approval before each file edit or command. You see a diff view and can accept or reject each change.100* **macOS**: press **Cmd+Enter**

114* **Code**: Claude auto-accepts file edits but still asks before running terminal commands. Use this when you trust file changes and want faster iteration.101* **Windows**: press **Ctrl+Enter**

115* **Plan**: Claude creates a detailed plan for your approval before making any changes. Good for complex tasks where you want to review the approach first.

116 102

117To stop Claude mid-task, click the stop button.103Claude reads your comments and makes the requested changes, which appear as a new diff you can review.

118 104

119Remote sessions only support **Code** and **Plan** modes because they continue running in the background without requiring your active participation. See [permission modes](/en/permissions#permission-modes) for details on how these work internally.105### Review your code

120 106

121### Work in parallel with sessions107In 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.

122 108

123Click **+ 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 worktrees, so changes in one session don't affect another until you commit them. Worktrees are stored in `~/.claude-worktrees/` by default.109The 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.

110

111### Monitor pull request status

112

113After 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.

114

115* **Auto-fix**: when enabled, Claude automatically attempts to fix failing CI checks by reading the failure output and iterating.

116* **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.

117

118Use 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.

124 119

125<Note>120<Note>

126 Session isolation requires [Git](https://git-scm.com/downloads). Without Git, sessions in the same directory edit the same files, so changes in one session are immediately visible in others.121 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.

127</Note>122</Note>

128 123

129To include files listed in your `.gitignore` (like `.env`) in new worktrees, create a `.worktreeinclude` file in your project root listing the file patterns to copy.124## Manage sessions

125

126Each session is an independent conversation with its own context and changes. You can run multiple sessions in parallel or send work to the cloud.

127

128### Work in parallel with sessions

129

130Click **+ 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.

131

132Worktrees 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.

133

134<Note>

135 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.

136</Note>

130 137

131To manage a session, click its dropdown in the sidebar to rename it, archive it, or check context usage. When context fills up, Claude automatically summarizes the conversation. You can also ask Claude to compact if you want to free up space earlier.138Use 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.

132 139

133### Run long-running tasks remotely140### Run long-running tasks remotely

134 141

135For 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.142For 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.

136 143

137Remote sessions support **Code** and **Plan** modes. See [Claude Code on the web](/en/claude-code-on-the-web) for details on configuring remote environments.144Remote 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.

138 145

139### Review changes with diff view146See [Claude Code on the web](/en/claude-code-on-the-web) for more on how remote sessions work.

140 147

141After Claude makes changes to your code, the diff view lets you review modifications file by file before creating a pull request.148### Continue in another surface

142 149

143When Claude changes files, a diff stats indicator appears showing the number of lines added and removed (for example, `+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.150The **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:

144 151

145To comment on specific lines, click any line in the diff to open a comment box. Type your feedback and press **Enter** to send. In the full diff view, press **Enter** to accept each comment, then **Cmd+Enter** to send them all. Claude reads your comments and makes the requested changes, which appear as a new diff you can review.152* **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.

153* **Your IDE**: opens your project in a supported IDE at the current working directory.

146 154

147## Extend Claude Code155## Extend Claude Code

148 156

149You can extend Claude Code with custom commands, automated workflows, and external integrations.157Connect external services, add reusable workflows, customize Claude's behavior, and configure preview servers.

150 158

151### Connect external tools159### Connect external tools

152 160

153For local sessions, click the **...** button before starting and select **Connectors** to add integrations like Google Calendar, Slack, GitHub, Linear, Notion, and more. Connectors must be configured before the session starts and are only available for local sessions. Once 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.161For 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. Connectors are not available for remote sessions.

162

163To manage or disconnect connectors, go to Settings → Connectors in the desktop app, or select **Manage connectors** from the Connectors menu in the prompt box.

164

165Once 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.

166

167Connectors 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).

168

169### Use skills

170

171[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.

172

173### Install plugins

174

175[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.

176

177For 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.

178

179Plugins 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).

180

181### Configure preview servers

182

183Claude 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.

184

185To 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.

186

187```json theme={null}

188{

189 "version": "0.0.1",

190 "configurations": [

191 {

192 "name": "my-app",

193 "runtimeExecutable": "npm",

194 "runtimeArgs": ["run", "dev"],

195 "port": 3000

196 }

197 ]

198}

199```

200

201You can define multiple configurations to run different servers from the same project, such as a frontend and an API. See the [examples](#examples) below.

202

203#### Auto-verify changes

204

205When `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.

206

207Auto-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.

208

209```json theme={null}

210{

211 "version": "0.0.1",

212 "autoVerify": false,

213 "configurations": [...]

214}

215```

216

217When disabled, preview tools are still available and you can ask Claude to verify at any time. Auto-verify makes it automatic after every edit.

218

219#### Configuration fields

220

221Each entry in the `configurations` array accepts the following fields:

222

223| Field | Type | Description |

224| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

225| `name` | string | A unique identifier for this server |

226| `runtimeExecutable` | string | The command to run, such as `npm`, `yarn`, or `node` |

227| `runtimeArgs` | string\[] | Arguments passed to `runtimeExecutable`, such as `["run", "dev"]` |

228| `port` | number | The port your server listens on. Defaults to 3000 |

229| `cwd` | string | Working directory relative to your project root. Defaults to the project root. Use `${workspaceFolder}` to reference the project root explicitly |

230| `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. |

231| `autoPort` | boolean | How to handle port conflicts. See below |

232| `program` | string | A script to run with `node`. See [when to use `program` vs `runtimeExecutable`](#when-to-use-program-vs-runtimeexecutable) |

233| `args` | string\[] | Arguments passed to `program`. Only used when `program` is set |

234

235##### When to use `program` vs `runtimeExecutable`

236

237Use `runtimeExecutable` with `runtimeArgs` to start a dev server through a package manager. For example, `"runtimeExecutable": "npm"` with `"runtimeArgs": ["run", "dev"]` runs `npm run dev`.

238

239Use `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`.

240

241#### Port conflicts

242

243The `autoPort` field controls what happens when your preferred port is already in use:

244

245* **`true`**: Claude finds and uses a free port automatically. Suitable for most dev servers.

246* **`false`**: Claude fails with an error. Use this when your server must use a specific port, such as for OAuth callbacks or CORS allowlists.

247* **Not set (default)**: Claude asks whether the server needs that exact port, then saves your answer.

248

249When Claude picks a different port, it passes the assigned port to your server via the `PORT` environment variable.

250

251#### Examples

252

253These configurations show common setups for different project types:

254

255<Tabs>

256 <Tab title="Next.js">

257 This configuration runs a Next.js app using Yarn on port 3000:

258

259 ```json theme={null}

260 {

261 "version": "0.0.1",

262 "configurations": [

263 {

264 "name": "web",

265 "runtimeExecutable": "yarn",

266 "runtimeArgs": ["dev"],

267 "port": 3000

268 }

269 ]

270 }

271 ```

272 </Tab>

273

274 <Tab title="Multiple servers">

275 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:

276

277 ```json theme={null}

278 {

279 "version": "0.0.1",

280 "configurations": [

281 {

282 "name": "frontend",

283 "runtimeExecutable": "npm",

284 "runtimeArgs": ["run", "dev"],

285 "cwd": "apps/web",

286 "port": 3000,

287 "autoPort": true

288 },

289 {

290 "name": "api",

291 "runtimeExecutable": "npm",

292 "runtimeArgs": ["run", "start"],

293 "cwd": "server",

294 "port": 8080,

295 "env": { "NODE_ENV": "development" },

296 "autoPort": false

297 }

298 ]

299 }

300 ```

301 </Tab>

302

303 <Tab title="Node.js script">

304 To run a Node.js script directly instead of using a package manager command, use the `program` field:

305

306 ```json theme={null}

307 {

308 "version": "0.0.1",

309 "configurations": [

310 {

311 "name": "server",

312 "program": "server.js",

313 "args": ["--verbose"],

314 "port": 4000

315 }

316 ]

317 }

318 ```

319 </Tab>

320</Tabs>

321

322## Schedule recurring tasks

323

324Scheduled tasks start a new local 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.

325

326Tasks run on your machine, so the desktop app must be open and your computer awake for them to fire. See [How scheduled tasks run](#how-scheduled-tasks-run) for details on missed runs and catch-up behavior.

327

328<Note>

329 By default, 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.

330</Note>

331

332To create a scheduled task, click **Schedule** in the sidebar, then **+ New task**. Configure these fields:

333

334| Field | Description |

335| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

336| Name | Identifier for the task. Converted to lowercase kebab-case and used as the folder name on disk. Must be unique across your tasks. |

337| Description | Short summary shown in the task list. |

338| 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. |

339| Frequency | How often the task runs. See [frequency options](#frequency-options) below. |

340

341You 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."

342

343### Frequency options

344

345* **Manual**: no schedule, only runs when you click **Run now**. Useful for saving a prompt you trigger on demand

346* **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

347* **Daily**: shows a time picker, defaults to 9:00 AM local time

348* **Weekdays**: same as Daily but skips Saturday and Sunday

349* **Weekly**: shows a time picker and a day picker

350

351For 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."

352

353### How scheduled tasks run

354

355Scheduled tasks run locally 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.

356

357When 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.

358

359Tasks 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.

360

361### Missed runs

362

363When 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.

364

365Keep 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."

154 366

155Connectors are [MCP (Model Context Protocol) servers](/en/mcp) with built-in setup. You can also [create custom connectors](https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp) or add MCP servers manually via [configuration files](/en/mcp#configure-mcp-servers).367### Permissions for scheduled tasks

156 368

157### Create custom skills369Each 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.

158 370

159[Skills](/en/skills) are reusable prompts that extend Claude's capabilities. For example, you could create a `review` skill that runs your standard code review checklist, or a `deploy` skill that walks through your deployment steps. Skills are defined as markdown files in `.claude/skills/` and can include instructions, context, and even call other tools. Ask Claude what skills are available or to run a specific skill. Claude can also help you create a skill if you describe what you want, or see [skills](/en/skills) to learn how to write them yourself.371To 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.

160 372

161### Automate workflows with hooks373### Manage scheduled tasks

162 374

163[Hooks](/en/hooks) run shell commands automatically in response to Claude Code events. For example, you could run a linter after every file edit, auto-format code, or send notifications when tasks complete. Hooks are configured in your [settings files](/en/settings). See [hooks](/en/hooks) for available events and configuration examples.375Click a task in the **Schedule** list to open its detail page. From here you can:

376

377* **Run now**: start the task immediately without waiting for the next scheduled time

378* **Toggle repeats**: pause or resume scheduled runs without deleting the task

379* **Edit**: change the prompt, frequency, folder, or other settings

380* **Review history**: see every past run, including ones that were skipped because your computer was asleep

381* **Review allowed permissions**: see and revoke saved tool approvals for this task from the **Always allowed** panel

382* **Delete**: remove the task and archive all sessions it created

383

384You 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."

385

386To 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.

164 387

165## Environment configuration388## Environment configuration

166 389

167When starting a session, you choose between **Local** (runs on your machine) or **Remote** (runs on Anthropic's cloud).390The environment you pick when [starting a session](#start-a-session) determines where Claude executes and how you connect:

391

392* **Local**: runs on your machine with direct access to your files

393* **Remote**: runs on Anthropic's cloud infrastructure. Sessions continue even if you close the app.

394* **SSH**: runs on a remote machine you connect to over SSH, such as your own servers, cloud VMs, or dev containers

395

396### Local sessions

397

398Local 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.

399

400[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.

401

402### Remote sessions

403

404Remote 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.

405

406You 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.

407

408### SSH sessions

409

410SSH 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.

411

412To add an SSH connection, click the environment dropdown before starting a session and select **+ Add SSH connection**. The dialog asks for:

413

414* **Name**: a friendly label for this connection

415* **SSH Host**: `user@hostname` or a host defined in `~/.ssh/config`

416* **SSH Port**: defaults to 22 if left empty, or uses the port from your SSH config

417* **Identity File**: path to your private key, such as `~/.ssh/id_rsa`. Leave empty to use the default key or your SSH config.

418

419Once 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.

420

421Claude Code must be installed on the remote machine. Once connected, SSH sessions support permission modes, connectors, plugins, and MCP servers.

422

423## Enterprise configuration

424

425Organizations on Teams or Enterprise plans can manage desktop app behavior through admin console controls, managed settings files, and device management policies.

426

427### Admin console controls

428

429These settings are configured through the [admin settings console](https://claude.ai/admin-settings/claude-code):

430

431* **Enable or disable the Code tab**: control whether users in your organization can access Claude Code in the desktop app

432* **Disable Bypass permissions mode**: prevent users in your organization from enabling bypass permissions mode

433* **Disable Claude Code on the web**: enable or disable remote sessions for your organization

434

435### Managed settings

436

437Managed 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.

438

439| Key | Description |

440| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |

441| `disableBypassPermissionsMode` | set to `"disable"` to prevent users from enabling Bypass permissions mode. See [managed settings](/en/permissions#managed-only-settings). |

442

443For the complete list of managed-only settings including `allowManagedPermissionRulesOnly` and `allowManagedHooksOnly`, see [managed-only settings](/en/permissions#managed-only-settings).

444

445Remote 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.

446

447### Device management policies

448

449IT 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.

168 450

169**Local sessions** inherit environment variables from your shell. If you need additional variables, set them in your shell profile (`~/.zshrc`, `~/.bashrc`) and restart the desktop app. See [environment variables](/en/settings#environment-variables) for the full list of supported variables.451* **macOS**: configure via `com.anthropic.Claude` preference domain using tools like Jamf or Kandji

452* **Windows**: configure via registry at `SOFTWARE\Policies\Claude`

170 453

171[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. The thinking process runs in the background but isn't displayed in the Desktop interface. To disable it or adjust the budget, set `MAX_THINKING_TOKENS` in your shell profile (use `0` to disable).454### Authentication and SSO

172 455

173**Remote sessions** run on Anthropic's cloud infrastructure and continue even if you close the app. Usage counts toward your subscription plan limits with no separate compute charges. See [Claude Code on the web](/en/claude-code-on-the-web) for details on configuring remote environments.456Enterprise 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.

174 457

175## How Desktop relates to CLI458### Data handling

176 459

177If 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 (CLAUDE.md files).460Claude 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.

461

462### Deployment

463

464Desktop can be distributed through enterprise deployment tools:

465

466* **macOS**: distribute via MDM such as Jamf or Kandji using the `.dmg` installer

467* **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

468

469For network configuration such as proxy settings, firewall allowlisting, and LLM gateways, see [network configuration](/en/network-config).

470

471For the full enterprise configuration reference, see the [enterprise configuration guide](https://support.claude.com/en/articles/12622667-enterprise-configuration).

472

473## Coming from the CLI?

474

475If 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.

476

477To 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.

478

479<Tip>

480 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.

481</Tip>

178 482

179### CLI flag equivalents483### CLI flag equivalents

180 484

181If you're used to CLI flags, the table below shows the Desktop equivalent for each. Some flags have no Desktop equivalent because they're designed for scripting or automation.485This 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.

182 486

183| CLI | Desktop equivalent |487| CLI | Desktop equivalent |

184| ------------------------------------- | ---------------------------------------------- |488| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

494| `--allowedTools`, `--disallowedTools` | not available in Desktop |

495| `--verbose` | not available. Check system logs: Console.app on macOS, Event Viewer → Windows Logs → Application on Windows |

496| `--print`, `--output-format` | not available. Desktop is interactive only. |

497| `ANTHROPIC_MODEL` env var | model dropdown next to the send button |

498| `MAX_THINKING_TOKENS` env var | set in shell profile; applies to local sessions. See [environment configuration](#environment-configuration). |

190 499

191### Shared configuration500### Shared configuration

192 501

193Desktop and CLI read the same configuration files, so your setup carries over:502Desktop and CLI read the same configuration files, so your setup carries over:

194 503

195* **[CLAUDE.md](/en/memory)** and **CLAUDE.local.md** files in your project are used by both504* **[CLAUDE.md](/en/memory)** files in your project are used by both

196* **[MCP servers](/en/mcp)** configured in `~/.claude.json` or `.mcp.json` work in both505* **[MCP servers](/en/mcp)** configured in `~/.claude.json` or `.mcp.json` work in both

197* **[Hooks](/en/hooks)** and **[skills](/en/skills)** defined in settings apply to both506* **[Hooks](/en/hooks)** and **[skills](/en/skills)** defined in settings apply to both

198* **[Settings](/en/settings)** in `~/.claude.json` and `~/.claude/settings.json` are shared507* **[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.

199* **Models** (Sonnet, Opus, Haiku) are available in both (Desktop requires selecting before starting a session)508* **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.

200 509

201<Note>510<Note>

202 MCP servers configured for the **Claude Desktop chat app** (in `claude_desktop_config.json`) are separate from Claude Code. To use MCP servers in Claude Code, configure them in `~/.claude.json` or your project's `.mcp.json` file. See [MCP configuration](/en/mcp#configure-mcp-servers) for details.511 **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.

203</Note>512</Note>

204 513

205### What's different514### Feature comparison

206 515

207**Desktop adds:**516This table compares core capabilities between the CLI and Desktop. For a full list of CLI flags, see the [CLI reference](/en/cli-reference).

208 517

209* Graphical interface with visual session management518| Feature | CLI | Desktop |

210* Built-in connectors for common integrations519| ----------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------- |

211* Automatic session isolation for Git repositories (each session gets its own worktree)520| Permission modes | all modes including `dontAsk` | Ask permissions, Auto accept edits, Plan mode, and Bypass permissions via Settings |

521| `--dangerously-skip-permissions` | CLI flag | Bypass permissions mode. Enable in Settings → Claude Code → "Allow bypass permissions mode" |

522| [Third-party providers](/en/third-party-integrations) | Bedrock, Vertex, Foundry | not available. Desktop connects to Anthropic's API directly. |

523| [MCP servers](/en/mcp) | configure in settings files | Connectors UI for local and SSH sessions, or settings files |

524| [Plugins](/en/plugins) | `/plugin` command | plugin manager UI |

525| @mention files | text-based | with autocomplete |

526| File attachments | not available | images, PDFs |

527| Session isolation | [`--worktree`](/en/cli-reference) flag | automatic worktrees |

528| Multiple sessions | separate terminals | sidebar tabs |

529| Recurring tasks | cron jobs, CI pipelines | [scheduled tasks](#schedule-recurring-tasks) |

530| Scripting and automation | [`--print`](/en/cli-reference), [Agent SDK](/en/headless) | not available |

212 531

213**CLI adds:**532### What's not available in Desktop

214 533

215* [Third-party API providers](/en/third-party-integrations) (Bedrock, Vertex, Foundry). If you use these, continue using CLI for those projects.534The following features are only available in the CLI or VS Code extension:

216* [CLI flags](/en/cli-reference) for scripting (`--print`, `--resume`, `--continue`)

217* [Programmatic usage](/en/headless) via the Agent SDK

218 535

219## Troubleshooting536* **Third-party providers**: Desktop connects to Anthropic's API directly. Use the [CLI](/en/quickstart) with Bedrock, Vertex, or Foundry instead.

537* **Linux**: the desktop app is available on macOS and Windows only.

538* **Inline code suggestions**: Desktop does not provide autocomplete-style suggestions. It works through conversational prompts and explicit code changes.

539* **Agent teams**: multi-agent orchestration is available via the [CLI](/en/agent-teams) and [Agent SDK](/en/headless), not in Desktop.

220 540

221Solutions to common issues with the Claude desktop app. For CLI issues, see [CLI troubleshooting](/en/troubleshooting).541## Troubleshooting

222 542

223### Check your version543### Check your version

224 544

225To see which version of the desktop app you're running:545To see which version of the desktop app you're running:

226 546

227* **macOS**: Click **Claude** in the menu bar, then **About Claude**547* **macOS**: click **Claude** in the menu bar, then **About Claude**

228* **Windows**: Click **Help**, then **About**548* **Windows**: click **Help**, then **About**

229 549

230Click the version number to copy it to your clipboard.550Click the version number to copy it to your clipboard.

231 551

232### "Branch doesn't exist yet" when opening in CLI552### 403 or authentication errors in the Code tab

233 553

234Remote 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:554If you see `Error 403: Forbidden` or other authentication failures when using the Code tab:

235 555

236```bash theme={null}5561. Sign out and back in from the app menu. This is the most common fix.

237git fetch origin <branch-name>5572. Verify you have an active paid subscription: Pro, Max, Teams, or Enterprise.

238git checkout <branch-name>5583. If the CLI works but Desktop does not, quit the desktop app completely, not just close the window, then reopen and sign in again.

239```5594. Check your internet connection and proxy settings.

240 560

241### "Failed to load session" error561### Blank or stuck screen on launch

242 562

243This error can occur for several reasons:563If the app opens but shows a blank or unresponsive screen:

244 564

245* The selected folder no longer exists or is inaccessible5651. Restart the app.

246* A Git repository requires Git LFS but it's not installed (see [Git LFS errors](#git-lfs-errors))5662. Check for pending updates. The app auto-updates on launch.

247* File permissions prevent access to the project directory5673. On Windows, check Event Viewer for crash logs under **Windows Logs → Application**.

248 568

249Try selecting a different folder or restarting the desktop app.569### "Failed to load session"

250 570

251### App won't quit571If 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.

252 572

253If the desktop app doesn't close properly:573### Session not finding installed tools

254 574

255* **macOS**: Press Cmd+Q. If the app doesn't respond, use Force Quit (Cmd+Option+Esc, select Claude, click Force Quit).575If 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.

256* **Windows**: Use Task Manager (Ctrl+Shift+Esc) to end the Claude process.

257 576

258### Windows installation issues577### Git and Git LFS errors

259 578

260If the installer fails silently or doesn't complete properly:579On 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.

261 580

2621. **PATH not updated**: After installation, open a new terminal window. The PATH updates only apply to new terminal sessions.581If 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.

2632. **Concurrent installation error**: If you see an error about another installation in progress but there isn't one, try running the installer as Administrator.

264 582

265### Session not finding installed tools583### MCP servers not working on Windows

584

585If 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.

266 586

267If Claude can't find tools like `npm`, `node`, or other CLI commands:587### App won't quit

268 588

2691. Verify the tools work in your regular terminal589* **macOS**: press Cmd+Q. If the app doesn't respond, use Force Quit with Cmd+Option+Esc, select Claude, and click Force Quit.

2702. Check that your shell profile (`~/.zshrc`, `~/.bashrc`) properly sets up PATH590* **Windows**: use Task Manager with Ctrl+Shift+Esc to end the Claude process.

2713. Restart the desktop app to reload environment variables

272 591

273### MCP servers not working (Windows)592### Windows-specific issues

274 593

275If MCP server toggles don't respond or servers fail to connect on Windows:594* **PATH not updated after install**: open a new terminal window. PATH updates only apply to new terminal sessions.

595* **Concurrent installation error**: if you see an error about another installation in progress but there isn't one, try running the installer as Administrator.

596* **ARM64**: Windows ARM64 devices are fully supported.

276 597

2771. Check that the MCP server is properly configured in your settings598### Cowork tab unavailable on Intel Macs

2782. Restart the desktop app after making changes

2793. Verify the MCP server process is running (check Task Manager)

2804. Review the server logs for connection errors

281 599

282### Git LFS errors600The 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.

283 601

284If you see "Git LFS is required by this repository but is not installed," your repository uses Git Large File Storage for large binary files. Install Git LFS before opening this repository:602### "Branch doesn't exist yet" when opening in CLI

285 603

2861. Install Git LFS from [git-lfs.com](https://git-lfs.com/)604Remote 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:

2872. Run `git lfs install` in your terminal

2883. Restart the desktop app

289 605

290## Enterprise configuration606```bash theme={null}

607git fetch origin <branch-name>

608git checkout <branch-name>

609```

291 610

292Organizations can disable local Claude Code use in the desktop application with the `isClaudeCodeForDesktopEnabled` [enterprise policy option](https://support.claude.com/en/articles/12622667-enterprise-configuration#h_003283c7cb). Additionally, Claude Code on the web can be disabled in your [admin settings](https://claude.ai/admin-settings/claude-code).611### Still stuck?

293 612

294## Related resources613* Search or file a bug on [GitHub Issues](https://github.com/anthropics/claude-code/issues)

614* Visit the [Claude support center](https://support.claude.com/)

295 615

296* [Claude Code on the web](/en/claude-code-on-the-web): Run remote sessions that continue in the cloud616When 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.

297* [CLI reference](/en/cli-reference): Use Claude Code in your terminal with flags and scripting

298* [Common workflows](/en/common-workflows): Tutorials for debugging, refactoring, testing, and more

299* [Settings reference](/en/settings): Configure Claude Code behavior with settings files

300* [Claude Desktop support](https://support.claude.com/en/collections/16163169-claude-desktop): Help articles for the Chat tab and general desktop app usage

301* [Enterprise configuration](https://support.claude.com/en/articles/12622667-enterprise-configuration): Admin policies for organizational deployments

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

discover-plugins.md +38 −2

Details

37```37```

38 38

39<Note>39<Note>

~~40 The official marketplace is maintained by Anthropic. To distribute your own plugins, [create your own marketplace](/en/plugin-marketplaces) and share it with users.~~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.

41</Note>46</Note>

42 47

43The official marketplace includes several categories of plugins:48The official marketplace includes several categories of plugins:

289claude plugin uninstall formatter@your-org --scope project294claude plugin uninstall formatter@your-org --scope project

290```295```

291 296

297### Apply plugin changes without restarting

298

299When you install, enable, or disable plugins during a session, some changes (like new commands and hooks) take effect immediately. Others, including LSP server updates, require a restart.

300

301To activate all pending plugin changes without restarting, run:

302

303```shell theme={null}

304/reload-plugins

305```

306

307Claude Code reloads all active plugins and reports what was loaded. If any LSP servers were added or updated, it will let you know those require a restart to take effect.

308

292## Manage marketplaces309## Manage marketplaces

293 310

294You can manage marketplaces through the interactive `/plugin` interface or with CLI commands.311You can manage marketplaces through the interactive `/plugin` interface or with CLI commands.

330 347

331### Configure auto-updates348### Configure auto-updates

332 349

333Claude 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 suggesting you restart Claude Code.350Claude 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`.

334 351

335Toggle auto-update for individual marketplaces through the UI:352Toggle auto-update for individual marketplaces through the UI:

336 353

356 373

357Team 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.374Team 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.

358 375

376Add `extraKnownMarketplaces` to your project's `.claude/settings.json`:

377

378```json theme={null}

379{

380 "extraKnownMarketplaces": {

381 "my-team-tools": {

382 "source": {

383 "source": "github",

384 "repo": "your-org/claude-plugins"

385 }

386 }

387 }

388}

389```

390

359For full configuration options including `extraKnownMarketplaces` and `enabledPlugins`, see [Plugin settings](/en/settings#plugin-settings).391For full configuration options including `extraKnownMarketplaces` and `enabledPlugins`, see [Plugin settings](/en/settings#plugin-settings).

360 392

393## Security

394

395Plugins 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).

396

361## Troubleshooting397## Troubleshooting

362 398

363### /plugin command not recognized399### /plugin command not recognized

env-vars.md +115 −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, typically for the Claude SDK (for interactive usage, run `/login`) |

14| `ANTHROPIC_AUTH_TOKEN` | Custom value for the `Authorization` header (the value you set here will be prefixed with `Bearer `) |

15| `ANTHROPIC_CUSTOM_HEADERS` | Custom headers to add to requests (`Name: Value` format, newline-separated for multiple headers) |

16| `ANTHROPIC_DEFAULT_HAIKU_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

17| `ANTHROPIC_DEFAULT_OPUS_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

18| `ANTHROPIC_DEFAULT_SONNET_MODEL` | See [Model configuration](/en/model-config#environment-variables) |

19| `ANTHROPIC_FOUNDRY_API_KEY` | API key for Microsoft Foundry authentication (see [Microsoft Foundry](/en/microsoft-foundry)) |

20| `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)) |

21| `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)) |

22| `ANTHROPIC_MODEL` | Name of the model setting to use (see [Model Configuration](/en/model-config#environment-variables)) |

23| `ANTHROPIC_SMALL_FAST_MODEL` | \[DEPRECATED] Name of [Haiku-class model for background tasks](/en/costs) |

24| `ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION` | Override AWS region for the Haiku-class model when using Bedrock |

25| `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/)) |

26| `BASH_DEFAULT_TIMEOUT_MS` | Default timeout for long-running bash commands |

27| `BASH_MAX_OUTPUT_LENGTH` | Maximum number of characters in bash outputs before they are middle-truncated |

28| `BASH_MAX_TIMEOUT_MS` | Maximum timeout the model can set for long-running bash commands |

29| `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) |

30| `CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR` | Return to the original working directory after each Bash command |

31| `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 |

32| `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 |

33| `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 |

34| `CLAUDE_CODE_API_KEY_HELPER_TTL_MS` | Interval in milliseconds at which credentials should be refreshed (when using [`apiKeyHelper`](/en/settings#available-settings)) |

35| `CLAUDE_CODE_CLIENT_CERT` | Path to client certificate file for mTLS authentication |

36| `CLAUDE_CODE_CLIENT_KEY` | Path to client private key file for mTLS authentication |

37| `CLAUDE_CODE_CLIENT_KEY_PASSPHRASE` | Passphrase for encrypted CLAUDE\_CODE\_CLIENT\_KEY (optional) |

38| `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 |

39| `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` |

40| `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 |

41| `CLAUDE_CODE_DISABLE_GIT_INSTRUCTIONS` | Set to `1` to remove built-in commit and PR workflow instructions 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 |

42| `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 |

43| `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 |

44| `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 |

45| `CLAUDE_CODE_DISABLE_FAST_MODE` | Set to `1` to disable [fast mode](/en/fast-mode) |

46| `CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY` | Set to `1` to disable the "How is Claude doing?" session quality surveys. Also disabled when using third-party providers or when telemetry is disabled. See [Session quality surveys](/en/data-usage#session-quality-surveys) |

47| `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | Equivalent of setting `DISABLE_AUTOUPDATER`, `DISABLE_BUG_COMMAND`, `DISABLE_ERROR_REPORTING`, and `DISABLE_TELEMETRY` |

48| `CLAUDE_CODE_DISABLE_TERMINAL_TITLE` | Set to `1` to disable automatic terminal title updates based on conversation context |

49| `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) |

50| `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) |

51| `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) |

52| `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) |

53| `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 |

54| `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS` | Set to `1` to enable [agent teams](/en/agent-teams). Agent teams are experimental and disabled by default |

55| `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 |

56| `CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL` | Skip auto-installation of IDE extensions |

57| `CLAUDE_CODE_MAX_OUTPUT_TOKENS` | Set the maximum number of output tokens for most requests. Default: 32,000. Maximum: 64,000. Increasing this value reduces the effective context window available before [auto-compaction](/en/costs#reduce-token-usage) triggers. |

58| `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 |

59| `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) |

60| `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) |

61| `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) |

62| `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 |

63| `CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS` | Maximum time in milliseconds for [SessionEnd](/en/hooks#sessionend) hooks to complete (default: `1500`). Applies to both session exit and `/clear`. Per-hook `timeout` values are also capped by this budget |

64| `CLAUDE_CODE_SHELL` | Override automatic shell detection. Useful when your login shell differs from your preferred working shell (for example, `bash` vs `zsh`) |

65| `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>` |

66| `CLAUDE_CODE_SIMPLE` | Set to `1` to run with a minimal system prompt and only the Bash, file read, and file edit tools. Disables MCP tools, attachments, hooks, and CLAUDE.md files |

67| `CLAUDE_CODE_SKIP_BEDROCK_AUTH` | Skip AWS authentication for Bedrock (for example, when using an LLM gateway) |

68| `CLAUDE_CODE_SKIP_FOUNDRY_AUTH` | Skip Azure authentication for Microsoft Foundry (for example, when using an LLM gateway) |

69| `CLAUDE_CODE_SKIP_VERTEX_AUTH` | Skip Google authentication for Vertex (for example, when using an LLM gateway) |

70| `CLAUDE_CODE_SUBAGENT_MODEL` | See [Model configuration](/en/model-config) |

71| `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) |

72| `CLAUDE_CODE_TEAM_NAME` | Name of the agent team this teammate belongs to. Set automatically on [agent team](/en/agent-teams) members |

73| `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 |

74| `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 |

75| `CLAUDE_CODE_USE_BEDROCK` | Use [Bedrock](/en/amazon-bedrock) |

76| `CLAUDE_CODE_USE_FOUNDRY` | Use [Microsoft Foundry](/en/microsoft-foundry) |

77| `CLAUDE_CODE_USE_VERTEX` | Use [Vertex](/en/google-vertex-ai) |

78| `CLAUDE_CONFIG_DIR` | Customize where Claude Code stores its configuration and data files |

79| `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 hooks](/en/hooks#persist-environment-variables) |

80| `DISABLE_AUTOUPDATER` | Set to `1` to disable automatic updates. |

81| `DISABLE_BUG_COMMAND` | Set to `1` to disable the `/bug` command |

82| `DISABLE_COST_WARNINGS` | Set to `1` to disable cost warning messages |

83| `DISABLE_ERROR_REPORTING` | Set to `1` to opt out of Sentry error reporting |

84| `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 |

85| `DISABLE_PROMPT_CACHING` | Set to `1` to disable prompt caching for all models (takes precedence over per-model settings) |

86| `DISABLE_PROMPT_CACHING_HAIKU` | Set to `1` to disable prompt caching for Haiku models |

87| `DISABLE_PROMPT_CACHING_OPUS` | Set to `1` to disable prompt caching for Opus models |

88| `DISABLE_PROMPT_CACHING_SONNET` | Set to `1` to disable prompt caching for Sonnet models |

89| `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) |

90| `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 |

91| `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) |

92| `FORCE_AUTOUPDATE_PLUGINS` | Set to `true` to force plugin auto-updates even when the main auto-updater is disabled via `DISABLE_AUTOUPDATER` |

93| `HTTP_PROXY` | Specify HTTP proxy server for network connections |

94| `HTTPS_PROXY` | Specify HTTPS proxy server for network connections |

95| `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 |

96| `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) |

97| `MAX_THINKING_TOKENS` | Override the [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) token budget. Thinking is enabled at max budget (31,999 tokens) by default. Use this to limit the budget (for example, `MAX_THINKING_TOKENS=10000`) or disable thinking entirely (`MAX_THINKING_TOKENS=0`). For Opus 4.6, thinking depth is controlled by [effort level](/en/model-config#adjust-effort-level) instead, and this variable is ignored unless set to `0` to disable thinking. |

98| `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` |

99| `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) |

100| `MCP_TIMEOUT` | Timeout in milliseconds for MCP server startup |

101| `MCP_TOOL_TIMEOUT` | Timeout in milliseconds for MCP tool execution |

102| `NO_PROXY` | List of domains and IPs to which requests will be directly issued, bypassing proxy |

103| `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 |

104| `USE_BUILTIN_RIPGREP` | Set to `0` to use system-installed `rg` instead of `rg` included with Claude Code |

105| `VERTEX_REGION_CLAUDE_3_5_HAIKU` | Override region for Claude 3.5 Haiku when using Vertex AI |

106| `VERTEX_REGION_CLAUDE_3_7_SONNET` | Override region for Claude 3.7 Sonnet when using Vertex AI |

107| `VERTEX_REGION_CLAUDE_4_0_OPUS` | Override region for Claude 4.0 Opus when using Vertex AI |

108| `VERTEX_REGION_CLAUDE_4_0_SONNET` | Override region for Claude 4.0 Sonnet when using Vertex AI |

109| `VERTEX_REGION_CLAUDE_4_1_OPUS` | Override region for Claude 4.1 Opus when using Vertex AI |

110

111## See also

112

113* [Settings](/en/settings): configure environment variables in `settings.json` so they apply to every session

114* [CLI reference](/en/cli-reference): launch-time flags

115* [Network configuration](/en/network-config): proxy and TLS setup

fast-mode.md +151 −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 starts at \$30/150 MTok. Fast mode is available at a 50% discount for all plans until 11:59pm PT on February 16.

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 (\<200K) | \$30 | \$150 |

57| Fast mode on Opus 4.6 (>200K) | \$60 | \$225 |

59Fast mode is compatible with the 1M token extended context window.

61When 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.

63## Decide when to use fast mode

65Fast mode is best for interactive work where response latency matters more than cost:

67* Rapid iteration on code changes

68* Live debugging sessions

69* Time-sensitive work with tight deadlines

71Standard mode is better for:

73* Long autonomous tasks where speed matters less

74* Batch processing or CI/CD pipelines

75* Cost-sensitive workloads

77### Fast mode vs effort level

79Fast mode and effort level both affect response speed, but differently:

81| Setting | Effect |

82| ---------------------- | -------------------------------------------------------------------------------- |

83| **Fast mode** | Same model quality, lower latency, higher cost |

84| **Lower effort level** | Less thinking time, faster responses, potentially lower quality on complex tasks |

86You can combine both: use fast mode with a lower [effort level](/en/model-config#adjust-effort-level) for maximum speed on straightforward tasks.

88## Requirements

90Fast mode requires all of the following:

92* **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.

93* **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.

95<Note>

96 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.

97</Note>

99* **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

101<Note>

102 If your admin has not enabled fast mode for your organization, the `/fast` command will show "Fast mode has been disabled by your organization."

103</Note>

104

105### Enable fast mode for your organization

106

107Admins can enable fast mode in:

108

109* **Console** (API customers): [Claude Code preferences](https://platform.claude.com/claude-code/preferences)

110* **Claude AI** (Teams and Enterprise): [Admin Settings > Claude Code](https://claude.ai/admin-settings/claude-code)

111

112Another option to disable fast mode entirely is to set `CLAUDE_CODE_DISABLE_FAST_MODE=1`. See [Environment variables](/en/env-vars).

113

114### Require per-session opt-in

115

116By 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`.

117

118```json theme={null}

119{

120 "fastModePerSessionOptIn": true

121}

122```

123

124This 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.

125

126## Handle rate limits

127

128Fast 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:

129

1301. Fast mode automatically falls back to standard Opus 4.6

1312. The `↯` icon turns gray to indicate cooldown

1323. You continue working at standard speed and pricing

1334. When the cooldown expires, fast mode automatically re-enables

134

135To disable fast mode manually instead of waiting for cooldown, run `/fast` again.

136

137## Research preview

138

139Fast mode is a research preview feature. This means:

140

141* The feature may change based on feedback

142* Availability and pricing are subject to change

143* The underlying API configuration may evolve

144

145Report issues or feedback through your usual Anthropic support channels.

146

147## See also

148

149* [Model configuration](/en/model-config): switch models and adjust effort levels

150* [Manage costs effectively](/en/costs): track token usage and reduce costs

151* [Status line configuration](/en/statusline): display model and context information

features-overview.md +57 −10

Details

22* **[Skills](/en/skills)** add reusable knowledge and invocable workflows22* **[Skills](/en/skills)** add reusable knowledge and invocable workflows

23* **[MCP](/en/mcp)** connects Claude to external services and tools23* **[MCP](/en/mcp)** connects Claude to external services and tools

24* **[Subagents](/en/sub-agents)** run their own loops in isolated context, returning summaries24* **[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

25* **[Hooks](/en/hooks)** run outside the loop entirely as deterministic scripts26* **[Hooks](/en/hooks)** run outside the loop entirely as deterministic scripts

26* **[Plugins](/en/plugins)** and **[marketplaces](/en/plugin-marketplaces)** package and distribute these features27* **[Plugins](/en/plugins)** and **[marketplaces](/en/plugin-marketplaces)** package and distribute these features

27 28

28[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 slash 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.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.

29 30

30## Match features to your goal31## Match features to your goal

31 32

32Features 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.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.

33 34

35| ------------- | ---------------------------------------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------- |36| ---------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |

39| **MCP** | Connect to external services | External data or actions | Query your database, post to Slack, control a browser |41| **MCP** | Connect to external services | External data or actions | Query your database, post to Slack, control a browser |

41 43

79 81

80 **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).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).

81 83

~~82 **Rule of thumb:** Keep CLAUDE.md under \~500 lines. If it's growing, move reference content to skills.~~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>

83 </Tab>126 </Tab>

84 127

85 <Tab title="MCP vs Skill">128 <Tab title="MCP vs Skill">

105 148

106Features 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: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:

107 150

108* **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 looks up memories](/en/memory#how-claude-looks-up-memories).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-claudemd-files-load).

109* **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).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).

110* **MCP servers** override by name: local > project > user. See [MCP scope](/en/mcp#scope-hierarchy-and-precedence).153* **MCP servers** override by name: local > project > user. See [MCP scope](/en/mcp#scope-hierarchy-and-precedence).

111* **Hooks** merge: all registered hooks fire for their matching events regardless of source. See [hooks](/en/hooks).154* **Hooks** merge: all registered hooks fire for their matching events regardless of source. See [hooks](/en/hooks).

117For 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.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.

118 161

120| ---------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |163| ---------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |

122| **Skill + Subagent** | A skill spawns subagents for parallel work | `/review` skill kicks off security, performance, and style subagents that work in isolated context |165| **Skill + Subagent** | A skill spawns subagents for parallel work | `/audit` skill kicks off security, performance, and style subagents that work in isolated context |

123| **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 |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 |

125 168

145 188

146Each feature loads at different points in your session. The tabs below explain when each one loads and what goes into context.189Each feature loads at different points in your session. The tabs below explain when each one loads and what goes into context.

147 190

148<img src="https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/context-loading.svg?fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=bd2e24b8e6a99b31ecfffb63f5b23bf5" 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." data-og-width="720" width="720" data-og-height="410" height="410" data-path="images/context-loading.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/context-loading.svg?w=280&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=aebaadd1f484f285dd9cb4e0ea6d49b9 280w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/context-loading.svg?w=560&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=030c9b46126d750de315612560082727 560w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/context-loading.svg?w=840&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=6c73f8b0389da4f3190843140c810fe9 840w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/context-loading.svg?w=1100&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=9844c55d08d2c386672447f2e8518669 1100w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/context-loading.svg?w=1650&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=21a9522d0e4bd10ced146aab850ede76 1650w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/context-loading.svg?w=2500&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=d318525915aee1a1a6a4215cfaa61fb9 2500w" />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" />

149 192

150<Tabs>193<Tabs>

151 <Tab title="CLAUDE.md">194 <Tab title="CLAUDE.md">

153 196

154 **What loads:** Full content of all CLAUDE.md files (managed, user, and project levels).197 **What loads:** Full content of all CLAUDE.md files (managed, user, and project levels).

155 198

156 **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 looks up memories](/en/memory#how-claude-looks-up-memories) for details.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-claudemd-files-load) for details.

157 200

158 <Tip>Keep CLAUDE.md under \~500 lines. Move reference material to skills, which load on-demand.</Tip>201 <Tip>Keep CLAUDE.md under \~500 lines. Move reference material to skills, which load on-demand.</Tip>

159 </Tab>202 </Tab>

160 203

161 <Tab title="Skills">204 <Tab title="Skills">

162 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`). Some are built-in; you can also create your own. Claude uses skills when appropriate, or you can invoke one directly.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.

163 206

164 **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.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.

165 208

229 Offload work to isolated context272 Offload work to isolated context

230 </Card>273 </Card>

231 274

275 <Card title="Agent teams" icon="network" href="/en/agent-teams">

276 Coordinate multiple sessions working in parallel

277 </Card>

278

232 <Card title="MCP" icon="plug" href="/en/mcp">279 <Card title="MCP" icon="plug" href="/en/mcp">

233 Connect Claude to external services280 Connect Claude to external services

234 </Card>281 </Card>

github-actions.md +15 −18

Details

6 6

7> 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

8 8

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.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).

10 10

11<Note>11<Note>

~~12 Claude Code GitHub Actions is built on top of the [Claude~~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.

~~13 Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview), which enables programmatic integration of~~

~~14 Claude Code into your applications. You can use the SDK to build custom~~

~~15 automation workflows beyond GitHub Actions.~~

16</Note>13</Note>

17 14

18<Info>15<Info>

~~19 **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`.

20</Info>17</Info>

21 18

22## Why use Claude Code GitHub Actions?19## Why use Claude Code GitHub Actions?

117 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}114 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

118 custom_instructions: "Follow our coding standards"115 custom_instructions: "Follow our coding standards"

119 max_turns: "10"116 max_turns: "10"

120 model: "claude-sonnet-4-5-20250929"117 model: "claude-sonnet-4-6"

121```118```

122 119

123**GA version (v1.0):**120**GA version (v1.0):**

130 claude_args: |127 claude_args: |

131 --append-system-prompt "Follow our coding standards"128 --append-system-prompt "Follow our coding standards"

132 --max-turns 10129 --max-turns 10

133 --model claude-sonnet-4-5-20250929130 --model claude-sonnet-4-6

134```131```

135 132

136<Tip>133<Tip>

174 - uses: anthropics/claude-code-action@v1171 - uses: anthropics/claude-code-action@v1

175 with:172 with:

176 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}173 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

177 prompt: "/review"174 prompt: "Review this pull request for code quality, correctness, and security. Analyze the diff, then post your findings as review comments."

178 claude_args: "--max-turns 5"175 claude_args: "--max-turns 5"

179```176```

180 177

193 with:190 with:

194 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}191 anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

195 prompt: "Generate a summary of yesterday's commits and open issues"192 prompt: "Generate a summary of yesterday's commits and open issues"

196 claude_args: "--model claude-opus-4-5-20251101"193 claude_args: "--model opus"

197```194```

198 195

199### Common use cases196### Common use cases

200 197

201In issue or PR comments:198In issue or PR comments:

202 199

203```200```text theme={null}

204@claude implement this feature based on the issue description201@claude implement this feature based on the issue description

205@claude how should I implement user authentication for this endpoint?202@claude how should I implement user authentication for this endpoint?

206@claude fix the TypeError in the user dashboard component203@claude fix the TypeError in the user dashboard component

270Key features:267Key features:

271 268

272* **Unified prompt interface** - Use `prompt` for all instructions269* **Unified prompt interface** - Use `prompt` for all instructions

273* **Commands** - Prebuilt prompts like `/review` or `/fix`270* **Skills** - Invoke installed [skills](/en/skills) directly from the prompt

274* **CLI passthrough** - Any Claude Code CLI argument via `claude_args`271* **CLI passthrough** - Any Claude Code CLI argument via `claude_args`

275* **Flexible triggers** - Works with any GitHub event272* **Flexible triggers** - Works with any GitHub event

276 273

521 with:518 with:

522 github_token: ${{ steps.app-token.outputs.token }}519 github_token: ${{ steps.app-token.outputs.token }}

523 use_bedrock: "true"520 use_bedrock: "true"

524 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'

525 ```522 ```

526 523

527 <Tip>524 <Tip>

528 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`).

529 </Tip>526 </Tip>

530 </Accordion>527 </Accordion>

531 528

628The Claude Code Action v1 uses a simplified configuration:625The Claude Code Action v1 uses a simplified configuration:

629 626

631| ------------------- | ------------------------------------------------------ | -------- |628| ------------------- | ------------------------------------------------------------------ | -------- |

632| `prompt` | Instructions for Claude (text or skill like `/review`) | No\* |629| `prompt` | Instructions for Claude (plain text or a [skill](/en/skills) name) | No\* |

633| `claude_args` | CLI arguments passed to Claude Code | No |630| `claude_args` | CLI arguments passed to Claude Code | No |

634| `anthropic_api_key` | Claude API key | Yes\*\* |631| `anthropic_api_key` | Claude API key | Yes\*\* |

635| `github_token` | GitHub token for API access | No |632| `github_token` | GitHub token for API access | No |

645The `claude_args` parameter accepts any Claude Code CLI arguments:642The `claude_args` parameter accepts any Claude Code CLI arguments:

646 643

647```yaml theme={null}644```yaml theme={null}

648claude_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"

649```646```

650 647

651Common arguments:648Common arguments:

652 649

653* `--max-turns`: Maximum conversation turns (default: 10)650* `--max-turns`: Maximum conversation turns (default: 10)

654* `--model`: Model to use (for example, `claude-sonnet-4-5-20250929`)651* `--model`: Model to use (for example, `claude-sonnet-4-6`)

655* `--mcp-config`: Path to MCP configuration652* `--mcp-config`: Path to MCP configuration

656* `--allowed-tools`: Comma-separated list of allowed tools653* `--allowed-tools`: Comma-separated list of allowed tools

657* `--debug`: Enable debug output654* `--debug`: Enable debug output

gitlab-ci-cd.md +4 −4

Details

126 126

127In an issue comment:127In an issue comment:

128 128

129```129```text theme={null}

130@claude implement this feature based on the issue description130@claude implement this feature based on the issue description

131```131```

132 132

136 136

137In an MR discussion:137In an MR discussion:

138 138

139```139```text theme={null}

140@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

141```141```

142 142

146 146

147In an issue or MR comment:147In an issue or MR comment:

148 148

149```149```text theme={null}

150@claude fix the TypeError in the user dashboard component150@claude fix the TypeError in the user dashboard component

151```151```

152 152

319```319```

320 320

321<Note>321<Note>

322 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.

323</Note>323</Note>

324 324

325### Google Vertex AI job example (Workload Identity Federation)325### Google Vertex AI job example (Workload Identity Federation)

google-vertex-ai.md +30 −28

Details

12 12

13* A Google Cloud Platform (GCP) account with billing enabled13* A Google Cloud Platform (GCP) account with billing enabled

14* A GCP project with Vertex AI API enabled14* A GCP project with Vertex AI API enabled

~~15* Access to desired Claude models (for example, Claude Sonnet 4.5)~~15* Access to desired Claude models (for example, Claude Sonnet 4.6)

16* Google Cloud SDK (`gcloud`) installed and configured16* Google Cloud SDK (`gcloud`) installed and configured

17* Quota allocated in desired GCP region17* Quota allocated in desired GCP region

18 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>

19## Region Configuration23## Region Configuration

20 24

21Claude 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.

22 26

23<Note>27<Note>

24 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.

~~25</Note>~~

~~27<Note>~~

28 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).

29</Note>29</Note>

30 30

31## Setup31## Setup

48 48

491. 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)

502. Search for "Claude" models502. Search for "Claude" models

~~513. Request access to desired Claude models (for example, Claude Sonnet 4.5)~~513. Request access to desired Claude models (for example, Claude Sonnet 4.6)

524. Wait for approval (may take 24-48 hours)524. Wait for approval (may take 24-48 hours)

53 53

54### 3. Configure GCP credentials54### 3. Configure GCP credentials

85export VERTEX_REGION_CLAUDE_4_1_OPUS=europe-west185export VERTEX_REGION_CLAUDE_4_1_OPUS=europe-west1

86```86```

87 87

~~88<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.

89 [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.

~~90</Note>~~

91 89

~~92<Note>~~90### 5. Pin model versions

~~93 When using Vertex AI, the `/login` and `/logout` commands are disabled since authentication is handled through Google Cloud credentials.~~

~~94</Note>~~

95 91

~~96### 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>

97 95

~~98Claude 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:

99 107

100| Model type | Default value |108| Model type | Default value |

101| :--------------- | :--------------------------- |109| :--------------- | :-------------------------- |

104 112

105<Note>113To customize models further:

106 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 (for example, `claude-haiku-4-5@20251001`).

107</Note>

~~108~~

109To customize models:

110 114

111```bash theme={null}115```bash theme={null}

112export ANTHROPIC_MODEL='claude-opus-4-1@20250805'116export ANTHROPIC_MODEL='claude-opus-4-6'

113export ANTHROPIC_SMALL_FAST_MODEL='claude-haiku-4-5@20251001'117export ANTHROPIC_SMALL_FAST_MODEL='claude-haiku-4-5@20251001'

114```118```

115 119

126For 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).

127 131

128<Note>132<Note>

129 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.

130</Note>134</Note>

131 135

132## 1M token context window136## 1M token context window

133 137

134Claude Sonnet 4 and Sonnet 4.5 support the [1M token context window](https://platform.claude.com/docs/en/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.

135 139

136<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.

137 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.

138</Note>

139 141

140## Troubleshooting142## Troubleshooting

141 143

headless.md +5 −18

Details

115The `--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`.115The `--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`.

116 116

117<Note>117<Note>

118 User-invoked [skills](/en/skills) like `/commit` and [built-in commands](/en/interactive-mode#built-in-commands) are only available in interactive mode. In `-p` mode, describe the task you want to accomplish instead.118 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.

119</Note>119</Note>

120 120

121### Customize the system prompt121### Customize the system prompt

152 152

153## Next steps153## Next steps

154 154

155<CardGroup cols={2}>155* [Agent SDK quickstart](https://platform.claude.com/docs/en/agent-sdk/quickstart): build your first agent with Python or TypeScript

156 <Card title="Agent SDK quickstart" icon="play" href="https://platform.claude.com/docs/en/agent-sdk/quickstart">156* [CLI reference](/en/cli-reference): all CLI flags and options

157 Build your first agent with Python or TypeScript157* [GitHub Actions](/en/github-actions): use the Agent SDK in GitHub workflows

158 </Card>158* [GitLab CI/CD](/en/gitlab-ci-cd): use the Agent SDK in GitLab pipelines

~~159~~

160 <Card title="CLI reference" icon="terminal" href="/en/cli-reference">

161 Explore all CLI flags and options

162 </Card>

~~163~~

164 <Card title="GitHub Actions" icon="github" href="/en/github-actions">

165 Use the Agent SDK in GitHub workflows

166 </Card>

~~167~~

168 <Card title="GitLab CI/CD" icon="gitlab" href="/en/gitlab-ci-cd">

169 Use the Agent SDK in GitLab pipelines

170 </Card>

171</CardGroup>

hooks.md +607 −40

Details

4 4

5# Hooks reference5# Hooks reference

6 6

~~7> Reference for Claude Code hook events, configuration schema, JSON input/output formats, exit codes, async hooks, prompt hooks, and MCP tool hooks.~~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.

8 8

9<Tip>9<Tip>

10 For a quickstart guide with examples, see [Automate workflows with hooks](/en/hooks-guide).10 For a quickstart guide with examples, see [Automate workflows with hooks](/en/hooks-guide).

11</Tip>11</Tip>

12 12

13Hooks are user-defined shell commands 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 and MCP tool hooks. If you're setting up hooks for the first time, start with the [guide](/en/hooks-guide) instead.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.

14 14

15## Hook lifecycle15## Hook lifecycle

16 16

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, this arrives on stdin. 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: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:

18 18

19<div style={{maxWidth: "500px", margin: "0 auto"}}>19<div style={{maxWidth: "500px", margin: "0 auto"}}>

20 <Frame>20 <Frame>

21 <img src="https://mintcdn.com/claude-code/z2YM37Ycg6eMbID3/images/hooks-lifecycle.png?fit=max&auto=format&n=z2YM37Ycg6eMbID3&q=85&s=5c25fedbc3db6f8882af50c3cc478c32" alt="Hook lifecycle diagram showing the sequence of hooks from SessionStart through the agentic loop to SessionEnd" data-og-width="8876" width="8876" data-og-height="12492" height="12492" data-path="images/hooks-lifecycle.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/z2YM37Ycg6eMbID3/images/hooks-lifecycle.png?w=280&fit=max&auto=format&n=z2YM37Ycg6eMbID3&q=85&s=62406fcd5d4a189cc8842ee1bd946b84 280w, https://mintcdn.com/claude-code/z2YM37Ycg6eMbID3/images/hooks-lifecycle.png?w=560&fit=max&auto=format&n=z2YM37Ycg6eMbID3&q=85&s=fa3049022a6973c5f974e0f95b28169d 560w, https://mintcdn.com/claude-code/z2YM37Ycg6eMbID3/images/hooks-lifecycle.png?w=840&fit=max&auto=format&n=z2YM37Ycg6eMbID3&q=85&s=bd2890897db61a03160b93d4f972ff8e 840w, https://mintcdn.com/claude-code/z2YM37Ycg6eMbID3/images/hooks-lifecycle.png?w=1100&fit=max&auto=format&n=z2YM37Ycg6eMbID3&q=85&s=7ae8e098340479347135e39df4a13454 1100w, https://mintcdn.com/claude-code/z2YM37Ycg6eMbID3/images/hooks-lifecycle.png?w=1650&fit=max&auto=format&n=z2YM37Ycg6eMbID3&q=85&s=848a8606aab22c2ccaa16b6a18431e32 1650w, https://mintcdn.com/claude-code/z2YM37Ycg6eMbID3/images/hooks-lifecycle.png?w=2500&fit=max&auto=format&n=z2YM37Ycg6eMbID3&q=85&s=f3a9ef7feb61fa8fe362005aa185efbc 2500w" />21 <img src="https://mintcdn.com/claude-code/lBsitdsGyD9caWJQ/images/hooks-lifecycle.svg?fit=max&auto=format&n=lBsitdsGyD9caWJQ&q=85&s=be3486ef2cf2563eb213b6cbbce93982" alt="Hook lifecycle diagram showing the sequence of hooks from SessionStart through the agentic loop (PreToolUse, PermissionRequest, PostToolUse, SubagentStart/Stop, TaskCompleted) to PostCompact and SessionEnd, with Elicitation and ElicitationResult nested inside MCP tool execution and WorktreeCreate, WorktreeRemove, Notification, ConfigChange, and InstructionsLoaded as standalone async events" width="520" height="1100" data-path="images/hooks-lifecycle.svg" />

22 </Frame>22 </Frame>

23</div>23</div>

24 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.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.

26 26

27| Event | When it fires |27| Event | When it fires |

~~28| :------------------- | :--------------------------------------------------- |~~28| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |

29| `SessionStart` | When a session begins or resumes |29| `SessionStart` | When a session begins or resumes |

30| `UserPromptSubmit` | When you submit a prompt, before Claude processes it |30| `UserPromptSubmit` | When you submit a prompt, before Claude processes it |

31| `PreToolUse` | Before a tool call executes. Can block it |31| `PreToolUse` | Before a tool call executes. Can block it |

36| `SubagentStart` | When a subagent is spawned |36| `SubagentStart` | When a subagent is spawned |

37| `SubagentStop` | When a subagent finishes |37| `SubagentStop` | When a subagent finishes |

38| `Stop` | When Claude finishes responding |38| `Stop` | When Claude finishes responding |

39| `TeammateIdle` | When an [agent team](/en/agent-teams) teammate is about to go idle |

40| `TaskCompleted` | When a task is being marked as completed |

41| `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 |

42| `ConfigChange` | When a configuration file changes during a session |

43| `WorktreeCreate` | When a worktree is being created via `--worktree` or `isolation: "worktree"`. Replaces default git behavior |

44| `WorktreeRemove` | When a worktree is being removed, either at session exit or when a subagent finishes |

39| `PreCompact` | Before context compaction |45| `PreCompact` | Before context compaction |

46| `PostCompact` | After context compaction completes |

47| `Elicitation` | When an MCP server requests user input during a tool call |

48| `ElicitationResult` | After a user responds to an MCP elicitation, before the response is sent back to the server |

40| `SessionEnd` | When a session terminates |49| `SessionEnd` | When a session terminates |

41 50

42### How a hook resolves51### How a hook resolves

84Now suppose Claude Code decides to run `Bash "rm -rf /tmp/build"`. Here's what happens:93Now suppose Claude Code decides to run `Bash "rm -rf /tmp/build"`. Here's what happens:

85 94

86<Frame>95<Frame>

87 <img src="https://mintcdn.com/claude-code/s7NM0vfd_wres2nf/images/hook-resolution.svg?fit=max&auto=format&n=s7NM0vfd_wres2nf&q=85&s=7c13f51ffcbc37d22a593b27e2f2de72" alt="Hook resolution flow: PreToolUse event fires, matcher checks for Bash match, hook handler runs, result returns to Claude Code" data-og-width="780" width="780" data-og-height="290" height="290" data-path="images/hook-resolution.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/s7NM0vfd_wres2nf/images/hook-resolution.svg?w=280&fit=max&auto=format&n=s7NM0vfd_wres2nf&q=85&s=36a39a07e8bc1995dcb4639e09846905 280w, https://mintcdn.com/claude-code/s7NM0vfd_wres2nf/images/hook-resolution.svg?w=560&fit=max&auto=format&n=s7NM0vfd_wres2nf&q=85&s=6568d90c596c7605bbac2c325b0a0c86 560w, https://mintcdn.com/claude-code/s7NM0vfd_wres2nf/images/hook-resolution.svg?w=840&fit=max&auto=format&n=s7NM0vfd_wres2nf&q=85&s=255a6f68b9475a0e41dbde7b88002dad 840w, https://mintcdn.com/claude-code/s7NM0vfd_wres2nf/images/hook-resolution.svg?w=1100&fit=max&auto=format&n=s7NM0vfd_wres2nf&q=85&s=dcecf8d5edc88cd2bc49deb006d5760d 1100w, https://mintcdn.com/claude-code/s7NM0vfd_wres2nf/images/hook-resolution.svg?w=1650&fit=max&auto=format&n=s7NM0vfd_wres2nf&q=85&s=04fe51bf69ae375e9fd517f18674e35f 1650w, https://mintcdn.com/claude-code/s7NM0vfd_wres2nf/images/hook-resolution.svg?w=2500&fit=max&auto=format&n=s7NM0vfd_wres2nf&q=85&s=b1b76e0b77fddb5c7fa7bf302dacd80b 2500w" />96 <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" />

88</Frame>97</Frame>

89 98

90<Steps>99<Steps>

134See [How a hook resolves](#how-a-hook-resolves) above for a complete walkthrough with an annotated example.143See [How a hook resolves](#how-a-hook-resolves) above for a complete walkthrough with an annotated example.

135 144

136<Note>145<Note>

137 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, prompt, or agent that runs. "Hook" on its own refers to the general feature.146 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.

138</Note>147</Note>

139 148

140### Hook locations149### Hook locations

157The `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:166The `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:

158 167

160| :--------------------------------------------------------------------- | :------------------------ | :----------------------------------------------------------------------------- |169| :-------------------------------------------------------------------------------------------------------------------- | :------------------------ | :--------------------------------------------------------------------------------- |

178| `UserPromptSubmit`, `Stop`, `TeammateIdle`, `TaskCompleted`, `WorktreeCreate`, `WorktreeRemove`, `InstructionsLoaded` | no matcher support | always fires on every occurrence |

169 179

170The 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.180The 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.

171 181

189}199}

190```200```

191 201

192`UserPromptSubmit` and `Stop` don't support matchers and always fire on every occurrence. If you add a `matcher` field to these events, it is silently ignored.202`UserPromptSubmit`, `Stop`, `TeammateIdle`, `TaskCompleted`, `WorktreeCreate`, `WorktreeRemove`, and `InstructionsLoaded` don't support matchers and always fire on every occurrence. If you add a `matcher` field to these events, it is silently ignored.

193 203

194#### Match MCP tools204#### Match MCP tools

195 205

237 247

238### Hook handler fields248### Hook handler fields

239 249

240Each object in the inner `hooks` array is a hook handler: the shell command, LLM prompt, or agent that runs when the matcher matches. There are three types:250Each 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:

241 251

242* **[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.252* **[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.

253* **[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.

243* **[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).254* **[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).

244* **[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).255* **[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).

245 256

249 260

251| :-------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |262| :-------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |

252| `type` | yes | `"command"`, `"prompt"`, or `"agent"` |263| `type` | yes | `"command"`, `"http"`, `"prompt"`, or `"agent"` |

253| `timeout` | no | Seconds before canceling. Defaults: 600 for command, 30 for prompt, 60 for agent |264| `timeout` | no | Seconds before canceling. Defaults: 600 for command, 30 for prompt, 60 for agent |

254| `statusMessage` | no | Custom spinner message displayed while the hook runs |265| `statusMessage` | no | Custom spinner message displayed while the hook runs |

255| `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) |266| `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) |

263| `command` | yes | Shell command to execute |274| `command` | yes | Shell command to execute |

264| `async` | no | If `true`, runs in the background without blocking. See [Run hooks in the background](#run-hooks-in-the-background) |275| `async` | no | If `true`, runs in the background without blocking. See [Run hooks in the background](#run-hooks-in-the-background) |

265 276

277#### HTTP hook fields

278

279In addition to the [common fields](#common-fields), HTTP hooks accept these fields:

280

281| Field | Required | Description |

282| :--------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

283| `url` | yes | URL to send the POST request to |

284| `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 |

285| `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 |

286

287Claude 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.

288

289Error 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"`.

290

291This example sends `PreToolUse` events to a local validation service, authenticating with a token from the `MY_TOKEN` environment variable:

292

293```json theme={null}

294{

295 "hooks": {

296 "PreToolUse": [

297 {

298 "matcher": "Bash",

299 "hooks": [

300 {

301 "type": "http",

302 "url": "http://localhost:8080/hooks/pre-tool-use",

303 "timeout": 30,

304 "headers": {

305 "Authorization": "Bearer $MY_TOKEN"

306 },

307 "allowedEnvVars": ["MY_TOKEN"]

308 }

309 ]

310 }

311 ]

312 }

313}

314```

315

266#### Prompt and agent hook fields316#### Prompt and agent hook fields

267 317

268In addition to the [common fields](#common-fields), prompt and agent hooks accept these fields:318In addition to the [common fields](#common-fields), prompt and agent hooks accept these fields:

272| `prompt` | yes | Prompt text to send to the model. Use `$ARGUMENTS` as a placeholder for the hook input JSON |322| `prompt` | yes | Prompt text to send to the model. Use `$ARGUMENTS` as a placeholder for the hook input JSON |

273| `model` | no | Model to use for evaluation. Defaults to a fast model |323| `model` | no | Model to use for evaluation. Defaults to a fast model |

274 324

275All matching hooks run in parallel, and identical handlers are deduplicated automatically. 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.325All 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.

276 326

277### Reference scripts by path327### Reference scripts by path

278 328

360 410

361### The `/hooks` menu411### The `/hooks` menu

362 412

363Type `/hooks` in Claude Code to open the interactive hooks manager, where you can view, add, and delete hooks without editing settings files directly. For a step-by-step walkthrough, see [Set up your first hook](/en/hooks-guide#set-up-your-first-hook) in the guide.413Type `/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.

364 414

365Each hook in the menu is labeled with a bracket prefix indicating its source:415The 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:

366 416

367* `[User]`: from `~/.claude/settings.json`417* `User`: from `~/.claude/settings.json`

368* `[Project]`: from `.claude/settings.json`418* `Project`: from `.claude/settings.json`

369* `[Local]`: from `.claude/settings.local.json`419* `Local`: from `.claude/settings.local.json`

370* `[Plugin]`: from a plugin's `hooks/hooks.json`, read-only420* `Plugin`: from a plugin's `hooks/hooks.json`

421* `Session`: registered in memory for the current session

422* `Built-in`: registered internally by Claude Code

423

424Selecting 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.

371 425

372### Disable or remove hooks426### Disable or remove hooks

373 427

374To remove a hook, delete its entry from the settings JSON file, or use the `/hooks` menu and select the hook to delete it.428To remove a hook, delete its entry from the settings JSON file.

429

430To 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.

375 431

376To temporarily disable all hooks without removing them, set `"disableAllHooks": true` in your settings file or use the toggle in the `/hooks` menu. There is no way to disable an individual hook while keeping it in the configuration.432The `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.

377 433

378Direct edits to hooks in settings files don't take effect immediately. Claude Code captures a snapshot of hooks at startup and uses it throughout the session. This prevents malicious or accidental hook modifications from taking effect mid-session without your review. If hooks are modified externally, Claude Code warns you and requires review in the `/hooks` menu before changes apply.434Direct edits to hooks in settings files don't take effect immediately. Claude Code captures a snapshot of hooks at startup and uses it throughout the session. This prevents malicious or accidental hook modifications from taking effect mid-session without your review. If hooks are modified externally, Claude Code warns you and requires review in the `/hooks` menu before changes apply.

379 435

380## Hook input and output436## Hook input and output

381 437

382Hooks receive JSON data via stdin and communicate results through exit codes, stdout, and stderr. 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.438Command 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.

383 439

384### Common input fields440### Common input fields

385 441

386All hook events receive these fields via stdin as JSON, in addition to event-specific fields documented in each [hook event](#hook-events) section:442All hook 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.

387 443

388| Field | Description |444| Field | Description |

389| :---------------- | :----------------------------------------------------------------------------------------------------------------------------------------- |445| :---------------- | :----------------------------------------------------------------------------------------------------------------------------------------- |

393| `permission_mode` | Current [permission mode](/en/permissions#permission-modes): `"default"`, `"plan"`, `"acceptEdits"`, `"dontAsk"`, or `"bypassPermissions"` |449| `permission_mode` | Current [permission mode](/en/permissions#permission-modes): `"default"`, `"plan"`, `"acceptEdits"`, `"dontAsk"`, or `"bypassPermissions"` |

395 451

452When running with `--agent` or inside a subagent, two additional fields are included:

453

454| Field | Description |

455| :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

456| `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. |

457| `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. |

458

396For example, a `PreToolUse` hook for a Bash command receives this on stdin:459For example, a `PreToolUse` hook for a Bash command receives this on stdin:

397 460

398```json theme={null}461```json theme={null}

441Exit 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.504Exit 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.

442 505

444| :------------------- | :--------- | :-------------------------------------------------------- |507| :------------------- | :--------- | :---------------------------------------------------------------------------- |

445| `PreToolUse` | Yes | Blocks the tool call |508| `PreToolUse` | Yes | Blocks the tool call |

446| `PermissionRequest` | Yes | Denies the permission |509| `PermissionRequest` | Yes | Denies the permission |

447| `UserPromptSubmit` | Yes | Blocks prompt processing and erases the prompt |510| `UserPromptSubmit` | Yes | Blocks prompt processing and erases the prompt |

448| `Stop` | Yes | Prevents Claude from stopping, continues the conversation |511| `Stop` | Yes | Prevents Claude from stopping, continues the conversation |

449| `SubagentStop` | Yes | Prevents the subagent from stopping |512| `SubagentStop` | Yes | Prevents the subagent from stopping |

513| `TeammateIdle` | Yes | Prevents the teammate from going idle (teammate continues working) |

514| `TaskCompleted` | Yes | Prevents the task from being marked as completed |

515| `ConfigChange` | Yes | Blocks the configuration change from taking effect (except `policy_settings`) |

450| `PostToolUse` | No | Shows stderr to Claude (tool already ran) |516| `PostToolUse` | No | Shows stderr to Claude (tool already ran) |

451| `PostToolUseFailure` | No | Shows stderr to Claude (tool already failed) |517| `PostToolUseFailure` | No | Shows stderr to Claude (tool already failed) |

452| `Notification` | No | Shows stderr to user only |518| `Notification` | No | Shows stderr to user only |

454| `SessionStart` | No | Shows stderr to user only |520| `SessionStart` | No | Shows stderr to user only |

455| `SessionEnd` | No | Shows stderr to user only |521| `SessionEnd` | No | Shows stderr to user only |

456| `PreCompact` | No | Shows stderr to user only |522| `PreCompact` | No | Shows stderr to user only |

523| `PostCompact` | No | Shows stderr to user only |

524| `Elicitation` | Yes | Denies the elicitation |

525| `ElicitationResult` | Yes | Blocks the response (action becomes decline) |

526| `WorktreeCreate` | Yes | Any non-zero exit code causes worktree creation to fail |

527| `WorktreeRemove` | No | Failures are logged in debug mode only |

528| `InstructionsLoaded` | No | Exit code is ignored |

529

530### HTTP response handling

531

532HTTP hooks use HTTP status codes and response bodies instead of exit codes and stdout:

533

534* **2xx with an empty body**: success, equivalent to exit code 0 with no output

535* **2xx with a plain text body**: success, the text is added as context

536* **2xx with a JSON body**: success, parsed using the same [JSON output](#json-output) schema as command hooks

537* **Non-2xx status**: non-blocking error, execution continues

538* **Connection failure or timeout**: non-blocking error, execution continues

539

540Unlike 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.

457 541

458### JSON output542### JSON output

459 543

489Not 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:573Not 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:

490 574

492| :-------------------------------------------------------------------- | :------------------- | :---------------------------------------------------------------- |576| :------------------------------------------------------------------------------------ | :----------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

578| 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 |

581| WorktreeCreate | stdout path | Hook prints absolute path to created worktree. Non-zero exit fails creation |

582| Elicitation | `hookSpecificOutput` | `action` (accept/decline/cancel), `content` (form field values for accept) |

583| ElicitationResult | `hookSpecificOutput` | `action` (accept/decline/cancel), `content` (form field values override) |

584| WorktreeRemove, Notification, SessionEnd, PreCompact, PostCompact, InstructionsLoaded | None | No decision control. Used for side effects like logging or cleanup |

496 585

497Here are examples of each pattern in action:586Here are examples of each pattern in action:

498 587

499<Tabs>588<Tabs>

500 <Tab title="Top-level decision">589 <Tab title="Top-level decision">

501 Used by `UserPromptSubmit`, `PostToolUse`, `PostToolUseFailure`, `Stop`, and `SubagentStop`. The only value is `"block"` — to allow the action to proceed, omit `decision` from your JSON, or exit 0 without any JSON at all:590 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:

502 591

503 ```json theme={null}592 ```json theme={null}

504 {593 {

551 640

552Runs 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.641Runs 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.

553 642

554SessionStart runs on every session, so keep these hooks fast.643SessionStart runs on every session, so keep these hooks fast. Only `type: "command"` hooks are supported.

555 644

556The matcher value corresponds to how the session was initiated:645The matcher value corresponds to how the session was initiated:

557 646

574 "permission_mode": "default",663 "permission_mode": "default",

575 "hook_event_name": "SessionStart",664 "hook_event_name": "SessionStart",

576 "source": "startup",665 "source": "startup",

577 "model": "claude-sonnet-4-5-20250929"666 "model": "claude-sonnet-4-6"

578}667}

579```668```

580 669

638 `CLAUDE_ENV_FILE` is available for SessionStart hooks. Other hook types do not have access to this variable.727 `CLAUDE_ENV_FILE` is available for SessionStart hooks. Other hook types do not have access to this variable.

639</Note>728</Note>

640 729

730### InstructionsLoaded

731

732Fires 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.

733

734InstructionsLoaded does not support matchers and fires on every load occurrence.

735

736#### InstructionsLoaded input

737

738In addition to the [common input fields](#common-input-fields), InstructionsLoaded hooks receive these fields:

739

740| Field | Description |

741| :------------------ | :-------------------------------------------------------------------------------------------------------- |

742| `file_path` | Absolute path to the instruction file that was loaded |

743| `memory_type` | Scope of the file: `"User"`, `"Project"`, `"Local"`, or `"Managed"` |

744| `load_reason` | Why the file was loaded: `"session_start"`, `"nested_traversal"`, `"path_glob_match"`, or `"include"` |

745| `globs` | Path glob patterns from the file's `paths:` frontmatter, if any. Present only for `path_glob_match` loads |

746| `trigger_file_path` | Path to the file whose access triggered this load, for lazy loads |

747| `parent_file_path` | Path to the parent instruction file that included this one, for `include` loads |

748

749```json theme={null}

750{

751 "session_id": "abc123",

752 "transcript_path": "/Users/.../.claude/projects/.../transcript.jsonl",

753 "cwd": "/Users/my-project",

754 "permission_mode": "default",

755 "hook_event_name": "InstructionsLoaded",

756 "file_path": "/Users/my-project/CLAUDE.md",

757 "memory_type": "Project",

758 "load_reason": "session_start"

759}

760```

761

762#### InstructionsLoaded decision control

763

764InstructionsLoaded hooks have no decision control. They cannot block or modify instruction loading. Use this event for audit logging, compliance tracking, or observability.

765

641### UserPromptSubmit766### UserPromptSubmit

642 767

643Runs when the user submits a prompt, before Claude processes it. This allows you768Runs when the user submits a prompt, before Claude processes it. This allows you

696 821

697### PreToolUse822### PreToolUse

698 823

699Runs after Claude creates tool parameters and before processing the tool call. Matches on tool name: `Bash`, `Edit`, `Write`, `Read`, `Glob`, `Grep`, `Task`, `WebFetch`, `WebSearch`, and any [MCP tool names](#match-mcp-tools).824Runs 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).

700 825

701Use [PreToolUse decision control](#pretooluse-decision-control) to allow, deny, or ask for permission to use the tool.826Use [PreToolUse decision control](#pretooluse-decision-control) to allow, deny, or ask for permission to use the tool.

702 827

788 913

789##### Task914##### Agent

790 915

791Spawns a [subagent](/en/sub-agents).916Spawns a [subagent](/en/sub-agents).

792 917

808| `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 |933| `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 |

810 935

936When 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.

937

811```json theme={null}938```json theme={null}

812{939{

813 "hookSpecificOutput": {940 "hookSpecificOutput": {

1041 1168

1042### SubagentStart1169### SubagentStart

1043 1170

1044Runs when a Claude Code subagent is spawned via the Task tool. Supports matchers to filter by agent type name (built-in agents like `Bash`, `Explore`, `Plan`, or custom agent names from `.claude/agents/`).1171Runs 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/`).

1045 1172

1046#### SubagentStart input1173#### SubagentStart input

1047 1174

1080 1207

1081#### SubagentStop input1208#### SubagentStop input

1082 1209

1083In addition to the [common input fields](#common-input-fields), SubagentStop hooks receive `stop_hook_active`, `agent_id`, `agent_type`, and `agent_transcript_path`. 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.1210In 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.

1084 1211

1085```json theme={null}1212```json theme={null}

1086{1213{

1092 "stop_hook_active": false,1219 "stop_hook_active": false,

1093 "agent_id": "def456",1220 "agent_id": "def456",

1094 "agent_type": "Explore",1221 "agent_type": "Explore",

1095 "agent_transcript_path": "~/.claude/projects/.../abc123/subagents/agent-def456.jsonl"1222 "agent_transcript_path": "~/.claude/projects/.../abc123/subagents/agent-def456.jsonl",

1223 "last_assistant_message": "Analysis complete. Found 3 potential issues..."

1096}1224}

1097```1225```

1098 1226

1105 1233

1106#### Stop input1234#### Stop input

1107 1235

1108In addition to the [common input fields](#common-input-fields), Stop hooks receive `stop_hook_active`. This 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.1236In 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.

1109 1237

1110```json theme={null}1238```json theme={null}

1111{1239{

1114 "cwd": "/Users/...",1242 "cwd": "/Users/...",

1115 "permission_mode": "default",1243 "permission_mode": "default",

1116 "hook_event_name": "Stop",1244 "hook_event_name": "Stop",

1117 "stop_hook_active": true1245 "stop_hook_active": true,

1246 "last_assistant_message": "I've completed the refactoring. Here's a summary..."

1118}1247}

1119```1248```

1120 1249

1134}1263}

1135```1264```

1136 1265

1266### TeammateIdle

1267

1268Runs 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.

1269

1270When 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.

1271

1272#### TeammateIdle input

1273

1274In addition to the [common input fields](#common-input-fields), TeammateIdle hooks receive `teammate_name` and `team_name`.

1275

1276```json theme={null}

1277{

1278 "session_id": "abc123",

1279 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1280 "cwd": "/Users/...",

1281 "permission_mode": "default",

1282 "hook_event_name": "TeammateIdle",

1283 "teammate_name": "researcher",

1284 "team_name": "my-project"

1285}

1286```

1287

1288| Field | Description |

1289| :-------------- | :-------------------------------------------- |

1290| `teammate_name` | Name of the teammate that is about to go idle |

1291| `team_name` | Name of the team |

1292

1293#### TeammateIdle decision control

1294

1295TeammateIdle hooks support two ways to control teammate behavior:

1296

1297* **Exit code 2**: the teammate receives the stderr message as feedback and continues working instead of going idle.

1298* **JSON `{"continue": false, "stopReason": "..."}`**: stops the teammate entirely, matching `Stop` hook behavior. The `stopReason` is shown to the user.

1299

1300This example checks that a build artifact exists before allowing a teammate to go idle:

1301

1302```bash theme={null}

1303#!/bin/bash

1304

1305if [ ! -f "./dist/output.js" ]; then

1306 echo "Build artifact missing. Run the build before stopping." >&2

1307 exit 2

1308fi

1309

1310exit 0

1311```

1312

1313### TaskCompleted

1314

1315Runs 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.

1316

1317When 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.

1318

1319#### TaskCompleted input

1320

1321In 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`.

1322

1323```json theme={null}

1324{

1325 "session_id": "abc123",

1326 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1327 "cwd": "/Users/...",

1328 "permission_mode": "default",

1329 "hook_event_name": "TaskCompleted",

1330 "task_id": "task-001",

1331 "task_subject": "Implement user authentication",

1332 "task_description": "Add login and signup endpoints",

1333 "teammate_name": "implementer",

1334 "team_name": "my-project"

1335}

1336```

1337

1338| Field | Description |

1339| :----------------- | :------------------------------------------------------ |

1340| `task_id` | Identifier of the task being completed |

1341| `task_subject` | Title of the task |

1342| `task_description` | Detailed description of the task. May be absent |

1343| `teammate_name` | Name of the teammate completing the task. May be absent |

1344| `team_name` | Name of the team. May be absent |

1345

1346#### TaskCompleted decision control

1347

1348TaskCompleted hooks support two ways to control task completion:

1349

1350* **Exit code 2**: the task is not marked as completed and the stderr message is fed back to the model as feedback.

1351* **JSON `{"continue": false, "stopReason": "..."}`**: stops the teammate entirely, matching `Stop` hook behavior. The `stopReason` is shown to the user.

1352

1353This example runs tests and blocks task completion if they fail:

1354

1355```bash theme={null}

1356#!/bin/bash

1357INPUT=$(cat)

1358TASK_SUBJECT=$(echo "$INPUT" | jq -r '.task_subject')

1359

1360# Run the test suite

1361if ! npm test 2>&1; then

1362 echo "Tests not passing. Fix failing tests before completing: $TASK_SUBJECT" >&2

1363 exit 2

1364fi

1365

1366exit 0

1367```

1368

1369### ConfigChange

1370

1371Runs when a configuration file changes during a session. Use this to audit settings changes, enforce security policies, or block unauthorized modifications to configuration files.

1372

1373ConfigChange 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.

1374

1375The matcher filters on the configuration source:

1376

1377| Matcher | When it fires |

1378| :----------------- | :---------------------------------------- |

1379| `user_settings` | `~/.claude/settings.json` changes |

1380| `project_settings` | `.claude/settings.json` changes |

1381| `local_settings` | `.claude/settings.local.json` changes |

1382| `policy_settings` | Managed policy settings change |

1383| `skills` | A skill file in `.claude/skills/` changes |

1384

1385This example logs all configuration changes for security auditing:

1386

1387```json theme={null}

1388{

1389 "hooks": {

1390 "ConfigChange": [

1391 {

1392 "hooks": [

1393 {

1394 "type": "command",

1395 "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/audit-config-change.sh"

1396 }

1397 ]

1398 }

1399 ]

1400 }

1401}

1402```

1403

1404#### ConfigChange input

1405

1406In 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.

1407

1408```json theme={null}

1409{

1410 "session_id": "abc123",

1411 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1412 "cwd": "/Users/...",

1413 "permission_mode": "default",

1414 "hook_event_name": "ConfigChange",

1415 "source": "project_settings",

1416 "file_path": "/Users/.../my-project/.claude/settings.json"

1417}

1418```

1419

1420#### ConfigChange decision control

1421

1422ConfigChange 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.

1423

1424| Field | Description |

1425| :--------- | :--------------------------------------------------------------------------------------- |

1426| `decision` | `"block"` prevents the configuration change from being applied. Omit to allow the change |

1427| `reason` | Explanation shown to the user when `decision` is `"block"` |

1428

1429```json theme={null}

1430{

1431 "decision": "block",

1432 "reason": "Configuration changes to project settings require admin approval"

1433}

1434```

1435

1436`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.

1437

1438### WorktreeCreate

1439

1440When 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.

1441

1442The 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.

1443

1444This example creates an SVN working copy and prints the path for Claude Code to use. Replace the repository URL with your own:

1445

1446```json theme={null}

1447{

1448 "hooks": {

1449 "WorktreeCreate": [

1450 {

1451 "hooks": [

1452 {

1453 "type": "command",

1454 "command": "bash -c 'NAME=$(jq -r .name); DIR=\"$HOME/.claude/worktrees/$NAME\"; svn checkout https://svn.example.com/repo/trunk \"$DIR\" >&2 && echo \"$DIR\"'"

1455 }

1456 ]

1457 }

1458 ]

1459 }

1460}

1461```

1462

1463The 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.

1464

1465#### WorktreeCreate input

1466

1467In 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`).

1468

1469```json theme={null}

1470{

1471 "session_id": "abc123",

1472 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1473 "cwd": "/Users/...",

1474 "hook_event_name": "WorktreeCreate",

1475 "name": "feature-auth"

1476}

1477```

1478

1479#### WorktreeCreate output

1480

1481The 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.

1482

1483WorktreeCreate 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.

1484

1485### WorktreeRemove

1486

1487The 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.

1488

1489Claude 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:

1490

1491```json theme={null}

1492{

1493 "hooks": {

1494 "WorktreeRemove": [

1495 {

1496 "hooks": [

1497 {

1498 "type": "command",

1499 "command": "bash -c 'jq -r .worktree_path | xargs rm -rf'"

1500 }

1501 ]

1502 }

1503 ]

1504 }

1505}

1506```

1507

1508#### WorktreeRemove input

1509

1510In 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.

1511

1512```json theme={null}

1513{

1514 "session_id": "abc123",

1515 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1516 "cwd": "/Users/...",

1517 "hook_event_name": "WorktreeRemove",

1518 "worktree_path": "/Users/.../my-project/.claude/worktrees/feature-auth"

1519}

1520```

1521

1522WorktreeRemove 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.

1523

1137### PreCompact1524### PreCompact

1138 1525

1139Runs before Claude Code is about to run a compact operation.1526Runs before Claude Code is about to run a compact operation.

1161}1548}

1162```1549```

1163 1550

1551### PostCompact

1552

1553Runs 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.

1554

1555The same matcher values apply as for `PreCompact`:

1556

1557| Matcher | When it fires |

1558| :------- | :------------------------------------------------- |

1559| `manual` | After `/compact` |

1560| `auto` | After auto-compact when the context window is full |

1561

1562#### PostCompact input

1563

1564In 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.

1565

1566```json theme={null}

1567{

1568 "session_id": "abc123",

1569 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1570 "cwd": "/Users/...",

1571 "permission_mode": "default",

1572 "hook_event_name": "PostCompact",

1573 "trigger": "manual",

1574 "compact_summary": "Summary of the compacted conversation..."

1575}

1576```

1577

1578PostCompact hooks have no decision control. They cannot affect the compaction result but can perform follow-up tasks.

1579

1164### SessionEnd1580### SessionEnd

1165 1581

1166Runs when a Claude Code session ends. Useful for cleanup tasks, logging session1582Runs when a Claude Code session ends. Useful for cleanup tasks, logging session

1193 1609

1194SessionEnd hooks have no decision control. They cannot block session termination but can perform cleanup tasks.1610SessionEnd hooks have no decision control. They cannot block session termination but can perform cleanup tasks.

1195 1611

1612SessionEnd hooks have a default timeout of 1.5 seconds. This applies to both session exit and `/clear`. 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.

1613

1614```bash theme={null}

1615CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS=5000 claude

1616```

1617

1618### Elicitation

1619

1620Runs 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.

1621

1622The matcher field matches against the MCP server name.

1623

1624#### Elicitation input

1625

1626In 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.

1627

1628For form-mode elicitation (the most common case):

1629

1630```json theme={null}

1631{

1632 "session_id": "abc123",

1633 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1634 "cwd": "/Users/...",

1635 "permission_mode": "default",

1636 "hook_event_name": "Elicitation",

1637 "mcp_server_name": "my-mcp-server",

1638 "message": "Please provide your credentials",

1639 "mode": "form",

1640 "requested_schema": {

1641 "type": "object",

1642 "properties": {

1643 "username": { "type": "string", "title": "Username" }

1644 }

1645 }

1646}

1647```

1648

1649For URL-mode elicitation (browser-based authentication):

1650

1651```json theme={null}

1652{

1653 "session_id": "abc123",

1654 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1655 "cwd": "/Users/...",

1656 "permission_mode": "default",

1657 "hook_event_name": "Elicitation",

1658 "mcp_server_name": "my-mcp-server",

1659 "message": "Please authenticate",

1660 "mode": "url",

1661 "url": "https://auth.example.com/login"

1662}

1663```

1664

1665#### Elicitation output

1666

1667To respond programmatically without showing the dialog, return a JSON object with `hookSpecificOutput`:

1668

1669```json theme={null}

1670{

1671 "hookSpecificOutput": {

1672 "hookEventName": "Elicitation",

1673 "action": "accept",

1674 "content": {

1675 "username": "alice"

1676 }

1677 }

1678}

1679```

1680

1681| Field | Values | Description |

1682| :-------- | :---------------------------- | :--------------------------------------------------------------- |

1683| `action` | `accept`, `decline`, `cancel` | Whether to accept, decline, or cancel the request |

1684| `content` | object | Form field values to submit. Only used when `action` is `accept` |

1685

1686Exit code 2 denies the elicitation and shows stderr to the user.

1687

1688### ElicitationResult

1689

1690Runs 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.

1691

1692The matcher field matches against the MCP server name.

1693

1694#### ElicitationResult input

1695

1696In addition to the [common input fields](#common-input-fields), ElicitationResult hooks receive `mcp_server_name`, `action`, and optional `mode`, `elicitation_id`, and `content` fields.

1697

1698```json theme={null}

1699{

1700 "session_id": "abc123",

1701 "transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",

1702 "cwd": "/Users/...",

1703 "permission_mode": "default",

1704 "hook_event_name": "ElicitationResult",

1705 "mcp_server_name": "my-mcp-server",

1706 "action": "accept",

1707 "content": { "username": "alice" },

1708 "mode": "form",

1709 "elicitation_id": "elicit-123"

1710}

1711```

1712

1713#### ElicitationResult output

1714

1715To override the user's response, return a JSON object with `hookSpecificOutput`:

1716

1717```json theme={null}

1718{

1719 "hookSpecificOutput": {

1720 "hookEventName": "ElicitationResult",

1721 "action": "decline",

1722 "content": {}

1723 }

1724}

1725```

1726

1727| Field | Values | Description |

1728| :-------- | :---------------------------- | :--------------------------------------------------------------------- |

1729| `action` | `accept`, `decline`, `cancel` | Overrides the user's action |

1730| `content` | object | Overrides form field values. Only meaningful when `action` is `accept` |

1731

1732Exit code 2 blocks the response, changing the effective action to `decline`.

1733

1196## Prompt-based hooks1734## Prompt-based hooks

1197 1735

1198In 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 work with the following events: `PreToolUse`, `PostToolUse`, `PostToolUseFailure`, `PermissionRequest`, `UserPromptSubmit`, `Stop`, and `SubagentStop`.1736In 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.

1737

1738Events that support all four hook types (`command`, `http`, `prompt`, and `agent`):

1739

1740* `PermissionRequest`

1741* `PostToolUse`

1742* `PostToolUseFailure`

1743* `PreToolUse`

1744* `Stop`

1745* `SubagentStop`

1746* `TaskCompleted`

1747* `UserPromptSubmit`

1748

1749Events that only support `type: "command"` hooks:

1750

1751* `ConfigChange`

1752* `Elicitation`

1753* `ElicitationResult`

1754* `InstructionsLoaded`

1755* `Notification`

1756* `PostCompact`

1757* `PreCompact`

1758* `SessionEnd`

1759* `SessionStart`

1760* `SubagentStart`

1761* `TeammateIdle`

1762* `WorktreeCreate`

1763* `WorktreeRemove`

1199 1764

1200### How prompt-based hooks work1765### How prompt-based hooks work

1201 1766

1359 1924

1360After 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.1925After 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.

1361 1926

1927Async hook completion notifications are suppressed by default. To see them, enable verbose mode with `Ctrl+O` or start Claude Code with `--verbose`.

1928

1362### Example: run tests after file changes1929### Example: run tests after file changes

1363 1930

1364This 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`:1931This 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`:

1422 1989

1423### Disclaimer1990### Disclaimer

1424 1991

1425Hooks run with your system user's full permissions.1992Command hooks run with your system user's full permissions.

1426 1993

1427<Warning>1994<Warning>

1428 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.1995 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.

1429</Warning>1996</Warning>

1430 1997

1431### Security best practices1998### Security best practices

1442 2009

1443Run `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.2010Run `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.

1444 2011

1445```2012```text theme={null}

1446[DEBUG] Executing hooks for PostToolUse:Write2013[DEBUG] Executing hooks for PostToolUse:Write

1447[DEBUG] Getting matching hook commands for PostToolUse with query: Write2014[DEBUG] Getting matching hook commands for PostToolUse with query: Write

1448[DEBUG] Found 1 hook matchers in settings2015[DEBUG] Found 1 hook matchers in settings

hooks-guide.md +114 −48

Details

18 18

19## Set up your first hook19## Set up your first hook

20 20

21The fastest way to create a hook is through the `/hooks` interactive menu in Claude Code. This walkthrough creates a desktop notification hook, so you get alerted whenever Claude is waiting for your input instead of watching the terminal.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.

22 22

23<Steps>23<Steps>

~~24 <Step title="Open the hooks menu">~~24 <Step title="Add the hook to your settings">

25 Type `/hooks` in the Claude Code CLI. You'll see a list of all available hook events, plus an option to disable all hooks. Each event corresponds to a point in Claude's lifecycle where you can run custom code. Select `Notification` to create a hook that fires when Claude needs your attention.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.

~~26 </Step>~~

~~28 <Step title="Configure the matcher">~~

29 The menu shows a list of matchers, which filter when the hook fires. Set the matcher to `*` to fire on all notification types. You can narrow it later by changing the matcher to a specific value like `permission_prompt` or `idle_prompt`.

~~30 </Step>~~

~~32 <Step title="Add your command">~~

33 Select `+ Add new hook…`. The menu prompts you for a shell command to run when the event fires. Hooks run any shell command you provide, so you can use your platform's built-in notification tool. Copy the command for your OS:

~~35 <Tabs>~~

~~36 <Tab title="macOS">~~

~~37 Uses [`osascript`](https://ss64.com/mac/osascript.html) to trigger a native macOS notification through AppleScript:~~

38 26

27 ```json theme={null}

28 {

29 "hooks": {

30 "Notification": [

31 {

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 }

39 ```43 ```

~~40 osascript -e 'display notification "Claude Code needs your attention" with title "Claude Code"'~~

~~41 ```~~

~~42 </Tab>~~

~~44 <Tab title="Linux">~~

~~45 Uses `notify-send`, which is pre-installed on most Linux desktops with a notification daemon:~~

~~47 ```~~

~~48 notify-send 'Claude Code' 'Claude Code needs your attention'~~

~~49 ```~~

~~50 </Tab>~~

~~52 <Tab title="Windows (PowerShell)">~~

~~53 Uses PowerShell to show a native message box through .NET's Windows Forms:~~

54 44

~~55 ```~~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.

56 powershell.exe -Command "[System.Reflection.Assembly]::LoadWithPartialName('System.Windows.Forms'); [System.Windows.Forms.MessageBox]::Show('Claude Code needs your attention', 'Claude Code')"

~~57 ```~~

~~58 </Tab>~~

~~59 </Tabs>~~

60 </Step>46 </Step>

61 47

~~62 <Step title="Choose a storage location">~~48 <Step title="Verify the configuration">

63 The menu asks where to save the hook configuration. Select `User settings` to store it in `~/.claude/settings.json`, which applies the hook to all your projects. You could also choose `Project settings` to scope it to the current project. See [Configure hook location](#configure-hook-location) for all available scopes.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.

64 </Step>50 </Step>

65 51

66 <Step title="Test the hook">52 <Step title="Test the hook">

68 </Step>54 </Step>

69</Steps>55</Steps>

70 56

57<Tip>

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>

71## What you can automate61## What you can automate

72 62

73Hooks 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).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).

78* [Auto-format code after edits](#auto-format-code-after-edits)68* [Auto-format code after edits](#auto-format-code-after-edits)

79* [Block edits to protected files](#block-edits-to-protected-files)69* [Block edits to protected files](#block-edits-to-protected-files)

80* [Re-inject context after compaction](#re-inject-context-after-compaction)70* [Re-inject context after compaction](#re-inject-context-after-compaction)

71* [Audit configuration changes](#audit-configuration-changes)

81 72

82### Get notified when Claude needs input73### Get notified when Claude needs input

83 74

84Get a desktop notification whenever Claude finishes working and needs your input, so you can switch to other tasks without checking the terminal.75Get a desktop notification whenever Claude finishes working and needs your input, so you can switch to other tasks without checking the terminal.

85 76

86This 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`, or use the [interactive walkthrough](#set-up-your-first-hook) above to configure it with `/hooks`:77This 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`:

87 78

88<Tabs>79<Tabs>

89 <Tab title="macOS">80 <Tab title="macOS">

262 253

263You 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.254You 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.

264 255

256### Audit configuration changes

257

258Track 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.

259

260This example appends each change to an audit log. Add this to `~/.claude/settings.json`:

261

262```json theme={null}

263{

264 "hooks": {

265 "ConfigChange": [

266 {

267 "matcher": "",

268 "hooks": [

269 {

270 "type": "command",

271 "command": "jq -c '{timestamp: now | todate, source: .source, file: .file_path}' >> ~/claude-config-audit.log"

272 }

273 ]

274 }

275 ]

276 }

277}

278```

279

280The 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.

281

265## How hooks work282## How hooks work

266 283

267Hook 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:284Hook 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:

268 285

269| Event | When it fires |286| Event | When it fires |

270| :------------------- | :--------------------------------------------------- |287| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |

298| `TeammateIdle` | When an [agent team](/en/agent-teams) teammate is about to go idle |

299| `TaskCompleted` | When a task is being marked as completed |

300| `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 |

301| `ConfigChange` | When a configuration file changes during a session |

302| `WorktreeCreate` | When a worktree is being created via `--worktree` or `isolation: "worktree"`. Replaces default git behavior |

303| `WorktreeRemove` | When a worktree is being removed, either at session exit or when a subagent finishes |

305| `PostCompact` | After context compaction completes |

306| `Elicitation` | When an MCP server requests user input during a tool call |

307| `ElicitationResult` | After a user responds to an MCP elicitation, before the response is sent back to the server |

283 309

284Each hook has a `type` that determines how it runs. Most hooks use `"type": "command"`, which runs a shell command. Two other options use a Claude model to make decisions: `"type": "prompt"` for single-turn evaluation and `"type": "agent"` for multi-turn verification with tool access. See [Prompt-based hooks](#prompt-based-hooks) and [Agent-based hooks](#agent-based-hooks) for details.310Each hook has a `type` that determines how it runs. Most hooks use `"type": "command"`, which runs a shell command. Three other types are available:

311

312* `"type": "http"`: POST event data to a URL. See [HTTP hooks](#http-hooks).

313* `"type": "prompt"`: single-turn LLM evaluation. See [Prompt-based hooks](#prompt-based-hooks).

314* `"type": "agent"`: multi-turn verification with tool access. See [Agent-based hooks](#agent-based-hooks).

285 315

286### Read input and return output316### Read input and return output

287 317

303}333}

304```334```

305 335

306Your 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, 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.336Your 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.

307 337

308#### Hook output338#### Hook output

309 339

382Each event type matches on a specific field. Matchers support exact strings and regex patterns:412Each event type matches on a specific field. Matchers support exact strings and regex patterns:

383 413

385| :--------------------------------------------------------------------- | :------------------------ | :----------------------------------------------------------------------- |415| :---------------------------------------------------------------------------------------------- | :------------------------ | :--------------------------------------------------------------------------------- |

392| `UserPromptSubmit`, `Stop` | no matcher support | always fires on every occurrence |

423| `ConfigChange` | configuration source | `user_settings`, `project_settings`, `local_settings`, `policy_settings`, `skills` |

424| `UserPromptSubmit`, `Stop`, `TeammateIdle`, `TaskCompleted`, `WorktreeCreate`, `WorktreeRemove` | no matcher support | always fires on every occurrence |

394 425

395A few more examples showing matchers on different event types:426A few more examples showing matchers on different event types:

396 427

481 512

482You can also use the [`/hooks` menu](/en/hooks#the-hooks-menu) in Claude Code to add, delete, and view hooks interactively. To disable all hooks at once, use the toggle at the bottom of the `/hooks` menu or set `"disableAllHooks": true` in your settings file.513Run [`/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.

483 514

484Hooks added through the `/hooks` menu take effect immediately. If you edit settings files directly while Claude Code is running, the changes won't take effect until you review them in the `/hooks` menu or restart your session.515If you edit settings files directly while Claude Code is running, hook changes won't take effect until you review them in the `/hooks` menu or restart your session. This prevents unexpected hook modifications from taking effect mid-session.

485 516

486## Prompt-based hooks517## Prompt-based hooks

487 518

543 574

544For full configuration options, see [Agent-based hooks](/en/hooks#agent-based-hooks) in the reference.575For full configuration options, see [Agent-based hooks](/en/hooks#agent-based-hooks) in the reference.

545 576

577## HTTP hooks

578

579Use `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.

580

581HTTP 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.

582

583This example posts every tool use to a local logging service:

584

585```json theme={null}

586{

587 "hooks": {

588 "PostToolUse": [

589 {

590 "hooks": [

591 {

592 "type": "http",

593 "url": "http://localhost:8080/hooks/tool-use",

594 "headers": {

595 "Authorization": "Bearer $MY_TOKEN"

596 },

597 "allowedEnvVars": ["MY_TOKEN"]

598 }

599 ]

600 }

601 ]

602 }

603}

604```

605

606The 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.

607

608Header 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.

609

610For full configuration options and response handling, see [HTTP hooks](/en/hooks#http-hook-fields) in the reference.

611

546## Limitations and troubleshooting612## Limitations and troubleshooting

547 613

548### Limitations614### Limitations

549 615

550* Hooks communicate through stdout, stderr, and exit codes only. They cannot trigger slash commands or tool calls directly.616* 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.

551* Hook timeout is 10 minutes by default, configurable per hook with the `timeout` field (in seconds).617* Hook timeout is 10 minutes by default, configurable per hook with the `timeout` field (in seconds).

552* `PostToolUse` hooks cannot undo actions since the tool has already executed.618* `PostToolUse` hooks cannot undo actions since the tool has already executed.

553* `PermissionRequest` hooks do not fire in [non-interactive mode](/en/headless) (`-p`). Use `PreToolUse` hooks for automated permission decisions.619* `PermissionRequest` hooks do not fire in [non-interactive mode](/en/headless) (`-p`). Use `PreToolUse` hooks for automated permission decisions.

579 645

580You edited a settings file but the hooks don't appear in the menu.646You edited a settings file but the hooks don't appear in the menu.

581 647

582* Restart your session or open `/hooks` to reload. Hooks added through the `/hooks` menu take effect immediately, but manual file edits require a reload.648* Restart your session or open `/hooks` to reload. Manual file edits require a reload before they take effect.

583* Verify your JSON is valid (trailing commas and comments are not allowed)649* Verify your JSON is valid (trailing commas and comments are not allowed)

584* Confirm the settings file is in the correct location: `.claude/settings.json` for project hooks, `~/.claude/settings.json` for global hooks650* Confirm the settings file is in the correct location: `.claude/settings.json` for project hooks, `~/.claude/settings.json` for global hooks

585 651

604 670

605When 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:671When 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:

606 672

607```673```text theme={null}

608Shell ready on arm64674Shell ready on arm64

609{"decision": "block", "reason": "Not allowed"}675{"decision": "block", "reason": "Not allowed"}

610```676```

how-claude-code-works.md +46 −25

Details

14 14

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.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.

16 16

17<img src="https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/agentic-loop.svg?fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=e30acfc80d6ff01ec877dd19c7af58b2" 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." data-og-width="720" width="720" data-og-height="280" height="280" data-path="images/agentic-loop.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/agentic-loop.svg?w=280&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=8620f6ebce761a1e8bbf7f0a0255cc15 280w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/agentic-loop.svg?w=560&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=7b46b5ff4454aa4a03725eee625b39a0 560w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/agentic-loop.svg?w=840&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=7fa0397bc37d147e3bf3bb6296c6477f 840w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/agentic-loop.svg?w=1100&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=73b2a7040c4c93821c4d5bbee9f4a2d4 1100w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/agentic-loop.svg?w=1650&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=17703cbeb6f59b40a00ab24f56d5f8f9 1650w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/agentic-loop.svg?w=2500&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=20dedb60b95d45a1bd60a0cccaf3e1ff 2500w" />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" />

18 18

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.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.

20 20

34 34

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.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.

36 36

~~37The built-in tools generally fall into four categories, each representing a different kind of agency.~~37The built-in tools generally fall into five categories, each representing a different kind of agency.

38 38

39| Category | What Claude can do |39| Category | What Claude can do |

40| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |40| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |

44| **Web** | Search the web, fetch documentation, look up error messages |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)) |45| **Code intelligence** | See type errors and warnings after edits, jump to definitions, find references (requires [code intelligence plugins](/en/discover-plugins#code-intelligence)) |

46 46

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/settings#tools-available-to-claude) for the complete list.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.

48 48

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: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:

50 50

61 61

62## What Claude can access62## What Claude can access

63 63

~~64This guide focuses on the terminal. Claude Code also runs in [VS Code, JetBrains IDEs, and other environments](/en/ide-integrations).~~64This guide focuses on the terminal. Claude Code also runs in [VS Code](/en/vs-code), [JetBrains IDEs](/en/jetbrains), and other environments.

65 65

66When you run `claude` in a directory, Claude Code gains access to:66When you run `claude` in a directory, Claude Code gains access to:

67 67

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.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.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.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.

72* **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.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.

73 74

74Because 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.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.

75 76

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.

76## Work with sessions95## Work with sessions

77 96

78Claude 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.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.

79 98

80**Sessions are ephemeral.** Unlike claude.ai, Claude Code has no persistent memory between sessions. Each new session starts fresh. Claude doesn't "learn" your preferences over time or remember what you worked on last week. If you want Claude to know something across sessions, put it in your [CLAUDE.md](/en/memory).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).

81 100

82### Work across branches101### Work across branches

83 102

91 110

92When 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.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.

93 112

94<img src="https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/session-continuity.svg?fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=f671b603cc856119c95475b9084ebfef" alt="Session continuity: resume continues the same session, fork creates a new branch with a new ID." data-og-width="560" width="560" data-og-height="280" height="280" data-path="images/session-continuity.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/session-continuity.svg?w=280&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=bddf1f33d419a27d7427acdf06058804 280w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/session-continuity.svg?w=560&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=417478eb9b86003b8eebaac058a8618a 560w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/session-continuity.svg?w=840&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=1d89d26e2c0487f067d187c3fa5f7170 840w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/session-continuity.svg?w=1100&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=8ea739a1f7860e4edbbcf74d444e37b2 1100w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/session-continuity.svg?w=1650&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=9cb5095d6a8920f04c3b78d31a69c809 1650w, https://mintcdn.com/claude-code/ELkJZG54dIaeldDC/images/session-continuity.svg?w=2500&fit=max&auto=format&n=ELkJZG54dIaeldDC&q=85&s=d67e1744e4878813d20c6c3f39d9459d 2500w" />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" />

95 114

96To branch off and try a different approach without affecting the original session, use the `--fork-session` flag:115To branch off and try a different approach without affecting the original session, use the `--fork-session` flag:

97 116

165 184

166Claude Code is conversational. You don't need perfect prompts. Start with what you want, then refine:185Claude Code is conversational. You don't need perfect prompts. Start with what you want, then refine:

167 186

187```text theme={null}

188Fix the login bug

168```189```

169> Fix the login bug

170 190

171[Claude investigates, tries something]191\[Claude investigates, tries something]

172 192

173> That's not quite right. The issue is in the session handling.193```text theme={null}

~~174~~ 194That's not quite right. The issue is in the session handling.

175[Claude adjusts approach]

176```195```

177 196

197\[Claude adjusts approach]

198

178When the first attempt isn't right, you don't start over. You iterate.199When the first attempt isn't right, you don't start over. You iterate.

179 200

180#### Interrupt and steer201#### Interrupt and steer

185 206

186The more precise your initial prompt, the fewer corrections you'll need. Reference specific files, mention constraints, and point to example patterns.207The more precise your initial prompt, the fewer corrections you'll need. Reference specific files, mention constraints, and point to example patterns.

187 208

188```209```text theme={null}

189> The checkout flow is broken for users with expired cards.210The checkout flow is broken for users with expired cards.

190> Check src/payments/ for the issue, especially token refresh.211Check src/payments/ for the issue, especially token refresh.

191> Write a failing test first, then fix it.212Write a failing test first, then fix it.

192```213```

193 214

194Vague prompts like "fix the login bug" work, but you'll spend more time steering. Specific prompts like the above often succeed on the first attempt.215Vague prompts work, but you'll spend more time steering. Specific prompts like the one above often succeed on the first attempt.

195 216

196### Give Claude something to verify against217### Give Claude something to verify against

197 218

198Claude performs better when it can check its own work. Include test cases, paste screenshots of expected UI, or define the output you want.219Claude performs better when it can check its own work. Include test cases, paste screenshots of expected UI, or define the output you want.

199 220

200```221```text theme={null}

201> Implement validateEmail. Test cases: 'user@example.com' → true,222Implement validateEmail. Test cases: 'user@example.com' → true,

202> 'invalid' → false, 'user@.com' → false. Run the tests after.223'invalid' → false, 'user@.com' → false. Run the tests after.

203```224```

204 225

205For visual work, paste a screenshot of the design and ask Claude to compare its implementation against it.226For visual work, paste a screenshot of the design and ask Claude to compare its implementation against it.

208 229

209For complex problems, separate research from coding. Use plan mode (`Shift+Tab` twice) to analyze the codebase first:230For complex problems, separate research from coding. Use plan mode (`Shift+Tab` twice) to analyze the codebase first:

210 231

211```232```text theme={null}

212> Read src/auth/ and understand how we handle sessions.233Read src/auth/ and understand how we handle sessions.

213> Then create a plan for adding OAuth support.234Then create a plan for adding OAuth support.

214```235```

215 236

216Review the plan, refine it through conversation, then let Claude implement. This two-phase approach produces better results than jumping straight to code.237Review the plan, refine it through conversation, then let Claude implement. This two-phase approach produces better results than jumping straight to code.

219 240

220Think of delegating to a capable colleague. Give context and direction, then trust Claude to figure out the details:241Think of delegating to a capable colleague. Give context and direction, then trust Claude to figure out the details:

221 242

222```243```text theme={null}

223> The checkout flow is broken for users with expired cards.244The checkout flow is broken for users with expired cards.

224> The relevant code is in src/payments/. Can you investigate and fix it?245The relevant code is in src/payments/. Can you investigate and fix it?

225```246```

226 247

227You don't need to specify which files to read or what commands to run. Claude figures that out.248You don't need to specify which files to read or what commands to run. Claude figures that out.

interactive-mode.md +39 −53

Details

13 13

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: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:

15 15

~~16 * **iTerm2**: Settings → Profiles → Keys → Set Left/Right Option key to "Esc+"~~16 * **iTerm2**: settings → Profiles → Keys → set Left/Right Option key to "Esc+"

~~17 * **Terminal.app**: Settings → Profiles → Keyboard → Check "Use Option as Meta Key"~~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+"~~18 * **VS Code**: settings → Profiles → Keys → set Left/Right Option key to "Esc+"

19 19

20 See [Terminal configuration](/en/terminal-config) for details.20 See [Terminal configuration](/en/terminal-config) for details.

21</Note>21</Note>

23### General controls23### General controls

24 24

~~26| :------------------------------------------------ | :--------------------------------- | :-------------------------------------------------------------------------------------------- |~~26| :------------------------------------------------ | :------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------- |

28| `Ctrl+F` | Kill all background agents. Press twice within 3 seconds to confirm | Background agent control |

36| `Ctrl+T` | Toggle task list | Show or hide the [task list](#task-list) in the terminal status area |

40| `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 |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 |

41 43

84 86

85## Built-in commands87## Built-in commands

86 88

87Built-in commands are shortcuts for common actions. The table below covers commonly used commands but not all available options. Type `/` in Claude Code to see the full list, or type `/` followed by any letters to filter.89Type `/` 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.

88 90

~~89To create your own commands you can invoke with `/`, see [skills](/en/skills).~~91See the [commands reference](/en/commands) for the full list of built-in commands. To create your own commands, see [skills](/en/skills).

~~91| Command | Purpose |~~

~~92| :------------------------ | :-------------------------------------------------------------------------------------------------------------------------- |~~

~~93| `/clear` | Clear conversation history |~~

~~94| `/compact [instructions]` | Compact conversation with optional focus instructions |~~

~~95| `/config` | Open the Settings interface (Config tab) |~~

~~96| `/context` | Visualize current context usage as a colored grid |~~

~~97| `/cost` | Show token usage statistics. See [cost tracking guide](/en/costs#using-the-cost-command) for subscription-specific details. |~~

~~98| `/debug [description]` | Troubleshoot the current session by reading the session debug log. Optionally describe the issue |~~

~~99| `/doctor` | Checks the health of your Claude Code installation |~~

100| `/exit` | Exit the REPL |

101| `/export [filename]` | Export the current conversation to a file or clipboard |

102| `/help` | Get usage help |

103| `/init` | Initialize project with `CLAUDE.md` guide |

104| `/mcp` | Manage MCP server connections and OAuth authentication |

105| `/memory` | Edit `CLAUDE.md` memory files |

106| `/model` | Select or change the AI model. The change takes effect immediately without waiting for the current response to finish |

107| `/permissions` | View or update [permissions](/en/permissions#manage-permissions) |

108| `/plan` | Enter plan mode directly from the prompt |

109| `/rename <name>` | Rename the current session for easier identification |

110| `/resume [session]` | Resume a conversation by ID or name, or open the session picker |

111| `/rewind` | Rewind the conversation and/or code |

112| `/stats` | Visualize daily usage, session history, streaks, and model preferences |

113| `/status` | Open the Settings interface (Status tab) showing version, model, account, and connectivity |

114| `/statusline` | Set up Claude Code's status line UI |

115| `/copy` | Copy the last assistant response to clipboard |

116| `/tasks` | List and manage background tasks |

117| `/teleport` | Resume a remote session from claude.ai (subscribers only) |

118| `/theme` | Change the color theme |

119| `/todos` | List current TODO items |

120| `/usage` | For subscription plans only: show plan usage limits and rate limit status |

~~121~~

122### MCP prompts

~~123~~

124MCP 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.

125 92

126## Vim editor mode93## Vim editor mode

127 94

201 168

202Claude Code maintains command history for the current session:169Claude Code maintains command history for the current session:

203 170

204* History is stored per working directory171* Input history is stored per working directory

205* Cleared with `/clear` command172* Input history resets when you run `/clear` to start a new session. The previous session's conversation is preserved and can be resumed.

206* Use Up/Down arrows to navigate (see keyboard shortcuts above)173* Use Up/Down arrows to navigate (see keyboard shortcuts above)

207* **Note**: History expansion (`!`) is disabled by default174* **Note**: history expansion (`!`) is disabled by default

208 175

209### Reverse search with Ctrl+R176### Reverse search with Ctrl+R

210 177

211Press `Ctrl+R` to interactively search through your command history:178Press `Ctrl+R` to interactively search through your command history:

212 179

2131. **Start search**: Press `Ctrl+R` to activate reverse history search1801. **Start search**: press `Ctrl+R` to activate reverse history search

2142. **Type query**: Enter text to search for in previous commands - the search term will be highlighted in matching results1812. **Type query**: enter text to search for in previous commands. The search term is highlighted in matching results

2153. **Navigate matches**: Press `Ctrl+R` again to cycle through older matches1823. **Navigate matches**: press `Ctrl+R` again to cycle through older matches

2164. **Accept match**:1834. **Accept match**:

217 * Press `Tab` or `Esc` to accept the current match and continue editing184 * Press `Tab` or `Esc` to accept the current match and continue editing

218 * Press `Enter` to accept and execute the command immediately185 * Press `Enter` to accept and execute the command immediately

220 * Press `Ctrl+C` to cancel and restore your original input187 * Press `Ctrl+C` to cancel and restore your original input

221 * Press `Backspace` on empty search to cancel188 * Press `Backspace` on empty search to cancel

222 189

223The search displays matching commands with the search term highlighted, making it easy to find and reuse previous inputs.190The search displays matching commands with the search term highlighted, so you can find and reuse previous inputs.

224 191

225## Background bash commands192## Background bash commands

226 193

241* Background tasks have unique IDs for tracking and output retrieval208* Background tasks have unique IDs for tracking and output retrieval

242* Background tasks are automatically cleaned up when Claude Code exits209* Background tasks are automatically cleaned up when Claude Code exits

243 210

244To disable all background task functionality, set the `CLAUDE_CODE_DISABLE_BACKGROUND_TASKS` environment variable to `1`. See [Environment variables](/en/settings#environment-variables) for details.211To disable all background task functionality, set the `CLAUDE_CODE_DISABLE_BACKGROUND_TASKS` environment variable to `1`. See [Environment variables](/en/env-vars) for details.

245 212

246**Common backgrounded commands:**213**Common backgrounded commands:**

247 214

268* Supports the same `Ctrl+B` backgrounding for long-running commands235* Supports the same `Ctrl+B` backgrounding for long-running commands

269* Does not require Claude to interpret or approve the command236* Does not require Claude to interpret or approve the command

270* Supports history-based autocomplete: type a partial command and press **Tab** to complete from previous `!` commands in the current project237* Supports history-based autocomplete: type a partial command and press **Tab** to complete from previous `!` commands in the current project

238* Exit with `Escape`, `Backspace`, or `Ctrl+U` on an empty prompt

271 239

272This is useful for quick shell operations while maintaining conversation context.240This is useful for quick shell operations while maintaining conversation context.

273 241

290export CLAUDE_CODE_ENABLE_PROMPT_SUGGESTION=false258export CLAUDE_CODE_ENABLE_PROMPT_SUGGESTION=false

291```259```

292 260

261## Side questions with /btw

262

263Use `/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.

264

265```

266/btw what was the name of that config file again?

267```

268

269Side 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.

270

271* **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.

272* **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.

273* **Single response**: there are no follow-up turns. If you need a back-and-forth, use a normal prompt instead.

274* **Low cost**: the side question reuses the parent conversation's prompt cache, so the additional cost is minimal.

275

276Press **Space**, **Enter**, or **Escape** to dismiss the answer and return to the prompt.

277

278`/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.

279

293## Task list280## Task list

294 281

295When 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.282When 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.

298* To see all tasks or clear them, ask Claude directly: "show me all tasks" or "clear all tasks"285* To see all tasks or clear them, ask Claude directly: "show me all tasks" or "clear all tasks"

299* Tasks persist across context compactions, helping Claude stay organized on larger projects286* Tasks persist across context compactions, helping Claude stay organized on larger projects

300* 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`287* 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`

301* To revert to the previous TODO list, set `CLAUDE_CODE_ENABLE_TASKS=false`.

302 288

303## PR review status289## PR review status

304 290

jetbrains.md +4 −1

Details

51 51

52```bash theme={null}52```bash theme={null}

53claude53claude

~~54> /ide~~54```

56```text theme={null}

57/ide

55```58```

56 59

57If 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.

keybindings.md +9 −5

Details

6 6

7> Customize keyboard shortcuts in Claude Code with a keybindings configuration file.7> Customize keyboard shortcuts in Claude Code with a keybindings configuration file.

8 8

9<Note>

10 Customizable keyboard shortcuts require Claude Code v2.1.18 or later. Check your version with `claude --version`.

11</Note>

9Claude Code supports customizable keyboard shortcuts. Run `/keybindings` to create or open your configuration file at `~/.claude/keybindings.json`.13Claude Code supports customizable keyboard shortcuts. Run `/keybindings` to create or open your configuration file at `~/.claude/keybindings.json`.

10 14

11## Configuration file15## Configuration file

57| `ThemePicker` | Theme picker dialog |61| `ThemePicker` | Theme picker dialog |

58| `Attachments` | Image/attachment bar navigation |62| `Attachments` | Image/attachment bar navigation |

59| `Footer` | Footer indicator navigation (tasks, teams, diff) |63| `Footer` | Footer indicator navigation (tasks, teams, diff) |

61| `DiffDialog` | Diff viewer navigation |65| `DiffDialog` | Diff viewer navigation |

62| `ModelPicker` | Model picker effort level |66| `ModelPicker` | Model picker effort level |

63| `Select` | Generic select/list components |67| `Select` | Generic select/list components |

221 225

223| :----------------------- | :---------------------------------------- | :---------------- |227| :----------------------- | :---------------------------------------- | :---------------- |

292 296

293For example:297For example:

294 298

295```299```text theme={null}

296ctrl+k Single key with modifier300ctrl+k Single key with modifier

297shift+tab Shift + Tab301shift+tab Shift + Tab

298meta+p Command/Meta + P302meta+p Command/Meta + P

309 313

310Chords are sequences of keystrokes separated by spaces:314Chords are sequences of keystrokes separated by spaces:

311 315

312```316```text theme={null}

313ctrl+k ctrl+s Press Ctrl+K, release, then Ctrl+S317ctrl+k ctrl+s Press Ctrl+K, release, then Ctrl+S

314```318```

315 319

legal-and-compliance.md +19 −2

Details

13Your use of Claude Code is subject to:13Your use of Claude Code is subject to:

14 14

15* [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

~~16* [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

17 17

18### Commercial agreements18### Commercial agreements

19 19

23 23

24### Healthcare compliance (BAA)24### Healthcare compliance (BAA)

25 25

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) 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).

27 44

28## Security and trust45## Security and trust

29 46

mcp.md +232 −43

Details

327{/* ### Example: Automate browser testing with Playwright327{/* ### Example: Automate browser testing with Playwright

328 328

329 ```bash329 ```bash

330 # 1. Add the Playwright MCP server

331 claude mcp add --transport stdio playwright -- npx -y @playwright/mcp@latest330 claude mcp add --transport stdio playwright -- npx -y @playwright/mcp@latest

331 ```

332

333 Then write and run browser tests:

332 334

333 # 2. Write and run browser tests335 ```text

334 > "Test if the login flow works with test@example.com"336 Test if the login flow works with test@example.com

335 > "Take a screenshot of the checkout page on mobile"337 ```

336 > "Verify that the search feature returns results"338 ```text

339 Take a screenshot of the checkout page on mobile

340 ```

341 ```text

342 Verify that the search feature returns results

337 ``` */}343 ``` */}

338 344

339### Example: Monitor errors with Sentry345### Example: Monitor errors with Sentry

340 346

341```bash theme={null}347```bash theme={null}

342# 1. Add the Sentry MCP server

343claude mcp add --transport http sentry https://mcp.sentry.dev/mcp348claude mcp add --transport http sentry https://mcp.sentry.dev/mcp

349```

350

351Authenticate with your Sentry account:

352

353```text theme={null}

354/mcp

355```

344 356

345# 2. Use /mcp to authenticate with your Sentry account357Then debug production issues:

346> /mcp358

359```text theme={null}

360What are the most common errors in the last 24 hours?

361```

347 362

348# 3. Debug production issues363```text theme={null}

349> "What are the most common errors in the last 24 hours?"364Show me the stack trace for error ID abc123

350> "Show me the stack trace for error ID abc123"365```

351> "Which deployment introduced these new errors?"366

367```text theme={null}

368Which deployment introduced these new errors?

352```369```

353 370

354### Example: Connect to GitHub for code reviews371### Example: Connect to GitHub for code reviews

355 372

356```bash theme={null}373```bash theme={null}

357# 1. Add the GitHub MCP server

358claude mcp add --transport http github https://api.githubcopilot.com/mcp/374claude mcp add --transport http github https://api.githubcopilot.com/mcp/

375```

359 376

360# 2. In Claude Code, authenticate if needed377Authenticate if needed by selecting "Authenticate" for GitHub:

361> /mcp

362# Select "Authenticate" for GitHub

363 378

364# 3. Now you can ask Claude to work with GitHub379```text theme={null}

365> "Review PR #456 and suggest improvements"380/mcp

366> "Create a new issue for the bug we just found"381```

367> "Show me all open PRs assigned to me"382

383Then work with GitHub:

384

385```text theme={null}

386Review PR #456 and suggest improvements

387```

388

389```text theme={null}

390Create a new issue for the bug we just found

391```

392

393```text theme={null}

394Show me all open PRs assigned to me

368```395```

369 396

370### Example: Query your PostgreSQL database397### Example: Query your PostgreSQL database

371 398

372```bash theme={null}399```bash theme={null}

373# 1. Add the database server with your connection string

374claude mcp add --transport stdio db -- npx -y @bytebase/dbhub \400claude mcp add --transport stdio db -- npx -y @bytebase/dbhub \

375 --dsn "postgresql://readonly:pass@prod.db.com:5432/analytics"401 --dsn "postgresql://readonly:pass@prod.db.com:5432/analytics"

402```

403

404Then query your database naturally:

405

406```text theme={null}

407What's our total revenue this month?

408```

409

410```text theme={null}

411Show me the schema for the orders table

412```

376 413

377# 2. Query your database naturally414```text theme={null}

378> "What's our total revenue this month?"415Find customers who haven't made a purchase in 90 days

379> "Show me the schema for the orders table"

380> "Find customers who haven't made a purchase in 90 days"

381```416```

382 417

383## Authenticate with remote MCP servers418## Authenticate with remote MCP servers

396 <Step title="Use the /mcp command within Claude Code">431 <Step title="Use the /mcp command within Claude Code">

397 In Claude code, use the command:432 In Claude code, use the command:

398 433

399 ```434 ```text theme={null}

400 > /mcp435 /mcp

401 ```436 ```

402 437

403 Then follow the steps in your browser to login.438 Then follow the steps in your browser to login.

409 444

410 * Authentication tokens are stored securely and refreshed automatically445 * Authentication tokens are stored securely and refreshed automatically

411 * Use "Clear authentication" in the `/mcp` menu to revoke access446 * Use "Clear authentication" in the `/mcp` menu to revoke access

412 * If your browser doesn't open automatically, copy the provided URL447 * If your browser doesn't open automatically, copy the provided URL and open it manually

448 * 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

413 * OAuth authentication works with HTTP servers449 * OAuth authentication works with HTTP servers

414</Tip>450</Tip>

415 451

452### Use a fixed OAuth callback port

453

454Some 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`.

455

456You can use `--callback-port` on its own (with dynamic client registration) or together with `--client-id` (with pre-configured credentials).

457

458```bash theme={null}

459# Fixed callback port with dynamic client registration

460claude mcp add --transport http \

461 --callback-port 8080 \

462 my-server https://mcp.example.com/mcp

463```

464

465### Use pre-configured OAuth credentials

466

467Some MCP servers don't support automatic OAuth setup. If you see an error like "Incompatible auth server: does not support dynamic client registration," the server requires pre-configured credentials. Register an OAuth app through the server's developer portal first, then provide the credentials when adding the server.

468

469<Steps>

470 <Step title="Register an OAuth app with the server">

471 Create an app through the server's developer portal and note your client ID and client secret.

472

473 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.

474 </Step>

475

476 <Step title="Add the server with your credentials">

477 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.

478

479 <Tabs>

480 <Tab title="claude mcp add">

481 Use `--client-id` to pass your app's client ID. The `--client-secret` flag prompts for the secret with masked input:

482

483 ```bash theme={null}

484 claude mcp add --transport http \

485 --client-id your-client-id --client-secret --callback-port 8080 \

486 my-server https://mcp.example.com/mcp

487 ```

488 </Tab>

489

490 <Tab title="claude mcp add-json">

491 Include the `oauth` object in the JSON config and pass `--client-secret` as a separate flag:

492

493 ```bash theme={null}

494 claude mcp add-json my-server \

495 '{"type":"http","url":"https://mcp.example.com/mcp","oauth":{"clientId":"your-client-id","callbackPort":8080}}' \

496 --client-secret

497 ```

498 </Tab>

499

500 <Tab title="claude mcp add-json (callback port only)">

501 Use `--callback-port` without a client ID to fix the port while using dynamic client registration:

502

503 ```bash theme={null}

504 claude mcp add-json my-server \

505 '{"type":"http","url":"https://mcp.example.com/mcp","oauth":{"callbackPort":8080}}'

506 ```

507 </Tab>

508

509 <Tab title="CI / env var">

510 Set the secret via environment variable to skip the interactive prompt:

511

512 ```bash theme={null}

513 MCP_CLIENT_SECRET=your-secret claude mcp add --transport http \

514 --client-id your-client-id --client-secret --callback-port 8080 \

515 my-server https://mcp.example.com/mcp

516 ```

517 </Tab>

518 </Tabs>

519 </Step>

520

521 <Step title="Authenticate in Claude Code">

522 Run `/mcp` in Claude Code and follow the browser login flow.

523 </Step>

524</Steps>

525

526<Tip>

527 Tips:

528

529 * The client secret is stored securely in your system keychain (macOS) or a credentials file, not in your config

530 * If the server uses a public OAuth client with no secret, use only `--client-id` without `--client-secret`

531 * `--callback-port` can be used with or without `--client-id`

532 * These flags only apply to HTTP and SSE transports. They have no effect on stdio servers

533 * Use `claude mcp get <name>` to verify that OAuth credentials are configured for a server

534</Tip>

535

536### Override OAuth metadata discovery

537

538If 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.

539

540Set `authServerMetadataUrl` in the `oauth` object of your server's config in `.mcp.json`:

541

542```json theme={null}

543{

544 "mcpServers": {

545 "my-server": {

546 "type": "http",

547 "url": "https://mcp.example.com/mcp",

548 "oauth": {

549 "authServerMetadataUrl": "https://auth.example.com/.well-known/openid-configuration"

550 }

551 }

552 }

553}

554```

555

556The URL must use `https://`. This option requires Claude Code v2.1.64 or later.

557

416## Add MCP servers from JSON configuration558## Add MCP servers from JSON configuration

417 559

418If you have a JSON configuration for an MCP server, you can add it directly:560If you have a JSON configuration for an MCP server, you can add it directly:

428 570

429 # Example: Adding a stdio server with JSON configuration571 # Example: Adding a stdio server with JSON configuration

430 claude mcp add-json local-weather '{"type":"stdio","command":"/path/to/weather-cli","args":["--api-key","abc123"],"env":{"CACHE_DIR":"/tmp"}}'572 claude mcp add-json local-weather '{"type":"stdio","command":"/path/to/weather-cli","args":["--api-key","abc123"],"env":{"CACHE_DIR":"/tmp"}}'

573

574 # Example: Adding an HTTP server with pre-configured OAuth credentials

575 claude mcp add-json my-server '{"type":"http","url":"https://mcp.example.com/mcp","oauth":{"clientId":"your-client-id","callbackPort":8080}}' --client-secret

431 ```576 ```

432 </Step>577 </Step>

433 578

479 * If servers with the same names already exist, they will get a numerical suffix (for example, `server_1`)624 * If servers with the same names already exist, they will get a numerical suffix (for example, `server_1`)

480</Tip>625</Tip>

481 626

627## Use MCP servers from Claude.ai

628

629If 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:

630

631<Steps>

632 <Step title="Configure MCP servers in Claude.ai">

633 Add servers at [claude.ai/settings/connectors](https://claude.ai/settings/connectors). On Team and Enterprise plans, only admins can add servers.

634 </Step>

635

636 <Step title="Authenticate the MCP server">

637 Complete any required authentication steps in Claude.ai.

638 </Step>

639

640 <Step title="View and manage servers in Claude Code">

641 In Claude Code, use the command:

642

643 ```text theme={null}

644 /mcp

645 ```

646

647 Claude.ai servers appear in the list with indicators showing they come from Claude.ai.

648 </Step>

649</Steps>

650

651To disable claude.ai MCP servers in Claude Code, set the `ENABLE_CLAUDEAI_MCP_SERVERS` environment variable to `false`:

652

653```bash theme={null}

654ENABLE_CLAUDEAI_MCP_SERVERS=false claude

655```

656

482## Use Claude Code as an MCP server657## Use Claude Code as an MCP server

483 658

484You can use Claude Code itself as an MCP server that other applications can connect to:659You can use Claude Code itself as an MCP server that other applications can connect to:

564 If you frequently encounter output warnings with specific MCP servers, consider increasing the limit or configuring the server to paginate or filter its responses.739 If you frequently encounter output warnings with specific MCP servers, consider increasing the limit or configuring the server to paginate or filter its responses.

565</Warning>740</Warning>

566 741

742## Respond to MCP elicitation requests

743

744MCP 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.

745

746Servers can request input in two ways:

747

748* **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.

749* **URL mode**: Claude Code opens a browser URL for authentication or approval. Complete the flow in the browser, then confirm in the CLI.

750

751To auto-respond to elicitation requests without showing a dialog, use the [`Elicitation` hook](/en/hooks#elicitation).

752

753If 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.

754

567## Use MCP resources755## Use MCP resources

568 756

569MCP servers can expose resources that you can reference using @ mentions, similar to how you reference files.757MCP servers can expose resources that you can reference using @ mentions, similar to how you reference files.

578 <Step title="Reference a specific resource">766 <Step title="Reference a specific resource">

579 Use the format `@server:protocol://resource/path` to reference a resource:767 Use the format `@server:protocol://resource/path` to reference a resource:

580 768

581 ```769 ```text theme={null}

582 > Can you analyze @github:issue://123 and suggest a fix?770 Can you analyze @github:issue://123 and suggest a fix?

583 ```771 ```

584 772

585 ```773 ```text theme={null}

586 > Please review the API documentation at @docs:file://api/authentication774 Please review the API documentation at @docs:file://api/authentication

587 ```775 ```

588 </Step>776 </Step>

589 777

590 <Step title="Multiple resource references">778 <Step title="Multiple resource references">

591 You can reference multiple resources in a single prompt:779 You can reference multiple resources in a single prompt:

592 780

593 ```781 ```text theme={null}

594 > Compare @postgres:schema://users with @docs:file://database/user-model782 Compare @postgres:schema://users with @docs:file://database/user-model

595 ```783 ```

596 </Step>784 </Step>

597</Steps>785</Steps>

630 818

631### Configure tool search819### Configure tool search

632 820

633Tool search runs in auto mode by default, meaning it activates only when your MCP tool definitions exceed the context threshold. If you have few tools, they load normally without tool search. 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.821Tool 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.

634 822

635Control tool search behavior with the `ENABLE_TOOL_SEARCH` environment variable:823Control tool search behavior with the `ENABLE_TOOL_SEARCH` environment variable:

636 824

637| Value | Behavior |825| Value | Behavior |

638| :--------- | :--------------------------------------------------------------------------------- |826| :--------- | :--------------------------------------------------------------------------------- |

828| `true` | Always enabled, including for non-first-party `ANTHROPIC_BASE_URL` |

829| `auto` | Activates when MCP tools exceed 10% of context |

641| `true` | Always enabled |

643 832

644```bash theme={null}833```bash theme={null}

673 </Step>862 </Step>

674 863

675 <Step title="Execute a prompt without arguments">864 <Step title="Execute a prompt without arguments">

676 ```865 ```text theme={null}

677 > /mcp__github__list_prs866 /mcp__github__list_prs

678 ```867 ```

679 </Step>868 </Step>

680 869

681 <Step title="Execute a prompt with arguments">870 <Step title="Execute a prompt with arguments">

682 Many prompts accept arguments. Pass them space-separated after the command:871 Many prompts accept arguments. Pass them space-separated after the command:

683 872

684 ```873 ```text theme={null}

685 > /mcp__github__pr_review 456874 /mcp__github__pr_review 456

686 ```875 ```

687 876

688 ```877 ```text theme={null}

689 > /mcp__jira__create_issue "Bug in login flow" high878 /mcp__jira__create_issue "Bug in login flow" high

690 ```879 ```

691 </Step>880 </Step>

692</Steps>881</Steps>

memory.md +237 −118

Details

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt2> 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.3> Use this file to discover all available pages before exploring further.

4 4

~~5# Manage Claude's memory~~5# How Claude remembers your project

6 6

~~7> Learn how to manage Claude Code's memory across sessions with different memory locations and best practices.~~7> Give Claude persistent instructions with CLAUDE.md files, and let Claude accumulate learnings automatically with auto memory.

8 8

~~9Claude Code can remember your preferences across sessions, like style guidelines and common commands in your workflow.~~9Each Claude Code session begins with a fresh context window. Two mechanisms carry knowledge across sessions:

10 10

~~11## Determine memory type~~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

12 13

~~13Claude Code offers four memory locations in a hierarchical structure, each serving a different purpose:~~14This page covers how to:

14 15

16| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------- |17* [Scope rules to specific file types](#organize-rules-with-clauderules) with `.claude/rules/`

17| **Managed policy** | • macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md` • Linux: `/etc/claude-code/CLAUDE.md` • 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 |18* [Configure auto memory](#auto-memory) so Claude takes notes automatically

19| **Project rules** | `./.claude/rules/*.md` | Modular, topic-specific project instructions | Language-specific guidelines, testing conventions, API standards | Team members via source control |

22 20

23All 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.21## CLAUDE.md vs auto memory

24 22

~~25<Note>~~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.

~~26 CLAUDE.local.md files are automatically added to .gitignore, making them ideal for private project-specific preferences that shouldn't be checked into version control.~~

~~27</Note>~~

28 24

~~29## CLAUDE.md imports~~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 |

30 32

~~31CLAUDE.md files can import additional files using `@path/to/import` syntax. The following example imports 3 files:~~33Use CLAUDE.md files when you want to guide Claude's behavior. Auto memory lets Claude learn from your corrections without manual effort.

32 34

~~33```~~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` • Linux and WSL: `/etc/claude-code/CLAUDE.md` • 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-claudemd-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.

61</Tip>

63### Write effective instructions

65CLAUDE.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.

67**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.

69**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.

71**Specificity**: write instructions that are concrete enough to verify. For example:

73* "Use 2-space indentation" instead of "Format code properly"

74* "Run `npm test` before committing" instead of "Test your changes"

75* "API handlers live in `src/api/handlers/`" instead of "Keep files organized"

77**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-claudemd-files) to skip CLAUDE.md files from other teams that aren't relevant to your work.

79### Import additional files

81CLAUDE.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.

83Both 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.

85To pull in a README, package.json, and a workflow guide, reference them with `@` syntax anywhere in your CLAUDE.md:

87```text theme={null}

34See @README for project overview and @package.json for available npm commands for this project.88See @README for project overview and @package.json for available npm commands for this project.

35 89

36# Additional Instructions90# Additional Instructions

37- git workflow @docs/git-instructions.md91- git workflow @docs/git-instructions.md

38```92```

39 93

40Both relative and absolute paths are allowed. Relative paths resolve relative to the file containing the import, not the working directory. For private per-project preferences that shouldn't be checked into version control, prefer `CLAUDE.local.md`: it is automatically loaded and added to `.gitignore`.94For 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:

~~42If you work across multiple git worktrees, `CLAUDE.local.md` only exists in one. Use a home-directory import instead so all worktrees share the same personal instructions:~~

43 95

~~44```~~96```text theme={null}

45# Individual Preferences97# Individual Preferences

46- @~/.claude/my-project-instructions.md98- @~/.claude/my-project-instructions.md

47```99```

48 100

49<Warning>101<Warning>

50 The first time Claude Code encounters external imports in a project, it shows an approval dialog listing the specific files. Approve to load them; decline to skip them. This is a one-time decision per project: once declined, the dialog does not resurface and the imports remain disabled.102 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.

51</Warning>103</Warning>

52 104

~~53To avoid potential collisions, imports are not evaluated inside markdown code spans and code blocks.~~105For a more structured approach to organizing instructions, see [`.claude/rules/`](#organize-rules-with-clauderules).

~~55```~~

~~56This code span will not be treated as an import: `@anthropic-ai/claude-code`~~

~~57```~~

58 106

~~59Imported 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.~~107### How CLAUDE.md files load

60 108

~~61## How Claude looks up memories~~109Claude 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`.

62 110

63Claude 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*.111Claude 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.

64 112

~~65Claude 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.~~113If you work in a large monorepo where other teams' CLAUDE.md files get picked up, use [`claudeMdExcludes`](#exclude-specific-claudemd-files) to skip them.

66 114

~~67### Load memory from additional directories~~115#### Load from additional directories

68 116

69The `--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.117The `--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.

70 118

~~71To also load memory files (CLAUDE.md, .claude/CLAUDE.md, and .claude/rules/\*.md) from additional directories, set the `CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD` environment variable:~~119To 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:

72 120

73```bash theme={null}121```bash theme={null}

74CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1 claude --add-dir ../shared-config122CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1 claude --add-dir ../shared-config

75```123```

76 124

~~77## Directly edit memories with `/memory`~~125### Organize rules with `.claude/rules/`

~~79Use the `/memory` command during a session to open any memory file in your system editor for more extensive additions or organization.~~

~~81## Set up project memory~~

83Suppose 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`.

~~85Bootstrap a CLAUDE.md for your codebase with the following command:~~

~~87```~~

~~88> /init~~

~~89```~~

~~91<Tip>~~

~~92 Tips:~~

93 126

~~94 * Include frequently used commands (build, test, lint) to avoid repeated searches~~127For 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.

~~95 * Document code style preferences and naming conventions~~

~~96 * Add important architectural patterns specific to your project~~

~~97 * CLAUDE.md memories can be used for both instructions shared with your team and for your individual preferences.~~

~~98</Tip>~~

99 128

100## Modular rules with `.claude/rules/`129<Note>

~~101~~ 130 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.

102For larger projects, you can organize instructions into multiple files using the `.claude/rules/` directory. This allows teams to maintain focused, well-organized rule files instead of one large CLAUDE.md.131</Note>

103 132

104### Basic structure133#### Set up rules

105 134

106Place markdown files in your project's `.claude/rules/` directory:135Place 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/`:

107 136

108```137```text theme={null}

109your-project/138your-project/

110├── .claude/139├── .claude/

111│ ├── CLAUDE.md # Main project instructions140│ ├── CLAUDE.md # Main project instructions

115│ └── security.md # Security requirements144│ └── security.md # Security requirements

116```145```

117 146

118All `.md` files in `.claude/rules/` are automatically loaded as project memory, with the same priority as `.claude/CLAUDE.md`.147Rules without [`paths` frontmatter](#path-specific-rules) are loaded at launch with the same priority as `.claude/CLAUDE.md`.

119 148

120### Path-specific rules149#### Path-specific rules

121 150

122Rules 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.151Rules 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.

123 152

134- Include OpenAPI documentation comments163- Include OpenAPI documentation comments

135```164```

136 165

137Rules without a `paths` field are loaded unconditionally and apply to all files.166Rules 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.

138 167

139### Glob patterns168Use glob patterns in the `paths` field to match files by extension, directory, or any combination:

~~140~~

141The `paths` field supports standard glob patterns:

142 169

143| Pattern | Matches |170| Pattern | Matches |

144| ---------------------- | ---------------------------------------- |171| ---------------------- | ---------------------------------------- |

147| `*.md` | Markdown files in the project root |174| `*.md` | Markdown files in the project root |

148| `src/components/*.tsx` | React components in a specific directory |175| `src/components/*.tsx` | React components in a specific directory |

149 176

150You can specify multiple patterns:177You can specify multiple patterns and use brace expansion to match multiple extensions in one pattern:

151 178

152```markdown theme={null}179```markdown theme={null}

153---180---

154paths:181paths:

155 - "src/**/*.ts"182 - "src/**/*.{ts,tsx}"

156 - "lib/**/*.ts"183 - "lib/**/*.ts"

157 - "tests/**/*.test.ts"184 - "tests/**/*.test.ts"

158---185---

159```186```

160 187

161Brace expansion is supported for matching multiple extensions or directories:188#### Share rules across projects with symlinks

162 189

163```markdown theme={null}190The `.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.

164paths:

165 - "src/**/*.{ts,tsx}"

166 - "{src,lib}/**/*.ts"

167 191

168# TypeScript/React Rules192This example links both a shared directory and an individual file:

169```

170 193

171This expands `src/**/*.{ts,tsx}` to match both `.ts` and `.tsx` files.194```bash theme={null}

195ln -s ~/shared-claude-rules .claude/rules/shared

196ln -s ~/company-standards/security.md .claude/rules/security.md

197```

172 198

173### Subdirectories199#### User-level rules

174 200

175Rules can be organized into subdirectories for better structure:201Personal rules in `~/.claude/rules/` apply to every project on your machine. Use them for preferences that aren't project-specific:

176 202

203```text theme={null}

204~/.claude/rules/

205├── preferences.md # Your personal coding preferences

206└── workflows.md # Your preferred workflows

177```207```

178.claude/rules/208

179├── frontend/209User-level rules are loaded before project rules, giving project rules higher priority.

180│ ├── react.md210

181│ └── styles.md211### Manage CLAUDE.md for large teams

182├── backend/212

183│ ├── api.md213For organizations deploying Claude Code across teams, you can centralize instructions and control which CLAUDE.md files are loaded.

184│ └── database.md214

185└── general.md215#### Deploy organization-wide CLAUDE.md

216

217Organizations can deploy a centrally managed CLAUDE.md that applies to all users on a machine. This file cannot be excluded by individual settings.

218

219<Steps>

220 <Step title="Create the file at the managed policy location">

221 * macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`

222 * Linux and WSL: `/etc/claude-code/CLAUDE.md`

223 * Windows: `C:\Program Files\ClaudeCode\CLAUDE.md`

224 </Step>

225

226 <Step title="Deploy with your configuration management system">

227 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.

228 </Step>

229</Steps>

230

231#### Exclude specific CLAUDE.md files

232

233In 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.

234

235This 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:

236

237```json theme={null}

238{

239 "claudeMdExcludes": [

240 "**/monorepo/CLAUDE.md",

241 "/home/user/monorepo/other-team/.claude/rules/**"

242 ]

243}

186```244```

187 245

188All `.md` files are discovered recursively.246Patterns 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.

189 247

190### Symlinks248Managed policy CLAUDE.md files cannot be excluded. This ensures organization-wide instructions always apply regardless of individual settings.

191 249

192The `.claude/rules/` directory supports symlinks, allowing you to share common rules across multiple projects:250## Auto memory

193 251

194```bash theme={null}252Auto 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.

195# Symlink a shared rules directory

196ln -s ~/shared-claude-rules .claude/rules/shared

197 253

198# Symlink individual rule files254<Note>

199ln -s ~/company-standards/security.md .claude/rules/security.md255 Auto memory requires Claude Code v2.1.59 or later. Check your version with `claude --version`.

256</Note>

257

258### Enable or disable auto memory

259

260Auto 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:

261

262```json theme={null}

263{

264 "autoMemoryEnabled": false

265}

200```266```

201 267

202Symlinks are resolved and their contents are loaded normally. Circular symlinks are detected and handled gracefully.268To disable auto memory via environment variable, set `CLAUDE_CODE_DISABLE_AUTO_MEMORY=1`.

269

270### Storage location

203 271

204### User-level rules272Each 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.

205 273

206You can create personal rules that apply to all your projects in `~/.claude/rules/`:274To store auto memory in a different location, set `autoMemoryDirectory` in your user or local settings:

207 275

276```json theme={null}

277{

278 "autoMemoryDirectory": "~/my-custom-memory-dir"

279}

208```280```

209~/.claude/rules/281

210├── preferences.md # Your personal coding preferences282This 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.

211└── workflows.md # Your preferred workflows283

284The directory contains a `MEMORY.md` entrypoint and optional topic files:

285

286```text theme={null}

287~/.claude/projects/<project>/memory/

288├── MEMORY.md # Concise index, loaded into every session

289├── debugging.md # Detailed notes on debugging patterns

290├── api-conventions.md # API design decisions

291└── ... # Any other topic files Claude creates

212```292```

213 293

214User-level rules are loaded before project rules, giving project rules higher priority.294`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.

215 295

216<Tip>296Auto 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.

217 Best practices for `.claude/rules/`:297

298### How it works

299

300The 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.

301

302This 200-line limit applies only to `MEMORY.md`. CLAUDE.md files are loaded in full regardless of length, though shorter files produce better adherence.

303

304Topic 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.

305

306Claude 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/`.

307

308### Audit and edit your memory

309

310Auto 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.

218 311

219 * **Keep rules focused**: Each file should cover one topic (e.g., `testing.md`, `api-design.md`)312## View and edit with `/memory`

220 * **Use descriptive filenames**: The filename should indicate what the rules cover313

221 * **Use conditional rules sparingly**: Only add `paths` frontmatter when rules truly apply to specific file types314The `/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.

222 * **Organize with subdirectories**: Group related rules (e.g., `frontend/`, `backend/`)315

316When 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`.

317

318## Troubleshoot memory issues

319

320These are the most common issues with CLAUDE.md and auto memory, along with steps to debug them.

321

322### Claude isn't following my CLAUDE.md

323

324CLAUDE.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.

325

326To debug:

327

328* Run `/memory` to verify your CLAUDE.md files are being loaded. If a file isn't listed, Claude can't see it.

329* 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-claudemd-files)).

330* Make instructions more specific. "Use 2-space indentation" works better than "format code nicely."

331* Look for conflicting instructions across CLAUDE.md files. If two files give different guidance for the same behavior, Claude may pick one arbitrarily.

332

333For 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.

334

335<Tip>

336 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.

223</Tip>337</Tip>

224 338

225## Organization-level memory management339### I don't know what auto memory saved

340

341Run `/memory` and select the auto memory folder to browse what Claude has saved. Everything is plain markdown you can read, edit, or delete.

342

343### My CLAUDE.md is too large

226 344

227Organizations can deploy centrally managed CLAUDE.md files that apply to all users.345Files 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.

228 346

229To set up organization-level memory management:347### Instructions seem lost after `/compact`

230 348

2311. Create the managed memory file at the **Managed policy** location shown in the [memory types table above](#determine-memory-type).349CLAUDE.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.

232 350

2332. Deploy via your configuration management system (MDM, Group Policy, Ansible, etc.) to ensure consistent distribution across all developer machines.351See [Write effective instructions](#write-effective-instructions) for guidance on size, structure, and specificity.

234 352

235## Memory best practices353## Related resources

236 354

237* **Be specific**: "Use 2-space indentation" is better than "Format code properly".355* [Skills](/en/skills): package repeatable workflows that load on demand

238* **Use structure to organize**: Format each individual memory as a bullet point and group related memories under descriptive markdown headings.356* [Settings](/en/settings): configure Claude Code behavior with settings files

239* **Review periodically**: Update memories as your project evolves to ensure Claude is always using the most up to date information and context.357* [Manage sessions](/en/sessions): manage context, resume conversations, and run parallel sessions

358* [Subagent memory](/en/sub-agents#enable-persistent-memory): let subagents maintain their own auto memory

microsoft-foundry.md +18 −5

Details

14* RBAC permissions to create Microsoft Foundry resources and deployments14* RBAC permissions to create Microsoft Foundry resources and deployments

15* 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)

16 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>

17## Setup21## Setup

18 22

19### 1. Provision Microsoft Foundry resource23### 1. Provision Microsoft Foundry resource

59 63

60### 3. Configure Claude Code64### 3. Configure Claude Code

61 65

62Set 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:

63 67

64```bash theme={null}68```bash theme={null}

65# Enable Microsoft Foundry integration69# Enable Microsoft Foundry integration

69export ANTHROPIC_FOUNDRY_RESOURCE={resource}73export ANTHROPIC_FOUNDRY_RESOURCE={resource}

70# Or provide the full base URL:74# Or provide the full base URL:

71# export ANTHROPIC_FOUNDRY_BASE_URL=https://{resource}.services.ai.azure.com/anthropic75# export ANTHROPIC_FOUNDRY_BASE_URL=https://{resource}.services.ai.azure.com/anthropic

76```

72 77

~~73# Set models to your resource's deployment names~~78### 4. Pin model versions

~~74export 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'

75export ANTHROPIC_DEFAULT_HAIKU_MODEL='claude-haiku-4-5'89export ANTHROPIC_DEFAULT_HAIKU_MODEL='claude-haiku-4-5'

~~76export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-1'~~

77```90```

78 91

~~79For 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.

80 93

81## Azure RBAC configuration94## Azure RBAC configuration

82 95

model-config.md +156 −19

Details

12 12

13* A **model alias**13* A **model alias**

14* A **model name**14* A **model name**

~~15 * 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)**

16 * Bedrock: an inference profile ARN16 * Bedrock: an inference profile ARN

17 * Foundry: a deployment name17 * Foundry: a deployment name

18 * Vertex: a version name18 * Vertex: a version name

23remembering exact version numbers:23remembering exact version numbers:

24 24

25| Model alias | Behavior |25| Model alias | Behavior |

~~26| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |~~26| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

27| **`default`** | Recommended model setting, depending on your account type |27| **`default`** | Recommended model setting, depending on your account type |

30| **`haiku`** | Uses the fast and efficient Haiku model for simple tasks |30| **`haiku`** | Uses the fast and efficient Haiku model for simple tasks |

~~31| **`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 |

32| **`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 |

33 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`.

34### Setting your model37### Setting your model

35 38

36You 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:

53 56

54Example settings file:57Example settings file:

55 58

~~56```~~59```json theme={null}

57{60{

58 "permissions": {61 "permissions": {

59 ...62 ...

62}65}

63```66```

64 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

65## Special model behavior106## Special model behavior

66 107

67### `default` model setting108### `default` model setting

68 109

~~69The behavior of `default` depends on your account type.~~110The behavior of `default` depends on your account type:

70 111

~~71For certain Max users, Claude Code will automatically fall back to Sonnet if you~~112* **Max and Team Premium**: defaults to Opus 4.6

~~72hit a usage threshold with Opus.~~113* **Pro and Team Standard**: defaults to Sonnet 4.6

114* **Enterprise**: Opus 4.6 is available but not the default

115

116Claude Code may automatically fall back to Sonnet if you hit a usage threshold with Opus.

73 117

74### `opusplan` model setting118### `opusplan` model setting

75 119

83This 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,

84and Sonnet's efficiency for execution.128and Sonnet's efficiency for execution.

85 129

~~86### 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 applies to the current session without persisting. Opus 4.6 defaults to medium effort for Max and Team subscribers.

135

136**Setting effort:**

137

138* **`/effort`**: run `/effort low`, `/effort medium`, `/effort high`, or `/effort max` to change the level, or `/effort auto` to reset to the model default

139* **In `/model`**: use left/right arrow keys to adjust the effort slider when selecting a model

140* **`--effort` flag**: pass `low`, `medium`, `high`, or `max` to set the level for a single session when launching Claude Code

141* **Environment variable**: set `CLAUDE_CODE_EFFORT_LEVEL` to `low`, `medium`, `high`, `max`, or `auto`

142* **Settings**: set `effortLevel` in your settings file to `"low"`, `"medium"`, or `"high"`

143

144The environment variable takes precedence, then your configured level, then the model default.

145

146Effort 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`.

147

148To 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).

149

150### Extended context

151

152Opus 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.

87 153

~~88For Console/API users, the `[1m]` suffix can be added to full model names to~~154Availability 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.

~~89enable a~~155

~~90[1 million token context window](https://docs.claude.com/en/docs/build-with-claude/context-windows#1m-token-context-window).~~156| Plan | Opus 4.6 with 1M context | Sonnet 4.6 with 1M context |

157| ------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |

158| Max, Team, and Enterprise | Included with subscription | Requires [extra usage](https://support.claude.com/en/articles/12429409-extra-usage-for-paid-claude-plans) |

159| 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) |

160| API and pay-as-you-go | Full access | Full access |

161

162To 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).

163

164The 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.

165

166If 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.

167

168You can also use the `[1m]` suffix with model aliases or full model names:

91 169

92```bash theme={null}170```bash theme={null}

~~93# Example of using a full model name with the [1m] suffix~~171# Use the opus[1m] or sonnet[1m] alias

~~94/model anthropic.claude-sonnet-4-5-20250929-v1:0[1m]~~172/model opus[1m]

~~95```~~173/model sonnet[1m]

96 174

~~97Note: Extended context models have~~175# Or append [1m] to a full model name

~~98[different pricing](https://docs.claude.com/en/docs/about-claude/pricing#long-context-pricing).~~176/model claude-opus-4-6[1m]

177```

99 178

100## Checking your current model179## Checking your current model

101 180

119Note: `ANTHROPIC_SMALL_FAST_MODEL` is deprecated in favor of198Note: `ANTHROPIC_SMALL_FAST_MODEL` is deprecated in favor of

120`ANTHROPIC_DEFAULT_HAIKU_MODEL`.199`ANTHROPIC_DEFAULT_HAIKU_MODEL`.

121 200

201### Pin models for third-party deployments

202

203When 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.

204

205Without 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.

206

207<Warning>

208 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.

209</Warning>

210

211Use the following environment variables with version-specific model IDs for your provider:

212

213| Provider | Example |

214| :-------- | :---------------------------------------------------------------------- |

215| Bedrock | `export ANTHROPIC_DEFAULT_OPUS_MODEL='us.anthropic.claude-opus-4-6-v1'` |

216| Vertex AI | `export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6'` |

217| Foundry | `export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6'` |

218

219Apply 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.

220

221To 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`:

222

223```bash theme={null}

224export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-6[1m]'

225```

226

227The `[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.

228

229<Note>

230 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.

231</Note>

232

233### Override model IDs per version

234

235The 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.

236

237`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.

238

239This 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.

240

241Set `modelOverrides` in your [settings file](/en/settings#settings-files):

242

243```json theme={null}

244{

245 "modelOverrides": {

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

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

248 "claude-sonnet-4-6": "arn:aws:bedrock:us-east-2:123456789012:application-inference-profile/sonnet-prod"

249 }

250}

251```

252

253Keys 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.

254

255Overrides 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`.

256

257`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.

258

122### Prompt caching configuration259### Prompt caching configuration

123 260

124Claude 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:261Claude 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:

125 262

126| Environment variable | Description |263| Environment variable | Description |

127| ------------------------------- | ---------------------------------------------------------------------------------------------- |264| ------------------------------- | ---------------------------------------------------------------------------------------------- |

monitoring-usage.md +64 −38

Details

6 6

7> Learn how to enable and configure OpenTelemetry for Claude Code.7> Learn how to enable and configure OpenTelemetry for Claude Code.

8 8

~~9Claude 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.

11All 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.

12 10

13## Quick start11## Quick start

14 12

56 "OTEL_METRICS_EXPORTER": "otlp",54 "OTEL_METRICS_EXPORTER": "otlp",

57 "OTEL_LOGS_EXPORTER": "otlp",55 "OTEL_LOGS_EXPORTER": "otlp",

58 "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",56 "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",

~~59 "OTEL_EXPORTER_OTLP_ENDPOINT": "http://collector.company.com:4317",~~57 "OTEL_EXPORTER_OTLP_ENDPOINT": "http://collector.example.com:4317",

~~60 "OTEL_EXPORTER_OTLP_HEADERS": "Authorization=Bearer company-token"~~58 "OTEL_EXPORTER_OTLP_HEADERS": "Authorization=Bearer example-token"

61 }59 }

62}60}

63```61```

71### Common configuration variables69### Common configuration variables

72 70

~~74| ----------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------ |~~72| --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |

75| `CLAUDE_CODE_ENABLE_TELEMETRY` | Enables telemetry collection (required) | `1` |73| `CLAUDE_CODE_ENABLE_TELEMETRY` | Enables telemetry collection (required) | `1` |

88| `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` |

89| `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` | Metrics temporality preference (default: `delta`). Set to `cumulative` if your backend expects cumulative temporality | `delta`, `cumulative` |

91| `CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS` | Interval for refreshing dynamic headers (default: 1740000ms / 29 minutes) | `900000` |90| `CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS` | Interval for refreshing dynamic headers (default: 1740000ms / 29 minutes) | `900000` |

92 91

93### Metrics cardinality control92### Metrics cardinality control

149<Warning>148<Warning>

150 **Important formatting requirements for OTEL\_RESOURCE\_ATTRIBUTES:**149 **Important formatting requirements for OTEL\_RESOURCE\_ATTRIBUTES:**

151 150

152 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:

153 152

154 * **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

155 * **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`

175 174

176### Example configurations175### Example configurations

177 176

177Set these environment variables before running `claude`. Each block shows a complete configuration for a different exporter or deployment scenario:

178

178```bash theme={null}179```bash theme={null}

179# Console debugging (1-second intervals)180# Console debugging (1-second intervals)

180export CLAUDE_CODE_ENABLE_TELEMETRY=1181export CLAUDE_CODE_ENABLE_TELEMETRY=1

201export OTEL_METRICS_EXPORTER=otlp202export OTEL_METRICS_EXPORTER=otlp

202export OTEL_LOGS_EXPORTER=otlp203export OTEL_LOGS_EXPORTER=otlp

203export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf204export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=http/protobuf

204export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://metrics.company.com:4318205export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://metrics.example.com:4318

205export OTEL_EXPORTER_OTLP_LOGS_PROTOCOL=grpc206export OTEL_EXPORTER_OTLP_LOGS_PROTOCOL=grpc

206export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://logs.company.com:4317207export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://logs.example.com:4317

207 208

208# Metrics only (no events/logs)209# Metrics only (no events/logs)

209export CLAUDE_CODE_ENABLE_TELEMETRY=1210export CLAUDE_CODE_ENABLE_TELEMETRY=1

225All metrics and events share these standard attributes:226All metrics and events share these standard attributes:

226 227

228| ------------------- | -------------------------------------------------------------------- | --------------------------------------------------- |229| ------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------- |

235| `user.email` | User email address (when authenticated via OAuth) | Always included when available |

236| `terminal.type` | Terminal type, such as `iTerm.app`, `vscode`, `cursor`, or `tmux` | Always included when detected |

234 237

235### Metrics238### Metrics

236 239

249 252

250### Metric details253### Metric details

251 254

255Each metric includes the standard attributes listed above. Metrics with additional context-specific attributes are noted below.

256

252#### Session counter257#### Session counter

253 258

254Incremented at the start of each session.259Incremented at the start of each session.

289**Attributes**:294**Attributes**:

290 295

291* All [standard attributes](#standard-attributes)296* All [standard attributes](#standard-attributes)

292* `model`: Model identifier (for example, "claude-sonnet-4-5-20250929")297* `model`: Model identifier (for example, "claude-sonnet-4-6")

293 298

294#### Token counter299#### Token counter

295 300

299 304

300* All [standard attributes](#standard-attributes)305* All [standard attributes](#standard-attributes)

301* `type`: (`"input"`, `"output"`, `"cacheRead"`, `"cacheCreation"`)306* `type`: (`"input"`, `"output"`, `"cacheRead"`, `"cacheCreation"`)

302* `model`: Model identifier (for example, "claude-sonnet-4-5-20250929")307* `model`: Model identifier (for example, "claude-sonnet-4-6")

303 308

304#### Code edit tool decision counter309#### Code edit tool decision counter

305 310

308**Attributes**:313**Attributes**:

309 314

310* All [standard attributes](#standard-attributes)315* All [standard attributes](#standard-attributes)

311* `tool`: Tool name (`"Edit"`, `"Write"`, `"NotebookEdit"`)316* `tool_name`: Tool name (`"Edit"`, `"Write"`, `"NotebookEdit"`)

312* `decision`: User decision (`"accept"`, `"reject"`)317* `decision`: User decision (`"accept"`, `"reject"`)

313* `language`: Programming language of the edited file (for example, `"TypeScript"`, `"Python"`, `"JavaScript"`, `"Markdown"`). Returns `"unknown"` for unrecognized file extensions.318* `source`: Decision source - `"config"`, `"hook"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`

319* `language`: Programming language of the edited file, such as `"TypeScript"`, `"Python"`, `"JavaScript"`, or `"Markdown"`. Returns `"unknown"` for unrecognized file extensions.

314 320

315#### Active time counter321#### Active time counter

316 322

317Tracks actual time spent actively using Claude Code (not idle time). This metric is incremented during user interactions such as typing prompts or receiving responses.323Tracks 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).

318 324

319**Attributes**:325**Attributes**:

320 326

321* All [standard attributes](#standard-attributes)327* All [standard attributes](#standard-attributes)

328* `type`: `"user"` for keyboard interactions, `"cli"` for tool execution and AI responses

322 329

323### Events330### Events

324 331

325Claude Code exports the following events via OpenTelemetry logs/events (when `OTEL_LOGS_EXPORTER` is configured):332Claude Code exports the following events via OpenTelemetry logs/events (when `OTEL_LOGS_EXPORTER` is configured):

326 333

334#### Event correlation attributes

335

336When 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.

337

338| Attribute | Description |

339| ----------- | ------------------------------------------------------------------------------------ |

340| `prompt.id` | UUID v4 identifier linking all events produced while processing a single user prompt |

341

342To 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.

343

344<Note>

345 `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.

346</Note>

347

327#### User prompt event348#### User prompt event

328 349

329Logged when a user submits a prompt.350Logged when a user submits a prompt.

355* `success`: `"true"` or `"false"`376* `success`: `"true"` or `"false"`

356* `duration_ms`: Execution time in milliseconds377* `duration_ms`: Execution time in milliseconds

357* `error`: Error message (if failed)378* `error`: Error message (if failed)

358* `decision`: Either `"accept"` or `"reject"`379* `decision_type`: Either `"accept"` or `"reject"`

359* `source`: Decision source - `"config"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`380* `decision_source`: Decision source - `"config"`, `"hook"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`

381* `tool_result_size_bytes`: Size of the tool result in bytes

382* `mcp_server_scope`: MCP server scope identifier (for MCP tools)

360* `tool_parameters`: JSON string containing tool-specific parameters (when available)383* `tool_parameters`: JSON string containing tool-specific parameters (when available)

361 * For Bash tool: includes `bash_command`, `full_command`, `timeout`, `description`, `sandbox`384 * For Bash tool: includes `bash_command`, `full_command`, `timeout`, `description`, `dangerouslyDisableSandbox`, and `git_commit_id` (the commit SHA, when a `git commit` command succeeds)

362 * For MCP tools (when `OTEL_LOG_TOOL_DETAILS=1`): includes `mcp_server_name`, `mcp_tool_name`385 * For MCP tools (when `OTEL_LOG_TOOL_DETAILS=1`): includes `mcp_server_name`, `mcp_tool_name`

363 * For Skill tool (when `OTEL_LOG_TOOL_DETAILS=1`): includes `skill_name`386 * For Skill tool (when `OTEL_LOG_TOOL_DETAILS=1`): includes `skill_name`

364 387

374* `event.name`: `"api_request"`397* `event.name`: `"api_request"`

375* `event.timestamp`: ISO 8601 timestamp398* `event.timestamp`: ISO 8601 timestamp

376* `event.sequence`: monotonically increasing counter for ordering events within a session399* `event.sequence`: monotonically increasing counter for ordering events within a session

377* `model`: Model used (for example, "claude-sonnet-4-5-20250929")400* `model`: Model used (for example, "claude-sonnet-4-6")

378* `cost_usd`: Estimated cost in USD401* `cost_usd`: Estimated cost in USD

379* `duration_ms`: Request duration in milliseconds402* `duration_ms`: Request duration in milliseconds

380* `input_tokens`: Number of input tokens403* `input_tokens`: Number of input tokens

381* `output_tokens`: Number of output tokens404* `output_tokens`: Number of output tokens

382* `cache_read_tokens`: Number of tokens read from cache405* `cache_read_tokens`: Number of tokens read from cache

383* `cache_creation_tokens`: Number of tokens used for cache creation406* `cache_creation_tokens`: Number of tokens used for cache creation

407* `speed`: `"fast"` or `"normal"`, indicating whether fast mode was active

384 408

385#### API error event409#### API error event

386 410

394* `event.name`: `"api_error"`418* `event.name`: `"api_error"`

395* `event.timestamp`: ISO 8601 timestamp419* `event.timestamp`: ISO 8601 timestamp

396* `event.sequence`: monotonically increasing counter for ordering events within a session420* `event.sequence`: monotonically increasing counter for ordering events within a session

397* `model`: Model used (for example, "claude-sonnet-4-5-20250929")421* `model`: Model used (for example, "claude-sonnet-4-6")

398* `error`: Error message422* `error`: Error message

399* `status_code`: HTTP status code (if applicable)423* `status_code`: HTTP status code as a string, or `"undefined"` for non-HTTP errors

400* `duration_ms`: Request duration in milliseconds424* `duration_ms`: Request duration in milliseconds

401* `attempt`: Attempt number (for retried requests)425* `attempt`: Attempt number (for retried requests)

426* `speed`: `"fast"` or `"normal"`, indicating whether fast mode was active

402 427

403#### Tool decision event428#### Tool decision event

404 429

414* `event.sequence`: monotonically increasing counter for ordering events within a session439* `event.sequence`: monotonically increasing counter for ordering events within a session

415* `tool_name`: Name of the tool (for example, "Read", "Edit", "Write", "NotebookEdit")440* `tool_name`: Name of the tool (for example, "Read", "Edit", "Write", "NotebookEdit")

416* `decision`: Either `"accept"` or `"reject"`441* `decision`: Either `"accept"` or `"reject"`

417* `source`: Decision source - `"config"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`442* `source`: Decision source - `"config"`, `"hook"`, `"user_permanent"`, `"user_temporary"`, `"user_abort"`, or `"user_reject"`

418 443

419## Interpreting metrics and events data444## Interpret metrics and events data

420 445

421The metrics exported by Claude Code provide valuable insights into usage patterns and productivity. Here are some common visualizations and analyses you can create:446The exported metrics and events support a range of analyses:

422 447

423### Usage monitoring448### Usage monitoring

424 449

497 522

498For 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.523For 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.

499 524

500## Security/privacy considerations525## Security and privacy

501 526

502* Telemetry is opt-in and requires explicit configuration527* Telemetry is opt-in and requires explicit configuration

503* Sensitive information like API keys or file contents are never included in metrics or events528* 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`

504* User prompt content is redacted by default, only prompt length is recorded. To enable user prompt logging, set `OTEL_LOG_USER_PROMPTS=1`529* 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

505* MCP server/tool names and skill names are not logged by default because they can reveal user-specific configurations. To enable, set `OTEL_LOG_TOOL_DETAILS=1`530* User prompt content is not collected by default. Only prompt length is recorded. To include prompt content, set `OTEL_LOG_USER_PROMPTS=1`

531* MCP server/tool names and skill names are not logged by default because they can reveal user-specific configurations. To include them, set `OTEL_LOG_TOOL_DETAILS=1`

506 532

507## Monitoring Claude Code on Amazon Bedrock533## Monitor Claude Code on Amazon Bedrock

508 534

509For 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).535For 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 +6 −5

Details

80 80

81Claude Code requires access to the following URLs:81Claude Code requires access to the following URLs:

82 82

~~83* `api.anthropic.com` - Claude API endpoints~~83* `api.anthropic.com`: Claude API endpoints

~~84* `claude.ai` - WebFetch safeguards~~84* `claude.ai`: authentication for claude.ai accounts

~~85* `statsig.anthropic.com` - Telemetry and metrics~~85* `platform.claude.com`: authentication for Anthropic Console accounts

~~86* `sentry.io` - Error reporting~~

87 86

88Ensure 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.

89 88

89[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).

90## Additional resources91## Additional resources

91 92

92* [Claude Code settings](/en/settings)93* [Claude Code settings](/en/settings)

~~93* [Environment variables reference](/en/settings#environment-variables)~~94* [Environment variables reference](/en/env-vars)

94* [Troubleshooting guide](/en/troubleshooting)95* [Troubleshooting guide](/en/troubleshooting)

output-styles.md +16 −11

Details

42 42

43## Change your output style43## Change your output style

44 44

~~45You 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).

46 48

~~47* 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

~~48 also be accessed from the `/config` menu)~~50settings file:

49 51

~~50* Run `/output-style [style]`, such as `/output-style explanatory`, to directly~~52```json theme={null}

~~51 switch to a style~~53{

54 "outputStyle": "Explanatory"

55}

56```

52 57

~~53These 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,

~~54`.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

~~55field in a settings file at a different level.~~60prompt stable throughout a conversation so prompt caching can reduce latency and

61cost.

56 62

57## Create a custom output style63## Create a custom output style

58 64

81 87

82### Frontmatter88### Frontmatter

83 89

~~84Output style files support frontmatter, useful for specifying metadata about the~~90Output style files support frontmatter for specifying metadata:

~~85command:~~

86 91

88| :------------------------- | :-------------------------------------------------------------------------- | :---------------------- |93| :------------------------- | :-------------------------------------------------------------------------- | :---------------------- |

92 97

93## Comparisons to related features98## Comparisons to related features

overview.md +143 −82

Details

4 4

5# Claude Code overview5# Claude Code overview

6 6

~~7> Learn about Claude Code, Anthropic's agentic coding tool that works in your terminal, IDE, desktop app, and browser to help you turn ideas into code faster than ever before.~~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.

8 8

~~9## Get started in 30 seconds~~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.

10 10

~~11Prerequisites:~~11## Get started

12 12

~~13* Meet the [system requirements](/en/setup#system-requirements)~~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).

~~14* A [Claude subscription](https://claude.com/pricing) (Pro, Max, Teams, or Enterprise) or [Claude Console](https://console.anthropic.com/) account~~

15 14

~~16**Install Claude Code:**~~15<Tabs>

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.

17 18

~~18To install Claude Code, use one of the following methods:~~19 To install Claude Code, use one of the following methods:

19 20

~~20<Tabs>~~21 <Tabs>

21 <Tab title="Native Install (Recommended)">22 <Tab title="Native Install (Recommended)">

22 **macOS, Linux, WSL:**23 **macOS, Linux, WSL:**

23 24

37 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd38 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

38 ```39 ```

39 40

41 **Windows requires [Git for Windows](https://git-scm.com/downloads/win).** Install it first if you don't have it.

40 <Info>43 <Info>

41 Native installations automatically update in the background to keep you on the latest version.44 Native installations automatically update in the background to keep you on the latest version.

42 </Info>45 </Info>

43 </Tab>46 </Tab>

44 47

45 <Tab title="Homebrew">48 <Tab title="Homebrew">

~~46 ```sh theme={null}~~49 ```bash theme={null}

47 brew install --cask claude-code50 brew install --cask claude-code

48 ```51 ```

49 52

61 WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.64 WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.

62 </Info>65 </Info>

63 </Tab>66 </Tab>

~~64</Tabs>~~67 </Tabs>

65 68

~~66**Start using Claude Code:**~~69 Then start Claude Code in any project:

67 70

~~68```bash theme={null}~~71 ```bash theme={null}

~~69cd your-project~~72 cd your-project

~~70claude~~73 claude

~~71```~~74 ```

72 75

~~73You'll be prompted to log in on first use. That's it! [Continue with Quickstart (5 minutes) →](/en/quickstart)~~76 You'll be prompted to log in on first use. That's it! [Continue with the Quickstart →](/en/quickstart)

74 77

~~75<Tip>~~78 <Tip>

76 See [advanced setup](/en/setup) for installation options, manual updates, or uninstallation instructions. Visit [troubleshooting](/en/troubleshooting) if you hit issues.79 See [advanced setup](/en/setup) for installation options, manual updates, or uninstallation instructions. Visit [troubleshooting](/en/troubleshooting) if you hit issues.

~~77</Tip>~~80 </Tip>

81 </Tab>

78 82

79Claude Code also runs in [VS Code](/en/vs-code), [JetBrains IDEs](/en/jetbrains), as a [desktop app](/en/desktop), [on the web](/en/claude-code-on-the-web), and in [Slack](/en/slack). See [all platforms](#use-claude-code-everywhere) below.83 <Tab title="VS Code">

84 The VS Code extension provides inline diffs, @-mentions, plan review, and conversation history directly in your editor.

80 85

~~81## What Claude Code does for you~~86 * [Install for VS Code](vscode:extension/anthropic.claude-code)

87 * [Install for Cursor](cursor:extension/anthropic.claude-code)

82 88

~~83* **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.~~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**.

~~84* **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.~~

85* **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 data sources like Google Drive, Figma, and Slack.

~~86* **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.~~

87 90

~~88## Why developers love Claude Code~~91 [Get started with VS Code →](/en/vs-code#get-started)

92 </Tab>

89 93

~~90* **Meets you where you work**: Use Claude Code in your terminal, your IDE, or a standalone desktop app. It integrates with the tools you already use.~~94 <Tab title="Desktop app">

91* **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.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.

92* **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"`.

~~93* **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.~~

94 96

~~95## Use Claude Code everywhere~~97 Download and install:

96 98

~~97Claude Code works across your development environment: in your terminal, in your IDE, in the cloud, and in Slack.~~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)

98 102

~~99* **[Terminal (CLI)](/en/quickstart)**: the core Claude Code experience. Run `claude` in any terminal to start coding.~~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.

100* **[Claude Code on the web](/en/claude-code-on-the-web)**: use Claude Code from your browser at [claude.ai/code](https://claude.ai/code) or the Claude iOS app, with no local setup required. Run tasks in parallel, work on repos you don't have locally, and review changes in a built-in diff view.

101* **[Desktop app](/en/desktop)**: a standalone application with diff review, parallel sessions via git worktrees, and the ability to launch cloud sessions.

102* **[VS Code](/en/vs-code)**: a native extension with inline diffs, @-mentions, and plan review.

103* **[JetBrains IDEs](/en/jetbrains)**: a plugin for IntelliJ IDEA, PyCharm, WebStorm, and other JetBrains IDEs with IDE diff viewing and context sharing.

104* **[GitHub Actions](/en/github-actions)**: automate code review, issue triage, and other workflows in CI/CD with `@claude` mentions.

105* **[GitLab CI/CD](/en/gitlab-ci-cd)**: event-driven automation for GitLab merge requests and issues.

106* **[Slack](/en/slack)**: mention Claude in Slack to route coding tasks to Claude Code on the web and get PRs back.

107* **[Chrome](/en/chrome)**: connect Claude Code to your browser for live debugging, design verification, and web app testing.

108 104

109## Next steps105 [Learn more about the desktop app →](/en/desktop-quickstart)

106 </Tab>

110 107

111<CardGroup>108 <Tab title="Web">

112 <Card title="Quickstart" icon="rocket" href="/en/quickstart">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.

113 See Claude Code in action with practical examples

114 </Card>

115 110

116 <Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">111 Start coding at [claude.ai/code](https://claude.ai/code).

117 Step-by-step guides for common workflows

118 </Card>

119 112

120 <Card title="Troubleshooting" icon="wrench" href="/en/troubleshooting">113 [Get started on the web →](/en/claude-code-on-the-web#getting-started)

121 Solutions for common issues with Claude Code114 </Tab>

122 </Card>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.

123 118

124 <Card title="Desktop app" icon="laptop" href="/en/desktop">119 Install the [Claude Code plugin](https://plugins.jetbrains.com/plugin/27310-claude-code-beta-) from the JetBrains Marketplace and restart your IDE.

125 Run Claude Code as a standalone application

126 </Card>

127</CardGroup>

128 120

129## Additional resources121 [Get started with JetBrains →](/en/jetbrains)

122 </Tab>

123</Tabs>

130 124

131<CardGroup>125## What you can do

132 <Card title="About Claude Code" icon="sparkles" href="https://claude.com/product/claude-code">

133 Learn more about Claude Code on claude.com

134 </Card>

135 126

136 <Card title="Build with the Agent SDK" icon="code-branch" href="https://platform.claude.com/docs/en/agent-sdk/overview">127Here are some of the ways you can use Claude Code:

137 Create custom AI agents with the Claude Agent SDK

138 </Card>

139 128

140 <Card title="Host on AWS or GCP" icon="cloud" href="/en/third-party-integrations">129<AccordionGroup>

141 Configure Claude Code with Amazon Bedrock or Google Vertex AI130 <Accordion title="Automate the work you keep putting off" icon="wand-magic-sparkles">

142 </Card>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.

143 132

144 <Card title="Settings" icon="gear" href="/en/settings">133 ```bash theme={null}

145 Customize Claude Code for your workflow134 claude "write tests for the auth module, run them, and fix any failures"

146 </Card>135 ```

136 </Accordion>

147 137

148 <Card title="Commands" icon="terminal" href="/en/cli-reference">138 <Accordion title="Build features and fix bugs" icon="hammer">

149 Learn about CLI commands and controls139 Describe what you want in plain language. Claude Code plans the approach, writes the code across multiple files, and verifies it works.

150 </Card>140

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>

143

144 <Accordion title="Create commits and pull requests" icon="code-branch">

145 Claude Code works directly with git. It stages changes, writes commit messages, creates branches, and opens pull requests.

146

147 ```bash theme={null}

148 claude "commit my changes with a descriptive message"

149 ```

151 150

152 <Card title="Reference implementation" icon="code" href="https://github.com/anthropics/claude-code/tree/main/.devcontainer">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).

153 Clone our development container reference implementation152 </Accordion>

154 </Card>153

154 <Accordion title="Connect your tools with MCP" icon="plug">

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.

156 </Accordion>

157

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.

160

161 Create [custom commands](/en/skills) to package repeatable workflows your team can share, like `/review-pr` or `/deploy-staging`.

162

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>

171

172 <Accordion title="Pipe, script, and automate with the CLI" icon="terminal">

173 Claude Code is composable and follows the Unix philosophy. Pipe logs into it, run it in CI, or chain it with other tools:

174

175 ```bash theme={null}

176 # Monitor logs and get alerted

177 tail -f 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 ```

185

186 See the [CLI reference](/en/cli-reference) for the full set of commands and flags.

187 </Accordion>

188

189 <Accordion title="Work from anywhere" icon="globe">

190 Sessions aren't tied to a single surface. Move work between environments as your context changes:

191

192 * Step away from your desk and keep working from your phone or any browser with [Remote Control](/en/remote-control)

193 * 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`

194 * Hand off a terminal session to the [Desktop app](/en/desktop) with `/desktop` for visual diff review

195 * Route tasks from team chat: mention `@Claude` in [Slack](/en/slack) with a bug report and get a pull request back

196 </Accordion>

197</AccordionGroup>

198

199## Use Claude Code everywhere

200

201Each surface connects to the same underlying Claude Code engine, so your CLAUDE.md files, settings, and MCP servers work across all of them.

202

203Beyond 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:

204

205| I want to... | Best option |

206| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |

207| Continue a local session from my phone or another device | [Remote Control](/en/remote-control) |

208| 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) |

209| Automate PR reviews and issue triage | [GitHub Actions](/en/github-actions) or [GitLab CI/CD](/en/gitlab-ci-cd) |

210| Get automatic code review on every PR | [GitHub Code Review](/en/code-review) |

211| Route bug reports from Slack to pull requests | [Slack](/en/slack) |

212| Debug live web applications | [Chrome](/en/chrome) |

213| Build custom agents for your own workflows | [Agent SDK](https://platform.claude.com/docs/en/agent-sdk/overview) |

214

215## Next steps

155 216

156 <Card title="Security" icon="shield" href="/en/security">217Once you've installed Claude Code, these guides help you go deeper.

157 Discover Claude Code's safeguards and best practices for safe usage

158 </Card>

159 218

160 <Card title="Privacy and data usage" icon="lock" href="/en/data-usage">219* [Quickstart](/en/quickstart): walk through your first real task, from exploring a codebase to committing a fix

161 Understand how Claude Code handles your data220* [Store instructions and memories](/en/memory): give Claude persistent instructions with CLAUDE.md files and auto memory

162 </Card>221* [Common workflows](/en/common-workflows) and [best practices](/en/best-practices): patterns for getting the most out of Claude Code

163</CardGroup>222* [Settings](/en/settings): customize Claude Code for your workflow

223* [Troubleshooting](/en/troubleshooting): solutions for common issues

224* [code.claude.com](https://code.claude.com/): demos, pricing, and product details

permissions.md +25 −23

Details

136Read and Edit rules both follow the [gitignore](https://git-scm.com/docs/gitignore) specification with four distinct pattern types:136Read and Edit rules both follow the [gitignore](https://git-scm.com/docs/gitignore) specification with four distinct pattern types:

137 137

139| ------------------ | -------------------------------------- | -------------------------------- | ---------------------------------- |139| ------------------ | -------------------------------------- | -------------------------------- | ------------------------------ |

140| `//path` | **Absolute** path from filesystem root | `Read(//Users/alice/secrets/**)` | `/Users/alice/secrets/**` |140| `//path` | **Absolute** path from filesystem root | `Read(//Users/alice/secrets/**)` | `/Users/alice/secrets/**` |

141| `~/path` | Path from **home** directory | `Read(~/Documents/*.pdf)` | `/Users/alice/Documents/*.pdf` |141| `~/path` | Path from **home** directory | `Read(~/Documents/*.pdf)` | `/Users/alice/Documents/*.pdf` |

142| `/path` | Path **relative to settings file** | `Edit(/src/**/*.ts)` | `<settings file path>/src/**/*.ts` |142| `/path` | Path **relative to project root** | `Edit(/src/**/*.ts)` | `<project root>/src/**/*.ts` |

143| `path` or `./path` | Path **relative to current directory** | `Read(*.env)` | `<cwd>/*.env` |143| `path` or `./path` | Path **relative to current directory** | `Read(*.env)` | `<cwd>/*.env` |

144 144

145<Warning>145<Warning>

146 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.146 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.

147</Warning>147</Warning>

148 148

149Examples:149Examples:

150 150

151* `Edit(/docs/**)`: edits in `<project>/docs/` (NOT `/docs/`)151* `Edit(/docs/**)`: edits in `<project>/docs/` (NOT `/docs/` and NOT `<project>/.claude/docs/`)

152* `Read(~/.zshrc)`: reads your home directory's `.zshrc`152* `Read(~/.zshrc)`: reads your home directory's `.zshrc`

153* `Edit(//tmp/scratch.txt)`: edits the absolute path `/tmp/scratch.txt`153* `Edit(//tmp/scratch.txt)`: edits the absolute path `/tmp/scratch.txt`

154* `Read(src/**)`: reads from `<current-directory>/src/`154* `Read(src/**)`: reads from `<current-directory>/src/`

167* `mcp__puppeteer__*` wildcard syntax that also matches all tools from the `puppeteer` server167* `mcp__puppeteer__*` wildcard syntax that also matches all tools from the `puppeteer` server

168* `mcp__puppeteer__puppeteer_navigate` matches the `puppeteer_navigate` tool provided by the `puppeteer` server168* `mcp__puppeteer__puppeteer_navigate` matches the `puppeteer_navigate` tool provided by the `puppeteer` server

169 169

170### Task (subagents)170### Agent (subagents)

171 171

172Use `Task(AgentName)` rules to control which [subagents](/en/sub-agents) Claude can use:172Use `Agent(AgentName)` rules to control which [subagents](/en/sub-agents) Claude can use:

173 173

174* `Task(Explore)` matches the Explore subagent174* `Agent(Explore)` matches the Explore subagent

175* `Task(Plan)` matches the Plan subagent175* `Agent(Plan)` matches the Plan subagent

176* `Task(my-custom-agent)` matches a custom subagent named `my-custom-agent`176* `Agent(my-custom-agent)` matches a custom subagent named `my-custom-agent`

177 177

178Add these rules to the `deny` array in your settings or use the `--disallowedTools` CLI flag to disable specific agents. To disable the Explore agent:178Add these rules to the `deny` array in your settings or use the `--disallowedTools` CLI flag to disable specific agents. To disable the Explore agent:

179 179

180```json theme={null}180```json theme={null}

181{181{

182 "permissions": {182 "permissions": {

183 "deny": ["Task(Explore)"]183 "deny": ["Agent(Explore)"]

184 }184 }

185}185}

186```186```

215 215

216## Managed settings216## Managed settings

217 217

218For organizations that need centralized control over Claude Code configuration, administrators can deploy `managed-settings.json` files to system directories. These policy files follow the same format as regular settings files and cannot be overridden by user or project settings.218For 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.

~~219~~

220**Managed settings file locations**:

~~221~~

222* **macOS**: `/Library/Application Support/ClaudeCode/managed-settings.json`

223* **Linux and WSL**: `/etc/claude-code/managed-settings.json`

224* **Windows**: `C:\Program Files\ClaudeCode\managed-settings.json`

~~225~~

226<Note>

227 These are system-wide paths (not user home directories like `~/Library/...`) that require administrator privileges. They are designed to be deployed by IT administrators.

228</Note>

229 219

230### Managed-only settings220### Managed-only settings

231 221

232Some settings are only effective in managed settings:222Some settings are only effective in managed settings:

233 223

234| Setting | Description |224| Setting | Description |

235| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------- |225| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

236| `disableBypassPermissionsMode` | Set to `"disable"` to prevent `bypassPermissions` mode and the `--dangerously-skip-permissions` flag |226| `disableBypassPermissionsMode` | Set to `"disable"` to prevent `bypassPermissions` mode and the `--dangerously-skip-permissions` flag |

237| `allowManagedPermissionRulesOnly` | When `true`, prevents user and project settings from defining `allow`, `ask`, or `deny` permission rules. Only rules in managed settings apply |227| `allowManagedPermissionRulesOnly` | When `true`, prevents user and project settings from defining `allow`, `ask`, or `deny` permission rules. Only rules in managed settings apply |

238| `allowManagedHooksOnly` | When `true`, prevents loading of user, project, and plugin hooks. Only managed hooks and SDK hooks are allowed |228| `allowManagedHooksOnly` | When `true`, prevents loading of user, project, and plugin hooks. Only managed hooks and SDK hooks are allowed |

229| `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) |

230| `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) |

231| `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 |

239| `strictKnownMarketplaces` | Controls which plugin marketplaces users can add. See [managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions) |232| `strictKnownMarketplaces` | Controls which plugin marketplaces users can add. See [managed marketplace restrictions](/en/plugin-marketplaces#managed-marketplace-restrictions) |

233| `allow_remote_sessions` | When `true`, allows users to start [Remote Control](/en/remote-control) and [web sessions](/en/claude-code-on-the-web). Defaults to `true`. Set to `false` to prevent remote session access |

240 234

241## Settings precedence235## Settings precedence

242 236

243Permission rules follow the same [settings precedence](/en/settings#settings-precedence) as all other Claude Code settings: managed settings have the highest precedence, followed by command line arguments, local project, shared project, and user settings.237Permission rules follow the same [settings precedence](/en/settings#settings-precedence) as all other Claude Code settings:

238

2391. **Managed settings**: cannot be overridden by any other level, including command line arguments

2402. **Command line arguments**: temporary session overrides

2413. **Local project settings** (`.claude/settings.local.json`)

2424. **Shared project settings** (`.claude/settings.json`)

2435. **User settings** (`~/.claude/settings.json`)

244

245If 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.

244 246

245If a permission is allowed in user settings but denied in project settings, the project setting takes precedence and the permission is blocked.247If a permission is allowed in user settings but denied in project settings, the project setting takes precedence and the permission is blocked.

246 248

plugin-marketplaces.md +261 −24

Details

6 6

7> Build and host plugin marketplaces to distribute Claude Code extensions across teams and communities.7> Build and host plugin marketplaces to distribute Claude Code extensions across teams and communities.

8 8

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 **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.

10 10

11Looking to install plugins from an existing marketplace? See [Discover and install prebuilt plugins](/en/discover-plugins).11Looking to install plugins from an existing marketplace? See [Discover and install prebuilt plugins](/en/discover-plugins).

12 12

23 23

24## Walkthrough: create a local marketplace24## Walkthrough: create a local marketplace

25 25

26This example creates a marketplace with one plugin: a `/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.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.

27 27

28<Steps>28<Steps>

29 <Step title="Create the directory structure">29 <Step title="Create the directory structure">

30 ```bash theme={null}30 ```bash theme={null}

31 mkdir -p my-marketplace/.claude-plugin31 mkdir -p my-marketplace/.claude-plugin

~~32 mkdir -p my-marketplace/plugins/review-plugin/.claude-plugin~~32 mkdir -p my-marketplace/plugins/quality-review-plugin/.claude-plugin

~~33 mkdir -p my-marketplace/plugins/review-plugin/skills/review~~33 mkdir -p my-marketplace/plugins/quality-review-plugin/skills/quality-review

34 ```34 ```

35 </Step>35 </Step>

36 36

37 <Step title="Create the skill">37 <Step title="Create the skill">

~~38 Create a `SKILL.md` file that defines what the `/review` skill does.~~38 Create a `SKILL.md` file that defines what the `/quality-review` skill does.

39 39

~~40 ```markdown my-marketplace/plugins/review-plugin/skills/review/SKILL.md theme={null}~~40 ```markdown my-marketplace/plugins/quality-review-plugin/skills/quality-review/SKILL.md theme={null}

41 ---41 ---

42 description: Review code for bugs, security, and performance42 description: Review code for bugs, security, and performance

43 disable-model-invocation: true43 disable-model-invocation: true

56 <Step title="Create the plugin manifest">56 <Step title="Create the plugin manifest">

57 Create a `plugin.json` file that describes the plugin. The manifest goes in the `.claude-plugin/` directory.57 Create a `plugin.json` file that describes the plugin. The manifest goes in the `.claude-plugin/` directory.

58 58

~~59 ```json my-marketplace/plugins/review-plugin/.claude-plugin/plugin.json theme={null}~~59 ```json my-marketplace/plugins/quality-review-plugin/.claude-plugin/plugin.json theme={null}

60 {60 {

~~61 "name": "review-plugin",~~61 "name": "quality-review-plugin",

~~62 "description": "Adds a /review skill for quick code reviews",~~62 "description": "Adds a /quality-review skill for quick code reviews",

63 "version": "1.0.0"63 "version": "1.0.0"

64 }64 }

65 ```65 ```

76 },76 },

77 "plugins": [77 "plugins": [

78 {78 {

~~79 "name": "review-plugin",~~79 "name": "quality-review-plugin",

~~80 "source": "./plugins/review-plugin",~~80 "source": "./plugins/quality-review-plugin",

~~81 "description": "Adds a /review skill for quick code reviews"~~81 "description": "Adds a /quality-review skill for quick code reviews"

82 }82 }

83 ]83 ]

84 }84 }

90 90

91 ```shell theme={null}91 ```shell theme={null}

92 /plugin marketplace add ./my-marketplace92 /plugin marketplace add ./my-marketplace

~~93 /plugin install review-plugin@my-plugins~~93 /plugin install quality-review-plugin@my-plugins

94 ```94 ```

95 </Step>95 </Step>

96 96

108<Note>108<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.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 110

111 If you need to share files across plugins, use symlinks (which are followed during copying) or restructure your marketplace so the shared directory is inside the plugin source path. See [Plugin caching and file resolution](/en/plugins-reference#plugin-caching-and-file-resolution) for details.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>112</Note>

113 113

114## Create the marketplace file114## Create the marketplace file

191**Standard metadata fields:**191**Standard metadata fields:**

192 192

194| :------------ | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |194| :------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------------- |

204| `strict` | boolean | Controls whether plugins need their own `plugin.json` file. When `true` (default), the plugin source must contain a `plugin.json`, and any fields you add here in the marketplace entry get merged with it. When `false`, the plugin doesn't need its own `plugin.json`; the marketplace entry itself defines everything about the plugin. Use `false` when you want to define simple plugins entirely in your marketplace file. |204| `strict` | boolean | Controls whether `plugin.json` is the authority for component definitions (default: true). See [Strict mode](#strict-mode) below. |

205 205

206**Component configuration fields:**206**Component configuration fields:**

207 207

215 215

216## Plugin sources216## Plugin sources

217 217

218Plugin 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`.

219

220Once a plugin is cloned or copied into the local machine, it is copied into the local versioned plugin cache at `~/.claude/plugins/cache`.

221

223| ------------- | ------------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------- |

230

231<Note>

232 **Marketplace sources vs plugin sources**: These are different concepts that control different things.

233

234 * **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`.

235 * **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).

236

237 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.

238</Note>

239

218### Relative paths240### Relative paths

219 241

220For plugins in the same repository:242For plugins in the same repository, use a path starting with `./`:

221 243

222```json theme={null}244```json theme={null}

223{245{

226}248}

227```249```

228 250

251Paths 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/`.

252

229<Note>253<Note>

230 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 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.

231</Note>255</Note>

289```313```

290 314

292| :---- | :----- | :-------------------------------------------------------------------- |316| :---- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |

293| `url` | string | Required. Full git repository URL (must end with `.git`) |317| `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 |

294| `ref` | string | Optional. Git branch or tag (defaults to repository default branch) |318| `ref` | string | Optional. Git branch or tag (defaults to repository default branch) |

295| `sha` | string | Optional. Full 40-character git commit SHA to pin to an exact version |319| `sha` | string | Optional. Full 40-character git commit SHA to pin to an exact version |

296 320

321### Git subdirectories

322

323Use `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.

324

325```json theme={null}

326{

327 "name": "my-plugin",

328 "source": {

329 "source": "git-subdir",

330 "url": "https://github.com/acme-corp/monorepo.git",

331 "path": "tools/claude-plugin"

332 }

333}

334```

335

336You can pin to a specific branch, tag, or commit:

337

338```json theme={null}

339{

340 "name": "my-plugin",

341 "source": {

342 "source": "git-subdir",

343 "url": "https://github.com/acme-corp/monorepo.git",

344 "path": "tools/claude-plugin",

345 "ref": "v2.0.0",

346 "sha": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0"

347 }

348}

349```

350

351The `url` field also accepts a GitHub shorthand (`owner/repo`) or SSH URLs (`git@github.com:owner/repo.git`).

352

353| Field | Type | Description |

354| :----- | :----- | :------------------------------------------------------------------------------------------------------- |

355| `url` | string | Required. Git repository URL, GitHub `owner/repo` shorthand, or SSH URL |

356| `path` | string | Required. Subdirectory path within the repo containing the plugin (for example, `"tools/claude-plugin"`) |

357| `ref` | string | Optional. Git branch or tag (defaults to repository default branch) |

358| `sha` | string | Optional. Full 40-character git commit SHA to pin to an exact version |

359

360### npm packages

361

362Plugins 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.

363

364```json theme={null}

365{

366 "name": "my-npm-plugin",

367 "source": {

368 "source": "npm",

369 "package": "@acme/claude-plugin"

370 }

371}

372```

373

374To pin to a specific version, add the `version` field:

375

376```json theme={null}

377{

378 "name": "my-npm-plugin",

379 "source": {

380 "source": "npm",

381 "package": "@acme/claude-plugin",

382 "version": "2.1.0"

383 }

384}

385```

386

387To install from a private or internal registry, add the `registry` field:

388

389```json theme={null}

390{

391 "name": "my-npm-plugin",

392 "source": {

393 "source": "npm",

394 "package": "@acme/claude-plugin",

395 "version": "^2.0.0",

396 "registry": "https://npm.example.com"

397 }

398}

399```

400

401| Field | Type | Description |

402| :--------- | :----- | :------------------------------------------------------------------------------------------- |

403| `package` | string | Required. Package name or scoped package (for example, `@org/plugin`) |

404| `version` | string | Optional. Version or version range (for example, `2.1.0`, `^2.0.0`, `~1.5.0`) |

405| `registry` | string | Optional. Custom npm registry URL. Defaults to the system npm registry (typically npmjs.org) |

406

297### Advanced plugin entries407### Advanced plugin entries

298 408

299This example shows a plugin entry using many of the optional fields, including custom paths for commands, agents, hooks, and MCP servers:409This example shows a plugin entry using many of the optional fields, including custom paths for commands, agents, hooks, and MCP servers:

349 459

350* **`commands` and `agents`**: You can specify multiple directories or individual files. Paths are relative to the plugin root.460* **`commands` and `agents`**: You can specify multiple directories or individual files. Paths are relative to the plugin root.

351* **`${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.461* **`${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.

352* **`strict: false`**: Since this is set to false, the plugin doesn't need its own `plugin.json`. The marketplace entry defines everything.462* **`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.

463

464### Strict mode

465

466The `strict` field controls whether `plugin.json` is the authority for component definitions (commands, agents, hooks, skills, MCP servers, output styles).

467

468| Value | Behavior |

469| :--------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- |

470| `true` (default) | `plugin.json` is the authority. The marketplace entry can supplement it with additional components, and both sources are merged. |

471| `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. |

472

473**When to use each mode:**

474

475* **`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.

476* **`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.

353 477

354## Host and distribute marketplaces478## Host and distribute marketplaces

355 479

478}602}

479```603```

480 604

481Allow all marketplaces from an internal git server using regex pattern matching:605Allow all marketplaces from an internal git server using regex pattern matching on the host:

482 606

483```json theme={null}607```json theme={null}

484{608{

491}615}

492```616```

493 617

618Allow filesystem-based marketplaces from a specific directory using regex pattern matching on the path:

619

620```json theme={null}

621{

622 "strictKnownMarketplaces": [

623 {

624 "source": "pathPattern",

625 "pathPattern": "^/opt/approved/"

626 }

627 ]

628}

629```

630

631Use `".*"` as the `pathPattern` to allow any filesystem path while still controlling network sources with `hostPattern`.

632

633<Note>

634 `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).

635</Note>

636

494#### How restrictions work637#### How restrictions work

495 638

496Restrictions are validated early in the plugin installation process, before any network requests or filesystem operations occur. This prevents unauthorized marketplace access attempts.639Restrictions are validated early in the plugin installation process, before any network requests or filesystem operations occur. This prevents unauthorized marketplace access attempts.

500* For GitHub sources: `repo` is required, and `ref` or `path` must also match if specified in the allowlist643* For GitHub sources: `repo` is required, and `ref` or `path` must also match if specified in the allowlist

501* For URL sources: the full URL must match exactly644* For URL sources: the full URL must match exactly

502* For `hostPattern` sources: the marketplace host is matched against the regex pattern645* For `hostPattern` sources: the marketplace host is matched against the regex pattern

646* For `pathPattern` sources: the marketplace's filesystem path is matched against the regex pattern

503 647

504Because `strictKnownMarketplaces` is set in [managed settings](/en/settings#settings-files), individual users and project configurations cannot override these restrictions.648Because `strictKnownMarketplaces` is set in [managed settings](/en/settings#settings-files), individual users and project configurations cannot override these restrictions.

505 649

506For complete configuration details including all supported source types and comparison with `extraKnownMarketplaces`, see the [strictKnownMarketplaces reference](/en/settings#strictknownmarketplaces).650For complete configuration details including all supported source types and comparison with `extraKnownMarketplaces`, see the [strictKnownMarketplaces reference](/en/settings#strictknownmarketplaces).

507 651

652### Version resolution and release channels

653

654Plugin 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`).

655

656<Warning>

657 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.

658</Warning>

659

660#### Set up release channels

661

662To 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).

663

664<Warning>

665 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.

666</Warning>

667

668##### Example

669

670```json theme={null}

671{

672 "name": "stable-tools",

673 "plugins": [

674 {

675 "name": "code-formatter",

676 "source": {

677 "source": "github",

678 "repo": "acme-corp/code-formatter",

679 "ref": "stable"

680 }

681 }

682 ]

683}

684```

685

686```json theme={null}

687{

688 "name": "latest-tools",

689 "plugins": [

690 {

691 "name": "code-formatter",

692 "source": {

693 "source": "github",

694 "repo": "acme-corp/code-formatter",

695 "ref": "latest"

696 }

697 }

698 ]

699}

700```

701

702##### Assign channels to user groups

703

704Assign each marketplace to the appropriate user group through managed settings. For example, the stable group receives:

705

706```json theme={null}

707{

708 "extraKnownMarketplaces": {

709 "stable-tools": {

710 "source": {

711 "source": "github",

712 "repo": "acme-corp/stable-tools"

713 }

714 }

715 }

716}

717```

718

719The early-access group receives `latest-tools` instead:

720

721```json theme={null}

722{

723 "extraKnownMarketplaces": {

724 "latest-tools": {

725 "source": {

726 "source": "github",

727 "repo": "acme-corp/latest-tools"

728 }

729 }

730 }

731}

732```

733

508## Validation and testing734## Validation and testing

509 735

510Test your marketplace before sharing.736Test your marketplace before sharing.

553Run `claude plugin validate .` or `/plugin validate .` from your marketplace directory to check for issues. Common errors:779Run `claude plugin validate .` or `/plugin validate .` from your marketplace directory to check for issues. Common errors:

554 780

556| :------------------------------------------------ | :------------------------------ | :------------------------------------------------------------ |782| :------------------------------------------------ | :------------------------------ | :--------------------------------------------------------------------------------------------- |

561 787

562**Warnings** (non-blocking):788**Warnings** (non-blocking):

563 789

564* `Marketplace has no plugins defined`: add at least one plugin to the `plugins` array790* `Marketplace has no plugins defined`: add at least one plugin to the `plugins` array

565* `No marketplace description provided`: add `metadata.description` to help users understand your marketplace791* `No marketplace description provided`: add `metadata.description` to help users understand your marketplace

566* `Plugin "x" uses npm source which is not yet fully implemented`: use `github` or local path sources instead

567 792

568### Plugin installation failures793### Plugin installation failures

569 794

596* For GitLab, ensure the token has at least `read_repository` scope821* For GitLab, ensure the token has at least `read_repository` scope

597* Verify the token hasn't expired822* Verify the token hasn't expired

598 823

824### Git operations time out

825

826**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".

827

828**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.

829

830**Solution**: Increase the timeout using the `CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS` environment variable. The value is in milliseconds:

831

832```bash theme={null}

833export CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS=300000 # 5 minutes

834```

835

599### Plugins with relative paths fail in URL-based marketplaces836### Plugins with relative paths fail in URL-based marketplaces

600 837

601**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.838**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.

plugins.md +38 −14

Details

24* You're customizing Claude Code for a single project24* You're customizing Claude Code for a single project

25* The configuration is personal and doesn't need to be shared25* The configuration is personal and doesn't need to be shared

26* You're experimenting with skills or hooks before packaging them26* You're experimenting with skills or hooks before packaging them

~~27* You want short skill names like `/hello` or `/review`~~27* You want short skill names like `/hello` or `/deploy`

28 28

29**Use plugins when**:29**Use plugins when**:

30 30

122 claude --plugin-dir ./my-first-plugin122 claude --plugin-dir ./my-first-plugin

123 ```123 ```

124 124

125 Once Claude Code starts, try your new command:125 Once Claude Code starts, try your new skill:

126 126

127 ```shell theme={null}127 ```shell theme={null}

128 /my-first-plugin:hello128 /my-first-plugin:hello

129 ```129 ```

130 130

131 You'll see Claude respond with a greeting. Run `/help` to see your command listed under the plugin namespace.131 You'll see Claude respond with a greeting. Run `/help` to see your skill listed under the plugin namespace.

132 132

133 <Note>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.134 **Why namespacing?** Plugin skills are always namespaced (like `/greet:hello`) to prevent conflicts when multiple plugins have skills with the same name.

140 <Step title="Add skill arguments">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.141 Make your skill dynamic by accepting user input. The `$ARGUMENTS` placeholder captures any text the user provides after the skill name.

142 142

143 Update your `hello.md` file:143 Update your `SKILL.md` file:

144 144

145 ```markdown my-first-plugin/commands/hello.md theme={null}145 ```markdown my-first-plugin/skills/hello/SKILL.md theme={null}

146 ---146 ---

147 description: Greet the user with a personalized message147 description: Greet the user with a personalized message

148 ---148 ---

149 149

150 # Hello Command150 # Hello Skill

151 151

152 Greet the user named "$ARGUMENTS" warmly and ask how you can help them today. Make the greeting personal and encouraging.152 Greet the user named "$ARGUMENTS" warmly and ask how you can help them today. Make the greeting personal and encouraging.

153 ```153 ```

154 154

155 Restart Claude Code to pick up the changes, then try the command with your name:155 Run `/reload-plugins` to pick up the changes, then try the skill with your name:

156 156

157 ```shell theme={null}157 ```shell theme={null}

158 /my-first-plugin:hello Alex158 /my-first-plugin:hello Alex

165You've successfully created and tested a plugin with these key components:165You've successfully created and tested a plugin with these key components:

166 166

167* **Plugin manifest** (`.claude-plugin/plugin.json`): describes your plugin's metadata167* **Plugin manifest** (`.claude-plugin/plugin.json`): describes your plugin's metadata

168* **Commands directory** (`commands/`): contains your custom skills168* **Skills directory** (`skills/`): contains your custom skills

169* **Skill arguments** (`$ARGUMENTS`): captures user input for dynamic behavior169* **Skill arguments** (`$ARGUMENTS`): captures user input for dynamic behavior

170 170

171<Tip>171<Tip>

181</Warning>181</Warning>

182 182

184| :---------------- | :---------- | :---------------------------------------------- |184| :---------------- | :---------- | :----------------------------------------------------------------------------- |

192| `settings.json` | Plugin root | Default [settings](/en/settings) applied when the plugin is enabled |

192 193

193<Note>194<Note>

194 **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).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).

204 205

205Add a `skills/` directory at your plugin root with Skill folders containing `SKILL.md` files:206Add a `skills/` directory at your plugin root with Skill folders containing `SKILL.md` files:

206 207

207```208```text theme={null}

208my-plugin/209my-plugin/

209├── .claude-plugin/210├── .claude-plugin/

210│ └── plugin.json211│ └── plugin.json

2284. Test coverage2294. Test coverage

229```230```

230 231

231After installing the plugin, restart Claude Code to load the Skills. For complete Skill authoring guidance including progressive disclosure and tool restrictions, see [Agent Skills](/en/skills).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).

232 233

233### Add LSP servers to your plugin234### Add LSP servers to your plugin

234 235

254 255

255For complete LSP configuration options, see [LSP servers](/en/plugins-reference#lsp-servers).256For complete LSP configuration options, see [LSP servers](/en/plugins-reference#lsp-servers).

256 257

258### Ship default settings with your plugin

259

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.

261

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.

263

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

265{

266 "agent": "security-reviewer"

267}

268```

269

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.

271

257### Organize complex plugins272### Organize complex plugins

258 273

259For 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).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).

266claude --plugin-dir ./my-plugin281claude --plugin-dir ./my-plugin

267```282```

268 283

269As you make changes to your plugin, restart Claude Code to pick up the updates. Test your plugin components:284When 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.

285

286As you make changes to your plugin, run `/reload-plugins` to pick up the updates without restarting. Changes to LSP server configuration still require a full restart. Test your plugin components:

270 287

271* Try your commands with `/command-name`288* Try your skills with `/plugin-name:skill-name`

272* Check that agents appear in `/agents`289* Check that agents appear in `/agents`

273* Verify hooks work as expected290* Verify hooks work as expected

274 291

299 316

300Once your plugin is in a marketplace, others can install it using the instructions in [Discover and install plugins](/en/discover-plugins).317Once your plugin is in a marketplace, others can install it using the instructions in [Discover and install plugins](/en/discover-plugins).

301 318

319### Submit your plugin to the official marketplace

320

321To submit a plugin to the official Anthropic marketplace, use one of the in-app submission forms:

322

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)

325

302<Note>326<Note>

303 For complete technical specifications, debugging techniques, and distribution strategies, see [Plugins reference](/en/plugins-reference).327 For complete technical specifications, debugging techniques, and distribution strategies, see [Plugins reference](/en/plugins-reference).

304</Note>328</Note>

plugins-reference.md +54 −73

Details

12 12

13This 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.

14 14

~~15## Plugin components reference~~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.

16 16

~~17This section documents the types of components that plugins can provide.~~17## Plugin components reference

18 18

19### Skills19### Skills

20 20

26 26

27**Skill structure**:27**Skill structure**:

28 28

~~29```~~29```text theme={null}

30skills/30skills/

31├── pdf-processor/31├── pdf-processor/

32│ ├── SKILL.md32│ ├── SKILL.md

56 56

57```markdown theme={null}57```markdown theme={null}

58---58---

~~59description: What this agent specializes in~~59name: agent-name

~~60capabilities: ["task1", "task2", "task3"]~~60description: What this agent specializes in and when Claude should invoke it

61---61---

62 62

~~63# Agent Name~~63Detailed system prompt for the agent describing its role, expertise, and behavior.

~~65Detailed description of the agent's role, expertise, and when Claude should invoke it.~~

~~67## Capabilities~~

~~68- Specific task the agent excels at~~

~~69- Another specialized capability~~

~~70- When to use this agent vs others~~

~~72## Context and examples~~

~~73Provide examples of when this agent should be used and what kinds of problems it solves.~~

74```64```

75 65

76**Integration points**:66**Integration points**:

80* Agents can be invoked manually by users70* Agents can be invoked manually by users

81* Plugin agents work alongside built-in Claude agents71* Plugin agents work alongside built-in Claude agents

82 72

73For complete details, see [Subagents](/en/sub-agents).

83### Hooks75### Hooks

84 76

85Plugins can provide event handlers that respond to Claude Code events automatically.77Plugins can provide event handlers that respond to Claude Code events automatically.

121* `SubagentStop`: When a subagent attempts to stop113* `SubagentStop`: When a subagent attempts to stop

122* `SessionStart`: At the beginning of sessions114* `SessionStart`: At the beginning of sessions

123* `SessionEnd`: At the end of sessions115* `SessionEnd`: At the end of sessions

116* `TeammateIdle`: When an agent team teammate is about to go idle

117* `TaskCompleted`: When a task is being marked as completed

124* `PreCompact`: Before conversation history is compacted118* `PreCompact`: Before conversation history is compacted

125 119

126**Hook types**:120**Hook types**:

168### LSP servers162### LSP servers

169 163

170<Tip>164<Tip>

171 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.165 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.

172</Tip>166</Tip>

173 167

174Plugins 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.168Plugins 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.

257When you install a plugin, you choose a **scope** that determines where the plugin is available and who else can use it:251When you install a plugin, you choose a **scope** that determines where the plugin is available and who else can use it:

258 252

260| :-------- | :---------------------------- | :------------------------------------------------------- |254| :-------- | :---------------------------------------------- | :------------------------------------------------------- |

265 259

266Plugins 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).260Plugins 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).

267 261

269 263

270## Plugin manifest schema264## Plugin manifest schema

271 265

272The `plugin.json` file defines your plugin's metadata and configuration. This section documents all supported fields and options.266The `.claude-plugin/plugin.json` file defines your plugin's metadata and configuration. This section documents all supported fields and options.

267

268The 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.

273 269

274### Complete schema270### Complete schema

275 271

299 295

300### Required fields296### Required fields

301 297

298If you include a manifest, `name` is the only required field.

299

303| :----- | :----- | :---------------------------------------- | :------------------- |301| :----- | :----- | :---------------------------------------- | :------------------- |

305 303

304This name is used for namespacing components. For example, in the UI, the

305agent `agent-creator` for the plugin with name `plugin-dev` will appear as

306`plugin-dev:agent-creator`.

307

306### Metadata fields308### Metadata fields

307 309

309| :------------ | :----- | :---------------------------------- | :------------------------------------------------- |311| :------------ | :----- | :-------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |

312| `author` | object | Author information | `{"name": "Dev Team", "email": "dev@company.com"}` |314| `author` | object | Author information | `{"name": "Dev Team", "email": "dev@company.com"}` |

318### Component path fields320### Component path fields

319 321

321| :------------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------- |323| :------------- | :-------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------- |

329 331

330### Path behavior rules332### Path behavior rules

331 333

376 378

377## Plugin caching and file resolution379## Plugin caching and file resolution

378 380

379For security and verification purposes, Claude Code copies plugins to a cache directory rather than using them in-place. Understanding this behavior is important when developing plugins that reference external files.381Plugins are specified in one of two ways:

~~380~~

381### How plugin caching works

382 382

383When you install a plugin, Claude Code copies the plugin files to a cache directory:383* Through `claude --plugin-dir`, for the duration of a session.

384* Through a marketplace, installed for future sessions.

384 385

385* **For marketplace plugins with relative paths**: The path specified in the `source` field is copied recursively. For example, if your marketplace entry specifies `"source": "./plugins/my-plugin"`, the entire `./plugins` directory is copied.386For 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.

386* **For plugins with `.claude-plugin/plugin.json`**: The implicit root directory (the directory containing `.claude-plugin/plugin.json`) is copied recursively.

387 387

388### Path traversal limitations388### Path traversal limitations

389 389

390Plugins cannot reference files outside their copied directory structure. 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.390Installed 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.

391 391

392### Working with external dependencies392### Working with external dependencies

393 393

394If your plugin needs to access files outside its directory, you have two options:394If 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:

~~395~~

396**Option 1: Use symlinks**

~~397~~

398Create symbolic links to external files within your plugin directory. Symlinks are honored during the copy process:

399 395

400```bash theme={null}396```bash theme={null}

401# Inside your plugin directory397# Inside your plugin directory

402ln -s /path/to/shared-utils ./shared-utils398ln -s /path/to/shared-utils ./shared-utils

403```399```

404 400

405The symlinked content will be copied into the plugin cache.401The symlinked content will be copied into the plugin cache. This provides flexibility while maintaining the security benefits of the caching system.

~~406~~

407**Option 2: Restructure your marketplace**

~~408~~

409Set the plugin path to a parent directory that contains all required files, then provide the rest of the plugin manifest directly in the marketplace entry:

~~410~~

411```json theme={null}

412{

413 "name": "my-plugin",

414 "source": "./",

415 "description": "Plugin that needs root-level access",

416 "commands": ["./plugins/my-plugin/commands/"],

417 "agents": ["./plugins/my-plugin/agents/"],

418 "strict": false

419}

420```

~~421~~

422This approach copies the entire marketplace root, giving your plugin access to sibling directories.

~~423~~

424<Note>

425 Symlinks that point to locations outside the plugin's logical root are followed during copying. This provides flexibility while maintaining the security benefits of the caching system.

426</Note>

427 402

428***403***

429 404

433 408

434A complete plugin follows this structure:409A complete plugin follows this structure:

435 410

436```411```text theme={null}

437enterprise-plugin/412enterprise-plugin/

438├── .claude-plugin/ # Metadata directory413├── .claude-plugin/ # Metadata directory (optional)

439│ └── plugin.json # Required: plugin manifest414│ └── plugin.json # plugin manifest

440├── commands/ # Default command location415├── commands/ # Default command location

441│ ├── status.md416│ ├── status.md

442│ └── logs.md417│ └── logs.md

453├── hooks/ # Hook configurations428├── hooks/ # Hook configurations

454│ ├── hooks.json # Main hook config429│ ├── hooks.json # Main hook config

455│ └── security-hooks.json # Additional hooks430│ └── security-hooks.json # Additional hooks

431├── settings.json # Default settings for the plugin

456├── .mcp.json # MCP server definitions432├── .mcp.json # MCP server definitions

457├── .lsp.json # LSP server configurations433├── .lsp.json # LSP server configurations

458├── scripts/ # Hook and utility scripts434├── scripts/ # Hook and utility scripts

470### File locations reference446### File locations reference

471 447

473| :-------------- | :--------------------------- | :---------------------------------------------------------- |449| :-------------- | :--------------------------- | :------------------------------------------------------------------------------------------------------------------------ |

457| **Settings** | `settings.json` | Default configuration applied when the plugin is enabled. Only [`agent`](/en/sub-agents) settings are currently supported |

481 458

482***459***

483 460

506 483

484Scope 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.

485

507**Examples:**486**Examples:**

508 487

509```bash theme={null}488```bash theme={null}

601 580

602### Debugging commands581### Debugging commands

603 582

604Use `claude --debug` to see plugin loading details:583Use `claude --debug` (or `/debug` within the TUI) to see plugin loading details:

~~605~~

606```bash theme={null}

607claude --debug

608```

609 584

610This shows:585This shows:

611 586

637 612

638* `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 files613* `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

639* `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 directory614* `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

640* `Plugin my-plugin has conflicting manifests: both plugin.json and marketplace entry specify components.`: remove duplicate component definitions or set `strict: true` in marketplace entry615* `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

641 616

642### Hook troubleshooting617### Hook troubleshooting

643 618

675 650

676**Correct structure**: Components must be at the plugin root, not inside `.claude-plugin/`. Only `plugin.json` belongs in `.claude-plugin/`.651**Correct structure**: Components must be at the plugin root, not inside `.claude-plugin/`. Only `plugin.json` belongs in `.claude-plugin/`.

677 652

678```653```text theme={null}

679my-plugin/654my-plugin/

680├── .claude-plugin/655├── .claude-plugin/

681│ └── plugin.json ← Only manifest here656│ └── plugin.json ← Only manifest here

720* Document changes in a `CHANGELOG.md` file695* Document changes in a `CHANGELOG.md` file

721* Use pre-release versions like `2.0.0-beta.1` for testing696* Use pre-release versions like `2.0.0-beta.1` for testing

722 697

698<Warning>

699 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.

700

701 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`.

702</Warning>

703

723***704***

724 705

725## See also706## See also

quickstart.md +31 −28

Details

6 6

7> Welcome to Claude Code!7> Welcome to Claude Code!

8 8

~~9This 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.~~9This 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.

10 10

11## Before you begin11## Before you begin

12 12

13Make sure you have:13Make sure you have:

14 14

15* A terminal or command prompt open15* A terminal or command prompt open

16 * If you've never used the terminal before, check out the [terminal guide](/en/terminal-guide)

16* A code project to work with17* A code project to work with

17* A [Claude subscription](https://claude.com/pricing) (Pro, Max, Teams, or Enterprise), [Claude Console](https://console.anthropic.com/) account, or access through a [supported cloud provider](/en/third-party-integrations)18* 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)

18 19

19<Note>20<Note>

20 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).21 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).

44 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd45 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

45 ```46 ```

46 47

48 **Windows requires [Git for Windows](https://git-scm.com/downloads/win).** Install it first if you don't have it.

47 <Info>50 <Info>

48 Native installations automatically update in the background to keep you on the latest version.51 Native installations automatically update in the background to keep you on the latest version.

49 </Info>52 </Info>

50 </Tab>53 </Tab>

51 54

52 <Tab title="Homebrew">55 <Tab title="Homebrew">

~~53 ```sh theme={null}~~56 ```bash theme={null}

54 brew install --cask claude-code57 brew install --cask claude-code

55 ```58 ```

56 59

86 89

87You can log in using any of these account types:90You can log in using any of these account types:

88 91

~~89* [Claude Pro, Max, Teams, or Enterprise](https://claude.com/pricing) (recommended)~~92* [Claude Pro, Max, Teams, or Enterprise](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=quickstart_login) (recommended)

90* [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.93* [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.

91* [Amazon Bedrock, Google Vertex AI, or Microsoft Foundry](/en/third-party-integrations) (enterprise cloud providers)94* [Amazon Bedrock, Google Vertex AI, or Microsoft Foundry](/en/third-party-integrations) (enterprise cloud providers)

92 95

111 114

112Let's start with understanding your codebase. Try one of these commands:115Let's start with understanding your codebase. Try one of these commands:

113 116

114```117```text theme={null}

115what does this project do?118what does this project do?

116```119```

117 120

118Claude will analyze your files and provide a summary. You can also ask more specific questions:121Claude will analyze your files and provide a summary. You can also ask more specific questions:

119 122

120```123```text theme={null}

121what technologies does this project use?124what technologies does this project use?

122```125```

123 126

124```127```text theme={null}

125where is the main entry point?128where is the main entry point?

126```129```

127 130

128```131```text theme={null}

129explain the folder structure132explain the folder structure

130```133```

131 134

132You can also ask Claude about its own capabilities:135You can also ask Claude about its own capabilities:

133 136

134```137```text theme={null}

135what can Claude Code do?138what can Claude Code do?

136```139```

137 140

138```141```text theme={null}

139how do I create custom skills in Claude Code?142how do I create custom skills in Claude Code?

140```143```

141 144

142```145```text theme={null}

143can Claude Code work with Docker?146can Claude Code work with Docker?

144```147```

145 148

146<Note>149<Note>

147 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.150 Claude Code reads your project files as needed. You don't have to manually add context.

148</Note>151</Note>

149 152

150## Step 5: Make your first code change153## Step 5: Make your first code change

151 154

152Now let's make Claude Code do some actual coding. Try a simple task:155Now let's make Claude Code do some actual coding. Try a simple task:

153 156

154```157```text theme={null}

155add a hello world function to the main file158add a hello world function to the main file

156```159```

157 160

170 173

171Claude Code makes Git operations conversational:174Claude Code makes Git operations conversational:

172 175

173```176```text theme={null}

174what files have I changed?177what files have I changed?

175```178```

176 179

177```180```text theme={null}

178commit my changes with a descriptive message181commit my changes with a descriptive message

179```182```

180 183

181You can also prompt for more complex Git operations:184You can also prompt for more complex Git operations:

182 185

183```186```text theme={null}

184create a new branch called feature/quickstart187create a new branch called feature/quickstart

185```188```

186 189

187```190```text theme={null}

188show me the last 5 commits191show me the last 5 commits

189```192```

190 193

191```194```text theme={null}

192help me resolve merge conflicts195help me resolve merge conflicts

193```196```

194 197

198 201

199Describe what you want in natural language:202Describe what you want in natural language:

200 203

201```204```text theme={null}

202add input validation to the user registration form205add input validation to the user registration form

203```206```

204 207

205Or fix existing issues:208Or fix existing issues:

206 209

207```210```text theme={null}

208there's a bug where users can submit empty forms - fix it211there's a bug where users can submit empty forms - fix it

209```212```

210 213

221 224

222**Refactor code**225**Refactor code**

223 226

224```227```text theme={null}

225refactor the authentication module to use async/await instead of callbacks228refactor the authentication module to use async/await instead of callbacks

226```229```

227 230

228**Write tests**231**Write tests**

229 232

230```233```text theme={null}

231write unit tests for the calculator functions234write unit tests for the calculator functions

232```235```

233 236

234**Update documentation**237**Update documentation**

235 238

236```239```text theme={null}

237update the README with installation instructions240update the README with installation instructions

238```241```

239 242

240**Code review**243**Code review**

241 244

242```245```text theme={null}

243review my changes and suggest improvements246review my changes and suggest improvements

244```247```

245 248

246<Tip>249<Tip>

247 **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.250 Talk to Claude like you would a helpful colleague. Describe what you want to achieve, and it will help you get there.

248</Tip>251</Tip>

249 252

250## Essential commands253## Essential commands

279 <Accordion title="Use step-by-step instructions">282 <Accordion title="Use step-by-step instructions">

280 Break complex tasks into steps:283 Break complex tasks into steps:

281 284

282 ```285 ```text theme={null}

283 1. create a new database table for user profiles286 1. create a new database table for user profiles

284 2. create an API endpoint to get and update user profiles287 2. create an API endpoint to get and update user profiles

285 3. build a webpage that allows users to see and edit their information288 3. build a webpage that allows users to see and edit their information

289 <Accordion title="Let Claude explore first">292 <Accordion title="Let Claude explore first">

290 Before making changes, let Claude understand your code:293 Before making changes, let Claude understand your code:

291 294

292 ```295 ```text theme={null}

293 analyze the database schema296 analyze the database schema

294 ```297 ```

295 298

296 ```299 ```text theme={null}

297 build a dashboard showing products that are most frequently returned by our UK customers300 build a dashboard showing products that are most frequently returned by our UK customers

298 ```301 ```

299 </Accordion>302 </Accordion>

remote-control.md +137 −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. Team and Enterprise admins must first enable Claude Code in [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. Team and Enterprise admins must first enable Claude Code in [admin settings](https://claude.ai/admin-settings/claude-code). API keys are not supported.

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. • `same-dir` (default): all sessions share the current working directory, so they can conflict if editing the same files. • `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 takes its name from the `--name` argument (or the name passed to `/remote-control`), your last message, your `/rename` value, or "Remote Control session" if there's no conversation history. If the environment already has an active session, you'll be asked whether to continue it or start a new one.

104

105If 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).

106

107### Enable Remote Control for all sessions

108

109By 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.

110

111With 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.

112

113## Connection and security

114

115Your 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.

116

117All 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.

118

119## Remote Control vs Claude Code on the web

120

121Remote 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.

122

123Use 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.

124

125## Limitations

126

127* **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.

128* **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.

129* **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.

130

131## Related resources

132

133* [Claude Code on the web](/en/claude-code-on-the-web): run sessions in Anthropic-managed cloud environments instead of on your machine

134* [Authentication](/en/authentication): set up `/login` and manage credentials for claude.ai

135* [CLI reference](/en/cli-reference): full list of flags and commands including `claude remote-control`

136* [Security](/en/security): how Remote Control sessions fit into the Claude Code security model

137* [Data usage](/en/data-usage): what data flows through the Anthropic API during local and remote sessions

sandboxing.md +40 −4

Details

42* **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

43* **Configurable**: Define custom allowed and denied paths through settings43* **Configurable**: Define custom allowed and denied paths through settings

44 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.

45### Network isolation47### Network isolation

46 48

47Network access is controlled through a proxy server running outside the sandbox:49Network access is controlled through a proxy server running outside the sandbox:

48 50

49* **Domain restrictions**: Only approved domains can be accessed51* **Domain restrictions**: Only approved domains can be accessed

~~50* **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)

51* **Custom proxy support**: Advanced users can implement custom rules on outgoing traffic53* **Custom proxy support**: Advanced users can implement custom rules on outgoing traffic

52* **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

53 55

89 91

90You can enable sandboxing by running the `/sandbox` command:92You can enable sandboxing by running the `/sandbox` command:

91 93

~~92```~~94```text theme={null}

~~93> /sandbox~~95/sandbox

94```96```

95 97

96This 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.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.

113 115

114Customize sandbox behavior through your `settings.json` file. See [Settings](/en/settings#sandbox-settings) for complete configuration reference.116Customize sandbox behavior through your `settings.json` file. See [Settings](/en/settings#sandbox-settings) for complete configuration reference.

115 117

118#### Granting subprocess write access to specific paths

119

120By 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:

121

122```json theme={null}

123{

124 "sandbox": {

125 "enabled": true,

126 "filesystem": {

127 "allowWrite": ["~/.kube", "//tmp/build"]

128 }

129 }

130}

131```

132

133These 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`.

134

135When `allowWrite` (or `denyWrite`/`denyRead`) 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.

136

137Path prefixes control how paths are resolved:

138

139| Prefix | Meaning | Example |

140| :---------------- | :------------------------------------------ | :------------------------------------- |

141| `//` | Absolute path from filesystem root | `//tmp/build` becomes `/tmp/build` |

142| `~/` | Relative to home directory | `~/.kube` becomes `$HOME/.kube` |

143| `/` | Relative to the settings file's directory | `/build` becomes `$SETTINGS_DIR/build` |

144| `./` or no prefix | Relative path (resolved by sandbox runtime) | `./output` |

145

146You 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.

147

116<Tip>148<Tip>

117 Not all commands are compatible with sandboxing out of the box. Some notes that may help you make the most out of the sandbox:149 Not all commands are compatible with sandboxing out of the box. Some notes that may help you make the most out of the sandbox:

118 150

191* **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.223* **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.

192* **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.224* **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.

193 225

194Filesystem and network restrictions are configured through permission rules, not sandbox settings:226Filesystem and network restrictions are configured through both sandbox settings and permission rules:

195 227

228* Use `sandbox.filesystem.allowWrite` to grant subprocess write access to paths outside the working directory

229* Use `sandbox.filesystem.denyWrite` and `sandbox.filesystem.denyRead` to block subprocess access to specific paths

196* Use `Read` and `Edit` deny rules to block access to specific files or directories230* Use `Read` and `Edit` deny rules to block access to specific files or directories

197* Use `WebFetch` allow/deny rules to control domain access231* Use `WebFetch` allow/deny rules to control domain access

198* Use sandbox `allowedDomains` to control which domains Bash commands can reach232* Use sandbox `allowedDomains` to control which domains Bash commands can reach

199 233

234Paths from both `sandbox.filesystem` settings and permission rules are merged together into the final sandbox configuration.

235

200This [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.236This [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.

201 237

202## Advanced usage238## Advanced usage

scheduled-tasks.md +133 −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.

15Tasks are session-scoped: they live in the current Claude Code process and are gone when you exit. For durable scheduling that survives restarts and runs without an active terminal session, see [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) or [GitHub Actions](/en/github-actions).

17## Schedule a recurring prompt with /loop

19The `/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.

21```text theme={null}

22/loop 5m check if the deployment finished and tell me what happened

23```

25Claude parses the interval, converts it to a cron expression, schedules the job, and confirms the cadence and job ID.

27### Interval syntax

29Intervals are optional. You can lead with them, trail with them, or leave them out entirely.

31| Form | Example | Parsed interval |

32| :---------------------- | :------------------------------------ | :--------------------------- |

33| Leading token | `/loop 30m check the build` | every 30 minutes |

34| Trailing `every` clause | `/loop check the build every 2 hours` | every 2 hours |

35| No interval | `/loop check the build` | defaults to every 10 minutes |

37Supported 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.

39### Loop over another command

41The scheduled prompt can itself be a command or skill invocation. This is useful for re-running a workflow you've already packaged.

43```text theme={null}

44/loop 20m /review-pr 1234

45```

47Each time the job fires, Claude runs `/review-pr 1234` as if you had typed it.

49## Set a one-time reminder

51For 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.

53```text theme={null}

54remind me at 3pm to push the release branch

55```

57```text theme={null}

58in 45 minutes, check whether the integration tests passed

59```

61Claude pins the fire time to a specific minute and hour using a cron expression and confirms when it will fire.

63## Manage scheduled tasks

65Ask Claude in natural language to list or cancel tasks, or reference the underlying tools directly.

67```text theme={null}

68what scheduled tasks do I have?

69```

71```text theme={null}

72cancel the deploy check job

73```

75Under the hood, Claude uses these tools:

77| Tool | Purpose |

78| :----------- | :-------------------------------------------------------------------------------------------------------------- |

79| `CronCreate` | Schedule a new task. Accepts a 5-field cron expression, the prompt to run, and whether it recurs or fires once. |

80| `CronList` | List all scheduled tasks with their IDs, schedules, and prompts. |

81| `CronDelete` | Cancel a task by ID. |

83Each scheduled task has an 8-character ID you can pass to `CronDelete`. A session can hold up to 50 scheduled tasks at once.

85## How scheduled tasks run

87The 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.

89All times are interpreted in your local timezone. A cron expression like `0 9 * * *` means 9am wherever you're running Claude Code, not UTC.

91### Jitter

93To avoid every session hitting the API at the same wall-clock moment, the scheduler adds a small deterministic offset to fire times:

95* Recurring tasks fire up to 10% of their period late, capped at 15 minutes. An hourly job might fire anywhere from `:00` to `:06`.

96* One-shot tasks scheduled for the top or bottom of the hour fire up to 90 seconds early.

98The 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.

100### Three-day expiry

101

102Recurring 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 [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) for durable scheduling.

103

104## Cron expression reference

105

106`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`).

107

108| Example | Meaning |

109| :------------- | :--------------------------- |

110| `*/5 * * * *` | Every 5 minutes |

111| `0 * * * *` | Every hour on the hour |

112| `7 * * * *` | Every hour at 7 minutes past |

113| `0 9 * * *` | Every day at 9am local |

114| `0 9 * * 1-5` | Weekdays at 9am local |

115| `30 14 15 3 *` | March 15 at 2:30pm local |

116

117Day-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.

118

119When both day-of-month and day-of-week are constrained, a date matches if either field matches. This follows standard vixie-cron semantics.

120

121## Disable scheduled tasks

122

123Set `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.

124

125## Limitations

126

127Session-scoped scheduling has inherent constraints:

128

129* Tasks only fire while Claude Code is running and idle. Closing the terminal or letting the session exit cancels everything.

130* 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.

131* No persistence across restarts. Restarting Claude Code clears all session-scoped tasks.

132

133For cron-driven automation that needs to run unattended, use a [GitHub Actions workflow](/en/github-actions) with a `schedule` trigger, or [Desktop scheduled tasks](/en/desktop#schedule-recurring-tasks) if you want a graphical setup flow.

security.md +4 −1

Details

106 106

107For 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).

108 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

109## Security best practices111## Security best practices

110 112

111### Working with sensitive code113### Working with sensitive code

117 119

118### Team security120### Team security

119 121

120* Use [managed settings](/en/permissions#managed-settings) to enforce organizational standards122* Use [managed settings](/en/settings#settings-files) to enforce organizational standards

121* Share approved permission configurations through version control123* Share approved permission configurations through version control

122* Train team members on security best practices124* Train team members on security best practices

123* 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)

124 127

125### Reporting security issues128### Reporting security issues

126 129

server-managed-settings.md +164 −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 [managed-only settings](/en/permissions#managed-only-settings) like `disableBypassPermissionsMode`.

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 },

58 "disableBypassPermissionsMode": "disable"

59 }

60 ```

61 </Step>

63 <Step title="Save and deploy">

64 Save your changes. Claude Code clients receive the updated settings on their next startup or hourly polling cycle.

65 </Step>

66</Steps>

68### Verify settings delivery

70To 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.

72### Access control

74The following roles can manage server-managed settings:

76* **Primary Owner**

77* **Owner**

79Restrict access to trusted personnel, as settings changes apply to all users in the organization.

81### Current limitations

83Server-managed settings have the following limitations during the beta period:

85* Settings apply uniformly to all users in the organization. Per-group configurations are not yet supported.

86* [MCP server configurations](/en/mcp#managed-mcp-configuration) cannot be distributed through server-managed settings.

88## Settings delivery

90### Settings precedence

92Server-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.

94### Fetch and caching behavior

96Claude Code fetches settings from Anthropic's servers at startup and polls for updates hourly during active sessions.

98**First launch without cached settings:**

100* Claude Code fetches settings asynchronously

101* If the fetch fails, Claude Code continues without managed settings

102* There is a brief window before settings load where restrictions are not yet enforced

103

104**Subsequent launches with cached settings:**

105

106* Cached settings apply immediately at startup

107* Claude Code fetches fresh settings in the background

108* Cached settings persist through network failures

109

110Claude Code applies settings updates automatically without a restart, except for advanced settings like OpenTelemetry configuration, which require a full restart to take effect.

111

112### Security approval dialogs

113

114Certain settings that could pose security risks require explicit user approval before being applied:

115

116* **Shell command settings**: settings that execute shell commands

117* **Custom environment variables**: variables not in the known safe allowlist

118* **Hook configurations**: any hook definition

119

120When 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.

121

122<Note>

123 In non-interactive mode with the `-p` flag, Claude Code skips security dialogs and applies settings without user approval.

124</Note>

125

126## Platform availability

127

128Server-managed settings require a direct connection to `api.anthropic.com` and are not available when using third-party model providers:

129

130* Amazon Bedrock

131* Google Vertex AI

132* Microsoft Foundry

133* Custom API endpoints via `ANTHROPIC_BASE_URL` or [LLM gateways](/en/llm-gateway)

134

135## Audit logging

136

137Audit log events for settings changes are available through the compliance API or audit log export. Contact your Anthropic account team for access.

138

139Audit events include the type of action performed, the account and device that performed the action, and references to the previous and new values.

140

141## Security considerations

142

143Server-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.

144

145| Scenario | Behavior |

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

147| User edits the cached settings file | Tampered file applies at startup, but correct settings restore on the next server fetch |

148| User deletes the cached settings file | First-launch behavior occurs: settings fetch asynchronously with a brief unenforced window |

149| API is unavailable | Cached settings apply if available, otherwise managed settings are not enforced until the next successful fetch |

150| User authenticates with a different organization | Settings are not delivered for accounts outside the managed organization |

151| User sets a non-default `ANTHROPIC_BASE_URL` | Server-managed settings are bypassed when using third-party API providers |

152

153To detect runtime configuration changes, use [`ConfigChange` hooks](/en/hooks#configchange) to log modifications or block unauthorized changes before they take effect.

154

155For stronger enforcement guarantees, use [endpoint-managed settings](/en/settings#settings-files) on devices enrolled in an MDM solution.

156

157## See also

158

159Related pages for managing Claude Code configuration:

160

161* [Settings](/en/settings): complete configuration reference including all available settings

162* [Endpoint-managed settings](/en/settings#settings-files): managed settings deployed to devices by IT

163* [Authentication](/en/authentication): set up user access to Claude Code

164* [Security](/en/security): security safeguards and best practices

settings.md +126 −224

Details

15### Available scopes15### Available scopes

16 16

~~18| :---------- | :----------------------------------- | :----------------------------------- | :--------------------- |~~18| :---------- | :--------------------------------------------------------------------------------- | :----------------------------------- | :--------------------- |

20| **User** | `~/.claude/` directory | You, across all projects | No |20| **User** | `~/.claude/` directory | You, across all projects | No |

~~22| **Local** | `.claude/*.local.*` files | You, in this repository only | No (gitignored) |~~22| **Local** | `.claude/settings.local.json` | You, in this repository only | No (gitignored) |

23 23

24### When to use each scope24### When to use each scope

25 25

67| :-------------- | :------------------------ | :--------------------------------- | :----------------------------- |67| :-------------- | :------------------------ | :--------------------------------- | :----------------------------- |

73 73

74***74***

75 75

76## Settings files76## Settings files

77 77

~~78The `settings.json` file is our official mechanism for configuring Claude~~78The `settings.json` file is the official mechanism for configuring Claude

79Code through hierarchical settings:79Code through hierarchical settings:

80 80

81* **User settings** are defined in `~/.claude/settings.json` and apply to all81* **User settings** are defined in `~/.claude/settings.json` and apply to all

83* **Project settings** are saved in your project directory:83* **Project settings** are saved in your project directory:

84 * `.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

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.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.

~~86* **Managed settings**: For organizations that need centralized control, Claude Code supports `managed-settings.json` and `managed-mcp.json` files that can be deployed to system directories:~~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:

88 * **Server-managed settings**: delivered from Anthropic's servers via the Claude.ai admin console. See [server-managed settings](/en/server-managed-settings).

89 * **MDM/OS-level policies**: delivered through native device management on macOS and Windows:

90 * macOS: `com.anthropic.claudecode` managed preferences domain (deployed via configuration profiles in Jamf, Kandji, or other MDM tools)

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)

92 * Windows (user-level): `HKCU\SOFTWARE\Policies\ClaudeCode` (lowest policy priority, only used when no admin-level source exists)

93 * **File-based**: `managed-settings.json` and `managed-mcp.json` deployed to system directories:

87 94

88 * macOS: `/Library/Application Support/ClaudeCode/`95 * macOS: `/Library/Application Support/ClaudeCode/`

89 * Linux and WSL: `/etc/claude-code/`96 * Linux and WSL: `/etc/claude-code/`

90 * Windows: `C:\Program Files\ClaudeCode\`97 * Windows: `C:\Program Files\ClaudeCode\`

91 98

~~92 <Note>~~99 <Warning>

~~93 These are system-wide paths (not user home directories like `~/Library/...`) that require administrator privileges. They are designed to be deployed by IT administrators.~~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`.

~~94 </Note>~~101 </Warning>

95 102

~~96 See [Managed settings](/en/permissions#managed-settings) and [Managed MCP configuration](/en/mcp#managed-mcp-configuration) for details.~~103 See [managed settings](/en/permissions#managed-only-settings) and [Managed MCP configuration](/en/mcp#managed-mcp-configuration) for details.

97 104

98 <Note>105 <Note>

99 Managed deployments can also restrict **plugin marketplace additions** using106 Managed deployments can also restrict **plugin marketplace additions** using

140`settings.json` supports a number of options:147`settings.json` supports a number of options:

141 148

142| Key | Description | Example |149| Key | Description | Example |

143| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------- |150| :-------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- |

144| `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` |151| `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` |

145| `cleanupPeriodDays` | Sessions inactive for longer than this period are deleted at startup. Setting to `0` immediately deletes all sessions. (default: 30 days) | `20` |152| `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"` |

153| `cleanupPeriodDays` | Sessions inactive for longer than this period are deleted at startup (default: 30 days). 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` |

146| `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"]` |154| `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"]` |

147| `env` | Environment variables that will be applied to every session | `{"FOO": "bar"}` |155| `env` | Environment variables that will be applied to every session | `{"FOO": "bar"}` |

148| `attribution` | Customize attribution for git commits and pull requests. See [Attribution settings](#attribution-settings) | `{"commit": "🤖 Generated with Claude Code", "pr": ""}` |156| `attribution` | Customize attribution for git commits and pull requests. See [Attribution settings](#attribution-settings) | `{"commit": "🤖 Generated with Claude Code", "pr": ""}` |

149| `includeCoAuthoredBy` | **Deprecated**: Use `attribution` instead. Whether to include the `co-authored-by Claude` byline in git commits and pull requests (default: `true`) | `false` |157| `includeCoAuthoredBy` | **Deprecated**: Use `attribution` instead. Whether to include the `co-authored-by Claude` byline in git commits and pull requests (default: `true`) | `false` |

158| `includeGitInstructions` | Include built-in commit and PR workflow instructions in Claude's system prompt (default: `true`). Set to `false` to remove these instructions, 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` |

153| `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` |162| `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` |

163| `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/*"]` |

164| `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"]` |

154| `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` |165| `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` |

155| `model` | Override the default model to use for Claude Code | `"claude-sonnet-4-5-20250929"` |166| `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` |

167| `model` | Override the default model to use for Claude Code | `"claude-sonnet-4-6"` |

168| `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"]` |

169| `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:..."}` |

170| `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"` |

156| `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` |171| `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` |

157| `statusLine` | Configure a custom status line to display context. See [`statusLine` documentation](/en/statusline) | `{"type": "command", "command": "~/.claude/statusline.sh"}` |172| `statusLine` | Configure a custom status line to display context. See [`statusLine` documentation](/en/statusline) | `{"type": "command", "command": "~/.claude/statusline.sh"}` |

158| `fileSuggestion` | Configure a custom script for `@` file autocomplete. See [File suggestion settings](#file-suggestion-settings) | `{"type": "command", "command": "~/.claude/file-suggestion.sh"}` |173| `fileSuggestion` | Configure a custom script for `@` file autocomplete. See [File suggestion settings](#file-suggestion-settings) | `{"type": "command", "command": "~/.claude/file-suggestion.sh"}` |

166| `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" }]` |181| `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" }]` |

167| `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" }]` |182| `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" }]` |

168| `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" }]` |183| `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" }]` |

184| `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" }]` |

185| `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"` |

169| `awsAuthRefresh` | Custom script that modifies the `.aws` directory (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `aws sso login --profile myprofile` |186| `awsAuthRefresh` | Custom script that modifies the `.aws` directory (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `aws sso login --profile myprofile` |

170| `awsCredentialExport` | Custom script that outputs JSON with AWS credentials (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `/bin/generate_aws_grant.sh` |187| `awsCredentialExport` | Custom script that outputs JSON with AWS credentials (see [advanced credential configuration](/en/amazon-bedrock#advanced-credential-configuration)) | `/bin/generate_aws_grant.sh` |

171| `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` |188| `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` |

175| `language` | Configure Claude's preferred response language (e.g., `"japanese"`, `"spanish"`, `"french"`). Claude will respond in this language by default | `"japanese"` |192| `language` | Configure Claude's preferred response language (e.g., `"japanese"`, `"spanish"`, `"french"`). Claude will respond in this language by default | `"japanese"` |

176| `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"` |193| `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"` |

195| `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"] }` |

178| `terminalProgressBarEnabled` | Enable the terminal progress bar that shows progress in supported terminals like Windows Terminal and iTerm2 (default: `true`) | `false` |196| `terminalProgressBarEnabled` | Enable the terminal progress bar that shows progress in supported terminals like Windows Terminal and iTerm2 (default: `true`) | `false` |

198| `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` |

199| `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"` |

200| `feedbackSurveyRate` | Probability (0–1) that the session quality survey appears when eligible. Enterprise admins can set this to control how often the survey is shown to users. A value of `0.05` means 5% of eligible sessions | `0.05` |

201

202### Worktree settings

203

204Configure how `--worktree` creates and manages git worktrees. Use these settings to reduce disk usage and startup time in large monorepos.

205

206| Key | Description | Example |

207| :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------ |

208| `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"]` |

209| `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"]` |

180 210

181### Permission settings211### Permission settings

182 212

187| `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/**)" ]` |217| `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/**)" ]` |

190| `disableBypassPermissionsMode` | Set to `"disable"` to prevent `bypassPermissions` mode from being activated. This disables the `--dangerously-skip-permissions` command-line flag. See [managed settings](/en/permissions#managed-settings) | `"disable"` |220| `disableBypassPermissionsMode` | Set to `"disable"` to prevent `bypassPermissions` mode from being activated. This disables the `--dangerously-skip-permissions` command-line flag. See [managed settings](/en/permissions#managed-only-settings) | `"disable"` |

191 221

192### Permission rule syntax222### Permission rule syntax

193 223

204 234

205For the complete rule syntax reference, including wildcard behavior, tool-specific patterns for Read, Edit, WebFetch, MCP, and Task rules, and security limitations of Bash patterns, see [Permission rule syntax](/en/permissions#permission-rule-syntax).235For 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).

206 236

207### Sandbox settings237### Sandbox settings

208 238

209Configure advanced sandboxing behavior. Sandboxing isolates bash commands from your filesystem and network. See [Sandboxing](/en/sandboxing) for details.239Configure advanced sandboxing behavior. Sandboxing isolates bash commands from your filesystem and network. See [Sandboxing](/en/sandboxing) for details.

210 240

211**Filesystem and network restrictions** are configured via Read, Edit, and WebFetch permission rules, not via these sandbox settings.

~~212~~

214| :---------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------ |242| :-------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------ |

218| `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` |246| `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` |

247| `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"]` |

248| `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"]` |

249| `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"]` |

254| `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` |

223| `network.httpProxyPort` | HTTP proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8080` |255| `network.httpProxyPort` | HTTP proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8080` |

224| `network.socksProxyPort` | SOCKS5 proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8081` |256| `network.socksProxyPort` | SOCKS5 proxy port used if you wish to bring your own proxy. If not specified, Claude will run its own proxy. | `8081` |

258| `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` |

259

260#### Sandbox path prefixes

261

262Paths in `filesystem.allowWrite`, `filesystem.denyWrite`, and `filesystem.denyRead` support these prefixes:

263

264| Prefix | Meaning | Example |

265| :---------------- | :------------------------------------------ | :------------------------------------- |

266| `//` | Absolute path from filesystem root | `//tmp/build` becomes `/tmp/build` |

267| `~/` | Relative to home directory | `~/.kube` becomes `$HOME/.kube` |

268| `/` | Relative to the settings file's directory | `/build` becomes `$SETTINGS_DIR/build` |

269| `./` or no prefix | Relative path (resolved by sandbox runtime) | `./output` |

226 270

227**Configuration example:**271**Configuration example:**

228 272

232 "enabled": true,276 "enabled": true,

233 "autoAllowBashIfSandboxed": true,277 "autoAllowBashIfSandboxed": true,

234 "excludedCommands": ["docker"],278 "excludedCommands": ["docker"],

279 "filesystem": {

280 "allowWrite": ["//tmp/build", "~/.kube"],

281 "denyRead": ["~/.aws/credentials"]

282 },

235 "network": {283 "network": {

236 "allowedDomains": ["github.com", "*.npmjs.org", "registry.yarnpkg.com"],284 "allowedDomains": ["github.com", "*.npmjs.org", "registry.yarnpkg.com"],

237 "allowUnixSockets": [285 "allowUnixSockets": [

239 ],287 ],

240 "allowLocalBinding": true288 "allowLocalBinding": true

241 }289 }

242 },

243 "permissions": {

244 "deny": [

245 "Read(.envrc)",

246 "Read(~/.aws/**)"

247 ]

248 }290 }

249}291}

250```292```

251 293

252**Filesystem and network restrictions** use standard permission rules:294**Filesystem and network restrictions** can be configured in two ways that are merged together:

253 295

254* Use `Read` deny rules to block Claude from reading specific files or directories296* **`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.

255* Use `Edit` allow rules to let Claude write to directories beyond the current working directory297* **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.

256* Use `Edit` deny rules to block writes to specific paths

257* Use `WebFetch` allow/deny rules to control which network domains Claude can access

258 298

259### Attribution settings299### Attribution settings

260 300

270 310

271**Default commit attribution:**311**Default commit attribution:**

272 312

273```313```text theme={null}

274🤖 Generated with [Claude Code](https://claude.com/claude-code)314🤖 Generated with [Claude Code](https://claude.com/claude-code)

275 315

276 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>316 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

277```317```

278 318

279**Default pull request attribution:**319**Default pull request attribution:**

280 320

281```321```text theme={null}

282🤖 Generated with [Claude Code](https://claude.com/claude-code)322🤖 Generated with [Claude Code](https://claude.com/claude-code)

283```323```

284 324

318 358

319Output newline-separated file paths to stdout (currently limited to 15):359Output newline-separated file paths to stdout (currently limited to 15):

320 360

321```361```text theme={null}

322src/components/Button.tsx362src/components/Button.tsx

323src/components/Modal.tsx363src/components/Modal.tsx

324src/components/Form.tsx364src/components/Form.tsx

334 374

335### Hook configuration375### Hook configuration

336 376

337**Managed settings only**: Controls which hooks are allowed to run. This setting can only be configured in [managed settings](#settings-files) and provides administrators with strict control over hook execution.377These 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.

338 378

339**Behavior when `allowManagedHooksOnly` is `true`:**379**Behavior when `allowManagedHooksOnly` is `true`:**

340 380

341* Managed hooks and SDK hooks are loaded381* Managed hooks and SDK hooks are loaded

342* User hooks, project hooks, and plugin hooks are blocked382* User hooks, project hooks, and plugin hooks are blocked

343 383

344**Configuration:**384**Restrict HTTP hook URLs:**

385

386Limit 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.

345 387

346```json theme={null}388```json theme={null}

347{389{

348 "allowManagedHooksOnly": true390 "allowedHttpHookUrls": ["https://hooks.example.com/*", "http://localhost:*"]

391}

392```

393

394**Restrict HTTP hook environment variables:**

395

396Limit 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.

397

398```json theme={null}

399{

400 "httpHookAllowedEnvVars": ["MY_TOKEN", "HOOK_SECRET"]

349}401}

350```402```

351 403

353 405

354Settings apply in order of precedence. From highest to lowest:406Settings apply in order of precedence. From highest to lowest:

355 407

3561. **Managed settings** (`managed-settings.json`)4081. **Managed settings** ([server-managed](/en/server-managed-settings), [MDM/OS-level policies](#configuration-scopes), or [managed settings](/en/settings#settings-files))

357 * Policies deployed by IT/DevOps to system directories409 * Policies deployed by IT through server delivery, MDM configuration profiles, registry policies, or managed settings files

358 * Cannot be overridden by user or project settings410 * Cannot be overridden by any other level, including command line arguments

411 * Within the managed tier, precedence is: server-managed > MDM/OS-level policies > `managed-settings.json` > HKCU registry (Windows only). Only one managed source is used; sources do not merge.

359 412

3602. **Command line arguments**4132. **Command line arguments**

361 * Temporary overrides for a specific session414 * Temporary overrides for a specific session

373 426

374For 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.427For 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.

375 428

429<Note>

430 **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.

431</Note>

432

433### Verify active settings

434

435Run `/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.

436

376### Key points about the configuration system437### Key points about the configuration system

377 438

378* **Memory files (`CLAUDE.md`)**: Contain instructions and context that Claude loads at startup439* **Memory files (`CLAUDE.md`)**: Contain instructions and context that Claude loads at startup

502 563

503#### `strictKnownMarketplaces`564#### `strictKnownMarketplaces`

504 565

505**Managed settings only**: Controls which plugin marketplaces users are allowed to add. This setting can only be configured in [`managed-settings.json`](/en/permissions#managed-settings) and provides administrators with strict control over marketplace sources.566**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.

506 567

507**Managed settings file locations**:568**Managed settings file locations**:

508 569

710}771}

711```772```

712 773

774**Using both together**:

775

776`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`:

777

778```json theme={null}

779{

780 "strictKnownMarketplaces": [

781 { "source": "github", "repo": "acme-corp/plugins" }

782 ],

783 "extraKnownMarketplaces": {

784 "acme-tools": {

785 "source": { "source": "github", "repo": "acme-corp/plugins" }

786 }

787 }

788}

789```

790

791With only `strictKnownMarketplaces` set, users can still add the allowed marketplace manually via `/plugin marketplace add`, but it is not available automatically.

792

713**Important notes**:793**Important notes**:

714 794

715* Restrictions are checked BEFORE any network requests or filesystem operations795* Restrictions are checked BEFORE any network requests or filesystem operations

733 813

734## Environment variables814## Environment variables

735 815

736Claude Code supports the following environment variables to control its behavior:816Environment 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.

737 817

738<Note>818See the [environment variables reference](/en/env-vars) for the full list.

739 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.

740</Note>

~~741~~

742| Variable | Purpose | |

743| :--------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |

744| `ANTHROPIC_API_KEY` | API key sent as `X-Api-Key` header, typically for the Claude SDK (for interactive usage, run `/login`) | |

745| `ANTHROPIC_AUTH_TOKEN` | Custom value for the `Authorization` header (the value you set here will be prefixed with `Bearer `) | |

746| `ANTHROPIC_CUSTOM_HEADERS` | Custom headers to add to requests (`Name: Value` format, newline-separated for multiple headers) | |

747| `ANTHROPIC_DEFAULT_HAIKU_MODEL` | See [Model configuration](/en/model-config#environment-variables) | |

748| `ANTHROPIC_DEFAULT_OPUS_MODEL` | See [Model configuration](/en/model-config#environment-variables) | |

749| `ANTHROPIC_DEFAULT_SONNET_MODEL` | See [Model configuration](/en/model-config#environment-variables) | |

750| `ANTHROPIC_FOUNDRY_API_KEY` | API key for Microsoft Foundry authentication (see [Microsoft Foundry](/en/microsoft-foundry)) | |

751| `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)) | |

752| `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)) | |

753| `ANTHROPIC_MODEL` | Name of the model setting to use (see [Model Configuration](/en/model-config#environment-variables)) | |

754| `ANTHROPIC_SMALL_FAST_MODEL` | \[DEPRECATED] Name of [Haiku-class model for background tasks](/en/costs) | |

755| `ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION` | Override AWS region for the Haiku-class model when using Bedrock | |

756| `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/)) | |

757| `BASH_DEFAULT_TIMEOUT_MS` | Default timeout for long-running bash commands | |

758| `BASH_MAX_OUTPUT_LENGTH` | Maximum number of characters in bash outputs before they are middle-truncated | |

759| `BASH_MAX_TIMEOUT_MS` | Maximum timeout the model can set for long-running bash commands | |

760| `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) | |

761| `CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR` | Return to the original working directory after each Bash command | |

762| `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 | `1` |

763| `CLAUDE_CODE_API_KEY_HELPER_TTL_MS` | Interval in milliseconds at which credentials should be refreshed (when using `apiKeyHelper`) | |

764| `CLAUDE_CODE_CLIENT_CERT` | Path to client certificate file for mTLS authentication | |

765| `CLAUDE_CODE_CLIENT_KEY_PASSPHRASE` | Passphrase for encrypted CLAUDE\_CODE\_CLIENT\_KEY (optional) | |

766| `CLAUDE_CODE_CLIENT_KEY` | Path to client private key file for mTLS authentication | |

767| `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 | |

768| `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 | |

769| `CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY` | Set to `1` to disable the "How is Claude doing?" session quality surveys. Also disabled when using third-party providers or when telemetry is disabled. See [Session quality surveys](/en/data-usage#session-quality-surveys) | |

770| `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 | |

771| `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 | |

772| `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) | |

773| `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 | |

774| `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | Equivalent of setting `DISABLE_AUTOUPDATER`, `DISABLE_BUG_COMMAND`, `DISABLE_ERROR_REPORTING`, and `DISABLE_TELEMETRY` | |

775| `CLAUDE_CODE_DISABLE_TERMINAL_TITLE` | Set to `1` to disable automatic terminal title updates based on conversation context | |

776| `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) | |

777| `CLAUDE_CODE_ENABLE_TASKS` | Set to `false` to temporarily revert to the previous TODO list instead of the task tracking system. Default: `true`. See [Task list](/en/interactive-mode#task-list) | |

778| `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) | |

779| `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 | |

780| `CLAUDE_CODE_HIDE_ACCOUNT_INFO` | Set to `1` to hide your email address and organization name from the Claude Code UI. Useful when streaming or recording | |

781| `CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL` | Skip auto-installation of IDE extensions | |

782| `CLAUDE_CODE_MAX_OUTPUT_TOKENS` | Set the maximum number of output tokens for most requests. Default: 32,000. Maximum: 64,000. Increasing this value reduces the effective context window available before [auto-compaction](/en/costs#reduce-token-usage) triggers. | |

783| `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) | |

784| `CLAUDE_CODE_SHELL` | Override automatic shell detection. Useful when your login shell differs from your preferred working shell (for example, `bash` vs `zsh`) | |

785| `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>` | |

786| `CLAUDE_CODE_SKIP_BEDROCK_AUTH` | Skip AWS authentication for Bedrock (for example, when using an LLM gateway) | |

787| `CLAUDE_CODE_SKIP_FOUNDRY_AUTH` | Skip Azure authentication for Microsoft Foundry (for example, when using an LLM gateway) | |

788| `CLAUDE_CODE_SKIP_VERTEX_AUTH` | Skip Google authentication for Vertex (for example, when using an LLM gateway) | |

789| `CLAUDE_CODE_SUBAGENT_MODEL` | See [Model configuration](/en/model-config) | |

790| `CLAUDE_CODE_USE_BEDROCK` | Use [Bedrock](/en/amazon-bedrock) | |

791| `CLAUDE_CODE_USE_FOUNDRY` | Use [Microsoft Foundry](/en/microsoft-foundry) | |

792| `CLAUDE_CODE_USE_VERTEX` | Use [Vertex](/en/google-vertex-ai) | |

793| `CLAUDE_CONFIG_DIR` | Customize where Claude Code stores its configuration and data files | |

794| `DISABLE_AUTOUPDATER` | Set to `1` to disable automatic updates. | |

795| `DISABLE_BUG_COMMAND` | Set to `1` to disable the `/bug` command | |

796| `DISABLE_COST_WARNINGS` | Set to `1` to disable cost warning messages | |

797| `DISABLE_ERROR_REPORTING` | Set to `1` to opt out of Sentry error reporting | |

798| `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 | |

799| `DISABLE_NON_ESSENTIAL_MODEL_CALLS` | Set to `1` to disable model calls for non-critical paths like flavor text | |

800| `DISABLE_PROMPT_CACHING` | Set to `1` to disable prompt caching for all models (takes precedence over per-model settings) | |

801| `DISABLE_PROMPT_CACHING_HAIKU` | Set to `1` to disable prompt caching for Haiku models | |

802| `DISABLE_PROMPT_CACHING_OPUS` | Set to `1` to disable prompt caching for Opus models | |

803| `DISABLE_PROMPT_CACHING_SONNET` | Set to `1` to disable prompt caching for Sonnet models | |

804| `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) | |

805| `ENABLE_TOOL_SEARCH` | Controls [MCP tool search](/en/mcp#scale-with-mcp-tool-search). Values: `auto` (default, enables at 10% context), `auto:N` (custom threshold, e.g., `auto:5` for 5%), `true` (always on), `false` (disabled) | |

806| `FORCE_AUTOUPDATE_PLUGINS` | Set to `true` to force plugin auto-updates even when the main auto-updater is disabled via `DISABLE_AUTOUPDATER` | |

807| `HTTP_PROXY` | Specify HTTP proxy server for network connections | |

808| `HTTPS_PROXY` | Specify HTTPS proxy server for network connections | |

809| `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 | |

810| `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) | |

811| `MAX_THINKING_TOKENS` | Override the [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) token budget. Thinking is enabled at max budget (31,999 tokens) by default. Use this to limit the budget (for example, `MAX_THINKING_TOKENS=10000`) or disable thinking entirely (`MAX_THINKING_TOKENS=0`). Extended thinking improves performance on complex reasoning and coding tasks but impacts [prompt caching efficiency](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#caching-with-thinking-blocks). | |

812| `MCP_TIMEOUT` | Timeout in milliseconds for MCP server startup | |

813| `MCP_TOOL_TIMEOUT` | Timeout in milliseconds for MCP tool execution | |

814| `NO_PROXY` | List of domains and IPs to which requests will be directly issued, bypassing proxy | |

815| `SLASH_COMMAND_TOOL_CHAR_BUDGET` | Maximum number of characters for skill metadata shown to the [Skill tool](/en/skills#control-who-invokes-a-skill) (default: 15000). Legacy name kept for backwards compatibility. | |

816| `USE_BUILTIN_RIPGREP` | Set to `0` to use system-installed `rg` instead of `rg` included with Claude Code | |

817| `VERTEX_REGION_CLAUDE_3_5_HAIKU` | Override region for Claude 3.5 Haiku when using Vertex AI | |

818| `VERTEX_REGION_CLAUDE_3_7_SONNET` | Override region for Claude 3.7 Sonnet when using Vertex AI | |

819| `VERTEX_REGION_CLAUDE_4_0_OPUS` | Override region for Claude 4.0 Opus when using Vertex AI | |

820| `VERTEX_REGION_CLAUDE_4_0_SONNET` | Override region for Claude 4.0 Sonnet when using Vertex AI | |

821| `VERTEX_REGION_CLAUDE_4_1_OPUS` | Override region for Claude 4.1 Opus when using Vertex AI | |

822 819

823## Tools available to Claude820## Tools available to Claude

824 821

825Claude Code has access to a set of powerful tools that help it understand and modify your codebase:822Claude 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.

~~826~~

827| Tool | Description | Permission Required |

828| :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------ |

829| **AskUserQuestion** | Asks multiple-choice questions to gather requirements or clarify ambiguity | No |

830| **Bash** | Executes shell commands in your environment (see [Bash tool behavior](#bash-tool-behavior) below) | Yes |

831| **TaskOutput** | Retrieves output from a background task (bash shell or subagent) | No |

832| **Edit** | Makes targeted edits to specific files | Yes |

833| **ExitPlanMode** | Prompts the user to exit plan mode and start coding | Yes |

834| **Glob** | Finds files based on pattern matching | No |

835| **Grep** | Searches for patterns in file contents | No |

836| **KillShell** | Kills a running background bash shell by its ID | No |

837| **MCPSearch** | Searches for and loads MCP tools when [tool search](/en/mcp#scale-with-mcp-tool-search) is enabled | No |

838| **NotebookEdit** | Modifies Jupyter notebook cells | Yes |

839| **Read** | Reads the contents of files | No |

840| **Skill** | Executes a [skill](/en/skills#control-who-invokes-a-skill) within the main conversation | Yes |

841| **Task** | Runs a sub-agent to handle complex, multi-step tasks | No |

842| **TaskCreate** | Creates a new task in the task list | No |

843| **TaskGet** | Retrieves full details for a specific task | No |

844| **TaskList** | Lists all tasks with their current status | No |

845| **TaskUpdate** | Updates task status, dependencies, details, or deletes tasks | No |

846| **WebFetch** | Fetches content from a specified URL | Yes |

847| **WebSearch** | Performs web searches with domain filtering | Yes |

848| **Write** | Creates or overwrites files | Yes |

849| **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 |

~~850~~

851Permission rules can be configured using `/allowed-tools` or in [permission settings](/en/settings#available-settings). Also see [Tool-specific permission rules](/en/permissions#tool-specific-permission-rules).

~~852~~

853### Bash tool behavior

~~854~~

855The Bash tool executes shell commands with the following persistence behavior:

~~856~~

857* **Working directory persists**: When Claude changes the working directory (for example, `cd /path/to/dir`), subsequent Bash commands will execute in that directory. You can use `CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR=1` to reset to the project directory after each command.

858* **Environment variables do NOT persist**: Environment variables set in one Bash command (for example, `export MY_VAR=value`) are **not** available in subsequent Bash commands. Each Bash command runs in a fresh shell environment.

~~859~~

860To make environment variables available in Bash commands, you have **three options**:

~~861~~

862**Option 1: Activate environment before starting Claude Code** (simplest approach)

~~863~~

864Activate your virtual environment in your terminal before launching Claude Code:

~~865~~

866```bash theme={null}

867conda activate myenv

868# or: source /path/to/venv/bin/activate

869claude

870```

~~871~~

872This works for shell environments but environment variables set within Claude's Bash commands will not persist between commands.

~~873~~

874**Option 2: Set CLAUDE\_ENV\_FILE before starting Claude Code** (persistent environment setup)

~~875~~

876Export the path to a shell script containing your environment setup:

~~877~~

878```bash theme={null}

879export CLAUDE_ENV_FILE=/path/to/env-setup.sh

880claude

881```

~~882~~

883Where `/path/to/env-setup.sh` contains:

~~884~~

885```bash theme={null}

886conda activate myenv

887# or: source /path/to/venv/bin/activate

888# or: export MY_VAR=value

889```

~~890~~

891Claude Code will source this file before each Bash command, making the environment persistent across all commands.

~~892~~

893**Option 3: Use a SessionStart hook** (project-specific configuration)

~~894~~

895Configure in `.claude/settings.json`:

~~896~~

897```json theme={null}

898{

899 "hooks": {

900 "SessionStart": [{

901 "matcher": "startup",

902 "hooks": [{

903 "type": "command",

904 "command": "echo 'conda activate myenv' >> \"$CLAUDE_ENV_FILE\""

905 }]

906 }]

907 }

908}

909```

~~910~~

911The hook writes to `$CLAUDE_ENV_FILE`, which is then sourced before each Bash command. This is ideal for team-shared project configurations.

~~912~~

913See [SessionStart hooks](/en/hooks#persist-environment-variables) for more details on Option 3.

~~914~~

915### Extending tools with hooks

~~916~~

917You can run custom commands before or after any tool executes using

918[Claude Code hooks](/en/hooks-guide).

919 823

920For example, you could automatically run a Python formatter after Claude824See the [tools reference](/en/tools-reference) for the full list and Bash tool behavior details.

921modifies Python files, or prevent modifications to production configuration

922files by blocking Write operations to certain paths.

923 825

924## See also826## See also

925 827

setup.md +196 −153

Details

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt2> 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.3> Use this file to discover all available pages before exploring further.

4 4

~~5# Set up Claude Code~~5# Advanced setup

6 6

~~7> Install, authenticate, and start using Claude Code on your development machine.~~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).

8 10

9## System requirements11## System requirements

10 12

~~11* **Operating System**:~~13Claude Code runs on the following platforms and configurations:

15* **Operating system**:

12 * macOS 13.0+16 * macOS 13.0+

~~13 * Windows 10 1809+ or Windows Server 2019+ ([see setup notes](#platform-specific-setup))~~17 * Windows 10 1809+ or Windows Server 2019+

14 * Ubuntu 20.04+18 * Ubuntu 20.04+

15 * Debian 10+19 * Debian 10+

~~16 * Alpine Linux 3.19+ ([additional dependencies required](#platform-specific-setup))~~20 * Alpine Linux 3.19+

17* **Hardware**: 4 GB+ RAM21* **Hardware**: 4 GB+ RAM

~~18* **Network**: Internet connection required (see [network configuration](/en/network-config#network-access-requirements))~~22* **Network**: internet connection required. See [network configuration](/en/network-config#network-access-requirements).

~~19* **Shell**: Works best in Bash or Zsh~~23* **Shell**: Bash, Zsh, PowerShell, or CMD. On Windows, [Git for Windows](https://git-scm.com/downloads/win) is required.

20* **Location**: [Anthropic supported countries](https://www.anthropic.com/supported-countries)24* **Location**: [Anthropic supported countries](https://www.anthropic.com/supported-countries)

21 25

22### Additional dependencies26### Additional dependencies

23 27

~~24* **ripgrep**: Usually included with Claude Code. If search 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).

~~25* **[Node.js 18+](https://nodejs.org/en/download)**: Only required for [deprecated npm installation](#npm-installation-deprecated)~~29

30## Install Claude Code

26 31

~~27## Installation~~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).

35 New to the terminal? See the [terminal guide](/en/terminal-guide) for step-by-step instructions.

36</Tip>

28 37

29To install Claude Code, use one of the following methods:38To install Claude Code, use one of the following methods:

30 39

48 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

49 ```58 ```

50 59

60 **Windows requires [Git for Windows](https://git-scm.com/downloads/win).** Install it first if you don't have it.

51 <Info>62 <Info>

52 Native installations automatically update in the background to keep you on the latest version.63 Native installations automatically update in the background to keep you on the latest version.

53 </Info>64 </Info>

54 </Tab>65 </Tab>

55 66

56 <Tab title="Homebrew">67 <Tab title="Homebrew">

~~57 ```sh theme={null}~~68 ```bash theme={null}

58 brew install --cask claude-code69 brew install --cask claude-code

59 ```70 ```

60 71

74 </Tab>85 </Tab>

75</Tabs>86</Tabs>

76 87

~~77After the installation process completes, navigate to your project and start Claude Code:~~88After installation completes, open a terminal in the project you want to work in and start Claude Code:

78 89

79```bash theme={null}90```bash theme={null}

~~80cd your-awesome-project~~

81claude91claude

82```92```

83 93

~~84If you encounter any issues during installation, consult the [troubleshooting guide](/en/troubleshooting).~~94If you encounter any issues during installation, see the [troubleshooting guide](/en/troubleshooting).

85 95

~~86<Tip>~~96### Set up on Windows

~~87 Run `claude doctor` after installation to check your installation type and version.~~97

~~88</Tip>~~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.

89 99

~~90### Platform-specific setup~~100**Option 1: Native Windows with Git Bash**

91 101

92**Windows**: Run Claude Code natively (requires [Git Bash](https://git-scm.com/downloads/win)) or inside WSL. Both WSL 1 and WSL 2 are supported, but WSL 1 has limited support and does not support features like Bash tool sandboxing.102Install [Git for Windows](https://git-scm.com/downloads/win), then run the install command from PowerShell or CMD.

93 103

~~94**Alpine Linux and other musl/uClibc-based distributions**:~~104If Claude Code can't find your Git Bash installation, set the path in your [settings.json file](/en/settings):

105

106```json theme={null}

107{

108 "env": {

109 "CLAUDE_CODE_GIT_BASH_PATH": "C:\\Program Files\\Git\\bin\\bash.exe"

110 }

111}

112```

113

114**Option 2: WSL**

115

116Both WSL 1 and WSL 2 are supported. WSL 2 supports [sandboxing](/en/sandboxing) for enhanced security. WSL 1 does not support sandboxing.

117

118### Alpine Linux and musl-based distributions

95 119

96The 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`.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`.

97 121

~~98On Alpine:~~122This example installs the required packages on Alpine:

99 123

100```bash theme={null}124```bash theme={null}

101apk add libgcc libstdc++ ripgrep125apk add libgcc libstdc++ ripgrep

102```126```

103 127

104### Authentication128Then set `USE_BUILTIN_RIPGREP` to `0` in your [`settings.json`](/en/settings#available-settings) file:

129

130```json theme={null}

131{

132 "env": {

133 "USE_BUILTIN_RIPGREP": "0"

134 }

135}

136```

137

138## Verify your installation

139

140After installing, confirm Claude Code is working:

105 141

106#### For individuals142```bash theme={null}

143claude --version

144```

145

146For a more detailed check of your installation and configuration, run [`claude doctor`](/en/troubleshooting#get-more-help):

147

148```bash theme={null}

149claude doctor

150```

107 151

1081. **Claude Pro or Max plan** (recommended): Subscribe to Claude's [Pro or Max plan](https://claude.ai/pricing) for a unified subscription that includes both Claude Code and Claude on the web. Manage your account in one place and log in with your Claude.ai account.152## Authenticate

1092. **Claude Console**: Connect through the [Claude Console](https://console.anthropic.com) and complete the OAuth process. Requires active billing in the Anthropic Console. A "Claude Code" workspace is automatically created for usage tracking and cost management. You can't create API keys for the Claude Code workspace; it's dedicated exclusively for Claude Code usage.

110 153

111#### For teams and organizations154Claude 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).

112 155

1131. **Claude for Teams or Enterprise** (recommended): Subscribe to [Claude for Teams](https://claude.com/pricing#team-&-enterprise) or [Claude for Enterprise](https://anthropic.com/contact-sales) for centralized billing, team management, and access to both Claude Code and Claude on the web. Team members log in with their Claude.ai accounts.156After installing, log in by running `claude` and following the browser prompts. See [Authentication](/en/authentication) for all account types and team setup options.

1142. **Claude Console with team billing**: Set up a shared [Claude Console](https://console.anthropic.com) organization with team billing. Invite team members and assign roles for usage tracking.157

1153. **Cloud providers**: Configure Claude Code to use [Amazon Bedrock, Google Vertex AI, or Microsoft Foundry](/en/third-party-integrations) for deployments with your existing cloud infrastructure.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.

165

166<Note>

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.

172</Note>

173

174### Configure release channel

175

176Control which release channel Claude Code follows for auto-updates and `claude update` with the `autoUpdatesChannel` setting:

177

178* `"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

180

181Configure this via `/config` → **Auto-update channel**, or add it to your [settings.json file](/en/settings):

182

183```json theme={null}

184{

185 "autoUpdatesChannel": "stable"

186}

187```

188

189For enterprise deployments, you can enforce a consistent release channel across your organization using [managed settings](/en/permissions#managed-settings).

190

191### Disable auto-updates

192

193Set `DISABLE_AUTOUPDATER` to `"1"` in the `env` key of your [`settings.json`](/en/settings#available-settings) file:

194

195```json theme={null}

196{

197 "env": {

198 "DISABLE_AUTOUPDATER": "1"

199 }

200}

201```

202

203### Update manually

204

205To apply an update immediately without waiting for the next background check, run:

206

207```bash theme={null}

208claude update

209```

210

211## Advanced installation options

212

213These options are for version pinning, migrating from npm, and verifying binary integrity.

116 214

117### Install a specific version215### Install a specific version

118 216

119The 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.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.

120 218

121To install the latest version (default):219To install the latest version (default):

122 220

184 </Tab>282 </Tab>

185</Tabs>283</Tabs>

186 284

187### Binary integrity and code signing285### Deprecated npm installation

188 286

189* 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`)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.

190* Signed binaries are distributed for the following platforms:

191 * macOS: Signed by "Anthropic PBC" and notarized by Apple

192 * Windows: Signed by "Anthropic, PBC"

193 288

194## NPM installation (deprecated)289#### Migrate from npm to native

195 290

196NPM installation is deprecated. Use the [native installation](#installation) method when possible. To migrate an existing npm installation to native, run `claude install`.291If you previously installed Claude Code with npm, switch to the native installer:

197 292

198**Global npm installation**293```bash theme={null}

294# Install the native binary

295curl -fsSL https://claude.ai/install.sh | bash

199 296

200```sh theme={null}297# Remove the old npm installation

201npm install -g @anthropic-ai/claude-code298npm uninstall -g @anthropic-ai/claude-code

202```299```

203 300

204<Warning>301You can also run `claude install` from an existing npm installation to install the native binary alongside it, then remove the npm version.

205 Do NOT use `sudo npm install -g` as this can lead to permission issues and security risks.

206 If you encounter permission errors, see [troubleshooting permission errors](/en/troubleshooting#command-not-found-claude-or-permission-errors) for recommended solutions.

207</Warning>

~~208~~

209## Windows setup

210 302

211**Option 1: Claude Code within WSL**303#### Install with npm

212 304

213* Both WSL 1 and WSL 2 are supported305If you need npm installation for compatibility reasons, you must have [Node.js 18+](https://nodejs.org/en/download) installed. Install the package globally:

214* WSL 2 supports [sandboxing](/en/sandboxing) for enhanced security. WSL 1 does not support sandboxing.

215 306

216**Option 2: Claude Code on native Windows with Git Bash**307```bash theme={null}

~~217~~ 308npm install -g @anthropic-ai/claude-code

218* Requires [Git for Windows](https://git-scm.com/downloads/win)

219* For portable Git installations, specify the path to your `bash.exe`:

220 ```powershell theme={null}

221 $env:CLAUDE_CODE_GIT_BASH_PATH="C:\Program Files\Git\bin\bash.exe"

222 ```

~~223~~

224## Update Claude Code

~~225~~

226### Auto updates

~~227~~

228Claude Code automatically keeps itself up to date to ensure you have the latest features and security fixes.

~~229~~

230* **Update checks**: Performed on startup and periodically while running

231* **Update process**: Downloads and installs automatically in the background

232* **Notifications**: You'll see a notification when updates are installed

233* **Applying updates**: Updates take effect the next time you start Claude Code

~~234~~

235<Note>

236 Homebrew and WinGet installations do not auto-update. Use `brew upgrade claude-code` or `winget upgrade Anthropic.ClaudeCode` to update manually.

~~237~~

238 **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.

239</Note>

~~240~~

241### Configure release channel

~~242~~

243Configure which release channel Claude Code follows for both auto-updates and `claude update` with the `autoUpdatesChannel` setting:

~~244~~

245* `"latest"` (default): Receive new features as soon as they're released

246* `"stable"`: Use a version that is typically about one week old, skipping releases with major regressions

~~247~~

248Configure this via `/config` → **Auto-update channel**, or add it to your [settings.json file](/en/settings):

~~249~~

250```json theme={null}

251{

252 "autoUpdatesChannel": "stable"

253}

254```309```

255 310

256For enterprise deployments, you can enforce a consistent release channel across your organization using [managed settings](/en/permissions#managed-settings).311<Warning>

~~257~~ 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).

258### Disable auto-updates313</Warning>

~~259~~

260Set the `DISABLE_AUTOUPDATER` environment variable in your shell or [settings.json file](/en/settings):

261 314

262```bash theme={null}315### Binary integrity and code signing

263export DISABLE_AUTOUPDATER=1

264```

265 316

266### Update manually317You can verify the integrity of Claude Code binaries using SHA256 checksums and code signatures.

267 318

268```bash theme={null}319* 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`.

269claude update320* Signed binaries are distributed for the following platforms:

270```321 * **macOS**: signed by "Anthropic PBC" and notarized by Apple

322 * **Windows**: signed by "Anthropic, PBC"

271 323

272## Uninstall Claude Code324## Uninstall Claude Code

273 325

274If you need to uninstall Claude Code, follow the instructions for your installation method.326To remove Claude Code, follow the instructions for your installation method.

275 327

276### Native installation328### Native installation

277 329

278Remove the Claude Code binary and version files:330Remove the Claude Code binary and version files:

279 331

280**macOS, Linux, WSL:**332<Tabs>

~~281~~ 333 <Tab title="macOS, Linux, WSL">

282```bash theme={null}334 ```bash theme={null}

283rm -f ~/.local/bin/claude335 rm -f ~/.local/bin/claude

284rm -rf ~/.local/share/claude336 rm -rf ~/.local/share/claude

285```337 ```

~~286~~ 338 </Tab>

287**Windows PowerShell:**

~~288~~

289```powershell theme={null}

290Remove-Item -Path "$env:USERPROFILE\.local\bin\claude.exe" -Force

291Remove-Item -Path "$env:USERPROFILE\.local\share\claude" -Recurse -Force

292```

~~293~~

294**Windows CMD:**

295 339

296```batch theme={null}340 <Tab title="Windows PowerShell">

297del "%USERPROFILE%\.local\bin\claude.exe"341 ```powershell theme={null}

298rmdir /s /q "%USERPROFILE%\.local\share\claude"342 Remove-Item -Path "$env:USERPROFILE\.local\bin\claude.exe" -Force

299```343 Remove-Item -Path "$env:USERPROFILE\.local\share\claude" -Recurse -Force

344 ```

345 </Tab>

346</Tabs>

300 347

301### Homebrew installation348### Homebrew installation

302 349

350Remove the Homebrew cask:

351

303```bash theme={null}352```bash theme={null}

304brew uninstall --cask claude-code353brew uninstall --cask claude-code

305```354```

306 355

307### WinGet installation356### WinGet installation

308 357

358Remove the WinGet package:

359

309```powershell theme={null}360```powershell theme={null}

310winget uninstall Anthropic.ClaudeCode361winget uninstall Anthropic.ClaudeCode

311```362```

312 363

313### NPM installation364### npm

365

366Remove the global npm package:

314 367

315```bash theme={null}368```bash theme={null}

316npm uninstall -g @anthropic-ai/claude-code369npm uninstall -g @anthropic-ai/claude-code

317```370```

318 371

319### Clean up configuration files (optional)372### Remove configuration files

320 373

321<Warning>374<Warning>

322 Removing configuration files will delete all your settings, allowed tools, MCP server configurations, and session history.375 Removing configuration files will delete all your settings, allowed tools, MCP server configurations, and session history.

324 377

325To remove Claude Code settings and cached data:378To remove Claude Code settings and cached data:

326 379

327**macOS, Linux, WSL:**380<Tabs>

~~328~~ 381 <Tab title="macOS, Linux, WSL">

329```bash theme={null}382 ```bash theme={null}

330# Remove user settings and state383 # Remove user settings and state

331rm -rf ~/.claude384 rm -rf ~/.claude

332rm ~/.claude.json385 rm ~/.claude.json

~~333~~

334# Remove project-specific settings (run from your project directory)

335rm -rf .claude

336rm -f .mcp.json

337```

~~338~~

339**Windows PowerShell:**

~~340~~

341```powershell theme={null}

342# Remove user settings and state

343Remove-Item -Path "$env:USERPROFILE\.claude" -Recurse -Force

344Remove-Item -Path "$env:USERPROFILE\.claude.json" -Force

~~345~~

346# Remove project-specific settings (run from your project directory)

347Remove-Item -Path ".claude" -Recurse -Force

348Remove-Item -Path ".mcp.json" -Force

349```

350 386

351**Windows CMD:**387 # Remove project-specific settings (run from your project directory)

388 rm -rf .claude

389 rm -f .mcp.json

390 ```

391 </Tab>

352 392

353```batch theme={null}393 <Tab title="Windows PowerShell">

354REM Remove user settings and state394 ```powershell theme={null}

355rmdir /s /q "%USERPROFILE%\.claude"395 # Remove user settings and state

356del "%USERPROFILE%\.claude.json"396 Remove-Item -Path "$env:USERPROFILE\.claude" -Recurse -Force

397 Remove-Item -Path "$env:USERPROFILE\.claude.json" -Force

357 398

358REM Remove project-specific settings (run from your project directory)399 # Remove project-specific settings (run from your project directory)

359rmdir /s /q ".claude"400 Remove-Item -Path ".claude" -Recurse -Force

360del ".mcp.json"401 Remove-Item -Path ".mcp.json" -Force

361```402 ```

403 </Tab>

404</Tabs>

skills.md +40 −17

Details

4 4

5# Extend Claude with skills5# Extend Claude with skills

6 6

~~7> Create, manage, and share skills to extend Claude's capabilities in Claude Code. Includes custom slash commands.~~7> Create, manage, and share skills to extend Claude's capabilities in Claude Code. Includes custom commands and bundled skills.

8 8

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`.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`.

10 10

11<Note>11<Note>

~~12 For built-in commands like `/help` and `/compact`, see [interactive mode](/en/interactive-mode#built-in-commands).~~12 For built-in commands like `/help` and `/compact`, see the [built-in commands reference](/en/commands).

13 13

14 **Custom slash commands have been merged into skills.** A file at `.claude/commands/review.md` and a skill at `.claude/skills/review/SKILL.md` both create `/review` 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.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>15</Note>

16 16

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).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).

18 18

19## Bundled skills

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.

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.

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` |

19## Getting started33## Getting started

20 34

21### Create your first skill35### Create your first skill

58 72

59 **Let Claude invoke it automatically** by asking something that matches the description:73 **Let Claude invoke it automatically** by asking something that matches the description:

60 74

~~61 ```~~75 ```text theme={null}

62 How does this code work?76 How does this code work?

63 ```77 ```

64 78

65 **Or invoke it directly** with the skill name:79 **Or invoke it directly** with the skill name:

66 80

~~67 ```~~81 ```text theme={null}

68 /explain-code src/auth/login.ts82 /explain-code src/auth/login.ts

69 ```83 ```

70 84

77Where you store a skill determines who can use it:91Where you store a skill determines who can use it:

78 92

~~80| :--------- | :------------------------------------------------------- | :----------------------------- |~~94| :--------- | :-------------------------------------------------- | :----------------------------- |

91 105

92Each skill is a directory with `SKILL.md` as the entrypoint:106Each skill is a directory with `SKILL.md` as the entrypoint:

93 107

~~94```~~108```text theme={null}

95my-skill/109my-skill/

96├── SKILL.md # Main instructions (required)110├── SKILL.md # Main instructions (required)

97├── template.md # Template for Claude to fill in111├── template.md # Template for Claude to fill in

107 Files in `.claude/commands/` still work and support the same [frontmatter](#frontmatter-reference). Skills are recommended since they support additional features like supporting files.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.

108</Note>122</Note>

109 123

124#### Skills from additional directories

125

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.

127

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>

131

110## Configure skills132## Configure skills

111 133

112Skills are configured through YAML frontmatter at the top of `SKILL.md` and the markdown content that follows.134Skills are configured through YAML frontmatter at the top of `SKILL.md` and the markdown content that follows.

182Skills support string substitution for dynamic values in the skill content:204Skills support string substitution for dynamic values in the skill content:

183 205

184| Variable | Description |206| Variable | Description |

185| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- |207| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

186| `$ARGUMENTS` | All arguments passed when invoking the skill. If `$ARGUMENTS` is not present in the content, arguments are appended as `ARGUMENTS: <value>`. |208| `$ARGUMENTS` | All arguments passed when invoking the skill. If `$ARGUMENTS` is not present in the content, arguments are appended as `ARGUMENTS: <value>`. |

188| `$N` | Shorthand for `$ARGUMENTS[N]`, such as `$0` for the first argument or `$1` for the second. |210| `$N` | Shorthand for `$ARGUMENTS[N]`, such as `$0` for the first argument or `$1` for the second. |

189| `${CLAUDE_SESSION_ID}` | The current session ID. Useful for logging, creating session-specific files, or correlating skill output with sessions. |211| `${CLAUDE_SESSION_ID}` | The current session ID. Useful for logging, creating session-specific files, or correlating skill output with sessions. |

212| `${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. |

190 213

191**Example using substitutions:**214**Example using substitutions:**

192 215

205 228

206Skills 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.229Skills 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.

207 230

208```231```text theme={null}

209my-skill/232my-skill/

210├── SKILL.md (required - overview and navigation)233├── SKILL.md (required - overview and navigation)

211├── reference.md (detailed API docs - loaded when needed)234├── reference.md (detailed API docs - loaded when needed)

415 438

416**Disable all skills** by denying the Skill tool in `/permissions`:439**Disable all skills** by denying the Skill tool in `/permissions`:

417 440

418```441```text theme={null}

419# Add to deny rules:442# Add to deny rules:

420Skill443Skill

421```444```

422 445

423**Allow or deny specific skills** using [permission rules](/en/permissions):446**Allow or deny specific skills** using [permission rules](/en/permissions):

424 447

425```448```text theme={null}

426# Allow only specific skills449# Allow only specific skills

427Skill(commit)450Skill(commit)

428Skill(review-pr *)451Skill(review-pr *)

445 468

446* **Project skills**: Commit `.claude/skills/` to version control469* **Project skills**: Commit `.claude/skills/` to version control

447* **Plugins**: Create a `skills/` directory in your [plugin](/en/plugins)470* **Plugins**: Create a `skills/` directory in your [plugin](/en/plugins)

448* **Managed**: Deploy organization-wide through [managed settings](/en/permissions#managed-settings)471* **Managed**: Deploy organization-wide through [managed settings](/en/settings#settings-files)

449 472

450### Generate visual output473### Generate visual output

451 474

478 501

479```bash502```bash

480python ~/.claude/skills/codebase-visualizer/scripts/visualize.py .503python ~/.claude/skills/codebase-visualizer/scripts/visualize.py .

481```504```text

482 505

483This creates `codebase-map.html` in the current directory and opens it in your default browser.506This creates `codebase-map.html` in the current directory and opens it in your default browser.

484 507

656 679

657### Claude doesn't see all my skills680### Claude doesn't see all my skills

658 681

659Skill descriptions are loaded into context so Claude knows what's available. If you have many skills, they may exceed the character budget (default 15,000 characters). Run `/context` to check for a warning about excluded skills.682Skill 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.

660 683

661To increase the limit, set the `SLASH_COMMAND_TOOL_CHAR_BUDGET` environment variable.684To override the limit, set the `SLASH_COMMAND_TOOL_CHAR_BUDGET` environment variable.

662 685

663## Related resources686## Related resources

664 687

666* **[Plugins](/en/plugins)**: package and distribute skills with other extensions689* **[Plugins](/en/plugins)**: package and distribute skills with other extensions

667* **[Hooks](/en/hooks)**: automate workflows around tool events690* **[Hooks](/en/hooks)**: automate workflows around tool events

668* **[Memory](/en/memory)**: manage CLAUDE.md files for persistent context691* **[Memory](/en/memory)**: manage CLAUDE.md files for persistent context

669* **[Interactive mode](/en/interactive-mode#built-in-commands)**: built-in commands and shortcuts692* **[Built-in commands](/en/commands)**: reference for built-in `/` commands

670* **[Permissions](/en/permissions)**: control tool and skill access693* **[Permissions](/en/permissions)**: control tool and skill access

slack.md +1 −1

Details

23 23

24| Requirement | Details |24| Requirement | Details |

25| :--------------------- | :----------------------------------------------------------------------------- |25| :--------------------- | :----------------------------------------------------------------------------- |

~~26| Claude Plan | Pro, Max, Team, or Enterprise with Claude Code access (premium seats) |~~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 |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 |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 |29| Slack Authentication | Your Slack account linked to your Claude account via the Claude app |

statusline.md +812 −165

Details

2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt2> 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.3> Use this file to discover all available pages before exploring further.

4 4

~~5# Status line configuration~~5# Customize your status line

6 6

~~7> Create a custom status line for Claude Code to display contextual information~~7> Configure a custom status bar to monitor context window usage, costs, and git status in Claude Code

8 8

~~9Make 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.~~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.

10 10

~~11## Create a custom status line~~11Status lines are useful when you:

12 12

~~13You can either:~~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

14 17

15* 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`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.

16 19

~~17* Directly add a `statusLine` command to your `.claude/settings.json`:~~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).

18 41

19```json theme={null}42```json theme={null}

20{43{

21 "statusLine": {44 "statusLine": {

22 "type": "command",45 "type": "command",

23 "command": "~/.claude/statusline.sh",46 "command": "~/.claude/statusline.sh",

~~24 "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\"'"

25 }59 }

26}60}

27```61```

28 62

~~29## 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.

30 64

~~31* The status line is updated when the conversation messages update~~65### Disable the status line

~~32* Updates run at most every 300 ms~~

~~33* The first line of stdout from your command becomes the status line text~~

~~34* ANSI color codes are supported for styling your status line~~

~~35* Claude Code passes contextual information about the current session (model, directories, etc.) as JSON to your script via stdin~~

36 66

~~37## 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.

38 68

~~39Your status line command receives structured data via stdin in JSON format:~~69## Build a status line step by step

40 70

~~41```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.

~~42{~~72

~~43 "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>

~~44 "session_id": "abc123...",~~74

~~45 "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| `session_id` | Unique session identifier |

163| `transcript_path` | Path to conversation transcript file |

164| `version` | Claude Code version |

165| `output_style.name` | Name of the current output style |

166| `vim.mode` | Current vim mode (`NORMAL` or `INSERT`) when [vim mode](/en/interactive-mode#vim-editor-mode) is enabled |

167| `agent.name` | Agent name when running with the `--agent` flag or agent settings configured |

168| `worktree.name` | Name of the active worktree. Present only during `--worktree` sessions |

169| `worktree.path` | Absolute path to the worktree directory |

170| `worktree.branch` | Git branch name for the worktree (for example, `"worktree-my-feature"`). Absent for hook-based worktrees |

171| `worktree.original_cwd` | The directory Claude was in before entering the worktree |

172| `worktree.original_branch` | Git branch checked out before entering the worktree. Absent for hook-based worktrees |

173

174<Accordion title="Full JSON schema">

175 Your status line command receives this JSON structure via stdin:

176

177 ```json theme={null}

178 {

46 "cwd": "/current/working/directory",179 "cwd": "/current/working/directory",

180 "session_id": "abc123...",

181 "transcript_path": "/path/to/transcript.jsonl",

47 "model": {182 "model": {

~~48 "id": "claude-opus-4-1",~~183 "id": "claude-opus-4-6",

49 "display_name": "Opus"184 "display_name": "Opus"

50 },185 },

51 "workspace": {186 "workspace": {

67 "total_input_tokens": 15234,202 "total_input_tokens": 15234,

68 "total_output_tokens": 4521,203 "total_output_tokens": 4521,

69 "context_window_size": 200000,204 "context_window_size": 200000,

~~70 "used_percentage": 42.5,~~205 "used_percentage": 8,

~~71 "remaining_percentage": 57.5,~~206 "remaining_percentage": 92,

72 "current_usage": {207 "current_usage": {

73 "input_tokens": 8500,208 "input_tokens": 8500,

74 "output_tokens": 1200,209 "output_tokens": 1200,

75 "cache_creation_input_tokens": 5000,210 "cache_creation_input_tokens": 5000,

76 "cache_read_input_tokens": 2000211 "cache_read_input_tokens": 2000

77 }212 }

213 },

214 "exceeds_200k_tokens": false,

215 "vim": {

216 "mode": "NORMAL"

217 },

218 "agent": {

219 "name": "security-reviewer"

220 },

221 "worktree": {

222 "name": "my-feature",

223 "path": "/path/to/.claude/worktrees/my-feature",

224 "branch": "worktree-my-feature",

225 "original_cwd": "/path/to/project",

226 "original_branch": "main"

78 }227 }

~~79}~~228 }

~~80```~~229 ```

81 230

~~82## Example Scripts~~231 **Fields that may be absent** (not present in JSON):

83 232

~~84### Simple Status Line~~233 * `vim`: appears only when vim mode is enabled

234 * `agent`: appears only when running with the `--agent` flag or agent settings configured

235 * `worktree`: appears only during `--worktree` sessions. When present, `branch` and `original_branch` may also be absent for hook-based worktrees

85 236

~~86```bash theme={null}~~237 **Fields that may be `null`**:

~~87#!/bin/bash~~

~~88# Read JSON input from stdin~~

~~89input=$(cat)~~

90 238

~~91# Extract values using jq~~239 * `context_window.current_usage`: `null` before the first API call in a session

~~92MODEL_DISPLAY=$(echo "$input" | jq -r '.model.display_name')~~240 * `context_window.used_percentage`, `context_window.remaining_percentage`: may be `null` early in the session

~~93CURRENT_DIR=$(echo "$input" | jq -r '.workspace.current_dir')~~

94 241

~~95echo "[$MODEL_DISPLAY] 📁 ${CURRENT_DIR##*/}"~~242 Handle missing fields with conditional access and null values with fallback defaults in your scripts.

~~96```~~243</Accordion>

244

245### Context window fields

246

247The `context_window` object provides two ways to track context usage:

248

249* **Cumulative totals** (`total_input_tokens`, `total_output_tokens`): sum of all tokens across the entire session, useful for tracking total consumption

250* **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

251

252The `current_usage` object contains:

253

254* `input_tokens`: input tokens in current context

255* `output_tokens`: output tokens generated

256* `cache_creation_input_tokens`: tokens written to cache

257* `cache_read_input_tokens`: tokens read from cache

258

259The `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`.

97 260

~~98### Git-Aware Status Line~~261If you calculate context percentage manually from `current_usage`, use the same input-only formula to match `used_percentage`.

99 262

100```bash theme={null}263The `current_usage` object is `null` before the first API call in a session.

101#!/bin/bash

102# Read JSON input from stdin

103input=$(cat)

104 264

105# Extract values using jq265## Examples

106MODEL_DISPLAY=$(echo "$input" | jq -r '.model.display_name')

107CURRENT_DIR=$(echo "$input" | jq -r '.workspace.current_dir')

108 266

109# Show git branch if in a git repo267These examples show common status line patterns. To use any example:

110GIT_BRANCH=""268

111if git rev-parse --git-dir > /dev/null 2>&1; then2691. Save the script to a file like `~/.claude/statusline.sh` (or `.py`/`.js`)

2702. Make it executable: `chmod +x ~/.claude/statusline.sh`

2713. Add the path to your [settings](#manually-configure-a-status-line)

272

273The Bash examples use [`jq`](https://jqlang.github.io/jq/) to parse JSON. Python and Node.js have built-in JSON parsing.

274

275### Context window usage

276

277Display 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:

278

279<Frame>

280 <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" />

281</Frame>

282

283<CodeGroup>

284 ```bash Bash theme={null}

285 #!/bin/bash

286 # Read all of stdin into a variable

287 input=$(cat)

288

289 # Extract fields with jq, "// 0" provides fallback for null

290 MODEL=$(echo "$input" | jq -r '.model.display_name')

291 PCT=$(echo "$input" | jq -r '.context_window.used_percentage // 0' | cut -d. -f1)

292

293 # Build progress bar: printf creates spaces, tr replaces with blocks

294 BAR_WIDTH=10

295 FILLED=$((PCT * BAR_WIDTH / 100))

296 EMPTY=$((BAR_WIDTH - FILLED))

297 BAR=""

298 [ "$FILLED" -gt 0 ] && BAR=$(printf "%${FILLED}s" | tr ' ' '▓')

299 [ "$EMPTY" -gt 0 ] && BAR="${BAR}$(printf "%${EMPTY}s" | tr ' ' '░')"

300

301 echo "[$MODEL] $BAR $PCT%"

302 ```

303

304 ```python Python theme={null}

305 #!/usr/bin/env python3

306 import json, sys

307

308 # json.load reads and parses stdin in one step

309 data = json.load(sys.stdin)

310 model = data['model']['display_name']

311 # "or 0" handles null values

312 pct = int(data.get('context_window', {}).get('used_percentage', 0) or 0)

313

314 # String multiplication builds the bar

315 filled = pct * 10 // 100

316 bar = '▓' * filled + '░' * (10 - filled)

317

318 print(f"[{model}] {bar} {pct}%")

319 ```

320

321 ```javascript Node.js theme={null}

322 #!/usr/bin/env node

323 // Node.js reads stdin asynchronously with events

324 let input = '';

325 process.stdin.on('data', chunk => input += chunk);

326 process.stdin.on('end', () => {

327 const data = JSON.parse(input);

328 const model = data.model.display_name;

329 // Optional chaining (?.) safely handles null fields

330 const pct = Math.floor(data.context_window?.used_percentage || 0);

331

332 // String.repeat() builds the bar

333 const filled = Math.floor(pct * 10 / 100);

334 const bar = '▓'.repeat(filled) + '░'.repeat(10 - filled);

335

336 console.log(`[${model}] ${bar} ${pct}%`);

337 });

338 ```

339</CodeGroup>

340

341### Git status with colors

342

343Show 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.

344

345<Frame>

346 <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" />

347</Frame>

348

349Each script checks if the current directory is a git repository, counts staged and modified files, and displays color-coded indicators:

350

351<CodeGroup>

352 ```bash Bash theme={null}

353 #!/bin/bash

354 input=$(cat)

355

356 MODEL=$(echo "$input" | jq -r '.model.display_name')

357 DIR=$(echo "$input" | jq -r '.workspace.current_dir')

358

359 GREEN='\033[32m'

360 YELLOW='\033[33m'

361 RESET='\033[0m'

362

363 if git rev-parse --git-dir > /dev/null 2>&1; then

112 BRANCH=$(git branch --show-current 2>/dev/null)364 BRANCH=$(git branch --show-current 2>/dev/null)

113 if [ -n "$BRANCH" ]; then365 STAGED=$(git diff --cached --numstat 2>/dev/null | wc -l | tr -d ' ')

114 GIT_BRANCH=" | 🌿 $BRANCH"366 MODIFIED=$(git diff --numstat 2>/dev/null | wc -l | tr -d ' ')

115 fi

116fi

117 367

118echo "[$MODEL_DISPLAY] 📁 ${CURRENT_DIR##*/}$GIT_BRANCH"368 GIT_STATUS=""

119```369 [ "$STAGED" -gt 0 ] && GIT_STATUS="${GREEN}+${STAGED}${RESET}"

370 [ "$MODIFIED" -gt 0 ] && GIT_STATUS="${GIT_STATUS}${YELLOW}~${MODIFIED}${RESET}"

120 371

121### Python Example372 echo -e "[$MODEL] 📁 ${DIR##*/} | 🌿 $BRANCH $GIT_STATUS"

373 else

374 echo "[$MODEL] 📁 ${DIR##*/}"

375 fi

376 ```

122 377

123```python theme={null}378 ```python Python theme={null}

124#!/usr/bin/env python3379 #!/usr/bin/env python3

125import json380 import json, sys, subprocess, os

126import sys

127import os

128 381

129# Read JSON from stdin382 data = json.load(sys.stdin)

130data = json.load(sys.stdin)383 model = data['model']['display_name']

384 directory = os.path.basename(data['workspace']['current_dir'])

131 385

132# Extract values386 GREEN, YELLOW, RESET = '\033[32m', '\033[33m', '\033[0m'

133model = data['model']['display_name']

134current_dir = os.path.basename(data['workspace']['current_dir'])

135 387

136# Check for git branch

137git_branch = ""

138if os.path.exists('.git'):

139 try:388 try:

140 with open('.git/HEAD', 'r') as f:389 subprocess.check_output(['git', 'rev-parse', '--git-dir'], stderr=subprocess.DEVNULL)

141 ref = f.read().strip()390 branch = subprocess.check_output(['git', 'branch', '--show-current'], text=True).strip()

142 if ref.startswith('ref: refs/heads/'):391 staged_output = subprocess.check_output(['git', 'diff', '--cached', '--numstat'], text=True).strip()

143 git_branch = f" | 🌿 {ref.replace('ref: refs/heads/', '')}"392 modified_output = subprocess.check_output(['git', 'diff', '--numstat'], text=True).strip()

393 staged = len(staged_output.split('\n')) if staged_output else 0

394 modified = len(modified_output.split('\n')) if modified_output else 0

395

396 git_status = f"{GREEN}+{staged}{RESET}" if staged else ""

397 git_status += f"{YELLOW}~{modified}{RESET}" if modified else ""

398

399 print(f"[{model}] 📁 {directory} | 🌿 {branch} {git_status}")

144 except:400 except:

145 pass401 print(f"[{model}] 📁 {directory}")

402 ```

146 403

147print(f"[{model}] 📁 {current_dir}{git_branch}")404 ```javascript Node.js theme={null}

148```405 #!/usr/bin/env node

406 const { execSync } = require('child_process');

407 const path = require('path');

408

409 let input = '';

410 process.stdin.on('data', chunk => input += chunk);

411 process.stdin.on('end', () => {

412 const data = JSON.parse(input);

413 const model = data.model.display_name;

414 const dir = path.basename(data.workspace.current_dir);

415

416 const GREEN = '\x1b[32m', YELLOW = '\x1b[33m', RESET = '\x1b[0m';

417

418 try {

419 execSync('git rev-parse --git-dir', { stdio: 'ignore' });

420 const branch = execSync('git branch --show-current', { encoding: 'utf8' }).trim();

421 const staged = execSync('git diff --cached --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

422 const modified = execSync('git diff --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

423

424 let gitStatus = staged ? `${GREEN}+${staged}${RESET}` : '';

425 gitStatus += modified ? `${YELLOW}~${modified}${RESET}` : '';

426

427 console.log(`[${model}] 📁 ${dir} | 🌿 ${branch} ${gitStatus}`);

428 } catch {

429 console.log(`[${model}] 📁 ${dir}`);

430 }

431 });

432 ```

433</CodeGroup>

434

435### Cost and duration tracking

436

437Track 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.

438

439Each script formats cost as currency and converts milliseconds to minutes and seconds:

440

441<Frame>

442 <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" />

443</Frame>

444

445<CodeGroup>

446 ```bash Bash theme={null}

447 #!/bin/bash

448 input=$(cat)

449

450 MODEL=$(echo "$input" | jq -r '.model.display_name')

451 COST=$(echo "$input" | jq -r '.cost.total_cost_usd // 0')

452 DURATION_MS=$(echo "$input" | jq -r '.cost.total_duration_ms // 0')

453

454 COST_FMT=$(printf '$%.2f' "$COST")

455 DURATION_SEC=$((DURATION_MS / 1000))

456 MINS=$((DURATION_SEC / 60))

457 SECS=$((DURATION_SEC % 60))

458

459 echo "[$MODEL] 💰 $COST_FMT | ⏱️ ${MINS}m ${SECS}s"

460 ```

461

462 ```python Python theme={null}

463 #!/usr/bin/env python3

464 import json, sys

149 465

150### Node.js Example466 data = json.load(sys.stdin)

467 model = data['model']['display_name']

468 cost = data.get('cost', {}).get('total_cost_usd', 0) or 0

469 duration_ms = data.get('cost', {}).get('total_duration_ms', 0) or 0

151 470

152```javascript theme={null}471 duration_sec = duration_ms // 1000

153#!/usr/bin/env node472 mins, secs = duration_sec // 60, duration_sec % 60

154 473

155const fs = require('fs');474 print(f"[{model}] 💰 ${cost:.2f} | ⏱️ {mins}m {secs}s")

156const path = require('path');475 ```

157 476

158// Read JSON from stdin477 ```javascript Node.js theme={null}

159let input = '';478 #!/usr/bin/env node

160process.stdin.on('data', chunk => input += chunk);479 let input = '';

161process.stdin.on('end', () => {480 process.stdin.on('data', chunk => input += chunk);

481 process.stdin.on('end', () => {

162 const data = JSON.parse(input);482 const data = JSON.parse(input);

483 const model = data.model.display_name;

484 const cost = data.cost?.total_cost_usd || 0;

485 const durationMs = data.cost?.total_duration_ms || 0;

486

487 const durationSec = Math.floor(durationMs / 1000);

488 const mins = Math.floor(durationSec / 60);

489 const secs = durationSec % 60;

490

491 console.log(`[${model}] 💰 $${cost.toFixed(2)} | ⏱️ ${mins}m ${secs}s`);

492 });

493 ```

494</CodeGroup>

495

496### Display multiple lines

497

498Your script can output multiple lines to create a richer display. Each `echo` statement produces a separate row in the status area.

499

500<Frame>

501 <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" />

502</Frame>

503

504This 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:

505

506<CodeGroup>

507 ```bash Bash theme={null}

508 #!/bin/bash

509 input=$(cat)

510

511 MODEL=$(echo "$input" | jq -r '.model.display_name')

512 DIR=$(echo "$input" | jq -r '.workspace.current_dir')

513 COST=$(echo "$input" | jq -r '.cost.total_cost_usd // 0')

514 PCT=$(echo "$input" | jq -r '.context_window.used_percentage // 0' | cut -d. -f1)

515 DURATION_MS=$(echo "$input" | jq -r '.cost.total_duration_ms // 0')

516

517 CYAN='\033[36m'; GREEN='\033[32m'; YELLOW='\033[33m'; RED='\033[31m'; RESET='\033[0m'

518

519 # Pick bar color based on context usage

520 if [ "$PCT" -ge 90 ]; then BAR_COLOR="$RED"

521 elif [ "$PCT" -ge 70 ]; then BAR_COLOR="$YELLOW"

522 else BAR_COLOR="$GREEN"; fi

523

524 FILLED=$((PCT / 10)); EMPTY=$((10 - FILLED))

525 BAR=$(printf "%${FILLED}s" | tr ' ' '█')$(printf "%${EMPTY}s" | tr ' ' '░')

526

527 MINS=$((DURATION_MS / 60000)); SECS=$(((DURATION_MS % 60000) / 1000))

163 528

164 // Extract values529 BRANCH=""

530 git rev-parse --git-dir > /dev/null 2>&1 && BRANCH=" | 🌿 $(git branch --show-current 2>/dev/null)"

531

532 echo -e "${CYAN}[$MODEL]${RESET} 📁 ${DIR##*/}$BRANCH"

533 COST_FMT=$(printf '$%.2f' "$COST")

534 echo -e "${BAR_COLOR}${BAR}${RESET} ${PCT}% | ${YELLOW}${COST_FMT}${RESET} | ⏱️ ${MINS}m ${SECS}s"

535 ```

536

537 ```python Python theme={null}

538 #!/usr/bin/env python3

539 import json, sys, subprocess, os

540

541 data = json.load(sys.stdin)

542 model = data['model']['display_name']

543 directory = os.path.basename(data['workspace']['current_dir'])

544 cost = data.get('cost', {}).get('total_cost_usd', 0) or 0

545 pct = int(data.get('context_window', {}).get('used_percentage', 0) or 0)

546 duration_ms = data.get('cost', {}).get('total_duration_ms', 0) or 0

547

548 CYAN, GREEN, YELLOW, RED, RESET = '\033[36m', '\033[32m', '\033[33m', '\033[31m', '\033[0m'

549

550 bar_color = RED if pct >= 90 else YELLOW if pct >= 70 else GREEN

551 filled = pct // 10

552 bar = '█' * filled + '░' * (10 - filled)

553

554 mins, secs = duration_ms // 60000, (duration_ms % 60000) // 1000

555

556 try:

557 branch = subprocess.check_output(['git', 'branch', '--show-current'], text=True, stderr=subprocess.DEVNULL).strip()

558 branch = f" | 🌿 {branch}" if branch else ""

559 except:

560 branch = ""

561

562 print(f"{CYAN}[{model}]{RESET} 📁 {directory}{branch}")

563 print(f"{bar_color}{bar}{RESET} {pct}% | {YELLOW}${cost:.2f}{RESET} | ⏱️ {mins}m {secs}s")

564 ```

565

566 ```javascript Node.js theme={null}

567 #!/usr/bin/env node

568 const { execSync } = require('child_process');

569 const path = require('path');

570

571 let input = '';

572 process.stdin.on('data', chunk => input += chunk);

573 process.stdin.on('end', () => {

574 const data = JSON.parse(input);

165 const model = data.model.display_name;575 const model = data.model.display_name;

166 const currentDir = path.basename(data.workspace.current_dir);576 const dir = path.basename(data.workspace.current_dir);

577 const cost = data.cost?.total_cost_usd || 0;

578 const pct = Math.floor(data.context_window?.used_percentage || 0);

579 const durationMs = data.cost?.total_duration_ms || 0;

167 580

168 // Check for git branch581 const CYAN = '\x1b[36m', GREEN = '\x1b[32m', YELLOW = '\x1b[33m', RED = '\x1b[31m', RESET = '\x1b[0m';

169 let gitBranch = '';582

583 const barColor = pct >= 90 ? RED : pct >= 70 ? YELLOW : GREEN;

584 const filled = Math.floor(pct / 10);

585 const bar = '█'.repeat(filled) + '░'.repeat(10 - filled);

586

587 const mins = Math.floor(durationMs / 60000);

588 const secs = Math.floor((durationMs % 60000) / 1000);

589

590 let branch = '';

170 try {591 try {

171 const headContent = fs.readFileSync('.git/HEAD', 'utf8').trim();592 branch = execSync('git branch --show-current', { encoding: 'utf8', stdio: ['pipe', 'pipe', 'ignore'] }).trim();

172 if (headContent.startsWith('ref: refs/heads/')) {593 branch = branch ? ` | 🌿 ${branch}` : '';

173 gitBranch = ` | 🌿 ${headContent.replace('ref: refs/heads/', '')}`;594 } catch {}

595

596 console.log(`${CYAN}[${model}]${RESET} 📁 ${dir}${branch}`);

597 console.log(`${barColor}${bar}${RESET} ${pct}% | ${YELLOW}$${cost.toFixed(2)}${RESET} | ⏱️ ${mins}m ${secs}s`);

598 });

599 ```

600</CodeGroup>

601

602### Clickable links

603

604This 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.

605

606<Frame>

607 <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" />

608</Frame>

609

610Each 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:

611

612<CodeGroup>

613 ```bash Bash theme={null}

614 #!/bin/bash

615 input=$(cat)

616

617 MODEL=$(echo "$input" | jq -r '.model.display_name')

618

619 # Convert git SSH URL to HTTPS

620 REMOTE=$(git remote get-url origin 2>/dev/null | sed 's/git@github.com:/https:\/\/github.com\//' | sed 's/\.git$//')

621

622 if [ -n "$REMOTE" ]; then

623 REPO_NAME=$(basename "$REMOTE")

624 # OSC 8 format: \e]8;;URL\a then TEXT then \e]8;;\a

625 # printf %b interprets escape sequences reliably across shells

626 printf '%b' "[$MODEL] 🔗 \e]8;;${REMOTE}\a${REPO_NAME}\e]8;;\a\n"

627 else

628 echo "[$MODEL]"

629 fi

630 ```

631

632 ```python Python theme={null}

633 #!/usr/bin/env python3

634 import json, sys, subprocess, re, os

635

636 data = json.load(sys.stdin)

637 model = data['model']['display_name']

638

639 # Get git remote URL

640 try:

641 remote = subprocess.check_output(

642 ['git', 'remote', 'get-url', 'origin'],

643 stderr=subprocess.DEVNULL, text=True

644 ).strip()

645 # Convert SSH to HTTPS format

646 remote = re.sub(r'^git@github\.com:', 'https://github.com/', remote)

647 remote = re.sub(r'\.git$', '', remote)

648 repo_name = os.path.basename(remote)

649 # OSC 8 escape sequences

650 link = f"\033]8;;{remote}\a{repo_name}\033]8;;\a"

651 print(f"[{model}] 🔗 {link}")

652 except:

653 print(f"[{model}]")

654 ```

655

656 ```javascript Node.js theme={null}

657 #!/usr/bin/env node

658 const { execSync } = require('child_process');

659 const path = require('path');

660

661 let input = '';

662 process.stdin.on('data', chunk => input += chunk);

663 process.stdin.on('end', () => {

664 const data = JSON.parse(input);

665 const model = data.model.display_name;

666

667 try {

668 let remote = execSync('git remote get-url origin', { encoding: 'utf8', stdio: ['pipe', 'pipe', 'ignore'] }).trim();

669 // Convert SSH to HTTPS format

670 remote = remote.replace(/^git@github\.com:/, 'https://github.com/').replace(/\.git$/, '');

671 const repoName = path.basename(remote);

672 // OSC 8 escape sequences

673 const link = `\x1b]8;;${remote}\x07${repoName}\x1b]8;;\x07`;

674 console.log(`[${model}] 🔗 ${link}`);

675 } catch {

676 console.log(`[${model}]`);

174 }677 }

175 } catch (e) {678 });

176 // Not a git repo or can't read HEAD679 ```

680</CodeGroup>

681

682### Cache expensive operations

683

684Your 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.

685

686Use 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.

687

688Each script checks if the cache file is missing or older than 5 seconds before running git commands:

689

690<CodeGroup>

691 ```bash Bash theme={null}

692 #!/bin/bash

693 input=$(cat)

694

695 MODEL=$(echo "$input" | jq -r '.model.display_name')

696 DIR=$(echo "$input" | jq -r '.workspace.current_dir')

697

698 CACHE_FILE="/tmp/statusline-git-cache"

699 CACHE_MAX_AGE=5 # seconds

700

701 cache_is_stale() {

702 [ ! -f "$CACHE_FILE" ] || \

703 # stat -f %m is macOS, stat -c %Y is Linux

704 [ $(($(date +%s) - $(stat -f %m "$CACHE_FILE" 2>/dev/null || stat -c %Y "$CACHE_FILE" 2>/dev/null || echo 0))) -gt $CACHE_MAX_AGE ]

177 }705 }

178 706

179 console.log(`[${model}] 📁 ${currentDir}${gitBranch}`);707 if cache_is_stale; then

180});708 if git rev-parse --git-dir > /dev/null 2>&1; then

181```709 BRANCH=$(git branch --show-current 2>/dev/null)

710 STAGED=$(git diff --cached --numstat 2>/dev/null | wc -l | tr -d ' ')

711 MODIFIED=$(git diff --numstat 2>/dev/null | wc -l | tr -d ' ')

712 echo "$BRANCH|$STAGED|$MODIFIED" > "$CACHE_FILE"

713 else

714 echo "||" > "$CACHE_FILE"

715 fi

716 fi

182 717

183### Helper Function Approach718 IFS='|' read -r BRANCH STAGED MODIFIED < "$CACHE_FILE"

~~184~~ 719

185For more complex bash scripts, you can create helper functions:720 if [ -n "$BRANCH" ]; then

~~186~~ 721 echo "[$MODEL] 📁 ${DIR##*/} | 🌿 $BRANCH +$STAGED ~$MODIFIED"

187```bash theme={null}722 else

188#!/bin/bash723 echo "[$MODEL] 📁 ${DIR##*/}"

189# Read JSON input once724 fi

190input=$(cat)725 ```

~~191~~

192# Helper functions for common extractions

193get_model_name() { echo "$input" | jq -r '.model.display_name'; }

194get_current_dir() { echo "$input" | jq -r '.workspace.current_dir'; }

195get_project_dir() { echo "$input" | jq -r '.workspace.project_dir'; }

196get_version() { echo "$input" | jq -r '.version'; }

197get_cost() { echo "$input" | jq -r '.cost.total_cost_usd'; }

198get_duration() { echo "$input" | jq -r '.cost.total_duration_ms'; }

199get_lines_added() { echo "$input" | jq -r '.cost.total_lines_added'; }

200get_lines_removed() { echo "$input" | jq -r '.cost.total_lines_removed'; }

201get_input_tokens() { echo "$input" | jq -r '.context_window.total_input_tokens'; }

202get_output_tokens() { echo "$input" | jq -r '.context_window.total_output_tokens'; }

203get_context_window_size() { echo "$input" | jq -r '.context_window.context_window_size'; }

~~204~~

205# Use the helpers

206MODEL=$(get_model_name)

207DIR=$(get_current_dir)

208echo "[$MODEL] 📁 ${DIR##*/}"

209```

210 726

211### Context Window Usage727 ```python Python theme={null}

728 #!/usr/bin/env python3

729 import json, sys, subprocess, os, time

212 730

213Display the percentage of context window consumed. The `context_window` object contains:731 data = json.load(sys.stdin)

732 model = data['model']['display_name']

733 directory = os.path.basename(data['workspace']['current_dir'])

214 734

215* `total_input_tokens` / `total_output_tokens`: Cumulative totals across the entire session735 CACHE_FILE = "/tmp/statusline-git-cache"

216* `used_percentage`: Pre-calculated percentage of context window used (0-100)736 CACHE_MAX_AGE = 5 # seconds

217* `remaining_percentage`: Pre-calculated percentage of context window remaining (0-100)

218* `current_usage`: Current context window usage from the last API call (may be `null` if no messages yet)

219 * `input_tokens`: Input tokens in current context

220 * `output_tokens`: Output tokens generated

221 * `cache_creation_input_tokens`: Tokens written to cache

222 * `cache_read_input_tokens`: Tokens read from cache

223 737

224You can use the pre-calculated `used_percentage` and `remaining_percentage` fields directly, or calculate from `current_usage` for more control.738 def cache_is_stale():

739 if not os.path.exists(CACHE_FILE):

740 return True

741 return time.time() - os.path.getmtime(CACHE_FILE) > CACHE_MAX_AGE

225 742

226**Simple approach using pre-calculated percentages:**743 if cache_is_stale():

744 try:

745 subprocess.check_output(['git', 'rev-parse', '--git-dir'], stderr=subprocess.DEVNULL)

746 branch = subprocess.check_output(['git', 'branch', '--show-current'], text=True).strip()

747 staged = subprocess.check_output(['git', 'diff', '--cached', '--numstat'], text=True).strip()

748 modified = subprocess.check_output(['git', 'diff', '--numstat'], text=True).strip()

749 staged_count = len(staged.split('\n')) if staged else 0

750 modified_count = len(modified.split('\n')) if modified else 0

751 with open(CACHE_FILE, 'w') as f:

752 f.write(f"{branch}|{staged_count}|{modified_count}")

753 except:

754 with open(CACHE_FILE, 'w') as f:

755 f.write("||")

756

757 with open(CACHE_FILE) as f:

758 branch, staged, modified = f.read().strip().split('|')

759

760 if branch:

761 print(f"[{model}] 📁 {directory} | 🌿 {branch} +{staged} ~{modified}")

762 else:

763 print(f"[{model}] 📁 {directory}")

764 ```

765

766 ```javascript Node.js theme={null}

767 #!/usr/bin/env node

768 const { execSync } = require('child_process');

769 const fs = require('fs');

770 const path = require('path');

771

772 let input = '';

773 process.stdin.on('data', chunk => input += chunk);

774 process.stdin.on('end', () => {

775 const data = JSON.parse(input);

776 const model = data.model.display_name;

777 const dir = path.basename(data.workspace.current_dir);

227 778

228```bash theme={null}779 const CACHE_FILE = '/tmp/statusline-git-cache';

229#!/bin/bash780 const CACHE_MAX_AGE = 5; // seconds

230input=$(cat)

231 781

232MODEL=$(echo "$input" | jq -r '.model.display_name')782 const cacheIsStale = () => {

233PERCENT_USED=$(echo "$input" | jq -r '.context_window.used_percentage // 0')783 if (!fs.existsSync(CACHE_FILE)) return true;

784 return (Date.now() / 1000) - fs.statSync(CACHE_FILE).mtimeMs / 1000 > CACHE_MAX_AGE;

785 };

234 786

235echo "[$MODEL] Context: ${PERCENT_USED}%"787 if (cacheIsStale()) {

236```788 try {

789 execSync('git rev-parse --git-dir', { stdio: 'ignore' });

790 const branch = execSync('git branch --show-current', { encoding: 'utf8' }).trim();

791 const staged = execSync('git diff --cached --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

792 const modified = execSync('git diff --numstat', { encoding: 'utf8' }).trim().split('\n').filter(Boolean).length;

793 fs.writeFileSync(CACHE_FILE, `${branch}|${staged}|${modified}`);

794 } catch {

795 fs.writeFileSync(CACHE_FILE, '||');

796 }

797 }

237 798

238**Advanced approach with manual calculation:**799 const [branch, staged, modified] = fs.readFileSync(CACHE_FILE, 'utf8').trim().split('|');

239 800

240```bash theme={null}801 if (branch) {

241#!/bin/bash802 console.log(`[${model}] 📁 ${dir} | 🌿 ${branch} +${staged} ~${modified}`);

242input=$(cat)803 } else {

804 console.log(`[${model}] 📁 ${dir}`);

805 }

806 });

807 ```

808</CodeGroup>

243 809

244MODEL=$(echo "$input" | jq -r '.model.display_name')810### Windows configuration

245CONTEXT_SIZE=$(echo "$input" | jq -r '.context_window.context_window_size')

246USAGE=$(echo "$input" | jq '.context_window.current_usage')

247 811

248if [ "$USAGE" != "null" ]; then812On Windows, Claude Code runs status line commands through Git Bash. You can invoke PowerShell from that shell:

249 # Calculate current context from current_usage fields813

250 CURRENT_TOKENS=$(echo "$USAGE" | jq '.input_tokens + .cache_creation_input_tokens + .cache_read_input_tokens')814<CodeGroup>

251 PERCENT_USED=$((CURRENT_TOKENS * 100 / CONTEXT_SIZE))815 ```json settings.json theme={null}

252 echo "[$MODEL] Context: ${PERCENT_USED}%"816 {

253else817 "statusLine": {

254 echo "[$MODEL] Context: 0%"818 "type": "command",

255fi819 "command": "powershell -NoProfile -File C:/Users/username/.claude/statusline.ps1"

256```820 }

821 }

822 ```

823

824 ```powershell statusline.ps1 theme={null}

825 $input_json = $input | Out-String | ConvertFrom-Json

826 $cwd = $input_json.cwd

827 $model = $input_json.model.display_name

828 $used = $input_json.context_window.used_percentage

829 $dirname = Split-Path $cwd -Leaf

830

831 if ($used) {

832 Write-Host "$dirname [$model] ctx: $used%"

833 } else {

834 Write-Host "$dirname [$model]"

835 }

836 ```

837</CodeGroup>

838

839Or run a Bash script directly:

840

841<CodeGroup>

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

843 {

844 "statusLine": {

845 "type": "command",

846 "command": "~/.claude/statusline.sh"

847 }

848 }

849 ```

850

851 ```bash statusline.sh theme={null}

852 #!/usr/bin/env bash

853 input=$(cat)

854 cwd=$(echo "$input" | grep -o '"cwd":"[^"]*"' | cut -d'"' -f4)

855 model=$(echo "$input" | grep -o '"display_name":"[^"]*"' | cut -d'"' -f4)

856 dirname="${cwd##*[/\\]}"

857 echo "$dirname [$model]"

858 ```

859</CodeGroup>

257 860

258## Tips861## Tips

259 862

260* Keep your status line concise - it should fit on one line863* **Test with mock input**: `echo '{"model":{"display_name":"Opus"},"context_window":{"used_percentage":25}}' | ./statusline.sh`

261* Use emojis (if your terminal supports them) and colors to make information scannable864* **Keep output short**: the status bar has limited width, so long output may get truncated or wrap awkwardly

262* Use `jq` for JSON parsing in Bash (see examples above)865* **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.

263* Test your script by running it manually with mock JSON input: `echo '{"model":{"display_name":"Test"},"workspace":{"current_dir":"/test"}}' | ./statusline.sh`866

264* Consider caching expensive operations (like git status) if needed867Community 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.

265 868

266## Troubleshooting869## Troubleshooting

267 870

268* If your status line doesn't appear, check that your script is executable (`chmod +x`)871**Status line not appearing**

269* Ensure your script outputs to stdout (not stderr)872

873* Verify your script is executable: `chmod +x ~/.claude/statusline.sh`

874* Check that your script outputs to stdout, not stderr

875* Run your script manually to verify it produces output

876* 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.

877* Run `claude --debug` to log the exit code and stderr from the first status line invocation in a session

878* Ask Claude to read your settings file and execute the `statusLine` command directly to surface errors

879

880**Status line shows `--` or empty values**

881

882* Fields may be `null` before the first API response completes

883* Handle null values in your script with fallbacks such as `// 0` in jq

884* Restart Claude Code if values remain empty after multiple messages

885

886**Context percentage shows unexpected values**

887

888* Use `used_percentage` for accurate context state rather than cumulative totals

889* The `total_input_tokens` and `total_output_tokens` are cumulative across the session and may exceed the context window size

890* Context percentage may differ from `/context` output due to when each is calculated

891

892**OSC 8 links not clickable**

893

894* Verify your terminal supports OSC 8 hyperlinks (iTerm2, Kitty, WezTerm)

895* Terminal.app does not support clickable links

896* SSH and tmux sessions may strip OSC sequences depending on configuration

897* If escape sequences appear as literal text like `\e]8;;`, use `printf '%b'` instead of `echo -e` for more reliable escape handling

898

899**Display glitches with escape sequences**

900

901* Complex escape sequences (ANSI colors, OSC 8 links) can occasionally cause garbled output if they overlap with other UI updates

902* If you see corrupted text, try simplifying your script to plain text output

903* Multi-line status lines with escape codes are more prone to rendering issues than single-line plain text

904

905**Script errors or hangs**

906

907* Scripts that exit with non-zero codes or produce no output cause the status line to go blank

908* Slow scripts block the status line from updating until they complete. Keep scripts fast to avoid stale output.

909* If a new update triggers while a slow script is running, the in-flight script is cancelled

910* Test your script independently with mock input before configuring it

911

912**Notifications share the status line row**

913

914* System notifications like MCP server errors, auto-updates, and token warnings display on the right side of the same row as your status line

915* Enabling verbose mode adds a token counter to this area

916* On narrow terminals, these notifications may truncate your status line output

sub-agents.md +136 −22

Details

8 8

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.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.

10 10

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>

11Subagents help you:15Subagents help you:

12 16

13* **Preserve context** by keeping exploration and implementation out of your main conversation17* **Preserve context** by keeping exploration and implementation out of your main conversation

80 <Step title="Open the subagents interface">84 <Step title="Open the subagents interface">

81 In Claude Code, run:85 In Claude Code, run:

82 86

~~83 ```~~87 ```text theme={null}

84 /agents88 /agents

85 ```89 ```

86 </Step>90 </Step>

92 <Step title="Generate with Claude">96 <Step title="Generate with Claude">

93 Select **Generate with Claude**. When prompted, describe the subagent:97 Select **Generate with Claude**. When prompted, describe the subagent:

94 98

~~95 ```~~99 ```text theme={null}

96 A code improvement agent that scans files and suggests improvements100 A code improvement agent that scans files and suggests improvements

97 for readability, performance, and best practices. It should explain101 for readability, performance, and best practices. It should explain

98 each issue, show the current code, and provide an improved version.102 each issue, show the current code, and provide an improved version.

116 <Step title="Save and try it out">120 <Step title="Save and try it out">

117 Save the subagent. It's available immediately (no restart needed). Try it:121 Save the subagent. It's available immediately (no restart needed). Try it:

118 122

119 ```123 ```text theme={null}

120 Use the code-improver agent to suggest improvements in this project124 Use the code-improver agent to suggest improvements in this project

121 ```125 ```

122 126

142 146

143This is the recommended way to create and manage subagents. For manual creation or automation, you can also add subagent files directly.147This is the recommended way to create and manage subagents. For manual creation or automation, you can also add subagent files directly.

144 148

149To 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.

150

145### Choose the subagent scope151### Choose the subagent scope

146 152

147Subagents 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.153Subagents 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.

157 163

158**User subagents** (`~/.claude/agents/`) are personal subagents available in all your projects.164**User subagents** (`~/.claude/agents/`) are personal subagents available in all your projects.

159 165

160**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:166**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:

161 167

162```bash theme={null}168```bash theme={null}

163claude --agents '{169claude --agents '{

166 "prompt": "You are a senior code reviewer. Focus on code quality, security, and best practices.",172 "prompt": "You are a senior code reviewer. Focus on code quality, security, and best practices.",

167 "tools": ["Read", "Grep", "Glob", "Bash"],173 "tools": ["Read", "Grep", "Glob", "Bash"],

168 "model": "sonnet"174 "model": "sonnet"

175 },

176 "debugger": {

177 "description": "Debugging specialist for errors and test failures.",

178 "prompt": "You are an expert debugger. Analyze errors, identify root causes, and provide fixes."

169 }179 }

170}'180}'

171```181```

172 182

173The `--agents` flag accepts JSON with the same fields as [frontmatter](#supported-frontmatter-fields). Use `prompt` for the system prompt (equivalent to the markdown body in file-based subagents). See the [CLI reference](/en/cli-reference#agents-flag-format) for the full JSON format.183The `--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`, and `memory`. Use `prompt` for the system prompt, equivalent to the markdown body in file-based subagents.

174 184

175**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.185**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.

176 186

201The following fields can be used in the YAML frontmatter. Only `name` and `description` are required.211The following fields can be used in the YAML frontmatter. Only `name` and `description` are required.

202 212

204| :---------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |214| :---------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

205| `name` | Yes | Unique identifier using lowercase letters and hyphens |215| `name` | Yes | Unique identifier using lowercase letters and hyphens |

206| `description` | Yes | When Claude should delegate to this subagent |216| `description` | Yes | When Claude should delegate to this subagent |

207| `tools` | No | [Tools](#available-tools) the subagent can use. Inherits all tools if omitted |217| `tools` | No | [Tools](#available-tools) the subagent can use. Inherits all tools if omitted |

208| `disallowedTools` | No | Tools to deny, removed from inherited or specified list |218| `disallowedTools` | No | Tools to deny, removed from inherited or specified list |

209| `model` | No | [Model](#choose-a-model) to use: `sonnet`, `opus`, `haiku`, or `inherit`. Defaults to `inherit` |219| `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` |

210| `permissionMode` | No | [Permission mode](#permission-modes): `default`, `acceptEdits`, `dontAsk`, `bypassPermissions`, or `plan` |220| `permissionMode` | No | [Permission mode](#permission-modes): `default`, `acceptEdits`, `dontAsk`, `bypassPermissions`, or `plan` |

221| `maxTurns` | No | Maximum number of agentic turns before the subagent stops |

211| `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 |222| `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 |

223| `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 |

212| `hooks` | No | [Lifecycle hooks](#define-hooks-for-subagents) scoped to this subagent |224| `hooks` | No | [Lifecycle hooks](#define-hooks-for-subagents) scoped to this subagent |

225| `memory` | No | [Persistent memory scope](#enable-persistent-memory): `user`, `project`, or `local`. Enables cross-session learning |

226| `background` | No | Set to `true` to always run this subagent as a [background task](#run-subagents-in-foreground-or-background). Default: `false` |

227| `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 |

213 228

214### Choose a model229### Choose a model

215 230

216The `model` field controls which [AI model](/en/model-config) the subagent uses:231The `model` field controls which [AI model](/en/model-config) the subagent uses:

217 232

218* **Model alias**: Use one of the available aliases: `sonnet`, `opus`, or `haiku`233* **Model alias**: Use one of the available aliases: `sonnet`, `opus`, or `haiku`

234* **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

219* **inherit**: Use the same model as the main conversation235* **inherit**: Use the same model as the main conversation

220* **Omitted**: If not specified, defaults to `inherit` (uses the same model as the main conversation)236* **Omitted**: If not specified, defaults to `inherit` (uses the same model as the main conversation)

221 237

225 241

226#### Available tools242#### Available tools

227 243

228Subagents can use any of Claude Code's [internal tools](/en/settings#tools-available-to-claude). By default, subagents inherit all tools from the main conversation, including MCP tools.244Subagents 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.

229 245

230To restrict tools, use the `tools` field (allowlist) or `disallowedTools` field (denylist):246To restrict tools, use the `tools` field (allowlist) or `disallowedTools` field (denylist):

231 247

238---254---

239```255```

240 256

257#### Restrict which subagents can be spawned

258

259When 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.

260

261<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>

262

263```yaml theme={null}

264---

265name: coordinator

266description: Coordinates work across specialized agents

267tools: Agent(worker, researcher), Read, Bash

268---

269```

270

271This 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.

272

273To allow spawning any subagent without restrictions, use `Agent` without parentheses:

274

275```yaml theme={null}

276tools: Agent, Read, Bash

277```

278

279If `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.

280

281#### Scope MCP servers to a subagent

282

283Use 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.

284

285Each entry in the list is either an inline server definition or a string referencing an MCP server already configured in your session:

286

287```yaml theme={null}

288---

289name: browser-tester

290description: Tests features in a real browser using Playwright

291mcpServers:

292 # Inline definition: scoped to this subagent only

293 - playwright:

294 type: stdio

295 command: npx

296 args: ["-y", "@playwright/mcp@latest"]

297 # Reference by name: reuses an already-configured server

298 - github

299---

300

301Use the Playwright tools to navigate, screenshot, and interact with pages.

302```

303

304Inline definitions use the same schema as `.mcp.json` server entries (`stdio`, `http`, `sse`, `ws`), keyed by the server name.

305

306To 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.

307

241#### Permission modes308#### Permission modes

242 309

243The `permissionMode` field controls how the subagent handles permission prompts. Subagents inherit the permission context from the main conversation but can override the mode.310The `permissionMode` field controls how the subagent handles permission prompts. Subagents inherit the permission context from the main conversation but can override the mode.

278 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.345 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.

279</Note>346</Note>

280 347

348#### Enable persistent memory

349

350The `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.

351

352```yaml theme={null}

353---

354name: code-reviewer

355description: Reviews code for quality and best practices

356memory: user

357---

358

359You are a code reviewer. As you review code, update your agent memory with

360patterns, conventions, and recurring issues you discover.

361```

362

363Choose a scope based on how broadly the memory should apply:

364

365| Scope | Location | Use when |

366| :-------- | :-------------------------------------------- | :------------------------------------------------------------------------------------------ |

367| `user` | `~/.claude/agent-memory/<name-of-agent>/` | the subagent should remember learnings across all projects |

368| `project` | `.claude/agent-memory/<name-of-agent>/` | the subagent's knowledge is project-specific and shareable via version control |

369| `local` | `.claude/agent-memory-local/<name-of-agent>/` | the subagent's knowledge is project-specific but should not be checked into version control |

370

371When memory is enabled:

372

373* The subagent's system prompt includes instructions for reading and writing to the memory directory.

374* 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.

375* Read, Write, and Edit tools are automatically enabled so the subagent can manage its memory files.

376

377##### Persistent memory tips

378

379* `user` is the recommended default scope. Use `project` or `local` when the subagent's knowledge is only relevant to a specific codebase.

380* Ask the subagent to consult its memory before starting work: "Review this PR, and check your memory for patterns you've seen before."

381* 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.

382* Include memory instructions directly in the subagent's markdown file so it proactively maintains its own knowledge base:

383

384 ```markdown theme={null}

385 Update your agent memory as you discover codepaths, patterns, library

386 locations, and key architectural decisions. This builds up institutional

387 knowledge across conversations. Write concise notes about what you found

388 and where.

389 ```

390

281#### Conditional rules with hooks391#### Conditional rules with hooks

282 392

283For 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.393For 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.

320 430

321#### Disable specific subagents431#### Disable specific subagents

322 432

323You can prevent Claude from using specific subagents by adding them to the `deny` array in your [settings](/en/settings#permission-settings). Use the format `Task(subagent-name)` where `subagent-name` matches the subagent's name field.433You 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.

324 434

325```json theme={null}435```json theme={null}

326{436{

327 "permissions": {437 "permissions": {

328 "deny": ["Task(Explore)", "Task(my-custom-agent)"]438 "deny": ["Agent(Explore)", "Agent(my-custom-agent)"]

329 }439 }

330}440}

331```441```

333This works for both built-in and custom subagents. You can also use the `--disallowedTools` CLI flag:443This works for both built-in and custom subagents. You can also use the `--disallowedTools` CLI flag:

334 444

335```bash theme={null}445```bash theme={null}

336claude --disallowedTools "Task(Explore)"446claude --disallowedTools "Agent(Explore)"

337```447```

338 448

339See [Permissions documentation](/en/permissions#tool-specific-permission-rules) for more details on permission rules.449See [Permissions documentation](/en/permissions#tool-specific-permission-rules) for more details on permission rules.

387| :-------------- | :-------------- | :------------------------------- |497| :-------------- | :-------------- | :------------------------------- |

390 500

391`SubagentStart` supports matchers to target specific agent types by name. `SubagentStop` fires for all subagent completions regardless of matcher values. This example runs a setup script only when the `db-agent` subagent starts, and a cleanup script when any subagent stops:501Both 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:

392 502

393```json theme={null}503```json theme={null}

394{504{

422 532

423You can also request a specific subagent explicitly:533You can also request a specific subagent explicitly:

424 534

425```535```text theme={null}

426Use the test-runner subagent to fix failing tests536Use the test-runner subagent to fix failing tests

427Have the code-reviewer subagent look at my recent changes537Have the code-reviewer subagent look at my recent changes

428```538```

431 541

432Subagents can run in the foreground (blocking) or background (concurrent):542Subagents can run in the foreground (blocking) or background (concurrent):

433 543

434* **Foreground subagents** block the main conversation until complete. Permission prompts and clarifying questions (like [`AskUserQuestion`](/en/settings#tools-available-to-claude)) are passed through to you.544* **Foreground subagents** block the main conversation until complete. Permission prompts and clarifying questions (like [`AskUserQuestion`](/en/tools-reference)) are passed through to you.

435* **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. MCP tools are not available in background subagents.545* **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.

436 546

437If a background subagent fails due to missing permissions, you can [resume it](#resume-subagents) in the foreground to retry with interactive prompts.547If a background subagent fails due to missing permissions, you can [resume it](#resume-subagents) in the foreground to retry with interactive prompts.

438 548

441* Ask Claude to "run this in the background"551* Ask Claude to "run this in the background"

442* Press **Ctrl+B** to background a running task552* Press **Ctrl+B** to background a running task

443 553

444To disable all background task functionality, set the `CLAUDE_CODE_DISABLE_BACKGROUND_TASKS` environment variable to `1`. See [Environment variables](/en/settings#environment-variables).554To disable all background task functionality, set the `CLAUDE_CODE_DISABLE_BACKGROUND_TASKS` environment variable to `1`. See [Environment variables](/en/env-vars).

445 555

446### Common patterns556### Common patterns

447 557

449 559

450One 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.560One 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.

451 561

452```562```text theme={null}

453Use a subagent to run the test suite and report only the failing tests with their error messages563Use a subagent to run the test suite and report only the failing tests with their error messages

454```564```

455 565

457 567

458For independent investigations, spawn multiple subagents to work simultaneously:568For independent investigations, spawn multiple subagents to work simultaneously:

459 569

460```570```text theme={null}

461Research the authentication, database, and API modules in parallel using separate subagents571Research the authentication, database, and API modules in parallel using separate subagents

462```572```

463 573

467 When subagents complete, their results return to your main conversation. Running many subagents that each return detailed results can consume significant context.577 When subagents complete, their results return to your main conversation. Running many subagents that each return detailed results can consume significant context.

468</Warning>578</Warning>

469 579

580For tasks that need sustained parallelism or exceed your context window, [agent teams](/en/agent-teams) give each worker its own independent context.

581

470#### Chain subagents582#### Chain subagents

471 583

472For 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.584For 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.

473 585

474```586```text theme={null}

475Use the code-reviewer subagent to find performance issues, then use the optimizer subagent to fix them587Use the code-reviewer subagent to find performance issues, then use the optimizer subagent to fix them

476```588```

477 589

492 604

493Consider [Skills](/en/skills) instead when you want reusable prompts or workflows that run in the main conversation context rather than isolated subagent context.605Consider [Skills](/en/skills) instead when you want reusable prompts or workflows that run in the main conversation context rather than isolated subagent context.

494 606

607For 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.

608

495<Note>609<Note>

496 Subagents cannot spawn other subagents. If your workflow requires nested delegation, use [Skills](/en/skills) or [chain subagents](#chain-subagents) from the main conversation.610 Subagents cannot spawn other subagents. If your workflow requires nested delegation, use [Skills](/en/skills) or [chain subagents](#chain-subagents) from the main conversation.

497</Note>611</Note>

506 620

507When a subagent completes, Claude receives its agent ID. To resume a subagent, ask Claude to continue the previous work:621When a subagent completes, Claude receives its agent ID. To resume a subagent, ask Claude to continue the previous work:

508 622

509```623```text theme={null}

510Use the code-reviewer subagent to review the authentication module624Use the code-reviewer subagent to review the authentication module

511[Agent completes]625[Agent completes]

512 626

524 638

525#### Auto-compaction639#### Auto-compaction

526 640

527Subagents 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/settings#environment-variables) for details.641Subagents 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.

528 642

529Compaction events are logged in subagent transcript files:643Compaction events are logged in subagent transcript files:

530 644

terminal-config.md +11 −10

Details

42 42

43### Notification setup43### Notification setup

44 44

~~45Never miss when Claude completes a task with proper notification configuration:~~45When 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).

46 46

~~47#### iTerm 2 system notifications~~47#### Terminal notifications

48 48

~~49For iTerm 2 alerts when tasks complete:~~49Kitty and Ghostty support desktop notifications without additional configuration. iTerm 2 requires setup:

50 50

~~511. Open iTerm 2 Preferences~~511. Open iTerm 2 Settings → Profiles → Terminal

~~522. Navigate to Profiles → Terminal~~522. Enable "Notification Center Alerts"

~~533. Enable "Silence bell" and Filter Alerts → "Send escape sequence-generated alerts"~~533. Click "Filter Alerts" and check "Send escape sequence-generated alerts"

~~544. Set your preferred notification delay~~

55 54

~~56Note that these notifications are specific to iTerm 2 and not available in the default macOS Terminal.~~55If notifications aren't appearing, verify that your terminal app has notification permissions in your OS settings.

57 56

~~58#### Custom notification hooks~~57Other terminals, including the default macOS Terminal, do not support native notifications. Use [notification hooks](/en/hooks#notification) instead.

59 58

~~60For advanced notification handling, you can create [notification hooks](/en/hooks#notification) to run your own logic.~~59#### Notification hooks

61To 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.

61 62

62### Handling large inputs63### Handling large inputs

63 64

third-party-integrations.md +11 −7

Details

44 44

45 <tr>45 <tr>

46 <td>Billing</td>46 <td>Billing</td>

~~47 <td>Teams: \$150/seat (Premium) with PAYG available Enterprise: <a href="https://claude.com/contact-sales">Contact Sales</a></td>~~47 <td>Teams: \$150/seat (Premium) with PAYG available Enterprise: <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>48 <td>PAYG</td>

49 <td>PAYG through AWS</td>49 <td>PAYG through AWS</td>

50 <td>PAYG through GCP</td>50 <td>PAYG through GCP</td>

128 128

129<Tabs>129<Tabs>

130 <Tab title="Corporate proxy">130 <Tab title="Corporate proxy">

131 Route Bedrock traffic through your corporate proxy by setting the following [environment variables](/en/settings#environment-variables):131 Route Bedrock traffic through your corporate proxy by setting the following [environment variables](/en/env-vars):

132 132

133 ```bash theme={null}133 ```bash theme={null}

134 # Enable Bedrock134 # Enable Bedrock

141 </Tab>141 </Tab>

142 142

143 <Tab title="LLM Gateway">143 <Tab title="LLM Gateway">

144 Route Bedrock traffic through your LLM gateway by setting the following [environment variables](/en/settings#environment-variables):144 Route Bedrock traffic through your LLM gateway by setting the following [environment variables](/en/env-vars):

145 145

146 ```bash theme={null}146 ```bash theme={null}

147 # Enable Bedrock147 # Enable Bedrock

158 158

159<Tabs>159<Tabs>

160 <Tab title="Corporate proxy">160 <Tab title="Corporate proxy">

161 Route Foundry traffic through your corporate proxy by setting the following [environment variables](/en/settings#environment-variables):161 Route Foundry traffic through your corporate proxy by setting the following [environment variables](/en/env-vars):

162 162

163 ```bash theme={null}163 ```bash theme={null}

164 # Enable Microsoft Foundry164 # Enable Microsoft Foundry

172 </Tab>172 </Tab>

173 173

174 <Tab title="LLM Gateway">174 <Tab title="LLM Gateway">

175 Route Foundry traffic through your LLM gateway by setting the following [environment variables](/en/settings#environment-variables):175 Route Foundry traffic through your LLM gateway by setting the following [environment variables](/en/env-vars):

176 176

177 ```bash theme={null}177 ```bash theme={null}

178 # Enable Microsoft Foundry178 # Enable Microsoft Foundry

189 189

190<Tabs>190<Tabs>

191 <Tab title="Corporate proxy">191 <Tab title="Corporate proxy">

192 Route Vertex AI traffic through your corporate proxy by setting the following [environment variables](/en/settings#environment-variables):192 Route Vertex AI traffic through your corporate proxy by setting the following [environment variables](/en/env-vars):

193 193

194 ```bash theme={null}194 ```bash theme={null}

195 # Enable Vertex195 # Enable Vertex

203 </Tab>203 </Tab>

204 204

205 <Tab title="LLM Gateway">205 <Tab title="LLM Gateway">

206 Route Vertex AI traffic through your LLM gateway by setting the following [environment variables](/en/settings#environment-variables):206 Route Vertex AI traffic through your LLM gateway by setting the following [environment variables](/en/env-vars):

207 207

208 ```bash theme={null}208 ```bash theme={null}

209 # Enable Vertex209 # Enable Vertex

239 239

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.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.

241 241

242### 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

242### Configure security policies246### Configure security policies

243 247

244Security 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).

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` | Retrieves output from a background task | 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 +584 −117

Details

6 6

7> Discover solutions to common issues with Claude Code installation and usage.7> Discover solutions to common issues with Claude Code installation and usage.

8 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

9## Common installation issues219## Common installation issues

10 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

11### Windows installation issues: errors in WSL527### Windows installation issues: errors in WSL

12 528

13You might encounter the following issues in WSL:529You might encounter the following issues in WSL:

14 530

~~15**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:

16 532

17* Run `npm config set os linux` before installation533* Run `npm config set os linux` before installation

~~18* 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`.

19 535

20**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).

21 537

22**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.

23 539

24You can identify this issue by:540You can identify this issue by:

25 541

54```570```

55 571

56<Warning>572<Warning>

57 Avoid disabling Windows PATH importing (`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.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.

58</Warning>574</Warning>

59 575

60### WSL2 sandbox setup576### WSL2 sandbox setup

77 593

78WSL1 does not support sandboxing. If you see "Sandboxing requires WSL2", you need to upgrade to WSL2 or run Claude Code without sandboxing.594WSL1 does not support sandboxing. If you see "Sandboxing requires WSL2", you need to upgrade to WSL2 or run Claude Code without sandboxing.

79 595

~~80### Linux and Mac installation issues: permission or command not found errors~~596### Permission errors during installation

81 597

~~82When installing Claude Code with npm, `PATH` problems may prevent access to `claude`.~~598If the native installer fails with permission errors, the target directory may not be writable. See [Check directory permissions](#check-directory-permissions).

~~83You may also encounter permission errors if your npm global prefix is not user writable (for example, `/usr`, or `/usr/local`).~~

84 599

~~85#### Recommended solution: Native Claude Code installation~~600If you previously installed with npm and are hitting npm-specific permission errors, switch to the native installer:

~~87Claude Code has a native installation that doesn't depend on npm or Node.js.~~

~~89Use the following command to run the native installer.~~

~~91**macOS, Linux, WSL:**~~

92 601

93```bash theme={null}602```bash theme={null}

~~94# Install stable version (default)~~

95curl -fsSL https://claude.ai/install.sh | bash603curl -fsSL https://claude.ai/install.sh | bash

~~97# Install latest version~~

~~98curl -fsSL https://claude.ai/install.sh | bash -s latest~~

100# Install specific version number

101curl -fsSL https://claude.ai/install.sh | bash -s 1.0.58

102```604```

103 605

104**Windows PowerShell:**606## Permissions and authentication

~~105~~

106```powershell theme={null}

107# Install stable version (default)

108irm https://claude.ai/install.ps1 | iex

~~109~~

110# Install latest version

111& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) latest

112 607

113# Install specific version number608These sections address login failures, token issues, and permission prompt behavior.

114& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) 1.0.58

115 609

116```610### Repeated permission prompts

117 611

118This 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` (or `%USERPROFILE%\.local\bin\claude.exe` on Windows).612If you find yourself repeatedly approving the same commands, you can allow specific tools

613to run without approval using the `/permissions` command. See [Permissions docs](/en/permissions#manage-permissions).

119 614

120<Tip>615### Authentication issues

121 Make sure that you have the installation directory in your system PATH.

122</Tip>

123 616

124### Windows: "Claude Code on Windows requires git-bash"617If you're experiencing authentication problems:

125 618

126Claude Code on native Windows requires [Git for Windows](https://git-scm.com/downloads/win) which includes Git Bash. If Git is installed but not detected:6191. Run `/logout` to sign out completely

6202. Close Claude Code

6213. Restart with `claude` and complete the authentication process again

127 622

1281. Set the path explicitly in PowerShell before running 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.

129 ```powershell theme={null}

130 $env:CLAUDE_CODE_GIT_BASH_PATH="C:\Program Files\Git\bin\bash.exe"

131 ```

132 624

1332. Or add it to your system environment variables permanently through System Properties → Environment Variables.625### OAuth error: Invalid code

134 626

135If Git is installed in a non-standard location, adjust the path accordingly.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.

136 628

137### Windows: "installMethod is native, but claude command not found"629**Solutions:**

138 630

139If you see this error after installation, the `claude` command isn't in your PATH. Add it manually: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.

140 634

141<Steps>635### 403 Forbidden after login

142 <Step title="Open Environment Variables">

143 Press `Win + R`, type `sysdm.cpl`, and press Enter. Click **Advanced** → **Environment Variables**.

144 </Step>

145 636

146 <Step title="Edit User PATH">637If you see `API Error: 403 {"error":{"type":"forbidden","message":"Request not allowed"}}` after logging in:

147 Under "User variables", select **Path** and click **Edit**. Click **New** and add:

148 638

149 ```639* **Claude Pro/Max users**: verify your subscription is active at [claude.ai/settings](https://claude.ai/settings)

150 %USERPROFILE%\.local\bin640* **Console users**: confirm your account has the "Claude Code" or "Developer" role assigned by your admin

151 ```641* **Behind a proxy**: corporate proxies can interfere with API requests. See [network configuration](/en/network-config) for proxy setup.

152 </Step>

153 642

154 <Step title="Restart your terminal">643### OAuth login fails in WSL2

155 Close and reopen PowerShell or CMD for changes to take effect.

156 </Step>

157</Steps>

158 644

159Verify installation:645Browser-based login in WSL2 may fail if WSL can't open your Windows browser. Set the `BROWSER` environment variable:

160 646

161```bash theme={null}647```bash theme={null}

162claude doctor # Check installation health648export BROWSER="/mnt/c/Program Files/Google/Chrome/Application/chrome.exe"

649claude

163```650```

164 651

165## Permissions and authentication652Or copy the URL manually: when the login prompt appears, press `c` to copy the OAuth URL, then paste it into your Windows browser.

~~166~~

167### Repeated permission prompts

~~168~~

169If you find yourself repeatedly approving the same commands, you can allow specific tools

170to run without approval using the `/permissions` command. See [Permissions docs](/en/permissions#manage-permissions).

171 653

172### Authentication issues654### "Not logged in" or token expired

173 655

174If you're experiencing authentication problems:656If Claude Code prompts you to log in again after a session, your OAuth token may have expired.

175 657

1761. Run `/logout` to sign out completely658Run `/login` to re-authenticate. If this happens frequently, check that your system clock is accurate, as token validation depends on correct timestamps.

1772. Close Claude Code

1783. Restart with `claude` and complete the authentication process again

~~179~~

180If 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.

~~181~~

182If problems persist, try:

~~183~~

184```bash theme={null}

185rm -rf ~/.config/claude-code/auth.json

186claude

187```

~~188~~

189This removes your stored authentication information and forces a clean login.

190 659

191## Configuration file locations660## Configuration file locations

192 661

193Claude Code stores configuration in several locations:662Claude Code stores configuration in several locations:

194 663

195| File | Purpose |664| File | Purpose |

196| :---------------------------- | :------------------------------------------------------- |665| :---------------------------- | :----------------------------------------------------------------------------------------------------- |

202| `managed-settings.json` | [Managed settings](/en/settings#settings-files) |

672| Managed settings | [Managed settings](/en/settings#settings-files) (server-managed, MDM/OS-level policies, or file-based) |

204 673

205On Windows, `~` refers to your user home directory, such as `C:\Users\YourName`.674On Windows, `~` refers to your user home directory, such as `C:\Users\YourName`.

206 675

207**Managed file locations:**

~~208~~

209* macOS: `/Library/Application Support/ClaudeCode/`

210* Linux/WSL: `/etc/claude-code/`

211* Windows: `C:\Program Files\ClaudeCode\`

~~212~~

213For details on configuring these files, see [Settings](/en/settings) and [MCP](/en/mcp).676For details on configuring these files, see [Settings](/en/settings) and [MCP](/en/mcp).

214 677

215### Resetting configuration678### Resetting configuration

232 695

233## Performance and stability696## Performance and stability

234 697

698These sections cover issues related to resource usage, responsiveness, and search behavior.

699

235### High CPU or memory usage700### High CPU or memory usage

236 701

237Claude Code is designed to work with most development environments, but may consume significant resources when processing large codebases. If you're experiencing performance issues:702Claude Code is designed to work with most development environments, but may consume significant resources when processing large codebases. If you're experiencing performance issues:

268pacman -S ripgrep733pacman -S ripgrep

269```734```

270 735

271Then set `USE_BUILTIN_RIPGREP=0` in your [environment](/en/settings#environment-variables).736Then set `USE_BUILTIN_RIPGREP=0` in your [environment](/en/env-vars).

272 737

273### Slow or incomplete search results on WSL738### Slow or incomplete search results on WSL

274 739

275Disk 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.740Disk 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.

276 741

277<Note>742<Note>

278 `/doctor` will show Search as OK in this case.743 `/doctor` will show Search as OK in this case.

280 745

281**Solutions:**746**Solutions:**

282 747

2831. **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".7481. **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".

284 749

2852. **Move project to Linux filesystem**: If possible, ensure your project is located on the Linux filesystem (`/home/`) rather than the Windows filesystem (`/mnt/c/`).7502. **Move project to Linux filesystem**: if possible, ensure your project is located on the Linux filesystem (`/home/`) rather than the Windows filesystem (`/mnt/c/`).

286 751

2873. **Use native Windows instead**: Consider running Claude Code natively on Windows instead of through WSL, for better file system performance.7523. **Use native Windows instead**: consider running Claude Code natively on Windows instead of through WSL, for better file system performance.

288 753

289## IDE integration issues754## IDE integration issues

290 755

756If Claude Code does not connect to your IDE or behaves unexpectedly within an IDE terminal, try the solutions below.

757

291### JetBrains IDE not detected on WSL2758### JetBrains IDE not detected on WSL2

292 759

293If 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.760If 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.

3011. Find your WSL2 IP address:7681. Find your WSL2 IP address:

302 ```bash theme={null}769 ```bash theme={null}

303 wsl hostname -I770 wsl hostname -I

304 # Example output: 172.21.123.456771 # Example output: 172.21.123.45

305 ```772 ```

306 773

3072. Open PowerShell as Administrator and create a firewall rule:7742. Open PowerShell as Administrator and create a firewall rule:

308 ```powershell theme={null}775 ```powershell theme={null}

309 New-NetFirewallRule -DisplayName "Allow WSL2 Internal Traffic" -Direction Inbound -Protocol TCP -Action Allow -RemoteAddress 172.21.0.0/16 -LocalAddress 172.21.0.0/16776 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

310 ```777 ```

311 (Adjust the IP range based on your WSL2 subnet from step 1)778 Adjust the IP range based on your WSL2 subnet from step 1.

312 779

3133. Restart both your IDE and Claude Code7803. Restart both your IDE and Claude Code

314 781

327 These networking issues only affect WSL2. WSL1 uses the host's network directly and doesn't require these configurations.794 These networking issues only affect WSL2. WSL1 uses the host's network directly and doesn't require these configurations.

328</Note>795</Note>

329 796

330For additional JetBrains configuration tips, see our [JetBrains IDE guide](/en/jetbrains#plugin-settings).797For additional JetBrains configuration tips, see the [JetBrains IDE guide](/en/jetbrains#plugin-settings).

331 798

332### Reporting Windows IDE integration issues (both native and WSL)799### Report Windows IDE integration issues

333 800

334If you're experiencing IDE integration problems on Windows, [create an issue](https://github.com/anthropics/claude-code/issues) with the following information:801If you're experiencing IDE integration problems on Windows, [create an issue](https://github.com/anthropics/claude-code/issues) with the following information:

335 802

336* Environment type: native Windows (Git Bash) or WSL1/WSL2803* Environment type: native Windows (Git Bash) or WSL1/WSL2

337* WSL networking mode (if applicable): NAT or mirrored804* WSL networking mode, if applicable: NAT or mirrored

338* IDE name and version805* IDE name and version

339* Claude Code extension/plugin version806* Claude Code extension/plugin version

340* Shell type: Bash, Zsh, PowerShell, etc.807* Shell type: Bash, Zsh, PowerShell, etc.

341 808

342### Escape key not working in JetBrains (IntelliJ, PyCharm, etc.) terminals809### Escape key not working in JetBrains IDE terminals

343 810

344If 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.811If 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.

345 812

366function example() {833function example() {

367 return "hello";834 return "hello";

368}835}

369```836```text

370````837````

371 838

372Instead of properly tagged blocks like:839Instead of properly tagged blocks like:

376function example() {843function example() {

377 return "hello";844 return "hello";

378}845}

379```846```text

380````847````

381 848

382**Solutions:**849**Solutions:**

383 850

3841. **Ask Claude to add language tags**: Request "Add appropriate language tags to all code blocks in this markdown file."8511. **Ask Claude to add language tags**: request "Add appropriate language tags to all code blocks in this markdown file."

385 852

3862. **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.8532. **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.

387 854

3883. **Manual verification**: After generating markdown files, review them for proper code block formatting and request corrections if needed.8553. **Manual verification**: after generating markdown files, review them for proper code block formatting and request corrections if needed.

389 856

390### Inconsistent spacing and formatting857### Inconsistent spacing and formatting

391 858

393 860

394**Solutions:**861**Solutions:**

395 862

3961. **Request formatting corrections**: Ask Claude to "Fix spacing and formatting issues in this markdown file."8631. **Request formatting corrections**: ask Claude to "Fix spacing and formatting issues in this markdown file."

397 864

3982. **Use formatting tools**: Set up hooks to run markdown formatters like `prettier` or custom formatting scripts on generated markdown files.8652. **Use formatting tools**: set up hooks to run markdown formatters like `prettier` or custom formatting scripts on generated markdown files.

399 866

4003. **Specify formatting preferences**: Include formatting requirements in your prompts or project [memory](/en/memory) files.8673. **Specify formatting preferences**: include formatting requirements in your prompts or project [memory](/en/memory) files.

401 868

402### Best practices for markdown generation869### Reduce markdown formatting issues

403 870

404To minimize formatting issues:871To minimize formatting issues:

405 872

406* **Be explicit in requests**: Ask for "properly formatted markdown with language-tagged code blocks"873* **Be explicit in requests**: ask for "properly formatted markdown with language-tagged code blocks"

407* **Use project conventions**: Document your preferred markdown style in [`CLAUDE.md`](/en/memory)874* **Use project conventions**: document your preferred markdown style in [`CLAUDE.md`](/en/memory)

408* **Set up validation hooks**: Use post-processing hooks to automatically verify and fix common formatting issues875* **Set up validation hooks**: use post-processing hooks to automatically verify and fix common formatting issues

409 876

410## Getting more help877## Get more help

411 878

412If you're experiencing issues not covered here:879If you're experiencing issues not covered here:

413 880

vs-code.md +37 −38

Details

6 6

7> Install and configure the Claude Code extension for VS Code. Get AI coding assistance with inline diffs, @-mentions, plan review, and keyboard shortcuts.7> Install and configure the Claude Code extension for VS Code. Get AI coding assistance with inline diffs, @-mentions, plan review, and keyboard shortcuts.

8 8

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" 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" />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" />

10 10

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.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.

12 12

14 14

15## Prerequisites15## Prerequisites

16 16

17Before installing, make sure you have:

17* VS Code 1.98.0 or higher19* VS Code 1.98.0 or higher

18* 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.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.

19 21

38 40

39<Steps>41<Steps>

40 <Step title="Open the Claude Code panel">42 <Step title="Open the Claude Code panel">

41 Throughout VS Code, the Spark icon indicates Claude Code: <img src="https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-spark-icon.svg?fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=a734d84e785140016672f08e0abb236c" alt="Spark icon" style={{display: "inline", height: "0.85em", verticalAlign: "middle"}} data-og-width="16" width="16" data-og-height="16" height="16" data-path="images/vs-code-spark-icon.svg" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-spark-icon.svg?w=280&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=9a45aad9a84b9fa1701ac99a1f9aa4e9 280w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-spark-icon.svg?w=560&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=3f4cb9254c4d4e93989c4b6bf9292f4b 560w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-spark-icon.svg?w=840&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=e75ccc9faa3e572db8f291ceb65bb264 840w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-spark-icon.svg?w=1100&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=f147bd81a381a62539a4ce361fac41c7 1100w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-spark-icon.svg?w=1650&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=78fe68efaee5d6e844bbacab1b442ed5 1650w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-spark-icon.svg?w=2500&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=efb8dbe1dfa722d094edc6ad2ad4bedb 2500w" />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" />

42 44

43 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.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.

44 46

45 <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" data-og-width="2796" width="2796" data-og-height="734" height="734" data-path="images/vs-code-editor-icon.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-editor-icon.png?w=280&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=56f218d5464359d6480cfe23f70a923e 280w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-editor-icon.png?w=560&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=344a8db024b196c795a80dc85cacb8d1 560w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-editor-icon.png?w=840&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=f30bf834ee0625b2a4a635d552d87163 840w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-editor-icon.png?w=1100&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=81fdf984840e43a9f08ae42729d1484d 1100w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-editor-icon.png?w=1650&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=8b60fb32de54717093d512afaa99785c 1650w, https://mintcdn.com/claude-code/mfM-EyoZGnQv8JTc/images/vs-code-editor-icon.png?w=2500&fit=max&auto=format&n=mfM-EyoZGnQv8JTc&q=85&s=893e6bda8f2e9d42c8a294d394f0b736 2500w" />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" />

46 48

47 Other ways to open Claude Code:49 Other ways to open Claude Code:

48 50

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.

49 * **Command Palette**: `Cmd+Shift+P` (Mac) or `Ctrl+Shift+P` (Windows/Linux), type "Claude Code", and select an option like "Open in New Tab"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"

~~50 * **Status Bar**: Click **✱ Claude Code** in the bottom-right corner of the window. This works even when no file is open.~~53 * **Status Bar**: click **✱ Claude Code** in the bottom-right corner of the window. This works even when no file is open.

51 54

52 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.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.

53 56

61 64

62 Here's an example of asking about a particular line in a file:65 Here's an example of asking about a particular line in a file:

63 66

64 <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" data-og-width="3288" width="3288" data-og-height="1876" height="1876" data-path="images/vs-code-send-prompt.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-send-prompt.png?w=280&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=f40bde7b2c245fe8f0f5b784e8106492 280w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-send-prompt.png?w=560&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=fad66a27a9a6faa23b05370aa4f398b2 560w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-send-prompt.png?w=840&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=4539c8a3823ca80a5c8771f6c088ce9e 840w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-send-prompt.png?w=1100&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=fae8ebf300c7853409a562ffa46d9c71 1100w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-send-prompt.png?w=1650&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=22e4462bb8cf0c0ca20f8102bc4c971a 1650w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-send-prompt.png?w=2500&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=739bfd045f70fe7be1a109a53494590e 2500w" />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" />

65 </Step>68 </Step>

66 69

67 <Step title="Review changes">70 <Step title="Review changes">

68 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.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.

69 72

70 <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" data-og-width="3292" width="3292" data-og-height="1876" height="1876" data-path="images/vs-code-edits.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-edits.png?w=280&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=cb5d41b81087f79b842a56b5a3304660 280w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-edits.png?w=560&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=90bb691960decdc06393c3c21cd62c75 560w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-edits.png?w=840&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=9a11bf878ba619e850380904ff4f38e8 840w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-edits.png?w=1100&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=6dddbf596b4f69ec6245bdc5eb6dd487 1100w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-edits.png?w=1650&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=ef2713b8cbfd2cee97af817d813d64c7 1650w, https://mintcdn.com/claude-code/FVYz38sRY-VuoGHA/images/vs-code-edits.png?w=2500&fit=max&auto=format&n=FVYz38sRY-VuoGHA&q=85&s=1f7e1c52919cdfddf295f32a2ec7ae59 2500w" />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" />

71 </Step>74 </Step>

72</Steps>75</Steps>

73 76

81 84

82The prompt box supports several features:85The prompt box supports several features:

83 86

84* **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. In auto-accept mode, Claude makes edits without asking. Set the default in VS Code settings under `claudeCode.initialPermissionMode`.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`.

85* **Command menu**: Click `/` or type `/` to open the command menu. Options include attaching files, switching models, toggling extended thinking, and viewing plan usage (`/usage`). The Customize section provides access to MCP servers, hooks, memory, permissions, and plugins. Items with a terminal icon open in the integrated terminal.88* **Command menu**: click `/` or type `/` to open the command menu. Options include attaching files, switching models, toggling extended thinking, and viewing plan usage (`/usage`). The Customize section provides access to MCP servers, hooks, memory, permissions, and plugins. Items with a terminal icon open in the integrated terminal.

~~86* **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.~~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.

87* **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.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.

~~88* **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.~~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.

89 92

90### Reference files and folders93### Reference files and folders

91 94

92Use @-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: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:

93 96

~~94```~~97```text theme={null}

95> Explain the logic in @auth (fuzzy matches auth.js, AuthService.ts, etc.)98> Explain the logic in @auth (fuzzy matches auth.js, AuthService.ts, etc.)

96> What's in @src/components/ (include a trailing slash for folders)99> What's in @src/components/ (include a trailing slash for folders)

97```100```

104 107

105### Resume past conversations108### Resume past conversations

106 109

107Click 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. For more on resuming sessions, see [Common workflows](/en/common-workflows#resume-previous-conversations).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. 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).

108 111

109### Resume remote sessions from Claude.ai112### Resume remote sessions from Claude.ai

110 113

136 139

137You can drag the Claude panel to reposition it anywhere in VS Code. Grab the panel's tab or title bar and drag it to: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:

138 141

139* **Secondary sidebar**: The right side of the window. Keeps Claude visible while you code.142* **Secondary sidebar**: the right side of the window. Keeps Claude visible while you code.

140* **Primary sidebar**: The left sidebar with icons for Explorer, Search, etc.143* **Primary sidebar**: the left sidebar with icons for Explorer, Search, etc.

141* **Editor area**: Opens Claude as a tab alongside your files. Useful for side tasks.144* **Editor area**: opens Claude as a tab alongside your files. Useful for side tasks.

142 145

143<Tip>146<Tip>

144 Use the sidebar for your main Claude session and open additional tabs for side tasks. Claude remembers your preferred location. Note that the Spark icon only appears in the Activity Bar when the Claude panel is docked to the left. Since Claude defaults to the right side, use the Editor Toolbar icon to open Claude.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.

145</Tip>148</Tip>

146 149

147### Run multiple conversations150### Run multiple conversations

173 176

174When you install a plugin, choose the installation scope:177When you install a plugin, choose the installation scope:

175 178

176* **Install for you**: Available in all your projects (user scope)179* **Install for you**: available in all your projects (user scope)

177* **Install for this project**: Shared with project collaborators (project scope)180* **Install for this project**: shared with project collaborators (project scope)

178* **Install locally**: Only for you, only in this repository (local scope)181* **Install locally**: only for you, only in this repository (local scope)

179 182

180### Manage marketplaces183### Manage marketplaces

181 184

235 238

236The extension has two types of settings:239The extension has two types of settings:

237 240

238* **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.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.

239* **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.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.

240 243

241<Tip>244<Tip>

242 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.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.

265Claude 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.268Claude 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.

266 269

267| Feature | CLI | VS Code Extension |270| Feature | CLI | VS Code Extension |

268| ------------------- | --------------------------------------------- | ---------------------------------------- |271| ------------------- | ------------------- | ------------------------------------------------------------------------------------ |

270| MCP server config | Yes | No (configure via CLI, use in extension) |273| MCP server config | Yes | Partial (add servers via CLI; manage existing servers with `/mcp` in the chat panel) |

271| Checkpoints | Yes | Yes |274| Checkpoints | Yes | Yes |

272| `!` bash shortcut | Yes | No |275| `!` bash shortcut | Yes | No |

273| Tab completion | Yes | No |276| Tab completion | Yes | No |

302 305

303### Connect to external tools with MCP306### Connect to external tools with MCP

304 307

305MCP (Model Context Protocol) servers give Claude access to external tools, databases, and APIs. Configure them via CLI, then use them in both extension and CLI.308MCP (Model Context Protocol) servers give Claude access to external tools, databases, and APIs.

306 309

307To add an MCP server, open the integrated terminal (`` Ctrl+` `` or `` Cmd+` ``) and run:310To add an MCP server, open the integrated terminal (`` Ctrl+` `` or `` Cmd+` ``) and run:

308 311

310claude mcp add --transport http github https://api.githubcopilot.com/mcp/313claude mcp add --transport http github https://api.githubcopilot.com/mcp/

311```314```

312 315

313Once configured, ask Claude to use the tools (e.g., "Review PR #456"). Some servers require authentication: run `claude` in the terminal, then type `/mcp` to authenticate. See the [MCP documentation](/en/mcp) for available servers.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.

314 319

315## Work with git320## Work with git

316 321

320 325

321Claude can stage changes, write commit messages, and create pull requests based on your work:326Claude can stage changes, write commit messages, and create pull requests based on your work:

322 327

323```328```text theme={null}

324> commit my changes with a descriptive message329> commit my changes with a descriptive message

325> create a pr for this feature330> create a pr for this feature

326> summarize the changes I've made to the auth module331> summarize the changes I've made to the auth module

330 335

331### Use git worktrees for parallel tasks336### Use git worktrees for parallel tasks

332 337

333Git worktrees allow multiple Claude Code sessions to work on separate branches simultaneously, each with isolated files:338Use the `--worktree` (`-w`) flag to start Claude in an isolated worktree with its own files and branch:

334 339

335```bash theme={null}340```bash theme={null}

336# Create a worktree for a new feature341claude --worktree feature-auth

337git worktree add ../project-feature-a -b feature-a

~~338~~

339# Run Claude Code in each worktree

340cd ../project-feature-a && claude

341```342```

342 343

343Each worktree maintains independent file state while sharing git history. This prevents Claude instances from interfering with each other when working on different tasks.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).

~~344~~

345For detailed git workflows including PR reviews and branch management, see [Common workflows](/en/common-workflows#create-pull-requests).

346 345

347## Use third-party providers346## Use third-party providers

348 347

427Now that you have Claude Code set up in VS Code:426Now that you have Claude Code set up in VS Code:

428 427

429* [Explore common workflows](/en/common-workflows) to get the most out of Claude Code428* [Explore common workflows](/en/common-workflows) to get the most out of Claude Code

430* [Set up MCP servers](/en/mcp) to extend Claude's capabilities with external tools. Configure servers using the CLI, then use them in the extension.429* [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.

431* [Configure Claude Code settings](/en/settings) to customize allowed commands, hooks, and more. These settings are shared between the extension and CLI.430* [Configure Claude Code settings](/en/settings) to customize allowed commands, hooks, and more. These settings are shared between the extension and CLI.

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 2026-02-05 00:07 UTC → 2026-03-14 03:44 UTC