docs: update installation instructions in README

- Add note that npm installation is deprecated
- Add link to setup documentation
- Add WinGet installation option for Windows
- Update Homebrew to indicate MacOS/Linux support
- Mark recommended installation methods
- Improve formatting with proper indentation
This commit is contained in:
Kurt Carpenter
2026-01-12 15:11:57 -08:00
parent b17c088cdc
commit b640d94a49

View File

@@ -11,31 +11,38 @@ Claude Code is an agentic coding tool that lives in your terminal, understands y
<img src="./demo.gif" /> <img src="./demo.gif" />
## Get started ## 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](https://code.claude.com/docs/en/setup).
1. Install Claude Code: 1. Install Claude Code:
**MacOS/Linux:** **MacOS/Linux (Recommended):**
```bash ```bash
curl -fsSL https://claude.ai/install.sh | bash curl -fsSL https://claude.ai/install.sh | bash
``` ```
**Homebrew (MacOS):** **Homebrew (MacOS/Linux):**
```bash ```bash
brew install --cask claude-code brew install --cask claude-code
``` ```
**Windows:** **Windows (Recommended):**
```powershell ```powershell
irm https://claude.ai/install.ps1 | iex irm https://claude.ai/install.ps1 | iex
``` ```
**NPM:** **WinGet (Windows):**
```powershell
winget install Anthropic.ClaudeCode
```
**NPM (Deprecated):**
```bash ```bash
npm install -g @anthropic-ai/claude-code 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/)
2. Navigate to your project directory and run `claude`. 2. Navigate to your project directory and run `claude`.
## Plugins ## Plugins