2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt2> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
3> Use this file to discover all available pages before exploring further.3> Use this file to discover all available pages before exploring further.
4 4
5# 快速开始5# 快速入门
6 6
7> 欢迎使用 Claude Code!7> 在终端中安装 Claude Code,完成登录,并使用 CLI 探索您的代码库、进行第一次代码更改。
8 8
9本快速开始指南将在几分钟内让您使用 AI 驱动的编码辅助。完成本指南后,您将了解如何使用 Claude Code 完成常见的开发任务。9本快速入门介绍终端中的 Claude Code:安装 CLI、在第一个会话中登录,以及在您自己的项目中使用它完成常见的开发任务。
10 10
11<Note>11<Note>
12 默认配置下,Claude Code 需要能够访问 claude.ai 和 Anthropic API 等端点才能完成安装、登录和正常使用。在中国大陆的网络环境中,这些端点可能无法直接访问。开始前,请先确认所在网络能够连通这些服务。企业代理配置以及 Amazon Bedrock 等第三方提供商的网络要求,请参阅[网络配置](/docs/zh-CN/network-config#network-access-requirements)。12 默认配置下,Claude Code 需要能够访问 claude.ai 和 Anthropic API 等端点才能完成安装、登录和正常使用。在中国大陆的网络环境中,这些端点可能无法直接访问。开始前,请先确认所在网络能够连通这些服务。企业代理配置以及 Amazon Bedrock 等第三方提供商的网络要求,请参阅[网络配置](/docs/zh-CN/network-config#network-access-requirements)。
19确保您拥有:19确保您拥有:
20 20
21* 打开的终端或命令提示符21* 打开的终端或命令提示符
22 * 如果您之前从未使用过终端,请查看[终端指南](/docs/zh-CN/terminal-guide)
23* 一个可以使用的代码项目22* 一个可以使用的代码项目
24* 一个 [Claude 订阅](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=quickstart_prereq)(Pro、Max、Team 或 Enterprise)、[Claude Console](https://platform.claude.com/) 账户,或通过[支持的云提供商](/docs/zh-CN/third-party-integrations)的访问权限23* 一个 [Claude 订阅](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=quickstart_prereq)(Pro、Max、Team 或 Enterprise)、[Claude Console](https://platform.claude.com/) 账户,或通过[支持的云提供商](/docs/zh-CN/third-party-integrations)的访问权限
25 24
26<Note>25<Note>
27 本指南涵盖终端 CLI。Claude Code 也可在[网页](https://claude.ai/code)、[桌面应用](/docs/zh-CN/desktop)、[VS Code](/docs/zh-CN/vs-code) 和 [JetBrains IDE](/docs/zh-CN/jetbrains)、[Slack](/docs/zh-CN/slack) 中使用,以及通过 [GitHub Actions](/docs/zh-CN/github-actions) 和 [GitLab](/docs/zh-CN/gitlab-ci-cd) 进行 CI/CD。查看[所有界面](/docs/zh-CN/overview#use-claude-code-everywhere)。26 以下情况在其他页面中介绍:
27
28 * **从未使用过终端**:请从[终端指南](/docs/zh-CN/terminal-guide)开始
29 * **希望在终端以外的地方使用 Claude Code**:Claude Code 也可在[网页](https://claude.ai/code)、[桌面应用](/docs/zh-CN/desktop)、[VS Code](/docs/zh-CN/vs-code) 和 [JetBrains IDE](/docs/zh-CN/jetbrains)、[Slack](/docs/zh-CN/slack) 中使用,以及通过 [GitHub Actions](/docs/zh-CN/github-actions) 和 [GitLab](/docs/zh-CN/gitlab-ci-cd) 在 CI/CD 中使用。查看[所有界面](/docs/zh-CN/overview#use-claude-code-everywhere)。
28</Note>30</Note>
29 31
30<h2 id="step-1-install-claude-code">32<h2 id="step-1-install-claude-code">
37 <Tab title="原生安装(推荐)">39 <Tab title="原生安装(推荐)">
38 **macOS、Linux、WSL:**40 **macOS、Linux、WSL:**
39 41
40 ```bash theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}42 ```bash theme={null}
41 curl -fsSL https://claude.ai/install.sh | bash43 curl -fsSL https://claude.ai/install.sh | bash
42 ```44 ```
43 45
46 在 Windows 上,当您在 PowerShell 中时,您的提示符显示 `PS C:\`;当您在 CMD 中时,提示符显示 `C:\`(没有 `PS`)。
47
44 **Windows PowerShell:**48 **Windows PowerShell:**
45 49
46 ```powershell theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}50 ```powershell theme={null}
47 irm https://claude.ai/install.ps1 | iex51 irm https://claude.ai/install.ps1 | iex
48 ```52 ```
49 53
50 **Windows CMD:**54 **Windows CMD:**
51 55
52 ```batch theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}56 ```batch theme={null}
53 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd57 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd
54 ```58 ```
55 59
56 安装程序完成后,打开一个新的终端窗口并运行 `claude --version`。正常的安装会打印一个版本号。如果您的 shell 显示找不到 `claude` 或无法识别,说明安装目录还不在您的 PATH 中:请参阅[修复您的 PATH](/docs/zh-CN/troubleshoot-install#command-not-found-claude-after-installation)。60 安装程序完成后,打开一个新的终端窗口并运行 `claude --version`。正常的安装会打印一个版本号。如果您的 shell 显示找不到 `claude` 或无法识别,说明安装目录还不在您的 PATH 中:请参阅[修复您的 PATH](/docs/zh-CN/troubleshoot-install#command-not-found-claude-after-installation)。
57 61
58 如果您看到 `The token '&&' is not a valid statement separator`,说明您在 PowerShell 中,而不是 CMD。如果您看到 `'irm' is not recognized as an internal or external command`,说明您在 CMD 中,而不是 PowerShell。当您在 PowerShell 中时,您的提示符显示 `PS C:\`,当您在 CMD 中时显示 `C:\`(没有 `PS`)。62 如果您看到 `The token '&&' is not a valid statement separator`,说明您在 PowerShell 中,而不是 CMD。如果您看到 `'irm' is not recognized as an internal or external command`,说明您在 CMD 中,而不是 PowerShell。
59 63
60 如果安装命令失败并显示 `syntax error near unexpected token '<'`、`403` 或其他 curl 错误,请参阅 [Troubleshoot installation](/docs/zh-CN/troubleshoot-install#find-your-error) 以匹配错误并获得修复方案和替代安装方法。64 如果安装命令失败并显示 `syntax error near unexpected token '<'`、`403` 或其他任何错误,请参阅[排查安装问题](/docs/zh-CN/troubleshoot-install#find-your-error)以匹配错误并获得修复方案和替代安装方法。
61 65
62 建议在原生 Windows 上安装 [Git for Windows](https://git-scm.com/downloads/win),以便 Claude Code 可以使用 Bash 工具。如果未安装 Git for Windows,Claude Code 将使用 PowerShell 作为 shell 工具。WSL 设置不需要 Git for Windows。66 建议在原生 Windows 上安装 [Git for Windows](https://git-scm.com/downloads/win),以便 Claude Code 可以使用 Bash 工具。如果未安装 Git for Windows,Claude Code 将使用 PowerShell 作为 shell 工具。WSL 设置不需要 Git for Windows。
63 67
67 </Tab>71 </Tab>
68 72
69 <Tab title="Homebrew">73 <Tab title="Homebrew">
70 ```bash theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}74 ```bash theme={null}
71 brew install --cask claude-code75 brew install --cask claude-code
72 ```76 ```
73 77
79 </Tab>83 </Tab>
80 84
81 <Tab title="WinGet">85 <Tab title="WinGet">
82 ```powershell theme={null} theme={null} theme={null} theme={null} theme={null} theme={null}86 ```powershell theme={null}
83 winget install Anthropic.ClaudeCode87 winget install Anthropic.ClaudeCode
84 ```88 ```
85 89
99 103
100该命令会打印一个版本号,后面跟着 `(Claude Code)`。104该命令会打印一个版本号,后面跟着 `(Claude Code)`。
101 105
102<h2 id="step-2-log-in-to-your-account">106<h2 id="step-2-start-your-first-session">
103 步骤 2:登录您的账户107 步骤 2:开始您的第一个会话
104</h2>108</h2>
105 109
106Claude Code 需要账户才能使用。使用 `claude` 命令启动交互式会话,首次使用时系统会提示您登录:110在任意项目目录中打开终端并启动 Claude Code:
107 111
108```bash theme={null}112```bash theme={null}
113cd /path/to/your/project
109claude114claude
110```115```
111 116
112对于 Claude 订阅或 Console 账户,请按照提示在浏览器中完成身份验证。如果您已设置 `ANTHROPIC_API_KEY` 环境变量,Claude Code 会跳过登录提示,改为要求您批准该密钥。要稍后切换账户或重新身份验证,请在运行的会话中输入 `/login`:117将 `/path/to/your/project` 替换为您要处理的项目路径。
113 118
114```text wrap theme={null}119首次使用时,Claude Code 会提示您登录。对于 Claude 订阅或 Console 账户,请按照提示在浏览器中完成身份验证。如果您已设置 `ANTHROPIC_API_KEY` 环境变量,并且在 Claude Code 询问是否使用该密钥时予以批准,Claude Code 将跳过登录提示。
115/login
116```
117 120
118您可以使用以下任何账户类型登录:121您可以使用以下任一账户类型登录:
119 122
120* [Claude Pro、Max、Team 或 Enterprise](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=quickstart_login)(推荐)123* [Claude Pro、Max、Team 或 Enterprise](https://claude.com/pricing?utm_source=claude_code\&utm_medium=docs\&utm_content=quickstart_login)(推荐)
121* [Claude Console](https://platform.claude.com/)(具有预付费额度的 API 访问)。首次登录时,Console 中会自动为集中成本跟踪创建一个"Claude Code"工作区。124* [Claude Console](https://platform.claude.com/)(使用预付额度的 API 访问)。首次登录时,系统会在 Console 中自动创建一个"Claude Code"工作区,用于集中跟踪费用。
122* [Amazon Bedrock、Google Cloud 的 Agent Platform 或 Microsoft Foundry](/docs/zh-CN/third-party-integrations)(企业云提供商)125* [Amazon Bedrock、Google Cloud's Agent Platform 或 Microsoft Foundry](/docs/zh-CN/third-party-integrations)(企业云服务提供商)
123* 自托管的 [Claude apps gateway](/docs/zh-CN/claude-apps-gateway)(如果您的组织运行一个):您的管理员会预先配置网关 URL,`/login` 会直接在 **Cloud gateway** 屏幕上打开,供您使用企业 SSO 登录126* 自托管的 [Claude apps gateway](/docs/zh-CN/claude-apps-gateway)(如果您的组织部署了该网关):管理员会预先配置网关 URL,`/login` 将直接打开 **Cloud gateway** 界面,供您使用企业 SSO 登录
124
125登录后,您的凭证将被存储,您无需再次登录。详细了解 [凭证管理](/docs/zh-CN/authentication#credential-management)。
126
127<h2 id="step-3-start-your-first-session">
128 步骤 3:启动您的第一个会话
129</h2>
130
131在任何项目目录中打开您的终端并启动 Claude Code:
132
133```bash theme={null}
134cd /path/to/your/project
135claude
136```
137 127
138将 `/path/to/your/project` 替换为您要处理的项目的路径。128登录后,您的凭据会被保存,无需再次登录。如需了解更多信息,请参阅[凭据管理](/docs/zh-CN/authentication#credential-management)。
139 129
140您将看到 Claude Code 提示符,其中显示版本、当前模型和上方显示的工作目录。输入 `/help` 查看可用命令,或输入 `/resume` 继续之前的对话。130随后将显示 Claude Code 提示符,其上方会显示版本、当前模型和工作目录。输入 `/help` 查看可用命令,或输入 `/resume` 继续之前的对话。如需稍后切换账户或重新进行身份验证,请在运行中的会话内输入 `/login`。
141 131
142<h2 id="step-4-ask-your-first-question">132<h2 id="step-3-ask-your-first-question">
143 步骤 4:提出您的第一个问题133 步骤 3:提出您的第一个问题
144</h2>134</h2>
145 135
146让我们从理解您的代码库开始。尝试以下命令之一:136尝试以下命令之一:
147 137
148```text wrap theme={null}138```text wrap theme={null}
149what does this project do?139what does this project do?
150```140```
151 141
152Claude 将分析您的文件并提供摘要。您也可以提出更具体的问题:142Claude 将分析您的文件并提供摘要。您还可以提出更具体的问题:
153 143
154```text wrap theme={null}144```text wrap theme={null}
155what technologies does this project use?145what technologies does this project use?
163explain the folder structure153explain the folder structure
164```154```
165 155
166您也可以询问 Claude 关于其自身功能的问题:156您还可以询问 Claude 有关其自身功能的问题:
167 157
168```text wrap theme={null}158```text wrap theme={null}
169what can Claude Code do?159what can Claude Code do?
178```168```
179 169
180<Note>170<Note>
181 Claude Code 根据需要读取您的项目文件。您不必手动添加上下文。171 Claude Code 会根据需要读取您的项目文件。您无需手动添加上下文。
182</Note>172</Note>
183 173
184<h2 id="step-5-make-your-first-code-change">174<h2 id="step-4-make-your-first-code-change">
185 步骤 5:进行您的第一次代码更改175 步骤 4:进行您的第一次代码更改
186</h2>176</h2>
187 177
188现在让我们让 Claude Code 进行一些实际的编码。尝试一个简单的任务:178尝试一个小任务:
189 179
190```text wrap theme={null}180```text wrap theme={null}
191在主文件中添加一个 hello world 函数181add a hello world function to the main file
192```182```
193 183
194Claude Code 找到适当的文件并向您显示更改。如果它在进行更改前询问,请选择**是**以批准。184Claude Code 会找到合适的文件并向您展示更改。如果它在进行更改前征求确认,请选择 **Yes** 以批准。
195 185
196使用 Claude Code v2.1.283 或更高版本,auto 模式是交互式终端会话的[内置起始权限模式](/docs/zh-CN/permission-modes#eliminate-prompts-with-auto-mode):分类器审查操作而不是您,Claude 在不询问的情况下编辑大多数文件并运行大多数命令。在早期版本上,auto 模式仅在 Pro、Max 和 Team 计划上是内置起始权限模式。对于安装后立即启动的会话,请参阅[安装或升级后的首个会话](/docs/zh-CN/env-vars#first-session-after-an-install-or-upgrade)。186会话的[权限模式](/docs/zh-CN/permission-modes)决定了 Claude 可以在不事先询问您的情况下执行哪些操作。随时按 `Shift+Tab` 即可切换当前会话的权限模式。
197
198<Note>
199 您的设置或您的组织可以设置不同的起始权限模式。[会话启动时的权限模式](/docs/zh-CN/permission-modes#which-mode-a-session-starts-in)列出了相关内容。随时按 `Shift+Tab` 切换您所在会话的权限模式。
200</Note>
201 187
202<h2 id="step-6-use-git-with-claude-code">188<h2 id="step-5-use-git-with-claude-code">
203 步骤 6:在 Claude Code 中使用 Git189 步骤 5:在 Claude Code 中使用 Git
204</h2>190</h2>
205 191
206Claude Code 使 Git 操作变得对话式:192Claude Code 让 Git 操作变得像对话一样简单:
207 193
208```text wrap theme={null}194```text wrap theme={null}
209我更改了哪些文件?195what files have I changed?
210```196```
211 197
212```text wrap theme={null}198```text wrap theme={null}
213用描述性消息提交我的更改199commit my changes with a descriptive message
214```200```
215 201
216您也可以提示更复杂的 Git 操作:202您还可以通过提示词执行更复杂的 Git 操作:
217 203
218```text wrap theme={null}204```text wrap theme={null}
219创建一个名为 feature/quickstart 的新分支205create a new branch called feature/quickstart
220```206```
221 207
222```text wrap theme={null}208```text wrap theme={null}
223显示我最后的 5 次提交209show me the last 5 commits
224```210```
225 211
226```text wrap theme={null}212```text wrap theme={null}
227帮我解决合并冲突213help me resolve merge conflicts
228```214```
229 215
230<h2 id="step-7-fix-a-bug-or-add-a-feature">216<h2 id="step-6-fix-a-bug-or-add-a-feature">
231 步骤 7:修复错误或添加功能217 步骤 6:修复 bug 或添加功能
232</h2>218</h2>
233 219
234Claude 擅长调试和功能实现。
235
236用自然语言描述您想要的内容:220用自然语言描述您想要的内容:
237 221
238```text wrap theme={null}222```text wrap theme={null}
239向用户注册表单添加输入验证223add input validation to the user registration form
240```224```
241 225
242或修复现有问题:226或修复现有问题:
243 227
244```text wrap theme={null}228```text wrap theme={null}
245有一个错误,用户可以提交空表单 - 修复它229there's a bug where users can submit empty forms - fix it
246```230```
247 231
248Claude Code 将:232<h2 id="step-7-test-out-other-common-workflows">
249 233 步骤 7:试用其他常见工作流
250* 定位相关代码
251* 理解上下文
252* 实现解决方案
253* 如果可用,运行测试
254
255<h2 id="step-8-test-out-other-common-workflows">
256 步骤 8:尝试其他常见工作流
257</h2>234</h2>
258 235
259有多种方式可以与 Claude 一起工作:236您可以通过多种方式与 Claude 协作:
260 237
261**重构代码**238**重构代码**
262 239
283```260```
284 261
285<Tip>262<Tip>
286 像与有帮助的同事交谈一样与 Claude 交谈。描述您想要实现的目标,它将帮助您实现。263 像与一位乐于助人的同事交流一样与 Claude 对话。描述您想要实现的目标,它会帮助您达成。
287</Tip>264</Tip>
288 265
289<h2 id="essential-commands">266<h2 id="essential-commands">
361 338
362现在您已经学习了基础知识,探索更多高级功能:339现在您已经学习了基础知识,探索更多高级功能:
363 340
364<CardGroup cols={2}>341* [Claude Code 如何工作](/docs/zh-CN/how-claude-code-works):了解智能体循环、内置工具以及 Claude Code 如何与您的项目交互
365 <Card title="Claude Code 如何工作" icon="microchip" href="/docs/zh-CN/how-claude-code-works">342* [最佳实践](/docs/zh-CN/best-practices):通过有效的提示和项目设置获得更好的结果
366 了解代理循环、内置工具以及 Claude Code 如何与您的项目交互343* [常见工作流](/docs/zh-CN/common-workflows):常见任务的分步指南
367 </Card>344* [扩展 Claude Code](/docs/zh-CN/features-overview):使用 CLAUDE.md、skill、hook、MCP 等进行自定义
368
369 <Card title="最佳实践" icon="star" href="/docs/zh-CN/best-practices">
370 通过有效的提示和项目设置获得更好的结果
371 </Card>
372
373 <Card title="常见工作流" icon="graduation-cap" href="/docs/zh-CN/common-workflows">
374 常见任务的分步指南
375 </Card>
376 345
377 <Card title="扩展 Claude Code" icon="puzzle-piece" href="/docs/zh-CN/features-overview">346有关安装选项、手动更新或卸载说明,请参阅[高级设置](/docs/zh-CN/setup)。
378 使用 CLAUDE.md、skills、hooks、MCP 等进行自定义
379 </Card>
380</CardGroup>
381 347
382<h2 id="getting-help">348<h2 id="getting-help">
383 获取帮助349 获取帮助
384</h2>350</h2>
385 351
386* **在 Claude Code 中**:输入 `/help` 或询问"我如何..."352* **在 Claude Code 中**:输入 `/help` 或询问"我如何..."
387* **文档**:您在这里!浏览其他指南353* **文档**:浏览本站的其他指南
388* **课程**:参加 [Claude Code 101](https://academy.claude.com/courses/claude-code-101) 和 [Claude Academy](https://academy.claude.com/) 上的其他免费自学课程354* **课程**:参加 [Claude Code 101](https://academy.claude.com/courses/claude-code-101) 和 [Claude Academy](https://academy.claude.com/) 上的其他免费自学课程
389* **社区**:加入 [Discord 服务器](https://www.anthropic.com/discord) 获取提示和支持355* **社区**:加入 [Discord 服务器](https://www.anthropic.com/discord) 获取提示和支持