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

272 pages for kind.

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

Run Claude Code through a gateway Claude Code CLI · in the page gateways …t\&n=-uq-4JE0W_JO5Er5\&q=85\&s=1c1a8dcc0cfcc3a58652cc8e28cd3e20) Two kinds of credential are involved: * **Developer credential**: each developer holds their own, issued by the gateway. It authentic… Claude Code GitHub Actions Claude Code CLI · in the page github-actions …blob/main/docs/security.md). ### Manage costs Each run consumes two kinds of resources: * **GitHub Actions minutes**: the Claude Code GitHub Action runs on GitHub-hosted runners, which consume your… Glossary Claude Code CLI · in the page glossary …ocs/en/permissions.md#what-runs-before-you-trust-a-folder) lists each kind of content, including what a `-p` session runs without a dialog. Learn more: [The `.claude` directory](/docs/en/claude-direc… Keep Claude working toward a goal Claude Code CLI · in the page goal …then [set the goal again](#set-a-goal) with `/goal <condition>`. Four kinds of failure clear the goal: * An authentication failure, when Claude Code manages its own credentials. When a host manages t… Run Claude Code programmatically Claude Code CLI · in the page headless …cs/en/permissions.md#what-runs-before-you-trust-a-folder) covers each kind of repository content under `-p` and how to keep it out. This example runs a one-off summarize task in bare mode and pre-app… Hooks reference Claude Code CLI · in the page hooks …laude must always see within the cap. The JSON object supports three kinds of fields: * **Universal fields** like `continue` are listed in the table below. Every event accepts them, but some events… How Claude Code works Claude Code CLI · in the page how-claude-code-works …ls generally fall into five categories, each representing a different kind of agency. | Category | What Claude can do | | - | - | | **File operations** | Read files, edit code, create new files, rena… Customize keyboard shortcuts Claude Code CLI · in the page keybindings …How Claude Code matches the key you press to a binding depends on the kind of layout: * Under a non-Latin layout such as Cyrillic, Claude Code matches Ctrl shortcuts by the key's US-layout position w… Connect Claude Code to an LLM gateway Claude Code CLI · in the page llm-gateway-connect …a command that fetches one * If your gateway team didn't say which kind of credential it is, the [credential variable section](#set-the-credential-variable) below covers what to try The sections b… Claude Code gateway compatibility guide Claude Code CLI · in the page llm-gateway-protocol …er | Description | | :- | :- | | `x-claude-code-request-class` | What kind of request this is: `main` for a turn of the main conversation, `subagent` for a turn of a [subagent](/docs/en/sub-agents.md)… Roll out an LLM gateway for your organization Claude Code CLI · in the page llm-gateway-rollout …y-requirements) above. ## Maintain the gateway After rollout, three kinds of change reach the gateway over time. Each has a symptom to watch for and an action to take. | Change | Symptom when the g… Control MCP server access for your organization Claude Code CLI · in the page managed-mcp …s-reach-claude-code) shows which controls apply to connectors in each kind of session, including cloud sessions. This page covers how to: * [Choose a pattern](#choose-a-pattern) that matches how muc… Deploy managed settings Claude Code CLI · in the page managed-settings …es every admin source that delivers a policy key and combines them by kind of key: on most keys the higher-ranked source's value applies, lists union, and locks take the strictest value. [Compose ever… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …aude.ai themselves. Each row below names how connectors arrive in one kind of session and what controls them there. The desktop app's WSL sessions have no row because connectors are [still rolling out… Connect to MCP servers Claude Code CLI · in the page mcp-quickstart …than the `Invoke-WebRequest` alias. > > The response tells you which kind of problem you have: > > * A `404` or `405`: the server is up. Many MCP endpoints answer only POST requests, so this still co… How Claude remembers your project Claude Code CLI · in the page memory …sessions without you writing anything. As it works, Claude saves four kinds of notes for itself. Claude records the kind as a `type` field in the memory file's frontmatter: * `user`: your role, exper… Model configuration Claude Code CLI · in the page model-config …sion name For guidance on which model and effort level fit different kinds of work, see [Choosing a Claude model and effort level in Claude Code](https://claude.com/blog/claude-model-and-effort-level… Monitoring Claude Code CLI · in the page monitoring-usage …essions read these managed settings from the sources that [reach each kind of Desktop session](/docs/en/desktop.md#managed-settings). The OpenTelemetry form for Cowork under **Monitoring** in the admi… Output styles Claude Code CLI · in the page output-styles …and it stays loaded whichever style you pick | | Instructions for one kind of task, such as a release checklist or a review procedure | A [skill](/docs/en/skills.md) | Claude loads it only when you in… Choose a permission mode Claude Code CLI · in the page permission-modes …e because you turned telemetry off, asks the server by default in any kind of session. * **A cloud provider, or an LLM gateway or proxy**: on [Claude Platform on AWS](/docs/en/claude-platform-on-aws.m… Configure permissions Claude Code CLI · in the page permissions …IR` is set. ### What runs before you trust a folder Each row is one kind of content a repository can supply. The columns are the two situations in which you haven't trusted the folder itself: you tr… Recommend your plugin from your CLI Claude Code CLI · in the page plugins/cli-hints …| Protocol version. `1` is the only supported value | | `type` | Hint kind. `plugin` is the only supported value | | `value` | Plugin identifier in `name@marketplace` form | Values may be double-quot… Add components to a plugin Claude Code CLI · in the page plugins/components …explorer shows an example plugin, `my-plugin`, that has one of every kind of component in its default location: * A review skill and an `about` command * A security-review subagent * A hook that for… Create a Claude Code plugin Claude Code CLI · in the page plugins/create …/publish.md#submit-to-anthropics-directory). ### Plugin layout Each kind of [component](/docs/en/plugins/components.md), such as skills, agents, hooks, and MCP servers, goes in a fixed directory und… Host and maintain a marketplace Claude Code CLI · in the page plugins/host-marketplace …the user's configured git credential helpers and never prompts. Each kind of remote and helper gives a different result: * **SSH remotes**: a key loaded in `ssh-agent` authenticates the check. * **H… Install and manage plugins Claude Code CLI · in the page plugins/install …versions automatically. These are the auto-update defaults for each kind of marketplace: * **On by default**: `claude-plugins-official` and the other [official marketplace names](/docs/en/plugins/s… Plugin loading reference Claude Code CLI · in the page plugins/loading …ginonlycustomization) set to `true` or to an array naming one or more kinds of customization to lock. The whole plugin is skipped when any one kind is locked, such as `mcp`, whichever components it ha… Manage mods for your organization Claude Code CLI · in the page plugins/mods/admin …what-managed-settings-can’t-enforce) * **Check which apps and session kinds apply the plugin keys**: [When each surface applies the plugin keys](/docs/en/plugins/org.md#when-each-surface-applies-the-p… Use the mods API Claude Code CLI · in the page plugins/mods/api …es for this session, before Claude reads it | `e.text`, and `e.origin.kind`, such as `peer` or `peer-send-message` for another session or agent, `task-notification`, or `scheduled-trigger`. Return `{… React to events with a mod Claude Code CLI · in the page plugins/mods/events …line in the transcript names the file. Nothing is logged for another kind of file, or for a call that was refused or failed. Claude's view of the call doesn't change, because the hook returns the res… Draw in the interface with a mod Claude Code CLI · in the page plugins/mods/interface …tore.delete('count')`. [Keep state](#keep-state) covers how long each kind of value lasts. ## Pick where to draw A `ui.render` hook runs for every render site unless you narrow it to the one you wan… Mods overview Claude Code CLI · in the page plugins/mods/overview …functions that run inside Claude Code instead. Claude Code calls both kinds hooks: on these pages, "hook" means a mod's handler, and the settings-file kind is a "settings hook". ## What a mod can do… Mods reference Claude Code CLI · in the page plugins/mods/reference …Plugins` can call it. | | `next.error` | In a `.catch` handler only. `kind` is `throw` or `timeout` when the hook failed, and `message` is the error's text. `kind` is `re-entry` when the hook was skip… Test a mod Claude Code CLI · in the page plugins/mods/test …// Each yield is one piece of the model's streamed reply yield { kind: 'text', index: 0, text: 'ok' } // The return value is the result of the whole request return { turnId: e.turnId, ind… Troubleshoot a mod Claude Code CLI · in the page plugins/mods/troubleshoot …ep): <message>` The reason gives no line number and doesn't say what kind of code is nested, so look through the file yourself for its most deeply nested part. Rewrite that part to nest less. If you… Manage Claude Code plugins for your organization Claude Code CLI · in the page plugins/org …When each surface applies the plugin keys The table shows when each kind of Claude Code session applies `extraKnownMarketplaces` and `enabledPlugins`, from managed settings and from a repository's `… Troubleshoot plugins Claude Code CLI · in the page plugins/troubleshooting …its network source differs from the one declared for it in settings (kind, target, or a fetch-shaping field such as headers / ref / path / sparsePaths)`. ### `Failed to install: <plugin> (<reason>)`… How Claude Code uses prompt caching Claude Code CLI · in the page prompt-caching …ls server-side. This table gives each bucket's default TTL under both kinds of billing. | Request bucket | Claude subscription, within plan usage | Usage credits, API key, or cloud provider | | - | -… Continue local sessions from any device with Remote Control Claude Code CLI · in the page remote-control …estions open until you answer them. When Claude Code forwards another kind of dialog to the remote session, such as the model-choice prompt shown after a safety refusal, it waits five minutes by defau… Automate work with scheduled tasks Claude Code CLI · in the page routines …s). ## Example use cases Each example pairs a trigger type with the kind of work scheduled tasks are suited to: unattended, repeatable, and tied to a clear outcome. * **Backlog maintenance**: a sch… Choose a sandbox environment Claude Code CLI · in the page sandbox-environments …nt it at code you do not fully trust. Claude Code can run in several kinds of isolated environments, ranging from a lightweight per-command sandbox to a fully separate virtual machine. This page comp… Configure the sandboxed Bash tool Claude Code CLI · in the page sandboxing …t `127.0.0.1`. The command sees a `403` response whose body names the kind of address, such as `Connection to myapp.test blocked: resolved to a loopback address`. Add the IP address the name resolves… Self-hosted environments Claude Code CLI · in the page self-hosted-environments …runner. ### Network paths The runner and its sessions make several kinds of outbound connection, and no inbound connectivity from Anthropic is required: * **Control plane**: the runner polls `api.… Deploy self-hosted environments to production Claude Code CLI · in the page self-hosted-environments-deploy …: a push that deletes a branch fails, and so does a push to any other kind of ref, such as a tag. For which branches a push can update, see [GitHub proxy](/docs/en/cloud-environments.md#github-proxy).… Self-hosted environments reference Claude Code CLI · in the page self-hosted-environments-reference …over 60. | | `claude_code_self_hosted_runner_poll_errors_total{error_kind}` | Cumulative PollWork failures by kind: `transport`, `timeout`, `5xx`, `429`, or `4xx`. All five series are present from pr… Configure server-managed settings Claude Code CLI · in the page server-managed-settings …ns `/login`. * When the fetch fails in any other way, or in any other kind of launch except a `claude auth` subcommand, the client exits with an error. When this setting is active in a session that f… Extend Claude with skills Claude Code CLI · in the page skills …to a synced skill's frontmatter: * The frontmatter applies in every kind of session, so an `allowed-tools` grant goes through the normal [permission flow](/docs/en/permissions.md). If your organizat… Customize your status line Claude Code CLI · in the page statusline …draft`. May be independently absent even when `pr` is present | | `pr.kind` | `mr` when `pr` describes a [GitLab merge request](/docs/en/interactive-mode.md#gitlab-merge-requests). Absent for GitHub p… Create custom subagents Claude Code CLI · in the page sub-agents …the summary. Define a custom subagent when you keep spawning the same kind of worker with the same instructions. Each subagent runs in its own context window with a custom system prompt, specific too… Tools reference Claude Code CLI · in the page tools-reference …othing in its result names the cap. Claude Code can also count other kinds of processes it starts against the same limit. Set [`CLAUDE_CODE_TOOL_MEMORY_CGROUP_EXCLUDE`](/docs/en/env-vars#variables) t…
Feedback