Files
claude-code/README.md

66 lines
2.5 KiB
Markdown
Raw Normal View History

# Claude Code
2025-02-22 09:23:42 -08:00
2025-03-10 14:01:20 -07:00
![](https://img.shields.io/badge/Node.js-18%2B-brightgreen?style=flat-square) [![npm]](https://www.npmjs.com/package/@anthropic-ai/claude-code)
[npm]: https://img.shields.io/npm/v/@anthropic-ai/claude-code.svg?style=flat-square
2025-02-22 09:23:42 -08:00
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.
2025-02-22 09:23:42 -08:00
**Learn more in the [official documentation](https://code.claude.com/docs/en/overview)**.
2025-02-22 09:23:42 -08:00
<img src="./demo.gif" />
2025-03-10 14:01:20 -07:00
## Get started
1. Install Claude Code:
2025-03-10 14:01:20 -07:00
**MacOS/Linux:**
```bash
curl -fsSL https://claude.ai/install.sh | bash
```
**Homebrew (MacOS):**
```bash
brew install --cask claude-code
```
**Windows:**
```powershell
irm https://claude.ai/install.ps1 | iex
```
**NPM:**
```bash
npm install -g @anthropic-ai/claude-code
```
NOTE: If installing with NPM, you also need to install [Node.js 18+](https://nodejs.org/en/download/)
2025-03-10 14:01:20 -07:00
2. Navigate to your project directory and run `claude`.
2025-02-22 09:23:42 -08:00
## Plugins
This repository includes several Claude Code plugins that extend functionality with custom commands and agents. See the [plugins directory](./plugins/README.md) for detailed documentation on available plugins.
## Reporting Bugs
2025-02-22 09:23:42 -08:00
We welcome your feedback. Use the `/bug` command to report issues directly within Claude Code, or file a [GitHub issue](https://github.com/anthropics/claude-code/issues).
2025-02-22 09:23:42 -08:00
2025-08-20 11:07:32 -07:00
## Connect on Discord
Join the [Claude Developers Discord](https://anthropic.com/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
2025-02-22 09:23:42 -08:00
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
2025-02-22 09:23:42 -08:00
See our [data usage policies](https://code.claude.com/docs/en/data-usage).
2025-02-22 09:23:42 -08:00
### 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](https://www.anthropic.com/legal/commercial-terms) and [Privacy Policy](https://www.anthropic.com/legal/privacy).