claude-code README

The project's README from github.com/anthropics/claude-code. As one markdown file: README.md.

Claude Code

npm

Claude Code is an agentic coding tool that lives in your terminal, understands your codebase, and helps you code faster by executing routine tasks, explaining complex code, and handling git workflows -- all through natural language commands. Use it in your terminal, IDE, or tag @claude on Github.

Learn more in the official documentation.

Get started

[!NOTE] Installation via npm is deprecated. Use one of the recommended methods below.

For more installation options, uninstall steps, and troubleshooting, see the setup documentation.

  1. Install Claude Code:

    MacOS/Linux (Recommended):

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

    Homebrew (MacOS/Linux):

    brew install --cask claude-code
    

    Windows (Recommended):

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

    WinGet (Windows):

    winget install Anthropic.ClaudeCode
    

    NPM (Deprecated):

    npm install -g @anthropic-ai/claude-code
    
  2. Navigate to your project directory and run claude.

Plugins

This repository includes several Claude Code plugins that extend functionality with custom commands and agents. See the plugins directory for detailed documentation on available plugins.

Reporting Bugs

We welcome your feedback. Use the /bug command to report issues directly within Claude Code, or file a GitHub issue.

Connect on Discord

Join the Claude Developers Discord to connect with other developers using Claude Code. Get help, share feedback, and discuss your projects with the community.

Data collection, usage, and retention

When you use Claude Code, we collect feedback, which includes usage data (such as code acceptance or rejections), associated conversation data, and user feedback submitted via the /bug command.

How we use your data

See our data usage policies.

Privacy safeguards

We have implemented several safeguards to protect your data, including limited retention periods for sensitive information, restricted access to user session data, and clear policies against using feedback for model training.

For full details, please review our Commercial Terms of Service and Privacy Policy.

claude-code (anthropics/claude-code)

anthropic
Searching Database…

What is this?Claude Code is an agentic coding tool that runs in your terminal. It understands your codebase and helps you code faster by executing routine tasks, explaining complex code, and handling git workflows through natural language commands.
Is this a CLI tool, or can I also use it inside my editor?It's primarily a terminal CLI, but you can also use it in your IDE or tag @claude on GitHub to invoke it.
How do I install and start using it?Install via Homebrew on MacOS/Linux (recommended) or WinGet on Windows (recommended); NPM installation is deprecated. Then navigate to your project directory and run 'claude'.
Is the npm install method still the way to go?No, installing via npm is explicitly marked as deprecated; the recommended paths are Homebrew (MacOS/Linux) or WinGet (Windows).
Does it work on both macOS and Windows, not just Linux?Yes, it supports MacOS, Linux, and Windows, each with its own recommended installer.
What data does it collect about my usage?It collects feedback including usage data like code acceptance or rejection, associated conversation data, and feedback submitted via the /bug command, with limited retention for sensitive information.
Can I extend Claude Code with custom commands?Yes, the repository includes plugins that extend functionality with custom commands and agents, documented in the plugins directory.
Is there a community to discuss the project?Yes, there's a Claude Developers Discord where you can get help, share feedback, and discuss projects with other developers.
Creator
anthropics
Size
31.8 MB
Stars
151.7K
Age
1y
Commits · 90 Days