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

992 pages for start.

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 …when a session signs in to a Claude apps gateway. To keep pre-sign-in startup analytics off as well, deliver [`DISABLE_TELEMETRY`](/docs/en/managed-settings#turn-telemetry-off-for-your-organization) i… Claude Code GitHub Actions Claude Code CLI · in the page github-actions …om or bitbucket.org, the command prints a notice and exits instead of starting setup. To run Claude Code from GitLab pipelines, see [Claude Code GitLab CI/CD](/docs/en/gitlab-ci-cd.md). Before you st… Use Claude Code GitHub Actions with cloud providers Claude Code CLI · in the page github-actions-cloud-providers …dy include the input for each provider. ## Prerequisites Before you start, you need: * Admin access to the repository where the Claude Code GitHub Action runs, to install a GitHub App and add secre… Claude Code with GitHub Enterprise Server Claude Code CLI · in the page github-enterprise-server …trol#github-enterprise) and find the GitHub Enterprise section. **2. Start the guided setup** Click **Connect**, or **Add instance** if an instance is already connected, then select **Set up automat… Claude Code GitLab CI/CD Claude Code CLI · in the page gitlab-ci-cd …requested changes ## Setup ### Quick setup The fastest way to get started is to add a minimal job to your `.gitlab-ci.yml` and set your API key as a masked variable. 1. **Add a masked CI/CD varia… Glossary Claude Code CLI · in the page glossary …y. The first 200 lines or 25 KB of the `MEMORY.md` index loads at the start of every session. Auto memory is the Claude-written counterpart to [CLAUDE.md](#claude-md), which you write. Learn more: [A… Keep Claude working toward a goal Claude Code CLI · in the page goal …ether the condition holds. If the model judges it not yet met, Claude starts another turn instead of returning control to you. The goal clears automatically once the condition is met, if the model jud… Claude Code on Google Cloud's Agent Platform Claude Code CLI · in the page google-vertex-ai …with Agent Platform If you have Google Cloud credentials and want to start using Claude Code through Google Cloud's Agent Platform, the login wizard walks you through it. You complete the GCP-side pr… Run Claude Code programmatically Claude Code CLI · in the page headless …invalid flag, Claude Code reports the error to stderr before the run starts. When a failure happens inside the run, such as missing authentication, Claude Code prints the failure as the result on std… Set up Claude Code (local mode) for a HIPAA-ready organization Claude Code CLI · in the page hipaa-setup …computers before the HIPAA configuration is applied We recommend you start with the tasks in this section and complete them before the configuration is applied. ### Check how developers sign in and… Hooks reference Claude Code CLI · in the page hooks …TTP hooks, prompt hooks, and MCP tool hooks. > [!TIP] > > For a quickstart guide with examples, see [Automate actions with hooks](/docs/en/hooks-guide.md). Hooks are user-defined shell commands, HTT… Automate actions with hooks Claude Code CLI · in the page hooks-guide …ects. > [!TIP] > > This guide covers common use cases and how to get started. For full event schemas, JSON input/output formats, and advanced features like async hooks and MCP tool hooks, see the [Ho… How Claude Code works Claude Code CLI · in the page how-claude-code-works …lex architectural decisions. Switch with `/model` during a session or start with `claude --model <name>`. When this guide says "Claude chooses" or "Claude decides," it's the model doing the reasoning… Interactive mode Claude Code CLI · in the page interactive-mode …Description | Context | | :- | :- | :- | | `Ctrl+A` | Move cursor to start of current line | In multiline input, moves to the start of the current logical line | | `Ctrl+E` | Move cursor to end of cu… JetBrains IDEs Claude Code CLI · in the page jetbrains …ll both pieces: **1. Install the Claude Code CLI** Follow the [quickstart](/docs/en/quickstart.md) to install the CLI if you haven't already. The plugin shows a "Cannot launch Claude Code" notificat… Customize keyboard shortcuts Claude Code CLI · in the page keybindings …the keybindings file are automatically detected and applied without restarting Claude Code. | Field | Description | | :- | :- | | `$schema` | Optional JSON Schema URL for editor autocompletion | | `$… Set up Claude Code in a monorepo or large codebase Claude Code CLI · in the page large-codebases …each other, so apply whichever fit your repository. [Choose where to start Claude](#choose-where-to-start-claude) determines where your settings files live, so read it first. [Put it together](#put-i… Connect Claude Code to an LLM gateway Claude Code CLI · in the page llm-gateway-connect …otate-credentials-with-apikeyhelper), so Claude Code picks them up at startup with nothing for you to set. To check whether your organization already did this: **1. Start Claude Code** Run `claude`.… Claude Code gateway compatibility guide Claude Code CLI · in the page llm-gateway-protocol …est](/docs/en/claude-platform-on-aws.md). ### Optional endpoints and startup traffic Token-counting endpoints are the only optional ones: when they're absent, Claude Code falls back to a character-b… Roll out an LLM gateway for your organization Claude Code CLI · in the page llm-gateway-rollout …ABLE_GATEWAY_MODEL_DISCOVERY` | Queries the gateway's `/v1/models` at startup and adds the returned names to the `/model` picker | Your gateway serves `/v1/models` and you want developers' pickers pop… Control MCP server access for your organization Claude Code CLI · in the page managed-mcp …vers-through-managed-settings) * In-process servers that the app that started the session registers, such as the VS Code extension's own server or the [connectors the desktop app delivers](/docs/en/mc… Deploy managed settings Claude Code CLI · in the page managed-settings …settings or debugs why one isn't applying. To decide what to enforce, start with the [Decide what to enforce](/docs/en/admin-setup.md#decide-what-to-enforce) table. For the claude.ai console path, see… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …working from what you paste. If you're connecting your first server, start with the [MCP quickstart](/docs/en/mcp-quickstart.md) for a step-by-step walkthrough. This page is the full reference. ## W… How Claude remembers your project Claude Code CLI · in the page memory …ude Code has two complementary memory systems. Both are loaded at the start of every conversation. Claude treats them as context, not enforced configuration. To block an action regardless of what Clau… Claude Code on Microsoft Foundry Claude Code CLI · in the page microsoft-foundry …nd may not yet be available in your account. Microsoft Foundry has no startup model check, so requests fail when the default is unavailable. When you create Azure deployments, select a specific model… Claude Code on mobile Claude Code CLI · in the page mobile # Claude Code on mobile > Start, monitor, and steer Claude Code tasks from your phone with the Claude app for iOS and Android. The Claude app for [iOS](https://apps.apple.com/us/app/claude-by-anthro… Model configuration Claude Code CLI · in the page model-config …e` or `fable[1m]` alias the first time you run v2.1.257 or later. The startup model line shows `(auto-updated)` once. A `claude-fable-5` value in project, local, or managed settings stays as it is. R… Monitoring Claude Code CLI · in the page monitoring-usage …//platform.claude.com/docs/en/manage-claude/opentelemetry). ## Quick start Configure OpenTelemetry using environment variables: ```bash theme={null} # 1. Enable telemetry export CLAUDE_CODE_ENABLE_… Enterprise network configuration Claude Code CLI · in the page network-config …launch Claude Code. Variables exported in your shell are read once at startup, so a running session doesn't pick up later changes to your shell environment. > [!NOTE] > > All environment variables sh… Output styles Claude Code CLI · in the page output-styles …responses shorter, add an explanation of each change, or have Claude start work without asking routine questions. A custom style can also turn Claude into something other than a software engineer, su… Overview Claude Code CLI · in the page overview …can work across multiple files and tools to get things done. ## Get started Claude Code runs on several surfaces: the terminal, IDE extensions, a desktop app, and the web. Choose one from the tabs… Choose a permission mode Claude Code CLI · in the page permission-modes …ip it. With Claude Code v2.1.283 or later, auto mode is the built-in starting permission mode for interactive terminal and VS Code sessions. On earlier versions, it's the built-in starting permission… Configure permissions Claude Code CLI · in the page permissions …es to future sessions anywhere in that repository, including sessions started in subdirectories and in worktrees. A file-modification approval isn't saved to the file: as the table shows, it lasts unt… Platforms and integrations Claude Code CLI · in the page platforms …rm | Best for | What you get | | :- | :- | :- | | [CLI](/docs/en/quickstart.md) | Terminal workflows, scripting, remote servers | Full feature set, [Agent SDK](/docs/en/headless.md), [computer use](/d… Test plugins with evals Claude Code CLI · in the page plugin-evals …ndle. ### What happens in a run For each run of a case, Claude Code starts a fresh, [isolated](#how-runs-are-isolated) [non-interactive session](/docs/en/headless.md) with only your plugin loaded, s… Anthropic's marketplaces Claude Code CLI · in the page plugins/anthropic-marketplaces …n contain | | How you get it | Claude Code adds it the first time you start an interactive terminal session, unless a [managed policy](/docs/en/plugins/org.md#allow-the-official-marketplace-and-your-o… Recommend your plugin from your CLI Claude Code CLI · in the page plugins/cli-hints …DE_CODE_CHILD_SESSION`**: set only in subprocesses Claude Code itself starts. Use it when you can require v2.1.172 or later The [environment variables reference](/docs/en/env-vars.md) has the details… Plugin commands reference Claude Code CLI · in the page plugins/cli-reference …`git config user.email` | | `--with <components...>` | Also scaffold starter files for `skills`, `agents`, `hooks`, `mcp`, `lsp`, `output-style`, or `channel` | | `-f, --force` | Overwrite an existin… Code intelligence plugins Claude Code CLI · in the page plugins/code-intelligence …ud sessions](/docs/en/claude-code-on-the-web.md), Claude Code doesn't start plugin language servers, so Claude gets no diagnostics or code navigation there. To write your own language server plugin, o… Add components to a plugin Claude Code CLI · in the page plugins/components …er you add a component, run `/reload-plugins` in a running session or start a new one so Claude Code loads it. To check the component's file before loading it, run [`claude plugin validate .`](/docs/e… Create a Claude Code plugin Claude Code CLI · in the page plugins/create ….com/docs/plugins/platform-support#compare-component-support-by-app) Start from the section that matches what you already have: * **Nothing yet**: follow [Create your first plugin](#create-your-firs… Create a marketplace Claude Code CLI · in the page plugins/create-marketplace …ketplace](/docs/en/plugins/create.md#develop-without-a-marketplace). Start with [Create a marketplace](#create-a-marketplace) to build one on your own machine and install a plugin from it, then [add… Plugin dependencies Claude Code CLI · in the page plugins/dependencies …lugins/loading.md#node-js-package-dependencies) To add a constraint, start at [Declare a dependency with a version constraint](#declare-a-dependency-with-a-version-constraint). If you maintain a plug… Host and maintain a marketplace Claude Code CLI · in the page plugins/host-marketplace …d on other pages: > > * **You haven't written the catalog file yet**: start with [Create a marketplace](/docs/en/plugins/create-marketplace.md) > * **You're an admin requiring, restricting, or pre-ins… Install and manage plugins Claude Code CLI · in the page plugins/install …nd it in [Troubleshoot plugins](/docs/en/plugins/troubleshooting.md) Start with [Install a plugin](#install-a-plugin). If someone sent you an install command whose `@` name isn't `claude-plugins-offi… Plugin loading reference Claude Code CLI · in the page plugins/loading …k decided that. It gives the rules Claude Code applies when a session starts and each time you run `/reload-plugins`. You can also ask Claude to read this page and diagnose your setup. > [!NOTE] > >… Plugin manifest reference Claude Code CLI · in the page plugins/manifest-reference …ses are covered on other pages: > > * **Learning to build a plugin**: start with [Create a plugin](/docs/en/plugins/create.md) > * **What each component does at runtime**: see [Plugin components](/doc… Marketplace reference Claude Code CLI · in the page plugins/marketplace-reference …s-name). This check requires Claude Code v2.1.296 or later. * **Names starting with `claudeai-`**: reserved for marketplaces hosted on claude.ai. `claude plugin marketplace add` refuses any other mark… Measure plugin cost and usage Claude Code CLI · in the page plugins/measure …d-plugins) and the [context window](/docs/en/context-window.md) page Start with [Measure what a plugin costs](#measure-what-a-plugin-costs). ## Measure what a plugin costs To see what a plugin adds… Manage mods for your organization Claude Code CLI · in the page plugins/mods/admin …in console. Mods are on by default in Claude Code v2.1.286 and later. Start with the section that matches what you came to do: * **Keep users' own mods out, with or without mods of your own**: [Stop…
Feedback