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
| @@ -17,29 +17,22 @@ | ||
| 17 | 17 | |
| 18 | 18 | ## Get started |
| 19 | 19 | |
| 20 | -1. Install Claude Code using one of these methods: | |
| 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/agents-and-tools/claude-code/overview#recommended-create-a-new-user-writable-npm-prefix). | |
| 22 | + | |
| 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. | |
| 25 | + | |
| 26 | +2. Install Claude Code: | |
| 21 | 27 | |
| 22 | - **User-level installation** (recommended, no `sudo` required): | |
| 23 | 28 | ```sh |
| 24 | - mkdir -p ~/.local/share/npm-packages | |
| 25 | - npm config set prefix ~/.local/share/npm-packages | |
| 26 | - export PATH=~/.local/share/npm-packages/bin:$PATH | |
| 27 | 29 | npm install -g @anthropic-ai/claude-code |
| 28 | 30 | ``` |
| 29 | - | |
| 30 | - *Add `export PATH=~/.local/share/npm-packages/bin:$PATH` to your `~/.bashrc` or `~/.zshrc` to make the change permanent.* | |
| 31 | - | |
| 32 | - **Installation inside of a virtual environment** (from `nvm`, etc...): | |
| 33 | - ```sh | |
| 34 | - npm install -g @anthropic-ai/claude-code | |
| 35 | - ``` | |
| 36 | 31 | |
| 37 | - *Do NOT install this package as an administrative user, such as `root`. This can compromise the security and stability of your system.* | |
| 32 | +3. Navigate to your project directory and run <code>claude</code>. | |
| 38 | 33 | |
| 39 | -2. Navigate to your project directory and run <code>claude</code>. | |
| 34 | +4. Complete the one-time OAuth process with your Anthropic Console account. | |
| 40 | 35 | |
| 41 | -3. Complete the one-time OAuth process with your Anthropic Console account. | |
| 42 | - | |
| 43 | 36 | ### Research Preview |
| 44 | 37 | |
| 45 | 38 | We're launching Claude Code as a beta product in research preview to learn directly from developers about their experiences collaborating with AI agents. Our aim is to learn more about how developers prefer to collaborate with AI tools, which development workflows benefit most from working with the agent, and how we can make the agent experience more intuitive. |