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.
4
5	# Claude code docs map
6
7	# Claude Code Documentation Map
8
9	This is a comprehensive map of all Claude Code documentation pages with their headings, designed for easy navigation by LLMs.
10
11	> **Note:** This file is auto-generated by GitHub Actions. Do not edit manually.
12	> Last updated: 2026-07-11 03:53:52 UTC
13
14	## Document Structure
15
16	This map uses a hierarchical structure:
17
18	* **##** marks documentation groups (e.g., 'Getting started')
19	* **###** marks individual documentation pages
20	* **Nested bullets** show the heading structure within each page
21	* Each page title links to the full documentation
22
23	## Getting started
24
25	### [overview](https://code.claude.com/docs/en/overview.md)
26
27	* Get started
28	* What you can do
29	* Use Claude Code everywhere
30	* Next steps
31
32	### [quickstart](https://code.claude.com/docs/en/quickstart.md)
33
34	* Before you begin
35	* Step 1: Install Claude Code
36	* Step 2: Log in to your account
37	* Step 3: Start your first session
38	* Step 4: Ask your first question
39	* Step 5: Make your first code change
40	* Step 6: Use Git with Claude Code
41	* Step 7: Fix a bug or add a feature
42	* Step 8: Test out other common workflows
43	* Essential commands
44	* Pro tips for beginners
45	* What's next?
46	* Getting help
47
48	### [changelog](https://code.claude.com/docs/en/changelog.md)
49
50	* (No headings found)
51
52	## Core concepts
53
54	### [how-claude-code-works](https://code.claude.com/docs/en/how-claude-code-works.md)
55
56	* The agentic loop
57	  * Models
58	  * Tools
59	* What Claude can access
60	* Environments and interfaces
61	  * Execution environments
62	  * Interfaces
63	* Work with sessions
64	  * Work across branches
65	  * Resume or fork sessions
66	  * The context window
67	    * When context fills up
68	    * Manage context with skills and subagents
69	* Stay safe with checkpoints and permissions
70	  * Undo changes with checkpoints
71	  * Control what Claude can do
72	* Work effectively with Claude Code
73	  * Ask Claude Code for help
74	  * It's a conversation
75	    * Interrupt and steer
76	  * Be specific upfront
77	  * Give Claude something to verify against
78	  * Explore before implementing
79	  * Delegate, don't dictate
80	* What's next
81
82	### [features-overview](https://code.claude.com/docs/en/features-overview.md)
83
84	* Overview
85	* Match features to your goal
86	  * Build your setup over time
87	  * Compare similar features
88	  * Understand how features layer
89	  * Combine features
90	* Understand context costs
91	  * Context cost by feature
92	  * Understand how features load
93	* Learn more
94
95	### [claude-directory](https://code.claude.com/docs/en/claude-directory.md)
96
97	* Explore the directory
98	* What's not shown
99	* Choose the right file
100	* File reference
101	* Troubleshoot configuration
102	* Application data
103	  * Cleaned up automatically
104	  * Kept until you delete them
105	  * Plaintext storage
106	  * Clear local data
107	* Related resources
108
109	### [context-window](https://code.claude.com/docs/en/context-window.md)
110
111	* What the timeline shows
112	* What survives compaction
113	* When your context fills up
114	* Check your own session
115	* Related resources
116
117	### [prompt-caching](https://code.claude.com/docs/en/prompt-caching.md)
118
119	* How the cache is organized
120	  * Where the cache lives
121	* Actions that invalidate the cache
122	  * Switching models
123	  * Changing effort level
124	  * Turning on fast mode
125	  * Connecting or disconnecting an MCP server
126	  * Enabling or disabling a plugin
127	  * Denying an entire tool
128	  * Compacting the conversation
129	  * Upgrading Claude Code
130	* Actions that keep the cache
131	  * Editing files in your repository
132	  * Editing CLAUDE.md mid-session
133	  * Changing output style
134	  * Changing permission mode
135	  * Invoking skills and commands
136	  * Running `/recap`
137	  * Rewinding the conversation
138	* Cache lifetime
139	  * On a Claude subscription
140	  * On an API key or third-party provider
141	  * Override the TTL
142	* Cache scope
143	* Check cache performance
144	* Subagents and the cache
145	* Disable prompt caching
146	* Related resources
147
148	## Use Claude Code
149
150	### [memory](https://code.claude.com/docs/en/memory.md)
151
152	* CLAUDE.md vs auto memory
153	* CLAUDE.md files
154	  * When to add to CLAUDE.md
155	  * Choose where to put CLAUDE.md files
156	  * Set up a project CLAUDE.md
157	  * Write effective instructions
158	  * Import additional files
159	  * AGENTS.md
160	  * How CLAUDE.md files load
161	    * Load from additional directories
162	  * Organize rules with `.claude/rules/`
163	    * Set up rules
164	    * Path-specific rules
165	    * Share rules across projects with symlinks
166	    * User-level rules
167	  * Manage CLAUDE.md for large teams
168	    * Deploy organization-wide CLAUDE.md
169	    * Exclude specific CLAUDE.md files
170	* Auto memory
171	  * Enable or disable auto memory
172	  * Storage location
173	  * How it works
174	  * Audit and edit your memory
175	* View and edit with `/memory`
176	* Troubleshoot memory issues
177	  * Claude isn't following my CLAUDE.md
178	  * I don't know what auto memory saved
179	  * My CLAUDE.md is too large
180	  * Instructions seem lost after `/compact`
181	* Related resources
182
183	### [permission-modes](https://code.claude.com/docs/en/permission-modes.md)
184
185	* Available modes
186	* Switch permission modes
187	* Auto-approve file edits with acceptEdits mode
188	* Analyze before you edit with plan mode
189	  * Review and approve a plan
190	  * Set plan mode as the default
191	* Eliminate permission prompts with auto mode
192	  * Enable auto mode on Bedrock, Agent Platform, or Foundry
193	  * What the classifier blocks by default
194	  * Boundaries you state in conversation
195	  * When auto mode falls back
196	* Allow only pre-approved tools with dontAsk mode
197	* Skip all checks with bypassPermissions mode
198	* Protected paths
199	* See also
200
201	### [sessions](https://code.claude.com/docs/en/sessions.md)
202
203	* Resume a session
204	  * Where the session picker looks
205	* Name your sessions
206	* Use the session picker
207	* Branch a session
208	* Manage context within a session
209	* Export and locate session data
210	  * Access conversations from scripts
211	  * Where transcripts are stored
212	* See also
213
214	### [common-workflows](https://code.claude.com/docs/en/common-workflows.md)
215
216	* Prompt recipes
217	  * Understand new codebases
218	    * Get a quick codebase overview
219	    * Find relevant code
220	  * Fix bugs efficiently
221	  * Refactor code
222	  * Work with tests
223	  * Create pull requests
224	  * Handle documentation
225	  * Work in notes and non-code folders
226	  * Work with images
227	  * Reference files and directories
228	  * Run Claude on a schedule
229	  * Ask Claude about its capabilities
230	    * Example questions
231	* Resume previous conversations
232	* Run parallel sessions with worktrees
233	* Plan before editing
234	* Delegate research to subagents
235	* Pipe Claude into scripts
236	* Next steps
237
238	### [prompt-library](https://code.claude.com/docs/en/prompt-library.md)
239
240	* What makes these prompts work
241	* Where these come from
242	* Related resources
243
244	### [best-practices](https://code.claude.com/docs/en/best-practices.md)
245
246	* Give Claude a way to verify its work
247	* Explore first, then plan, then code
248	* Provide specific context in your prompts
249	  * Provide rich content
250	* Configure your environment
251	  * Write an effective CLAUDE.md
252	  * Configure permissions
253	  * Use CLI tools
254	  * Connect MCP servers
255	  * Set up hooks
256	  * Create skills
257	  * Create custom subagents
258	  * Install plugins
259	* Communicate effectively
260	  * Ask codebase questions
261	  * Let Claude interview you
262	* Manage your session
263	  * Course-correct early and often
264	  * Manage context aggressively
265	  * Use subagents for investigation
266	  * Rewind with checkpoints
267	  * Resume conversations
268	* Automate and scale
269	  * Run non-interactive mode
270	  * Run multiple Claude sessions
271	  * Fan out across files
272	  * Run autonomously with auto mode
273	  * Add an adversarial review step
274	* Avoid common failure patterns
275	* Develop your intuition
276	* Related resources
277
278	### Platforms and integrations > Claude Code on the web
279
280	#### [web-quickstart](https://code.claude.com/docs/en/web-quickstart.md)
281
282	* How sessions run
283	* Compare ways to run Claude Code
284	* Connect GitHub and create an environment
285	  * Connect from your terminal
286	* Start a task
287	* Pre-fill sessions
288	* Review and iterate
289	* Troubleshoot setup
290	  * No repositories appear after connecting GitHub
291	  * The page only shows a GitHub login button
292	  * "Not available for the selected organization"
293	  * `/web-setup` shows "No commands match" or "Unknown command"
294	  * "Could not create a cloud environment" or "No cloud environment available" when using `--cloud` or ultraplan
295	  * Setup script failed
296	  * New sessions hang or time out during setup
297	  * Session keeps running after closing the tab
298	* Next steps
299
300	#### [claude-code-on-the-web](https://code.claude.com/docs/en/claude-code-on-the-web.md)
301
302	* GitHub authentication options
303	* The cloud environment
304	  * What's available in cloud sessions
305	  * Installed tools
306	  * Work with GitHub issues and pull requests
307	  * Link output back to the session
308	  * Run tests, start services, and add packages
309	  * Resource limits
310	  * Configure your environment
311	* Setup scripts
312	  * Environment caching
313	  * Setup scripts vs. SessionStart hooks
314	  * Install dependencies with a SessionStart hook
315	* Network access
316	  * Access levels
317	  * Allow specific domains
318	  * GitHub proxy
319	  * Security proxy
320	  * Default allowed domains
321	* Move tasks between web and terminal
322	  * From terminal to web
323	    * Tips for cloud tasks
324	    * Send local repositories without GitHub
325	  * From web to terminal
326	    * Teleport requirements
327	    * `--teleport` is unavailable
328	* Work with sessions
329	  * Manage context
330	  * Review changes
331	  * Share sessions
332	    * Share from an Enterprise or Team account
333	    * Share from a Max or Pro account
334	  * Archive sessions
335	  * Delete sessions
336	* Auto-fix pull requests
337	  * How Claude responds to PR activity
338	* Security and isolation
339	* Troubleshooting
340	  * Session creation failed
341	  * Remote Control session expired or access denied
342	  * Environment expired
343	* Limitations
344	* Related resources
345
346	#### [routines](https://code.claude.com/docs/en/routines.md)
347
348	* Example use cases
349	* Create a routine
350	  * Create from the web
351	  * Create from the CLI
352	* Configure triggers
353	  * Add a schedule trigger
354	    * Schedule a one-off run
355	  * Add an API trigger
356	    * Trigger a routine
357	    * API reference
358	  * Add a GitHub trigger
359	    * Supported events
360	    * Filter pull requests
361	    * How sessions map to events
362	* Manage routines
363	  * View and interact with runs
364	  * Edit and control routines
365	  * Repositories and branch permissions
366	  * Connectors
367	  * Environments and network access
368	* Usage and limits
369	* Troubleshooting
370	  * `/schedule` shows "No commands match" or "Unknown command"
371	  * "Routines are disabled by your organization's policy"
372	* Related resources
373
374	#### [ultraplan](https://code.claude.com/docs/en/ultraplan.md)
375
376	* Launch ultraplan from the CLI
377	* Review and revise the plan in your browser
378	* Choose where to execute
379	  * Execute on the web
380	  * Send the plan back to your terminal
381	* Related resources
382
383	#### [ultrareview](https://code.claude.com/docs/en/ultrareview.md)
384
385	* Run ultrareview from the CLI
386	* Pricing and free runs
387	* Track a running review
388	* Run ultrareview non-interactively
389	* How ultrareview compares to /code-review and /review
390	* Related resources
391
392	### Platforms and integrations > Claude Code on desktop
393
394	#### [desktop-quickstart](https://code.claude.com/docs/en/desktop-quickstart.md)
395
396	* Install
397	* Start your first session
398	* Now what?
399	* Coming from the CLI?
400	* What's next
401
402	#### [desktop](https://code.claude.com/docs/en/desktop.md)
403
404	* Start a session
405	* Work with code
406	  * Use the prompt box
407	  * Add files and context to prompts
408	  * Choose a permission mode
409	  * Preview your app
410	  * Browse external sites
411	    * Approve Claude's actions on a site
412	    * Choose between the Browser and the Chrome extension
413	    * Restrict external browsing for your organization
414	  * Review changes with diff view
415	  * Review your code
416	  * Monitor pull request status
417	* Arrange your workspace
418	  * Run commands in the terminal
419	  * Open and edit files
420	  * Open files in other apps
421	  * Switch view modes
422	  * Keyboard shortcuts
423	  * Check usage
424	* Let Claude use your computer
425	  * When computer use applies
426	  * Enable computer use
427	  * App permissions
428	* Manage sessions
429	  * Work in parallel with sessions
430	  * Ask a side question without derailing the session
431	  * Watch background tasks
432	  * Run long-running tasks remotely
433	  * Continue in another surface
434	  * Sessions from Dispatch
435	* Extend Claude Code
436	  * Connect external tools
437	  * Use skills
438	  * Install plugins
439	  * Configure preview servers
440	    * Auto-verify changes
441	    * Configuration fields
442	      * When to use `program` vs `runtimeExecutable`
443	    * Port conflicts
444	    * Examples
445	* Environment configuration
446	  * Local sessions
447	  * Cloud sessions
448	  * SSH sessions
449	    * Pre-configure SSH connections for your team
450	    * Restrict which SSH hosts users can connect to
451	* Enterprise configuration
452	  * Admin console controls
453	  * Managed settings
454	  * Device management policies
455	  * Authentication and SSO
456	  * Data handling
457	  * Deployment
458	* Coming from the CLI?
459	  * CLI flag equivalents
460	  * Shared configuration
461	  * Feature comparison
462	  * What's not available in Desktop
463	* Troubleshooting
464	  * Check your version
465	  * 403 or authentication errors in the Code tab
466	  * Blank or stuck screen on launch
467	  * "Failed to load session"
468	  * Session not finding installed tools
469	  * Git and Git LFS errors
470	  * MCP servers not working on Windows
471	  * App won't quit
472	  * Windows-specific issues
473	  * "Branch doesn't exist yet" when opening in CLI
474	  * Still stuck?
475
476	#### [desktop-linux](https://code.claude.com/docs/en/desktop-linux.md)
477
478	* Requirements
479	* Install
480	  * Install from a downloaded file
481	* Update
482	* Uninstall
483	* Troubleshoot
484	  * Unable to locate package claude-desktop
485	* What's not in the Linux beta yet
486
487	#### [desktop-scheduled-tasks](https://code.claude.com/docs/en/desktop-scheduled-tasks.md)
488
489	* Compare scheduling options
490	* Create a scheduled task
491	* Schedule options
492	* How scheduled tasks run
493	* Missed runs
494	* Permissions for scheduled tasks
495	* Manage scheduled tasks
496	* Related resources
497
498	### Platforms and integrations > Code review & CI/CD
499
500	#### [security-guidance](https://code.claude.com/docs/en/security-guidance.md)
501
502	* Prerequisites
503	* Install the plugin
504	  * Enable in cloud sessions and shared repositories
505	* What the plugin checks
506	  * On each file edit
507	  * At the end of each turn
508	  * On each commit or push Claude makes
509	  * Review independence and limits
510	* Add your own rules
511	  * Add guidance for the model-backed reviews
512	  * Add custom per-edit patterns
513	  * Rule file lookup locations
514	* Usage cost
515	* Disable or uninstall
516	* How the plugin integrates with Claude Code
517	* How this fits with other security tools
518	* Troubleshooting
519	* Related resources
520
521	#### [code-review](https://code.claude.com/docs/en/code-review.md)
522
523	* How reviews work
524	  * Severity levels
525	  * Rate and reply to findings
526	  * Check run output
527	  * What Code Review checks
528	* Set up Code Review
529	* Manually trigger reviews
530	* Customize reviews
531	  * CLAUDE.md
532	  * REVIEW\.md
533	    * What you can tune
534	    * Example
535	    * Keep it focused
536	* View usage
537	* Pricing
538	* Troubleshooting
539	  * Retrigger a failed or timed-out review
540	  * Review didn't run and the PR shows a spend-cap message
541	  * Find issues that aren't showing as inline comments
542	* Review a diff locally
543	* Related resources
544
545	#### [github-actions](https://code.claude.com/docs/en/github-actions.md)
546
547	* Why use Claude Code GitHub Actions?
548	* What can Claude do?
549	  * Claude Code Action
550	* Setup
551	* Quick setup
552	* Manual setup
553	* Upgrading from Beta
554	  * Essential changes
555	  * Breaking Changes Reference
556	  * Before and After Example
557	* Example use cases
558	  * Basic workflow
559	  * Using skills
560	  * Custom automation with prompts
561	  * Common use cases
562	* Best practices
563	  * CLAUDE.md configuration
564	  * Security considerations
565	  * Optimizing performance
566	  * CI costs
567	* Configuration examples
568	* Using with Amazon Bedrock and Google Cloud
569	  * Prerequisites
570	    * For Google Cloud's Agent Platform:
571	    * For Amazon Bedrock:
572	* Troubleshooting
573	  * Claude not responding to @claude commands
574	  * CI not running on Claude's commits
575	  * Authentication errors
576	* Advanced configuration
577	  * Action parameters
578	    * Pass CLI arguments
579	  * Alternative integration methods
580	  * Customizing Claude's behavior
581
582	#### [github-enterprise-server](https://code.claude.com/docs/en/github-enterprise-server.md)
583
584	* What works with GitHub Enterprise Server
585	* Admin setup
586	  * GitHub App permissions
587	  * Manual setup
588	  * Network requirements
589	* Developer workflow
590	  * Teleport sessions to your terminal
591	* Plugin marketplaces on GHES
592	  * Add a GHES marketplace
593	  * Pre-register GHES marketplaces with managed settings
594	  * Allowlist GHES marketplaces in managed settings
595	* Limitations
596	* Troubleshooting
597	  * Web session fails to clone repository
598	  * Marketplace add fails with a policy error
599	  * Marketplace add on claude.ai fails with a GitHub access error
600	  * GHES instance not reachable
601	* Related resources
602
603	#### [gitlab-ci-cd](https://code.claude.com/docs/en/gitlab-ci-cd.md)
604
605	* Why use Claude Code with GitLab?
606	* How it works
607	* What can Claude do?
608	* Setup
609	  * Quick setup
610	  * Manual setup (recommended for production)
611	* Example use cases
612	  * Turn issues into MRs
613	  * Get implementation help
614	  * Fix bugs quickly
615	* Using with Amazon Bedrock and Google Cloud
616	* Configuration examples
617	  * Basic .gitlab-ci.yml (Claude API)
618	  * Amazon Bedrock job example (OIDC)
619	  * Agent Platform job example (Workload Identity Federation)
620	* Best practices
621	  * CLAUDE.md configuration
622	  * Security considerations
623	  * Optimizing performance
624	  * CI costs
625	* Security and governance
626	* Troubleshooting
627	  * Claude not responding to @claude commands
628	  * Job can't write comments or open MRs
629	  * Authentication errors
630	* Advanced configuration
631	  * Common parameters and variables
632	  * Customizing Claude's behavior
633
634	## Platforms and integrations
635
636	### [platforms](https://code.claude.com/docs/en/platforms.md)
637
638	* Where to run Claude Code
639	* Connect your tools
640	* Work when you are away from your terminal
641	* Related resources
642	  * Platforms
643	  * Integrations
644	  * Remote access
645
646	### [remote-control](https://code.claude.com/docs/en/remote-control.md)
647
648	* Requirements
649	* Start a Remote Control session
650	  * Check connection status
651	  * Connect from another device
652	  * Enable Remote Control for all sessions
653	* Connection and security
654	* Trusted Devices
655	  * Enable Trusted Devices for your organization
656	  * What members see
657	  * Manage enrolled devices
658	* Remote Control vs Claude Code on the web
659	* Mobile push notifications
660	* Limitations
661	* Troubleshooting
662	  * "Remote Control requires a claude.ai subscription"
663	  * "Remote Control requires a full-scope login token"
664	  * "Unable to determine your organization for Remote Control eligibility"
665	  * "Remote Control is not yet enabled for your account"
666	  * "Couldn't verify Remote Control eligibility"
667	  * "Remote Control is only available when using Claude via api.anthropic.com"
668	  * "Remote Control is disabled by your organization's policy"
669	  * "Remote credentials fetch failed"
670	  * "Couldn't reconnect to your Remote Control session"
671	  * "Your organization requires Trusted Devices for Remote Control, but this device is not enrolled"
672	  * "session expired for trusted-device check"
673	* Choose the right approach
674	* Related resources
675
676	### [chrome](https://code.claude.com/docs/en/chrome.md)
677
678	* Capabilities
679	* Prerequisites
680	* Get started in the CLI
681	  * Enable Chrome by default
682	  * Manage site permissions
683	  * Browser tools in plan mode
684	* Example workflows
685	  * Test a local web application
686	  * Debug with console logs
687	  * Automate form filling
688	  * Draft content in Google Docs
689	  * Extract data from web pages
690	  * Run multi-site workflows
691	  * Record a demo GIF
692	* Troubleshooting
693	  * Extension not detected
694	  * Browser not responding
695	  * Connection drops during long sessions
696	  * Windows-specific issues
697	  * Common error messages
698	* See also
699
700	### [computer-use](https://code.claude.com/docs/en/computer-use.md)
701
702	* What you can do with computer use
703	* When computer use applies
704	* Enable computer use
705	* Approve apps per session
706	* How Claude works on your screen
707	  * One session at a time
708	  * Apps are hidden while Claude works
709	  * Screenshots are downscaled automatically
710	  * Stop at any time
711	* Safety and the trust boundary
712	* Example workflows
713	  * Validate a native build
714	  * Reproduce a layout bug
715	  * Test a simulator flow
716	* Differences from the Desktop app
717	* Troubleshooting
718	  * "Computer use is in use by another Claude session"
719	  * macOS permissions prompt keeps reappearing
720	  * `computer-use` doesn't appear in `/mcp`
721	* See also
722
723	### [vs-code](https://code.claude.com/docs/en/vs-code.md)
724
725	* Prerequisites
726	* Install the extension
727	* Get started
728	* Use the prompt box
729	  * Reference files and folders
730	  * Resume past conversations
731	  * Resume cloud sessions from Claude.ai
732	  * Check account and usage
733	* Customize your workflow
734	  * Choose where Claude lives
735	  * Run multiple conversations
736	  * Switch to terminal mode
737	* Manage plugins
738	  * Install plugins
739	  * Manage marketplaces
740	* Automate browser tasks with Chrome
741	* VS Code commands and shortcuts
742	  * Launch a VS Code tab from other tools
743	* Configure settings
744	  * Extension settings
745	* VS Code extension vs. Claude Code CLI
746	  * Rewind with checkpoints
747	  * Run CLI in VS Code
748	  * Switch between extension and CLI
749	  * Include terminal output in prompts
750	  * Monitor background processes
751	  * Connect to external tools with MCP
752	* Work with git
753	  * Create commits and pull requests
754	  * Use git worktrees for parallel tasks
755	* Use third-party providers
756	* Security and privacy
757	  * The built-in IDE MCP server
758	* Fix common issues
759	  * Extension won't install
760	  * Spark icon not visible
761	  * Cmd+Esc does nothing on macOS
762	  * Claude Code never responds
763	* Uninstall the extension
764	* Next steps
765
766	### [jetbrains](https://code.claude.com/docs/en/jetbrains.md)
767
768	* Supported IDEs
769	* Features
770	* Installation
771	* Usage
772	  * From your IDE
773	  * From external terminals
774	* Configuration
775	  * Claude Code settings
776	  * Plugin settings
777	    * General settings
778	    * ESC key configuration
779	* Special configurations
780	  * Remote development
781	  * WSL configuration
782	    * Allow WSL2 traffic through Windows Firewall
783	    * Switch WSL2 to mirrored networking
784	* Troubleshooting
785	  * Plugin not working
786	  * IDE not detected
787	  * Command not found
788	* Security considerations
789
790	### [slack](https://code.claude.com/docs/en/slack.md)
791
792	* Use cases
793	* Prerequisites
794	* Setting up Claude Code in Slack
795	* How it works
796	  * Automatic detection
797	  * Context gathering
798	  * Session flow
799	* User interface elements
800	  * App Home
801	  * Message actions
802	  * Repository selection
803	* Access and permissions
804	  * User-level access
805	  * Workspace-level access
806	  * Channel-based access control
807	* What's accessible where
808	* Best practices
809	  * Writing effective requests
810	  * When to use Slack vs. web
811	* Troubleshooting
812	  * "Claude Code is not enabled for your account"
813	  * Sessions not starting
814	  * Repository not showing
815	  * Wrong repository selected
816	  * Authentication errors
817	  * Session expiration
818	* Current limitations
819	* Related resources
820
821	## Agents and parallel work
822
823	### [agents](https://code.claude.com/docs/en/agents.md)
824
825	* Choose an approach
826	* Check on running work
827	* Learn more
828
829	### [sub-agents](https://code.claude.com/docs/en/sub-agents.md)
830
831	* Built-in subagents
832	* Quickstart: create your first subagent
833	* Configure subagents
834	  * Choose the subagent scope
835	  * Write subagent files
836	    * Supported frontmatter fields
837	  * Choose a model
838	  * Control subagent capabilities
839	    * Available tools
840	    * Restrict which subagents can be spawned
841	    * Scope MCP servers to a subagent
842	    * Permission modes
843	    * Preload skills into subagents
844	    * Enable persistent memory
845	      * Persistent memory tips
846	    * Conditional rules with hooks
847	    * Disable specific subagents
848	  * Define hooks for subagents
849	    * Hooks in subagent frontmatter
850	    * Project-level hooks for subagent events
851	* Work with subagents
852	  * Understand automatic delegation
853	  * Invoke subagents explicitly
854	  * Run subagents in foreground or background
855	  * API errors in subagents
856	  * Common patterns
857	    * Isolate high-volume operations
858	    * Run parallel research
859	    * Chain subagents
860	  * Choose between subagents and main conversation
861	  * Spawn nested subagents
862	  * Manage subagent context
863	    * What loads at startup
864	    * Resume subagents
865	    * Auto-compaction
866	* Fork the current conversation
867	  * Observe and steer running forks
868	  * How forks differ from named subagents
869	  * Limitations
870	* Example subagents
871	  * Code reviewer
872	  * Debugger
873	  * Data scientist
874	  * Database query validator
875	* Next steps
876
877	### [agent-view](https://code.claude.com/docs/en/agent-view.md)
878
879	* Quick start
880	* Monitor sessions with agent view
881	  * Read session state
882	  * Row summaries
883	  * Pull request status
884	  * Peek and reply
885	  * Attach to a session
886	  * Organize the list
887	  * Filter sessions
888	  * Keyboard shortcuts
889	* Dispatch new agents
890	  * From agent view
891	    * Dispatch to a specific directory
892	  * From inside a session
893	  * From your shell
894	    * Run a shell command
895	  * How file edits are isolated
896	  * Set the model
897	  * Permission mode, model, and effort
898	  * Settings, plugins, and MCP servers
899	* Manage sessions from the shell
900	* How background sessions are hosted
901	  * The supervisor process
902	  * Where state is stored
903	  * Turn off agent view
904	* Troubleshooting
905	  * `claude agents` lists subagents instead of opening agent view
906	  * Agent view opens with no sessions
907	  * Backgrounding shows a `Background this session?` dialog
908	  * Prompt rejected as too short
909	  * Sessions show as failed after shutdown
910	  * Opening a session says the conversation is already open
911	  * A session fails before starting with a `possibly low memory` note
912	  * Agent view says the background service did not respond
913	  * Dispatch fails with `Could not resolve authentication method`
914	  * Background sessions can't read Desktop, Documents, or Downloads on macOS
915	  * Background sessions can't reach local-network hosts on macOS
916	  * A session is slow to respond after attaching
917	  * `.claude/worktrees/` is filling up
918	* Limitations
919	* Related resources
920	* Version history
921
922	### [agent-teams](https://code.claude.com/docs/en/agent-teams.md)
923
924	* When to use agent teams
925	  * Compare with subagents
926	* Enable agent teams
927	* Start your first agent team
928	* Control your agent team
929	  * Choose a display mode
930	  * Specify teammates and models
931	  * Require plan approval for teammates
932	  * Talk to teammates directly
933	  * Assign and claim tasks
934	  * Shut down teammates
935	  * Enforce quality gates with hooks
936	* How agent teams work
937	  * How Claude starts agent teams
938	  * Architecture
939	  * Use subagent definitions for teammates
940	  * Permissions
941	  * Context and communication
942	  * Token usage
943	* Use case examples
944	  * Run a parallel code review
945	  * Investigate with competing hypotheses
946	* Best practices
947	  * Give teammates enough context
948	  * Choose an appropriate team size
949	  * Size tasks appropriately
950	  * Wait for teammates to finish
951	  * Start with research and review
952	  * Avoid file conflicts
953	  * Monitor and steer
954	* Troubleshooting
955	  * Teammates not appearing
956	  * Too many permission prompts
957	  * Teammates stopping on errors
958	  * Lead shuts down before work is done
959	  * Orphaned tmux sessions
960	* Limitations
961	* Next steps
962
963	### [workflows](https://code.claude.com/docs/en/workflows.md)
964
965	* When to use a workflow
966	* Run a bundled workflow
967	  * Bundled workflows
968	  * Watch the run
969	* Have Claude write a workflow
970	  * Ask for a workflow in your prompt
971	  * Let Claude decide with ultracode
972	  * Approve the plan before it runs
973	  * Save the workflow for reuse
974	  * Pass input to a saved workflow
975	* Example workflow prompts
976	  * Audit many files for the same issue
977	  * Keep fixing until a check passes
978	  * Migrate many files in parallel
979	  * Review every changed file and write one summary
980	  * Research a topic across many sources
981	  * Find issues until the list stops growing
982	  * What the saved script looks like
983	* How a workflow runs
984	  * Behavior and limits
985	* Manage runs
986	  * Resume after a pause
987	  * Cost
988	  * Set a size guideline
989	  * Turn workflows off
990	* Related resources
991
992	### [worktrees](https://code.claude.com/docs/en/worktrees.md)
993
994	* Start Claude in a worktree
995	  * Choose the base branch
996	* Copy gitignored files into worktrees
997	* Isolate subagents with worktrees
998	* Clean up worktrees
999	* Manage worktrees manually
1000	* Non-git version control
1001	* See also
1002
1003	## MCP
1004
1005	### [mcp-quickstart](https://code.claude.com/docs/en/mcp-quickstart.md)
1006
1007	* Before you begin
1008	* Add and verify a server
1009	* Where servers are saved
1010	  * Find your configuration on disk
1011	* Change server scope
1012	  * Use a server in all your projects
1013	  * Share a server with your team
1014	* Additional MCP server examples
1015	  * Add a local server
1016	  * Connect a server that requires sign-in
1017	* Edit .mcp.json directly
1018	* Connect from other surfaces
1019	* Troubleshooting
1020	* Next steps
1021
1022	### [mcp](https://code.claude.com/docs/en/mcp.md)
1023
1024	* What you can do with MCP
1025	* Find and build MCP servers
1026	* Installing MCP servers
1027	  * Option 1: Add a remote HTTP server
1028	  * Option 2: Add a remote SSE server
1029	  * Option 3: Add a local stdio server
1030	  * Option 4: Add a remote WebSocket server
1031	  * Managing your servers
1032	  * Dynamic tool updates
1033	  * Automatic reconnection
1034	  * Push messages with channels
1035	  * Plugin-provided MCP servers
1036	* MCP installation scopes
1037	  * Local scope
1038	  * Project scope
1039	  * User scope
1040	  * Scope hierarchy and precedence
1041	  * Environment variable expansion in `.mcp.json`
1042	* Practical examples
1043	  * Example: Monitor errors with Sentry
1044	  * Example: Connect to GitHub for code reviews
1045	  * Example: Query your PostgreSQL database
1046	* Authenticate with remote MCP servers
1047	  * Authenticate from the command line
1048	  * Use a fixed OAuth callback port
1049	  * Use pre-configured OAuth credentials
1050	  * Override OAuth metadata discovery
1051	  * Restrict OAuth scopes
1052	  * Use dynamic headers for custom authentication
1053	* Add MCP servers from JSON configuration
1054	* Import MCP servers from Claude Desktop
1055	* Use MCP servers from claude.ai
1056	  * Disable claude.ai connectors
1057	* Use Claude Code as an MCP server
1058	* MCP output limits and warnings
1059	  * Raise the limit for a specific tool
1060	* Tool input schemas with a root-level combinator
1061	* Require approval for a specific tool
1062	* Respond to MCP elicitation requests
1063	* Use MCP resources
1064	  * Reference MCP resources
1065	* Scale with MCP tool search
1066	  * How it works
1067	  * For MCP server authors
1068	  * Configure tool search
1069	  * Exempt a server from deferral
1070	* Use MCP prompts as commands
1071	  * Execute MCP prompts
1072	* Managed MCP configuration
1073
1074	## Skills
1075
1076	### [skills](https://code.claude.com/docs/en/skills.md)
1077
1078	* Bundled skills
1079	  * Run and verify your app
1080	* Getting started
1081	  * Create your first skill
1082	  * Where skills live
1083	    * Live change detection
1084	    * Automatic discovery from parent and nested directories
1085	    * Skills from additional directories
1086	* Configure skills
1087	  * Types of skill content
1088	  * Frontmatter reference
1089	    * How a skill gets its command name
1090	    * Available string substitutions
1091	  * Add supporting files
1092	  * Control who invokes a skill
1093	  * Skill content lifecycle
1094	  * Pre-approve tools for a skill
1095	  * Pass arguments to skills
1096	* Advanced patterns
1097	  * Inject dynamic context
1098	  * Run skills in a subagent
1099	    * Example: Research skill using Explore agent
1100	  * Restrict Claude's skill access
1101	  * Override skill visibility from settings
1102	* Evaluate and iterate on a skill
1103	  * Run evals with skill-creator
1104	* Share skills
1105	  * Generate visual output
1106	* Troubleshooting
1107	  * Skill not triggering
1108	  * Skill triggers too often
1109	  * Skill descriptions are cut short
1110	* Related resources
1111
1112	## Plugins
1113
1114	### [discover-plugins](https://code.claude.com/docs/en/discover-plugins.md)
1115
1116	* How marketplaces work
1117	* Official Anthropic marketplace
1118	  * Code intelligence
1119	    * What Claude gains from code intelligence plugins
1120	  * External integrations
1121	  * Automatic security review
1122	  * Development workflows
1123	  * Output styles
1124	* Community marketplace
1125	* Try it: add the demo marketplace
1126	* Add marketplaces
1127	  * Add from GitHub
1128	  * Add from other Git hosts
1129	  * Add from local paths
1130	  * Add from remote URLs
1131	* Install plugins
1132	* Manage installed plugins
1133	  * Apply plugin changes without restarting
1134	* Manage marketplaces
1135	  * Use the interactive interface
1136	  * Use CLI commands
1137	  * Configure auto-updates
1138	* Configure team marketplaces
1139	* Security
1140	* Troubleshooting
1141	  * /plugin command not recognized
1142	  * Common issues
1143	  * Code intelligence issues
1144	* Next steps
1145
1146	### [plugins](https://code.claude.com/docs/en/plugins.md)
1147
1148	* When to use plugins vs standalone configuration
1149	* Quickstart
1150	  * Prerequisites
1151	  * Create your first plugin
1152	* Develop a plugin in your skills directory
1153	* Plugin structure overview
1154	* Develop more complex plugins
1155	  * Add Skills to your plugin
1156	  * Add LSP servers to your plugin
1157	  * Add background monitors to your plugin
1158	  * Ship default settings with your plugin
1159	  * Organize complex plugins
1160	  * Test your plugins locally
1161	  * Debug plugin issues
1162	  * Share your plugins
1163	  * Submit your plugin to the community marketplace
1164	* Convert existing configurations to plugins
1165	  * Migration steps
1166	  * What changes when migrating
1167	* Next steps
1168	  * For plugin users
1169	  * For plugin developers
1170
1171	## Artifacts
1172
1173	### [artifacts](https://code.claude.com/docs/en/artifacts.md)
1174
1175	* When to use an artifact
1176	  * What an artifact is not
1177	* Create an artifact
1178	* Update an artifact
1179	* Share an artifact
1180	* What you can build
1181	  * Walk through a change
1182	  * Compare alternatives
1183	  * Tune with interactive controls
1184	  * Bring the result back to your session
1185	  * Track work in progress
1186	* Improve the visual design
1187	* Page constraints
1188	* Availability
1189	* Disable artifacts
1190	* Manage artifacts for your organization
1191	  * Enable or disable artifacts
1192	  * Set a retention policy
1193	  * Review the audit log
1194	  * Allowlist the viewer domain
1195	  * List and delete artifacts with the Compliance API
1196	* Related resources
1197
1198	## Automation
1199
1200	### [hooks-guide](https://code.claude.com/docs/en/hooks-guide.md)
1201
1202	* Set up your first hook
1203	* What you can automate
1204	  * Get notified when Claude needs input
1205	  * Auto-format code after edits
1206	  * Block edits to protected files
1207	  * Re-inject context after compaction
1208	  * Audit configuration changes
1209	  * Reload environment when directory or files change
1210	  * Auto-approve specific permission prompts
1211	* How hooks work
1212	  * Combine results from multiple hooks
1213	  * Read input and return output
1214	    * Hook input
1215	    * Hook output
1216	    * Structured JSON output
1217	  * Filter hooks with matchers
1218	    * Filter by tool name and arguments with the `if` field
1219	  * Configure hook location
1220	* Prompt-based hooks
1221	* Agent-based hooks
1222	* HTTP hooks
1223	* Limitations and troubleshooting
1224	  * Limitations
1225	  * Hooks and permission modes
1226	  * Hook not firing
1227	  * Hook error in output
1228	  * `/hooks` shows no hooks configured
1229	  * Stop hook hits the block cap
1230	  * JSON validation failed
1231	  * Debug techniques
1232	* Learn more
1233
1234	### [channels](https://code.claude.com/docs/en/channels.md)
1235
1236	* Supported channels
1237	* Quickstart
1238	* Security
1239	* Enterprise controls
1240	  * Enable channels for your organization
1241	  * Restrict which channel plugins can run
1242	* Research preview
1243	* How channels compare
1244	* Next steps
1245
1246	### [scheduled-tasks](https://code.claude.com/docs/en/scheduled-tasks.md)
1247
1248	* Compare scheduling options
1249	* Run a prompt repeatedly with /loop
1250	  * Run on a fixed interval
1251	  * Let Claude choose the interval
1252	  * Run the built-in maintenance prompt
1253	  * Customize the default prompt with loop.md
1254	  * Stop a loop
1255	* Set a one-time reminder
1256	* Manage scheduled tasks
1257	* How scheduled tasks run
1258	  * Jitter
1259	  * Seven-day expiry
1260	* Cron expression reference
1261	* Disable scheduled tasks
1262	* Limitations
1263
1264	### [goal](https://code.claude.com/docs/en/goal.md)
1265
1266	* Compare ways to keep a session running
1267	* Use `/goal`
1268	  * Set a goal
1269	  * Write an effective condition
1270	  * Check status
1271	  * Clear a goal
1272	  * Resume with an active goal
1273	  * Run non-interactively
1274	* How evaluation works
1275	* Requirements
1276	* See also
1277
1278	### [headless](https://code.claude.com/docs/en/headless.md)
1279
1280	* Basic usage
1281	  * Start faster with bare mode
1282	  * Background tasks at exit
1283	* Examples
1284	  * Pipe data through Claude
1285	  * Add Claude to a build script
1286	  * Get structured output
1287	  * Stream responses
1288	  * Auto-approve tools
1289	  * Create a commit
1290	  * Customize the system prompt
1291	  * Continue conversations
1292	* Next steps
1293
1294	### [deep-links](https://code.claude.com/docs/en/deep-links.md)
1295
1296	* How it works
1297	  * What a launched session shows
1298	* Build a link
1299	  * Choose between `cwd` and `repo`
1300	* Examples
1301	  * Embed a link in a runbook
1302	  * Open a link from the shell
1303	* Registration and supported platforms
1304	* Open a VS Code tab instead of a terminal
1305	* Troubleshooting
1306	  * Clicking the link does nothing
1307	  * The link renders as plain text instead of being clickable
1308	  * The session opens in my home directory instead of the repo
1309	  * The link opens the wrong terminal
1310	* Learn more
1311
1312	## Guides
1313
1314	### [large-codebases](https://code.claude.com/docs/en/large-codebases.md)
1315
1316	* What this guide covers
1317	  * Settings on this page
1318	  * The example monorepo
1319	* Choose where to start Claude
1320	* Layer CLAUDE.md files by directory
1321	  * Choose between per-directory CLAUDE.md and path-scoped rules
1322	  * Exclude irrelevant CLAUDE.md files
1323	* Reduce what Claude reads
1324	  * Block reads of generated and vendored code
1325	  * Reduce file reads with code intelligence
1326	* Scope worktrees and file access
1327	  * Check out only the directories you need
1328	  * Grant access across packages or repositories
1329	* Add per-directory skills
1330	  * Keep skills discoverable
1331	* Centralize conventions when layering stops scaling
1332	  * Recommend the right plugin at session start
1333	* Put it together
1334	* Scope and plan changes that span packages
1335	* Next steps
1336
1337	## Troubleshooting
1338
1339	### [troubleshoot-install](https://code.claude.com/docs/en/troubleshoot-install.md)
1340
1341	* Find your error
1342	* Run diagnostic checks
1343	  * Check network connectivity
1344	  * Verify your PATH
1345	  * Check for conflicting installations
1346	  * Check directory permissions
1347	  * Verify the binary works
1348	* Common installation issues
1349	  * Install script returns HTML instead of a shell script
1350	  * `command not found: claude` after installation
1351	  * `curl: (56) Failure writing output to destination`
1352	  * Homebrew cask unavailable or outdated
1353	  * TLS or SSL connection errors
1354	  * `Failed to fetch version from downloads.claude.ai`
1355	  * Wrong install command on Windows
1356	  * `The process cannot access the file` during Windows install
1357	  * Install killed on low-memory Linux servers
1358	  * Install hangs in Docker
1359	  * Claude Desktop overrides the `claude` command on Windows
1360	  * Claude Code on Windows requires either Git for Windows (for bash) or PowerShell
1361	  * Claude Code does not support 32-bit Windows
1362	  * Linux musl or glibc binary mismatch
1363	  * `Illegal instruction`
1364	  * `dyld: cannot load` on macOS
1365	  * `Exec format error` on WSL1
1366	  * npm install errors in WSL
1367	  * Permission errors during installation
1368	  * Native binary not found after npm install
1369	* Login and authentication
1370	  * Reset your login
1371	  * OAuth error: Invalid code
1372	  * 403 Forbidden after login
1373	  * This organization has been disabled with an active subscription
1374	  * OAuth login fails in WSL2, SSH, or containers
1375	  * Not logged in or token expired
1376	  * Bedrock, Agent Platform, or Foundry credentials not loading
1377	* Still stuck
1378
1379	### [troubleshooting](https://code.claude.com/docs/en/troubleshooting.md)
1380
1381	* Performance and stability
1382	  * High CPU or memory usage
1383	  * Auto-compaction stops with a thrashing error
1384	  * Command hangs or freezes
1385	  * Garbled or corrupted text in an editor's integrated terminal
1386	  * Search and discovery issues
1387	  * Slow or incomplete search results on WSL
1388	* Get more help
1389
1390	### [debug-your-config](https://code.claude.com/docs/en/debug-your-config.md)
1391
1392	* See what loaded into context
1393	* Check resolved settings
1394	* Check MCP servers
1395	* Check hooks
1396	* Test against a clean configuration
1397	* Check common causes
1398	* Related resources
1399
1400	### [errors](https://code.claude.com/docs/en/errors.md)
1401
1402	* Find your error
1403	* Automatic retries
1404	* Server errors
1405	  * API Error: 500 Internal server error
1406	  * API Error: Repeated 529 Overloaded errors
1407	  * Request timed out
1408	  * The response above may be incomplete
1409	  * Auto mode cannot determine the safety of an action
1410	  * Agent terminated early due to an API error
1411	* Usage limits
1412	  * You've hit your session limit
1413	  * Usage credits required for 1M context
1414	  * Server is temporarily limiting requests
1415	  * Request rejected (429)
1416	  * Credit balance is too low
1417	* Authentication errors
1418	  * Not logged in
1419	  * Could not resolve authentication method
1420	  * Invalid API key
1421	  * This organization has been disabled
1422	  * Your organization has disabled API key authentication
1423	  * Your organization has disabled Claude subscription access
1424	  * Routines are disabled by your organization's policy
1425	  * Remote Control requires the Anthropic API
1426	  * OAuth token revoked or expired
1427	  * OAuth scope requirement
1428	  * AWS credentials expired or invalid
1429	  * AWS authentication failed
1430	* Network and connection errors
1431	  * Unable to connect to API
1432	  * SSL certificate errors
1433	  * Host not allowed in a cloud session
1434	  * Couldn't reconnect to your Remote Control session
1435	* Request errors
1436	  * Prompt is too long
1437	  * Error during compaction: Conversation too long
1438	  * Request too large
1439	  * Image was too large
1440	  * Unable to resize image
1441	  * PDF errors
1442	  * Extra inputs are not permitted
1443	  * There's an issue with the selected model
1444	  * Model is not a recognized model id
1445	  * Claude Opus is not available with the Claude Pro plan
1446	  * Model is restricted by your organization's settings
1447	  * thinking.type.enabled is not supported for this model
1448	  * Thinking budget exceeds output limit
1449	  * Tool use or thinking block mismatch
1450	  * Usage Policy refusal
1451	  * Safety measures flagged a cybersecurity topic
1452	* Installation errors
1453	  * Installation was killed before it could finish
1454	  * The connection dropped while downloading the update
1455	* Command-line errors
1456	  * Conflict between --bg and --print
1457	  * The --json-schema value is not a valid JSON Schema
1458	  * Could not import a server from Claude Desktop
1459	* Plugin errors
1460	  * Marketplace is registered from an untrusted source
1461	* Configuration warnings
1462	  * Workspace has not been trusted
1463	* Responses seem lower quality than usual
1464	* Report an error
1465
1466	## Setup and access
1467
1468	### [admin-setup](https://code.claude.com/docs/en/admin-setup.md)
1469
1470	* Choose your API provider
1471	* Decide how settings reach devices
1472	* Decide what to enforce
1473	* Set up usage visibility
1474	* Review data handling
1475	* Verify and onboard
1476	* Next steps
1477
1478	### [setup](https://code.claude.com/docs/en/setup.md)
1479
1480	* System requirements
1481	  * Additional dependencies
1482	* Install Claude Code
1483	  * Set up on Windows
1484	  * Alpine Linux and musl-based distributions
1485	* Verify your installation
1486	* Authenticate
1487	* Update Claude Code
1488	  * Auto-updates
1489	  * Configure release channel
1490	  * Pin a minimum version
1491	  * Disable auto-updates
1492	  * Update manually
1493	* Advanced installation options
1494	  * Install a specific version
1495	  * Install with Linux package managers
1496	  * Install with npm
1497	  * Binary integrity and code signing
1498	    * Verify the manifest signature
1499	    * Platform code signatures
1500	* Uninstall Claude Code
1501	  * Native installation
1502	  * Homebrew installation
1503	  * WinGet installation
1504	  * apt / dnf / apk
1505	  * npm
1506	  * Remove configuration files
1507
1508	### [authentication](https://code.claude.com/docs/en/authentication.md)
1509
1510	* Log in to Claude Code
1511	* Set up team authentication
1512	  * Claude for Teams or Enterprise
1513	  * Claude Console authentication
1514	  * Cloud provider authentication
1515	* Credential management
1516	  * Renew an expiring login
1517	  * Authentication precedence
1518	  * Generate a long-lived token
1519
1520	### [server-managed-settings](https://code.claude.com/docs/en/server-managed-settings.md)
1521
1522	* Requirements
1523	* Choose between server-managed and endpoint-managed settings
1524	* Configure server-managed settings
1525	  * Verify settings delivery
1526	  * Access control
1527	  * Managed-only settings
1528	  * Current limitations
1529	* Settings delivery
1530	  * Settings precedence
1531	  * Fetch and caching behavior
1532	  * Invalid entries in delivered settings
1533	  * Enforce fail-closed startup
1534	  * Security approval dialogs
1535	* Platform availability
1536	* Audit logging
1537	* Security considerations
1538	* See also
1539
1540	### [managed-mcp](https://code.claude.com/docs/en/managed-mcp.md)
1541
1542	* Choose a pattern
1543	* Exclusive control with managed-mcp.json
1544	  * Authenticate with per-user credentials
1545	  * Validate the configuration
1546	  * Disable MCP entirely
1547	  * Allow claude.ai connectors alongside the managed set
1548	* Policy-based control with allowlists and denylists
1549	  * Match servers by URL, command, or name
1550	  * How a server is evaluated
1551	  * Example configuration
1552	  * Restrict the allowlist to managed settings only
1553	* How restrictions appear to users
1554	* Monitor MCP usage
1555	* Configuration summary
1556	* Related resources
1557
1558	### [auto-mode-config](https://code.claude.com/docs/en/auto-mode-config.md)
1559
1560	* Where the classifier reads configuration
1561	* Define trusted infrastructure
1562	* Override the block and allow rules
1563	* Route all shell commands through the classifier
1564	* Inspect the defaults and your effective config
1565	* Review denials
1566	* See also
1567
1568	## Deployment
1569
1570	### [third-party-integrations](https://code.claude.com/docs/en/third-party-integrations.md)
1571
1572	* Compare deployment options
1573	* Configure proxies and gateways
1574	  * Amazon Bedrock
1575	  * Microsoft Foundry
1576	  * Google Cloud's Agent Platform
1577	* Best practices for organizations
1578	  * Invest in documentation and memory
1579	  * Simplify deployment
1580	  * Start with guided usage
1581	  * Pin model versions for cloud providers
1582	  * Configure security policies
1583	  * Leverage MCP for integrations
1584	* Next steps
1585
1586	### [feature-availability](https://code.claude.com/docs/en/feature-availability.md)
1587
1588	* Availability by model provider
1589	  * Features available on every provider
1590	  * Features that require a Claude subscription
1591	  * CLI capabilities that vary by provider
1592	  * Admin and analytics
1593	  * Summary by provider
1594	* Availability by subscription plan
1595	* Model availability
1596	* Related resources
1597
1598	### [amazon-bedrock](https://code.claude.com/docs/en/amazon-bedrock.md)
1599
1600	* Prerequisites
1601	* Sign in with Bedrock
1602	* Set up manually
1603	  * 1. Submit use case details
1604	  * 2. Configure AWS credentials
1605	    * Advanced credential configuration
1606	      * Example configuration
1607	      * Configuration settings explained
1608	  * 3. Configure Claude Code
1609	  * 4. Pin model versions
1610	    * Map each model version to an inference profile
1611	* Startup model checks
1612	* IAM configuration
1613	* 1M token context window
1614	* Service tiers
1615	* AWS Guardrails
1616	* Use the Mantle endpoint
1617	  * Enable Mantle
1618	  * Select a Mantle model
1619	  * Run Mantle alongside the Invoke API
1620	  * Route Mantle through a gateway
1621	  * Mantle environment variables
1622	* Troubleshooting
1623	  * Authentication loop with SSO and corporate proxies
1624	  * Region issues
1625	  * Zero token counts in /context
1626	  * Mantle endpoint errors
1627	* Additional resources
1628
1629	### [claude-platform-on-aws](https://code.claude.com/docs/en/claude-platform-on-aws.md)
1630
1631	* Prerequisites
1632	* Setup
1633	  * 1. Configure AWS credentials
1634	  * 2. Configure Claude Code
1635	  * 3. Pin model versions
1636	* Use the Agent SDK
1637	* Route through a corporate proxy
1638	* Troubleshooting
1639	  * `403 Forbidden` or `AccessDenied` on every request
1640	  * Requests fail with a missing-workspace error
1641	  * Requests still go to `api.anthropic.com`
1642	* Additional resources
1643
1644	### [google-vertex-ai](https://code.claude.com/docs/en/google-vertex-ai.md)
1645
1646	* Prerequisites
1647	* Sign in with Agent Platform
1648	* Region configuration
1649	* Set up manually
1650	  * 1. Enable Agent Platform API
1651	  * 2. Request model access
1652	  * 3. Configure GCP credentials
1653	    * Advanced credential configuration
1654	  * 4. Configure Claude Code
1655	  * 5. Pin model versions
1656	* Startup model checks
1657	* IAM configuration
1658	* 1M token context window
1659	* Troubleshooting
1660	* Additional resources
1661
1662	### [microsoft-foundry](https://code.claude.com/docs/en/microsoft-foundry.md)
1663
1664	* Prerequisites
1665	* Setup
1666	  * 1. Provision Microsoft Foundry resource
1667	  * 2. Configure Azure credentials
1668	  * 3. Configure Claude Code
1669	  * 4. Pin model versions
1670	  * 5. Run Claude Code
1671	* Azure RBAC configuration
1672	* Troubleshooting
1673	* Additional resources
1674
1675	### [network-config](https://code.claude.com/docs/en/network-config.md)
1676
1677	* Proxy configuration
1678	  * Environment variables
1679	  * Basic authentication
1680	* CA certificate store
1681	* Custom CA certificates
1682	* mTLS authentication
1683	* Network access requirements
1684	* Additional resources
1685
1686	### [devcontainer](https://code.claude.com/docs/en/devcontainer.md)
1687
1688	* Add Claude Code to your dev container
1689	* Persist authentication and settings across rebuilds
1690	* Enforce organization policy
1691	* Restrict network egress
1692	* Run without permission prompts
1693	* Try the reference container
1694	* Next steps
1695
1696	### Gateways > Claude apps gateway
1697
1698	#### [claude-apps-gateway-config](https://code.claude.com/docs/en/claude-apps-gateway-config.md)
1699
1700	* File structure
1701	* Secret expansion
1702	* Required sections
1703	  * `listen`
1704	  * `oidc`
1705	  * `session`
1706	  * `store`
1707	  * `upstreams`
1708	    * Anthropic API
1709	    * Amazon Bedrock
1710	    * Claude Platform on AWS
1711	    * Google Cloud Agent Platform
1712	    * Microsoft Foundry
1713	    * Multiple upstreams
1714	* Optional sections
1715	  * `admin`
1716	  * `enforcement`
1717	  * `models`
1718	  * `managed`
1719	    * What goes in `cli`
1720	    * Precedence with other managed sources
1721	  * `telemetry`
1722	  * HTTP tuning
1723	* Complete example
1724	* Client-side managed settings
1725	* Related
1726
1727	#### [claude-apps-gateway-spend-limits](https://code.claude.com/docs/en/claude-apps-gateway-spend-limits.md)
1728
1729	* Set a cap
1730	  * Authenticate to the admin API
1731	* How enforcement works
1732	  * Postgres availability
1733	* Admin API reference
1734	  * `/effective`
1735	  * `/audit`
1736	  * Pagination
1737	* Data lifecycle
1738	* Related
1739
1740	#### [claude-apps-gateway-deploy](https://code.claude.com/docs/en/claude-apps-gateway-deploy.md)
1741
1742	* Identity provider setup
1743	* Deployment
1744	  * Container image
1745	  * Kubernetes
1746	  * Cloud Run
1747	  * Push the gateway URL to developer machines
1748	* Operations
1749	  * Logs
1750	  * Health
1751	  * Outage behavior
1752	  * JWT secret rotation
1753	  * Postgres
1754	  * Upgrades
1755	* Security
1756	  * Data flow
1757	  * Threat model summary
1758	  * User-code brute-force resistance
1759	  * Compliance posture
1760	* Troubleshooting
1761	* Related
1762
1763	#### [claude-apps-gateway-on-gcp](https://code.claude.com/docs/en/claude-apps-gateway-on-gcp.md)
1764
1765	* What you'll build
1766	* Prerequisites
1767	* Deploy the gateway
1768	* Terraform reference
1769	* Troubleshooting
1770	* Next steps
1771
1772	### Gateways > Other gateways
1773
1774	#### [llm-gateway-connect](https://code.claude.com/docs/en/llm-gateway-connect.md)
1775
1776	* Check for an existing configuration
1777	* Configure Claude Code yourself
1778	  * Set the credential variable
1779	  * Set the base URL and credential
1780	    * Set as shell environment variables
1781	    * Set in a settings file
1782	  * Verify the connection
1783	    * Confirm in Claude Code
1784	  * How the credential variable maps to a header
1785	  * Conflicts with an existing login
1786	* Configure each surface
1787	  * VS Code extension
1788	  * Desktop app
1789	  * GitHub Actions
1790	  * Agent SDK
1791	  * Slack, web, and Remote Control
1792	* Additional configuration
1793	  * Send additional headers
1794	  * Add gateway models to the model picker
1795	  * Rotate credentials with apiKeyHelper
1796	  * Route to a cloud provider through a gateway
1797	    * Amazon Bedrock
1798	    * Google Cloud's Agent Platform
1799	    * Microsoft Foundry
1800	    * Claude Platform on AWS
1801	* Troubleshoot gateway errors
1802	* Related resources
1803
1804	#### [llm-gateway-rollout](https://code.claude.com/docs/en/llm-gateway-rollout.md)
1805
1806	* Prerequisites
1807	  * Gateway requirements
1808	* Rollout steps
1809	  * Confirm the gateway routes your models
1810	  * Issue developer credentials
1811	  * Test Claude Code against the gateway
1812	  * Distribute the configuration
1813	    * What to distribute
1814	    * Distribute through managed settings
1815	    * Hand developers the values to set themselves
1816	  * Verify the rollout
1817	* Maintain the gateway
1818	* Related resources
1819
1820	#### [llm-gateway-protocol](https://code.claude.com/docs/en/llm-gateway-protocol.md)
1821
1822	* API formats
1823	  * Foundry and Claude Platform on AWS
1824	  * Optional endpoints and startup traffic
1825	  * Streaming
1826	  * Format mismatch with the upstream
1827	* Request headers
1828	  * Forward as open lists
1829	* System prompt attribution block
1830	* Feature pass-through
1831	  * Automatic retry and error forwarding
1832	  * Disable pre-release capabilities
1833	* Model discovery
1834	  * When discovery runs
1835	  * Request and response
1836	  * Picker entries and caching
1837	* Related resources
1838
1839	## Gateways
1840
1841	### [gateways](https://code.claude.com/docs/en/gateways.md)
1842
1843	* How a gateway works
1844	* Choose a gateway
1845	  * Claude apps gateway
1846	  * Other gateways
1847	* Subscriptions and gateways
1848	* Configure separately from the gateway
1849	* Next steps
1850
1851	## Usage and costs
1852
1853	### [monitoring-usage](https://code.claude.com/docs/en/monitoring-usage.md)
1854
1855	* Quick start
1856	* Administrator configuration
1857	* Configuration details
1858	  * Common configuration variables
1859	  * mTLS authentication
1860	  * Metrics cardinality control
1861	  * Traces (beta)
1862	    * Span hierarchy
1863	    * Span attributes
1864	  * Dynamic headers
1865	    * Settings configuration
1866	    * Script requirements
1867	    * Refresh behavior
1868	  * Multi-team organization support
1869	  * Example configurations
1870	* Available metrics and events
1871	  * Standard attributes
1872	  * Metrics
1873	  * Metric details
1874	    * Session counter
1875	    * Lines of code counter
1876	    * Pull request counter
1877	    * Commit counter
1878	    * Cost counter
1879	    * Token counter
1880	    * Code edit tool decision counter
1881	    * Active time counter
1882	  * Events
1883	    * Event correlation attributes
1884	    * User prompt event
1885	    * Assistant response event
1886	    * Tool result event
1887	    * API request event
1888	    * API error event
1889	    * API refusal event
1890	    * API request body event
1891	    * API response body event
1892	    * Tool decision event
1893	    * Permission mode changed event
1894	    * Auth event
1895	    * MCP server connection event
1896	    * Internal error event
1897	    * Plugin installed event
1898	    * Plugin loaded event
1899	    * Skill activated event
1900	    * At mention event
1901	    * API retries exhausted event
1902	    * Hook registered event
1903	    * Hook execution start event
1904	    * Hook execution complete event
1905	    * Hook plugin metrics event
1906	    * Compaction event
1907	    * Feedback survey event
1908	* Interpret metrics and events data
1909	  * Usage monitoring
1910	  * Cost monitoring
1911	  * Alerting and segmentation
1912	  * Detect retry exhaustion
1913	  * Event analysis
1914	* Audit security events
1915	  * Attribute actions to users
1916	  * Audit MCP activity
1917	  * Map security questions to events
1918	  * Send events to a SIEM
1919	* Backend considerations
1920	  * For metrics
1921	  * For events/logs
1922	  * For traces
1923	* Service information
1924	* ROI measurement resources
1925	* Security and privacy
1926	* Monitor Claude Code on Amazon Bedrock
1927
1928	### [costs](https://code.claude.com/docs/en/costs.md)
1929
1930	* Track your costs
1931	  * Using the `/usage` command
1932	* Managing costs for teams
1933	  * Rate limit recommendations
1934	  * Agent team token costs
1935	* Reduce token usage
1936	  * Manage context proactively
1937	  * Choose the right model
1938	  * Reduce MCP server overhead
1939	  * Install code intelligence plugins for typed languages
1940	  * Offload processing to hooks and skills
1941	  * Move instructions from CLAUDE.md to skills
1942	  * Adjust extended thinking
1943	  * Delegate verbose operations to subagents
1944	  * Manage agent team costs
1945	  * Write specific prompts
1946	  * Work efficiently on complex tasks
1947	* Background token usage
1948	* Understanding changes in Claude Code behavior
1949
1950	### [analytics](https://code.claude.com/docs/en/analytics.md)
1951
1952	* Access analytics for Team and Enterprise
1953	  * Enable contribution metrics
1954	  * Review summary metrics
1955	  * Explore the charts
1956	    * Track adoption
1957	    * Measure PRs per user
1958	    * View pull requests breakdown
1959	    * Find top contributors
1960	  * PR attribution
1961	    * Tagging criteria
1962	    * Attribution process
1963	    * Time window
1964	    * Excluded files
1965	    * Attribution notes
1966	  * Get the most from analytics
1967	    * Monitor adoption
1968	    * Measure ROI
1969	    * Identify power users
1970	    * Access data programmatically
1971	* Access analytics for API customers
1972	  * View team insights
1973	* Related resources
1974
1975	## Plugin distribution
1976
1977	### [plugin-marketplaces](https://code.claude.com/docs/en/plugin-marketplaces.md)
1978
1979	* Overview
1980	* Walkthrough: create a local marketplace
1981	* Create the marketplace file
1982	* Marketplace schema
1983	  * Required fields
1984	  * Owner fields
1985	  * Optional fields
1986	* Plugin entries
1987	  * Required fields
1988	  * Optional plugin fields
1989	* Plugin sources
1990	  * Relative paths
1991	  * GitHub repositories
1992	  * Git repositories
1993	  * Git subdirectories
1994	  * npm packages
1995	  * Advanced plugin entries
1996	  * Strict mode
1997	* Host and distribute marketplaces
1998	  * Host on GitHub (recommended)
1999	  * Host on other git services
2000	  * Private repositories
2001	  * Test locally before distribution
2002	  * Require marketplaces for your team
2003	  * Pre-populate plugins for containers
2004	  * Managed marketplace restrictions
2005	    * Common configurations
2006	    * How restrictions work
2007	  * Version resolution and release channels
2008	    * Set up release channels
2009	      * Example
2010	      * Assign channels to user groups
2011	    * Pin dependency versions
2012	  * Rename or remove a plugin
2013	* Validation and testing
2014	* Manage marketplaces from the CLI
2015	  * Plugin marketplace add
2016	  * Plugin marketplace list
2017	  * Plugin marketplace remove
2018	  * Plugin marketplace update
2019	* Troubleshooting
2020	  * Marketplace not loading
2021	  * Marketplace validation errors
2022	  * Plugin installation failures
2023	  * Private repository authentication fails
2024	  * Marketplace updates fail in offline environments
2025	  * Git operations time out
2026	  * Plugins with relative paths fail in URL-based marketplaces
2027	  * Files not found after installation
2028	* See also
2029
2030	### [plugin-dependencies](https://code.claude.com/docs/en/plugin-dependencies.md)
2031
2032	* Why constrain dependency versions
2033	* Declare a dependency with a version constraint
2034	* Depend on a plugin from another marketplace
2035	* Tag plugin releases for version resolution
2036	* How constraints interact
2037	* Enable or disable a plugin with dependencies
2038	* Remove orphaned auto-installed dependencies
2039	* Resolve dependency errors
2040	* See also
2041
2042	### [plugin-hints](https://code.claude.com/docs/en/plugin-hints.md)
2043

> ## Documentation Index
> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Claude code docs map

# Claude Code Documentation Map

This is a comprehensive map of all Claude Code documentation pages with their headings, designed for easy navigation by LLMs.

> **Note:** This file is auto-generated by GitHub Actions. Do not edit manually.
> Last updated: 2026-07-11 03:53:52 UTC

## Document Structure

This map uses a hierarchical structure:

* **##** marks documentation groups (e.g., 'Getting started')
* **###** marks individual documentation pages
* **Nested bullets** show the heading structure within each page
* Each page title links to the full documentation

## Getting started

### [overview](https://code.claude.com/docs/en/overview.md)

* Get started
* What you can do
* Use Claude Code everywhere
* Next steps

### [quickstart](https://code.claude.com/docs/en/quickstart.md)

* Before you begin
* Step 1: Install Claude Code
* Step 2: Log in to your account
* Step 3: Start your first session
* Step 4: Ask your first question
* Step 5: Make your first code change
* Step 6: Use Git with Claude Code
* Step 7: Fix a bug or add a feature
* Step 8: Test out other common workflows
* Essential commands
* Pro tips for beginners
* What's next?
* Getting help

### [changelog](https://code.claude.com/docs/en/changelog.md)

* (No headings found)

## Core concepts

### [how-claude-code-works](https://code.claude.com/docs/en/how-claude-code-works.md)

* The agentic loop
  * Models
  * Tools
* What Claude can access
* Environments and interfaces
  * Execution environments
  * Interfaces
* Work with sessions
  * Work across branches
  * Resume or fork sessions
  * The context window
    * When context fills up
    * Manage context with skills and subagents
* Stay safe with checkpoints and permissions
  * Undo changes with checkpoints
  * Control what Claude can do
* Work effectively with Claude Code
  * Ask Claude Code for help
  * It's a conversation
    * Interrupt and steer
  * Be specific upfront
  * Give Claude something to verify against
  * Explore before implementing
  * Delegate, don't dictate
* What's next

### [features-overview](https://code.claude.com/docs/en/features-overview.md)

* Overview
* Match features to your goal
  * Build your setup over time
  * Compare similar features
  * Understand how features layer
  * Combine features
* Understand context costs
  * Context cost by feature
  * Understand how features load
* Learn more

### [claude-directory](https://code.claude.com/docs/en/claude-directory.md)

* Explore the directory
* What's not shown
* Choose the right file
* File reference
* Troubleshoot configuration
* Application data
  * Cleaned up automatically
  * Kept until you delete them
  * Plaintext storage
  * Clear local data
* Related resources

### [context-window](https://code.claude.com/docs/en/context-window.md)

* What the timeline shows
* What survives compaction
* When your context fills up
* Check your own session
* Related resources

### [prompt-caching](https://code.claude.com/docs/en/prompt-caching.md)

* How the cache is organized
  * Where the cache lives
* Actions that invalidate the cache
  * Switching models
  * Changing effort level
  * Turning on fast mode
  * Connecting or disconnecting an MCP server
  * Enabling or disabling a plugin
  * Denying an entire tool
  * Compacting the conversation
  * Upgrading Claude Code
* Actions that keep the cache
  * Editing files in your repository
  * Editing CLAUDE.md mid-session
  * Changing output style
  * Changing permission mode
  * Invoking skills and commands
  * Running `/recap`
  * Rewinding the conversation
* Cache lifetime
  * On a Claude subscription
  * On an API key or third-party provider
  * Override the TTL
* Cache scope
* Check cache performance
* Subagents and the cache
* Disable prompt caching
* Related resources

## Use Claude Code

### [memory](https://code.claude.com/docs/en/memory.md)

* CLAUDE.md vs auto memory
* CLAUDE.md files
  * When to add to CLAUDE.md
  * Choose where to put CLAUDE.md files
  * Set up a project CLAUDE.md
  * Write effective instructions
  * Import additional files
  * AGENTS.md
  * How CLAUDE.md files load
    * Load from additional directories
  * Organize rules with `.claude/rules/`
    * Set up rules
    * Path-specific rules
    * Share rules across projects with symlinks
    * User-level rules
  * Manage CLAUDE.md for large teams
    * Deploy organization-wide CLAUDE.md
    * Exclude specific CLAUDE.md files
* Auto memory
  * Enable or disable auto memory
  * Storage location
  * How it works
  * Audit and edit your memory
* View and edit with `/memory`
* Troubleshoot memory issues
  * Claude isn't following my CLAUDE.md
  * I don't know what auto memory saved
  * My CLAUDE.md is too large
  * Instructions seem lost after `/compact`
* Related resources

### [permission-modes](https://code.claude.com/docs/en/permission-modes.md)

* Available modes
* Switch permission modes
* Auto-approve file edits with acceptEdits mode
* Analyze before you edit with plan mode
  * Review and approve a plan
  * Set plan mode as the default
* Eliminate permission prompts with auto mode
  * Enable auto mode on Bedrock, Agent Platform, or Foundry
  * What the classifier blocks by default
  * Boundaries you state in conversation
  * When auto mode falls back
* Allow only pre-approved tools with dontAsk mode
* Skip all checks with bypassPermissions mode
* Protected paths
* See also

### [sessions](https://code.claude.com/docs/en/sessions.md)

* Resume a session
  * Where the session picker looks
* Name your sessions
* Use the session picker
* Branch a session
* Manage context within a session
* Export and locate session data
  * Access conversations from scripts
  * Where transcripts are stored
* See also

### [common-workflows](https://code.claude.com/docs/en/common-workflows.md)

* Prompt recipes
  * Understand new codebases
    * Get a quick codebase overview
    * Find relevant code
  * Fix bugs efficiently
  * Refactor code
  * Work with tests
  * Create pull requests
  * Handle documentation
  * Work in notes and non-code folders
  * Work with images
  * Reference files and directories
  * Run Claude on a schedule
  * Ask Claude about its capabilities
    * Example questions
* Resume previous conversations
* Run parallel sessions with worktrees
* Plan before editing
* Delegate research to subagents
* Pipe Claude into scripts
* Next steps

### [prompt-library](https://code.claude.com/docs/en/prompt-library.md)

* What makes these prompts work
* Where these come from
* Related resources

### [best-practices](https://code.claude.com/docs/en/best-practices.md)

* Give Claude a way to verify its work
* Explore first, then plan, then code
* Provide specific context in your prompts
  * Provide rich content
* Configure your environment
  * Write an effective CLAUDE.md
  * Configure permissions
  * Use CLI tools
  * Connect MCP servers
  * Set up hooks
  * Create skills
  * Create custom subagents
  * Install plugins
* Communicate effectively
  * Ask codebase questions
  * Let Claude interview you
* Manage your session
  * Course-correct early and often
  * Manage context aggressively
  * Use subagents for investigation
  * Rewind with checkpoints
  * Resume conversations
* Automate and scale
  * Run non-interactive mode
  * Run multiple Claude sessions
  * Fan out across files
  * Run autonomously with auto mode
  * Add an adversarial review step
* Avoid common failure patterns
* Develop your intuition
* Related resources

### Platforms and integrations > Claude Code on the web

#### [web-quickstart](https://code.claude.com/docs/en/web-quickstart.md)

* How sessions run
* Compare ways to run Claude Code
* Connect GitHub and create an environment
  * Connect from your terminal
* Start a task
* Pre-fill sessions
* Review and iterate
* Troubleshoot setup
  * No repositories appear after connecting GitHub
  * The page only shows a GitHub login button
  * "Not available for the selected organization"
  * `/web-setup` shows "No commands match" or "Unknown command"
  * "Could not create a cloud environment" or "No cloud environment available" when using `--cloud` or ultraplan
  * Setup script failed
  * New sessions hang or time out during setup
  * Session keeps running after closing the tab
* Next steps

#### [claude-code-on-the-web](https://code.claude.com/docs/en/claude-code-on-the-web.md)

* GitHub authentication options
* The cloud environment
  * What's available in cloud sessions
  * Installed tools
  * Work with GitHub issues and pull requests
  * Link output back to the session
  * Run tests, start services, and add packages
  * Resource limits
  * Configure your environment
* Setup scripts
  * Environment caching
  * Setup scripts vs. SessionStart hooks
  * Install dependencies with a SessionStart hook
* Network access
  * Access levels
  * Allow specific domains
  * GitHub proxy
  * Security proxy
  * Default allowed domains
* Move tasks between web and terminal
  * From terminal to web
    * Tips for cloud tasks
    * Send local repositories without GitHub
  * From web to terminal
    * Teleport requirements
    * `--teleport` is unavailable
* Work with sessions
  * Manage context
  * Review changes
  * Share sessions
    * Share from an Enterprise or Team account
    * Share from a Max or Pro account
  * Archive sessions
  * Delete sessions
* Auto-fix pull requests
  * How Claude responds to PR activity
* Security and isolation
* Troubleshooting
  * Session creation failed
  * Remote Control session expired or access denied
  * Environment expired
* Limitations
* Related resources

#### [routines](https://code.claude.com/docs/en/routines.md)

* Example use cases
* Create a routine
  * Create from the web
  * Create from the CLI
* Configure triggers
  * Add a schedule trigger
    * Schedule a one-off run
  * Add an API trigger
    * Trigger a routine
    * API reference
  * Add a GitHub trigger
    * Supported events
    * Filter pull requests
    * How sessions map to events
* Manage routines
  * View and interact with runs
  * Edit and control routines
  * Repositories and branch permissions
  * Connectors
  * Environments and network access
* Usage and limits
* Troubleshooting
  * `/schedule` shows "No commands match" or "Unknown command"
  * "Routines are disabled by your organization's policy"
* Related resources

#### [ultraplan](https://code.claude.com/docs/en/ultraplan.md)

* Launch ultraplan from the CLI
* Review and revise the plan in your browser
* Choose where to execute
  * Execute on the web
  * Send the plan back to your terminal
* Related resources

#### [ultrareview](https://code.claude.com/docs/en/ultrareview.md)

* Run ultrareview from the CLI
* Pricing and free runs
* Track a running review
* Run ultrareview non-interactively
* How ultrareview compares to /code-review and /review
* Related resources

### Platforms and integrations > Claude Code on desktop

#### [desktop-quickstart](https://code.claude.com/docs/en/desktop-quickstart.md)

* Install
* Start your first session
* Now what?
* Coming from the CLI?
* What's next

#### [desktop](https://code.claude.com/docs/en/desktop.md)

* Start a session
* Work with code
  * Use the prompt box
  * Add files and context to prompts
  * Choose a permission mode
  * Preview your app
  * Browse external sites
    * Approve Claude's actions on a site
    * Choose between the Browser and the Chrome extension
    * Restrict external browsing for your organization
  * Review changes with diff view
  * Review your code
  * Monitor pull request status
* Arrange your workspace
  * Run commands in the terminal
  * Open and edit files
  * Open files in other apps
  * Switch view modes
  * Keyboard shortcuts
  * Check usage
* Let Claude use your computer
  * When computer use applies
  * Enable computer use
  * App permissions
* Manage sessions
  * Work in parallel with sessions
  * Ask a side question without derailing the session
  * Watch background tasks
  * Run long-running tasks remotely
  * Continue in another surface
  * Sessions from Dispatch
* Extend Claude Code
  * Connect external tools
  * Use skills
  * Install plugins
  * Configure preview servers
    * Auto-verify changes
    * Configuration fields
      * When to use `program` vs `runtimeExecutable`
    * Port conflicts
    * Examples
* Environment configuration
  * Local sessions
  * Cloud sessions
  * SSH sessions
    * Pre-configure SSH connections for your team
    * Restrict which SSH hosts users can connect to
* Enterprise configuration
  * Admin console controls
  * Managed settings
  * Device management policies
  * Authentication and SSO
  * Data handling
  * Deployment
* Coming from the CLI?
  * CLI flag equivalents
  * Shared configuration
  * Feature comparison
  * What's not available in Desktop
* Troubleshooting
  * Check your version
  * 403 or authentication errors in the Code tab
  * Blank or stuck screen on launch
  * "Failed to load session"
  * Session not finding installed tools
  * Git and Git LFS errors
  * MCP servers not working on Windows
  * App won't quit
  * Windows-specific issues
  * "Branch doesn't exist yet" when opening in CLI
  * Still stuck?

#### [desktop-linux](https://code.claude.com/docs/en/desktop-linux.md)

* Requirements
* Install
  * Install from a downloaded file
* Update
* Uninstall
* Troubleshoot
  * Unable to locate package claude-desktop
* What's not in the Linux beta yet

#### [desktop-scheduled-tasks](https://code.claude.com/docs/en/desktop-scheduled-tasks.md)

* Compare scheduling options
* Create a scheduled task
* Schedule options
* How scheduled tasks run
* Missed runs
* Permissions for scheduled tasks
* Manage scheduled tasks
* Related resources

### Platforms and integrations > Code review & CI/CD

#### [security-guidance](https://code.claude.com/docs/en/security-guidance.md)

* Prerequisites
* Install the plugin
  * Enable in cloud sessions and shared repositories
* What the plugin checks
  * On each file edit
  * At the end of each turn
  * On each commit or push Claude makes
  * Review independence and limits
* Add your own rules
  * Add guidance for the model-backed reviews
  * Add custom per-edit patterns
  * Rule file lookup locations
* Usage cost
* Disable or uninstall
* How the plugin integrates with Claude Code
* How this fits with other security tools
* Troubleshooting
* Related resources

#### [code-review](https://code.claude.com/docs/en/code-review.md)

* How reviews work
  * Severity levels
  * Rate and reply to findings
  * Check run output
  * What Code Review checks
* Set up Code Review
* Manually trigger reviews
* Customize reviews
  * CLAUDE.md
  * REVIEW\.md
    * What you can tune
    * Example
    * Keep it focused
* View usage
* Pricing
* Troubleshooting
  * Retrigger a failed or timed-out review
  * Review didn't run and the PR shows a spend-cap message
  * Find issues that aren't showing as inline comments
* Review a diff locally
* Related resources

#### [github-actions](https://code.claude.com/docs/en/github-actions.md)

* Why use Claude Code GitHub Actions?
* What can Claude do?
  * Claude Code Action
* Setup
* Quick setup
* Manual setup
* Upgrading from Beta
  * Essential changes
  * Breaking Changes Reference
  * Before and After Example
* Example use cases
  * Basic workflow
  * Using skills
  * Custom automation with prompts
  * Common use cases
* Best practices
  * CLAUDE.md configuration
  * Security considerations
  * Optimizing performance
  * CI costs
* Configuration examples
* Using with Amazon Bedrock and Google Cloud
  * Prerequisites
    * For Google Cloud's Agent Platform:
    * For Amazon Bedrock:
* Troubleshooting
  * Claude not responding to @claude commands
  * CI not running on Claude's commits
  * Authentication errors
* Advanced configuration
  * Action parameters
    * Pass CLI arguments
  * Alternative integration methods
  * Customizing Claude's behavior

#### [github-enterprise-server](https://code.claude.com/docs/en/github-enterprise-server.md)

* What works with GitHub Enterprise Server
* Admin setup
  * GitHub App permissions
  * Manual setup
  * Network requirements
* Developer workflow
  * Teleport sessions to your terminal
* Plugin marketplaces on GHES
  * Add a GHES marketplace
  * Pre-register GHES marketplaces with managed settings
  * Allowlist GHES marketplaces in managed settings
* Limitations
* Troubleshooting
  * Web session fails to clone repository
  * Marketplace add fails with a policy error
  * Marketplace add on claude.ai fails with a GitHub access error
  * GHES instance not reachable
* Related resources

#### [gitlab-ci-cd](https://code.claude.com/docs/en/gitlab-ci-cd.md)

* Why use Claude Code with GitLab?
* How it works
* What can Claude do?
* Setup
  * Quick setup
  * Manual setup (recommended for production)
* Example use cases
  * Turn issues into MRs
  * Get implementation help
  * Fix bugs quickly
* Using with Amazon Bedrock and Google Cloud
* Configuration examples
  * Basic .gitlab-ci.yml (Claude API)
  * Amazon Bedrock job example (OIDC)
  * Agent Platform job example (Workload Identity Federation)
* Best practices
  * CLAUDE.md configuration
  * Security considerations
  * Optimizing performance
  * CI costs
* Security and governance
* Troubleshooting
  * Claude not responding to @claude commands
  * Job can't write comments or open MRs
  * Authentication errors
* Advanced configuration
  * Common parameters and variables
  * Customizing Claude's behavior

## Platforms and integrations

### [platforms](https://code.claude.com/docs/en/platforms.md)

* Where to run Claude Code
* Connect your tools
* Work when you are away from your terminal
* Related resources
  * Platforms
  * Integrations
  * Remote access

### [remote-control](https://code.claude.com/docs/en/remote-control.md)

* Requirements
* Start a Remote Control session
  * Check connection status
  * Connect from another device
  * Enable Remote Control for all sessions
* Connection and security
* Trusted Devices
  * Enable Trusted Devices for your organization
  * What members see
  * Manage enrolled devices
* Remote Control vs Claude Code on the web
* Mobile push notifications
* Limitations
* Troubleshooting
  * "Remote Control requires a claude.ai subscription"
  * "Remote Control requires a full-scope login token"
  * "Unable to determine your organization for Remote Control eligibility"
  * "Remote Control is not yet enabled for your account"
  * "Couldn't verify Remote Control eligibility"
  * "Remote Control is only available when using Claude via api.anthropic.com"
  * "Remote Control is disabled by your organization's policy"
  * "Remote credentials fetch failed"
  * "Couldn't reconnect to your Remote Control session"
  * "Your organization requires Trusted Devices for Remote Control, but this device is not enrolled"
  * "session expired for trusted-device check"
* Choose the right approach
* Related resources

### [chrome](https://code.claude.com/docs/en/chrome.md)

* Capabilities
* Prerequisites
* Get started in the CLI
  * Enable Chrome by default
  * Manage site permissions
  * Browser tools in plan mode
* Example workflows
  * Test a local web application
  * Debug with console logs
  * Automate form filling
  * Draft content in Google Docs
  * Extract data from web pages
  * Run multi-site workflows
  * Record a demo GIF
* Troubleshooting
  * Extension not detected
  * Browser not responding
  * Connection drops during long sessions
  * Windows-specific issues
  * Common error messages
* See also

### [computer-use](https://code.claude.com/docs/en/computer-use.md)

* What you can do with computer use
* When computer use applies
* Enable computer use
* Approve apps per session
* How Claude works on your screen
  * One session at a time
  * Apps are hidden while Claude works
  * Screenshots are downscaled automatically
  * Stop at any time
* Safety and the trust boundary
* Example workflows
  * Validate a native build
  * Reproduce a layout bug
  * Test a simulator flow
* Differences from the Desktop app
* Troubleshooting
  * "Computer use is in use by another Claude session"
  * macOS permissions prompt keeps reappearing
  * `computer-use` doesn't appear in `/mcp`
* See also

### [vs-code](https://code.claude.com/docs/en/vs-code.md)

* Prerequisites
* Install the extension
* Get started
* Use the prompt box
  * Reference files and folders
  * Resume past conversations
  * Resume cloud sessions from Claude.ai
  * Check account and usage
* Customize your workflow
  * Choose where Claude lives
  * Run multiple conversations
  * Switch to terminal mode
* Manage plugins
  * Install plugins
  * Manage marketplaces
* Automate browser tasks with Chrome
* VS Code commands and shortcuts
  * Launch a VS Code tab from other tools
* Configure settings
  * Extension settings
* VS Code extension vs. Claude Code CLI
  * Rewind with checkpoints
  * Run CLI in VS Code
  * Switch between extension and CLI
  * Include terminal output in prompts
  * Monitor background processes
  * Connect to external tools with MCP
* Work with git
  * Create commits and pull requests
  * Use git worktrees for parallel tasks
* Use third-party providers
* Security and privacy
  * The built-in IDE MCP server
* Fix common issues
  * Extension won't install
  * Spark icon not visible
  * Cmd+Esc does nothing on macOS
  * Claude Code never responds
* Uninstall the extension
* Next steps

### [jetbrains](https://code.claude.com/docs/en/jetbrains.md)

* Supported IDEs
* Features
* Installation
* Usage
  * From your IDE
  * From external terminals
* Configuration
  * Claude Code settings
  * Plugin settings
    * General settings
    * ESC key configuration
* Special configurations
  * Remote development
  * WSL configuration
    * Allow WSL2 traffic through Windows Firewall
    * Switch WSL2 to mirrored networking
* Troubleshooting
  * Plugin not working
  * IDE not detected
  * Command not found
* Security considerations

### [slack](https://code.claude.com/docs/en/slack.md)

* Use cases
* Prerequisites
* Setting up Claude Code in Slack
* How it works
  * Automatic detection
  * Context gathering
  * Session flow
* User interface elements
  * App Home
  * Message actions
  * Repository selection
* Access and permissions
  * User-level access
  * Workspace-level access
  * Channel-based access control
* What's accessible where
* Best practices
  * Writing effective requests
  * When to use Slack vs. web
* Troubleshooting
  * "Claude Code is not enabled for your account"
  * Sessions not starting
  * Repository not showing
  * Wrong repository selected
  * Authentication errors
  * Session expiration
* Current limitations
* Related resources

## Agents and parallel work

### [agents](https://code.claude.com/docs/en/agents.md)

* Choose an approach
* Check on running work
* Learn more

### [sub-agents](https://code.claude.com/docs/en/sub-agents.md)

* Built-in subagents
* Quickstart: create your first subagent
* Configure subagents
  * Choose the subagent scope
  * Write subagent files
    * Supported frontmatter fields
  * Choose a model
  * Control subagent capabilities
    * Available tools
    * Restrict which subagents can be spawned
    * Scope MCP servers to a subagent
    * Permission modes
    * Preload skills into subagents
    * Enable persistent memory
      * Persistent memory tips
    * Conditional rules with hooks
    * Disable specific subagents
  * Define hooks for subagents
    * Hooks in subagent frontmatter
    * Project-level hooks for subagent events
* Work with subagents
  * Understand automatic delegation
  * Invoke subagents explicitly
  * Run subagents in foreground or background
  * API errors in subagents
  * Common patterns
    * Isolate high-volume operations
    * Run parallel research
    * Chain subagents
  * Choose between subagents and main conversation
  * Spawn nested subagents
  * Manage subagent context
    * What loads at startup
    * Resume subagents
    * Auto-compaction
* Fork the current conversation
  * Observe and steer running forks
  * How forks differ from named subagents
  * Limitations
* Example subagents
  * Code reviewer
  * Debugger
  * Data scientist
  * Database query validator
* Next steps

### [agent-view](https://code.claude.com/docs/en/agent-view.md)

* Quick start
* Monitor sessions with agent view
  * Read session state
  * Row summaries
  * Pull request status
  * Peek and reply
  * Attach to a session
  * Organize the list
  * Filter sessions
  * Keyboard shortcuts
* Dispatch new agents
  * From agent view
    * Dispatch to a specific directory
  * From inside a session
  * From your shell
    * Run a shell command
  * How file edits are isolated
  * Set the model
  * Permission mode, model, and effort
  * Settings, plugins, and MCP servers
* Manage sessions from the shell
* How background sessions are hosted
  * The supervisor process
  * Where state is stored
  * Turn off agent view
* Troubleshooting
  * `claude agents` lists subagents instead of opening agent view
  * Agent view opens with no sessions
  * Backgrounding shows a `Background this session?` dialog
  * Prompt rejected as too short
  * Sessions show as failed after shutdown
  * Opening a session says the conversation is already open
  * A session fails before starting with a `possibly low memory` note
  * Agent view says the background service did not respond
  * Dispatch fails with `Could not resolve authentication method`
  * Background sessions can't read Desktop, Documents, or Downloads on macOS
  * Background sessions can't reach local-network hosts on macOS
  * A session is slow to respond after attaching
  * `.claude/worktrees/` is filling up
* Limitations
* Related resources
* Version history

### [agent-teams](https://code.claude.com/docs/en/agent-teams.md)

* When to use agent teams
  * Compare with subagents
* Enable agent teams
* Start your first agent team
* Control your agent team
  * Choose a display mode
  * Specify teammates and models
  * Require plan approval for teammates
  * Talk to teammates directly
  * Assign and claim tasks
  * Shut down teammates
  * Enforce quality gates with hooks
* How agent teams work
  * How Claude starts agent teams
  * Architecture
  * Use subagent definitions for teammates
  * Permissions
  * Context and communication
  * Token usage
* Use case examples
  * Run a parallel code review
  * Investigate with competing hypotheses
* Best practices
  * Give teammates enough context
  * Choose an appropriate team size
  * Size tasks appropriately
  * Wait for teammates to finish
  * Start with research and review
  * Avoid file conflicts
  * Monitor and steer
* Troubleshooting
  * Teammates not appearing
  * Too many permission prompts
  * Teammates stopping on errors
  * Lead shuts down before work is done
  * Orphaned tmux sessions
* Limitations
* Next steps

### [workflows](https://code.claude.com/docs/en/workflows.md)

* When to use a workflow
* Run a bundled workflow
  * Bundled workflows
  * Watch the run
* Have Claude write a workflow
  * Ask for a workflow in your prompt
  * Let Claude decide with ultracode
  * Approve the plan before it runs
  * Save the workflow for reuse
  * Pass input to a saved workflow
* Example workflow prompts
  * Audit many files for the same issue
  * Keep fixing until a check passes
  * Migrate many files in parallel
  * Review every changed file and write one summary
  * Research a topic across many sources
  * Find issues until the list stops growing
  * What the saved script looks like
* How a workflow runs
  * Behavior and limits
* Manage runs
  * Resume after a pause
  * Cost
  * Set a size guideline
  * Turn workflows off
* Related resources

### [worktrees](https://code.claude.com/docs/en/worktrees.md)

* Start Claude in a worktree
  * Choose the base branch
* Copy gitignored files into worktrees
* Isolate subagents with worktrees
* Clean up worktrees
* Manage worktrees manually
* Non-git version control
* See also

## MCP

### [mcp-quickstart](https://code.claude.com/docs/en/mcp-quickstart.md)

* Before you begin
* Add and verify a server
* Where servers are saved
  * Find your configuration on disk
* Change server scope
  * Use a server in all your projects
  * Share a server with your team
* Additional MCP server examples
  * Add a local server
  * Connect a server that requires sign-in
* Edit .mcp.json directly
* Connect from other surfaces
* Troubleshooting
* Next steps

### [mcp](https://code.claude.com/docs/en/mcp.md)

* What you can do with MCP
* Find and build MCP servers
* Installing MCP servers
  * Option 1: Add a remote HTTP server
  * Option 2: Add a remote SSE server
  * Option 3: Add a local stdio server
  * Option 4: Add a remote WebSocket server
  * Managing your servers
  * Dynamic tool updates
  * Automatic reconnection
  * Push messages with channels
  * Plugin-provided MCP servers
* MCP installation scopes
  * Local scope
  * Project scope
  * User scope
  * Scope hierarchy and precedence
  * Environment variable expansion in `.mcp.json`
* Practical examples
  * Example: Monitor errors with Sentry
  * Example: Connect to GitHub for code reviews
  * Example: Query your PostgreSQL database
* Authenticate with remote MCP servers
  * Authenticate from the command line
  * Use a fixed OAuth callback port
  * Use pre-configured OAuth credentials
  * Override OAuth metadata discovery
  * Restrict OAuth scopes
  * Use dynamic headers for custom authentication
* Add MCP servers from JSON configuration
* Import MCP servers from Claude Desktop
* Use MCP servers from claude.ai
  * Disable claude.ai connectors
* Use Claude Code as an MCP server
* MCP output limits and warnings
  * Raise the limit for a specific tool
* Tool input schemas with a root-level combinator
* Require approval for a specific tool
* Respond to MCP elicitation requests
* Use MCP resources
  * Reference MCP resources
* Scale with MCP tool search
  * How it works
  * For MCP server authors
  * Configure tool search
  * Exempt a server from deferral
* Use MCP prompts as commands
  * Execute MCP prompts
* Managed MCP configuration

## Skills

### [skills](https://code.claude.com/docs/en/skills.md)

* Bundled skills
  * Run and verify your app
* Getting started
  * Create your first skill
  * Where skills live
    * Live change detection
    * Automatic discovery from parent and nested directories
    * Skills from additional directories
* Configure skills
  * Types of skill content
  * Frontmatter reference
    * How a skill gets its command name
    * Available string substitutions
  * Add supporting files
  * Control who invokes a skill
  * Skill content lifecycle
  * Pre-approve tools for a skill
  * Pass arguments to skills
* Advanced patterns
  * Inject dynamic context
  * Run skills in a subagent
    * Example: Research skill using Explore agent
  * Restrict Claude's skill access
  * Override skill visibility from settings
* Evaluate and iterate on a skill
  * Run evals with skill-creator
* Share skills
  * Generate visual output
* Troubleshooting
  * Skill not triggering
  * Skill triggers too often
  * Skill descriptions are cut short
* Related resources

## Plugins

### [discover-plugins](https://code.claude.com/docs/en/discover-plugins.md)

* How marketplaces work
* Official Anthropic marketplace
  * Code intelligence
    * What Claude gains from code intelligence plugins
  * External integrations
  * Automatic security review
  * Development workflows
  * Output styles
* Community marketplace
* Try it: add the demo marketplace
* Add marketplaces
  * Add from GitHub
  * Add from other Git hosts
  * Add from local paths
  * Add from remote URLs
* Install plugins
* Manage installed plugins
  * Apply plugin changes without restarting
* Manage marketplaces
  * Use the interactive interface
  * Use CLI commands
  * Configure auto-updates
* Configure team marketplaces
* Security
* Troubleshooting
  * /plugin command not recognized
  * Common issues
  * Code intelligence issues
* Next steps

### [plugins](https://code.claude.com/docs/en/plugins.md)

* When to use plugins vs standalone configuration
* Quickstart
  * Prerequisites
  * Create your first plugin
* Develop a plugin in your skills directory
* Plugin structure overview
* Develop more complex plugins
  * Add Skills to your plugin
  * Add LSP servers to your plugin
  * Add background monitors to your plugin
  * Ship default settings with your plugin
  * Organize complex plugins
  * Test your plugins locally
  * Debug plugin issues
  * Share your plugins
  * Submit your plugin to the community marketplace
* Convert existing configurations to plugins
  * Migration steps
  * What changes when migrating
* Next steps
  * For plugin users
  * For plugin developers

## Artifacts

### [artifacts](https://code.claude.com/docs/en/artifacts.md)

* When to use an artifact
  * What an artifact is not
* Create an artifact
* Update an artifact
* Share an artifact
* What you can build
  * Walk through a change
  * Compare alternatives
  * Tune with interactive controls
  * Bring the result back to your session
  * Track work in progress
* Improve the visual design
* Page constraints
* Availability
* Disable artifacts
* Manage artifacts for your organization
  * Enable or disable artifacts
  * Set a retention policy
  * Review the audit log
  * Allowlist the viewer domain
  * List and delete artifacts with the Compliance API
* Related resources

## Automation

### [hooks-guide](https://code.claude.com/docs/en/hooks-guide.md)

* Set up your first hook
* What you can automate
  * Get notified when Claude needs input
  * Auto-format code after edits
  * Block edits to protected files
  * Re-inject context after compaction
  * Audit configuration changes
  * Reload environment when directory or files change
  * Auto-approve specific permission prompts
* How hooks work
  * Combine results from multiple hooks
  * Read input and return output
    * Hook input
    * Hook output
    * Structured JSON output
  * Filter hooks with matchers
    * Filter by tool name and arguments with the `if` field
  * Configure hook location
* Prompt-based hooks
* Agent-based hooks
* HTTP hooks
* Limitations and troubleshooting
  * Limitations
  * Hooks and permission modes
  * Hook not firing
  * Hook error in output
  * `/hooks` shows no hooks configured
  * Stop hook hits the block cap
  * JSON validation failed
  * Debug techniques
* Learn more

### [channels](https://code.claude.com/docs/en/channels.md)

* Supported channels
* Quickstart
* Security
* Enterprise controls
  * Enable channels for your organization
  * Restrict which channel plugins can run
* Research preview
* How channels compare
* Next steps

### [scheduled-tasks](https://code.claude.com/docs/en/scheduled-tasks.md)

* Compare scheduling options
* Run a prompt repeatedly with /loop
  * Run on a fixed interval
  * Let Claude choose the interval
  * Run the built-in maintenance prompt
  * Customize the default prompt with loop.md
  * Stop a loop
* Set a one-time reminder
* Manage scheduled tasks
* How scheduled tasks run
  * Jitter
  * Seven-day expiry
* Cron expression reference
* Disable scheduled tasks
* Limitations

### [goal](https://code.claude.com/docs/en/goal.md)

* Compare ways to keep a session running
* Use `/goal`
  * Set a goal
  * Write an effective condition
  * Check status
  * Clear a goal
  * Resume with an active goal
  * Run non-interactively
* How evaluation works
* Requirements
* See also

### [headless](https://code.claude.com/docs/en/headless.md)

* Basic usage
  * Start faster with bare mode
  * Background tasks at exit
* Examples
  * Pipe data through Claude
  * Add Claude to a build script
  * Get structured output
  * Stream responses
  * Auto-approve tools
  * Create a commit
  * Customize the system prompt
  * Continue conversations
* Next steps

### [deep-links](https://code.claude.com/docs/en/deep-links.md)

* How it works
  * What a launched session shows
* Build a link
  * Choose between `cwd` and `repo`
* Examples
  * Embed a link in a runbook
  * Open a link from the shell
* Registration and supported platforms
* Open a VS Code tab instead of a terminal
* Troubleshooting
  * Clicking the link does nothing
  * The link renders as plain text instead of being clickable
  * The session opens in my home directory instead of the repo
  * The link opens the wrong terminal
* Learn more

## Guides

### [large-codebases](https://code.claude.com/docs/en/large-codebases.md)

* What this guide covers
  * Settings on this page
  * The example monorepo
* Choose where to start Claude
* Layer CLAUDE.md files by directory
  * Choose between per-directory CLAUDE.md and path-scoped rules
  * Exclude irrelevant CLAUDE.md files
* Reduce what Claude reads
  * Block reads of generated and vendored code
  * Reduce file reads with code intelligence
* Scope worktrees and file access
  * Check out only the directories you need
  * Grant access across packages or repositories
* Add per-directory skills
  * Keep skills discoverable
* Centralize conventions when layering stops scaling
  * Recommend the right plugin at session start
* Put it together
* Scope and plan changes that span packages
* Next steps

## Troubleshooting

### [troubleshoot-install](https://code.claude.com/docs/en/troubleshoot-install.md)

* Find your error
* Run diagnostic checks
  * Check network connectivity
  * Verify your PATH
  * Check for conflicting installations
  * Check directory permissions
  * Verify the binary works
* Common installation issues
  * Install script returns HTML instead of a shell script
  * `command not found: claude` after installation
  * `curl: (56) Failure writing output to destination`
  * Homebrew cask unavailable or outdated
  * TLS or SSL connection errors
  * `Failed to fetch version from downloads.claude.ai`
  * Wrong install command on Windows
  * `The process cannot access the file` during Windows install
  * Install killed on low-memory Linux servers
  * Install hangs in Docker
  * Claude Desktop overrides the `claude` command on Windows
  * Claude Code on Windows requires either Git for Windows (for bash) or PowerShell
  * Claude Code does not support 32-bit Windows
  * Linux musl or glibc binary mismatch
  * `Illegal instruction`
  * `dyld: cannot load` on macOS
  * `Exec format error` on WSL1
  * npm install errors in WSL
  * Permission errors during installation
  * Native binary not found after npm install
* Login and authentication
  * Reset your login
  * OAuth error: Invalid code
  * 403 Forbidden after login
  * This organization has been disabled with an active subscription
  * OAuth login fails in WSL2, SSH, or containers
  * Not logged in or token expired
  * Bedrock, Agent Platform, or Foundry credentials not loading
* Still stuck

### [troubleshooting](https://code.claude.com/docs/en/troubleshooting.md)

* Performance and stability
  * High CPU or memory usage
  * Auto-compaction stops with a thrashing error
  * Command hangs or freezes
  * Garbled or corrupted text in an editor's integrated terminal
  * Search and discovery issues
  * Slow or incomplete search results on WSL
* Get more help

### [debug-your-config](https://code.claude.com/docs/en/debug-your-config.md)

* See what loaded into context
* Check resolved settings
* Check MCP servers
* Check hooks
* Test against a clean configuration
* Check common causes
* Related resources

### [errors](https://code.claude.com/docs/en/errors.md)

* Find your error
* Automatic retries
* Server errors
  * API Error: 500 Internal server error
  * API Error: Repeated 529 Overloaded errors
  * Request timed out
  * The response above may be incomplete
  * Auto mode cannot determine the safety of an action
  * Agent terminated early due to an API error
* Usage limits
  * You've hit your session limit
  * Usage credits required for 1M context
  * Server is temporarily limiting requests
  * Request rejected (429)
  * Credit balance is too low
* Authentication errors
  * Not logged in
  * Could not resolve authentication method
  * Invalid API key
  * This organization has been disabled
  * Your organization has disabled API key authentication
  * Your organization has disabled Claude subscription access
  * Routines are disabled by your organization's policy
  * Remote Control requires the Anthropic API
  * OAuth token revoked or expired
  * OAuth scope requirement
  * AWS credentials expired or invalid
  * AWS authentication failed
* Network and connection errors
  * Unable to connect to API
  * SSL certificate errors
  * Host not allowed in a cloud session
  * Couldn't reconnect to your Remote Control session
* Request errors
  * Prompt is too long
  * Error during compaction: Conversation too long
  * Request too large
  * Image was too large
  * Unable to resize image
  * PDF errors
  * Extra inputs are not permitted
  * There's an issue with the selected model
  * Model is not a recognized model id
  * Claude Opus is not available with the Claude Pro plan
  * Model is restricted by your organization's settings
  * thinking.type.enabled is not supported for this model
  * Thinking budget exceeds output limit
  * Tool use or thinking block mismatch
  * Usage Policy refusal
  * Safety measures flagged a cybersecurity topic
* Installation errors
  * Installation was killed before it could finish
  * The connection dropped while downloading the update
* Command-line errors
  * Conflict between --bg and --print
  * The --json-schema value is not a valid JSON Schema
  * Could not import a server from Claude Desktop
* Plugin errors
  * Marketplace is registered from an untrusted source
* Configuration warnings
  * Workspace has not been trusted
* Responses seem lower quality than usual
* Report an error

## Setup and access

### [admin-setup](https://code.claude.com/docs/en/admin-setup.md)

* Choose your API provider
* Decide how settings reach devices
* Decide what to enforce
* Set up usage visibility
* Review data handling
* Verify and onboard
* Next steps

### [setup](https://code.claude.com/docs/en/setup.md)

* System requirements
  * Additional dependencies
* Install Claude Code
  * Set up on Windows
  * Alpine Linux and musl-based distributions
* Verify your installation
* Authenticate
* Update Claude Code
  * Auto-updates
  * Configure release channel
  * Pin a minimum version
  * Disable auto-updates
  * Update manually
* Advanced installation options
  * Install a specific version
  * Install with Linux package managers
  * Install with npm
  * Binary integrity and code signing
    * Verify the manifest signature
    * Platform code signatures
* Uninstall Claude Code
  * Native installation
  * Homebrew installation
  * WinGet installation
  * apt / dnf / apk
  * npm
  * Remove configuration files

### [authentication](https://code.claude.com/docs/en/authentication.md)

* Log in to Claude Code
* Set up team authentication
  * Claude for Teams or Enterprise
  * Claude Console authentication
  * Cloud provider authentication
* Credential management
  * Renew an expiring login
  * Authentication precedence
  * Generate a long-lived token

### [server-managed-settings](https://code.claude.com/docs/en/server-managed-settings.md)

* Requirements
* Choose between server-managed and endpoint-managed settings
* Configure server-managed settings
  * Verify settings delivery
  * Access control
  * Managed-only settings
  * Current limitations
* Settings delivery
  * Settings precedence
  * Fetch and caching behavior
  * Invalid entries in delivered settings
  * Enforce fail-closed startup
  * Security approval dialogs
* Platform availability
* Audit logging
* Security considerations
* See also

### [managed-mcp](https://code.claude.com/docs/en/managed-mcp.md)

* Choose a pattern
* Exclusive control with managed-mcp.json
  * Authenticate with per-user credentials
  * Validate the configuration
  * Disable MCP entirely
  * Allow claude.ai connectors alongside the managed set
* Policy-based control with allowlists and denylists
  * Match servers by URL, command, or name
  * How a server is evaluated
  * Example configuration
  * Restrict the allowlist to managed settings only
* How restrictions appear to users
* Monitor MCP usage
* Configuration summary
* Related resources

### [auto-mode-config](https://code.claude.com/docs/en/auto-mode-config.md)

* Where the classifier reads configuration
* Define trusted infrastructure
* Override the block and allow rules
* Route all shell commands through the classifier
* Inspect the defaults and your effective config
* Review denials
* See also

## Deployment

### [third-party-integrations](https://code.claude.com/docs/en/third-party-integrations.md)

* Compare deployment options
* Configure proxies and gateways
  * Amazon Bedrock
  * Microsoft Foundry
  * Google Cloud's Agent Platform
* Best practices for organizations
  * Invest in documentation and memory
  * Simplify deployment
  * Start with guided usage
  * Pin model versions for cloud providers
  * Configure security policies
  * Leverage MCP for integrations
* Next steps

### [feature-availability](https://code.claude.com/docs/en/feature-availability.md)

* Availability by model provider
  * Features available on every provider
  * Features that require a Claude subscription
  * CLI capabilities that vary by provider
  * Admin and analytics
  * Summary by provider
* Availability by subscription plan
* Model availability
* Related resources

### [amazon-bedrock](https://code.claude.com/docs/en/amazon-bedrock.md)

* Prerequisites
* Sign in with Bedrock
* Set up manually
  * 1. Submit use case details
  * 2. Configure AWS credentials
    * Advanced credential configuration
      * Example configuration
      * Configuration settings explained
  * 3. Configure Claude Code
  * 4. Pin model versions
    * Map each model version to an inference profile
* Startup model checks
* IAM configuration
* 1M token context window
* Service tiers
* AWS Guardrails
* Use the Mantle endpoint
  * Enable Mantle
  * Select a Mantle model
  * Run Mantle alongside the Invoke API
  * Route Mantle through a gateway
  * Mantle environment variables
* Troubleshooting
  * Authentication loop with SSO and corporate proxies
  * Region issues
  * Zero token counts in /context
  * Mantle endpoint errors
* Additional resources

### [claude-platform-on-aws](https://code.claude.com/docs/en/claude-platform-on-aws.md)

* Prerequisites
* Setup
  * 1. Configure AWS credentials
  * 2. Configure Claude Code
  * 3. Pin model versions
* Use the Agent SDK
* Route through a corporate proxy
* Troubleshooting
  * `403 Forbidden` or `AccessDenied` on every request
  * Requests fail with a missing-workspace error
  * Requests still go to `api.anthropic.com`
* Additional resources

### [google-vertex-ai](https://code.claude.com/docs/en/google-vertex-ai.md)

* Prerequisites
* Sign in with Agent Platform
* Region configuration
* Set up manually
  * 1. Enable Agent Platform API
  * 2. Request model access
  * 3. Configure GCP credentials
    * Advanced credential configuration
  * 4. Configure Claude Code
  * 5. Pin model versions
* Startup model checks
* IAM configuration
* 1M token context window
* Troubleshooting
* Additional resources

### [microsoft-foundry](https://code.claude.com/docs/en/microsoft-foundry.md)

* Prerequisites
* Setup
  * 1. Provision Microsoft Foundry resource
  * 2. Configure Azure credentials
  * 3. Configure Claude Code
  * 4. Pin model versions
  * 5. Run Claude Code
* Azure RBAC configuration
* Troubleshooting
* Additional resources

### [network-config](https://code.claude.com/docs/en/network-config.md)

* Proxy configuration
  * Environment variables
  * Basic authentication
* CA certificate store
* Custom CA certificates
* mTLS authentication
* Network access requirements
* Additional resources

### [devcontainer](https://code.claude.com/docs/en/devcontainer.md)

* Add Claude Code to your dev container
* Persist authentication and settings across rebuilds
* Enforce organization policy
* Restrict network egress
* Run without permission prompts
* Try the reference container
* Next steps

### Gateways > Claude apps gateway

#### [claude-apps-gateway-config](https://code.claude.com/docs/en/claude-apps-gateway-config.md)

* File structure
* Secret expansion
* Required sections
  * `listen`
  * `oidc`
  * `session`
  * `store`
  * `upstreams`
    * Anthropic API
    * Amazon Bedrock
    * Claude Platform on AWS
    * Google Cloud Agent Platform
    * Microsoft Foundry
    * Multiple upstreams
* Optional sections
  * `admin`
  * `enforcement`
  * `models`
  * `managed`
    * What goes in `cli`
    * Precedence with other managed sources
  * `telemetry`
  * HTTP tuning
* Complete example
* Client-side managed settings
* Related

#### [claude-apps-gateway-spend-limits](https://code.claude.com/docs/en/claude-apps-gateway-spend-limits.md)

* Set a cap
  * Authenticate to the admin API
* How enforcement works
  * Postgres availability
* Admin API reference
  * `/effective`
  * `/audit`
  * Pagination
* Data lifecycle
* Related

#### [claude-apps-gateway-deploy](https://code.claude.com/docs/en/claude-apps-gateway-deploy.md)

* Identity provider setup
* Deployment
  * Container image
  * Kubernetes
  * Cloud Run
  * Push the gateway URL to developer machines
* Operations
  * Logs
  * Health
  * Outage behavior
  * JWT secret rotation
  * Postgres
  * Upgrades
* Security
  * Data flow
  * Threat model summary
  * User-code brute-force resistance
  * Compliance posture
* Troubleshooting
* Related

#### [claude-apps-gateway-on-gcp](https://code.claude.com/docs/en/claude-apps-gateway-on-gcp.md)

* What you'll build
* Prerequisites
* Deploy the gateway
* Terraform reference
* Troubleshooting
* Next steps

### Gateways > Other gateways

#### [llm-gateway-connect](https://code.claude.com/docs/en/llm-gateway-connect.md)

* Check for an existing configuration
* Configure Claude Code yourself
  * Set the credential variable
  * Set the base URL and credential
    * Set as shell environment variables
    * Set in a settings file
  * Verify the connection
    * Confirm in Claude Code
  * How the credential variable maps to a header
  * Conflicts with an existing login
* Configure each surface
  * VS Code extension
  * Desktop app
  * GitHub Actions
  * Agent SDK
  * Slack, web, and Remote Control
* Additional configuration
  * Send additional headers
  * Add gateway models to the model picker
  * Rotate credentials with apiKeyHelper
  * Route to a cloud provider through a gateway
    * Amazon Bedrock
    * Google Cloud's Agent Platform
    * Microsoft Foundry
    * Claude Platform on AWS
* Troubleshoot gateway errors
* Related resources

#### [llm-gateway-rollout](https://code.claude.com/docs/en/llm-gateway-rollout.md)

* Prerequisites
  * Gateway requirements
* Rollout steps
  * Confirm the gateway routes your models
  * Issue developer credentials
  * Test Claude Code against the gateway
  * Distribute the configuration
    * What to distribute
    * Distribute through managed settings
    * Hand developers the values to set themselves
  * Verify the rollout
* Maintain the gateway
* Related resources

#### [llm-gateway-protocol](https://code.claude.com/docs/en/llm-gateway-protocol.md)

* API formats
  * Foundry and Claude Platform on AWS
  * Optional endpoints and startup traffic
  * Streaming
  * Format mismatch with the upstream
* Request headers
  * Forward as open lists
* System prompt attribution block
* Feature pass-through
  * Automatic retry and error forwarding
  * Disable pre-release capabilities
* Model discovery
  * When discovery runs
  * Request and response
  * Picker entries and caching
* Related resources

## Gateways

### [gateways](https://code.claude.com/docs/en/gateways.md)

* How a gateway works
* Choose a gateway
  * Claude apps gateway
  * Other gateways
* Subscriptions and gateways
* Configure separately from the gateway
* Next steps

## Usage and costs

### [monitoring-usage](https://code.claude.com/docs/en/monitoring-usage.md)

* Quick start
* Administrator configuration
* Configuration details
  * Common configuration variables
  * mTLS authentication
  * Metrics cardinality control
  * Traces (beta)
    * Span hierarchy
    * Span attributes
  * Dynamic headers
    * Settings configuration
    * Script requirements
    * Refresh behavior
  * Multi-team organization support
  * Example configurations
* Available metrics and events
  * Standard attributes
  * Metrics
  * Metric details
    * Session counter
    * Lines of code counter
    * Pull request counter
    * Commit counter
    * Cost counter
    * Token counter
    * Code edit tool decision counter
    * Active time counter
  * Events
    * Event correlation attributes
    * User prompt event
    * Assistant response event
    * Tool result event
    * API request event
    * API error event
    * API refusal event
    * API request body event
    * API response body event
    * Tool decision event
    * Permission mode changed event
    * Auth event
    * MCP server connection event
    * Internal error event
    * Plugin installed event
    * Plugin loaded event
    * Skill activated event
    * At mention event
    * API retries exhausted event
    * Hook registered event
    * Hook execution start event
    * Hook execution complete event
    * Hook plugin metrics event
    * Compaction event
    * Feedback survey event
* Interpret metrics and events data
  * Usage monitoring
  * Cost monitoring
  * Alerting and segmentation
  * Detect retry exhaustion
  * Event analysis
* Audit security events
  * Attribute actions to users
  * Audit MCP activity
  * Map security questions to events
  * Send events to a SIEM
* Backend considerations
  * For metrics
  * For events/logs
  * For traces
* Service information
* ROI measurement resources
* Security and privacy
* Monitor Claude Code on Amazon Bedrock

### [costs](https://code.claude.com/docs/en/costs.md)

* Track your costs
  * Using the `/usage` command
* Managing costs for teams
  * Rate limit recommendations
  * Agent team token costs
* Reduce token usage
  * Manage context proactively
  * Choose the right model
  * Reduce MCP server overhead
  * Install code intelligence plugins for typed languages
  * Offload processing to hooks and skills
  * Move instructions from CLAUDE.md to skills
  * Adjust extended thinking
  * Delegate verbose operations to subagents
  * Manage agent team costs
  * Write specific prompts
  * Work efficiently on complex tasks
* Background token usage
* Understanding changes in Claude Code behavior

### [analytics](https://code.claude.com/docs/en/analytics.md)

* Access analytics for Team and Enterprise
  * Enable contribution metrics
  * Review summary metrics
  * Explore the charts
    * Track adoption
    * Measure PRs per user
    * View pull requests breakdown
    * Find top contributors
  * PR attribution
    * Tagging criteria
    * Attribution process
    * Time window
    * Excluded files
    * Attribution notes
  * Get the most from analytics
    * Monitor adoption
    * Measure ROI
    * Identify power users
    * Access data programmatically
* Access analytics for API customers
  * View team insights
* Related resources

## Plugin distribution

### [plugin-marketplaces](https://code.claude.com/docs/en/plugin-marketplaces.md)

* Overview
* Walkthrough: create a local marketplace
* Create the marketplace file
* Marketplace schema
  * Required fields
  * Owner fields
  * Optional fields
* Plugin entries
  * Required fields
  * Optional plugin fields
* Plugin sources
  * Relative paths
  * GitHub repositories
  * Git repositories
  * Git subdirectories
  * npm packages
  * Advanced plugin entries
  * Strict mode
* Host and distribute marketplaces
  * Host on GitHub (recommended)
  * Host on other git services
  * Private repositories
  * Test locally before distribution
  * Require marketplaces for your team
  * Pre-populate plugins for containers
  * Managed marketplace restrictions
    * Common configurations
    * How restrictions work
  * Version resolution and release channels
    * Set up release channels
      * Example
      * Assign channels to user groups
    * Pin dependency versions
  * Rename or remove a plugin
* Validation and testing
* Manage marketplaces from the CLI
  * Plugin marketplace add
  * Plugin marketplace list
  * Plugin marketplace remove
  * Plugin marketplace update
* Troubleshooting
  * Marketplace not loading
  * Marketplace validation errors
  * Plugin installation failures
  * Private repository authentication fails
  * Marketplace updates fail in offline environments
  * Git operations time out
  * Plugins with relative paths fail in URL-based marketplaces
  * Files not found after installation
* See also

### [plugin-dependencies](https://code.claude.com/docs/en/plugin-dependencies.md)

* Why constrain dependency versions
* Declare a dependency with a version constraint
* Depend on a plugin from another marketplace
* Tag plugin releases for version resolution
* How constraints interact
* Enable or disable a plugin with dependencies
* Remove orphaned auto-installed dependencies
* Resolve dependency errors
* See also

### [plugin-hints](https://code.claude.com/docs/en/plugin-hints.md)