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

1,488 pages for read.

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

Observability with OpenTelemetry Claude Code CLI · in the page agent-sdk/observability …, and how to tag and filter the data once it reaches your backend. To read token usage and cost directly from the SDK response stream instead of exporting to a backend, see [Track cost and usage](/doc… Agent SDK overview Claude Code CLI · in the page agent-sdk/overview …hat completes a task by planning its own steps and calling tools that read files, run commands, or edit code. The Agent SDK gives you the same tools, [agent loop](/docs/en/agent-sdk/agent-loop.md), an… Configure permissions Claude Code CLI · in the page agent-sdk/permissions …is resolved at this step too, with no rule needed: for example a file read inside your working directories or a [read-only Bash command](/docs/en/permissions.md#read-only-commands). Recognized [criti… Plugins in the SDK Claude Code CLI · in the page agent-sdk/plugins …syntax 3. **Check file permissions**: ensure the plugin directory is readable 4. **Confirm the directory exists**: the SDK skips a nonexistent path, and the plugin doesn't appear in the init message'… Agent SDK reference - Python Claude Code CLI · in the page agent-sdk/python …r` | Unique identifier for the tool | | `description` | `str` | Human-readable description of what the tool does | | `input_schema` | `type \| dict[str, Any]` | Schema defining the tool's input parame… Quickstart Claude Code CLI · in the page agent-sdk/quickstart …s that work autonomously Use the Agent SDK to build an AI agent that reads your code, finds bugs, and fixes them, all without manual intervention. **What you'll do:** 1. Set up a project with the A… Securely deploying AI agents Claude Code CLI · in the page agent-sdk/secure-deployment …is sometimes called prompt injection. For example, if a repository's README contains unusual instructions, Claude Code might incorporate those into its actions in ways the operator didn't anticipate.… Persist sessions to external storage Claude Code CLI · in the page agent-sdk/session-storage …eploys. * **Compliance and audit.** Keep transcripts in storage you already govern, with your own retention rules, encryption, and access controls. ## The `SessionStore` interface A `SessionStore` i… Work with sessions Claude Code CLI · in the page agent-sdk/sessions …to a session means the agent has full context from before: files it already read, analysis it already performed, decisions it already made. You can ask a follow-up question, recover from an interrupti… Extend agents with skills Claude Code CLI · in the page agent-sdk/skills …, # Let Claude invoke every discovered skill allowed_tools=["Read", "Write", "Bash"], ) async for message in query( prompt="Help me process this PDF document", options=option… Stream responses in real-time Claude Code CLI · in the page agent-sdk/streaming-output …include_partial_messages=True, allowed_tools=["Bash", "Read"], ) async for message in query(prompt="List the files in my project", options=options): if isinstance(messa… Streaming Input Claude Code CLI · in the page agent-sdk/streaming-vs-single-mode …multiple turns naturally ### Implementation Example These examples read an image named `diagram.png` from the working directory. Create one there first, or change the filename to point at your own… Get structured output from agents Claude Code CLI · in the page agent-sdk/structured-outputs …the object the agent produced for your schema * A `tool_result` block reading `Structured output provided successfully` When that object doesn't match your schema, the `tool_result` carries `is_error… Subagents in the SDK Claude Code CLI · in the page agent-sdk/subagents …n. The parent receives a concise summary, not every file the subagent read. See [What subagents inherit](#what-subagents-inherit) for exactly what's in the subagent's context. * **Parallelization**: m… Track todos Claude Code CLI · in the page agent-sdk/todo-tracking …s a structured tool call. Opt a session in only when your application reads those tool calls, whether to log task activity or to render its own progress display. ## Model availability > [!NOTE] > >… Scale to many tools with tool search Claude Code CLI · in the page agent-sdk/tool-search …searches for relevant ones when the task requires a capability not already loaded. Up to five of the most relevant tools are loaded into context by default, where they stay available for subsequent t… Troubleshoot the Agent SDK Claude Code CLI · in the page agent-sdk/troubleshooting …int found`, `File rewinding is not enabled`, `ProcessTransport is not ready for writing` | [File checkpointing troubleshooting](/docs/en/agent-sdk/file-checkpointing.md#troubleshooting) | | Hook not f… Agent SDK reference - TypeScript Claude Code CLI · in the page agent-sdk/typescript …warm()`, the `InMemorySessionStore` class, and the helpers that list, read, fork, import, and summarize sessions. If you need one of them, use the root entry instead. The root entry inlines its own c… TypeScript SDK V2 session API (removed) Claude Code CLI · in the page agent-sdk/typescript-v2-preview …f session.stream()) { // Filter for assistant messages to get human-readable output if (msg.type === "assistant") { const text = msg.message.content .filter((block) => block.type === "te… Handle approvals and user input Claude Code CLI · in the page agent-sdk/user-input …, `content` | | `Edit` | `file_path`, `old_string`, `new_string` | | `Read` | `file_path`, `offset`, `limit` | See the SDK reference for complete input schemas: [Python](/docs/en/agent-sdk/python.md#… Orchestrate teams of Claude Code sessions Claude Code CLI · in the page agent-teams …t is `"in-process"`. Set `"auto"` to enable split panes when you're already running inside a tmux session, or when your terminal is iTerm2 with the `it2` CLI installed, falling back to in-process othe… Manage multiple agents with agent view Claude Code CLI · in the page agent-view …nother terminal and send it a message first. To move a session you already have open into agent view, run `/bg` inside it, or press `←` on an empty prompt to background it and open agent view in one… Run agents in parallel Claude Code CLI · in the page agents …/code or in the desktop app. Claude starts parallel sessions called threads, in the cloud or, when you ask, on your computer through Remote Control, gives each one the project's instructions, and show… Claude Code on Amazon Bedrock Claude Code CLI · in the page amazon-bedrock …, select **3rd-party platform**, then **Amazon Bedrock**. If you're already signed in and see the chat prompt instead, run `/setup-bedrock` to open the wizard. Until `CLAUDE_CODE_USE_BEDROCK=1` is set… Track team usage with analytics Claude Code CLI · in the page analytics …ess the dashboard for your plan: | Plan | Dashboard URL | Includes | Read more | | - | - | - | - | | Claude for Teams / Enterprise | [claude.ai/analytics/claude-code](https://claude.ai/analytics/clau… Share session output as artifacts Claude Code CLI · in the page artifacts …is open with the Always share latest version toggle, a version picker reading Sharing version 2, an Everyone at Acme audience selector, and a Copy link button. Below the header, the artifact page show… Authentication Claude Code CLI · in the page authentication …or the cached server-managed settings, exists but Claude Code [can't read it](/docs/en/managed-settings.md#invalid-entries-in-managed-settings) and no other managed source supplies a policy Unset `A… Auto mode classifier request charges Claude Code CLI · in the page auto-mode-classifier-billing …it emits a `system` warning message, which Agent SDK applications can read from the message stream. ## Make the session eligible If a gateway is the cause, ask your company's admin or your gateway p… Configure auto mode Claude Code CLI · in the page auto-mode-config …ask or deny rule for a durable guarantee. | ## Where the classifier reads configuration The classifier reads the same [CLAUDE.md](/docs/en/memory.md) content Claude itself loads, so an instruction… Best practices for Claude Code Claude Code CLI · in the page best-practices …t. Unlike a chatbot that answers questions and waits, Claude Code can read your files, run commands, make changes, and autonomously work through problems while you watch, redirect, or step away entire… Champion kit Claude Code CLI · in the page champion-kit …option on your team. This page is for individual engineers who are already using Claude Code and want to help their team adopt it. It covers what to share, how to answer the questions you will get, a… Claude Code changelog Claude Code CLI · in the page changelog …reates so they ignore git replace refs, as its other git operations already do * Fixed profile store write protection not applying when the config directory is reached through a symlink * Fixed sessio… Push events into a running session with channels Claude Code CLI · in the page channels …pen while you're not at the terminal. Channels can be two-way: Claude reads the event and replies back through the same channel, like a chat bridge. Events only arrive while the session is open, so fo… Channels reference Claude Code CLI · in the page channels-reference …k channel arrive as <channel source="webhook" ...>. They are one-way: read them and act, no reply expected.', }, ) // Connect to Claude Code over stdio (Claude Code spawns this process) await mcp.c… Checkpointing Claude Code CLI · in the page checkpointing …rize** option with the arrow keys and type instructions where the row reads **add context (optional)**, then press `Enter`. Selecting the option with its number key summarizes immediately without inst… Use Claude Code with Chrome Claude Code CLI · in the page chrome …shares your browser's login state, so it can access any site you're already signed into. Browser actions run in a visible Chrome window in real time. When Claude encounters a login page or CAPTCHA, it… Claude apps gateway for Amazon Bedrock, Claude Platform on AWS, Google Cloud, and Microsoft Foundry Claude Code CLI · in the page claude-apps-gateway …y-deploy.md#deployment). ### Other gateway implementations If you already run an LLM gateway or API gateway that meets your needs, keep using it; [Other LLM gateways](/docs/en/llm-gateway) covers co… Claude apps gateway configuration Claude Code CLI · in the page claude-apps-gateway-config …sting it on Kubernetes, Cloud Run, or your own platform. The gateway reads the file once, at startup, with `claude gateway --config /path/to/gateway.yaml`. Every option is validated against a schema… Claude apps gateway deployment and operations Claude Code CLI · in the page claude-apps-gateway-deploy …t day-to-day. For every option in the `gateway.yaml` file the gateway reads at boot, see the [Configuration reference](/docs/en/claude-apps-gateway-config.md). A production deployment follows four st… Deploy Claude apps gateway on AWS Claude Code CLI · in the page claude-apps-gateway-on-aws …state. The gateway signs users in via OIDC against the corporate IdP, reads secrets from AWS Secrets Manager, forwards model requests to Amazon Bedrock using its IAM role, and pulls its image from Ama… Deploy Claude apps gateway on Google Cloud Claude Code CLI · in the page claude-apps-gateway-on-gcp …state. The gateway signs users in via OIDC against Google Workspace, reads config and secrets from Secret Manager, forwards model requests to Google Cloud's Agent Platform, and pulls its image from A… Claude apps gateway spend limits Claude Code CLI · in the page claude-apps-gateway-spend-limits …/docs/en/claude-apps-gateway-config#admin) for full access, or `admin.read_keys` for `GET`-only access. Each key carries an `id` that appears in the audit log as `admin-key:<id>`, so give Terraform, C… Use Claude Code in the cloud Claude Code CLI · in the page claude-code-on-the-web …not the Claude GitHub App is installed | Individual developers who already use `gh` | These features depend on the Claude GitHub App being installed on the repository: * **Auto-fix**: installing th… Explore the .claude directory Claude Code CLI · in the page claude-directory # Explore the .claude directory > Where Claude Code reads CLAUDE.md, settings.json, hooks, skills, commands, subagents, workflows, rules, and auto memory. Explore the .claude directory in your projec… Claude Code on Claude Platform on AWS Claude Code CLI · in the page claude-platform-on-aws …ll list. Use this guide to point Claude Code at a workspace you've already provisioned through Claude Platform on AWS. For the AWS subscription and workspace setup that comes before this, see the [Cl… Let Claude coordinate ongoing work with Projects Claude Code CLI · in the page claude-projects …related work for you. You tell it what needs doing and it starts a thread for each task. Each thread is usually a [cloud session](/docs/en/claude-code-on-the-web.md): Claude Code running in the clou… Scan your codebase for vulnerabilities Claude Code CLI · in the page claude-security …Enterprise plan. The plugin is also distinct from the review tools already in Claude Code: the [security guidance plugin](/docs/en/security-guidance.md) reviews code as Claude writes it, [`/security-… claude-tag Claude Code CLI · in the page claude-tag …); })();</script><script type="text/javascript">!function(){ function read(){try{ var e=performance.getEntriesByType?performance.getEntriesByType("navigation"):[]; var st=(e[0]&&e[0].serverTiming)||[]… CLI reference Claude Code CLI · in the page cli-reference …| Show authentication status as JSON. Use `--text` for human-readable output. Exits with code 0 if logged in, 1 if not… Configure cloud environments Claude Code CLI · in the page cloud-environments …s) set by an Owner fills the selection when you haven't picked one. Threads in a [project](/docs/en/claude-projects.md#project-settings-reference) use the environment set in the project's settings ins…
Feedback