Skip to content
This repository was archived by the owner on Dec 1, 2025. It is now read-only.

Commit 802ec5c

Browse files
添加claude code, codex, factory cli文档 (#42)
* chore: update .gitignore * docs: 添加新的AI应用文档及多语言翻译 * docs(apps/factory-droid-cli): 添加Factory Droid CLI文档和安装指南图片 * docs(codex-cli): 添加Codex CLI的安装和使用文档及配套图片资源 * docs(claude-code): 添加claude-code文档及安装指南图片资源 * docs(claude-code): update claude-code.md
1 parent aaf031e commit 802ec5c

File tree

86 files changed

+959
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+959
-2
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ wheels/
2727
*.egg
2828

2929
# 忽略 python venv
30-
bin/
31-
pyvenv.cfg
30+
.venv
3231

3332
# 忽略 .DS_Store 文件
3433
.DS_Store

docs/apps/claude-code.md

Lines changed: 380 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,380 @@
1+
# Claude Code
2+
-------------------------------------
3+
4+
<style>
5+
.inline-badge img {
6+
display: inline-block; /* 或者使用 display: inline; */
7+
vertical-align: middle; /* 对齐方式,如果需要的话 */
8+
}
9+
</style>
10+
<div class="inline-badge" style="line-height: 1; display: block;">
11+
<img src="https://img.shields.io/badge/-Windows-0078D6?logo=windows&style=flat&logoColor=white" alt="Windows" style="height: 20px; margin: 0; vertical-align: top;">
12+
<img src="https://img.shields.io/badge/-macOS-black?logo=apple&style=flat&logoColor=white" alt="macOS" style="height: 20px; margin: 0; vertical-align: top;">
13+
<img src="https://img.shields.io/badge/-Linux-FCC624?logo=linux&style=flat&logoColor=black" alt="Linux" style="height: 20px; margin: 0; vertical-align: top;">
14+
</div>
15+
16+
!!! info "项目介绍"
17+
Unleash Claude’s raw power directly in your terminal. Search million-line codebases instantly. Turn hours-long workflows into a single command. Your tools. Your workflow. Your codebase, evolving at thought speed.
18+
19+
直接在你的终端中,释放 Claude 的强大威力。瞬间搜索百万行代码库。将数小时的工作流化为一条命令。你的工具。你的工作流。你的代码库,以思维速度进化。
20+
21+
1. 官方主页:<a href="https://www.anthropic.com/claude-code" target="_blank">https://www.anthropic.com/claude-code</a>
22+
1. 安装方法:见本页下方教程
23+
24+
## 效果演示
25+
-------------------------------------
26+
27+
![introduce-01.webp](../assets/claude_code/introduce-01.webp)
28+
29+
![introduce-02.webp](../assets/claude_code/introduce-02.webp)
30+
31+
### 特性
32+
33+
| **功能分类** | **特性** |
34+
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------|
35+
| **代码理解** | - 深度代码库分析,利用智能代理搜索理解项目结构和依赖 |
36+
| | - 自动生成高层次代码概述,快速帮助用户理解代码库 |
37+
| **代码编辑** | - 支持多文件协同编辑,适用于复杂代码修改 |
38+
| | - 提供符合项目模式和架构的实际可用代码建议 |
39+
| **集成能力** | - 支持在终端中直接运行,无需切换上下文 |
40+
| | - 与VS Code和JetBrains IDE无缝集成,无需复制粘贴 |
41+
| **代码生成和优化** | - 自动生成代码、创建测试、修复错误,支持从概念到提交的完整流程 |
42+
| | - 为代码生成和理解优化,结合Claude Opus 4等先进模型 |
43+
| **安全与灵活性** | - 改动需获得用户明确授权,文件和命令操作更安全 |
44+
| | - 适应用户代码规范,支持自定义配置 |
45+
| **工具链整合** | - 支持与GitHub、GitLab等工具结合,实现自动化工作流程 |
46+
| | - 与测试套件、构建系统集成,增强现有开发工具 |
47+
| **跨平台与扩展** | - 支持Windows、macOS、Linux操作系统 |
48+
| | - 可配置运行在SDK或GitHub Actions中,灵活适配不同需求 |
49+
| **主要应用场景** | - 代码库入门和理解、新成员快速上手 |
50+
| | - 代码问题修复与优化流程,从分析问题到提交PR |
51+
| | - 项目代码重构与新功能实现 |
52+
| **用户反馈亮点** | - 提升日常开发效率,省去例行任务消耗的时间 |
53+
| | - 处理复杂多步骤任务表现优异,扩展开发可能性 |
54+
55+
## AI 模型配置方法
56+
57+
### Windows 端图文指引
58+
59+
#### 1.安装 Node.js 环境
60+
61+
Claude Code 需要 Node.js 环境才能运行。
62+
63+
!!! info "Node.js 环境安装步骤"
64+
- 打开浏览器访问 https://nodejs.org/
65+
- 点击 "LTS" 版本进行下载(推荐长期支持版本)
66+
- 下载完成后双击 .msi 文件
67+
- 按照安装向导完成安装,保持默认设置即可
68+
69+
!!! caution "Windows 注意事项"
70+
- 建议使用 PowerShell 而不是 CMD
71+
- 如果遇到权限问题,尝试以管理员身份运行
72+
- 某些杀毒软件可能会误报,需要添加白名单
73+
74+
![windows-img-01.webp](../assets/claude_code/windows-img-01.webp)
75+
76+
![windows-img-02.webp](../assets/claude_code/windows-img-02.webp)
77+
78+
![windows-img-03.webp](../assets/claude_code/windows-img-03.webp)
79+
80+
![windows-img-04.webp](../assets/claude_code/windows-img-04.webp)
81+
82+
![windows-img-05.webp](../assets/claude_code/windows-img-05.webp)
83+
84+
!!! caution "验证安装是否成功"
85+
安装完成后,打开 PowerShell 或 CMD,输入以下命令:
86+
```
87+
node --version
88+
npm --version
89+
```
90+
如果显示版本号,说明安装成功
91+
92+
#### 2.安装 Git Bash
93+
94+
!!! caution "Windows 注意事项"
95+
Windows 环境下需要使用 Git Bash 安装 Claude code。安装完成后,环境变量设置和使用 Claude Code 仍然在普通的 PowerShell 或 CMD 中进行。
96+
97+
!!! info "下载并安装 Git for Windows"
98+
- 访问 https://git-scm.com/downloads/win
99+
- 点击 "Download for Windows" 下载安装包
100+
- 运行下载的 .exe 安装文件
101+
- 在安装过程中保持默认设置,直接点击 "Next" 完成安装
102+
103+
![windows-img-06.webp](../assets/claude_code/windows-img-06.webp)
104+
105+
![windows-img-07.webp](../assets/claude_code/windows-img-07.webp)
106+
107+
![windows-img-08.webp](../assets/claude_code/windows-img-08.webp)
108+
109+
!!! caution "验证 Git Bash 安装"
110+
安装完成后,打开 Git Bash,输入以下命令验证:
111+
```
112+
git --version
113+
```
114+
如果显示版本号,说明安装成功
115+
116+
#### 3.安装 Claude Code
117+
118+
!!! info "安装 Claude Code"
119+
打开 PowerShell,运行以下命令:
120+
```
121+
npm install -g @anthropic-ai/claude-code
122+
```
123+
这个命令会从 npm 官方仓库下载并安装最新版本的 Claude Code。
124+
125+
![windows-img-09.webp](../assets/claude_code/windows-img-09.webp)
126+
127+
!!! info "将 ~/.local/bin 加入 PATH(仅当提示要求时)"
128+
```
129+
[Environment]::SetEnvironmentVariable('Path', ([Environment]::GetEnvironmentVariable('Path','User') + ";$HOME\.local\bin"), 'User')
130+
```
131+
132+
!!! info "验证 Claude Code 安装"
133+
安装完成后,输入以下命令检查是否安装成功:
134+
```
135+
claude --version
136+
```
137+
如果显示版本号,恭喜你!Claude Code 已经成功安装了。
138+
139+
#### 4.设置环境变量
140+
141+
!!! info "一键设置命令 (Windows 系统)"
142+
为了让 Claude Code 连接到你的中转服务,需要设置多个环境变量:
143+
```
144+
iex (irm 'https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/claude-cli-setup.ps1')
145+
```
146+
147+
![windows-configure](../assets/claude_code/windows_configure.png)
148+
149+
#### 5.开始使用 Claude Code
150+
151+
现在你可以开始使用 Claude Code 了!
152+
153+
!!! info "启动 Claude Code"
154+
打开 PowerShell,直接启动 Claude Code:
155+
```
156+
# 启动 Claude Code
157+
claude
158+
```
159+
在特定项目中使用:
160+
```
161+
# 进入你的项目目录
162+
cd C:\path\to\your\project
163+
```
164+
```
165+
# 启动 Claude Code
166+
claude
167+
```
168+
169+
![windows-img-11.webp](../assets/claude_code/windows-img-11.webp)
170+
171+
![windows-img-12.webp](../assets/claude_code/windows-img-12.webp)
172+
173+
![windows-img-13.webp](../assets/claude_code/windows-img-13.webp)
174+
175+
![windows-img-14.webp](../assets/claude_code/windows-img-14.webp)
176+
177+
![windows-img-15.webp](../assets/claude_code/windows-img-15.webp)
178+
179+
!!! info "选择模型"
180+
输入命令:
181+
```
182+
/model
183+
```
184+
Enter进入,选择模型,通常使用默认设置即可。
185+
186+
![windows-img-16.webp](../assets/claude_code/windows-img-16.webp)
187+
188+
![windows-img-17.webp](../assets/claude_code/windows-img-17.webp)
189+
> 注意:设置环境变量修改后,使用所有模型(包括官方预设模型)均调用自定义接入点,而不使用官方账号额度。
190+
191+
### MacOS 端图文指引
192+
193+
#### 1.安装 Claude Code CLI
194+
195+
打开终端
196+
197+
![macos-img-01.webp](../assets/claude_code/macos-img-01.webp)
198+
199+
!!! info "安装 Claude Code"
200+
打开终端,运行以下命令:
201+
```
202+
curl -fsSL https://claude.ai/install.sh | bash
203+
```
204+
可选项:出现提示后运行提供的命令
205+
```
206+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc
207+
```
208+
209+
![macos-img-02.webp](../assets/claude_code/macos-img-02.webp)
210+
211+
#### 2.设置环境变量
212+
213+
为了让 Claude Code 连接到第三方中转服务,需要设置环境变量:
214+
215+
!!! info "一键设置 Claude Code 环境变量"
216+
输入命令:
217+
```
218+
curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/claude-cli-setup.sh | bash
219+
```
220+
221+
![macos-configure](../assets/claude_code/macos_configure.png)
222+
223+
224+
!!! info "验证 Claude Code 安装"
225+
安装完成后,输入以下命令检查是否安装成功:
226+
```
227+
claude --version
228+
```
229+
如果显示版本号,恭喜你!Claude Code 已经成功安装了。
230+
231+
#### 3.开始使用 Claude Code
232+
233+
现在你可以开始使用 Claude Code 了!
234+
235+
!!! info "启动 Claude Code"
236+
直接启动 Claude Code:
237+
```
238+
# 启动 Claude Code
239+
claude
240+
```
241+
在特定项目中使用:
242+
```
243+
# 进入你的项目目录
244+
cd /path/to/your/project
245+
```
246+
```
247+
# 启动 Claude Code
248+
claude
249+
```
250+
251+
![macos-img-04.webp](../assets/claude_code/macos-img-04.webp)
252+
253+
![macos-img-05.webp](../assets/claude_code/macos-img-05.webp)
254+
255+
![macos-img-06.webp](../assets/claude_code/macos-img-06.webp)
256+
257+
![macos-img-07.webp](../assets/claude_code/macos-img-07.webp)
258+
259+
![macos-img-08.webp](../assets/claude_code/macos-img-08.webp)
260+
261+
!!! info "选择模型 (可选)"
262+
输入命令:
263+
```
264+
/model
265+
```
266+
Enter进入,选择官方模型选择,通常使用默认模型即可
267+
268+
![macos-img-09.webp](../assets/claude_code/macos-img-09.webp)
269+
270+
![macos-img-10.webp](../assets/claude_code/macos-img-10.webp)
271+
272+
![macos-img-11.webp](../assets/claude_code/macos-img-11.webp)
273+
> 注意:设置环境变量修改`ANTHROPIC_BASE_URL`后,使用所有模型(包括官方预设模型)均调用自定义接入点,而不使用官方账号额度。
274+
275+
#### 6.macOS 常见问题解决
276+
277+
??? example "macOS 安全设置阻止运行"
278+
如果系统阻止运行 Claude Code:
279+
280+
- 打开"系统偏好设置" → "安全性与隐私"
281+
- 点击"仍要打开"或"允许"
282+
- 或者在`Terminal`中运行:`sudo spctl --master-disable`
283+
284+
### Linux 端图文指引
285+
286+
#### 1.安装 Claude Code
287+
288+
![linux-img-01.webp](../assets/claude_code/linux-img-01.webp)
289+
290+
!!! info "安装 Claude Code"
291+
打开终端,运行以下命令:
292+
```
293+
curl -fsSL https://claude.ai/install.sh | bash
294+
```
295+
如果遇到权限问题,可以使用 sudo:
296+
```
297+
sudo curl -fsSL https://claude.ai/install.sh | bash
298+
```
299+
![linux-img-03.webp](../assets/claude_code/linux-img-03.webp)
300+
301+
!!! info "验证 Claude Code 安装"
302+
安装完成后,输入以下命令检查是否安装成功:
303+
```
304+
claude --version
305+
```
306+
如果显示版本号,恭喜你!Claude Code 已经成功安装了。
307+
308+
#### 2.设置环境变量
309+
310+
为了让 Claude Code 连接到你的中转服务,需要设置两个环境变量:
311+
312+
!!! info "一键修改环境变量"
313+
输入命令:
314+
```
315+
curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/claude-cli-setup.sh | bash
316+
```
317+
318+
![macos-configure](../assets/claude_code/macos_configure.png)
319+
320+
#### 4.开始使用 Claude Code
321+
322+
现在你可以开始使用 Claude Code 了!
323+
324+
!!! info "启动 Claude Code"
325+
直接启动 Claude Code:
326+
```
327+
# 启动 Claude Code
328+
claude
329+
```
330+
在特定项目中使用:
331+
```
332+
# 进入你的项目目录
333+
cd /path/to/your/project
334+
```
335+
```
336+
# 启动 Claude Code
337+
claude
338+
```
339+
340+
![linux-img-03.webp](../assets/claude_code/linux-img-03.webp)
341+
342+
![linux-img-04.webp](../assets/claude_code/linux-img-04.webp)
343+
344+
![linux-img-05.webp](../assets/claude_code/linux-img-05.webp)
345+
346+
!!! info "选择模型"
347+
输入命令:
348+
```
349+
/model
350+
```
351+
Enter进入,选择官方模型选择,通常使用默认模型即可
352+
353+
![linux-img-06.webp](../assets/claude_code/linux-img-06.webp)
354+
355+
![linux-img-07.webp](../assets/claude_code/linux-img-07.webp)
356+
357+
![linux-img-08.webp](../assets/claude_code/linux-img-08.webp)
358+
359+
![linux-img-09.webp](../assets/claude_code/linux-img-09.webp)
360+
> 注意:设置环境变量修改`ANTHROPIC_BASE_URL`后,使用所有模型(包括官方预设模型)均调用自定义接入点,而不使用官方账号额度。
361+
362+
#### 5.Linux 常见问题解决
363+
364+
??? example "缺少依赖库"
365+
某些 Linux 发行版需要安装额外依赖:
366+
```
367+
# Ubuntu/Debian
368+
sudo apt install build-essential
369+
```
370+
```
371+
# CentOS/RHEL
372+
sudo dnf groupinstall "Development Tools"
373+
```
374+
375+
??? example "环境变量不生效"
376+
检查以下几点:
377+
378+
- 确认修改了正确的配置文件(`.bashrc`或`.zshrc`)
379+
- 重新启动终端或运行`source ~/.bashrc`
380+
- 验证设置:`echo $ANTHROPIC_BASE_URL`

0 commit comments

Comments
 (0)