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

406 pages for setup.

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

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… Get started with the desktop app Claude Code CLI · in the page desktop-quickstart …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… Claude Code Desktop in WSL Claude Code CLI · in the page desktop-wsl …ator. Administrators: see [how settings reach devices](/docs/en/admin-setup.md#decide-how-settings-reach-devices) in the deployment guide. Development containers Claude Code CLI · in the page devcontainer …and running without permission prompts. Read the ones that match your setup. > [!WARNING] > > While the dev container provides substantial protections, no system is completely immune to all attacks.… Environment variables Claude Code CLI · in the page env-vars …the Anthropic API is unaffected either way. In some direct-connection setups, Claude Code keeps the block on [auto mode](/docs/en/permission-modes#eliminate-prompts-with-auto-mode) classifier requests… Error reference Claude Code CLI · in the page errors …nstallation errors such as `command not found` or TLS failures during setup, see [Troubleshoot installation and login](/docs/en/troubleshoot-install.md). Except for [Wrapper and IDE errors](#wrapper-… Feature availability Claude Code CLI · in the page feature-availability …Code CLI and everything that runs locally work on every provider. For setup instructions per provider, see the [Enterprise deployment overview](/docs/en/third-party-integrations.md). To skip straight… Extend Claude Code Claude Code CLI · in the page features-overview …then add other extensions [as specific triggers come up](#build-your-setup-over-time). ## Overview Extensions plug into different parts of the agentic loop: * **[CLAUDE.md](/docs/en/memory.md)** a… Fullscreen rendering Claude Code CLI · in the page fullscreen …n or in the classic renderer](#fullscreen-by-default) depends on your setup. Run `/tui fullscreen` or `/tui default` to switch in your current conversation. Behavior may change based on feedback. Ful… Run Claude Code through a gateway Claude Code CLI · in the page gateways …ay. Anthropic's gateway runs from the `claude` binary and has its own setup guide; a gateway your organization already runs has a compatibility guide to follow and an admin rollout checklist. * [Clau… Claude Code GitHub Actions Claude Code CLI · in the page github-actions …github-enterprise-server.md): Claude Code with self-hosted GitHub ## Setup You can set up the Claude Code GitHub Action in one of two ways: * **Quick setup**: run `/install-github-app` from Claude… Use Claude Code GitHub Actions with cloud providers Claude Code CLI · in the page github-actions-cloud-providers …ur repository. > [!NOTE] > > This page builds on the [GitHub Actions setup](/docs/en/github-actions.md#setup). It assumes you already know the workflow file and the `anthropics/claude-code-action` st… Claude Code with GitHub Enterprise Server Claude Code CLI · in the page github-enterprise-server …ositories | | GitHub Actions | ✅ Supported | Requires manual workflow setup; `/install-github-app` is github.com only | | GitHub MCP server | ❌ Not supported | The GitHub MCP server does not work with… Claude Code GitLab CI/CD Claude Code CLI · in the page gitlab-ci-cd …ows your `CLAUDE.md` guidelines and existing code patterns * **Simple setup**: Add one job to `.gitlab-ci.yml` and a masked CI/CD variable * **Enterprise-ready**: Choose Claude API, Amazon Bedrock, or… Glossary Claude Code CLI · in the page glossary …sessions](/docs/en/cloud-environments.md#what-carries-over-from-your-setup) start from a fresh clone of your repository and don't read `~/.claude/` on your machine. Slack and the Chrome extension are… Claude Code on Google Cloud's Agent Platform Claude Code CLI · in the page google-vertex-ai …through Google Cloud's Agent Platform, formerly Vertex AI, including setup, IAM configuration, and troubleshooting. **Deploying Claude Code across your organization?** Talk to sales about enterprise… Run Claude Code programmatically Claude Code CLI · in the page headless …while a configured [`SessionStart`](/docs/en/hooks#sessionstart) or [`Setup`](/docs/en/hooks#setup) hook runs. These stream as the hook produces them. The event also carries an optional `capabilities… Hooks reference Claude Code CLI · in the page hooks …or) calls, which skip both ![Hook lifecycle diagram showing optional Setup feeding into SessionStart, then a per-turn loop containing UserPromptSubmit, UserPromptExpansion for slash commands, the nes… Automate actions with hooks Claude Code CLI · in the page hooks-guide …when a terminal session shows you an [agent team teammate's terminal setup question](/docs/en/agent-teams.md#choose-a-display-mode) or auto mode's notice about [classifier request charges](/docs/en/a… How Claude Code works Claude Code CLI · in the page how-claude-code-works …?" and Claude will explain. Built-in commands also guide you through setup: * `/init` generates a starter CLAUDE.md for your project * `/doctor` runs a setup checkup that diagnoses installation and… JetBrains IDEs Claude Code CLI · in the page jetbrains …er loopback, such as WSL2 with default NAT networking or a remote-IDE setup; see [WSL configuration](#wsl-configuration) for that scenario. > [!WARNING] > > Enabling **Accept connections from all net… Set up Claude Code in a monorepo or large codebase Claude Code CLI · in the page large-codebases …zation, see [Set up Claude Code for your organization](/docs/en/admin-setup.md). ### The example monorepo The examples throughout this page refer to a monorepo with three packages. The same patterns… Legal and compliance Claude Code CLI · in the page legal-and-compliance …aude Code (local mode) for a HIPAA-ready organization](/docs/en/hipaa-setup.md). * **Zero Data Retention**: Claude Code with [Zero Data Retention (ZDR)](/docs/en/zero-data-retention.md) enabled for th… Other LLM gateways Claude Code CLI · in the page llm-gateway …es to distribute at each one. The gateway is one part of organization setup; for policy enforcement, usage visibility, and data handling decisions, see [Set up Claude Code for your organization](/docs… Connect Claude Code to an LLM gateway Claude Code CLI · in the page llm-gateway-connect …managed-settings), the desktop app routes through the gateway with no setup on your part * **Configured locally**: for devices without an administrator-distributed configuration, open Help → Troublesh… Claude Code gateway compatibility guide Claude Code CLI · in the page llm-gateway-protocol …figuration. [Check how developers sign in and connect](/docs/en/hipaa-setup.md#check-how-developers-sign-in-and-connect) lists which sign-in and connection methods are. See [The HIPAA configuration be… Roll out an LLM gateway for your organization Claude Code CLI · in the page llm-gateway-rollout …f you don't have one yet, [how settings reach devices](/docs/en/admin-setup.md#decide-how-settings-reach-devices) compares the options ### Gateway requirements Whichever product provides the gateway… Control MCP server access for your organization Claude Code CLI · in the page managed-mcp …a server before approving it. [Decide what to enforce](/docs/en/admin-setup.md#decide-what-to-enforce) covers MCP restrictions alongside the other administrative controls. ## Choose a pattern Claude… Deploy managed settings Claude Code CLI · in the page managed-settings …at 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 [Server-managed settings](/docs/en/server-managed-sett… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …mcp add --transport` flag doesn't accept `ws`. ### Add a server from setup instructions written for another client MCP servers aren't specific to Claude Code, so a server's setup instructions may be… Connect to MCP servers Claude Code CLI · in the page mcp-quickstart …special configuration, so it works well as a first server to test the setup flow with. The steps are the same for any server: add it, check the connection status, then use it in a session, with an op… How Claude remembers your project Claude Code CLI · in the page memory …ad. The [extension overview](/docs/en/features-overview.md#build-your-setup-over-time) covers when to use each mechanism. ### Choose where to put CLAUDE.md files CLAUDE.md files can live in several… Claude Code on Microsoft Foundry Claude Code CLI · in the page microsoft-foundry …rn about configuring Claude Code through Microsoft Foundry, including setup, configuration, and troubleshooting. **Deploying Claude Code across your organization?** Talk to sales about enterprise pla… Claude Code on mobile Claude Code CLI · in the page mobile …d-environments.md): network access levels, environment variables, and setup scripts for cloud sessions * [Remote Control](/docs/en/remote-control.md): continue a local session from any device * [Sessi… Model configuration Claude Code CLI · in the page model-config …environment variables to specific version IDs as part of your initial setup. Pinning lets you control when your users move to a new model. Use the following environment variables with version-specifi… Monitoring Claude Code CLI · in the page monitoring-usage …conds (default: 5000ms) # 6. Run Claude Code claude ``` To verify a setup that exports metrics, check your backend for the `claude_code.session.count` metric, which Claude Code emits when a session… Enterprise network configuration Claude Code CLI · in the page network-config …ly in containerized or restricted network environments. The first-run setup connectivity check points here when it can't reach `api.anthropic.com` or `platform.claude.com`; see [Unable to connect to A… Overview Claude Code CLI · in the page overview …installed, Claude Code uses PowerShell as the shell tool instead. WSL setups do not need Git for Windows. > [!NOTE] > > Native installations automatically update in the background to keep you on the… Choose a permission mode Claude Code CLI · in the page permission-modes …docs/en/sandboxing.md) and the sandbox enforces the block. ## Common setups Permission modes decide whether Claude asks before an action, and the [Bash sandbox](/docs/en/sandboxing.md) and outer [is… Configure permissions Claude Code CLI · in the page permissions …tead isn't using that login, even when that login is stored. In that setup you aren't prompted when the mod approves a call that an ask rule, a `PreToolUse` hook, or `permissions.blockReadsOutsideWor… Platforms and integrations Claude Code CLI · in the page platforms …top](/docs/en/desktop.md) | Visual review, parallel sessions, managed setup | Diff viewer, app preview, [computer use](/docs/en/desktop.md#let-claude-use-your-computer) and [Dispatch](/docs/en/desktop… Test plugins with evals Claude Code CLI · in the page plugin-evals …r the task needs in the prompt itself, or [set up the workspace](#add-setup-or-history-with-case-yaml) first. The [full list of frontmatter fields](#prompt-md-fields) covers the model, timeout, tags,… Plugin commands reference Claude Code CLI · in the page plugins/cli-reference …fold` | Run each case's [`scaffold_script`](/docs/en/plugin-evals#add-setup-or-history-with-case-yaml) | Off | | `--trust-plugin` | Skip the first-run trust prompt, for CI. See [What a run can access]… Create a Claude Code plugin Claude Code CLI · in the page plugins/create …tory, test it without a marketplace, and convert an existing .claude/ setup. A plugin is a directory of skills, agents, hooks, and MCP servers, plus a `plugin.json` file, called the manifest, that na… Create a marketplace Claude Code CLI · in the page plugins/create-marketplace …lace` from a local directory with a relative-path `source`. With that setup, Claude Code reads the plugin's files directly from `my-marketplace/plugins/`. Your edits take effect at the next session st… Host and maintain a marketplace Claude Code CLI · in the page plugins/host-marketplace …lugins/org-sync) on claude.com lists the accepted sources, the GitLab setup, and the `bin/` error, and [Manage plugins for your organization](https://claude.com/docs/plugins/admin) covers the admin wo… Install and manage plugins Claude Code CLI · in the page plugins/install …n is now active.` No reload is needed. * **Active, but a server needs setup**: `Plugin is now active.` is followed by `Its bundled MCP server needs configuration before it can start`. The plugin's [bu… Plugin loading reference Claude Code CLI · in the page plugins/loading …plugins`. You can also ask Claude to read this page and diagnose your setup. > [!NOTE] > > These cases are covered on other pages: > > * **Install, enable, disable, and update steps**: see [Install a… Create a mod Claude Code CLI · in the page plugins/mods/create …your editor and `tsc -p ./first-mod` type-check the mod without more setup. The events and methods can change between releases, so trust these files over any page, this one included, when they disag…
Feedback