mirror of
https://github.com/nicepkg/ai-workflow.git
synced 2026-11-18 18:04:23 +00:00
305 lines
8.3 KiB
Markdown
305 lines
8.3 KiB
Markdown
---
|
||
source: https://code.claude.com/docs/en/quickstart
|
||
title: Quickstart
|
||
---
|
||
|
||
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) 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
|
||
|
||
## [](#step-1:-install-claude-code) Step 1: Install Claude Code
|
||
|
||
To install Claude Code, use one of the following methods:
|
||
|
||
- Native Install (Recommended)
|
||
- Homebrew
|
||
- WinGet
|
||
|
||
**macOS, Linux, WSL:**
|
||
|
||
```bash
|
||
curl -fsSL https://claude.ai/install.sh | bash
|
||
```
|
||
|
||
**Windows PowerShell:**
|
||
|
||
```bash
|
||
irm https://claude.ai/install.ps1 | iex
|
||
```
|
||
|
||
**Windows CMD:**
|
||
|
||
```bash
|
||
curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd
|
||
```
|
||
|
||
Native installations automatically update in the background to keep you on the latest version.
|
||
|
||
```bash
|
||
brew install --cask claude-code
|
||
```
|
||
|
||
Homebrew installations do not auto-update. Run `brew upgrade claude-code` periodically to get the latest features and security fixes.
|
||
|
||
```bash
|
||
winget install Anthropic.ClaudeCode
|
||
```
|
||
|
||
WinGet installations do not auto-update. Run `winget upgrade Anthropic.ClaudeCode` periodically to get the latest features and security fixes.
|
||
|
||
## [](#step-2:-log-in-to-your-account) 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
|
||
claude
|
||
# You'll be prompted to log in on first use
|
||
```
|
||
|
||
```bash
|
||
/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.
|
||
|
||
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.
|
||
|
||
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.
|
||
|
||
## [](#step-3:-start-your-first-session) Step 3: Start your first session
|
||
|
||
Open your terminal in any project directory and start Claude Code:
|
||
|
||
```bash
|
||
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.
|
||
|
||
After logging in (Step 2), your credentials are stored on your system. Learn more in [Credential Management](/docs/en/iam#credential-management).
|
||
|
||
## [](#step-4:-ask-your-first-question) Step 4: Ask your first question
|
||
|
||
Let’s start with understanding your codebase. Try one of these commands:
|
||
|
||
```bash
|
||
> what does this project do?
|
||
```
|
||
|
||
Claude will analyze your files and provide a summary. You can also ask more specific questions:
|
||
|
||
```bash
|
||
> what technologies does this project use?
|
||
```
|
||
|
||
```bash
|
||
> where is the main entry point?
|
||
```
|
||
|
||
```bash
|
||
> explain the folder structure
|
||
```
|
||
|
||
You can also ask Claude about its own capabilities:
|
||
|
||
```bash
|
||
> what can Claude Code do?
|
||
```
|
||
|
||
```bash
|
||
> how do I use slash commands in Claude Code?
|
||
```
|
||
|
||
```bash
|
||
> can Claude Code work with Docker?
|
||
```
|
||
|
||
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.
|
||
|
||
## [](#step-5:-make-your-first-code-change) Step 5: Make your first code change
|
||
|
||
Now let’s make Claude Code do some actual coding. Try a simple task:
|
||
|
||
```bash
|
||
> 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
|
||
|
||
Claude Code always asks for permission before modifying files. You can approve individual changes or enable “Accept all” mode for a session.
|
||
|
||
## [](#step-6:-use-git-with-claude-code) Step 6: Use Git with Claude Code
|
||
|
||
Claude Code makes Git operations conversational:
|
||
|
||
```bash
|
||
> what files have I changed?
|
||
```
|
||
|
||
```bash
|
||
> commit my changes with a descriptive message
|
||
```
|
||
|
||
You can also prompt for more complex Git operations:
|
||
|
||
```bash
|
||
> create a new branch called feature/quickstart
|
||
```
|
||
|
||
```bash
|
||
> show me the last 5 commits
|
||
```
|
||
|
||
```bash
|
||
> help me resolve merge conflicts
|
||
```
|
||
|
||
## [](#step-7:-fix-a-bug-or-add-a-feature) Step 7: Fix a bug or add a feature
|
||
|
||
Claude is proficient at debugging and feature implementation.
|
||
Describe what you want in natural language:
|
||
|
||
```bash
|
||
> add input validation to the user registration form
|
||
```
|
||
|
||
Or fix existing issues:
|
||
|
||
```bash
|
||
> 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) Step 8: Test out other common workflows
|
||
|
||
There are a number of ways to work with Claude:
|
||
**Refactor code**
|
||
|
||
```bash
|
||
> refactor the authentication module to use async/await instead of callbacks
|
||
```
|
||
|
||
**Write tests**
|
||
|
||
```bash
|
||
> write unit tests for the calculator functions
|
||
```
|
||
|
||
**Update documentation**
|
||
|
||
```bash
|
||
> update the README with installation instructions
|
||
```
|
||
|
||
**Code review**
|
||
|
||
```bash
|
||
> review my changes and suggest improvements
|
||
```
|
||
|
||
**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.
|
||
|
||
## [](#essential-commands) 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](/docs/en/cli-reference) for a complete list of commands.
|
||
|
||
## [](#pro-tips-for-beginners) Pro tips for beginners
|
||
|
||
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”
|
||
|
||
Use step-by-step instructions
|
||
|
||
Break complex tasks into steps:
|
||
|
||
```bash
|
||
> 1. create a new database table for user profiles
|
||
```
|
||
|
||
```bash
|
||
> 2. create an API endpoint to get and update user profiles
|
||
```
|
||
|
||
```bash
|
||
> 3. build a webpage that allows users to see and edit their information
|
||
```
|
||
|
||
Let Claude explore first
|
||
|
||
Before making changes, let Claude understand your code:
|
||
|
||
```bash
|
||
> analyze the database schema
|
||
```
|
||
|
||
```bash
|
||
> build a dashboard showing products that are most frequently returned by our UK customers
|
||
```
|
||
|
||
Save time with shortcuts
|
||
|
||
- Press `?` to see all available keyboard shortcuts
|
||
- Use Tab for command completion
|
||
- Press ↑ for command history
|
||
- Type `/` to see all slash commands
|
||
|
||
## [](#what’s-next) What’s next?
|
||
|
||
Now that you’ve learned the basics, explore more advanced features:
|
||
|
||
[## Common workflows
|
||
|
||
Step-by-step guides for common tasks](/docs/en/common-workflows)[## CLI reference
|
||
|
||
Master all commands and options](/docs/en/cli-reference)[## Configuration
|
||
|
||
Customize Claude Code for your workflow](/docs/en/settings)[## Claude Code on the web
|
||
|
||
Run tasks asynchronously in the cloud](/docs/en/claude-code-on-the-web)[## About Claude Code
|
||
|
||
Learn more on claude.com](https://claude.com/product/claude-code)
|
||
|
||
## [](#getting-help) 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 |