Skip to content

Latest commit

 

History

History
521 lines (343 loc) · 22.4 KB

File metadata and controls

521 lines (343 loc) · 22.4 KB

Documentation Index

Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt Use this file to discover all available pages before exploring further.

Advanced setup

System requirements, platform-specific installation, version management, and uninstallation for Claude Code.

This page covers system requirements, platform-specific installation details, updates, and uninstallation. For a guided walkthrough of your first session, see the quickstart. If you've never used a terminal before, see the terminal guide.

System requirements

Claude Code runs on the following platforms and configurations:

  • Operating system:
    • macOS 13.0+
    • Windows 10 1809+ or Windows Server 2019+
    • Ubuntu 20.04+
    • Debian 10+
    • Alpine Linux 3.19+
  • Hardware: 4 GB+ RAM, x64 or ARM64 processor
  • Network: internet connection required. See network configuration.
  • Shell: Bash, Zsh, PowerShell, or CMD.
  • Location: Anthropic supported countries

Additional dependencies

Install Claude Code

Prefer a graphical interface? The Desktop app lets you use Claude Code without the terminal. Download it for macOS or Windows.

New to the terminal? See the terminal guide for step-by-step instructions.

To install Claude Code, use one of the following methods:

**macOS, Linux, WSL:**

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

**Windows PowerShell:**

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

**Windows CMD:**

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

If you see `The token '&&' is not a valid statement separator`, you're in PowerShell, not CMD. If you see `'irm' is not recognized as an internal or external command`, you're in CMD, not PowerShell. Your prompt shows `PS C:\` when you're in PowerShell and `C:\` without the `PS` when you're in CMD.

[Git for Windows](https://git-scm.com/downloads/win) is recommended on native Windows so Claude Code can use the Bash tool. If Git for Windows is not installed, Claude Code uses PowerShell as the shell tool instead. WSL setups do not need Git for Windows.

  Native installations automatically update in the background to keep you on the latest version.

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

Homebrew offers two casks. `claude-code` tracks the stable release channel, which is typically about a week behind and skips releases with major regressions. `claude-code@latest` tracks the latest channel and receives new versions as soon as they ship.

  Homebrew installations do not auto-update. Run `brew upgrade claude-code` or `brew upgrade claude-code@latest`, depending on which cask you installed, to get the latest features and security fixes.

```powershell
winget install Anthropic.ClaudeCode
```

  WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.

You can also install with apt, dnf, or apk on Debian, Fedora, RHEL, and Alpine.

After installation completes, open a terminal in the project you want to work in and start Claude Code:

claude

If you encounter any issues during installation, see Troubleshoot installation and login.

Set up on Windows

You can run Claude Code natively on Windows or inside WSL. Pick based on where your projects are located and which features you need:

Option Requires Sandboxing When to use
Native Windows None; Git for Windows is optional Not supported Windows-native projects and tools
WSL 2 WSL 2 enabled Supported Linux toolchains or sandboxed command execution
WSL 1 WSL 1 enabled Not supported If WSL 2 is unavailable

Option 1: Native Windows

Run the install command from PowerShell or CMD. You do not need to run as Administrator. Installing Git for Windows is optional. It enables the Bash tool by providing Git Bash.

Whether you install from PowerShell or CMD only affects which install command you run. Your prompt shows PS C:\Users\YourName> in PowerShell and C:\Users\YourName> without the PS in CMD. If you're new to the terminal, the terminal guide walks through each step.

After installation, launch claude from any terminal.

  • Without Git for Windows, Claude Code runs shell commands via the PowerShell tool.

  • With Git for Windows, Claude Code uses Git Bash for the Bash tool. If Claude Code can't find Git Bash, set the path in your settings.json file:

    {
      "env": {
        "CLAUDE_CODE_GIT_BASH_PATH": "C:\\Program Files\\Git\\bin\\bash.exe"
      }
    }

When Git for Windows is installed, the PowerShell tool is rolling out progressively as an additional option alongside Bash. Set CLAUDE_CODE_USE_POWERSHELL_TOOL=1 to opt in or 0 to opt out. See PowerShell tool for setup and limitations.

Option 2: WSL

Open your WSL distribution and run the Linux installer from the install instructions above. You install and launch claude inside the WSL terminal, not from PowerShell or CMD.

Alpine Linux and musl-based distributions

The native installer on Alpine and other musl/uClibc-based distributions requires libgcc, libstdc++, and ripgrep. Install these using your distribution's package manager, then set USE_BUILTIN_RIPGREP=0.

This example installs the required packages on Alpine:

apk add libgcc libstdc++ ripgrep

Then set USE_BUILTIN_RIPGREP to 0 in your settings.json file:

{
  "env": {
    "USE_BUILTIN_RIPGREP": "0"
  }
}

Verify your installation

After installing, confirm Claude Code is working:

claude --version

If this fails with command not found or another error, see Troubleshoot installation and login.

For a more detailed check of your installation and configuration, run claude doctor:

claude doctor

Authenticate

Claude Code requires a Pro, Max, Team, Enterprise, or Console account. The free Claude.ai plan does not include Claude Code access. You can also use Claude Code with a third-party API provider like Amazon Bedrock, Google Vertex AI, or Microsoft Foundry.

After installing, log in by running claude and following the browser prompts. See Authentication for all account types and team setup options.

Update Claude Code

Native installations automatically update in the background. You can configure the release channel to control whether you receive updates immediately or on a delayed stable schedule, or disable auto-updates entirely. Homebrew, WinGet, and Linux package manager installations require manual updates by default.

Auto-updates

Claude Code checks for updates on startup and periodically while running. Updates download and install in the background, then take effect the next time you start Claude Code.

Homebrew, WinGet, apt, dnf, and apk installations do not auto-update by default; see below to opt in for Homebrew and WinGet. To upgrade Homebrew manually, run brew upgrade claude-code or brew upgrade claude-code@latest, depending on which cask you installed. For WinGet, run winget upgrade Anthropic.ClaudeCode. For Linux package managers, see the upgrade commands in Install with Linux package managers.

To have Claude Code run the upgrade command for you on Homebrew or WinGet, set CLAUDE_CODE_PACKAGE_MANAGER_AUTO_UPDATE to 1. Claude Code then runs the upgrade in the background when a new version is available and shows a restart prompt on success. The upgrade targets only the Claude Code package and does not affect other software you have installed.

On WinGet the upgrade may fail while Claude Code is running because Windows locks the executable. In that case Claude Code shows the manual command instead. apt, dnf, and apk continue to require a manual upgrade because those commands need elevated privileges.

Known issue: Claude Code may notify you of updates before the new version is available in these package managers. If an upgrade fails, wait and try again later.

Homebrew keeps old versions on disk after upgrades. Run brew cleanup periodically to reclaim disk space.

Configure release channel

Control which release channel Claude Code follows for auto-updates and claude update with the autoUpdatesChannel setting:

  • "latest", the default: receive new features as soon as they're released
  • "stable": use a version that is typically about one week old, skipping releases with major regressions

Configure this via /configAuto-update channel, or add it to your settings.json file:

{
  "autoUpdatesChannel": "stable"
}

For enterprise deployments, you can enforce a consistent release channel across your organization using managed settings.

Homebrew installations choose a channel by cask name instead of this setting: claude-code tracks stable and claude-code@latest tracks latest.

Pin a minimum version

The minimumVersion setting establishes a floor. Background auto-updates and claude update refuse to install any version below this value, so moving to the "stable" channel does not downgrade you if you are already on a newer "latest" build.

Switching from "latest" to "stable" via /config prompts you to either stay on the current version or allow the downgrade. Choosing to stay sets minimumVersion to that version. Switching back to "latest" clears it.

Add it to your settings.json file to pin a floor explicitly:

{
  "autoUpdatesChannel": "stable",
  "minimumVersion": "2.1.100"
}

In managed settings, this enforces an organization-wide minimum that user and project settings cannot override.

Disable auto-updates

Set DISABLE_AUTOUPDATER to "1" in the env key of your settings.json file:

{
  "env": {
    "DISABLE_AUTOUPDATER": "1"
  }
}

DISABLE_AUTOUPDATER only stops the background check; claude update and claude install still work. To block all update paths, including manual updates, set DISABLE_UPDATES instead. Use this when you distribute Claude Code through your own channels and need users to stay on the version you provide.

Update manually

To apply an update immediately without waiting for the next background check, run:

claude update

Advanced installation options

These options are for version pinning, Linux package managers, npm, and verifying binary integrity.

Install a specific version

The native installer accepts either a specific version number or a release channel (latest or stable). The channel you choose at install time becomes your default for auto-updates. See configure release channel for more information.

To install the latest version (default):

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

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

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

To install the stable version:

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

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

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

To install a specific version number:

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

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

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

Install with Linux package managers

Claude Code publishes signed apt, dnf, and apk repositories. Replace stable with latest for the rolling channel. Package manager installations do not auto-update through Claude Code; updates arrive through your normal system upgrade workflow.

All repositories are signed with the Claude Code release signing key. Before trusting the key, verify it as described in each tab.

For Debian and Ubuntu. To use the rolling channel, change both `stable` occurrences in the `deb` line: the URL path and the suite name.

```bash
sudo install -d -m 0755 /etc/apt/keyrings
sudo curl -fsSL https://downloads.claude.ai/keys/claude-code.asc \
  -o /etc/apt/keyrings/claude-code.asc
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
```

Verify the GPG key fingerprint before trusting it: `gpg --show-keys /etc/apt/keyrings/claude-code.asc` should report `31DD DE24 DDFA B679 F42D 7BD2 BAA9 29FF 1A7E CACE`.

To upgrade later, run `sudo apt update && sudo apt upgrade claude-code`.

For Fedora and RHEL:

```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
```

dnf downloads the key on first install and prompts you to confirm the fingerprint. Verify it matches `31DD DE24 DDFA B679 F42D 7BD2 BAA9 29FF 1A7E CACE` before accepting.

To upgrade later, run `sudo dnf upgrade claude-code`.

For Alpine Linux:

```sh
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
```

Verify the downloaded key with `sha256sum /etc/apk/keys/claude-code.rsa.pub`, which should report `395759c1f7449ef4cdef305a42e820f3c766d6090d142634ebdb049f113168b6`.

To upgrade later, run `apk update && apk upgrade claude-code`.

Install with npm

You can also install Claude Code as a global npm package. The package requires Node.js 18 or later.

npm install -g @anthropic-ai/claude-code

The npm package installs the same native binary as the standalone installer. npm pulls the binary in through a per-platform optional dependency such as @anthropic-ai/claude-code-darwin-arm64, and a postinstall step links it into place. The installed claude binary does not itself invoke Node.

Supported npm install platforms are darwin-arm64, darwin-x64, linux-x64, linux-arm64, linux-x64-musl, linux-arm64-musl, win32-x64, and win32-arm64. Your package manager must allow optional dependencies. See troubleshooting if the binary is missing after install.

To upgrade an npm installation, run npm install -g @anthropic-ai/claude-code@latest. Avoid npm update -g, which respects the semver range from the original install and may not move you to the newest release.

Do NOT use sudo npm install -g as this can lead to permission issues and security risks. If you encounter permission errors, see troubleshooting permission errors.

Binary integrity and code signing

Each release publishes a manifest.json containing SHA256 checksums for every platform binary. The manifest is signed with an Anthropic GPG key, so verifying the signature on the manifest transitively verifies every binary it lists.

Verify the manifest signature

Steps 1-3 require a POSIX shell with gpg and curl. On Windows, run them in Git Bash or WSL. Step 4 includes a PowerShell option.

The release signing key is published at a fixed URL.

```bash
curl -fsSL https://downloads.claude.ai/keys/claude-code.asc | gpg --import
```

Display the fingerprint of the imported key.

```bash
gpg --fingerprint security@anthropic.com
```

Confirm the output includes this fingerprint:

```text
31DD DE24 DDFA B679 F42D  7BD2 BAA9 29FF 1A7E CACE
```

Set `VERSION` to the release you want to verify.

```bash
REPO=https://downloads.claude.ai/claude-code-releases
VERSION=2.1.89
curl -fsSLO "$REPO/$VERSION/manifest.json"
curl -fsSLO "$REPO/$VERSION/manifest.json.sig"
```

Verify the detached signature against the manifest.

```bash
gpg --verify manifest.json.sig manifest.json
```

A valid result reports `Good signature from "Anthropic Claude Code Release Signing <security@anthropic.com>"`.

`gpg` also prints `WARNING: This key is not certified with a trusted signature!` for any freshly imported key. This is expected. The `Good signature` line confirms the cryptographic check passed. The fingerprint comparison in Step 1 confirms the key itself is authentic.

Compare the SHA256 checksum of your downloaded binary with the value listed under `platforms.<platform>.checksum` in `manifest.json`.

    ```bash
    sha256sum claude
    ```

    ```bash
    shasum -a 256 claude
    ```

    ```powershell
    (Get-FileHash claude.exe -Algorithm SHA256).Hash.ToLower()
    ```

Manifest signatures are available for releases from 2.1.89 onward. Earlier releases publish checksums in manifest.json without a detached signature.

Platform code signatures

In addition to the signed manifest, individual binaries carry platform-native code signatures where supported.

  • macOS: signed by "Anthropic PBC" and notarized by Apple. Verify with codesign --verify --verbose ./claude.
  • Windows: signed by "Anthropic, PBC". Verify with Get-AuthenticodeSignature .\claude.exe.
  • Linux: binaries are not individually code-signed. If you download directly from the claude-code-releases bucket or use the native installer, verify integrity with the manifest signature above. If you install with apt, dnf, or apk, your package manager verifies signatures automatically using the repository signing key.

Uninstall Claude Code

To remove Claude Code, follow the instructions for your installation method. If claude still runs afterward, you likely have a second installation or a leftover shell alias from an older installer. See Check for conflicting installations to find and remove it.

Native installation

Remove the Claude Code binary and version files:

```bash
rm -f ~/.local/bin/claude
rm -rf ~/.local/share/claude
```

```powershell
Remove-Item -Path "$env:USERPROFILE\.local\bin\claude.exe" -Force
Remove-Item -Path "$env:USERPROFILE\.local\share\claude" -Recurse -Force
```

Homebrew installation

Remove the Homebrew cask you installed. If you installed the stable cask:

brew uninstall --cask claude-code

If you installed the latest cask:

brew uninstall --cask claude-code@latest

WinGet installation

Remove the WinGet package:

winget uninstall Anthropic.ClaudeCode

apt / dnf / apk

Remove the package and the repository configuration:

```bash
sudo apt remove claude-code
sudo rm /etc/apt/sources.list.d/claude-code.list /etc/apt/keyrings/claude-code.asc
```

```bash
sudo dnf remove claude-code
sudo rm /etc/yum.repos.d/claude-code.repo
```

```sh
apk del claude-code
sed -i '\|downloads.claude.ai/claude-code/apk|d' /etc/apk/repositories
rm /etc/apk/keys/claude-code.rsa.pub
```

npm

Remove the global npm package:

npm uninstall -g @anthropic-ai/claude-code

Remove configuration files

Removing configuration files will delete all your settings, allowed tools, MCP server configurations, and session history.

The VS Code extension, the JetBrains plugin, and the Desktop app also write to ~/.claude/. If any of them is still installed, the directory is recreated the next time it runs. To remove Claude Code completely, uninstall the VS Code extension, the JetBrains plugin, and the Desktop app before deleting these files.

To remove Claude Code settings and cached data:

```bash
# Remove user settings and state
rm -rf ~/.claude
rm ~/.claude.json

# Remove project-specific settings (run from your project directory)
rm -rf .claude
rm -f .mcp.json
```

```powershell
# Remove user settings and state
Remove-Item -Path "$env:USERPROFILE\.claude" -Recurse -Force
Remove-Item -Path "$env:USERPROFILE\.claude.json" -Force

# Remove project-specific settings (run from your project directory)
Remove-Item -Path ".claude" -Recurse -Force
Remove-Item -Path ".mcp.json" -Force
```