mirror of
https://github.com/anthropics/claude-code.git
synced 2026-04-24 22:55:16 +00:00
README: Address review comments.
This commit is contained in:
25
README.md
25
README.md
@@ -17,28 +17,21 @@ Some of its key capabilities include:
|
||||
|
||||
## Get started
|
||||
|
||||
1. Install Claude Code using one of these methods:
|
||||
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.
|
||||
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).
|
||||
|
||||
*Important* We recommend installing this package as a non-privileged user, not as an administrative user like `root`.
|
||||
Installing as a non-privileged user helps maintain your system's security and stability.
|
||||
|
||||
2. Install Claude Code:
|
||||
|
||||
**User-level installation** (recommended, no `sudo` required):
|
||||
```sh
|
||||
mkdir -p ~/.local/share/npm-packages
|
||||
npm config set prefix ~/.local/share/npm-packages
|
||||
export PATH=~/.local/share/npm-packages/bin:$PATH
|
||||
npm install -g @anthropic-ai/claude-code
|
||||
```
|
||||
|
||||
*Add `export PATH=~/.local/share/npm-packages/bin:$PATH` to your `~/.bashrc` or `~/.zshrc` to make the change permanent.*
|
||||
|
||||
**Installation inside of a virtual environment** (from `nvm`, etc...):
|
||||
```sh
|
||||
npm install -g @anthropic-ai/claude-code
|
||||
```
|
||||
|
||||
*Do NOT install this package as an administrative user, such as `root`. This can compromise the security and stability of your system.*
|
||||
3. Navigate to your project directory and run <code>claude</code>.
|
||||
|
||||
2. Navigate to your project directory and run <code>claude</code>.
|
||||
|
||||
3. Complete the one-time OAuth process with your Anthropic Console account.
|
||||
4. Complete the one-time OAuth process with your Anthropic Console account.
|
||||
|
||||
### Research Preview
|
||||
|
||||
|
||||
Reference in New Issue
Block a user