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

404 pages for setup.

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

Quickstart Claude Code CLI · in the page agent-sdk/quickstart …you don't have one, [sign up here](https://platform.claude.com/). ## Setup **1. Create a project folder** Create a new directory for this quickstart: ```bash theme={null} mkdir my-agent cd my-agen… Securely deploying AI agents Claude Code CLI · in the page agent-sdk/secure-deployment …e | Good (secure defaults) | Very low | Low | | Containers (Docker) | Setup dependent | Low | Medium | | gVisor | Excellent (with correct setup) | Medium/High | Medium | | VMs (Firecracker, QEMU) | Ex… Work with sessions Claude Code CLI · in the page agent-sdk/sessions …rrent query. Use the client as an async context manager so connection setup and teardown are handled for you, or call `connect()` and `disconnect()` manually. This example runs two queries against th… Extend agents with skills Claude Code CLI · in the page agent-sdk/skills …ds that need an interactive terminal, such as `/theme` and `/terminal-setup`, don't appear in the list. Access the field when your session starts: ```typescript TypeScript theme={null} import { query… Get structured output from agents Claude Code CLI · in the page agent-sdk/structured-outputs …nt SDK by following the [quickstart](/docs/en/agent-sdk/quickstart.md#setup). The example below asks the agent to research Anthropic and return the company name, year founded, and headquarters as stru… Track todos Claude Code CLI · in the page agent-sdk/todo-tracking …quickstart.md). Every example on this page shares the same permission setup and exit behavior: * **Permission mode**: the example prompts ask Claude to do real work on a project, so each example sets… Scale to many tools with tool search Claude Code CLI · in the page agent-sdk/tool-search ….md). In a session that [gets the HIPAA configuration](/docs/en/hipaa-setup.md#check-how-developers-sign-in-and-connect), tool search is off, and neither `ENABLE_TOOL_SEARCH` nor managed settings turn… Troubleshoot the Agent SDK Claude Code CLI · in the page agent-sdk/troubleshooting …Claude Code if it isn't installed. See [Install Claude Code](/docs/en/setup.md#install-claude-code) for the command on your platform. * If you set `cli_path`, confirm the file exists and is the `claud… Agent SDK reference - TypeScript Claude Code CLI · in the page agent-sdk/typescript …`](#sdkhookresponsemessage). Lifecycle events for `SessionStart` and `Setup` hooks are always included and don't need this option. Some hook events, such as `Notification`, `SessionEnd`, `PreCompact`,… Orchestrate teams of Claude Code sessions Claude Code CLI · in the page agent-teams …w it and type to message it directly. Works in any terminal, no extra setup required. * **Split panes**: each teammate gets its own pane. You can see everyone's output at once and click into a pane to… Run agents in parallel Claude Code CLI · in the page agents …k-in-parallel-with-sessions). ## Learn more Each guide below covers setup and configuration for one approach: * [Create custom subagents](/docs/en/sub-agents.md): define reusable specialists and co… Claude Code on Amazon Bedrock Claude Code CLI · in the page amazon-bedrock …Learn about configuring Claude Code through Amazon Bedrock, including setup, IAM configuration, and troubleshooting. **Deploying Claude Code across your organization?** Talk to sales about enterprise… Track team usage with analytics Claude Code CLI · in the page analytics …aude for Enterprise accounts. Contribution metrics require additional setup to connect your GitHub organization. You need the Owner role to configure analytics settings. A GitHub admin must install t… Share session output as artifacts Claude Code CLI · in the page artifacts …rprise plans and require a session signed in with [`/login`](/docs/en/setup#authenticate). See [Availability](#availability) for the full set of requirements. An [artifact](https://claude.com/feature… Authentication Claude Code CLI · in the page authentication …laude Code supports multiple authentication methods depending on your setup. Individual users can log in with a claude.ai account, while teams can use Claude for Teams or Enterprise, the Claude Consol… Configure auto mode Claude Code CLI · in the page auto-mode-config …environment entries](#generate-environment-entries) with `/auto-mode-setup` * [Review denials](#review-denials) so you know what to add next ## Common boundaries Auto mode allows pushes to any bran… Best practices for Claude Code Claude Code CLI · in the page best-practices …the agent doing the work isn't the one grading it. Each step trades setup for attention. The prompt version works on any task today. The `/goal` and Stop hook versions are what let an unattended run… Champion kit Claude Code CLI · in the page champion-kit …ing your source. | [Permissions](/docs/en/permissions.md) | | "Is the setup worth the effort?" | Installation takes roughly two minutes, runs in the terminal, and requires no IDE extension. Running `/… Claude Code changelog Claude Code CLI · in the page changelog …ooks to be stopped after 30 minutes by default, failing the session's setup; if yours needs longer, raise `--checkout-hook-timeout-min` or set it to `0` * Self-hosted runner: Changed the certificate f… Push events into a running session with channels Claude Code CLI · in the page channels …ge. Events only arrive while the session is open, so for an always-on setup you run Claude in a background process or persistent terminal. Unlike integrations that spawn a fresh cloud session or wait… Channels reference Claude Code CLI · in the page channels-reference …-way channel, omit `capabilities.tools`. This example shows a two-way setup with the channel capability, tools, and instructions set: ```ts theme={null} import { Server } from '@modelcontextprotocol/… Use Claude Code with Chrome Claude Code CLI · in the page chrome …you authenticate with an API key or a long-lived token from [`claude setup-token`](/docs/en/authentication#generate-a-long-lived-token), Claude Code keeps Chrome integration off, even when you pass `… Claude apps gateway for Amazon Bedrock, Claude Platform on AWS, Google Cloud, and Microsoft Foundry Claude Code CLI · in the page claude-apps-gateway …loyment guide](/docs/en/claude-apps-gateway-deploy.md) covers per-IdP setup, Kubernetes and Cloud Run deployment, and operations. ## Why Claude apps gateway The [gateway overview](/docs/en/gateways.… Claude apps gateway configuration Claude Code CLI · in the page claude-apps-gateway-config …the gateway uses with your identity provider; see [Identity provider setup](/docs/en/claude-apps-gateway-deploy.md#identity-provider-setup) for what to register on the IdP side. | Field | Required |… Claude apps gateway deployment and operations Claude Code CLI · in the page claude-apps-gateway-deploy …it's running. 1. [Set up your identity provider](#identity-provider-setup): register the OAuth client and check the per-IdP notes for Okta, Entra, and Google 2. [Deploy the gateway](#deployment): bu… Deploy Claude apps gateway on AWS Claude Code CLI · in the page claude-apps-gateway-on-aws …any OpenID Connect (OIDC) compliant IdP works; see [Identity provider setup](/docs/en/claude-apps-gateway-deploy.md#identity-provider-setup) for per-IdP details. > [!NOTE] > > Bedrock isn't the only… Deploy Claude apps gateway on Google Cloud Claude Code CLI · in the page claude-apps-gateway-on-gcp …iant IdP works; only the `oidc` block changes. See [Identity provider setup](/docs/en/claude-apps-gateway-deploy.md#identity-provider-setup) for per-IdP details. ## What you'll build ![Diagram of Cl… Use Claude Code in the cloud Claude Code CLI · in the page claude-code-on-the-web …onfiguration that controls network access, environment variables, and setup scripts. * **Your first environment**: if you don't have one yet, onboarding sets up a **Default** environment with [**Trus… Explore the .claude directory Claude Code CLI · in the page claude-directory …* The [HIPAA configuration applies to your sessions](/docs/en/hipaa-setup#check-how-developers-sign-in-and-connect) Claude Code skips the age-based sweep in these cases: * **Bare mode**: when you… Claude Code on Claude Platform on AWS Claude Code CLI · in the page claude-platform-on-aws …hrough Claude Platform on AWS. For the AWS subscription and workspace setup that comes before this, see the [Claude Platform on AWS documentation](https://platform.claude.com/docs/en/build-with-claude… Let Claude coordinate ongoing work with Projects Claude Code CLI · in the page claude-projects …e project. Cloud threads don't pick up anything from the Claude Code setup on your own machine. [Get skills, plugins, connectors, and tools into threads](#get-skills-plugins-connectors-and-tools-into… claude-tag Claude Code CLI · in the page claude-tag …r Slack channels with admin-governed access. See what to hand it, how setup works, and where to start as an admin or end user."/><meta name="application-name" content="Claude.ai Documentation"/><meta… CLI reference Claude Code CLI · in the page cli-reference …`, or `stable` or `latest`. See [Install a specific version](/docs/en/setup#install-a-specific-version)… Configure cloud environments Claude Code CLI · in the page cloud-environments …de Code cloud sessions: network access levels, environment variables, setup scripts, and environment caching. > [!NOTE] > > Cloud environments apply to [cloud sessions](/docs/en/claude-code-on-the-we… Code Review Claude Code CLI · in the page code-review …a-retention) enabled or with the [HIPAA configuration](/docs/en/hipaa-setup) applied, and is not covered under Anthropic's BAA. On other plans, you can still [review a diff locally](#review-a-diff-loc… Code Review costs and usage Claude Code CLI · in the page code-review-costs …of each review**: scales with the [review level](/docs/en/code-review-setup.md#set-the-default-review-level), the size of the change, the complexity of the surrounding code, and how many candidate iss… Customize Code Review Claude Code CLI · in the page code-review-customize …y run, ask an Owner to change the [review level](/docs/en/code-review-setup.md#set-the-default-review-level) or the [**Review runs** setting](/docs/en/code-review-setup.md#set-when-reviews-run). ## U… Review locally with /code-review Claude Code CLI · in the page code-review-local …ta Retention enabled or with the [HIPAA configuration](/docs/en/hipaa-setup.md) applied. In these cases, `/code-review ultra` runs a local review in your session instead. Organizations that use [custo… Read and request reviews on a pull request Claude Code CLI · in the page code-review-pull-requests …a failure. An Owner controls [when reviews run](/docs/en/code-review-setup.md#set-when-reviews-run) and [how thorough they are](/docs/en/code-review-setup.md#set-the-default-review-level) for each re… Troubleshoot Code Review Claude Code CLI · in the page code-review-troubleshooting …failed, or was skipped for budget, find missing findings, and resolve setup and `REVIEW.md` problems. When [Code Review](/docs/en/code-review.md) doesn't do what you expect on a pull request, start w… Commands Claude Code CLI · in the page commands …checkpoint, or summarizes part of the conversation. `/doctor` runs a setup checkup that diagnoses installation and configuration issues and can fix them, `/debug` diagnoses runtime issues, and `/feed… Communications kit Claude Code CLI · in the page communications-kit …my working diff and tell me what looks risky" None of these need setup. Just `cd` into your repo and run `claude`. *Try it now:* pick the bug you have been avoiding and paste the error message i… Let Claude use your computer from the CLI Claude Code CLI · in the page computer-use …re you to restart Claude Code after granting Screen Recording. After setup, ask Claude to do something that needs the GUI: ```text theme={null} Build the app target, launch it, and click through eac… Explore the context window Claude Code CLI · in the page context-window …eparate context window. It loads CLAUDE.md and the same MCP and skill setup, but starts without your conversation history or the main session's auto memory.", link: '/en/sub-agents' }, { t:… Run Claude Code behind a corporate launcher Claude Code CLI · in the page corporate-launcher …th Claude Code: ```bash theme={null} #!/bin/sh # Your organization's setup: enter the sandbox, apply # network controls, or inject credentials. exec "$@" ``` Make it executable with `chmod +x`. The… Manage costs effectively Claude Code CLI · in the page costs …ed according to the one they authenticated with. The table maps each setup to where you see spend, where you cap it, and how you pull per-user numbers. On an individual Pro or Max plan you have no or… Debug your configuration Claude Code CLI · in the page debug-your-config …` | Resolved allow and deny rules currently in effect | | `/doctor` | Setup checkup: installation health, invalid settings files, unused extensions, duplicate [subagent](/docs/en/sub-agents.md) names… Desktop application Claude Code CLI · in the page desktop …n > **[Download for Windows](https://claude.ai/api/desktop/win32/x64/setup/latest/redirect?utm_source=claude_code\&utm_medium=docs)** > > For x64 processors > **[Get Claude for Linux (beta)](/docs/e… Test iOS apps in the simulator Claude Code CLI · in the page desktop-ios-simulator …boots it. If Xcode or its simulators are missing, the pane shows the setup steps instead and checks them off as you complete them. ## Control the simulator yourself The simulator pane is interactiv… Claude Desktop on Linux (beta) Claude Code CLI · in the page desktop-linux …t aren't Debian-based, such as Fedora or Arch, run the [CLI](/docs/en/setup.md#system-requirements) instead. If you work on Windows with WSL 2, install the Windows desktop app and run sessions inside…
Feedback