surshar / claude-code
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.
Built by Anthropic · github.com/anthropics
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
| @@ -4,44 +4,31 @@ | ||
| 4 | 4 | |
| 5 | 5 | [npm]: https://img.shields.io/npm/v/@anthropic-ai/claude-code.svg?style=flat-square |
| 6 | 6 | |
| 7 | -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. | |
| 7 | +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. | |
| 8 | 8 | |
| 9 | -Some of its key capabilities include: | |
| 10 | - | |
| 11 | -- Edit files and fix bugs across your codebase | |
| 12 | -- Answer questions about your code's architecture and logic | |
| 13 | -- Execute and fix tests, lint, and other commands | |
| 14 | -- Search through git history, resolve merge conflicts, and create commits and PRs | |
| 15 | - | |
| 16 | 9 | **Learn more in the [official documentation](https://docs.anthropic.com/en/docs/claude-code/overview)**. |
| 17 | 10 | |
| 11 | +<img src="./demo.gif" /> | |
| 12 | + | |
| 18 | 13 | ## Get started |
| 19 | 14 | |
| 20 | -1. If you are new to Node.js and Node Package Manager (`npm`), then it is recommended that you configure an NPM prefix for your user. | |
| 21 | - Instructions on how to do this can be found [here](https://docs.anthropic.com/en/docs/claude-code/troubleshooting#recommended-solution-create-a-user-writable-npm-prefix). | |
| 15 | +1. Install Claude Code: | |
| 22 | 16 | |
| 23 | - _Important_ We recommend installing this package as a non-privileged user, not as an administrative user like `root`. | |
| 24 | - Installing as a non-privileged user helps maintain your system's security and stability. | |
| 17 | +```sh | |
| 18 | +npm install -g @anthropic-ai/claude-code | |
| 19 | +``` | |
| 25 | 20 | |
| 26 | -2. Install Claude Code: | |
| 21 | +2. Navigate to your project directory and run `claude`. | |
| 27 | 22 | |
| 28 | - ```sh | |
| 29 | - npm install -g @anthropic-ai/claude-code | |
| 30 | - ``` | |
| 23 | +## Reporting Bugs | |
| 31 | 24 | |
| 32 | -3. Navigate to your project directory and run `claude`. | |
| 33 | - | |
| 34 | -4. Complete the one-time OAuth process with your Claude Max or Anthropic Console account. | |
| 35 | - | |
| 36 | -### Reporting Bugs | |
| 37 | - | |
| 38 | 25 | We welcome feedback during this beta period. Use the `/bug` command to report issues directly within Claude Code, or file a [GitHub issue](https://github.com/anthropics/claude-code/issues). |
| 39 | 26 | |
| 40 | -### Data collection, usage, and retention | |
| 27 | +## Data collection, usage, and retention | |
| 41 | 28 | |
| 42 | 29 | 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. |
| 43 | 30 | |
| 44 | -#### How we use your data | |
| 31 | +### How we use your data | |
| 45 | 32 | |
| 46 | 33 | We may use feedback to improve our products and services, but we will not train generative models using your feedback from Claude Code. Given their potentially sensitive nature, we store user feedback transcripts for only 30 days. |
| 47 | 34 |
Large file, diff not shown.