Skip to content

code-overview.md

Latest commit

 

History

History
247 lines (175 loc) · 15.1 KB

code-overview.md

File metadata and controls

247 lines (175 loc) · 15.1 KB
title Overview
source https://code.claude.com/docs/en/overview
category code
generated true

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.

Overview

Claude Code is an agentic coding tool that reads your codebase, edits files, runs commands, and integrates with your development tools. Available in your terminal, IDE, desktop app, and browser.

Claude Code is an AI-powered coding assistant that helps you build features, fix bugs, and automate development tasks. It understands your entire codebase and can work across multiple files and tools to get things done.

Get started

Choose your environment to get started. Most surfaces require a Claude subscription or Anthropic Console account. The Terminal CLI and VS Code also support third-party providers.

The full-featured CLI for working with Claude Code directly in your terminal. Edit files, run commands, and manage your entire project from the command line. 
To install Claude Code, use one of the following methods:

<Tabs>
  <Tab title="Native Install (Recommended)">
    **macOS, Linux, WSL:**

    ```bash theme={null}
    curl -fsSL https://claude.ai/install.sh | bash
    ```

    **Windows PowerShell:**

    ```powershell theme={null}
    irm https://claude.ai/install.ps1 | iex
    ```

    **Windows CMD:**

    ```batch theme={null}
    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.

    <Info>
      Native installations automatically update in the background to keep you on the latest version.
    </Info>
  </Tab>

  <Tab title="Homebrew">
    ```bash theme={null}
    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.

    <Info>
      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.
    </Info>
  </Tab>

  <Tab title="WinGet">
    ```powershell theme={null}
    winget install Anthropic.ClaudeCode
    ```

    <Info>
      WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.
    </Info>
  </Tab>
</Tabs>

You can also install with [apt, dnf, or apk](./code-setup.md#install-with-linux-package-managers) on Debian, Fedora, RHEL, and Alpine.

Then start Claude Code in any project:

```bash theme={null}
cd your-project
claude
```

You'll be prompted to log in on first use. That's it! [Continue with the Quickstart →](./code-quickstart.md)

<Tip>
  See [advanced setup](./code-setup.md) for installation options, manual updates, or uninstallation instructions. Visit [installation troubleshooting](./code-troubleshoot-install.md) if you hit issues.
</Tip>
The VS Code extension provides inline diffs, @-mentions, plan review, and conversation history directly in your editor. 
* [Install for VS Code](vscode:extension/anthropic.claude-code)
* [Install for Cursor](cursor:extension/anthropic.claude-code)

Or search for "Claude Code" in the Extensions view (`Cmd+Shift+X` on Mac, `Ctrl+Shift+X` on Windows/Linux). After installing, open the Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`), type "Claude Code", and select **Open in New Tab**.

[Get started with VS Code →](./code-vs-code.md#get-started)
A standalone app for running Claude Code outside your IDE or terminal. Review diffs visually, run multiple sessions side by side, schedule recurring tasks, and kick off cloud sessions. 
Download and install:

* [macOS](https://claude.ai/api/desktop/darwin/universal/dmg/latest/redirect?utm_source=claude_code\&utm_medium=docs) (Intel and Apple Silicon)
* [Windows](https://claude.ai/api/desktop/win32/x64/setup/latest/redirect?utm_source=claude_code\&utm_medium=docs) (x64)
* [Windows ARM64](https://claude.ai/api/desktop/win32/arm64/setup/latest/redirect?utm_source=claude_code\&utm_medium=docs)

After installing, launch Claude, sign in, and click the **Code** tab to start coding. A [paid subscription](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=overview_desktop_pricing) is required.

[Learn more about the desktop app →](./code-desktop-quickstart.md)
Run Claude Code in your browser with no local setup. Kick off long-running tasks and check back when they're done, work on repos you don't have locally, or run multiple tasks in parallel. Available on desktop browsers and the Claude iOS app. 
Start coding at [claude.ai/code](https://claude.ai/code).

[Get started on the web →](./code-web-quickstart.md)
A plugin for IntelliJ IDEA, PyCharm, WebStorm, and other JetBrains IDEs with interactive diff viewing and selection context sharing. 
Install the [Claude Code plugin](https://plugins.jetbrains.com/plugin/27310-claude-code-beta-) from the JetBrains Marketplace and restart your IDE.

[Get started with JetBrains →](./code-jetbrains.md)

What you can do

Here are some of the ways you can use Claude Code:

Claude Code handles the tedious tasks that eat up your day: writing tests for untested code, fixing lint errors across a project, resolving merge conflicts, updating dependencies, and writing release notes. 
```bash theme={null}
claude "write tests for the auth module, run them, and fix any failures"
```
Describe what you want in plain language. Claude Code plans the approach, writes the code across multiple files, and verifies it works. 
For bugs, paste an error message or describe the symptom. Claude Code traces the issue through your codebase, identifies the root cause, and implements a fix. See [common workflows](./code-common-workflows.md) for more examples.
Claude Code works directly with git. It stages changes, writes commit messages, creates branches, and opens pull requests. 
```bash theme={null}
claude "commit my changes with a descriptive message"
```

In CI, you can automate code review and issue triage with [GitHub Actions](./code-github-actions.md) or [GitLab CI/CD](./code-gitlab-ci-cd.md).
The [Model Context Protocol (MCP)](./code-mcp.md) is an open standard for connecting AI tools to external data sources. With MCP, Claude Code can read your design docs in Google Drive, update tickets in Jira, pull data from Slack, or use your own custom tooling. [`CLAUDE.md`](./code-memory.md) is a markdown file you add to your project root that Claude Code reads at the start of every session. Use it to set coding standards, architecture decisions, preferred libraries, and review checklists. Claude also builds [auto memory](./code-memory.md#auto-memory) as it works, saving learnings like build commands and debugging insights across sessions without you writing anything. 
Create [skills](./code-skills.md) to package repeatable workflows your team can share, like `/review-pr` or `/deploy-staging`.

[Hooks](./code-hooks.md) let you run shell commands before or after Claude Code actions, like auto-formatting after every file edit or running lint before a commit.
Spawn [multiple Claude Code agents](./code-sub-agents.md) that work on different parts of a task simultaneously. A lead agent coordinates the work, assigns subtasks, and merges results. 
To run several full sessions in parallel and watch them from one screen, use [background agents](./code-agent-view.md). For fully custom workflows, the [Agent SDK](./code-agent-sdk/overview.md) lets you build your own agents powered by Claude Code's tools and capabilities, with full control over orchestration, tool access, and permissions.
Claude Code is composable and follows the Unix philosophy. Pipe logs into it, run it in CI, or chain it with other tools: 
```bash theme={null}
# Analyze recent log output
tail -200 app.log | claude -p "Slack me if you see any anomalies"

# Automate translations in CI
claude -p "translate new strings into French and raise a PR for review"

# Bulk operations across files
git diff main --name-only | claude -p "review these changed files for security issues"
```

See the [CLI reference](./code-cli-reference.md) for the full set of commands and flags.
Run Claude on a schedule to automate work that repeats: morning PR reviews, overnight CI failure analysis, weekly dependency audits, or syncing docs after PRs merge. 
* [Routines](./code-routines.md) run on Anthropic-managed infrastructure, so they keep running even when your computer is off. They can also trigger on API calls or GitHub events. Create them from the web, the Desktop app, or by running `/schedule` in the CLI.
* [Desktop scheduled tasks](./code-desktop-scheduled-tasks.md) run on your machine, with direct access to your local files and tools
* [`/loop`](./code-scheduled-tasks.md) repeats a prompt within a CLI session for quick polling
Sessions aren't tied to a single surface. Move work between environments as your context changes: 
* Step away from your desk and keep working from your phone or any browser with [Remote Control](./code-remote-control.md)
* Message [Dispatch](./code-desktop.md#sessions-from-dispatch) a task from your phone and open the Desktop session it creates
* Kick off a long-running task on the [web](./code-claude-code-on-the-web.md) or [iOS app](https://apps.apple.com/app/claude-by-anthropic/id6473753684), then pull it into your terminal with `claude --teleport`
* Hand off a terminal session to the [Desktop app](./code-desktop.md) with `/desktop` for visual diff review
* Route tasks from team chat: mention `@Claude` in [Slack](./code-slack.md) with a bug report and get a pull request back

Use Claude Code everywhere

Each surface connects to the same underlying Claude Code engine, so your CLAUDE.md files, settings, and MCP servers work across all of them.

Beyond the Terminal, VS Code, JetBrains, Desktop, and Web environments above, Claude Code integrates with CI/CD, chat, and browser workflows:

I want to... Best option
Continue a local session from my phone or another device Remote Control
Push events from Telegram, Discord, iMessage, or my own webhooks into a session Channels
Start a task locally, continue on mobile Web or Claude iOS app
Run Claude on a recurring schedule Routines or Desktop scheduled tasks
Automate PR reviews and issue triage GitHub Actions or GitLab CI/CD
Get automatic code review on every PR GitHub Code Review
Route bug reports from Slack to pull requests Slack
Debug live web applications Chrome
Build custom agents for your own workflows Agent SDK

Next steps

Once you've installed Claude Code, these guides help you go deeper.