docs: 更新 API 分组说明、客户端推荐及重启终端提醒
All checks were successful
Deploy to Cloudflare Pages / deploy (push) Successful in 1m4s
All checks were successful
Deploy to Cloudflare Pages / deploy (push) Successful in 1m4s
- 文档新增 ccmax/cc2api 分组说明:cc2api 推荐优先使用(Claude 系列,无客户端限制),ccmax 仅限 Claude Code - 推荐 OpenCode、OpenClaw 作为 cc2api 客户端,GPT 模型推荐 v1/responses 端点 - Cherry Studio 兼容性说明更新:支持所有模型,仅 ccmax 分组 Claude 模型不可用 - 所有脚本重启终端提示改为中文 - 三个工具文档页及快速开始页添加重启终端 warning 框
This commit is contained in:
60
CLAUDE.md
60
CLAUDE.md
@@ -11,13 +11,25 @@ XCodeCLI-Shells 是一个跨平台配置工具集,用于配置 **Claude Code**
|
||||
```
|
||||
xcodecli-shells/
|
||||
├── setup.ps1 # Windows 统一启动器 (安装+配置三个工具)
|
||||
├── setup.sh # Unix 统一启动器
|
||||
├── setup-claude-code.ps1/.sh # Claude Code 配置脚本 (根目录副本)
|
||||
├── ClaudeCode/
|
||||
│ └── setup-claude-code.ps1/.sh
|
||||
├── GeminiCLI/
|
||||
│ └── setup-gemini.ps1/.sh
|
||||
└── codex/
|
||||
└── setup-codex.ps1/.sh
|
||||
├── codex/
|
||||
│ └── setup-codex.ps1/.sh
|
||||
└── docs/ # VitePress 文档站点
|
||||
├── .vitepress/config.ts # VitePress 配置 (导航、侧边栏、主题)
|
||||
├── index.md # 首页 (VitePress home layout, 含 Vue 交互组件)
|
||||
├── cherry-studio-nanobana.md # Cherry Studio 图文配置教程
|
||||
├── assets/ # 文档图片资源 (截图)
|
||||
├── guide/
|
||||
│ ├── index.md # 快速开始总览页
|
||||
│ ├── claude-code.md # Claude Code 单独配置指南
|
||||
│ ├── gemini-cli.md # Gemini CLI 单独配置指南
|
||||
│ └── codex.md # Codex 单独配置指南
|
||||
└── package.json # 文档依赖 (vitepress ^1.5.0)
|
||||
```
|
||||
|
||||
## 三个工具的配置差异
|
||||
@@ -28,13 +40,22 @@ xcodecli-shells/
|
||||
| Gemini CLI | `~/.gemini/.env` | ENV 文件 | `x-goog-api-key` |
|
||||
| Codex | `~/.codex/config.toml` + `auth.json` | TOML + JSON | `Authorization: Bearer` |
|
||||
|
||||
## 工具安装方式差异
|
||||
|
||||
| 工具 | 安装方式 | 依赖 |
|
||||
| ---- | ---- | ---- |
|
||||
| Claude Code | 官方原生脚本 `curl -fsSL https://claude.ai/install.sh \| bash` | 无需 Node.js,自动更新 |
|
||||
| Gemini CLI | `npm install -g @google/gemini-cli@latest` | **需要 Node.js >= 20** |
|
||||
| Codex | `npm install -g @openai/codex` | **需要 Node.js >= 20** |
|
||||
|
||||
## 统一启动器 (setup.ps1 / setup.sh)
|
||||
|
||||
跨平台一站式安装配置工具:
|
||||
|
||||
- 检测 Node.js 环境,缺失时使用 fnm 安装
|
||||
- 检测 Node.js 环境,缺失时使用 fnm 安装 (Gemini CLI / Codex 需要)
|
||||
- 显示三个工具的安装状态
|
||||
- 自动安装缺失的工具 (`npm install -g`)
|
||||
- Claude Code 使用官方原生安装脚本 (`curl -fsSL https://claude.ai/install.sh | bash`)
|
||||
- Gemini CLI / Codex 使用 `npm install -g` 安装 (需要 Node.js >= 20)
|
||||
- 下载并执行对应工具的配置脚本
|
||||
|
||||
```powershell
|
||||
@@ -95,3 +116,34 @@ powershell -ExecutionPolicy Bypass -File setup-claude-code.ps1 -ApiKey test-key
|
||||
|
||||
- Claude/Codex: 检查 `response.data` 或 `response.models` 数组
|
||||
- Gemini: 检查 `response.models` 数组 (Google API 格式)
|
||||
|
||||
## 文档站点 (docs/)
|
||||
|
||||
基于 **VitePress** 的静态文档站点,语言为 `zh-CN`。
|
||||
|
||||
### 开发命令
|
||||
|
||||
```bash
|
||||
# 在 docs/ 目录下执行
|
||||
bun run dev # 本地开发服务器
|
||||
bun run build # 构建静态站点
|
||||
bun run preview # 预览构建结果
|
||||
```
|
||||
|
||||
### 站点结构
|
||||
|
||||
| 页面 | 文件 | 说明 |
|
||||
| ------------- | -------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| 首页 | `docs/index.md` | VitePress home layout,含 Vue `<script setup>` 交互组件 (Tab 切换 + 一键复制) |
|
||||
| 快速开始 | `docs/guide/index.md` | 全自动一键配置说明 + 各工具单独配置入口 |
|
||||
| Claude Code | `docs/guide/claude-code.md` | Claude Code 安装配置指南 |
|
||||
| Gemini CLI | `docs/guide/gemini-cli.md` | Gemini CLI 安装配置指南 |
|
||||
| Codex | `docs/guide/codex.md` | Codex 安装配置指南 |
|
||||
| Cherry Studio | `docs/cherry-studio-nanobana.md` | Cherry Studio 图文教程 (仅支持 Gemini 模型) |
|
||||
|
||||
### 文档开发注意事项
|
||||
|
||||
- 首页 `index.md` 包含 Vue SFC 代码 (`<script setup>` + `<style>`),修改时注意保持 VitePress 兼容性
|
||||
- 图片资源放在 `docs/assets/`,文件名可含中文
|
||||
- 侧边栏和导航配置在 `.vitepress/config.ts` 中维护
|
||||
- Cherry Studio 页面强调 **仅支持 Gemini 模型**,Claude/GPT 系列不支持
|
||||
|
||||
Reference in New Issue
Block a user