← Back to daily report
+44 lines added
-45 lines removed
> ## Documentation Index¶
> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt¶
> Use this file to discover all available pages before exploring further.¶
¶
# Quickstart¶
¶
> Welcome to Claude Code!¶
¶
This quickstart guide will have you using AI-powered coding assistance in just a few minutes. By the end, you'll understand how to use Claude Code for common development tasks.¶
¶
## Before you begin¶
¶
Make sure you have:¶
¶
* A terminal or command prompt open¶
* A code project to work with¶
* A [Claude subscription](https://claude.com/pricing) (Pro, Max, Teams, or Enterprise) or, [Claude Console](https://console.anthropic.com/) account, or access through a [supported cloud provider](/en/third-party-integrations)¶
¶
<Note>¶
This guide covers the terminal CLI. Claude Code is also available on the [web](https://claude.ai/code), as a [desktop app](/en/desktop), in [VS Code](/en/vs-code) and [JetBrains IDEs](/en/jetbrains), in [Slack](/en/slack), and in CI/CD with [GitHub Actions](/en/github-actions) and [GitLab](/en/gitlab-ci-cd). See [all interfaces](/en/overview#use-claude-code-everywhere).¶
</Note>¶
¶
## Step 1: Install Claude Code¶
¶
To install Claude Code, use one of the following methods:¶
¶
<Tabs>¶
<Tab title="Native Install (Recommended)">¶
**macOS, Linux, WSL:**¶
¶
```bash theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}¶
curl -fsSL https://claude.ai/install.sh | bash¶
```¶
¶
**Windows PowerShell:**¶
¶
```powershell theme={null}¶
irm https://claude.ai/install.ps1 | iex¶
```¶
¶
**Windows CMD:**¶
¶
```batch theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}¶
irm https://claude.ai/install.ps1 | iex¶
```¶
¶
**Windows CMD:**¶
¶
```batch theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}¶
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd¶
```¶
¶
<Info>¶
Native installations automatically update in the background to keep you on the latest version.¶
</Info>¶
</Tab>¶
¶
<Tab title="Homebrew">¶
```sh theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}¶
brew install --cask claude-code¶
```¶
¶
<Info>¶
Homebrew installations do not auto-update. Run `brew upgrade claude-code` periodically to get the latest features and security fixes.¶
</Info>¶
</Tab>¶
¶
<Tab title="WinGet">¶
```powershell theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}¶
winget install Anthropic.ClaudeCode¶
```¶
¶
<Info>¶
WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.¶
</Info>¶
</Tab>¶
</Tabs>¶
¶
## Step 2: Log in to your account¶
¶
Claude Code requires an account to use. When you start an interactive session with the `claude` command, you'll need to log in:¶
¶
```bash theme={null}¶
claude¶
# You'll be prompted to log in on first use¶
```¶
¶
```bash theme={null}¶
/login¶
# Follow the prompts to log in with your account¶
```¶
¶
You can log in using any of these account types:¶
¶
* [Claude Pro, Max, Teams, or Enterprise](https://claude.com/pricing) (recommended)¶
* [Claude Console](https://console.anthropic.com/) (API access with pre-paid credits)¶
¶
Once logged in, your credentials are stored and you won't need to log in again.¶
¶
<Note>¶
When you first authenticate Claude Code with your Claude Console account, a workspace called "Claude Code" is automatically created for you. This workspace provides centralized cost tracking and management for all Claude Code usage in your organization.¶
</Note>¶
¶
<Note>¶
You can have both account types under the same email address. If you. On first login, a "Claude Code" workspace is automatically created in the Console for centralized cost tracking.¶
* [Amazon Bedrock, Google Vertex AI, or Microsoft Foundry](/en/third-party-integrations) (enterprise cloud providers)¶
¶
Once logged in, your credentials are stored and you won't need to log in again or. To switch accounts later, use the `/login` command within Claude Code.¶
</Note>.¶
¶
## Step 3: Start your first session¶
¶
Open your terminal in any project directory and start Claude Code:¶
¶
```bash theme={null}¶
cd /path/to/your/project¶
claude¶
```¶
¶
You'll see the Claude Code welcome screen with your session information, recent conversations, and latest updates. Type `/help` for available commands or `/resume` to continue a previous conversation.¶
¶
<Tip>¶
After logging in (Step 2), your credentials are stored on your system. Learn more in [Credential Management](/en/iam#credential-management).¶
</Tip>¶
¶
## Step 4: Ask your first question¶
¶
Let's start with understanding your codebase. Try one of these commands:¶
¶
```¶
> what does this project do?¶
```¶
¶
Claude will analyze your files and provide a summary. You can also ask more specific questions:¶
¶
```¶
> what technologies does this project use?¶
```¶
¶
```¶
> where is the main entry point?¶
```¶
¶
```¶
> explain the folder structure¶
```¶
¶
You can also ask Claude about its own capabilities:¶
¶
```¶
> what can Claude Code do?¶
```¶
¶
```¶
> how do I create custom skills in Claude Code?¶
```¶
¶
```¶
> can Claude Code work with Docker?¶
```¶
¶
<Note>¶
Claude Code reads your files as needed - you don't have to manually add context. Claude also has access to its own documentation and can answer questions about its features and capabilities.¶
</Note>¶
¶
## Step 5: Make your first code change¶
¶
Now let's make Claude Code do some actual coding. Try a simple task:¶
¶
```¶
> add a hello world function to the main file¶
```¶
¶
Claude Code will:¶
¶
1. Find the appropriate file¶
2. Show you the proposed changes¶
3. Ask for your approval¶
4. Make the edit¶
¶
<Note>¶
Claude Code always asks for permission before modifying files. You can approve individual changes or enable "Accept all" mode for a session.¶
</Note>¶
¶
## Step 6: Use Git with Claude Code¶
¶
Claude Code makes Git operations conversational:¶
¶
```¶
> what files have I changed?¶
```¶
¶
```¶
> commit my changes with a descriptive message¶
```¶
¶
You can also prompt for more complex Git operations:¶
¶
```¶
> create a new branch called feature/quickstart¶
```¶
¶
```¶
> show me the last 5 commits¶
```¶
¶
```¶
> help me resolve merge conflicts¶
```¶
¶
## Step 7: Fix a bug or add a feature¶
¶
Claude is proficient at debugging and feature implementation.¶
¶
Describe what you want in natural language:¶
¶
```¶
> add input validation to the user registration form¶
```¶
¶
Or fix existing issues:¶
¶
```¶
> there's a bug where users can submit empty forms - fix it¶
```¶
¶
Claude Code will:¶
¶
* Locate the relevant code¶
* Understand the context¶
* Implement a solution¶
* Run tests if available¶
¶
## Step 8: Test out other common workflows¶
¶
There are a number of ways to work with Claude:¶
¶
**Refactor code**¶
¶
```¶
> refactor the authentication module to use async/await instead of callbacks¶
```¶
¶
**Write tests**¶
¶
```¶
> write unit tests for the calculator functions¶
```¶
¶
**Update documentation**¶
¶
```¶
> update the README with installation instructions¶
```¶
¶
**Code review**¶
¶
```¶
> review my changes and suggest improvements¶
```¶
¶
<Tip>¶
**Remember**: Claude Code is your AI pair programmer. Talk to it like you would a helpful colleague - describe what you want to achieve, and it will help you get there.¶
</Tip>¶
¶
## Essential commands¶
¶
Here are the most important commands for daily use:¶
¶
| Command | What it does | Example |¶
| ------------------- | ------------------------------------------------------ | ----------------------------------- |¶
| `claude` | Start interactive mode | `claude` |¶
| `claude "task"` | Run a one-time task | `claude "fix the build error"` |¶
| `claude -p "query"` | Run one-off query, then exit | `claude -p "explain this function"` |¶
| `claude -c` | Continue most recent conversation in current directory | `claude -c` |¶
| `claude -r` | Resume a previous conversation | `claude -r` |¶
| `claude commit` | Create a Git commit | `claude commit` |¶
| `/clear` | Clear conversation history | `> /clear` |¶
| `/help` | Show available commands | `> /help` |¶
| `exit` or Ctrl+C | Exit Claude Code | `> exit` |¶
¶
See the [CLI reference](/en/cli-reference) for a complete list of commands.¶
¶
## Pro tips for beginners¶
¶
For more, see [best practices](/en/best-practices) and [common workflows](/en/common-workflows).¶
¶
<AccordionGroup>¶
<Accordion title="Be specific with your requests">¶
Instead of: "fix the bug"¶
¶
Try: "fix the login bug where users see a blank screen after entering wrong credentials"¶
</Accordion>¶
¶
<Accordion title="Use step-by-step instructions">¶
Break complex tasks into steps:¶
¶
```¶
> 1. create a new database table for user profiles¶
```¶
¶
```¶
> 2. create an API endpoint to get and update user profiles¶
```¶
¶
```¶
> 3. build a webpage that allows users to see and edit their information¶
```¶
</Accordion>¶
¶
<Accordion title="Let Claude explore first">¶
Before making changes, let Claude understand your code:¶
¶
```¶
> analyze the database schema¶
```¶
¶
```¶
> build a dashboard showing products that are most frequently returned by our UK customers¶
```¶
</Accordion>¶
¶
<Accordion title="Save time with shortcuts">¶
* Press `?` to see all available keyboard shortcuts¶
* Use Tab for command completion¶
* Press ↑ for command history¶
* Type `/` to see all commands and skills¶
</Accordion>¶
</AccordionGroup>¶
¶
## What's next?¶
¶
Now that you've learned the basics, explore more advanced features:¶
¶
<CardGroup cols={32}>¶
<Card title="CommonHow Claude Code workflows" icon="graduation-cap" href="/en/commonmicrochip" href="/en/how-claude-code-workflows">¶
Step-by-step guides for common tasksUnderstand the agentic loop, built-in tools, and how Claude Code interacts with your project¶
</Card>¶
¶
<Card title="CLI referenBest practices" icon="terminalstar" href="/en/cli-referenbest-practices">¶
Master all commands and options¶
</Card>¶
¶
<Card title="Configuration" icon="gear" href="/en/settings">¶
Customize Claude CoGet better results with effective prompting and project setup¶
</Card>¶
¶
<Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">¶
Step-by-step guides for your workflowcommon tasks¶
</Card>¶
¶
<Card title="Extend Claude Code on the web" icon="cloud" href="/en/claude-code-on-the-web">¶
Run tasks asynchronously in the cloud¶
</Card>¶
¶
<Card title="About Claude Code" icon="sparkles" href="https://claude.com/product/claude-code">¶
Learn more on claude.com" icon="puzzle-piece" href="/en/features-overview">¶
Customize with CLAUDE.md, skills, hooks, MCP, and more¶
</Card>¶
</CardGroup>¶
¶
## Getting help¶
¶
* **In Claude Code**: Type `/help` or ask "how do I..."¶
* **Documentation**: You're here! Browse other guides¶
* **Community**: Join our [Discord](https://www.anthropic.com/discord) for tips and support¶
Unified Diff
--- a/quickstart.md
+++ b/quickstart.md
@@ -14,7 +14,11 @@
* A terminal or command prompt open
* A code project to work with
-* A [Claude subscription](https://claude.com/pricing) (Pro, Max, Teams, or Enterprise) or [Claude Console](https://console.anthropic.com/) account
+* A [Claude subscription](https://claude.com/pricing) (Pro, Max, Teams, or Enterprise), [Claude Console](https://console.anthropic.com/) account, or access through a [supported cloud provider](/en/third-party-integrations)
+
+<Note>
+ This guide covers the terminal CLI. Claude Code is also available on the [web](https://claude.ai/code), as a [desktop app](/en/desktop), in [VS Code](/en/vs-code) and [JetBrains IDEs](/en/jetbrains), in [Slack](/en/slack), and in CI/CD with [GitHub Actions](/en/github-actions) and [GitLab](/en/gitlab-ci-cd). See [all interfaces](/en/overview#use-claude-code-everywhere).
+</Note>
## Step 1: Install Claude Code
@@ -24,19 +28,19 @@
<Tab title="Native Install (Recommended)">
**macOS, Linux, WSL:**
- ```bash theme={null}
+ ```bash theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
curl -fsSL https://claude.ai/install.sh | bash
```
**Windows PowerShell:**
- ```powershell theme={null}
+ ```powershell theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
irm https://claude.ai/install.ps1 | iex
```
**Windows CMD:**
- ```batch theme={null}
+ ```batch theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd
```
@@ -46,7 +50,7 @@
</Tab>
<Tab title="Homebrew">
- ```sh theme={null}
+ ```sh theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
brew install --cask claude-code
```
@@ -56,7 +60,7 @@
</Tab>
<Tab title="WinGet">
- ```powershell theme={null}
+ ```powershell theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}
winget install Anthropic.ClaudeCode
```
@@ -83,17 +87,10 @@
You can log in using any of these account types:
* [Claude Pro, Max, Teams, or Enterprise](https://claude.com/pricing) (recommended)
-* [Claude Console](https://console.anthropic.com/) (API access with pre-paid credits)
-
-Once logged in, your credentials are stored and you won't need to log in again.
-
-<Note>
- When you first authenticate Claude Code with your Claude Console account, a workspace called "Claude Code" is automatically created for you. This workspace provides centralized cost tracking and management for all Claude Code usage in your organization.
-</Note>
-
-<Note>
- You can have both account types under the same email address. If you need to log in again or switch accounts, use the `/login` command within Claude Code.
-</Note>
+* [Claude Console](https://console.anthropic.com/) (API access with pre-paid credits). On first login, a "Claude Code" workspace is automatically created in the Console for centralized cost tracking.
+* [Amazon Bedrock, Google Vertex AI, or Microsoft Foundry](/en/third-party-integrations) (enterprise cloud providers)
+
+Once logged in, your credentials are stored and you won't need to log in again. To switch accounts later, use the `/login` command.
## Step 3: Start your first session
@@ -115,35 +112,35 @@
Let's start with understanding your codebase. Try one of these commands:
```
-> what does this project do?
+what does this project do?
```
Claude will analyze your files and provide a summary. You can also ask more specific questions:
```
-> what technologies does this project use?
-```
-
-```
-> where is the main entry point?
-```
-
-```
-> explain the folder structure
+what technologies does this project use?
+```
+
+```
+where is the main entry point?
+```
+
+```
+explain the folder structure
```
You can also ask Claude about its own capabilities:
```
-> what can Claude Code do?
-```
-
-```
-> how do I create custom skills in Claude Code?
-```
-
-```
-> can Claude Code work with Docker?
+what can Claude Code do?
+```
+
+```
+how do I create custom skills in Claude Code?
+```
+
+```
+can Claude Code work with Docker?
```
<Note>
@@ -155,7 +152,7 @@
Now let's make Claude Code do some actual coding. Try a simple task:
```
-> add a hello world function to the main file
+add a hello world function to the main file
```
Claude Code will:
@@ -174,25 +171,25 @@
Claude Code makes Git operations conversational:
```
-> what files have I changed?
-```
-
-```
-> commit my changes with a descriptive message
+what files have I changed?
+```
+
+```
+commit my changes with a descriptive message
```
You can also prompt for more complex Git operations:
```
-> create a new branch called feature/quickstart
-```
-
-```
-> show me the last 5 commits
-```
-
-```
-> help me resolve merge conflicts
+create a new branch called feature/quickstart
+```
+
+```
+show me the last 5 commits
+```
+
+```
+help me resolve merge conflicts
```
## Step 7: Fix a bug or add a feature
@@ -202,13 +199,13 @@
Describe what you want in natural language:
```
-> add input validation to the user registration form
+add input validation to the user registration form
```
Or fix existing issues:
```
-> there's a bug where users can submit empty forms - fix it
+there's a bug where users can submit empty forms - fix it
```
Claude Code will:
@@ -225,25 +222,25 @@
**Refactor code**
```
-> refactor the authentication module to use async/await instead of callbacks
+refactor the authentication module to use async/await instead of callbacks
```
**Write tests**
```
-> write unit tests for the calculator functions
+write unit tests for the calculator functions
```
**Update documentation**
```
-> update the README with installation instructions
+update the README with installation instructions
```
**Code review**
```
-> review my changes and suggest improvements
+review my changes and suggest improvements
```
<Tip>
@@ -262,13 +259,15 @@
| `claude -c` | Continue most recent conversation in current directory | `claude -c` |
| `claude -r` | Resume a previous conversation | `claude -r` |
| `claude commit` | Create a Git commit | `claude commit` |
-| `/clear` | Clear conversation history | `> /clear` |
-| `/help` | Show available commands | `> /help` |
-| `exit` or Ctrl+C | Exit Claude Code | `> exit` |
+| `/clear` | Clear conversation history | `/clear` |
+| `/help` | Show available commands | `/help` |
+| `exit` or Ctrl+C | Exit Claude Code | `exit` |
See the [CLI reference](/en/cli-reference) for a complete list of commands.
## Pro tips for beginners
+
+For more, see [best practices](/en/best-practices) and [common workflows](/en/common-workflows).
<AccordionGroup>
<Accordion title="Be specific with your requests">
@@ -281,15 +280,9 @@
Break complex tasks into steps:
```
- > 1. create a new database table for user profiles
- ```
-
- ```
- > 2. create an API endpoint to get and update user profiles
- ```
-
- ```
- > 3. build a webpage that allows users to see and edit their information
+ 1. create a new database table for user profiles
+ 2. create an API endpoint to get and update user profiles
+ 3. build a webpage that allows users to see and edit their information
```
</Accordion>
@@ -297,11 +290,11 @@
Before making changes, let Claude understand your code:
```
- > analyze the database schema
- ```
-
- ```
- > build a dashboard showing products that are most frequently returned by our UK customers
+ analyze the database schema
+ ```
+
+ ```
+ build a dashboard showing products that are most frequently returned by our UK customers
```
</Accordion>
@@ -317,25 +310,21 @@
Now that you've learned the basics, explore more advanced features:
-<CardGroup cols={3}>
+<CardGroup cols={2}>
+ <Card title="How Claude Code works" icon="microchip" href="/en/how-claude-code-works">
+ Understand the agentic loop, built-in tools, and how Claude Code interacts with your project
+ </Card>
+
+ <Card title="Best practices" icon="star" href="/en/best-practices">
+ Get better results with effective prompting and project setup
+ </Card>
+
<Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">
Step-by-step guides for common tasks
</Card>
- <Card title="CLI reference" icon="terminal" href="/en/cli-reference">
- Master all commands and options
- </Card>
-
- <Card title="Configuration" icon="gear" href="/en/settings">
- Customize Claude Code for your workflow
- </Card>
-
- <Card title="Claude Code on the web" icon="cloud" href="/en/claude-code-on-the-web">
- Run tasks asynchronously in the cloud
- </Card>
-
- <Card title="About Claude Code" icon="sparkles" href="https://claude.com/product/claude-code">
- Learn more on claude.com
+ <Card title="Extend Claude Code" icon="puzzle-piece" href="/en/features-overview">
+ Customize with CLAUDE.md, skills, hooks, MCP, and more
</Card>
</CardGroup>