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)

Searching Database…

151.2K ·GitHub
Claude-code
这是什么？Claude Code 是一款在终端中运行的智能体编程工具。它能理解你的代码库，并通过自然语言指令执行日常任务、解释复杂代码、处理 git 工作流，帮你更快地写代码。
它是命令行工具，还是也能在编辑器里使用？它主要是终端命令行工具，但你也可以在 IDE 中使用它，或在 GitHub 上 @claude 来调用它。
我该怎么安装并开始使用？在 MacOS/Linux 上通过 Homebrew 安装（推荐），在 Windows 上通过 WinGet 安装（推荐）；NPM 安装方式已弃用。然后进入项目目录，运行 'claude'。
还应该用 npm 安装吗？不应该。通过 npm 安装已被明确标记为弃用，推荐的方式是 Homebrew（MacOS/Linux）或 WinGet（Windows）。
它在 macOS 和 Windows 上也能用，而不只是 Linux 吗？是的，它支持 MacOS、Linux 和 Windows，每个系统都有各自推荐的安装程序。
它会收集我使用时的哪些数据？它会收集反馈信息，包括代码采纳或拒绝等使用数据、相关的对话数据，以及通过 /bug 命令提交的反馈；其中敏感信息的保留时间有限。
我能用自定义命令扩展 Claude Code 吗？可以。该仓库包含一些插件，可通过自定义命令和智能体扩展功能，相关说明见 plugins 目录。
有没有可以交流这个项目的社区？有。Claude Developers Discord 是一个社区，你可以在那里获得帮助、分享反馈，并与其他开发者讨论项目。
What are similar projects?Aperant, billion-context, copperhead, agent-router, qwen-code, ralph, epiq, claude-code
Which topics is it in?git, anthropic, agents, devops, coding-agent, claude, agent, claude-code, npm, terminal, automation, ai-agents
Creator
anthropics
Size
32.5 MB
Stars
151.2K
Updated
CommitOct 16Releasev2.1.302Oct 16
Age
1y
Commits · 90 Days