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

409 pages for options.

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 …={null} import asyncio from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, ResultMessage async def main(): # Agentic loop: streams messages as Claude works async for me… Securely deploying AI agents Claude Code CLI · in the page agent-sdk/secure-deployment …sing customer data in a multi-tenant environment. This guide presents options ranging from Claude Code's built-in security features to hardened production architectures, so you can choose what fits yo… Persist sessions to external storage Claude Code CLI · in the page agent-sdk/session-storage …CONFIG_DIR` in a query's [`env` option](/docs/en/agent-sdk/typescript#options), the SDK keys that query's entries, and its `resume` and `continue` lookups, by that name instead. Because standalone hel… Work with sessions Claude Code CLI · in the page agent-sdk/sessions …to disk | Set [`persistSession: false`](/docs/en/agent-sdk/typescript#options) (TypeScript only). The session exists only in memory for the duration of the call. In Python, set [`CLAUDE_CODE_SKIP_PROM… Extend agents with skills Claude Code CLI · in the page agent-sdk/skills …overed through the filesystem setting sources. With default `query()` options, the SDK loads user and project sources, so skills in `~/.claude/skills/`, `<cwd>/.claude/skills/`, and `.claude/skills/`… Stream responses in real-time Claude Code CLI · in the page agent-sdk/streaming-output …` (Python) or `includePartialMessages` (TypeScript) to `true` in your options. This causes the SDK to yield `StreamEvent` messages containing raw API events as they arrive, in addition to the usual `A… Streaming Input Claude Code CLI · in the page agent-sdk/streaming-vs-single-mode …s for await (const message of query({ prompt: generateMessages(), options: { maxTurns: 10, allowedTools: ["Read", "Grep"] } })) { if (message.type === "result" && message.subtype === "… Get structured output from agents Claude Code CLI · in the page agent-sdk/structured-outputs …prompt: "Research Anthropic and provide key company information", options: { outputFormat: { type: "json_schema", schema: schema } } })) { // The result messa… Subagents in the SDK Claude Code CLI · in the page agent-sdk/subagents …* **Programmatically**: use the `agents` parameter in your `query()` options. See the [TypeScript](/docs/en/agent-sdk/typescript.md#agentdefinition) and [Python](/docs/en/agent-sdk/python.md#agentdef… Track todos Claude Code CLI · in the page agent-sdk/todo-tracking …tools on models where Claude Code otherwise doesn't provide them. options: { maxTurns: 15, permissionMode: "acceptEdits", env: { ...process.env, CLAUDE_CODE_ENABLE_TODO_TOOLS: "1" } }, })) {… Scale to many tools with tool search Claude Code CLI · in the page agent-sdk/tool-search …ude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#hosting-options), which reject it server-side: the SDK detects the rejection and loads tool definitions upfront for that deployment instea… Troubleshoot the Agent SDK Claude Code CLI · in the page agent-sdk/troubleshooting …g](/docs/en/agent-sdk/subagents.md#troubleshooting) | | Checkpointing options not recognized, user messages without UUIDs, `No file checkpoint found`, `File rewinding is not enabled`, `ProcessTranspor… Agent SDK reference - TypeScript Claude Code CLI · in the page agent-sdk/typescript …for <platform>-<arch> not found`; set [`pathToClaudeCodeExecutable`](#options) to a separately installed `claude` binary instead. > > If your package manager doesn't apply npm's `libc` field, as Yarn… TypeScript SDK V2 session API (removed) Claude Code CLI · in the page agent-sdk/typescript-v2-preview …meSession`, `unstable_v2_prompt`, and the `SDKSession` and `SDKSessionOptions` types. > > To migrate, use the [`query()` API](/docs/en/agent-sdk/typescript) and the [session options](/docs/en/agent-sd… Handle approvals and user input Claude Code CLI · in the page agent-sdk/user-input …essage. For clarifying questions, Claude generates the questions and options. Your role is to present them to users and return their selections. You can't add your own questions to this flow; if you… Manage multiple agents with agent view Claude Code CLI · in the page agent-view …2 in 4m Completed ✻ title screen menu, options, and credits done 9m ∙ sound effects 14 SFX exported to assets/audio 4h … 6 mo… Claude Code on Amazon Bedrock Claude Code CLI · in the page amazon-bedrock …``` Entries with the `anthropic.` prefix are added as custom picker options, and the ones that match the Mantle format are routed to Mantle. Replace `anthropic.claude-haiku-4-5` with the model ID yo… Share session output as artifacts Claude Code CLI · in the page artifacts …the session already pulled * Lay out several design or implementation options side by side * Keep an investigation timeline that fills in while a long task runs * Send a teammate a link instead of pas… Best practices for Claude Code Claude Code CLI · in the page best-practices …s while keeping recent ones in full. See [the rewind menu's summarize options](/docs/en/checkpointing.md#rewind-and-summarize). * Customize compaction behavior in CLAUDE.md with instructions like `"Wh… Claude Code changelog Claude Code CLI · in the page changelog …o share can reproduce a request exactly * Changed the `/sandbox` mode options to read "Sandbox commands" instead of "Sandbox BashTool" * Changed `PermissionRequest` hooks in Cowork cloud sessions: a `… Channels reference Claude Code CLI · in the page channels-reference …le-build-a-webhook-receiver): a minimal one-way walkthrough * [Server options](#server-options): the constructor fields * [Notification format](#notification-format): the event payload and delivery be… Checkpointing Claude Code CLI · in the page checkpointing …turn to the message list without making changes The two code restore options appear only when the selected checkpoint has tracked file changes to revert. If no file edits were captured after that poi… Claude apps gateway for Amazon Bedrock, Claude Platform on AWS, Google Cloud, and Microsoft Foundry Claude Code CLI · in the page claude-apps-gateway …hooks in the SDK's [`settings` option](/docs/en/agent-sdk/typescript#options). | | [`disableSkillShellExecution: true`](/docs/en/settings-reference#disableskillshellexecution) | Takes effect. | | `al… Claude apps gateway deployment and operations Claude Code CLI · in the page claude-apps-gateway-deploy …at most once a minute. To serve more requests at once, you have two options: * Add replicas. * Raise the limit on each replica. Set the `BUN_CONFIG_MAX_HTTP_REQUESTS` environment variable on the ga… Deploy Claude apps gateway on AWS Claude Code CLI · in the page claude-apps-gateway-on-aws …"logConfiguration": { "logDriver": "awslogs", "options": { "awslogs-group": "/ecs/claude-gateway", "awslogs-region": "<region>", "awslogs-stream-pr… Deploy Claude apps gateway on Google Cloud Claude Code CLI · in the page claude-apps-gateway-on-gcp …/run/docs/securing/private-networking) covers the infrastructure both options need. Verify sign-in once the gateway is serving on a private hostname; until then, confirm the container booted from its… Use Claude Code in the cloud Claude Code CLI · in the page claude-code-on-the-web …ub with one of the [GitHub connection methods](#github-authentication-options). If your repository is on GitLab, Bitbucket, or another host, see [Platform restrictions](#limitations) for what works.… Explore the .claude directory Claude Code CLI · in the page claude-directory …ctory per list | | `shell-snapshots/` | Aliases, functions, and shell options captured at startup and applied by the [Bash tool](/docs/en/tools-reference#bash-tool-behavior) to each command. Removed o… Let Claude coordinate ongoing work with Projects Claude Code CLI · in the page claude-projects …urn stops once the project opens. A local session doesn't have these options. To continue its work in a project, describe the work in the project conversation, or push its branch, add that repository… CLI reference Claude Code CLI · in the page cli-reference …ing agents into Claude Code. Accepts the same `--dry-run` and `--yes` options as the command. Not available on Amazon Bedrock, Google Cloud's Agent Platform, Microsoft Foundry, or Claude Platform on A… Configure cloud environments Claude Code CLI · in the page cloud-environments …/docs/en/self-hosted-environments-deploy.md#configure-git) covers the options, including per-session minted credentials and an opt-in to this same proxy. The proxy provides: * **Git credentials**: th… Set up Code Review Claude Code CLI · in the page code-review-setup …*Edit** on its row, select a **Review runs** option, and confirm. The options are the three from [Set when reviews run](#set-when-reviews-run) plus **Off**. After you confirm, these changes take effe… Commands Claude Code CLI · in the page commands …e where your project's Claude API spend goes and propose savings from options such as prompt caching, trimming unneeded input and output tokens, batch processing, effort, and model choice, one change… Manage costs effectively Claude Code CLI · in the page costs …not cover this usage. For per-user cost attribution, you have three options: * **OpenTelemetry**: [export metrics](/docs/en/monitoring-usage.md) from each developer's machine to your own observabil… Data usage Claude Code CLI · in the page data-usage …ude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#hosting-options). For Hosted on Azure deployments, prompts and completions remain within Azure; only usage metadata and content flagged by… Desktop application Claude Code CLI · in the page desktop …use** section in **Settings > This computer > System** includes these options: * **Denied apps**: add apps here to reject them without prompting. Claude may still affect a denied app indirectly throu… Schedule recurring tasks in Claude Code Desktop Claude Code CLI · in the page desktop-scheduled-tasks …rs local scheduled tasks; for cloud scheduled tasks and their trigger options, see [Automate work with scheduled tasks](/docs/en/routines.md). ## Compare scheduling options Claude Code offers three… Error reference Claude Code CLI · in the page errors …the hint because the model is set programmatically. Set [`model` on `Options`](/docs/en/agent-sdk/typescript#options) in TypeScript or [`ClaudeAgentOptions(model=...)`](/docs/en/agent-sdk/python#clau… Feature availability Claude Code CLI · in the page feature-availability …ude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#hosting-options). On Google Cloud's Agent Platform, tool search isn't supported on models earlier than Claude Opus 4.5, Claude Sonnet 4.5,… Extend Claude Code Claude Code CLI · in the page features-overview …as its own guide with setup instructions, examples, and configuration options. > **[CLAUDE.md](/docs/en/memory.md)** > > Store project context, conventions, and instructions > **[Skills](/docs/en/sk… Fullscreen rendering Claude Code CLI · in the page fullscreen …n prompts, `/model`, `/config`, and other dialogs that show a list of options. * **Click an option in a multi-select menu** to toggle it, and click the submit button to confirm your choices. Clicking… Run Claude Code through a gateway Claude Code CLI · in the page gateways …shown as the Anthropic API, and dashed arrows lead to other provider options, illustrated with Amazon Bedrock, Google Cloud, and Microsoft Foundry as examples.](https://mintcdn.com/claude-code/-uq-4J… Claude Code GitHub Actions Claude Code CLI · in the page github-actions …utomation-modes) 3. Replace `direct_prompt` with `prompt` 4. Move CLI options such as `max_turns` and `model` into `claude_args`. `custom_instructions` has no same-name flag and becomes `--append-syst… Use Claude Code GitHub Actions with cloud providers Claude Code CLI · in the page github-actions-cloud-providers …th a custom app. That step also says what to change for the other two options. To create a custom app, [register a new GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-g… Claude Code with GitHub Enterprise Server Claude Code CLI · in the page github-enterprise-server …. After you click **Add configuration**, open the connection's **More options** menu, select **Copy webhook URL**, and paste the URL into the app's webhook settings on your GHES instance. Use the same… Claude Code GitLab CI/CD Claude Code CLI · in the page gitlab-ci-cd …Claude API (SaaS) * Amazon Bedrock (IAM-based access, cross-region options) * Google Cloud's Agent Platform (GCP-native, Workload Identity Federation) 3. **Sandboxed execution**: Each interacti… Glossary Claude Code CLI · in the page glossary …same gallery as artifacts created in claude.ai conversations. Sharing options depend on your plan: see [Share an artifact](/docs/en/artifacts.md#share-an-artifact). Learn more: [Share session output… Keep Claude working toward a goal Claude Code CLI · in the page goal …pen session, such as nightly tests or morning triage. See [scheduling options](/docs/en/scheduled-tasks.md#compare-scheduling-options) for cloud and Desktop scheduled tasks. ## Use `/goal` One goal… Claude Code on Google Cloud's Agent Platform Claude Code CLI · in the page google-vertex-ai …See [Configure GCP credentials](#3-configure-gcp-credentials) for all options If you encounter quota issues: * Check current quotas or request quota increase through [Cloud Console](https://cloud.go… Run Claude Code programmatically Claude Code CLI · in the page headless …Code in non-interactive mode, pass `-p` with your prompt and the [CLI options](/docs/en/cli-reference.md) you need: ```bash theme={null} claude -p "Find and fix the bug in auth.py" --allowedTools "Re…
Feedback