Claude Code

https://code.claude.com/docs
Admin
Claude Code is Anthropic’s agentic coding tool that operates in your terminal, helping developers...
Tokens:1,077,480
Snippets:6,015
Trust Score:9.9
Update:5 days ago
Show doc for...
Tokens:
Raw
### Update documentation prompt example

Source: https://code.claude.com/docs/en/quickstart

Prompt example asking Claude to update README installation instructions.

```text
update the README with installation instructions

```

--------------------------------

### Start guided runner setup with claude self-hosted-runner setup

Source: https://code.claude.com/docs/en/self-hosted-environments-quickstart

Starts an interactive guided Claude Code session that walks through creating an environment and configuring a local runner. Requires signing in with an Owner role account and Claude Code version 2.1.224 or later.

```bash
claude self-hosted-runner setup

```

--------------------------------

### Install httpx using uv

Source: https://code.claude.com/docs/en/agent-sdk/custom-tools

Installs the httpx dependency for making HTTP requests in Python examples using uv.

```bash
uv add httpx

```

--------------------------------

### Run installation and configuration diagnostics

Source: https://code.claude.com/docs/en/setup

Prints read-only installation and settings diagnostics without starting a session. Displays install health, settings-file validation errors, and warnings with suggested fixes.

```bash
claude doctor

```

--------------------------------

### Generate teammate ramp-up guide with /team-onboarding

Source: https://code.claude.com/docs/en/whats-new/2026-w15

Creates a project-specific ramp-up guide based on local Claude Code usage to share custom setup with new teammates.

```text
/team-onboarding

```

--------------------------------

### Install httpx using pip

Source: https://code.claude.com/docs/en/agent-sdk/custom-tools

Installs the httpx dependency for making HTTP requests in Python examples using pip.

```bash
pip install httpx

```

--------------------------------

### Run plugin install command syntax

Source: https://code.claude.com/docs/en/plugins/cli-reference

Basic command syntax to install a plugin from configured marketplaces.

```bash
claude plugin install <plugin> [options]

```

--------------------------------

### Install plugin from the registered marketplace

Source: https://code.claude.com/docs/en/plugins/create-marketplace

Installs the plugin using the format <plugin-name>@<marketplace-name> at user scope.

```bash
claude plugin install my-first-plugin@my-marketplace

```

--------------------------------

### Install a plugin with /plugin install

Source: https://code.claude.com/docs/en/plugins/install

Opens the plugin details panel within a Claude Code session to review capabilities and choose an install scope. Replace the plugin name and marketplace as needed.

```shell
/plugin install commit-commands@claude-plugins-official

```

--------------------------------

### Initialize project directory and install dependencies

Source: https://code.claude.com/docs/en/channels-reference

Create a new project directory and install the Model Context Protocol SDK along with Zod using Bun.

```bash
mkdir webhook-channel && cd webhook-channel
bun add @modelcontextprotocol/sdk zod

```

--------------------------------

### Install a plugin using claude plugin install with project scope

Source: https://code.claude.com/docs/en/plugins/install

Installs a plugin directly from the shell without starting an interactive session. Set the scope to project level using `--scope project`.

```bash
claude plugin install formatter@your-org --scope project

```

--------------------------------

### Bundle plugins for team installation in plugin.json

Source: https://code.claude.com/docs/en/plugins/dependencies

Create a bundle plugin manifest to install a curated set of dependencies with a single install command.

```json
{
  "name": "backend-standard",
  "version": "1.0.0",
  "description": "Standard plugin set for backend engineers",
  "dependencies": [
    "secrets-vault",
    "deploy-kit",
    { "name": "db-migrate", "version": "^3.0" },
    "oncall-runbook"
  ]
}

```

--------------------------------

### Install a plugin with project scope

Source: https://code.claude.com/docs/en/plugins/cli-reference

Installs a plugin scoped to the project so that it is available to anyone who clones the repository.

```bash
claude plugin install formatter@my-marketplace --scope project

```

--------------------------------

### Install stable version on Windows CMD

Source: https://code.claude.com/docs/en/setup

Downloads and runs the installer configured for the stable release channel on Windows CMD.

```batch
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd stable && del install.cmd

```

--------------------------------

### Refactor code prompt example

Source: https://code.claude.com/docs/en/quickstart

Prompt example asking Claude to refactor callback-based code to async/await.

```text
refactor the authentication module to use async/await instead of callbacks

```

--------------------------------

### Initialize and install Agent SDK with uv in Python

Source: https://code.claude.com/docs/en/agent-sdk/quickstart

Initializes a new Python project and installs the claude-agent-sdk package using the uv package manager.

```bash
uv init
uv add claude-agent-sdk
```

--------------------------------

### Install @anthropic-ai/sandbox-runtime

Source: https://code.claude.com/docs/en/agent-sdk/secure-deployment

Installs the sandbox-runtime package for lightweight OS-level filesystem and network isolation without requiring Docker or container setups.

```bash
npm install @anthropic-ai/sandbox-runtime

```

--------------------------------

### Install stable version on macOS, Linux, WSL

Source: https://code.claude.com/docs/en/setup

Installs the stable release channel on macOS, Linux, or WSL.

```bash
curl -fsSL https://claude.ai/install.sh | bash -s stable

```

--------------------------------

### Create install directory and update ownership

Source: https://code.claude.com/docs/en/troubleshoot-install

Creates `~/.local/bin` and updates ownership of `~/.local` recursively to the current user if permissions are missing.

```bash
sudo mkdir -p ~/.local/bin
sudo chown -R $(whoami) ~/.local

```

--------------------------------

### Share plugin install link via vscode:// URL scheme

Source: https://code.claude.com/docs/en/vs-code

Construct a custom URL to open VS Code directly to the plugin installation prompt with specified plugin and marketplace parameters.

```text
vscode://anthropic.claude-code/install-plugin?plugin=code-review&marketplace=anthropics/claude-plugins-official

```

--------------------------------

### Configure SubagentStart and SubagentStop hooks in settings.json

Source: https://code.claude.com/docs/en/sub-agents

Define session-level hooks targeting subagent lifecycle events in settings.json. Runs setup scripts when specific named subagents start and cleanup scripts when any subagent finishes.

```json
{
  "hooks": {
    "SubagentStart": [
      {
        "matcher": "db-agent",
        "hooks": [
          { "type": "command", "command": "./scripts/setup-db-connection.sh" }
        ]
      }
    ],
    "SubagentStop": [
      {
        "hooks": [
          { "type": "command", "command": "./scripts/cleanup-db-connection.sh" }
        ]
      }
    ]
  }
}

```

--------------------------------

### Register marketplace and force-enable plugins in managed settings

Source: https://code.claude.com/docs/en/plugins/org

Registers an organization marketplace under `extraKnownMarketplaces` and force-enables specified plugins. Plugins are installed at the start of the next session, and managed settings take precedence over user scopes.

```json
{
  "extraKnownMarketplaces": {
    "your-marketplace": {
      "source": { "source": "github", "repo": "your-org/your-marketplace" },
      "autoUpdate": true
    }
  },
  "enabledPlugins": {
    "code-formatter@your-marketplace": true,
    "deploy-helper@your-marketplace": true
  }
}

```

--------------------------------

### Generate unit tests prompt example

Source: https://code.claude.com/docs/en/quickstart

Prompt example asking Claude to write unit tests for functions.

```text
write unit tests for the calculator functions

```

--------------------------------

### Install the Discord channel plugin

Source: https://code.claude.com/docs/en/channels

Installs the official Discord plugin in Claude Code. Select user scope during installation so the plugin is available globally.

```shell
/plugin install discord@claude-plugins-official

```

--------------------------------

### List installed plugins and verify status

Source: https://code.claude.com/docs/en/plugins/create-marketplace

Lists all installed plugins to confirm the new plugin is present and enabled.

```bash
claude plugin list

```

--------------------------------

### Install an LSP plugin using /plugin install

Source: https://code.claude.com/docs/en/plugins/code-intelligence

Installs a code intelligence plugin from the official marketplace within a Claude Code interactive terminal session. Replace the plugin identifier with the target language server plugin.

```shell
/plugin install typescript-lsp@claude-plugins-official

```

--------------------------------

### Register apt repository on stable channel and install

Source: https://code.claude.com/docs/en/setup

Adds the stable apt repository definition to sources.list.d, updates package lists, and installs claude-code.

```bash
echo "deb [signed-by=/etc/apt/keyrings/claude-code.asc] https://downloads.claude.ai/claude-code/apt/stable stable main" \
  | sudo tee /etc/apt/sources.list.d/claude-code.list
sudo apt update
sudo apt install claude-code

```

--------------------------------

### Linux Out-of-Memory (OOM) Killed install error

Source: https://code.claude.com/docs/en/troubleshoot-install

Example terminal output when the Linux OOM killer terminates the installer due to insufficient free memory.

```text
Setting up Claude Code...
bash: line 183: 34803 Killed    "$binary_path" install ${TARGET:+"$TARGET"}
Installation was killed before it could finish (exit code 137). This usually means the system ran out of memory.
Claude Code needs roughly 512MB of free memory to install. Free up memory, then run this script again.

```

--------------------------------

### Install dependencies in SessionStart hook (hooks/hooks.json)

Source: https://code.claude.com/docs/en/plugins/components

Installs node_modules into ${CLAUDE_PLUGIN_DATA} on the first session run and re-installs whenever package.json updates. Cleanly removes package.json on failure so subsequent runs can retry.

```json
{
  "hooks": {
    "SessionStart": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "diff -q \"${CLAUDE_PLUGIN_ROOT}/package.json\" \"${CLAUDE_PLUGIN_DATA}/package.json\" >/dev/null 2>&1 || (cd \"${CLAUDE_PLUGIN_DATA}\" && cp \"${CLAUDE_PLUGIN_ROOT}/package.json\" . && npm install) || rm -f \"${CLAUDE_PLUGIN_DATA}/package.json\""
          }
        ]
      }
    ]
  }
}

```

--------------------------------

### Run checkpointing example in Python

Source: https://code.claude.com/docs/en/agent-sdk/file-checkpointing

Executes the Python checkpointing script from the command line in the directory containing the utility file.

```bash
python try_checkpointing.py

```

--------------------------------

### Install and activate security-guidance plugin

Source: https://code.claude.com/docs/en/whats-new/2026-w22

Installs the security-guidance plugin from the official Anthropic marketplace and reloads plugins in the current session. Configure custom project rules in .claude/claude-security-guidance.md.

```shell
/plugin install security-guidance@claude-plugins-official

```

```shell
/reload-plugins

```

--------------------------------

### Install Claude Code using native installer

Source: https://code.claude.com/docs/en/troubleshoot-install

Run this curl command to switch to the native installer when encountering permission errors with npm installation.

```bash
curl -fsSL https://claude.ai/install.sh | bash
```

--------------------------------

### Install Claude Code natively on macOS, Linux, and WSL

Source: https://code.claude.com/docs/en/setup

Downloads and executes the native installer script for macOS, Linux, and WSL. Native installations automatically update in the background.

```bash
curl -fsSL https://claude.ai/install.sh | bash

```

--------------------------------

### Install curl and gnupg prerequisites

Source: https://code.claude.com/docs/en/desktop-linux

Run this command on fresh Debian and Ubuntu systems if curl or gpg report 'command not found'.

```bash
sudo apt install curl gnupg

```

--------------------------------

### Install pytest for running conformance tests

Source: https://code.claude.com/docs/en/agent-sdk/session-storage

Installs pytest prior to executing the Python SDK conformance test suite.

```shell
pip install pytest

```

--------------------------------

### Install stable version on Windows PowerShell

Source: https://code.claude.com/docs/en/setup

Installs the stable release channel using PowerShell.

```powershell
& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) stable

```

--------------------------------

### Verify plugin installation in Python

Source: https://code.claude.com/docs/en/agent-sdk/plugins

Inspect the `SystemMessage` with `init` subtype to check loaded plugins, skills, and slash commands from `query` results.

```python
import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions, SystemMessage


async def main():
    async for message in query(
        prompt="Hello",
        options=ClaudeAgentOptions(
            plugins=[{"type": "local", "path": "./my-plugin"}]
        ),
    ):
        if isinstance(message, SystemMessage) and message.subtype == "init":
            # Check loaded plugins
            print("Plugins:", message.data.get("plugins"))
            # Example: [{"name": "my-plugin", "path": "/absolute/path/to/my-plugin"}]

            # Plugin skills appear with the plugin name as a prefix
            print("Skills:", message.data.get("skills"))
            # Example: ["my-plugin:greet"]

            # Plugin commands use the same prefix, and skills appear here too
            print("Commands:", message.data.get("slash_commands"))
            # Example: ["compact", "context", "my-plugin:custom-command", "my-plugin:greet"]


asyncio.run(main())
```

--------------------------------

### Install downloaded claude-desktop Debian package

Source: https://code.claude.com/docs/en/desktop-linux

Installs the downloaded .deb file using apt. Run this from the directory containing the downloaded file.

```bash
sudo apt install ./claude-desktop_*.deb

```

--------------------------------

### Install using curl with --ssl-revoke-best-effort on Windows

Source: https://code.claude.com/docs/en/troubleshoot-install

Runs install.cmd with best-effort revocation checking to work around blocked certificate revocation lookups.

```cmd
curl --ssl-revoke-best-effort -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

```

--------------------------------

### Set up the marketplace directory and copy plugin

Source: https://code.claude.com/docs/en/plugins/create-marketplace

Creates the marketplace folder structure including the .claude-plugin/ metadata directory and copies your plugin into the plugins/ subfolder.

```bash
mkdir -p my-marketplace/.claude-plugin my-marketplace/plugins
cp -r my-first-plugin my-marketplace/plugins/

```

--------------------------------

### Review code changes prompt example

Source: https://code.claude.com/docs/en/quickstart

Prompt example asking Claude to review code changes and suggest improvements.

```text
review my changes and suggest improvements

```

--------------------------------

### Install the Telegram channel plugin

Source: https://code.claude.com/docs/en/channels

Installs the official Telegram plugin in Claude Code. Choose user scope during installation to make the plugin accessible across all projects.

```shell
/plugin install telegram@claude-plugins-official

```

--------------------------------

### Enable TLS 1.2 and run installer in Windows PowerShell 5.1

Source: https://code.claude.com/docs/en/troubleshoot-install

Sets the security protocol to TLS 1.2 and runs the installer in the same PowerShell window.

```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

```

```powershell
irm https://claude.ai/install.ps1 | iex

```

--------------------------------

### Install specific version on macOS, Linux, WSL

Source: https://code.claude.com/docs/en/setup

Pins and installs a specific version number on macOS, Linux, or WSL.

```bash
curl -fsSL https://claude.ai/install.sh | bash -s 2.1.89

```

--------------------------------

### Prompt Claude to perform GUI testing tasks

Source: https://code.claude.com/docs/en/computer-use

Example prompt instructing Claude to build an app target, launch it, navigate GUI tabs, and take screenshots of any error states.

```text
Build the app target, launch it, and click through each tab to make
sure nothing crashes. Screenshot any error states you find.

```

--------------------------------

### Share /init and CLAUDE.md project memory tip template

Source: https://code.claude.com/docs/en/communications-kit

Share this communication template to teach developers how to initialize persistent repo context and conventions using /init and CLAUDE.md.

```markdown
📁 *Tip: Stop re-explaining your repo every session*

Telling Claude "we use pnpm, not npm" for the fifth time? There is a
one-time fix.

Run `/init` once per repo. Claude reads your project structure and writes a
CLAUDE.md file with your build commands, architecture, and conventions.
Every future session in that repo starts from this file automatically. Keep
it under two screens. It is a cheat sheet, not documentation.

*Try it now:* open your main repo, run `claude`, type `/init`. Thirty
seconds, pays off every session after.

📖 CLAUDE.md and project memory → https://code.claude.com/docs/en/memory

```

--------------------------------

### Verify plugin installation in TypeScript

Source: https://code.claude.com/docs/en/agent-sdk/plugins

Inspect the system initialization message (`type: 'system'` and `subtype: 'init'`) from `query` to verify that plugins, skills, and slash commands are loaded.

```typescript
import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
  prompt: "Hello",
  options: {
    plugins: [{ type: "local", path: "./my-plugin" }]
  }
})) {
  if (message.type === "system" && message.subtype === "init") {
    // Check loaded plugins
    console.log("Plugins:", message.plugins);
    // Example: [{ name: "my-plugin", path: "/absolute/path/to/my-plugin" }]

    // Plugin skills appear with the plugin name as a prefix
    console.log("Skills:", message.skills);
    // Example: ["my-plugin:greet"]

    // Plugin commands use the same prefix, and skills appear here too
    console.log("Commands:", message.slash_commands);
    // Example: ["compact", "context", "my-plugin:custom-command", "my-plugin:greet"]
  }
}
```

--------------------------------

### Install specific version on Windows CMD

Source: https://code.claude.com/docs/en/setup

Pins and installs a specific version number using Windows CMD.

```batch
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd 2.1.89 && del install.cmd

```

--------------------------------

### Install skill-creator plugin

Source: https://code.claude.com/docs/en/slash-commands

Installs the skill-creator plugin from the official marketplace inside a Claude Code session to automate the skill evaluation loop.

```shell
/plugin install skill-creator@claude-plugins-official
```

--------------------------------

### Syntax for claude plugin list

Source: https://code.claude.com/docs/en/plugins/cli-reference

Lists installed plugins along with their version, installation scope, and current status.

```shell
claude plugin list [options]

```

--------------------------------

### Install marketplaces and plugins into a seed directory at build time

Source: https://code.claude.com/docs/en/plugins/org

Sets `CLAUDE_CODE_PLUGIN_CACHE_DIR` to the seed path so that marketplaces and plugins install into the target seed directory instead of `~/.claude/plugins`. Used during container build time or CI runner setup when runtime git cloning is unavailable.

```bash
CLAUDE_CODE_PLUGIN_CACHE_DIR=/opt/claude-seed claude plugin marketplace add your-org/your-marketplace
CLAUDE_CODE_PLUGIN_CACHE_DIR=/opt/claude-seed claude plugin install code-formatter@your-marketplace

```

--------------------------------

### Configure apk repository on stable channel and install

Source: https://code.claude.com/docs/en/setup

Downloads the RSA public key for Alpine Linux, appends the stable repository URL, and installs claude-code via apk.

```bash
wget -O /etc/apk/keys/claude-code.rsa.pub \
  https://downloads.claude.ai/keys/claude-code.rsa.pub
echo "https://downloads.claude.ai/claude-code/apk/stable" >> /etc/apk/repositories
apk add claude-code

```

--------------------------------

### Shared library error for Linux musl/glibc binary mismatch

Source: https://code.claude.com/docs/en/troubleshoot-install

An example error displayed when Claude Code installer misdetects the system's C standard library and downloads the wrong binary variant.

```text
Error loading shared library libstdc++.so.6: No such file or directory

```

--------------------------------

### Update package index and install claude-desktop

Source: https://code.claude.com/docs/en/desktop-linux

Refreshes APT package lists and installs the claude-desktop package.

```bash
sudo apt update && sudo apt install claude-desktop

```

--------------------------------

### Start cloud plan mode with /ultraplan

Source: https://code.claude.com/docs/en/whats-new/2026-w15

Kicks off plan mode in Claude Code on the web from your terminal session. Automatically creates a default cloud environment on first run in v2.1.101+.

```text
/ultraplan migrate the auth service from sessions to JWTs

```

--------------------------------

### Run setup checkup using /doctor

Source: https://code.claude.com/docs/en/whats-new/2026-w28

Runs a diagnostic checkup on the Claude Code installation, skills, MCP servers, CLAUDE.md configuration, and hooks. Reports findings and prompts for confirmation before applying any fixes.

```shell
> /doctor

```

--------------------------------

### Configure dnf repository on stable channel and install

Source: https://code.claude.com/docs/en/setup

Creates the yum repository configuration file for Fedora/RHEL and installs claude-code using dnf.

```bash
sudo tee /etc/yum.repos.d/claude-code.repo <<'EOF'
[claude-code]
name=Claude Code
baseurl=https://downloads.claude.ai/claude-code/rpm/stable
enabled=1
gpgcheck=1
gpgkey=https://downloads.claude.ai/keys/claude-code.asc
EOF
sudo dnf install claude-code

```

--------------------------------

### Review annotated repository settings keys in .claude/settings.json

Source: https://code.claude.com/docs/en/settings-example

Reference this annotated example to understand the purpose of each configuration key. Do not copy this directly into production, as Claude Code settings files do not accept comments.

```json
{
  "permissions": {
    // Run npm scripts without asking
    "allow": [
      "Bash(npm run *)"
    ],
    // Confirm before git push commands
    "ask": [
      "Bash(git push *)"
    ],
    // Deny reads of env files and the secrets folder by the file tools and file-reading commands
    "deny": [
      "Read(./.env)",
      "Read(./.env.*)",
      "Read(./secrets/**)"
    ]
  },
  // Before every Bash command, run a script in the repo that can block it
  "hooks": {
    "PreToolUse": [
      {
        "matcher": "Bash",
        "hooks": [
          {
            "type": "command",
            "command": "${CLAUDE_PROJECT_DIR}/.claude/hooks/block-rm.sh"
          }
        ]
      }
    ]
  },
  // Register the team's plugin marketplace on every clone
  "extraKnownMarketplaces": {
    "acme-tools": {
      "source": {
        "source": "github",
        "repo": "acme-corp/claude-plugins"
      }
    }
  },
  // Enable one plugin from that marketplace; a plugin from an external source such as a GitHub repository still needs each person to install it once
  "enabledPlugins": {
    "code-formatter@acme-tools": true
  },
  // Sandbox commands: writable build dir; npm and example.com pre-allowed
  "sandbox": {
    "enabled": true,
    "filesystem": {
      "allowWrite": [
        "/tmp/build"
      ]
    },
    "network": {
      "allowedDomains": [
        "registry.npmjs.org",
        "*.example.com"
      ]
    }
  },
  // Keep plan files inside the repo
  "plansDirectory": "./plans"
}

```

--------------------------------

### Set up the gallery mod files

Source: https://code.claude.com/docs/en/plugins/mods/gallery

Creates the mod manifest, hooks configuration, and entry point script that registers the /gallery command and renders elements in a pane.

```json
{
  "name": "gallery",
  "version": "0.1.0",
  "description": "Opens a pane that draws one sample",
  "author": { "name": "Your Name" }
}

```

```json
{
  "modules": ["./register.js"]
}

```

```javascript
// Stands in for your own callback in the samples that take one
const noop = () => {}
// The Select sample keeps its choice here
let picked = 'md'

// The Raster sample packs its cells with this function
const DEFAULT_COLOR = 0x01000000
function cellsOf(rows) {
  const numbers = rows.flat().flatMap(([char, color]) => [char.codePointAt(0), color, DEFAULT_COLOR])
  return new Uint8Array(Uint32Array.from(numbers).buffer).toBase64()
}

export function register(on) {
  on('session.start', async ($, e, next) => {
    await $.command.register({ name: 'gallery', description: 'Open the sample pane' })
    return next(e)
  })

  on('command.run', { command: 'gallery' }, async ($) => {
    await $.ui.open({ id: 'gallery', focus: true, closeOnEscape: true })
    return {}
  })

  on('ui.render', { component: 'Pane' }, async ($, e, next) => {
    if (e.requestId !== 'gallery') return next(e)
    const { Box, Text, Button, Input, Select, Link, Markdown, Code, Raster, Svg } = $.ui.resolve(e)
    // Replace the element after return with a sample
    return Text({ children: ['Plain text'] })
  })
}

```

--------------------------------

### Run stdio MCP server command directly

Source: https://code.claude.com/docs/en/mcp-quickstart

Run the configured command in the terminal to inspect underlying errors for stdio servers. If the command starts and waits for input, verify the configured command with claude mcp get.

```bash
npx -y @playwright/mcp@latest

```

--------------------------------

### Load a plugin from a URL using --plugin-url

Source: https://code.claude.com/docs/en/plugins/create

Loads a plugin from the address of a remote .zip archive at startup. To load multiple, repeat the flag or provide space-separated URLs in quotes.

```bash
claude --plugin-url https://example.com/my-first-plugin.zip

```

--------------------------------

### Configure proxy and run installer in Windows PowerShell

Source: https://code.claude.com/docs/en/troubleshoot-install

Sets proxy environment variables in PowerShell and invokes the Windows installation script via irm and iex.

```powershell
$env:HTTP_PROXY = 'http://proxy.example.com:8080'
$env:HTTPS_PROXY = 'http://proxy.example.com:8080'
irm https://claude.ai/install.ps1 | iex

```

--------------------------------

### Run doctor diagnostic command

Source: https://code.claude.com/docs/en/self-hosted-environments-deploy

Starts an interactive Claude Code session with attached runner logs and state for guided diagnosis on the runner host. Sign in with 'claude auth login' on the host beforehand to allow full queries against the environment, runners, and queued sessions.

```bash
claude self-hosted-runner doctor

```

--------------------------------

### Attach preview to an existing running server in launch.json

Source: https://code.claude.com/docs/en/desktop

Specify a `url` without a `runtimeExecutable` or command to attach Claude's preview to an already-running server rather than launching one.

```json
{
  "version": "0.0.1",
  "configurations": [
    {
      "name": "my-app",
      "url": "https://app.localhost:3000"
    }
  ]
}

```

--------------------------------

### Example output for slash_commands list

Source: https://code.claude.com/docs/en/agent-sdk/skills

Shows the printed list output combining built-in commands, bundled skills, custom user-invocable skills, and .claude/commands/ definitions.

```text
Available commands: ["clear", "compact", "context", "usage", "code-review", "verify", "security-check", ...]
```

--------------------------------

### Start Claude Code with the gallery plugin directory

Source: https://code.claude.com/docs/en/plugins/mods/gallery

Loads the gallery plugin into Claude Code from the local directory.

```shell
claude --plugin-dir ./gallery

```

--------------------------------

### Enable plugin in .claude/settings.json

Source: https://code.claude.com/docs/en/security-guidance

Declare the plugin under enabledPlugins in .claude/settings.json to automatically turn it on for teammates starting local sessions in the repository.

```json
{
  "enabledPlugins": {
    "security-guidance@claude-plugins-official": true
  }
}

```

--------------------------------

### new Server(serverInfo, options)

Source: https://code.claude.com/docs/en/channels-reference

Initializes an MCP Server instance configured as a Claude Code channel. Sets experimental channel capabilities, tool capabilities, and instructions delivered to Claude upon connection.

```APIDOC
## new Server(serverInfo, options)

### Description
Configures and instantiates an MCP Server with Claude Code channel capabilities and instructions.

### Parameters
#### serverInfo (object)
- **name** (string) - Required - Name of the channel server.
- **version** (string) - Required - Version string for the server.

#### options (object)
- **capabilities.experimental['claude/channel']** (object) - Required - Set to `{}`. Registers the channel notification listener.
- **capabilities.experimental['claude/channel/permission']** (object | boolean) - Optional - Set to `{}` to declare that the channel can receive permission relay requests to remotely approve or deny tool prompts. Omit or set to `false` to opt out.
- **capabilities.tools** (object) - Optional - Standard MCP tool capability (`{}`). Required for two-way channels; omit for one-way channels.
- **instructions** (string) - Optional - Recommended context delivered to Claude when the server connects, explaining expected events, tag attributes, and reply tools.

### Usage Example
```javascript
import { Server } from '@modelcontextprotocol/sdk/server/index.js'

const mcp = new Server(
  { name: 'your-channel', version: '0.0.1' },
  {
    capabilities: {
      experimental: { 'claude/channel': {} },
      tools: {},
    },
    instructions: 'Messages arrive as <channel source="your-channel" ...>. Reply with the reply tool.',
  },
)
```
```

--------------------------------

### Install Claude Code using Windows CMD

Source: https://code.claude.com/docs/en/setup

Downloads, executes, and cleans up the native batch installation script in Windows Command Prompt.

```batch
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

```

--------------------------------

### Start Claude Code in plan mode via CLI

Source: https://code.claude.com/docs/en/permission-modes

Starts a new Claude Code session configured in plan mode from the command line.

```bash
claude --permission-mode plan

```

--------------------------------

### Install required dependencies on Alpine Linux

Source: https://code.claude.com/docs/en/setup

Install required dependencies (bash, curl, libgcc, libstdc++, and ripgrep) on Alpine Linux using apk before running the installer.

```sh
apk add bash curl libgcc libstdc++ ripgrep

```

--------------------------------

### Explain folder structure

Source: https://code.claude.com/docs/en/quickstart

Request an explanation of how the project directories and files are organized.

```plaintext
explain the folder structure

```

--------------------------------

### Load and test the migrated plugin

Source: https://code.claude.com/docs/en/plugins/create

Starts a Claude session with the specified plugin loaded to test skills, subagents, and hooks.

```bash
claude --plugin-dir ./my-plugin

```

--------------------------------

### Install V2-compatible Agent SDK via npm

Source: https://code.claude.com/docs/en/agent-sdk/typescript-v2-preview

Installs the last release compatible with the deprecated V2 interface by pinning the major and minor version to 0.2.

```bash
npm install @anthropic-ai/claude-agent-sdk@0.2

```

--------------------------------

### Install with custom CA certificate on macOS/Linux

Source: https://code.claude.com/docs/en/troubleshoot-install

Passes a corporate proxy's CA certificate to curl during the installation script download.

```bash
curl --cacert /path/to/corporate-ca.pem -fsSL https://claude.ai/install.sh | bash

```

--------------------------------

### Check installed Claude Code cask with brew list

Source: https://code.claude.com/docs/en/troubleshoot-install

Lists installed Homebrew casks matching claude-code to identify whether claude-code or claude-code@latest is currently installed.

```bash
brew list --cask | grep claude-code

```

--------------------------------

### Install plugin with explicit marketplace name

Source: https://code.claude.com/docs/en/plugins/troubleshooting

Specify the marketplace name during plugin installation so Claude Code refreshes the marketplace before looking up the plugin.

```text
/plugin install <name>@<marketplace>

```

--------------------------------

### Inspect legacy local npm installation directory

Source: https://code.claude.com/docs/en/troubleshoot-install

Checks for the existence of the legacy local npm installation at `~/.claude/local/`. If this outputs 'No such file or directory', nothing is installed at that location.

```bash
ls -la ~/.claude/local/

```

--------------------------------

### Create venv and install Agent SDK with pip on Windows PowerShell

Source: https://code.claude.com/docs/en/agent-sdk/quickstart

Creates and activates a Python virtual environment on Windows and installs claude-agent-sdk. If PowerShell blocks Activate.ps1, run Set-ExecutionPolicy -Scope Process RemoteSigned first.

```powershell
py -m venv .venv
.venv\Scripts\Activate.ps1
pip install claude-agent-sdk
```

--------------------------------

### Configure proxy and run installer on macOS/Linux

Source: https://code.claude.com/docs/en/troubleshoot-install

Sets HTTP_PROXY and HTTPS_PROXY environment variables before downloading and executing the Claude Code installation script on macOS/Linux.

```bash
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080
curl -fsSL https://claude.ai/install.sh | bash

```

--------------------------------

### Create venv and install Agent SDK with pip on macOS or Linux

Source: https://code.claude.com/docs/en/agent-sdk/quickstart

Creates and activates a Python virtual environment (.venv) and installs claude-agent-sdk using pip on macOS or Linux platforms.

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install claude-agent-sdk
```

--------------------------------

### Run a local Postgres container for gateway development

Source: https://code.claude.com/docs/en/claude-apps-gateway-deploy

Start a throwaway Postgres container for local gateway development when resolving store.postgres_url configuration errors. Configures trust authentication on port 5432.

```bash
docker run --rm -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust postgres
```

--------------------------------

### Install Claude Code using WinGet on Windows

Source: https://code.claude.com/docs/en/setup

Installs Claude Code via the Windows Package Manager (WinGet). WinGet installations do not auto-update and require manual upgrades.

```powershell
winget install Anthropic.ClaudeCode

```

--------------------------------

### Add a marketplace and install a plugin from the shell

Source: https://code.claude.com/docs/en/plugins/install

Installs a plugin and adds its marketplace directly from the shell without interactive confirmation. Requires Claude Code v2.1.292 or later.

```bash
claude plugin install deploy-helper --marketplace your-org/plugins

```

--------------------------------

### Create a skill in skills/review/SKILL.md

Source: https://code.claude.com/docs/en/plugins/components

Save each skill in its own directory under skills/. Claude loads instructions when user requests match the frontmatter description, or when executed directly as /my-plugin:review.

```markdown
---
description: Reviews a pull request for style and test coverage. Use when asked to review code.
---

Review the changed files. Report style problems first, then missing tests.

```

--------------------------------

### Install Claude Code using Homebrew on macOS

Source: https://code.claude.com/docs/en/setup

Installs the stable channel cask via Homebrew. Homebrew installations do not auto-update and must be upgraded manually with brew upgrade.

```bash
brew install --cask claude-code

```

--------------------------------

### Run checkpointing example in TypeScript

Source: https://code.claude.com/docs/en/agent-sdk/file-checkpointing

Executes the TypeScript checkpointing script with `npx tsx` from the directory containing the utility file.

```bash
npx tsx try_checkpointing.ts

```

--------------------------------

### Log output example for runner fatal configuration conflict

Source: https://code.claude.com/docs/en/self-hosted-environments-deploy

Shows an example of standard runner fatal output when mutually exclusive flags or configuration constraints are violated, such as setting capacity above one with the git proxy enabled.

```text
[runner:fatal] --use-anthropic-git-proxy requires --capacity 1 (the proxy URL is per-session and linked worktrees share origin). Omit --use-anthropic-git-proxy or set --capacity 1.

```

--------------------------------

### Enable ultracode in settings.json

Source: https://code.claude.com/docs/en/settings-reference

Configures sessions to start with ultracode enabled, planning workflows for substantive tasks when dynamic workflows are enabled and the model supports xhigh effort.

```json
{
  "ultracode": true
}

```

--------------------------------

### Install ripgrep on Ubuntu/Debian using apt

Source: https://code.claude.com/docs/en/troubleshooting

Installs the system ripgrep package on Ubuntu/Debian distributions.

```shell
sudo apt install ripgrep

```

--------------------------------

### Add a marketplace and install a plugin in a Claude Code session

Source: https://code.claude.com/docs/en/plugins/install

Installs a plugin and adds its marketplace in one command during a Claude Code session. Requires Claude Code v2.1.275 or later and prompts for confirmation if the marketplace has not been added yet.

```shell
/plugin install deploy-helper --marketplace your-org/plugins

```

--------------------------------

### Install Claude Agent SDK via pip

Source: https://code.claude.com/docs/en/agent-sdk/migration-guide

Installs the claude-agent-sdk package in your Python environment.

```shell
pip install claude-agent-sdk

```

--------------------------------

### Start self-hosted runner with secret file and base directory

Source: https://code.claude.com/docs/en/self-hosted-environments-quickstart

Starts the runner daemon using specified paths for authentication and workspace creation. Replace `<writable-dir>` with an absolute path writable by the runner process.

```bash
claude self-hosted-runner --environment-secret-file '/etc/claude/environment-secret' --base-dir '<writable-dir>'

```

--------------------------------

### Create utils.py with buggy sample functions

Source: https://code.claude.com/docs/en/agent-sdk/quickstart

Provides sample functions in utils.py containing division by zero and null reference bugs for the agent to review and fix.

```python
def calculate_average(numbers):
    total = 0
    for num in numbers:
        total += num
    return total / len(numbers)


def get_user_name(user):
    return user["name"].upper()

```

--------------------------------

### Initialize and install Agent SDK in a new TypeScript project

Source: https://code.claude.com/docs/en/agent-sdk/quickstart

Initializes a package.json, configures ESM module support, and installs the Claude Agent SDK alongside tsx for executing TypeScript files. Setting type to module enables top-level await.

```bash
npm init -y
npm pkg set type=module
npm install @anthropic-ai/claude-agent-sdk
npm install --save-dev tsx
```

--------------------------------

### Check global npm installation of claude-code

Source: https://code.claude.com/docs/en/troubleshoot-install

Checks whether `@anthropic-ai/claude-code` is installed globally via npm.

```bash
npm -g ls @anthropic-ai/claude-code 2>/dev/null

```

--------------------------------

### Enable all discovered skills and tools in a session

Source: https://code.claude.com/docs/en/agent-sdk/skills

Loads skills from user and project filesystem directories, enables all discovered skills with skills set to 'all', and pre-approves necessary tools. Must be executed from a project directory containing .claude/skills/ or under its hierarchy.

```python
import asyncio
import os

from claude_agent_sdk import query, ClaudeAgentOptions


async def main():
    options = ClaudeAgentOptions(
        cwd=os.getcwd(),  # .claude/skills/ here or in a parent directory
        setting_sources=["user", "project"],  # Load skills from filesystem
        skills="all",  # Let Claude invoke every discovered skill
        allowed_tools=["Read", "Write", "Bash"],
    )

    async for message in query(
        prompt="Help me process this PDF document", options=options
    ):
        print(message)


asyncio.run(main())

```

```typescript
import { query } from "@anthropic-ai/claude-agent-sdk";

for await (const message of query({
  prompt: "Help me process this PDF document",
  options: {
    cwd: process.cwd(), // .claude/skills/ here or in a parent directory
    settingSources: ["user", "project"], // Load skills from filesystem
    skills: "all", // Let Claude invoke every discovered skill
    allowedTools: ["Read", "Write", "Bash"]
  }
})) {
  console.log(message);
}

```

--------------------------------

### Install ripgrep on Windows using winget

Source: https://code.claude.com/docs/en/troubleshooting

Installs ripgrep on Windows using the winget package manager.

```shell
winget install BurntSushi.ripgrep.MSVC

```

--------------------------------

### Start Claude Code with debug logging and plugin directory

Source: https://code.claude.com/docs/en/plugins/mods/troubleshoot

Starts Claude Code with output written to a specified debug log file while pointing to a local development copy of a plugin.

```bash
claude --debug-file ./mod-debug.log --plugin-dir ./first-mod

```

--------------------------------

### Install ripgrep on Arch Linux using pacman

Source: https://code.claude.com/docs/en/troubleshooting

Installs the system ripgrep package on Arch Linux.

```shell
pacman -S ripgrep

```

--------------------------------

### Start Remote Control session via CLI

Source: https://code.claude.com/docs/en/remote-control

Run this command in your project directory to initiate a Remote Control session using the CLI.

```bash
claude remote-control

```

--------------------------------

### List configured marketplaces with claude plugin marketplace list

Source: https://code.claude.com/docs/en/plugins/cli-reference

Lists every configured marketplace and its source. Use the `--json` flag to output marketplace details as a JSON array.

```shell
claude plugin marketplace list [options]

```

--------------------------------

### Install specific version on Windows PowerShell

Source: https://code.claude.com/docs/en/setup

Pins and installs a specific version number using PowerShell.

```powershell
& ([scriptblock]::Create((irm https://claude.ai/install.ps1))) 2.1.89

```

--------------------------------

### Install the fakechat channel plugin

Source: https://code.claude.com/docs/en/channels

Enter this command at the Claude Code prompt to install the fakechat plugin from the official marketplace. Choose user scope when prompted so the plugin is available across projects.

```shell
/plugin install fakechat@claude-plugins-official

```

--------------------------------

### Load plugins from directory or zip using --plugin-dir

Source: https://code.claude.com/docs/en/plugins/create

Loads one or more plugins for a single session using directory paths or .zip archives. Repeat the flag to load multiple plugins.

```bash
claude --plugin-dir ./my-first-plugin --plugin-dir ./other-plugin.zip

```

--------------------------------

### Stub and fire $.session.start

Source: https://code.claude.com/docs/en/plugins/mods/test

Register required stubs before calling $ and explicitly fire session.start if hooks depend on its setup. Missing command.register stubs cause calls to reject with 'no implementation for command.register'.

```javascript
// Answer the event after your hook passes it on with next(e)
on('session.start', () => ({ cwd: '/work' }))
// Answer the $.command.register call your hook makes
on('command.register', () => ({ value: undefined }))
// Fire the event, which runs your session.start hook
await $.session.start({ surface: 'terminal', isInteractive: true, cwd: '/work' })
```

--------------------------------

### Invoke plugin skills with query

Source: https://code.claude.com/docs/en/agent-sdk/plugins

Load a local plugin and execute a namespaced plugin skill by sending `/plugin-name:skill-name` as the prompt. Use the plugin's installation path in the options configuration.

```typescript
import { query } from "@anthropic-ai/claude-agent-sdk";

// Load a plugin with a custom /greet skill
for await (const message of query({
  prompt: "/my-plugin:greet", // Use plugin skill with namespace
  options: {
    plugins: [{ type: "local", path: "./my-plugin" }]
  }
})) {
  // Claude executes the custom greeting skill from the plugin
  if (message.type === "assistant") {
    console.log(message.message.content);
  }
}
```

```python
import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, TextBlock


async def main():
    # Load a plugin with a custom /greet skill
    async for message in query(
        prompt="/my-plugin:greet",  # Use plugin skill with namespace
        options=ClaudeAgentOptions(
            plugins=[{"type": "local", "path": "./my-plugin"}]
        ),
    ):
        # Claude executes the custom greeting skill from the plugin
        if isinstance(message, AssistantMessage):
            for block in message.content:
                if isinstance(block, TextBlock):
                    print(f"Claude: {block.text}")


asyncio.run(main())
```

--------------------------------

### Start Claude Code with acceptEdits Permission Mode

Source: https://code.claude.com/docs/en/permission-modes

Starts Claude Code directly in acceptEdits mode, allowing file creations and edits in the working directory without inline prompts. Can also be toggled from Manual mode using Shift+Tab.

```bash
claude --permission-mode acceptEdits

```

--------------------------------

### Install a project-scoped plugin

Source: https://code.claude.com/docs/en/plugins/troubleshooting

Run this command when a plugin is enabled in project settings but not yet downloaded locally. After running, use /reload-plugins to update the session.

```shell
claude plugin install <name>@<marketplace> --scope project

```

--------------------------------

### Allow cross-marketplace dependencies in marketplace.json

Source: https://code.claude.com/docs/en/plugins/dependencies

Add target marketplace names to allowCrossMarketplaceDependenciesOn in the root marketplace.json to permit cross-marketplace dependency installation.

```json
{
  "name": "your-marketplace",
  "owner": { "name": "Your Org" },
  "allowCrossMarketplaceDependenciesOn": ["your-shared-marketplace"],
  "plugins": [
    {
      "name": "deploy-kit",
      "source": "./deploy-kit",
      "dependencies": [
        { "name": "audit-logger", "marketplace": "your-shared-marketplace" }
      ]
    }
  ]
}
```

--------------------------------

### Create and navigate to project folder

Source: https://code.claude.com/docs/en/agent-sdk/quickstart

Creates a new directory for the Agent SDK project and changes into it. The SDK automatically gains access to files in this directory and its subdirectories by default.

```bash
mkdir my-agent
cd my-agent
```

--------------------------------

### Launch Claude Code and run plugin skill

Source: https://code.claude.com/docs/en/plugins/create

Loads the plugin for a single session using the `--plugin-dir` flag and executes the newly created `/my-first-plugin:hello` skill command.

```shell
claude --plugin-dir ./my-first-plugin

```

```shell
/my-first-plugin:hello

```

--------------------------------

### Skill execution sample scan output

Source: https://code.claude.com/docs/en/agent-sdk/skills

Example scan findings returned in the result property of a successful run.

```markdown
**Security scan of `app.js` — 4 findings (most severe first):**

1. **SQL Injection** (line 8) — `req.query.name` is concatenated directly into the SQL string. Trivially exploitable (`' OR '1'='1`, `'; DROP TABLE users;--`). **Fix:** use parameterized queries, e.g. `db.query("SELECT * FROM users WHERE name = ?", [req.query.name], cb)`.
...

```

--------------------------------

### Initialize a plugin evaluation suite with claude plugin eval init

Source: https://code.claude.com/docs/en/whats-new/2026-w37

Run from your plugin's root directory to have Claude propose test cases and scoring checks. The command asks what a good result looks like, runs the suite once, and writes the test files.

```terminal
claude plugin eval init

```

--------------------------------

### ShowOnboardingRolePicker

Source: https://code.claude.com/docs/en/agent-sdk/typescript

Renders a clickable role-picker chip row during Cowork onboarding to select a role and install a matching plugin. Blocks until user response.

```APIDOC
## Tool: ShowOnboardingRolePicker

### Description
Renders a clickable role-picker chip row during Cowork onboarding so the user can pick their role and get a matching plugin installed. Takes no arguments and blocks until the user responds.

### Tool Name
`ShowOnboardingRolePicker`

### Parameters
None.

### Input Schema
```typescript
type ShowOnboardingRolePickerInput = {};
```
```

--------------------------------

### Prompt Specifying Custom Output Format and Action

Source: https://code.claude.com/docs/en/prompt-library

Requests an explanation formatted as an HTML page with a diagram and instructs Claude to open it in a browser.

```text
explain how the payment retry logic works as an HTML page with a diagram, then open it in my browser

```

--------------------------------

### Install Claude Agent SDK via npm

Source: https://code.claude.com/docs/en/agent-sdk/migration-guide

Installs the new @anthropic-ai/claude-agent-sdk package in your TypeScript or JavaScript project.

```shell
npm install @anthropic-ai/claude-agent-sdk

```

--------------------------------

### Create plugin structure and plugin.json

Source: https://code.claude.com/docs/en/plugins/create

Create the required plugin directory structure and initialize the manifest file `my-plugin/.claude-plugin/plugin.json` alongside `.claude/`.

```bash
mkdir -p my-plugin/.claude-plugin

```

```json
{
  "name": "my-plugin",
  "description": "Migrated from standalone configuration",
  "version": "1.0.0"
}

```