欢迎回来

登录 EAKE AI,继续您的智能之旅

忘记密码?
还没有账号?立即注册
使用手册

CodexHub CN 使用说明

CodexHub CN 使用说明

CodexHub CN 是一款面向国内用户的 AI 模型聚合与智能路由平台。它汇集了国内外主流大语言模型,提供统一的 API 接口和友好的图形界面,让开发者无需为每个模型单独注册和对接,一站式完成模型调用与管理。

快速导航

什么是 CodexHub CN

CodexHub CN 定位为「软件厂商 + 模型厂商 + C端用户」的三方桥梁。它解决的核心痛点是:

  • 免登录 —— 不需要为每个 AI 模型注册账户
  • 国内直连 —— 无需科学上网即可访问海外模型
  • 智能路由 —— 根据任务类型自动选择最合适的模型
  • 统一 API —— 使用一套标准格式对接所有模型

快速开始

系统要求

  • 操作系统:Windows 10+ / macOS 13+ / Linux(Ubuntu 20.04+ 推荐)
  • 网络:能够正常访问国内互联网
  • 依赖:Node.js 18+、Python 3.9+(仅 API 中转模块需要)

安装步骤

  1. 下载安装包

    从官网 codexhubcn.com 下载对应操作系统的安装包。

  2. 安装运行

    # 解压后进入目录
    cd codexhub-cn
    
    # 启动服务
    ./codexhub-cn start
    
    # 查看状态
    ./codexhub-cn status
    
  3. 访问界面

    启动后浏览器打开 http://localhost:3000 即可进入 CodexHub CN 主界面。

  4. 配置 API Key

    在设置页面添加你的模型 API Key(如 DeepSeek、智谱、Anthropic 等),或使用内置的临时体验额度。

API 使用指南

CodexHub CN 提供兼容 OpenAI API 格式的接口,让你现有工具和代码可以无缝迁移。

标准 API 端点

# Chat Completions
curl https://api.codexhubcn.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "deepseek-chat",
    "messages": [{"role": "user", "content": "你好"}]
  }'

支持模型列表

模型名称 厂商 特点
deepseek-chat DeepSeek 综合能力强,性价比高
deepseek-reasoner DeepSeek 推理能力强,适合复杂逻辑
glm-4-plus 智谱 AI 中文理解优秀,适合国产化场景
claude-sonnet-4-6 Anthropic 编程和长文本处理

API 格式转换

CodexHub CN 内置请求格式转换引擎,自动将 OpenAI 格式转换为各模型的私有格式:

  • Anthropic 格式:自动将 /v1/chat/completions 转换为 /v1/messages
  • 智谱格式:自动处理 SSE 流式响应差异
  • DeepSeek 格式:原生兼容 OpenAI 格式,无需转换

智能路由

CodexHub CN 的智能路由功能可以根据任务类型自动选择最合适的模型,无需手动指定。

路由策略

任务类型 默认路由模型 说明
聊天对话 deepseek-chat 日常对话、问答
代码生成 claude-sonnet-4-6 编程、代码审查、重构
数学推理 deepseek-reasoner 复杂逻辑推理、数学题
中文创作 glm-4-plus 中文文章、文案、创意

自定义路由规则

你可以在设置中自定义路由规则,例如:

{
  "routing": {
    "default": "deepseek-chat",
    "overrides": [
      {"pattern": "代码审查", "model": "claude-sonnet-4-6"},
      {"pattern": "翻译", "model": "glm-4-plus"}
    ],
    "fallback": "deepseek-chat"
  }
}

个性化设置

API Key 管理

  • 支持多个 API Key 轮询
  • 自动检测失效 Key 并切换
  • 额度监控和预警

界面偏好

  • 主题色:默认蓝色(#1d4ed8),支持自定义
  • 语言:中文(简体)/ English
  • 显示模式:浅色 / 深色 / 跟随系统

代理设置

部分国内网络环境可能需要配置代理访问海外模型:

# 环境变量方式
export HTTP_PROXY=http://127.0.0.1:7890
export HTTPS_PROXY=http://127.0.0.1:7890

# 或在配置文件中设置
./codexhub-cn config set proxy http://127.0.0.1:7890

常见问题

Q: 为什么需要安装本地代理?

本地代理负责 API 格式转换和请求路由,所有请求经本地代理转发出站,数据仅在本地中转,不存储任何会话内容。

Q: CodexHub CN 会保存我的对话吗?

不会。CodexHub CN 仅做请求转发,不存储用户的对话记录。所有对话数据直接传递给目标模型 API 服务。

Q: 支持哪些国产模型?

目前已支持 DeepSeek、智谱 AI、通义千问(即将上线)、文心一言(即将上线)。

Q: 遇到连接问题时怎么办?

首先检查本地代理是否正常运行,然后检查 API Key 是否有效。如果问题持续,可以查看运行日志:./codexhub-cn logs

Q: 如何获取帮助?

可以访问我们的 帮助中心,或发送邮件至 support@codexhubcn.com。


文档版本:v1.0 | 最后更新:2026-07-18

使用手册

Claude Code 完整开发指南

Claude Code — 完整开发指南

通过 Hermes 终端将编码任务委托给 Claude Code(Anthropic 的自主编码 Agent CLI)。Claude Code v2.x 可以自主读取文件、编写代码、运行 Shell 命令、生成子 Agent 以及管理 Git 工作流程。

前置条件

  • 安装:npm install -g @anthropic-ai/claude-code
  • 认证:运行 claude 进行一次登录(Pro/Max 用户使用浏览器 OAuth,或设置 ANTHROPIC_API_KEY
  • 控制台认证:claude auth login --console(API Key 计费模式)
  • SSO 认证:claude auth login --sso(企业版)
  • 查看状态:claude auth status(JSON 格式)或 claude auth status --text(人类可读)
  • 健康检查:claude doctor — 检查自动更新器和安装健康状态
  • 版本检查:claude --version(需要 v2.x+)
  • 更新:claude updateclaude upgrade

两种编排模式

Hermes 与 Claude Code 有两种完全不同的交互方式。根据任务选择。

模式1:Print 模式(-p)— 非交互式(推荐用于大多数任务

Print 模式运行一次性任务,返回结果后退出。不需要 PTY,没有交互式提示。这是最干净的集成路径。

terminal(command="claude -p '为 src/ 中的所有 API 调用添加错误处理' --allowedTools 'Read,Edit' --max-turns 10", workdir="/path/to/project", timeout=120)

何时使用 Print 模式:

  • 一次性编码任务(修复 Bug、添加功能、重构)
  • CI/CD 自动化和脚本编写
  • 使用 --json-schema 进行结构化数据提取
  • 管道输入处理(cat file | claude -p "分析这个文件"
  • 任何不需要多轮对话的任务

Print 模式跳过所有交互式对话框 — 没有工作区信任提示,没有权限确认。这使得它非常适合自动化。

模式2:通过 tmux 的交互式 PTY — 多轮会话

交互式模式提供一个完整的对话式 REPL,你可以发送后续提示、使用斜杠命令,并实时观察 Claude 工作。需要 tmux 编排。

# 启动一个 tmux 会话
terminal(command="tmux new-session -d -s claude-work -x 140 -y 40")

# 在内部启动 Claude Code
terminal(command="tmux send-keys -t claude-work 'cd /path/to/project && claude' Enter")

# 等待启动,然后发送任务
# (大约等待 3-5 秒欢迎界面)
terminal(command="sleep 5 && tmux send-keys -t claude-work '将认证模块重构为使用 JWT 令牌' Enter")

# 通过捕获面板监控进度
terminal(command="sleep 15 && tmux capture-pane -t claude-work -p -S -50")

# 发送后续任务
terminal(command="tmux send-keys -t claude-work '现在为新的 JWT 代码添加单元测试' Enter")

# 完成后退出
terminal(command="tmux send-keys -t claude-work '/exit' Enter")

何时使用交互式模式:

  • 多轮迭代工作(重构 → 审查 → 修复 → 测试周期)
  • 需要人机协同决策的任务
  • 探索性编码会话
  • 需要使用 Claude 的斜杠命令时(/compact/review/model

PTY 对话框处理(交互式模式关键)

Claude Code 在首次启动时会出现最多两个确认对话框。你必须通过 tmux send-keys 处理它们:

对话框1:工作区信任(首次访问目录)

❯ 1. 是的,我信任这个文件夹    ← 默认选项(直接按 Enter)
  2. 不,退出

处理:tmux send-keys -t <session> Enter — 默认选择正确。

对话框2:绕过权限警告(仅在启用 --dangerously-skip-permissions 时出现)

❯ 1. 不,退出              ← 默认(错误选项!)
  2. 是的,我接受

处理:必须先向下导航,再按 Enter:

tmux send-keys -t <session> Down && sleep 0.3 && tmux send-keys -t <session> Enter

稳健的对话框处理模式

# 使用权限绕过启动
terminal(command="tmux send-keys -t claude-work 'claude --dangerously-skip-permissions "你的任务"' Enter")

# 处理信任对话框(Enter 选择默认的"是")
terminal(command="sleep 4 && tmux send-keys -t claude-work Enter")

# 处理权限对话框(先向下再 Enter 选择"是的,我接受")
terminal(command="sleep 3 && tmux send-keys -t claude-work Down && sleep 0.3 && tmux send-keys -t claude-work Enter")

# 现在等待 Claude 工作
terminal(command="sleep 15 && tmux capture-pane -t claude-work -p -S -60")

注意:在首次接受某个目录的信任后,信任对话框不会再次出现。只有权限对话框会在每次使用 --dangerously-skip-permissions 时重复出现。

CLI 子命令

子命令 用途
claude 启动交互式 REPL
claude "查询内容" 带初始提示启动 REPL
claude -p "查询内容" Print 模式(非交互式,完成后退出)
cat file | claude -p "查询内容" 通过管道传递内容作为 stdin 上下文
claude -c 继续此目录中最近的对话
claude -r "id" 按 ID 或名称恢复特定会话
claude auth login 登录(加 --console 用于 API 计费,--sso 用于企业版)
claude auth status 检查登录状态(返回 JSON;加 --text 为人类可读格式)
claude mcp add <名称> -- <命令> 添加 MCP 服务器
claude mcp list 列出已配置的 MCP 服务器
claude mcp remove <名称> 移除 MCP 服务器
claude agents 列出已配置的 Agent
claude doctor 对安装和自动更新器运行健康检查
claude update / claude upgrade 将 Claude Code 更新到最新版本
claude remote-control 启动服务器,从 claude.ai 或移动应用控制 Claude
claude install [目标] 安装原生构建(稳定版、最新版或特定版本)
claude setup-token 设置长期有效的认证令牌(需要订阅)
claude plugin / claude plugins 管理 Claude Code 插件
claude auto-mode 检查自动模式分类器配置

Print 模式深入

结构化 JSON 输出

terminal(command="claude -p '分析 auth.py 的安全问题' --output-format json --max-turns 5", workdir="/project", timeout=120)

返回包含以下字段的 JSON 对象:

{
  "type": "result",
  "subtype": "success",
  "result": "分析文本...",
  "session_id": "75e2167f-...",
  "num_turns": 3,
  "total_cost_usd": 0.0787,
  "duration_ms": 10276,
  "stop_reason": "end_turn",
  "terminal_reason": "completed",
  "usage": { "input_tokens": 5, "output_tokens": 603, ... },
  "modelUsage": { "claude-sonnet-4-6": { "costUSD": 0.078, "contextWindow": 200000 } }
}

关键字段:session_id 用于恢复会话,num_turns 表示 Agent 循环次数,total_cost_usd 用于支出跟踪,subtype 用于成功/错误检测(successerror_max_turnserror_budget)。

流式 JSON 输出

如需实时 Token 流,使用带 --verbosestream-json

terminal(command="claude -p '写一段摘要' --output-format stream-json --verbose --include-partial-messages", timeout=60)

返回按换行符分隔的 JSON 事件。使用 jq 过滤实时文本:

claude -p "解释 X 的概念" --output-format stream-json --verbose --include-partial-messages | 
  jq -rj 'select(.type == "stream_event" and .event.delta.type? == "text_delta") | .event.delta.text'

流事件包括 system/api_retry,包含 attemptmax_retrieserror 字段(例如 rate_limitbilling_error)。

双向流式传输

如需实时输入和输出流式传输:

claude -p "任务描述" --input-format stream-json --output-format stream-json --replay-user-messages

--replay-user-messages 在 stdout 上重新输出用户消息,用于确认。

管道输入

# 通过管道传输文件进行分析
terminal(command="cat src/auth.py | claude -p '审查此代码中的 Bug' --max-turns 1", timeout=60)

# 通过管道传输多个文件
terminal(command="cat src/*.py | claude -p '查找所有 TODO 注释' --max-turns 1", timeout=60)

# 通过管道传输命令输出
terminal(command="git diff HEAD~3 | claude -p '总结这些变更' --max-turns 1", timeout=60)

用于结构化提取的 JSON Schema

terminal(command="claude -p '列出 src/ 中的所有函数' --output-format json --json-schema '{"type":"object","properties":{"functions":{"type":"array","items":{"type":"string"}}},"required":["functions"]}' --max-turns 5", workdir="/project", timeout=90)

从 JSON 结果中解析 structured_output 字段。Claude 在返回前会根据 Schema 验证输出。

会话延续

# 开始一个任务
terminal(command="claude -p '开始重构数据库层' --output-format json --max-turns 10 > /tmp/session.json", workdir="/project", timeout=180)

# 使用会话 ID 恢复
terminal(command="claude -p '继续并添加连接池' --resume $(cat /tmp/session.json | python3 -c 'import json,sys; print(json.load(sys.stdin)["session_id"])') --max-turns 5", workdir="/project", timeout=120)

# 或恢复同一目录中最近的会话
terminal(command="claude -p '上次做了什么?' --continue --max-turns 1", workdir="/project", timeout=30)

# Fork 会话(新建 ID,保留历史)
terminal(command="claude -p '尝试不同的方法' --resume <id> --fork-session --max-turns 10", workdir="/project", timeout=120)

CI/脚本的 Bare 模式

terminal(command="claude --bare -p '运行所有测试并报告失败项' --allowedTools 'Read,Bash' --max-turns 10", workdir="/project", timeout=180)

--bare 跳过钩子、插件、MCP 发现和 CLAUDE.md 加载。启动最快。需要 ANTHROPIC_API_KEY(跳过 OAuth)。

在 bare 模式下选择性加载上下文:

要加载的内容 标志
系统提示补充 --append-system-prompt "文本"--append-system-prompt-file 路径
设置 --settings <文件或JSON>
MCP 服务器 --mcp-config <文件或JSON>
自定义 Agent --agents '<json>'

过载时的备用模型

terminal(command="claude -p '任务描述' --fallback-model haiku --max-turns 5", timeout=90)

当默认模型过载时,自动回退到指定的备用模型(仅限 print 模式)。

完整 CLI 标志参考

会话与环境

标志 效果
-p, --print 非交互式一次性模式(完成后退出)
-c, --continue 恢复当前目录中最近的对话
-r, --resume <id> 按 ID 或名称恢复特定会话(无 ID 时显示交互式选择器)
--fork-session 恢复时创建新会话 ID,而非复用原 ID
--session-id <uuid> 使用特定的 UUID 作为会话标识
--no-session-persistence 不将会话保存到磁盘(仅限 print 模式)
--add-dir <路径...> 授予 Claude 访问额外工作目录的权限
-w, --worktree [名称] .claude/worktrees/<名称> 的隔离 git worktree 中运行
--tmux 为 worktree 创建 tmux 会话(需要 --worktree
--ide 启动时自动连接到有效的 IDE
--chrome / --no-chrome 启用/禁用 Chrome 浏览器集成(用于 Web 测试)
--from-pr [编号] 恢复与特定 GitHub PR 关联的会话
--file <规格...> 启动时下载的文件资源(格式:file_id:相对路径

模型与性能

标志 效果
--model <别名> 模型选择:sonnetopushaiku 或全名如 claude-sonnet-4-6
--effort <级别> 推理深度:lowmediumhighmaxauto
--max-turns <n> 限制 Agent 循环次数(仅限 print 模式;防止失控)
--max-budget-usd <n> API 支出上限(美元),仅限 print 模式
--fallback-model <模型> 默认模型过载时自动回退(仅限 print 模式)
--betas <功能...> 包含在 API 请求中的 Beta 标头(仅限 API Key 用户)

权限与安全

标志 效果
--dangerously-skip-permissions 自动批准所有工具使用(写文件、bash、网络等)
--allow-dangerously-skip-permissions 启用绕过选项但默认不启用
--permission-mode <模式> defaultacceptEditsplanautodontAskbypassPermissions
--allowedTools <工具...> 白名单特定工具(逗号或空格分隔)
--disallowedTools <工具...> 黑名单特定工具
--tools <工具...> 覆盖内置工具集(""=无,"default"=全部,或工具名称)

输出与输入格式

标志 效果
--output-format <格式> text(默认)、json(单个结果对象)、stream-json(换行分隔)
--input-format <格式> text(默认)或 stream-json(实时流式输入)
--json-schema <schema> 强制使用匹配 Schema 的结构化 JSON 输出
--verbose 完整的逐轮输出
--include-partial-messages 包含到达的部分消息块(stream-json + print)
--replay-user-messages 在 stdout 上重新输出用户消息(stream-json 双向传输)

系统提示与上下文

标志 效果
--append-system-prompt <文本> 添加到默认系统提示(保留内置能力)
--append-system-prompt-file <路径> 添加文件内容到默认系统提示
--system-prompt <文本> 替换整个系统提示(通常建议使用 --append)
--system-prompt-file <路径> 替换系统提示为文件内容
--bare 跳过钩子、插件、MCP 发现、CLAUDE.md、OAuth(最快启动)
--agents '<json>' 以 JSON 格式动态定义自定义子 Agent
--mcp-config <路径> 从 JSON 文件加载 MCP 服务器(可重复)
--strict-mcp-config 仅使用 --mcp-config 中的 MCP 服务器,忽略其他所有 MCP 配置
--settings <文件或JSON> 从 JSON 文件或内联 JSON 加载额外设置
--setting-sources <源> 逗号分隔的加载源:userprojectlocal
--plugin-dir <路径...> 仅为此会话从指定目录加载插件
--disable-slash-commands 禁用所有技能/斜杠命令

调试

标志 效果
-d, --debug [过滤器] 启用调试日志(可选的类别过滤器,如 "api,hooks""!1p,!file"
--debug-file <路径> 将调试日志写入文件(隐式启用调试模式)

Agent 团队

标志 效果
--teammate-mode <模式> Agent 团队的显示方式:autoin-processtmux
--brief 启用 SendUserMessage 工具,实现 Agent 到用户的消息通信

--allowedTools / --disallowedTools 的工具名称语法

Read                    # 所有文件读取
Edit                    # 文件编辑(已有文件)
Write                   # 文件创建(新文件)
Bash                    # 所有 Shell 命令
Bash(git *)             # 仅 Git 命令
Bash(git commit *)      # 仅 Git commit 命令
Bash(npm run lint:*)    # 通配符模式匹配
WebSearch               # 网页搜索能力
WebFetch                # 网页抓取
mcp__<服务器>__<工具>     # 特定的 MCP 工具

设置与配置

设置优先级(从高到低)

  1. CLI 标志 — 覆盖一切
  2. 本地项目:.claude/settings.local.json(个人,被 gitignore)
  3. 项目:.claude/settings.json(团队共享,被 Git 跟踪)
  4. 用户:~/.claude/settings.json(全局)

设置中的权限配置

{
  "permissions": {
    "allow": ["Bash(npm run lint:*)", "WebSearch", "Read"],
    "ask": ["Write(*.ts)", "Bash(git push*)"],
    "deny": ["Read(.env)", "Bash(rm -rf *)"]
  }
}

记忆文件(CLAUDE.md)层级

  1. 全局:~/.claude/CLAUDE.md — 适用于所有项目
  2. 项目:./CLAUDE.md — 项目特定上下文(被 Git 跟踪)
  3. 本地:.claude/CLAUDE.local.md — 个人项目覆盖(被 gitignore)

在交互模式中使用 # 前缀快速添加到记忆:# 始终使用 2 空格缩进

交互式会话:斜杠命令

会话与上下文

命令 用途
/help 显示所有命令(包括自定义和 MCP 命令)
/compact [焦点] 压缩上下文以节省 Token;CLAUDE.md 不受压缩影响。例如:/compact focus on auth logic
/clear 清空对话历史,重新开始
/context 可视化上下文使用情况(彩色网格+优化提示)
/cost 查看 Token 使用情况(按模型和缓存命中细分)
/resume 切换或恢复不同的会话
/rewind 回退到对话或代码中的先前检查点
/btw <问题> 在不增加上下文成本的情况下提问
/status 显示版本、连接状态和会话信息
/todos 列出对话中跟踪的待办事项
/exitCtrl+D 结束会话

开发与审查

命令 用途
/review 请求对当前变更进行代码审查
/security-review 对当前变更执行安全分析
/plan [描述] 进入计划模式(自动启动任务规划)
/loop [间隔] 在会话内安排周期性任务
/batch 为大型并行变更自动创建工作区(5-30 个工作区)

配置与工具

命令 用途
/model [模型] 会话中切换模型(使用方向键调整 effort)
/effort [级别] 设置推理努力程度:lowmediumhighmaxauto
/init 创建 CLAUDE.md 文件作为项目记忆
/memory 打开 CLAUDE.md 进行编辑
/config 打开交互式设置配置
/permissions 查看/更新工具权限
/agents 管理专门的子 Agent
/mcp 管理 MCP 服务器的交互式 UI
/add-dir 添加额外的工作目录(对单体仓库很有用)
/usage 显示计划限制和速率限制状态
/voice 启用按键通话语音模式(20 种语言;按住 Space 录制,松开发送)
/release-notes 版本发布说明的交互式选择器

自定义斜杠命令

创建 .claude/commands/<名称>.md(项目共享)或 ~/.claude/commands/<名称>.md(个人):

# .claude/commands/deploy.md
运行部署流程:
1. 运行所有测试
2. 构建 Docker 镜像
3. 推送到镜像仓库
4. 更新 $ARGUMENTS 环境(默认:staging)

使用方式:/deploy production$ARGUMENTS 会被替换为用户输入的内容。

技能(自然语言调用)

与需要手动调用的斜杠命令不同,.claude/skills/ 中的技能是 Markdown 指南,当任务匹配时 Claude 通过自然语言自动调用:

# .claude/skills/database-migration.md
当被问到创建或修改数据库迁移时:
1. 使用 Alembic 生成迁移
2. 始终创建回滚函数
3. 在本地数据库副本上测试迁移

交互式会话:键盘快捷键

通用控制

按键 操作
Ctrl+C 取消当前输入或生成
Ctrl+D 退出会话
Ctrl+R 反向搜索命令历史
Ctrl+B 将正在运行的任务放入后台
Ctrl+V 粘贴图片到对话
Ctrl+O Transcript 模式 — 查看 Claude 的思考过程
Ctrl+GCtrl+X Ctrl+E 在外部编辑器中打开提示
Esc Esc 回退对话或代码状态 / 总结

模式切换

按键 操作
Shift+Tab 循环切换权限模式(Normal → Auto-Accept → Plan)
Alt+P 切换模型
Alt+T 切换思考模式
Alt+O 切换快速模式

多行输入

按键 操作
+ Enter 快速换行
Shift+Enter 换行(替代方式)
Ctrl+J 换行(替代方式)

输入前缀

前缀 操作
! 直接执行 bash,绕过 AI(例如 !npm test)。单独使用 ! 切换 Shell 模式。
@ 引用文件/目录(带自动补全),例如 @./src/api/
# 快速添加到 CLAUDE.md 记忆(例如 # 使用 2 空格缩进
/ 斜杠命令

专业技巧:「ultrathink」

在提示中使用「ultrathink」关键词以在特定轮次中获得最大推理努力。这会触发最深层的思考模式,无论当前的 /effort 设置如何。

PR 审查模式

快速审查(Print 模式)

terminal(command="cd /path/to/repo && git diff main...feature-branch | claude -p '审查此差异中的 Bug、安全问题和风格问题。请做到全面。' --max-turns 1", timeout=60)

深度审查(交互式 + Worktree)

terminal(command="tmux new-session -d -s review -x 140 -y 40")
terminal(command="tmux send-keys -t review 'cd /path/to/repo && claude -w pr-review' Enter")
terminal(command="sleep 5 && tmux send-keys -t review Enter")  # 信任对话框
terminal(command="sleep 2 && tmux send-keys -t review '审查与 main 分支的所有差异。检查 Bug、安全问题、竞态条件和缺失的测试。' Enter")
terminal(command="sleep 30 && tmux capture-pane -t review -p -S -60")

按编号进行 PR 审查

terminal(command="claude -p '全面审查此 PR' --from-pr 42 --max-turns 10", workdir="/path/to/repo", timeout=120)

带 tmux 的 Claude Worktree

terminal(command="claude -w feature-x --tmux", workdir="/path/to/repo")

.claude/worktrees/feature-x 创建隔离的 Git Worktree,同时创建一个 tmux 会话。在可用时使用 iTerm2 原生面板,添加 --tmux=classic 使用传统 tmux。

并行运行多个 Claude 实例

同时运行多个独立的 Claude 任务:

# 任务1:修复后端
terminal(command="tmux new-session -d -s task1 -x 140 -y 40 && tmux send-keys -t task1 'cd ~/project && claude -p "修复 src/auth.py 中的认证 Bug" --allowedTools "Read,Edit" --max-turns 10' Enter")

# 任务2:编写测试
terminal(command="tmux new-session -d -s task2 -x 140 -y 40 && tmux send-keys -t task2 'cd ~/project && claude -p "为 API 端点编写集成测试" --allowedTools "Read,Write,Bash" --max-turns 15' Enter")

# 任务3:更新文档
terminal(command="tmux new-session -d -s task3 -x 140 -y 40 && tmux send-keys -t task3 'cd ~/project && claude -p "使用新的 API 端点更新 README.md" --allowedTools "Read,Edit" --max-turns 5' Enter")

# 监控所有任务
terminal(command="sleep 30 && for s in task1 task2 task3; do echo '=== '$s' ==='; tmux capture-pane -t $s -p -S -5 2>/dev/null; done")

CLAUDE.md — 项目上下文文件

Claude Code 自动从项目根目录加载 CLAUDE.md。用它来持久化项目上下文:

# 项目:我的 API

## 架构
- FastAPI 后端,SQLAlchemy ORM
- PostgreSQL 数据库,Redis 缓存
- pytest 测试,覆盖率目标 90%

## 关键命令
- `make test` — 运行完整测试套件
- `make lint` — ruff + mypy
- `make dev` — 在 :8000 启动开发服务器

## 代码规范
- 所有公共函数使用类型提示
- 使用 Google 风格的文档字符串
- YAML 使用 2 空格缩进,Python 使用 4 空格
- 禁止通配符导入

要具体。不要写「写出好代码」,而是用「JS 使用 2 空格缩进」或「测试文件使用 .test.ts 后缀」。具体的指令能节省纠正周期。

规则目录(模块化 CLAUDE.md)

对于有很多规则的项目,使用规则目录代替一个庞大的 CLAUDE.md:

  • 项目规则:.claude/rules/*.md — 团队共享,被 Git 跟踪
  • 用户规则:~/.claude/rules/*.md — 个人,全局

规则目录中的每个 .md 文件都会作为额外上下文加载。这比把所有内容塞进一个 CLAUDE.md 更清晰。

自动记忆

Claude 自动学习项目上下文并存储在 ~/.claude/projects/<项目>/memory/ 中。

  • 限制:每个项目 25KB 或 200 行
  • 这与 CLAUDE.md 分开 — 是 Claude 自己对项目的笔记,跨会话累积

自定义子 Agent

.claude/agents/(项目)、~/.claude/agents/(个人)或通过 --agents CLI 标志(会话)定义专门的 Agent:

Agent 位置优先级

  1. .claude/agents/ — 项目级别,团队共享
  2. --agents CLI 标志 — 会话特定,动态
  3. ~/.claude/agents/ — 用户级别,个人

创建 Agent

# .claude/agents/security-reviewer.md
---
name: security-reviewer
description: 安全专注的代码审查
model: opus
tools: [Read, Bash]
---
你是一名资深安全工程师。审查代码时关注:
- 注入漏洞(SQL、XSS、命令注入)
- 认证/授权缺陷
- 代码中的密钥
- 不安全的反序列化

通过以下方式调用:@security-reviewer review the auth module

通过 CLI 动态定义 Agent

terminal(command="claude --agents '{"reviewer": {"description": "审查代码", "prompt": "你是一个专注于性能的代码审查者"}}' -p '使用 @reviewer 来检查 auth.py'", timeout=120)

Claude 可以编排多个 Agent:「使用 @db-expert 优化查询,然后使用 @security 审计变更。」

钩子 — 事件自动化

.claude/settings.json(项目)或 ~/.claude/settings.json(全局)中配置:

{
  "hooks": {
    "PostToolUse": [{
      "matcher": "Write(*.py)",
      "hooks": [{"type": "command", "command": "ruff check --fix $CLAUDE_FILE_PATHS"}]
    }],
    "PreToolUse": [{
      "matcher": "Bash",
      "hooks": [{"type": "command", "command": "if echo "$CLAUDE_TOOL_INPUT" | grep -q 'rm -rf'; then echo '已拦截!' && exit 2; fi"}]
    }],
    "Stop": [{
      "hooks": [{"type": "command", "command": "echo 'Claude 完成了一条响应' >> /tmp/claude-activity.log"}]
    }]
  }
}

全部 8 种钩子类型

钩子 触发时机 常见用途
UserPromptSubmit Claude 处理用户提示之前 输入验证、日志记录
PreToolUse 工具执行之前 安全门、阻止危险命令(exit 2 = 阻止)
PostToolUse 工具执行完成后 自动格式化代码、运行 linter
Notification 权限请求或等待输入时 桌面通知、告警
Stop Claude 完成一条响应时 完成日志、状态更新
SubagentStop 子 Agent 完成时 Agent 编排
PreCompact 上下文记忆被清除之前 备份会话记录
SessionStart 会话开始时 加载开发上下文(例如 git status

钩子环境变量

变量 内容
CLAUDE_PROJECT_DIR 当前项目路径
CLAUDE_FILE_PATHS 正在修改的文件
CLAUDE_TOOL_INPUT JSON 格式的工具参数

安全钩子示例

{
  "PreToolUse": [{
    "matcher": "Bash",
    "hooks": [{"type": "command", "command": "if echo "$CLAUDE_TOOL_INPUT" | grep -qE 'rm -rf|git push.*--force|:(){ :|:& };:'; then echo '危险命令已拦截!' && exit 2; fi"}]
  }]
}

MCP 集成

为数据库、API 和服务添加外部工具服务器:

# GitHub 集成
terminal(command="claude mcp add -s user github -- npx @modelcontextprotocol/server-github", timeout=30)

# PostgreSQL 查询
terminal(command="claude mcp add -s local postgres -- npx @anthropic-ai/server-postgres --connection-string postgresql://localhost/mydb", timeout=30)

# Puppeteer Web 测试
terminal(command="claude mcp add puppeteer -- npx @anthropic-ai/server-puppeteer", timeout=30)

MCP 作用域

标志 作用域 存储位置
-s user 全局(所有项目) ~/.claude.json
-s local 本项目(个人) .claude/settings.local.json(被 gitignore)
-s project 本项目(团队共享) .claude/settings.json(被 Git 跟踪)

Print/CI 模式中的 MCP

terminal(command="claude --bare -p '查询数据库' --mcp-config mcp-servers.json --strict-mcp-config", timeout=60)

--strict-mcp-config 忽略除 --mcp-config 之外的所有 MCP 服务器。

在对话中引用 MCP 资源:@github:issue://123

MCP 限制与调优

  • 工具描述:每个服务器 2KB 上限(工具描述和服务器指令)
  • 结果大小:默认有上限;使用 maxResultSizeChars 注释允许最多 500K 字符用于大输出
  • 输出 Token:export MAX_MCP_OUTPUT_TOKENS=50000 — 限制 MCP 服务器输出,防止上下文溢出
  • 传输协议:stdio(本地进程)、http(远程)、sse(服务器推送事件)

监控交互式会话

读取 TUI 状态

# 定期捕获以检查 Claude 是在工作还是在等待输入
terminal(command="tmux capture-pane -t dev -p -S -10")

关注这些指示器:

  • 在底部 = 等待你的输入(Claude 已完成或正在提问)
  • 行 = Claude 正在主动使用工具(读取、写入、运行命令)
  • ⏵⏵ bypass permissions on = 状态栏显示权限模式
  • ◐ medium · /effort = 状态栏中的当前努力级别
  • ctrl+o to expand = 工具输出被截断(可在交互模式下展开)

上下文窗口健康

在交互模式中使用 /context 查看上下文使用情况的彩色网格。关键阈值:

  • < 70% — 正常运行,全精度
  • 70-85% — 精度开始下降,考虑 /compact
  • > 85% — 幻觉风险显著增加,使用 /compact/clear

环境变量

变量 效果
ANTHROPIC_API_KEY 用于认证的 API Key(OAuth 的替代方案)
CLAUDE_CODE_EFFORT_LEVEL 默认 effort:lowmediumhighmaxauto
MAX_THINKING_TOKENS 限制思考 Token(设为 0 完全禁用思考)
MAX_MCP_OUTPUT_TOKENS 限制 MCP 服务器的输出(默认值不定;设如 50000
CLAUDE_CODE_NO_FLICKER=1 启用 alt-screen 渲染以消除终端闪烁
CLAUDE_CODE_SUBPROCESS_ENV_SCRUB 从子进程中清理凭证,提高安全性

成本与性能技巧

  1. 使用 --max-turns 在 print 模式中防止失控循环。大多数任务从 5-10 开始。
  2. 使用 --max-budget-usd 设置成本上限。注意:系统提示缓存创建最低约 $0.05。
  3. 使用 --effort low 处理简单任务(更快、更便宜)。highmax 用于复杂推理。
  4. CI/脚本使用 --bare 跳过插件/钩子发现的开销。
  5. 使用 --allowedTools 限制到仅需要的工具(例如审查时仅 Read)。
  6. 交互式会话中在上下文变大时使用 /compact
  7. 管道输入代替让 Claude 读取文件,当你只需要分析已知内容时。
  8. 使用 --model haiku 处理简单任务(更便宜),--model opus 用于复杂的多步骤工作。
  9. print 模式中使用 --fallback-model haiku 优雅处理模型过载。
  10. 不同任务开启新会话 — 会话持续 5 小时;新鲜上下文更高效。
  11. CI 中使用 --no-session-persistence 避免在磁盘上积累保存的会话。

常见陷阱与注意事项

  1. 交互式模式必须使用 tmux — Claude Code 是一个完整的 TUI 应用。在 Hermes 终端中单独使用 pty=true 可以工作,但 tmux 提供了 capture-pane 用于监控和 send-keys 用于输入,这对编排至关重要。
  2. --dangerously-skip-permissions 对话框默认为「不,退出」 — 你必须先按 Down 再按 Enter 来接受。Print 模式(-p)完全跳过此对话框。
  3. --max-budget-usd 最低约 $0.05 — 仅系统提示缓存创建就需要这个成本。设置更低会立即报错。
  4. --max-turns 仅限 print 模式 — 在交互式会话中被忽略。
  5. Claude 可能使用 python 而不是 python3 — 在没有 python 符号链接的系统上,Claude 的 bash 命令首次尝试会失败但会自动修正。
  6. 会话恢复需要同一目录--continue 找到当前工作目录最近的会话。
  7. --json-schema 需要足够的 --max-turns — Claude 在生成结构化输出之前需要读取文件,这需要多轮交互。
  8. 信任对话框每个目录只出现一次 — 仅首次,之后缓存。
  9. 后台 tmux 会话持续存在 — 完成后始终使用 tmux kill-session -t <名称> 清理。
  10. 斜杠命令(如 /commit)仅在交互模式中可用 — 在 -p 模式中,用自然语言描述任务。
  11. --bare 跳过 OAuth — 需要 ANTHROPIC_API_KEY 环境变量或设置中的 apiKeyHelper
  12. 上下文退化是真实存在的 — 上下文窗口使用超过 70% 时 AI 输出质量明显下降。使用 /context 监控并主动 /compact

Hermes Agent 使用规则

  1. 优先为单一任务使用 print 模式(-p — 更干净,无需对话框处理,结构化输出
  2. 多轮交互式工作使用 tmux — 编排 TUI 的唯一可靠方法
  3. 始终设置 workdir — 让 Claude 专注于正确的项目目录
  4. print 模式中设置 --max-turns — 防止无限循环和失控成本
  5. 监控 tmux 会话 — 使用 tmux capture-pane -t <会话> -p -S -50 检查进度
  6. 寻找 提示符 — 表示 Claude 正在等待输入(已完成或在提问)
  7. 清理 tmux 会话 — 完成后终止它们以避免资源泄漏
  8. 向用户报告结果 — 完成后总结 Claude 做了什么以及有什么变化
  9. 不要终止慢速会话 — Claude 可能正在做多步骤工作;检查进度而不是直接杀掉
  10. 使用 --allowedTools — 将能力限制到任务实际需要的范围
使用手册

OpenClaw 智能体开发实战

一、OpenClaw 智能体框架概述

OpenClaw 是国产开源智能体框架,支持快速构建 AI Agent 应用,提供技能开发、工具集成、多智能体协作等核心能力。

1. 核心特性

  • 技能系统:通过 SKILL.md 定义技能,支持自动发现和加载
  • 多通道集成:Telegram、Discord、微信、飞书等 10+ 通道
  • 工具链:exec、web_fetch、cron、memory 等内置工具
  • 多智能体:subagent 协作、session 管理
  • 上下文管理:LCM 无损上下文压缩

二、安装部署

项目要求
Node.jsv22+
操作系统Windows / macOS / Linux
API KeyOpenAI / Claude / 火山引擎等

2. 安装步骤

  1. 安装 OpenClaw CLI
  2. 初始化工作区
  3. 配置 API Key 和模型
  4. 启动 Gateway 服务

三、最佳实践

  • 技能描述要精确,避免歧义触发
  • 利用 memory/ 目录持久化状态
  • 善用 subagent 处理并行任务
使用手册

OpenClaw个人AI智能体部署

一、OpenClaw 个人AI智能体部署

在本地电脑部署 OpenClaw 智能体,打造7x24小时在线的私人AI助手。

1. 部署方案

方案适合场景成本
本地Windows个人开发者免费(API按量)
云服务器团队共享约50元/月
Docker一键部署免费

二、安装步骤

  1. 安装 Node.js v22+
  2. npm install -g openclaw
  3. openclaw init 初始化工作区
  4. 配置 .env 文件
  5. openclaw gateway start

三、通道配置

支持 Telegram / Discord / 微信 / 飞书 / Web UI 等通道。

使用手册

One API 使用手册 - 快速入门指南

One API 是一个开源的 LLM API 管理与代理工具,支持多种大模型和服务商,提供丰富的管理功能。

一、支持多种大模型

  1. OpenAI ChatGPT 系列模型(支持 Azure OpenAI API)
  2. Anthropic Claude 系列模型(支持 AWS Claude)
  3. Google PaLM2 / Gemini 系列模型
  4. Mistral 系列模型
  5. 字节跳动豆包大模型(火山引擎)
  6. 百度文心一言系列模型
  7. 阿里通义千问系列模型
  8. 讯飞星火认知大模型
  9. 智谱 ChatGLM 系列模型
  10. 360 智脑
  11. 腾讯混元大模型
  12. Moonshot AI
  13. 百川大模型
  14. MINIMAX
  15. Groq
  16. Ollama
  17. 零一万物
  18. 阶跃星辰
  19. Coze
  20. Cohere
  21. DeepSeek
  22. Cloudflare Workers AI
  23. DeepL
  24. together.ai
  25. novita.ai
  26. 硅基流动 SiliconCloud
  27. xAI

二、支持配置镜像以及众多第三方代理服务

三、支持通过负载均衡的方式访问多个渠道

四、支持 stream 模式,可以通过流式传输实现打字机效果

五、支持多机部署

六、支持令牌管理

设置令牌的过期时间、额度、允许的 IP 范围以及允许的模型访问。

七、支持兑换码管理

支持批量生成和导出兑换码,可使用兑换码为账户进行充值。

八、支持渠道管理,批量创建渠道

九、支持用户分组以及渠道分组

支持为不同分组设置不同的倍率。

十、支持渠道设置模型列表

十一、支持查看额度明细

十二、支持用户邀请奖励

十三、支持以美元为单位显示额度

十四、支持发布公告

设置充值链接,设置新用户初始额度。

十五、支持模型映射

重定向用户的请求模型,如无必要请不要设置,设置之后会导致请求体被重新构造而非直接透传,会导致部分还未正式支持的字段无法传递成功。

十六、支持失败自动重试

十七、支持绘图接口

十八、支持 Cloudflare AI Gateway

渠道设置的代理部分填写 https://gateway.ai.cloudflare.com/v1/ACCOUNT_TAG/GATEWAY/openai 即可。

十九、支持丰富的自定义设置

  1. 支持自定义系统名称、logo 以及页脚。
  2. 支持自定义首页和关于页面,可以选择使用 HTML & Markdown 代码进行自定义,或者使用一个单独的网页通过 iframe 嵌入。

二十、支持通过系统访问令牌调用管理 API

在无需二开的情况下扩展和自定义 One API 的功能,详情请参考 API 文档。

二十一、支持 Cloudflare Turnstile 用户校验

二十二、支持用户管理

支持多种用户登录注册方式:

  1. 邮箱登录注册(支持注册邮箱白名单)以及通过邮箱进行密码重置
  2. 支持飞书授权登录
  3. 支持 GitHub 授权登录
  4. 微信公众号授权(需要额外部署 WeChat Server)

二十三、支持主题切换

设置环境变量 THEME 即可,默认为 default,欢迎 PR 更多主题。

二十四、配合 Message Pusher 可将报警信息推送到多种 App 上

使用手册

One API 部署与配置指南

中文 | English | 日本語

one-api logo

One API

_✨ 通过标准的 OpenAI API 格式访问所有的大模型,开箱即用 ✨_

license release docker pull release GoReportCard

部署教程 · 使用方法 · 意见反馈 · 截图展示 · 在线演示 · 常见问题 · 相关项目 · 赞赏支持

> [!NOTE] > 本项目为开源项目,使用者必须在遵循 OpenAI 的使用条款以及法律法规的情况下使用,不得用于非法用途。 > > 根据《生成式人工智能服务管理暂行办法》的要求,请勿对中国地区公众提供一切未经备案的生成式人工智能服务。 > [!NOTE] > 稳定版 / 预览版镜像地址:justsong/one-api > 或者 ghcr.io/songquanpeng/one-api > > alpha 版镜像地址:justsong/one-api-alpha > 或者 ghcr.io/songquanpeng/one-api-alpha > [!WARNING] > 使用 root 用户初次登录系统后,务必修改默认密码 123456

功能

1. 支持多种大模型: + [x] OpenAI ChatGPT 系列模型(支持 Azure OpenAI API) + [x] Anthropic Claude 系列模型 (支持 AWS Claude) + [x] Google PaLM2/Gemini 系列模型 + [x] Mistral 系列模型 + [x] 字节跳动豆包大模型(火山引擎) + [x] 百度文心一言系列模型 + [x] 阿里通义千问系列模型 + [x] 讯飞星火认知大模型 + [x] 智谱 ChatGLM 系列模型 + [x] 360 智脑 + [x] 腾讯混元大模型 + [x] Moonshot AI + [x] 百川大模型 + [x] MINIMAX + [x] Groq + [x] Ollama + [x] 零一万物 + [x] 阶跃星辰 + [x] Coze + [x] Cohere + [x] DeepSeek + [x] Cloudflare Workers AI + [x] DeepL + [x] together.ai + [x] novita.ai + [x] 硅基流动 SiliconCloud + [x] xAI 2. 支持配置镜像以及众多第三方代理服务。 3. 支持通过负载均衡的方式访问多个渠道。 4. 支持 stream 模式,可以通过流式传输实现打字机效果。 5. 支持多机部署详见此处。 6. 支持令牌管理,设置令牌的过期时间、额度、允许的 IP 范围以及允许的模型访问。 7. 支持兑换码管理,支持批量生成和导出兑换码,可使用兑换码为账户进行充值。 8. 支持渠道管理,批量创建渠道。 9. 支持用户分组以及渠道分组,支持为不同分组设置不同的倍率。 10. 支持渠道设置模型列表。 11. 支持查看额度明细。 12. 支持用户邀请奖励。 13. 支持以美元为单位显示额度。 14. 支持发布公告,设置充值链接,设置新用户初始额度。 15. 支持模型映射,重定向用户的请求模型,如无必要请不要设置,设置之后会导致请求体被重新构造而非直接透传,会导致部分还未正式支持的字段无法传递成功。 16. 支持失败自动重试。 17. 支持绘图接口。 18. 支持 Cloudflare AI Gateway,渠道设置的代理部分填写 https://gateway.ai.cloudflare.com/v1/ACCOUNT_TAG/GATEWAY/openai 即可。 19. 支持丰富的自定义设置, 1. 支持自定义系统名称,logo 以及页脚。 2. 支持自定义首页和关于页面,可以选择使用 HTML & Markdown 代码进行自定义,或者使用一个单独的网页通过 iframe 嵌入。 20. 支持通过系统访问令牌调用管理 API,进而在无需二开的情况下扩展和自定义 One API 的功能,详情请参考此处 API 文档。 21. 支持 Cloudflare Turnstile 用户校验。 22. 支持用户管理,支持多种用户登录注册方式: + 邮箱登录注册(支持注册邮箱白名单)以及通过邮箱进行密码重置。 + 支持飞书授权登录这里有 One API 的实现细节阐述供参考)。 + 支持 GitHub 授权登录。 + 微信公众号授权(需要额外部署 WeChat Server)。 23. 支持主题切换,设置环境变量 THEME 即可,默认为 default,欢迎 PR 更多主题,具体参考此处。 24. 配合 Message Pusher 可将报警信息推送到多种 App 上。

部署

基于 Docker 进行部署

使用 SQLite 的部署命令:

docker run --name one-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api

使用 MySQL 的部署命令,在上面的基础上添加 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi",请自行修改数据库连接参数,不清楚如何修改请参见下面环境变量一节。

例如:

docker run --name one-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api
其中,-p 3000:3000 中的第一个 3000 是宿主机的端口,可以根据需要进行修改。 数据和日志将会保存在宿主机的 /home/ubuntu/data/one-api 目录,请确保该目录存在且具有写入权限,或者更改为合适的目录。 如果启动失败,请添加 --privileged=true,具体参考 https://github.com/songquanpeng/one-api/issues/482 。 如果上面的镜像无法拉取,可以尝试使用 GitHub 的 Docker 镜像,将上面的 justsong/one-api 替换为 ghcr.io/songquanpeng/one-api 即可。 如果你的并发量较大,务必设置 SQL_DSN,详见下面环境变量一节。 更新命令:docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower -cR Nginx 的参考配置:
server{
   server_name openai.justsong.cn;  # 请根据实际情况修改你的域名

   location / {
          client_max_body_size  64m;
          proxy_http_version 1.1;
          proxy_pass http://localhost:3000;  # 请根据实际情况修改你的端口
          proxy_set_header Host $host;
          proxy_set_header X-Forwarded-For $remote_addr;
          proxy_cache_bypass $http_upgrade;
          proxy_set_header Accept-Encoding gzip;
          proxy_read_timeout 300s;  # GPT-4 需要较长的超时时间,请自行调整
   }
}
之后使用 Let's Encrypt 的 certbot 配置 HTTPS:

Ubuntu 安装 certbot:

sudo snap install --classic certbot sudo ln -s /snap/bin/certbot /usr/bin/certbot

生成证书 & 修改 Nginx 配置

sudo certbot --nginx

根据指示进行操作

重启 Nginx

sudo service nginx restart
初始账号用户名为 root,密码为 123456

通过宝塔面板进行一键部署

1. 安装宝塔面板9.2.0及以上版本,前往 宝塔面板 官网,选择正式版的脚本下载安装; 2. 安装后登录宝塔面板,在左侧菜单栏中点击 Docker,首次进入会提示安装 Docker 服务,点击立即安装,按提示完成安装; 3. 安装完成后在应用商店中搜索 One-API,点击安装,配置域名等基本信息即可完成安装;

基于 Docker Compose 进行部署

> 仅启动方式不同,参数设置不变,请参考基于 Docker 部署部分

目前支持 MySQL 启动,数据存储在 ./data/mysql 文件夹内

docker-compose up -d

查看部署状态

docker-compose ps

手动部署

1. 从 GitHub Releases 下载可执行文件或者从源码编译:
   git clone https://github.com/songquanpeng/one-api.git

   # 构建前端
   cd one-api/web/default
   npm install
   npm run build

   # 构建后端
   cd ../..
   go mod download
   go build -ldflags "-s -w" -o one-api
   
2. 运行:
   chmod u+x one-api
   ./one-api --port 3000 --log-dir ./logs
   
3. 访问 http://localhost:3000/ 并登录。初始账号用户名为
root,密码为 123456。 更加详细的部署教程参见此处

多机部署

1. 所有服务器
SESSION_SECRET 设置一样的值。 2. 必须设置 SQL_DSN,使用 MySQL 数据库而非 SQLite,所有服务器连接同一个数据库。 3. 所有从服务器必须设置 NODE_TYPEslave,不设置则默认为主服务器。 4. 设置 SYNC_FREQUENCY 后服务器将定期从数据库同步配置,在使用远程数据库的情况下,推荐设置该项并启用 Redis,无论主从。 5. 从服务器可以选择设置 FRONTEND_BASE_URL,以重定向页面请求到主服务器。 6. 从服务器上分别装好 Redis,设置好 REDIS_CONN_STRING,这样可以做到在缓存未过期的情况下数据库零访问,可以减少延迟(Redis 集群或者哨兵模式的支持请参考环境变量说明)。 7. 如果主服务器访问数据库延迟也比较高,则也需要启用 Redis,并设置 SYNC_FREQUENCY,以定期从数据库同步配置。 环境变量的具体使用方法详见此处

宝塔部署教程

详见 #175。 如果部署后访问出现空白页面,详见 #97

部署第三方服务配合 One API 使用

> 欢迎 PR 添加更多示例。 #### ChatGPT Next Web 项目主页:https://github.com/Yidadaa/ChatGPT-Next-Web
docker run --name chat-next-web -d -p 3001:3000 yidadaa/chatgpt-next-web
注意修改端口号,之后在页面上设置接口地址(例如:https://openai.justsong.cn/ )和 API Key 即可。 #### ChatGPT Web 项目主页:https://github.com/Chanzhaoyu/chatgpt-web
docker run --name chatgpt-web -d -p 3002:3002 -e OPENAI_API_BASE_URL=https://openai.justsong.cn -e OPENAI_API_KEY=sk-xxx chenzhaoyu94/chatgpt-web
注意修改端口号、
OPENAI_API_BASE_URLOPENAI_API_KEY。 #### QChatGPT - QQ机器人 项目主页:https://github.com/RockChinQ/QChatGPT 根据文档完成部署后,在 data/provider.json设置requester.openai-chat-completions.base-url为 One API 实例地址,并填写 API Key 到 keys.openai 组中,设置 model 为要使用的模型名称。 运行期间可以通过!model命令查看、切换可用模型。

部署到第三方平台

部署到 Sealos
> Sealos 的服务器在国外,不需要额外处理网络问题,支持高并发 & 动态伸缩。 点击以下按钮一键部署(部署后访问出现 404 请等待 3~5 分钟): ![Deploy-on-Sealos.svg](https://cloud.sealos.io/?openapp=system-fastdeploy?templateName=one-api)
部署到 Zeabur
> Zeabur 的服务器在国外,自动解决了网络的问题,同时免费的额度也足够个人使用 ![Deploy on Zeabur](https://zeabur.com/templates/7Q0KO3) 1. 首先 fork 一份代码。 2. 进入 Zeabur,登录,进入控制台。 3. 新建一个 Project,在 Service -> Add Service 选择 Marketplace,选择 MySQL,并记下连接参数(用户名、密码、地址、端口)。 4. 复制链接参数,运行 `create database one-api ` 创建数据库。 5. 然后在 Service -> Add Service,选择 Git(第一次使用需要先授权),选择你 fork 的仓库。 6. Deploy 会自动开始,先取消。进入下方 Variable,添加一个 PORT,值为 3000,再添加一个 SQL_DSN,值为 :@tcp(:)/one-api ,然后保存。 注意如果不填写 SQL_DSN,数据将无法持久化,重新部署后数据会丢失。 7. 选择 Redeploy。 8. 进入下方 Domains,选择一个合适的域名前缀,如 "my-one-api",最终域名为 "my-one-api.zeabur.app",也可以 CNAME 自己的域名。 9. 等待部署完成,点击生成的域名进入 One API。
部署到 Render
> Render 提供免费额度,绑卡后可以进一步提升额度 Render 可以直接部署 docker 镜像,不需要 fork 仓库:https://dashboard.render.com

配置

系统本身开箱即用。 你可以通过设置环境变量或者命令行参数进行配置。 等到系统启动后,使用
root 用户登录系统并做进一步的配置。 Note:如果你不知道某个配置项的含义,可以临时删掉值以看到进一步的提示文字。

使用方法

渠道页面中添加你的 API Key,之后在令牌页面中新增访问令牌。 之后就可以使用你的令牌访问 One API 了,使用方式与 OpenAI API 一致。 你需要在各种用到 OpenAI API 的地方设置 API Base 为你的 One API 的部署地址,例如:https://openai.justsong.cn,API Key 则为你在 One API 中生成的令牌。 注意,具体的 API Base 的格式取决于你所使用的客户端。 例如对于 OpenAI 的官方库:
OPENAI_API_KEY="sk-xxxxxx"
OPENAI_API_BASE="https://:/v1"
graph LR
    A(用户)
    A --->|使用 One API 分发的 key 进行请求| B(One API)
    B -->|中继请求| C(OpenAI)
    B -->|中继请求| D(Azure)
    B -->|中继请求| E(其他 OpenAI API 格式下游渠道)
    B -->|中继并修改请求体和返回体| F(非 OpenAI API 格式下游渠道)
可以通过在令牌后面添加渠道 ID 的方式指定使用哪一个渠道处理本次请求,例如:
Authorization: Bearer ONE_API_KEY-CHANNEL_ID。 注意,需要是管理员用户创建的令牌才能指定渠道 ID。 不加的话将会使用负载均衡的方式使用多个渠道。

环境变量

> One API 支持从
.env 文件中读取环境变量,请参照 .env.example 文件,使用时请将其重命名为 .env。 1. REDIS_CONN_STRING:设置之后将使用 Redis 作为缓存使用。 + 例子:REDIS_CONN_STRING=redis://default:redispw@localhost:49153 + 如果数据库访问延迟很低,没有必要启用 Redis,启用后反而会出现数据滞后的问题。 + 如果需要使用哨兵或者集群模式: + 则需要把该环境变量设置为节点列表,例如:localhost:49153,localhost:49154,localhost:49155。 + 除此之外还需要设置以下环境变量: + REDIS_PASSWORD:Redis 集群或者哨兵模式下的密码设置。 + REDIS_MASTER_NAME:Redis 哨兵模式下主节点的名称。 2. SESSION_SECRET:设置之后将使用固定的会话密钥,这样系统重新启动后已登录用户的 cookie 将依旧有效。 + 例子:SESSION_SECRET=random_string 3. SQL_DSN:设置之后将使用指定数据库而非 SQLite,请使用 MySQL 或 PostgreSQL。 + 例子: + MySQL:SQL_DSN=root:123456@tcp(localhost:3306)/oneapi + PostgreSQL:SQL_DSN=postgres://postgres:123456@localhost:5432/oneapi(适配中,欢迎反馈) + 注意需要提前建立数据库 oneapi,无需手动建表,程序将自动建表。 + 如果使用本地数据库:部署命令可添加 --network="host" 以使得容器内的程序可以访问到宿主机上的 MySQL。 + 如果使用云数据库:如果云服务器需要验证身份,需要在连接参数中添加 ?tls=skip-verify。 + 请根据你的数据库配置修改下列参数(或者保持默认值): + SQL_MAX_IDLE_CONNS:最大空闲连接数,默认为 100。 + SQL_MAX_OPEN_CONNS:最大打开连接数,默认为 1000。 + 如果报错 Error 1040: Too many connections,请适当减小该值。 + SQL_CONN_MAX_LIFETIME:连接的最大生命周期,默认为 60,单位分钟。 4. LOG_SQL_DSN:设置之后将为 logs 表使用独立的数据库,请使用 MySQL 或 PostgreSQL。 5. FRONTEND_BASE_URL:设置之后将重定向页面请求到指定的地址,仅限从服务器设置。 + 例子:FRONTEND_BASE_URL=https://openai.justsong.cn 6. MEMORY_CACHE_ENABLED:启用内存缓存,会导致用户额度的更新存在一定的延迟,可选值为 truefalse,未设置则默认为 false。 + 例子:MEMORY_CACHE_ENABLED=true 7. SYNC_FREQUENCY:在启用缓存的情况下与数据库同步配置的频率,单位为秒,默认为 600 秒。 + 例子:SYNC_FREQUENCY=60 8. NODE_TYPE:设置之后将指定节点类型,可选值为 masterslave,未设置则默认为 master。 + 例子:NODE_TYPE=slave 9. CHANNEL_UPDATE_FREQUENCY:设置之后将定期更新渠道余额,单位为分钟,未设置则不进行更新。 + 例子:CHANNEL_UPDATE_FREQUENCY=1440 10. CHANNEL_TEST_FREQUENCY:设置之后将定期检查渠道,单位为分钟,未设置则不进行检查。 +例子:CHANNEL_TEST_FREQUENCY=1440 11. POLLING_INTERVAL:批量更新渠道余额以及测试可用性时的请求间隔,单位为秒,默认无间隔。 + 例子:POLLING_INTERVAL=5 12. BATCH_UPDATE_ENABLED:启用数据库批量更新聚合,会导致用户额度的更新存在一定的延迟可选值为 truefalse,未设置则默认为 false。 + 例子:BATCH_UPDATE_ENABLED=true + 如果你遇到了数据库连接数过多的问题,可以尝试启用该选项。 13. BATCH_UPDATE_INTERVAL=5:批量更新聚合的时间间隔,单位为秒,默认为 5。 + 例子:BATCH_UPDATE_INTERVAL=5 14. 请求频率限制: + GLOBAL_API_RATE_LIMIT:全局 API 速率限制(除中继请求外),单 ip 三分钟内的最大请求数,默认为 180。 + GLOBAL_WEB_RATE_LIMIT:全局 Web 速率限制,单 ip 三分钟内的最大请求数,默认为 60。 15. 编码器缓存设置: + TIKTOKEN_CACHE_DIR:默认程序启动时会联网下载一些通用的词元的编码,如:gpt-3.5-turbo,在一些网络环境不稳定,或者离线情况,可能会导致启动有问题,可以配置此目录缓存数据,可迁移到离线环境。 + DATA_GYM_CACHE_DIR:目前该配置作用与 TIKTOKEN_CACHE_DIR 一致,但是优先级没有它高。 16. RELAY_TIMEOUT:中继超时设置,单位为秒,默认不设置超时时间。 17. RELAY_PROXY:设置后使用该代理来请求 API。 18. USER_CONTENT_REQUEST_TIMEOUT:用户上传内容下载超时时间,单位为秒。 19. USER_CONTENT_REQUEST_PROXY:设置后使用该代理来请求用户上传的内容,例如图片。 20. SQLITE_BUSY_TIMEOUT:SQLite 锁等待超时设置,单位为毫秒,默认 3000。 21. GEMINI_SAFETY_SETTING:Gemini 的安全设置,默认 BLOCK_NONE。 22. GEMINI_VERSION:One API 所使用的 Gemini 版本,默认为 v1。 23. THEME:系统的主题设置,默认为 default,具体可选值参考此处。 24. ENABLE_METRIC:是否根据请求成功率禁用渠道,默认不开启,可选值为 truefalse。 25. METRIC_QUEUE_SIZE:请求成功率统计队列大小,默认为 10。 26. METRIC_SUCCESS_RATE_THRESHOLD:请求成功率阈值,默认为 0.8。 27. INITIAL_ROOT_TOKEN:如果设置了该值,则在系统首次启动时会自动创建一个值为该环境变量值的 root 用户令牌。 28. INITIAL_ROOT_ACCESS_TOKEN:如果设置了该值,则在系统首次启动时会自动创建一个值为该环境变量的 root 用户创建系统管理令牌。 29. ENFORCE_INCLUDE_USAGE:是否强制在 stream 模型下返回 usage,默认不开启,可选值为 truefalse。 30. TEST_PROMPT:测试模型时的用户 prompt,默认为 Print your model name exactly and do not output without any other text.

命令行参数

1.
--port : 指定服务器监听的端口号,默认为 3000。 + 例子:--port 3000 2. --log-dir : 指定日志文件夹,如果没有设置,默认保存至工作目录的 logs 文件夹下。 + 例子:--log-dir ./logs 3. --version: 打印系统版本号并退出。 4. --help: 查看命令的使用帮助和参数说明。

演示

在线演示

注意,该演示站不提供对外服务: https://openai.justsong.cn

截图展示

!channel !token

常见问题

1. 额度是什么?怎么计算的?One API 的额度计算有问题? + 额度 = 分组倍率 * 模型倍率 * (提示 token 数 + 补全 token 数 * 补全倍率) + 其中补全倍率对于 GPT3.5 固定为 1.33,GPT4 为 2,与官方保持一致。 + 如果是非流模式,官方接口会返回消耗的总 token,但是你要注意提示和补全的消耗倍率不一样。 + 注意,One API 的默认倍率就是官方倍率,是已经调整过的。 2. 账户额度足够为什么提示额度不足? + 请检查你的令牌额度是否足够,这个和账户额度是分开的。 + 令牌额度仅供用户设置最大使用量,用户可自由设置。 3. 提示无可用渠道? + 请检查的用户分组和渠道分组设置。 + 以及渠道的模型设置。 4. 渠道测试报错:
invalid character '<' looking for beginning of value + 这是因为返回值不是合法的 JSON,而是一个 HTML 页面。 + 大概率是你的部署站的 IP 或代理的节点被 CloudFlare 封禁了。 5. ChatGPT Next Web 报错:Failed to fetch + 部署的时候不要设置 BASE_URL。 + 检查你的接口地址和 API Key 有没有填对。 + 检查是否启用了 HTTPS,浏览器会拦截 HTTPS 域名下的 HTTP 请求。 6. 报错:当前分组负载已饱和,请稍后再试 + 上游渠道 429 了。 7. 升级之后我的数据会丢失吗? + 如果使用 MySQL,不会。 + 如果使用 SQLite,需要按照我所给的部署命令挂载 volume 持久化 one-api.db 数据库文件,否则容器重启后数据会丢失。 8. 升级之前数据库需要做变更吗? + 一般情况下不需要,系统将在初始化的时候自动调整。 + 如果需要的话,我会在更新日志中说明,并给出脚本。 9. 手动修改数据库后报错:数据库一致性已被破坏,请联系管理员`? + 这是检测到 ability 表里有些记录的渠道 id 是不存在的,这大概率是因为你删了 channel 表里的记录但是没有同步在 ability 表里清理无效的渠道。 + 对于每一个渠道,其所支持的模型都需要有一个专门的 ability 表的记录,表示该渠道支持该模型。

相关项目

* FastGPT: 基于 LLM 大语言模型的知识库问答系统 * ChatGPT Next Web: 一键拥有你自己的跨平台 ChatGPT 应用 * VChart: 不只是开箱即用的多端图表库,更是生动灵活的数据故事讲述者。 * VMind: 不仅自动,还很智能。开源智能可视化解决方案。 * CherryStudio: 全平台支持的AI客户端, 多服务商集成管理、本地知识库支持。

注意

本项目使用 MIT 协议进行开源,在此基础上,必须在页面底部保留署名以及指向本项目的链接。如果不想保留署名,必须首先获得授权。 同样适用于基于本项目的二开项目。 依据 MIT 协议,使用者需自行承担使用本项目的风险与责任,本开源项目开发者与此无关。
使用手册

One API 部署与使用手册

概述

One API 是一个开源的 API 管理和分发平台,支持将多种 AI 模型提供商(OpenAI、Anthropic、Google、DeepSeek 等)统一到一个兼容 OpenAI 格式的 API 接口下,方便管理和调用。

Docker 部署

快速启动

docker run --name one-api -d 
  --restart always 
  -p 3000:3000 
  -e TZ=Asia/Shanghai 
  -v /home/ubuntu/data/one-api:/data 
  justsong/one-api

Docker Compose

version: '3'
services:
  one-api:
    image: justsong/one-api
    container_name: one-api
    restart: always
    ports:
      - "3000:3000"
    environment:
      - TZ=Asia/Shanghai
    volumes:
      - ./data:/data

Nginx 反向代理配置

server {
    listen 443 ssl http2;
    server_name api.eake.cn;

    ssl_certificate /etc/ssl/api.eake.cn.pem;
    ssl_certificate_key /etc/ssl/api.eake.cn.key;

    location / {
        proxy_pass http://127.0.0.1:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # SSE 支持
        proxy_buffering off;
        proxy_cache off;
        chunked_transfer_encoding on;
    }
}

渠道配置

添加 OpenAI 渠道

  1. 进入管理后台 → 渠道管理 → 添加渠道
  2. 类型选择:OpenAI
  3. 填写 Base URL 和 API Key
  4. 选择要支持的模型

添加其他渠道

提供商类型Base URL
AnthropicAnthropichttps://api.anthropic.com
GoogleGoogle Geminihttps://generativelanguage.googleapis.com
DeepSeekDeepSeekhttps://api.deepseek.com

令牌管理

在「令牌」页面创建 API Token,设定额度、过期时间和可用模型。创建后获得的 sk-xxx 即为统一调用密钥。

统一调用示例

from openai import OpenAI

client = OpenAI(
    api_key="sk-your-one-api-token",
    base_url="https://api.eake.cn/v1"
)

# 调用任何已配置的模型
response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello"}]
)
使用手册

One API 部署与配置完全指南

One API 简介

One API 是一个开源的 AI API 管理和分发平台,支持将多个 AI 供应商的API统一为一个接口格式(兼容OpenAI格式),实现负载均衡、令牌管理、用量计费等功能。非常适合需要管理多个API Key或搭建API中转服务的场景。

Docker 部署(推荐)

创建数据目录

mkdir -p /opt/one-api/data

启动容器

docker run --name one-api -d 
  --restart always 
  -p 3000:3000 
  -e TZ=Asia/Shanghai 
  -v /opt/one-api/data:/data 
  justsong/one-api

Nginx 反向代理配置

server {
    listen 443 ssl http2;
    server_name api.example.com;

    ssl_certificate /etc/ssl/certs/api.example.com.pem;
    ssl_certificate_key /etc/ssl/certs/api.example.com.key;

    location / {
        proxy_pass http://127.0.0.1:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # SSE支持
        proxy_buffering off;
        proxy_cache off;
        chunked_transfer_encoding on;
    }
}

初始化配置

登录管理后台

访问 https://api.example.com,默认管理员账号:

  • 用户名:root
  • 密码:123456

⚠️ 首次登录后立即修改密码!

添加渠道(Channel)

渠道是API供应商的接入配置:

字段说明
类型选择供应商(OpenAI、Anthropic、DeepSeek等)
名称自定义渠道名称
Base URLAPI端点地址
密钥API Key
模型选择该渠道支持的模型

创建令牌(Token)

令牌是分发给用户的访问密钥:

  • 设置额度限制
  • 限制可用模型
  • 设置过期时间
  • 启用/禁用IP白名单

渠道配置示例

OpenAI 渠道

类型OpenAI
Base URLhttps://api.openai.com
密钥sk-xxx
模型gpt-4o, gpt-4o-mini, gpt-5.2

DeepSeek 渠道

类型DeepSeek
Base URLhttps://api.deepseek.com
密钥sk-xxx
模型deepseek-v4-pro, deepseek-v4-flash

Anthropic 渠道

类型Anthropic
Base URLhttps://api.anthropic.com
密钥sk-ant-xxx
模型claude-sonnet-4-20250514, claude-opus-4-20250514

负载均衡策略

同一模型可配置多个渠道,One API自动负载均衡:

  • 优先级:数字越小优先级越高
  • 权重:同优先级按权重分配
  • 自动重试:某渠道失败自动切换

使用方式

部署完成后,将 Base URL 改为 One API 地址,使用 One API 生成的令牌即可:

from openai import OpenAI

client = OpenAI(
    api_key="sk-one-api-token-xxx",  # One API 令牌
    base_url="https://api.example.com/v1"  # One API 地址
)

# 像使用 OpenAI 一样调用
response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello!"}]
)

数据备份

# 备份SQLite数据库
cp /opt/one-api/data/one-api.db /opt/one-api/data/one-api.db.bak

# 或导出MySQL
mysqldump -u root -p one_api > one_api_backup.sql

常见问题

Q: 渠道报错 401?
A: 检查API Key是否正确,是否已过期。

Q: 流式输出中断?
A: Nginx需关闭 proxy_buffering,确保SSE正常传输。

Q: 如何查看日志?
A: docker logs one-api -f --tail 100

使用手册

OpenAI API 使用手册

一、概述

OpenAI API 提供 GPT 系列模型的程序化访问,支持文本生成、对话、函数调用、图像生成、语音合成与识别、嵌入向量等功能。所有接口兼容 OpenAI 格式,可通过 REST API 或官方 SDK 调用。

二、认证

所有请求需在 HTTP Header 中携带 API Key:

Authorization: Bearer sk-xxxxxxxxxxxxxxxx

API Key 在 platform.openai.com/api-keys 创建,建议通过环境变量管理:

export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx

三、Base URL

https://api.openai.com/v1

四、模型列表

模型ID类型上下文窗口训练数据
gpt-5.2旗舰对话256K2026年4月
gpt-4o通用对话128K2025年10月
gpt-4o-mini轻量对话128K2025年10月
o3推理专用200K2026年4月
o4-mini轻量推理128K2026年3月
dall-e-3图像生成--
whisper-1语音识别--
tts-1语音合成--
text-embedding-3-large文本嵌入8191-

五、Chat Completions

请求

POST /v1/chat/completions

{
  "model": "gpt-4o",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello!"}
  ],
  "temperature": 0.7,
  "top_p": 1,
  "max_tokens": 4096,
  "stream": false,
  "stop": null,
  "presence_penalty": 0,
  "frequency_penalty": 0
}

参数说明

参数类型必填说明
modelstring模型ID
messagesarray消息数组,每条含 role + content
temperaturefloat0-2,默认1。越低越确定性
top_pfloat核采样,0-1,默认1
max_tokensint最大生成token数
streambool是否流式输出,默认false
stopstring/array停止序列
presence_penaltyfloat-2到2,正值鼓励新话题
frequency_penaltyfloat-2到2,正值降低重复
toolsarray函数定义列表
tool_choicestring/object"auto"/"none"/"required"/指定函数
response_formatobject{"type":"json_object"} 强制JSON输出
seedint随机种子,可复现结果

响应

{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "created": 1717100000,
  "model": "gpt-4o",
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "Hello! How can I help you today?"
    },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 8,
    "total_tokens": 28
  }
}

六、Function Calling(函数调用)

定义函数

"tools": [{
  "type": "function",
  "function": {
    "name": "get_weather",
    "description": "获取指定城市的当前天气",
    "parameters": {
      "type": "object",
      "properties": {
        "city": {"type": "string", "description": "城市名称"},
        "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]}
      },
      "required": ["city"]
    }
  }
}]

处理函数调用

// 模型返回 tool_calls
if (response.choices[0].finish_reason === "tool_calls") {
  const toolCall = response.choices[0].message.tool_calls[0];
  // 执行实际函数
  const result = await getWeather(toolCall.function.arguments);
  // 将结果返回给模型
  const followUp = await client.chat.completions.create({
    model: "gpt-4o",
    messages: [
      ...previousMessages,
      response.choices[0].message,
      {
        role: "tool",
        tool_call_id: toolCall.id,
        content: JSON.stringify(result)
      }
    ]
  });
}

七、图像生成(DALL·E)

POST /v1/images/generations

{
  "model": "dall-e-3",
  "prompt": "A white siamese cat in a cyberpunk city",
  "n": 1,
  "size": "1024x1024",
  "quality": "hd",
  "style": "vivid"
}

可选尺寸:1024x1024, 1792x1024, 1024x1792

八、语音识别(Whisper)

POST /v1/audio/transcriptions
Content-Type: multipart/form-data

file: audio.mp3
model: whisper-1
language: zh

九、语音合成(TTS)

POST /v1/audio/speech

{
  "model": "tts-1",
  "input": "你好,世界!",
  "voice": "alloy"
}

可用声音:alloy, echo, fable, onyx, nova, shimmer

十、文本嵌入

POST /v1/embeddings

{
  "model": "text-embedding-3-large",
  "input": "The food was delicious"
}

十一、速率限制

层级RPMTPM
Free340,000
Tier 1 ($5+)500200,000
Tier 2 ($50+)5,0002,000,000

遇到 429 错误时使用指数退避重试。

十二、错误码

状态码含义处理建议
400请求格式错误检查参数
401API Key 无效检查密钥
429速率限制退避重试
500服务器错误稍后重试
503服务过载稍后重试
使用手册

Anthropic Claude API 使用手册

一、概述

Anthropic Claude API 提供 Claude 系列模型的访问,以长上下文、高质量输出和安全对齐著称。API 同时支持 OpenAI 兼容格式和原生 Anthropic 格式。

二、认证

x-api-key: sk-ant-xxxxxxxxxxxxxxxx
anthropic-version: 2023-06-01

API Key 在 console.anthropic.com 创建。

三、Base URL

原生格式:https://api.anthropic.com/v1
OpenAI兼容:https://api.anthropic.com/v1/openai

四、模型列表

模型ID上下文最大输出定位
claude-opus-4-20250514200K32K最强推理
claude-sonnet-4-20250514200K64K通用最佳
claude-haiku-3-5-20241022200K8K快速轻量

五、Messages API

请求

POST /v1/messages

{
  "model": "claude-sonnet-4-20250514",
  "max_tokens": 4096,
  "system": "You are a helpful assistant.",
  "messages": [
    {"role": "user", "content": "Hello!"}
  ],
  "temperature": 0.7,
  "top_p": 1,
  "top_k": 0,
  "stream": false
}

参数说明

参数类型必填说明
modelstring模型ID
messagesarray消息数组,交替 user/assistant
max_tokensint最大生成token数
systemstring系统提示词(与messages同级)
temperaturefloat0-1,默认1
top_pfloat核采样,0-1
top_kintTop-K采样
streambool流式输出
stop_sequencesarray停止序列
toolsarray工具定义
tool_choiceobject工具选择策略
thinkingobject扩展思考配置

响应

{
  "id": "msg_xxx",
  "type": "message",
  "role": "assistant",
  "content": [
    {"type": "text", "text": "Hello! How can I help you?"}
  ],
  "model": "claude-sonnet-4-20250514",
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 12,
    "output_tokens": 10,
    "cache_creation_input_tokens": 0,
    "cache_read_input_tokens": 0
  }
}

六、多模态输入

图像(Base64)

"messages": [{
  "role": "user",
  "content": [
    {
      "type": "image",
      "source": {
        "type": "base64",
        "media_type": "image/png",
        "data": "iVBORw0KGgo..."
      }
    },
    {"type": "text", "text": "描述这张图片"}
  ]
}]

图像(URL)

"content": [
  {
    "type": "image",
    "source": {
      "type": "url",
      "url": "https://example.com/photo.jpg"
    }
  },
  {"type": "text", "text": "分析这张图"}
]

PDF文档

"content": [
  {
    "type": "document",
    "source": {
      "type": "base64",
      "media_type": "application/pdf",
      "data": "JVBERi0xLjQ..."
    }
  },
  {"type": "text", "text": "总结文档要点"}
]

七、Tool Use(工具调用)

定义工具

"tools": [{
  "name": "calculator",
  "description": "执行数学计算",
  "input_schema": {
    "type": "object",
    "properties": {
      "expression": {"type": "string", "description": "数学表达式"}
    },
    "required": ["expression"]
  }
}]

处理工具调用

// 模型返回 tool_use block
if (response.stop_reason === "tool_use") {
  const toolBlock = response.content.find(b => b.type === "tool_use");
  
  // 执行函数并返回结果
  const result = await calculator(toolBlock.input.expression);
  
  const followUp = await client.messages.create({
    model: "claude-sonnet-4-20250514",
    max_tokens: 4096,
    tools: tools,
    messages: [
      {"role": "user", "content": "计算 2+2"},
      {"role": "assistant", "content": response.content},
      {
        "role": "user",
        "content": [{
          "type": "tool_result",
          "tool_use_id": toolBlock.id,
          "content": result.toString()
        }]
      }
    ]
  });
}

八、扩展思考(Extended Thinking)

{
  "model": "claude-sonnet-4-20250514",
  "max_tokens": 16000,
  "thinking": {
    "type": "enabled",
    "budget_tokens": 10000
  },
  "messages": [
    {"role": "user", "content": "证明费马大定理的特殊情况n=4"}
  ]
}

响应中会包含 thinking 类型的 content block,展示推理过程。

九、流式输出

const stream = client.messages.stream({
  model: "claude-sonnet-4-20250514",
  max_tokens: 1024,
  messages: [{"role": "user", "content": "Hello!"}]
});

stream.on("text", (text) => {
  process.stdout.write(text);
});

十、Prompt Caching(提示缓存)

标记可缓存的内容块,减少重复计费:

"system": [{
  "type": "text",
  "text": "很长的系统指令...",
  "cache_control": {"type": "ephemeral"}
}]

缓存命中的 token 价格降低 90%。

十一、速率限制

层级并发请求数TPM
Free5-
Tier 15080,000
Tier 2200400,000
Tier 31,0002,000,000

十二、错误码

状态码类型处理建议
400invalid_request_error检查参数
401authentication_error检查API Key
403permission_error检查访问权限
429rate_limit_error退避重试
500api_error稍后重试
529overloaded_error稍后重试
使用手册

DeepSeek API 使用手册

一、概述

DeepSeek API 完全兼容 OpenAI API 格式,现有 OpenAI SDK 和代码可零成本迁移。同时提供 Anthropic API 兼容格式。DeepSeek 以极低价格提供顶级模型能力,性价比业界领先。

二、认证

Authorization: Bearer your-deepseek-api-key

API Key 在 platform.deepseek.com/api_keys 创建。

三、Base URL

OpenAI兼容格式:https://api.deepseek.com
Anthropic兼容格式:https://api.deepseek.com/anthropic
聊天补全端点:https://api.deepseek.com/chat/completions

四、模型列表

模型ID上下文最大输出说明
deepseek-v4-pro128K16K最新旗舰,支持思考模式
deepseek-v4-flash128K16K快速版,高性价比
deepseek-chat128K8K⚠️将废弃(2026/07/24),等同v4-flash非思考
deepseek-reasoner128K8K⚠️将废弃(2026/07/24),等同v4-flash思考

五、使用 OpenAI SDK 调用

from openai import OpenAI

client = OpenAI(
    api_key="your-deepseek-api-key",
    base_url="https://api.deepseek.com"
)

# 非思考模式
response = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello!"}
    ],
    stream=False
)
print(response.choices[0].message.content)

六、思考模式

DeepSeek 独有的深度推理能力,模型在回答前进行长链推理:

response = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[
        {"role": "user", "content": "求解 x^2 + 5x + 6 = 0"}
    ],
    thinking={"type": "enabled"},
    reasoning_effort="high",  # low / medium / high
    stream=False
)

思考模式响应结构

{
  "choices": [{
    "message": {
      "role": "assistant",
      "content": "方程 x^2 + 5x + 6 = 0 的解为 x = -2 或 x = -3",
      "reasoning_content": "这是一个一元二次方程...n使用因式分解...n(x+2)(x+3)=0..."
    }
  }]
}

reasoning_effort 参数

效果适用场景
low快速推理,思考短简单问题
medium平衡推理一般问题
high深度推理,思考长复杂数学/编程/逻辑

七、流式输出

stream = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[{"role": "user", "content": "写一首诗"}],
    stream=True
)

for chunk in stream:
    # 普通内容
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")
    # 思考内容(思考模式下)
    if hasattr(chunk.choices[0].delta, 'reasoning_content') and chunk.choices[0].delta.reasoning_content:
        # 可选择不输出思考过程
        pass

八、cURL 调用示例

curl https://api.deepseek.com/chat/completions 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer $DEEPSEEK_API_KEY" 
  -d '{
    "model": "deepseek-v4-pro",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Hello!"}
    ],
    "thinking": {"type": "enabled"},
    "reasoning_effort": "high",
    "stream": false
  }'

九、Function Calling

与 OpenAI 格式完全一致:

tools = [{
    "type": "function",
    "function": {
        "name": "get_weather",
        "description": "获取天气信息",
        "parameters": {
            "type": "object",
            "properties": {
                "city": {"type": "string", "description": "城市名"}
            },
            "required": ["city"]
        }
    }
}]

response = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[{"role": "user", "content": "北京天气如何?"}],
    tools=tools
)

十、JSON 输出

response = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[{"role": "user", "content": "列出中国前5大城市"}],
    response_format={"type": "json_object"}
)

十一、定价

模型输入价格输出(含思考)缓存命中
deepseek-v4-pro¥4/1M tokens¥16/1M tokens¥1/1M tokens
deepseek-v4-flash¥1/1M tokens¥4/1M tokens¥0.1/1M tokens

十二、Agent 工具集成

无需编码,直接在主流AI工具中使用:

工具配置方式
Claude Code自定义API端点 → https://api.deepseek.com
GitHub Copilot选择 DeepSeek 模型
One API添加 DeepSeek 渠道
OpenCode直接支持

十三、速率限制

默认限制(付费用户):

  • RPM: 60(v4-pro)/ 120(v4-flash)
  • TPM: 2,000,000

余额不足时自动降级为免费层级限速。

十四、错误码

状态码含义处理
400请求格式错误检查参数
401API Key 无效检查密钥
402余额不足充值
429速率限制退避重试
500服务器错误稍后重试
503服务过载稍后重试
使用手册

Google Gemini API 使用手册

一、概述

Google Gemini API 提供 Gemini 系列模型的访问,支持文本生成、多模态理解、代码执行、搜索增强、图像/视频/音乐生成等能力。以超长上下文(1M tokens)和丰富的多模态生态著称。

二、认证

API Key 方式(简单)

import google.generativeai as genai

genai.configure(api_key="YOUR_API_KEY")

API Key 在 Google AI Studio 创建。

服务账号方式(生产环境)

export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account.json"

三、Base URL

REST API: https://generativelanguage.googleapis.com/v1beta
OpenAI兼容: https://generativelanguage.googleapis.com/v1beta/openai

四、模型列表

模型ID上下文最大输出定位
gemini-3-pro1M64K最强推理
gemini-3-flash1M64K快速高效
gemini-2.5-pro1M64K上一代旗舰
gemini-2.5-flash1M64K上一代快速
gemini-3-pro-vision1M64K多模态专用
text-embedding-004--文本嵌入

五、文本生成

import google.generativeai as genai

genai.configure(api_key="YOUR_API_KEY")
model = genai.GenerativeModel('gemini-3-pro')

# 单次生成
response = model.generate_content(
    "解释量子计算的原理",
    generation_config=genai.types.GenerationConfig(
        temperature=0.7,
        top_p=0.95,
        top_k=40,
        max_output_tokens=2048,
        candidate_count=1
    )
)
print(response.text)

参数说明

参数类型说明
temperaturefloat0-2,默认1
top_pfloat核采样,0-1,默认0.95
top_kintTop-K采样,默认40
max_output_tokensint最大输出token数
candidate_countint候选回复数,默认1
stop_sequenceslist停止序列
response_mime_typestring"text/plain" 或 "application/json"

六、多轮对话

chat = model.start_chat(history=[])

response1 = chat.send_message("我想学习Python")
response2 = chat.send_message("推荐一些入门项目")

# 查看历史
for msg in chat.history:
    print(f"{msg.role}: {msg.parts[0].text}")

七、系统指令

model = genai.GenerativeModel(
    'gemini-3-pro',
    system_instruction=[
        "你是一位专业的Python讲师。",
        "回答使用Markdown格式,包含代码示例。",
        "语气友好且专业。"
    ]
)

八、多模态输入

图像

import PIL.Image

img = PIL.Image.open('photo.jpg')
response = model.generate_content(["描述这张图片", img])

多图

img1 = PIL.Image.open('img1.jpg')
img2 = PIL.Image.open('img2.jpg')
response = model.generate_content([
    "比较这两张图片的异同",
    img1, img2
])

视频

# 上传视频文件
video = genai.upload_file("video.mp4")

# 等待处理完成
while video.state.name == "PROCESSING":
    time.sleep(5)
    video = genai.get_file(video.name)

response = model.generate_content([
    "总结这个视频的内容",
    video
])

音频

audio = genai.upload_file("speech.mp3")
response = model.generate_content([
    "转录这段音频",
    audio
])

九、搜索增强(Grounding)

response = model.generate_content(
    "2026年最新的AI新闻",
    tools="google_search_retrieval"
)
# 回答中包含搜索来源引用

十、代码执行

response = model.generate_content(
    "计算斐波那契数列前100项的和",
    tools="code_execution"
)
# 模型自动编写并执行Python代码

十一、图像生成(多模态输出)

from google import genai
from google.genai import types

client = genai.Client()

response = client.models.generate_content(
    model="gemini-3-pro",
    contents="生成一张日落风景画",
    config=types.GenerateContentConfig(
        response_modalities=["TEXT", "IMAGE"]
    )
)

十二、文件上传与RAG

# 上传文件
file = genai.upload_file("document.pdf",
    mime_type="application/pdf"
)

# 缓存大文件(减少重复上传费用)
cache = genai.caching.CachedContent.create(
    model="gemini-3-pro",
    contents=[file],
    ttl=datetime.timedelta(hours=2)
)

model = genai.GenerativeModel.from_cached_content(cache)
response = model.generate_content("总结文档要点")

十三、流式输出

response = model.generate_content("写一首诗", stream=True)
for chunk in response:
    print(chunk.text, end="")

十四、定价

模型输入(≤128K)输入(>128K)输出
Gemini 3 Pro$1.25/1M$2.50/1M$5.00/1M
Gemini 3 Flash$0.15/1M$0.30/1M$0.60/1M

免费额度:15 RPM, 1M TPM, 1500 RPD(Flash模型)

十五、错误码

状态码含义处理
400请求错误检查参数
403权限不足检查API Key/配额
429速率限制退避重试
500内部错误稍后重试
503服务不可用稍后重试
使用手册

Midjourney 使用手册

一、概述

Midjourney 是基于AI的图像生成平台,通过文本提示词创建高质量艺术作品。当前版本 V6.1,同时提供 Niji 6 动漫专用模型。平台通过 Discord 运行,支持 Web 界面编辑。

二、入门配置

注册与订阅

  1. 访问 midjourney.com 注册
  2. 加入官方 Discord 服务器
  3. 选择订阅方案

订阅方案

方案月费快速时长最大并发隐身模式
Basic$10约200分钟3
Standard$3015小时3
Pro$6030小时12
Mega$12060小时12

三、核心命令

命令语法说明
生成图像/imagine prompt:描述根据提示词生成4张图
混合图片/blend 图片1 图片2混合2-5张图片
描述图片/describe上传图片反推提示词
缩短提示词/shorten prompt:描述精简提示词
查看信息/info查看订阅和用量
设置/settings模型版本等偏好设置
帮助/help帮助信息

四、生成后操作

按钮说明
U1-U4放大对应位置的图片(单独输出)
V1-V4基于对应图片生成变体
Vary (Strong)大幅修改(放大后可用)
Vary (Subtle)微调修改
Vary (Region)局部重绘(选中区域修改)
Zoom Out 2x画面缩小2倍
Zoom Out 1.5x画面缩小1.5倍
Pan ←↑→↓向指定方向扩展画面
⬆️ Web在Web界面中打开编辑

五、参数完整列表

参数语法默认值说明
宽高比--ar W:H1:1图片宽高比
混沌度--c 0-1000结果随机性
风格化--s 0-1000100艺术化程度
风格--style raw-减少默认美化
负面提示--no item1, item2-排除元素
图片权重--iw 0-21图片提示的影响力
种子--seed 0-4294967295随机可复现生成
停止--stop 10-100100提前结束生成
平铺--tile-无缝平铺图案
版本--v 6.16.1模型版本
Niji--niji 6-动漫模型
角色参考--cref URL-角色一致性
角色权重--cw 0-1001000=仅脸, 100=脸+服装
风格参考--sref URL-风格一致性
风格权重--sw 0-1000100风格参考强度
重复--r 1-41一次生成多组

六、版本对比

版本启用方式特点
V6.1--v 6.1当前最新,细节精细,一致性好
V6--v 6文字渲染,提示词理解强
V5.2--v 5.2美学提升
Niji 6--niji 6动漫专用
Niji 6 cute--niji 6 --style cuteQ版可爱
Niji 6 expressive--niji 6 --style expressive表现力强
Niji 6 scenic--niji 6 --style scenic场景优先

七、提示词最佳实践

基本公式

主体 + 场景/环境 + 光照/氛围 + 风格/媒介 + 参数

示例

/imagine prompt: a lone samurai standing on a cliff edge, cherry blossoms in wind, golden hour cinematic lighting, ukiyo-e style with modern colors, highly detailed --ar 16:9 --s 750 --v 6.1

技巧

  • 英文提示词效果优于中文
  • 用逗号分隔关键词,不要写长句
  • 材质词提升质感:crystal, marble, neon, holographic
  • 镜头词控制构图:close-up, wide angle, bird's eye, macro
  • 艺术家参考设定风格:in the style of Greg Rutkowski
  • 用 --no 排除不需要的元素
  • 迭代优化:生成 → 选择最佳 → 变体 → 放大 → 局部修改

八、角色一致性工作流

  1. 生成满意的角色图
  2. 复制该图的URL
  3. 在后续提示词中使用 --cref URL --cw 100
  4. 保持提示词中角色描述一致
  5. 可同时使用 --sref 保持风格一致

九、常见问题

Q: 快速时长用完了怎么办?
A: 切换到 Relax 模式(Standard及以上),生成时间约1-2分钟。

Q: 可以商用吗?
A: Pro及Mega方案生成的图片可商用。General商用条款需遵守。

Q: 如何获取图片URL?
A: 点击生成的图片 → 右键 → 复制图片地址。

Q: 生成的图片有手部问题怎么办?
A: V6.1大幅改善了手部,用 --style raw 减少风格化干扰,或使用 Vary (Region) 局部重绘手部。

使用手册

通义千问 API 使用手册

一、概述

通义千问是阿里云推出的大语言模型服务,提供 Qwen 系列模型的 API 访问。兼容 OpenAI API 格式,支持文本生成、对话、函数调用、长文档理解、图像理解、语音合成等能力。以超高性价比和完善的中文能力著称。

二、认证

通过阿里云 DashScope 平台管理 API Key:

Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxx

API Key 在 DashScope 控制台 创建。

三、Base URL

OpenAI兼容格式:https://dashscope.aliyuncs.com/compatible-mode/v1
原生格式:https://dashscope.aliyuncs.com/api/v1

四、模型列表

模型ID上下文最大输出说明
qwen-max128K8K旗舰模型,最强能力
qwen-plus128K8K能力与性价比均衡
qwen-turbo128K8K快速响应,低成本
qwen-long1M6K超长上下文专用
qwen-vl-max32K8K多模态旗舰
qwen-vl-plus32K8K多模态均衡
qwen2.5-coder-32b128K8K代码专用
qwen-audio-turbo8K2K语音理解
text-embedding-v38K-文本嵌入

五、使用 OpenAI SDK 调用

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxx",
    base_url="https://dashscope.aliyuncs.com/compatible-mode/v1"
)

response = client.chat.completions.create(
    model="qwen-max",
    messages=[
        {"role": "system", "content": "你是通义千问助手。"},
        {"role": "user", "content": "你好!"}
    ],
    temperature=0.7,
    top_p=0.8,
    max_tokens=2048,
    stream=False
)
print(response.choices[0].message.content)

六、cURL 调用示例

curl https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions 
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" 
  -H "Content-Type: application/json" 
  -d '{
    "model": "qwen-max",
    "messages": [
      {"role": "user", "content": "你好"}
    ]
  }'

七、流式输出

stream = client.chat.completions.create(
    model="qwen-max",
    messages=[{"role": "user", "content": "写一首诗"}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

八、Function Calling

tools = [{
    "type": "function",
    "function": {
        "name": "get_weather",
        "description": "获取天气信息",
        "parameters": {
            "type": "object",
            "properties": {
                "city": {"type": "string", "description": "城市名"}
            },
            "required": ["city"]
        }
    }
}]

response = client.chat.completions.create(
    model="qwen-max",
    messages=[{"role": "user", "content": "上海今天天气如何?"}],
    tools=tools,
    tool_choice="auto"
)

九、多模态(图像理解)

import base64

with open("image.jpg", "rb") as f:
    img_b64 = base64.b64encode(f.read()).decode()

response = client.chat.completions.create(
    model="qwen-vl-max",
    messages=[{
        "role": "user",
        "content": [
            {"type": "image_url", "image_url": {"url": f"data:image/jpeg;base64,{img_b64}"}},
            {"type": "text", "text": "描述这张图片"}
        ]
    }]
)

十、超长上下文(qwen-long)

response = client.chat.completions.create(
    model="qwen-long",
    messages=[
        {"role": "system", "content": "你是一个文档分析助手。"},
        {"role": "user", "content": very_long_text}  # 支持百万级token
    ],
    max_tokens=4096
)

十一、定价

模型输入价格输出价格
qwen-max¥20/1M tokens¥60/1M tokens
qwen-plus¥4/1M tokens¥12/1M tokens
qwen-turbo¥1/1M tokens¥3/1M tokens
qwen-long¥0.5/1M tokens¥2/1M tokens

新用户赠送 100 万 tokens 免费额度。

十二、速率限制

层级TPMRPM
免费60,00060
付费300,000300

十三、错误码

状态码含义处理
400请求格式错误检查参数
401API Key 无效检查密钥
429速率限制/额度不足退避重试或充值
500服务端错误稍后重试
使用手册

百度文心一言 API 使用手册

一、概述

文心一言(ERNIE Bot)是百度推出的大语言模型服务,提供 ERNIE 系列模型的 API 访问。支持文本生成、对话、函数调用、图像理解、文生图等能力。国内首批通过大模型备案,企业级服务成熟。

二、认证

采用 Access Token 方式认证,通过 API Key + Secret Key 获取:

# 获取 Access Token
curl https://aip.baidubce.com/oauth/2.0/token 
  -d "grant_type=client_credentials&client_id=YOUR_API_KEY&client_secret=YOUR_SECRET_KEY"

# 返回
{"access_token": "24.xxxxxxxxxxxx", "expires_in": 2592000}

Access Token 有效期30天,建议缓存复用。

API Key 和 Secret Key 在 千帆控制台 创建。

三、Base URL

https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop

四、模型列表

模型端点路径上下文说明
ERNIE 4.0/chat/completions_pro128K旗舰模型
ERNIE 3.5/chat/completions96K通用模型
ERNIE Speed/chat/ernie-speed-128k128K快速模型
ERNIE Lite/chat/ernie-lite-8k8K轻量模型
ERNIE Character/chat/ernie-char-8k8K角色扮演
ERNIE Functions/chat/ernie-func-8k8K函数调用
ERNIE-ViLG/txt2img-文生图

五、Chat 请求

POST https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions_pro?access_token=xxx

{
  "messages": [
    {"role": "user", "content": "你好"}
  ],
  "temperature": 0.7,
  "top_p": 0.9,
  "max_output_tokens": 2048,
  "stream": false,
  "system": "你是文心一言助手"
}

参数说明

参数类型必填说明
messagesarray消息数组
temperaturefloat0-1,默认0.95
top_pfloat0-1,默认0.7
max_output_tokensint最大输出
streambool流式输出
systemstring系统提示词
functionsarray函数定义(Function Calling)
penalty_scorefloat1-2,重复惩罚

响应

{
  "id": "as-xxx",
  "object": "chat.completion",
  "created": 1717100000,
  "result": "你好!我是文心一言,有什么可以帮你的?",
  "is_truncated": false,
  "need_clear_history": false,
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 15,
    "total_tokens": 20
  }
}

六、Function Calling

"functions": [{
  "name": "get_weather",
  "description": "获取天气信息",
  "parameters": {
    "type": "object",
    "properties": {
      "city": {"type": "string", "description": "城市名"}
    },
    "required": ["city"]
  }
}]

模型返回 function_call 字段时,执行对应函数并将结果追加到 messages 中继续对话。

七、流式输出

curl "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/completions_pro?access_token=xxx" 
  -H "Content-Type: application/json" 
  -d '{"messages":[{"role":"user","content":"你好"}],"stream":true}'

返回 Server-Sent Events (SSE) 格式数据流。

八、文生图

POST https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/txt2img?access_token=xxx

{
  "prompt": "一只在赛博朋克城市中的白色猫",
  "n": 1,
  "size": "1024x1024",
  "style": "vivid"
}

九、OpenAI 兼容模式

千帆平台同时提供 OpenAI 兼容接口,可直接使用 OpenAI SDK:

from openai import OpenAI

client = OpenAI(
    api_key="your-api-key",
    base_url="https://qianfan.baidubce.com/v1"
)

response = client.chat.completions.create(
    model="ernie-4.0-8k",
    messages=[{"role": "user", "content": "你好"}]
)

十、定价

模型输入价格输出价格
ERNIE 4.0¥30/1M tokens¥90/1M tokens
ERNIE 3.5¥4/1M tokens¥8/1M tokens
ERNIE Speed免费免费
ERNIE Lite免费免费

ERNIE Speed 和 ERNIE Lite 免费使用,适合开发测试。

十一、速率限制

层级RPMTPM
免费3-10限制较低
付费60-300按模型不同

十二、错误码

错误码含义处理
1参数错误检查请求参数
2服务暂不可用稍后重试
3权限不足检查 Access Token
17请求频率超限退避重试
18QPS 超限降低并发
110Access Token 无效重新获取
336100内容合规拦截修改输入内容
使用手册

字节豆包 API 使用手册

一、概述

豆包是字节跳动推出的大语言模型服务,提供 Doubao 系列模型的 API 访问。通过火山引擎平台调用,兼容 OpenAI API 格式。以极低价格和中文理解能力著称,Doubao-Pro 价格仅为同级别模型的十分之一。

二、认证

通过火山引擎 API Key 认证:

Authorization: Bearer xxxxxxxxxx

API Key 在 火山引擎方舟控制台 创建。

三、Base URL

OpenAI兼容格式:https://ark.cn-beijing.volces.com/api/v3

四、模型列表

模型ID上下文最大输出说明
doubao-1.5-pro-256k256K16K旗舰模型,超长上下文
doubao-1.5-pro-32k32K8K旗舰模型,标准版
doubao-1.5-lite-32k32K8K轻量模型,高性价比
doubao-1.5-vision-pro-32k32K8K多模态旗舰
doubao-1.5-vision-lite-32k32K4K多模态轻量
doubao-embedding--文本嵌入

五、使用 OpenAI SDK 调用

from openai import OpenAI

client = OpenAI(
    api_key="your-ark-api-key",
    base_url="https://ark.cn-beijing.volces.com/api/v3"
)

response = client.chat.completions.create(
    model="doubao-1.5-pro-32k",
    messages=[
        {"role": "system", "content": "你是豆包助手。"},
        {"role": "user", "content": "你好!"}
    ],
    temperature=0.7,
    max_tokens=2048
)
print(response.choices[0].message.content)

六、推理模型(深度思考)

response = client.chat.completions.create(
    model="doubao-1.5-pro-32k",
    messages=[{"role": "user", "content": "证明根号2是无理数"}],
    extra_body={
        "thinking": {"type": "enabled"},
        "reasoning_effort": "high"
    }
)

# 思考过程在 reasoning_content 中
print(response.choices[0].message.reasoning_content)
print(response.choices[0].message.content)

七、流式输出

stream = client.chat.completions.create(
    model="doubao-1.5-pro-32k",
    messages=[{"role": "user", "content": "解释量子计算"}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

八、Function Calling

tools = [{
    "type": "function",
    "function": {
        "name": "search_web",
        "description": "搜索互联网信息",
        "parameters": {
            "type": "object",
            "properties": {
                "query": {"type": "string", "description": "搜索关键词"}
            },
            "required": ["query"]
        }
    }
}]

response = client.chat.completions.create(
    model="doubao-1.5-pro-32k",
    messages=[{"role": "user", "content": "最新AI新闻"}],
    tools=tools,
    tool_choice="auto"
)

九、多模态(图像理解)

response = client.chat.completions.create(
    model="doubao-1.5-vision-pro-32k",
    messages=[{
        "role": "user",
        "content": [
            {"type": "image_url", "image_url": {"url": "https://example.com/photo.jpg"}},
            {"type": "text", "text": "描述这张图片"}
        ]
    }]
)

十、定价

模型输入价格输出价格说明
doubao-1.5-pro-32k¥4/1M tokens¥16/1M tokens旗舰级性价比
doubao-1.5-pro-256k¥8/1M tokens¥32/1M tokens超长上下文
doubao-1.5-lite-32k¥0.5/1M tokens¥2/1M tokens极低成本
doubao-1.5-vision-pro¥6/1M tokens¥24/1M tokens多模态

新用户赠送 50 万 tokens 免费额度。

十一、速率限制

层级RPMTPM
免费340,000
基础60300,000
标准3001,000,000

十二、错误码

状态码含义处理
400请求格式错误检查参数
401认证失败检查API Key
403权限不足开通模型访问权限
429速率限制退避重试
500服务端错误稍后重试
使用手册

智谱 GLM API 使用手册

一、概述

智谱 AI 推出的 GLM(General Language Model)系列大模型,提供从轻量到旗舰的完整模型矩阵。兼容 OpenAI API 格式,支持文本生成、对话、函数调用、图像理解、文生图、代码执行等能力。GLM-4V 多模态模型支持超高分辨率图像理解。

二、认证

Authorization: Bearer xxxxxxxxxx.xxxxxxxx

API Key 在 智谱开放平台 创建。

三、Base URL

https://open.bigmodel.cn/api/paas/v4

四、模型列表

模型ID上下文最大输出说明
glm-5128K16K最新旗舰
glm-4-plus128K8K上一代旗舰
glm-4-flash128K8K免费模型
glm-4-air128K8K高性价比
glm-4-long1M8K超长上下文
glm-4v-plus8K4K多模态旗舰
glm-4v-flash8K4K多模态免费
cogview-4--文生图
embedding-3--文本嵌入

五、使用 OpenAI SDK 调用

from openai import OpenAI

client = OpenAI(
    api_key="your-zhipu-api-key",
    base_url="https://open.bigmodel.cn/api/paas/v4"
)

response = client.chat.completions.create(
    model="glm-5",
    messages=[
        {"role": "system", "content": "你是智谱AI助手。"},
        {"role": "user", "content": "你好!"}
    ],
    temperature=0.7,
    top_p=0.7,
    max_tokens=2048,
    stream=False
)
print(response.choices[0].message.content)

六、原生 SDK 调用

from zhipuai import ZhipuAI

client = ZhipuAI(api_key="your-api-key")

response = client.chat.completions.create(
    model="glm-5",
    messages=[{"role": "user", "content": "你好"}]
)
print(response.choices[0].message.content)

七、流式输出

response = client.chat.completions.create(
    model="glm-5",
    messages=[{"role": "user", "content": "写一首关于春天的诗"}],
    stream=True
)

for chunk in response:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

八、Function Calling

tools = [{
    "type": "function",
    "function": {
        "name": "query_weather",
        "description": "查询天气",
        "parameters": {
            "type": "object",
            "properties": {
                "location": {"type": "string", "description": "城市"}
            },
            "required": ["location"]
        }
    }
}]

response = client.chat.completions.create(
    model="glm-5",
    messages=[{"role": "user", "content": "北京天气"}],
    tools=tools
)

if response.choices[0].finish_reason == "tool_calls":
    tool_call = response.choices[0].message.tool_calls[0]
    # 执行函数并返回结果
    result = query_weather(json.loads(tool_call.function.arguments)["location"])
    
    follow_up = client.chat.completions.create(
        model="glm-5",
        messages=[
            {"role": "user", "content": "北京天气"},
            response.choices[0].message,
            {"role": "tool", "tool_call_id": tool_call.id, "content": result}
        ],
        tools=tools
    )

九、多模态(图像理解)

response = client.chat.completions.create(
    model="glm-4v-plus",
    messages=[{
        "role": "user",
        "content": [
            {"type": "image_url", "image_url": {"url": "https://example.com/photo.jpg"}},
            {"type": "text", "text": "详细描述这张图片"}
        ]
    }]
)

十、文生图(CogView)

response = client.images.generations(
    model="cogview-4",
    prompt="一只在水墨画风格的山间行走的猫",
    size="1024x1024"
)
print(response.data[0].url)

十一、定价

模型输入价格输出价格
glm-5¥30/1M tokens¥90/1M tokens
glm-4-plus¥25/1M tokens¥75/1M tokens
glm-4-flash免费免费
glm-4-air¥1/1M tokens¥1/1M tokens
glm-4-long¥1/1M tokens¥1/1M tokens
cogview-4¥0.05/张-

十二、速率限制

模型RPM(免费)RPM(付费)
glm-4-flash10100
glm-4-air560
glm-5560

十三、错误码

状态码含义处理
400参数错误检查请求格式
401认证失败检查API Key
429速率限制退避重试
1301内容合规拦截修改输入
1302模型过载稍后重试
使用手册

Moonshot Kimi API 使用手册

一、概述

Moonshot AI(月之暗面)推出的 Kimi 系列模型,以超长上下文和卓越的文档理解能力著称。Kimi K2 支持 128K 上下文,擅长处理长文档、学术论文、代码仓库等场景。兼容 OpenAI API 格式。

二、认证

Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API Key 在 Moonshot 开放平台 创建。

三、Base URL

https://api.moonshot.cn/v1

四、模型列表

模型ID上下文最大输出说明
kimi-k2128K8K最新旗舰
moonshot-v1-128k128K8K上一代旗舰
moonshot-v1-32k32K8K标准版
moonshot-v1-8k8K8K基础版

五、使用 OpenAI SDK 调用

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxx",
    base_url="https://api.moonshot.cn/v1"
)

response = client.chat.completions.create(
    model="kimi-k2",
    messages=[
        {"role": "system", "content": "你是 Kimi 智能助手。"},
        {"role": "user", "content": "你好!"}
    ],
    temperature=0.7,
    max_tokens=2048
)
print(response.choices[0].message.content)

六、cURL 调用示例

curl https://api.moonshot.cn/v1/chat/completions 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer $MOONSHOT_API_KEY" 
  -d '{
    "model": "kimi-k2",
    "messages": [
      {"role": "user", "content": "你好"}
    ]
  }'

七、流式输出

stream = client.chat.completions.create(
    model="kimi-k2",
    messages=[{"role": "user", "content": "解释量子纠缠"}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

八、Function Calling

tools = [{
    "type": "function",
    "function": {
        "name": "search_web",
        "description": "搜索互联网",
        "parameters": {
            "type": "object",
            "properties": {
                "query": {"type": "string", "description": "搜索词"}
            },
            "required": ["query"]
        }
    }
}]

response = client.chat.completions.create(
    model="kimi-k2",
    messages=[{"role": "user", "content": "搜索最新的AI新闻"}],
    tools=tools,
    tool_choice="auto"
)

九、文件处理(核心特色)

Kimi 支持上传文件并在对话中引用,适合长文档分析:

# 1. 上传文件
file = client.files.create(
    file=open("paper.pdf", "rb"),
    purpose="file-extract"
)

# 2. 获取文件内容
file_content = client.files.content(file.id)
text = file_content.text

# 3. 在对话中使用
response = client.chat.completions.create(
    model="kimi-k2",
    messages=[
        {"role": "system", "content": "你是文档分析助手。"},
        {"role": "user", "content": f"以下是文档内容:n{text}nn请总结要点。"}
    ]
)

支持格式:PDF、Word、Excel、PPT、TXT、Markdown、CSV 等。

十、定价

模型输入价格输出价格
kimi-k2¥12/1M tokens¥36/1M tokens
moonshot-v1-128k¥14/1M tokens¥42/1M tokens
moonshot-v1-32k¥6/1M tokens¥18/1M tokens
moonshot-v1-8k¥4/1M tokens¥12/1M tokens

十一、速率限制

模型RPMTPM并发
moonshot-v1-8k30300,0005
moonshot-v1-32k30300,0005
moonshot-v1-128k10300,0003
kimi-k210300,0003

十二、错误码

状态码含义处理
400参数错误检查请求
401认证失败检查API Key
429速率限制退避重试
500服务端错误稍后重试
使用手册

MiniMax API 使用手册

一、概述

MiniMax 是国内领先的 AI 模型服务商,提供文本生成、语音合成(TTS)、语音识别(ASR)、音乐生成、视频生成等全栈 AI 能力。以语音合成质量业界领先著称,同时提供高性价比的文本模型。兼容 OpenAI API 格式。

二、认证

Authorization: Bearer xxxxxxxxxx.xxxxxxxx

API Key 在 MiniMax 开放平台 创建。

三、Base URL

https://api.minimax.chat/v1

四、模型列表

模型ID上下文最大输出说明
MiniMax-M2.7128K8K最新旗舰文本模型
abab6.5s-chat128K8K上一代快速模型
abab6.5g-chat32K8K上一代旗舰
speech-01-turbo--语音合成(TTS)
speech-01--高质量语音合成
video-01--视频生成
music-01--音乐生成

五、文本生成

from openai import OpenAI

client = OpenAI(
    api_key="your-minimax-api-key",
    base_url="https://api.minimax.chat/v1"
)

response = client.chat.completions.create(
    model="MiniMax-M2.7",
    messages=[
        {"role": "system", "content": "你是MiniMax助手。"},
        {"role": "user", "content": "你好!"}
    ],
    temperature=0.7,
    max_tokens=2048
)
print(response.choices[0].message.content)

六、语音合成(TTS)— 核心特色

MiniMax 的语音合成被认为是国内最自然的 TTS 服务之一:

POST https://api.minimax.chat/v1/t2a_v2?GroupId=your-group-id

{
  "model": "speech-01-turbo",
  "text": "你好,欢迎使用MiniMax语音合成服务。",
  "stream": false,
  "voice_setting": {
    "voice_id": "Chinese_Female_Gentle",
    "speed": 1.0,
    "vol": 1.0,
    "pitch": 0
  },
  "audio_setting": {
    "sample_rate": 32000,
    "format": "mp3"
  }
}

预设声音列表(部分)

voice_id风格
Chinese_Female_Gentle温柔女声
Chinese_Male_Storyteller沉稳男声
Chinese_Female_Vivid活泼女声
Chinese_Male_Calm平静男声
presenter_female主持女声
presenter_male主持男声

支持声音克隆:上传10-30秒音频即可创建自定义音色。

流式TTS

{
  "model": "speech-01-turbo",
  "text": "这是一段很长的文本...",
  "stream": true,
  "voice_setting": {
    "voice_id": "Chinese_Female_Gentle"
  }
}

返回 SSE 格式音频流,实现边生成边播放。

七、语音识别(ASR)

POST https://api.minimax.chat/v1/asr?GroupId=your-group-id

{
  "model": "speech-01",
  "file": "base64-encoded-audio",
  "language": "zh"
}

八、视频生成

POST https://api.minimax.chat/v1/video_generation

{
  "model": "video-01",
  "prompt": "一只猫在雨中撑伞漫步",
  "aspect_ratio": "16:9"
}

视频生成异步任务,需轮询查询状态。

九、音乐生成

POST https://api.minimax.chat/v1/music_generation

{
  "model": "music-01",
  "prompt": "轻快的电子音乐,节奏明快",
  "duration": 30
}

十、Function Calling

tools = [{
    "type": "function",
    "function": {
        "name": "get_stock_price",
        "description": "查询股票价格",
        "parameters": {
            "type": "object",
            "properties": {
                "symbol": {"type": "string", "description": "股票代码"}
            },
            "required": ["symbol"]
        }
    }
}]

response = client.chat.completions.create(
    model="MiniMax-M2.7",
    messages=[{"role": "user", "content": "茅台股价多少?"}],
    tools=tools
)

十一、定价

服务价格
MiniMax-M2.7 输入¥4/1M tokens
MiniMax-M2.7 输出¥12/1M tokens
TTS (speech-01-turbo)¥0.1/千字符
TTS (speech-01)¥0.2/千字符
声音克隆¥50/个音色
视频生成¥0.5/秒
音乐生成¥0.3/首(30秒)

十二、错误码

状态码含义处理
400参数错误检查请求
401认证失败检查API Key
429速率限制退避重试
500服务端错误稍后重试
使用手册

API密钥管理指南

API密钥管理指南

一、什么是 API 密钥

API 密钥(API Key)是调用 AI 模型服务的通行证,每个密钥对应一个独立账户,用于身份认证和用量统计。

二、获取密钥

模型平台获取地址注意
OpenAIplatform.openai.com需要国际信用卡
火山引擎console.volcengine.com新用户有免费额度
NVIDIA NIMcatalog.ngc.nvidia.com提供免费试用
硅基流动account.siliconflow.cn注册送额度
Groqconsole.groq.com免费额度充足

三、安全规范

风险说明防护措施
密钥泄露代码提交到 GitHub,密钥公开使用环境变量,不写进代码
用量超支密钥被他人滥用设置用量限额,及时轮换
跨平台混用一个密钥用于多个服务一个服务对应一个密钥

四、常见问题

1. 密钥显示无效怎么办?

检查密钥是否过期或被平台吊销,重新到对应平台控制台生成新密钥。

2. 费用异常如何处理?

第一时间在平台后台关闭密钥,排查用量记录,联系客服申诉。

使用手册

模型选择指南

模型选择指南

一、按任务类型选择

任务类型推荐模型原因
代码生成Claude 4.7 OpusSWE-bench Pro 64.3%,代码能力最强
长文档分析Gemini 3.1 Pro1M 上下文,科学推理 94.3%
中文内容豆包 Seed 2.0 Pro中文场景专项优化
成本敏感DeepSeek V4-Flash¥0.14/M tokens,性价比最高
快速响应GPT-5.5 Instant免费+极速,日常对话首选

二、性能对比

能力维度第1第2第3第4第5
推理能力ClaudeGPT-5.5GeminiQwenDeepSeek
代码能力ClaudeDeepSeek V4GPT-5.5QwenGemini
中文能力Qwen豆包DeepSeekGPT-5.5Claude
速度GPT-5.5 InstantDeepSeekQwenGeminiClaude
性价比DeepSeek豆包QwenGeminiClaude

三、模型特点详解

1. Claude 4.7 Opus

  • 优势:代码生成、复杂推理、长文本理解
  • 上下文:200K tokens
  • 适用场景:软件开发、技术文档、研究分析

2. GPT-5.5 Instant

  • 优势:响应速度快、免费额度充足
  • 上下文:128K tokens
  • 适用场景:日常对话、快速问答、内容生成

3. DeepSeek V4-Flash

  • 优势:成本极低、中文友好
  • 上下文:64K tokens
  • 适用场景:批量处理、成本敏感项目

4. Gemini 3.1 Pro

  • 优势:超长上下文、科学推理
  • 上下文:1M tokens
  • 适用场景:论文分析、多文档处理

四、使用建议

优先选择:复杂任务用 Claude,日常对话用 GPT-5.5 Instant,中文场景用豆包,成本敏感用 DeepSeek V4-Flash
使用手册

API 中转站使用指南

API 中转站使用指南

一、什么是 API 中转站

API 中转站(API Relay)统一管理多个 AI 平台的 API 分发,简化接入流程,支持密钥轮换和流量控制。

二、快速开始

步骤操作说明
1获取令牌在个人中心生成访问令牌
2配置模型选择需要的 AI 模型
3发起请求向中转站地址发送 API 请求
4查看用量在面板查看调用统计

三、支持的模型

模型状态说明
GPT-5.5可用最新 GPT 模型,速度快
Claude Opus 4.7可用代码能力强,推理优秀
DeepSeek V4可用性价比高,中文友好
Gemini 3.1 Pro可用长上下文,科学推理强
豆包 Seed 2.0可用国产优质模型

四、常见问题

1. 请求超时怎么办?

尝试切换模型或稍后重试,高峰期可能响应较慢。

2. 如何查看账单?

登录后在「用量统计」页面查看详细消费记录。

使用手册

One API 管理后台使用指南

One API 管理后台使用指南

一、One API 是什么

One API 是一款开源的 API 中转管理平台,支持多渠道统一管理、AI 模型接入与分发,适合个人或企业搭建 API 分发站。

二、核心功能

功能说明
渠道管理添加和管理不同的 AI API 渠道
令牌管理创建访问令牌,控制权限和额度
用量统计实时查看各渠道调用量和费用
智能路由根据负载自动分配请求到最优渠道

三、操作指南

1. 添加渠道

在「渠道」页面点击「新增渠道」,填写 API 端点、密钥和模型名称。

2. 创建令牌

在「令牌」页面创建新令牌,设置额度限制和有效期。

3. 查看日志

在「日志」页面查看每次 API 请求的详情,便于排查问题。


四、常见问题

1. 渠道显示离线?

检查密钥是否正确,API 端点是否可达,网络连接是否正常。

2. 如何限制用户额度?

在令牌管理中设置额度上限,超出后自动封禁该令牌。

使用手册

API密钥获取与使用完全指南

一、获取API密钥

使用EAKE AI平台的API服务,首先需要获取API密钥:

  1. 注册并登录 api.eake.cn
  2. 进入「令牌」页面,点击「创建新令牌」
  3. 设置令牌名称和额度,点击创建
  4. 复制生成的API密钥(仅显示一次,请妥善保存)

二、API基础调用

2.1 接口地址

https://api.eake.cn/v1/chat/completions

2.2 请求示例

curl https://api.eake.cn/v1/chat/completions -H Content-Type: application/json -H Authorization: Bearer YOUR_API_KEY -d {model:claude-sonnet-4-20250514,messages:[{role:user,content:hello}]}

2.3 Python调用

from openai import OpenAI
client = OpenAI(api_key=YOUR_API_KEY, base_url=https://api.eake.cn/v1)
response = client.chat.completions.create(model=claude-sonnet-4-20250514, messages=[{role:user,content:hello}])
print(response.choices[0].message.content)

三、支持的模型

  • Anthropic:Claude Opus 4、Sonnet 4、Sonnet 3.5
  • OpenAI:GPT-4.1、GPT-4.1 mini、o3
  • Google:Gemini 2.5 Pro、Gemini 2.5 Flash
  • 国产:DeepSeek R1、Qwen 3、GLM-5、Kimi K2

四、计费说明

平台采用预充值模式,按实际token用量计费。

五、常见问题

Q: 提示Insufficient quota怎么办?余额不足,请前往充值页面充值。

Q: 支持流式输出吗?支持,请求中设置stream:true即可。

使用手册

Hermes Agent 部署与配置完全指南

Hermes Agent 部署与配置完全指南

Hermes Agent 是 Nous Research 开发的开源 AI 智能体,支持15+平台接入,具备记忆、技能学习、语音交互等能力。本指南覆盖从零部署到生产使用的全流程。

一、环境要求

  • Python 3.11+
  • Node.js 20+(浏览器工具依赖)
  • Git、ffmpeg、ripgrep
  • uv 包管理器

二、一键安装

curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash

三、模型配置

运行 hermes model 交互式选择模型和 provider,或手动编辑 ~/.hermes/config.yaml

model:
  default: doubao-seed-2-0-pro-260215
  provider: custom
  base_url: " http://localhost:8866/v1\
 api_key: \your-api-key\
 context_length: 128000

四、平台接入

Hermes 支持 Telegram、Discord、微信、Slack 等 15+ 平台:

hermes gateway setup # 交互式配置
hermes gateway run # 前台运行
hermes gateway install # 安装为系统服务

五、语音功能

在 config.yaml 中添加:

voice:
 stt:
 enabled: true
 provider: local
 local:
 model: base
 tts:
 enabled: true
 provider: edge
 edge:
 voice: zh-CN-XiaoxiaoNeural

安装本地 STT:pip install faster-whisper

在聊天中发送 /voice on 启用语音模式。

六、Skills 管理

hermes skills list # 查看已装skills
hermes skills search \关键词\ # 搜索skills
hermes skills install identifier # 安装skill

七、Web UI 部署

npm install -g hermes-web-ui
hermes-web-ui start 8648 # 启动Web界面

配合 Nginx 反向代理即可对外提供 Web 访问。

常见问题

Q: 502 Bad Gateway?
A: 检查 hermes-web-ui 是否在运行,端口是否匹配 nginx 配置。

Q: 回复出现英文/配置内容?
A: 在 AGENTS.md 中添加强制中文和禁止输出文档的规则,并考虑升级模型。

Q: 语音不生效?
A: 确认 faster-whisper 已安装,voice 配置已写入,发送 /voice on 开启。

使用手册

Claude Code 终端编程完全指南

Claude Code 是 Anthropic 官方推出的终端编程工具,基于 Claude 3.5 Sonnet 模型,支持直接在命令行中与 AI 协作完成代码编写、调试、重构和解释等任务。

核心能力

  • 智能代码生成:通过自然语言描述需求,自动生成完整代码文件
  • 代码审查与优化:分析代码逻辑,提供改进建议和性能优化方案
  • 多轮对话迭代:支持持续对话,可完成从设计到实现的完整流程
  • 文件批量处理:支持一次处理多个文件,适合大型项目重构
  • 安全沙箱执行:所有代码操作在隔离环境中执行

安装方法

npm install -g @anthropic-ai/claude-code
npx claude-code

基本使用

claude-code
# 解释代码
"请解释 src/utils/auth.js 的工作原理"
# 重构代码
"将这个函数重构为 TypeScript,并添加类型注解"
# 写测试
"为这个模块生成 Jest 单元测试"

进阶技巧

  • 使用 @ 引用本地文件:@src/main.ts 请分析这个模块
  • 使用 /approval 查看所有待执行的写操作
  • 使用 /model 切换不同 Claude 模型
  • 设置 CLAUDE_API_KEY 环境变量使用自有 API Key

适用场景

  • 快速原型开发:用自然语言描述即可生成功能代码
  • 遗留代码维护:自动分析并重构老旧代码
  • 代码评审:辅助进行代码审查和 Bug 定位
  • 学习新技术:通过对话方式快速理解陌生代码库

Claude Code 是现代 AI 原生开发工具的代表,让开发者从繁琐的重复编码中解放出来,专注于更具创造性的工作。

使用手册

One API 中转站高可用部署方案

One API 是一个开源的 API 中转管理平台,支持将多个 AI 服务商的 API 统一接入,通过自定义渠道实现负载均衡、限流控制和成本优化。

架构设计

                    ┌─────────────┐
                    │   Nginx     │  (HTTPS 443)
                    └──────┬──────┘
                           │
        ┌──────────────────┼──────────────────┐
        │                  │                  │
  ┌─────▼─────┐      ┌────▼────┐      ┌─────▼─────┐
  │ One API 1 │      │ One API2│      │ One API 3│
  │  :3000    │      │  :3001   │      │  :3002   │
  └─────┬─────┘      └────┬────┘      └─────┬─────┘
        └──────────────────┼──────────────────┘
                           │
              ┌────────────▼────────────┐
              │      MySQL 共享存储       │
              └──────────────────────────┘

Docker Compose 部署

version: "3.8"
services:
  one-api:
    image: ssawing/one-api:latest
    container_name: one-api
    restart: unless-stopped
    ports:
      - "3000:3000"
    volumes:
      - ./data:/data
    depends_on:
      - mysql
  mysql:
    image: mysql:8.0
    container_name: one-api-mysql
    restart: unless-stopped
    environment:
      MYSQL_ROOT_PASSWORD: your_strong_password
      MYSQL_DATABASE: one_api
    volumes:
      - ./mysql:/var/lib/mysql

高可用配置要点

  • 多实例部署:通过 Nginx upstream 配置多个 One API 实例,轮询负载均衡
  • 会话共享:所有实例连接同一个 MySQL 数据库,渠道配置实时同步
  • 健康检查:Nginx upstream 配置 max_fails 和 fail_timeout,自动摘除故障节点
  • SSL 终端:在 Nginx 层处理 HTTPS,容器间通信走 HTTP
  • 数据持久化:MySQL 主从复制,One API /data 目录映射到宿主机

安全加固

  • 修改管理后台路径(如 /admin-secret-path/)防止扫描
  • 设置复杂的渠道 Token,定期轮换
  • 通过 Nginx limit_req 限制单 IP 请求频率
  • 配置 Key 鉴权白名单

高可用部署的核心是冗余 + 故障自动切换。生产环境建议使用 K8s 进行容器编排和自动恢复。

使用手册

Claude Code 完全指南 — 从安装到高效使用

Claude Code 完全指南

指南概述

Claude Code 完全指南 —— 从安装到高效使用 是一份从入门到精通的完整教程,帮助你快速掌握该工具的核心用法。

前置要求

  • 基础的命令行操作能力
  • 已安装必要的运行环境(如 Node.js、Python、Docker 等)
  • 拥有对应的 API 密钥或账号

安装步骤

  1. 环境准备:检查并安装所需依赖
  2. 获取凭证:注册账号并获取 API Key
  3. 初始化配置:按照向导完成初始设置
  4. 验证安装:运行测试命令确认可用

核心功能详解

本指南将逐一介绍各项核心功能的使用方法和最佳实践,包括但不限于:基本操作、高级配置、常见问题排查、性能优化建议等。

进阶技巧

  • 自定义快捷键和工作流
  • 与现有工具链的集成方案
  • 团队协作的最佳实践
  • 安全性和权限管理

故障排除

汇总了用户最常遇到的问题及其解决方案,包括网络连接问题、认证失败、输出异常等典型情况的排查思路。

使用手册

One API 部署指南 — 统一管理多个AI模型接口

One API 部署指南

指南概述

One API 部署指南 —— 统一管理多个AI模型接口 是一份从入门到精通的完整教程,帮助你快速掌握该工具的核心用法。

前置要求

  • 基础的命令行操作能力
  • 已安装必要的运行环境(如 Node.js、Python、Docker 等)
  • 拥有对应的 API 密钥或账号

安装步骤

  1. 环境准备:检查并安装所需依赖
  2. 获取凭证:注册账号并获取 API Key
  3. 初始化配置:按照向导完成初始设置
  4. 验证安装:运行测试命令确认可用

核心功能详解

本指南将逐一介绍各项核心功能的使用方法和最佳实践,包括但不限于:基本操作、高级配置、常见问题排查、性能优化建议等。

进阶技巧

  • 自定义快捷键和工作流
  • 与现有工具链的集成方案
  • 团队协作的最佳实践
  • 安全性和权限管理

故障排除

汇总了用户最常遇到的问题及其解决方案,包括网络连接问题、认证失败、输出异常等典型情况的排查思路。

使用手册

Gemini CLI 快速上手 — Google免费AI编程助手

Gemini CLI 快速上手

指南概述

Gemini CLI 快速上手 —— Google免费AI编程助手 是一份从入门到精通的完整教程,帮助你快速掌握该工具的核心用法。

前置要求

  • 基础的命令行操作能力
  • 已安装必要的运行环境(如 Node.js、Python、Docker 等)
  • 拥有对应的 API 密钥或账号

安装步骤

  1. 环境准备:检查并安装所需依赖
  2. 获取凭证:注册账号并获取 API Key
  3. 初始化配置:按照向导完成初始设置
  4. 验证安装:运行测试命令确认可用

核心功能详解

本指南将逐一介绍各项核心功能的使用方法和最佳实践,包括但不限于:基本操作、高级配置、常见问题排查、性能优化建议等。

进阶技巧

  • 自定义快捷键和工作流
  • 与现有工具链的集成方案
  • 团队协作的最佳实践
  • 安全性和权限管理

故障排除

汇总了用户最常遇到的问题及其解决方案,包括网络连接问题、认证失败、输出异常等典型情况的排查思路。

使用手册

Cursor AI 使用手册 — AI驱动的代码编辑器

Cursor AI 使用手册

指南概述

Cursor AI 使用手册 —— AI驱动的代码编辑器 是一份从入门到精通的完整教程,帮助你快速掌握该工具的核心用法。

前置要求

  • 基础的命令行操作能力
  • 已安装必要的运行环境(如 Node.js、Python、Docker 等)
  • 拥有对应的 API 密钥或账号

安装步骤

  1. 环境准备:检查并安装所需依赖
  2. 获取凭证:注册账号并获取 API Key
  3. 初始化配置:按照向导完成初始设置
  4. 验证安装:运行测试命令确认可用

核心功能详解

本指南将逐一介绍各项核心功能的使用方法和最佳实践,包括但不限于:基本操作、高级配置、常见问题排查、性能优化建议等。

进阶技巧

  • 自定义快捷键和工作流
  • 与现有工具链的集成方案
  • 团队协作的最佳实践
  • 安全性和权限管理

故障排除

汇总了用户最常遇到的问题及其解决方案,包括网络连接问题、认证失败、输出异常等典型情况的排查思路。

使用手册

OpenAI API 快速接入指南

OpenAI API 快速接入指南

指南概述

OpenAI API 快速接入指南 是一份从入门到精通的完整教程,帮助你快速掌握该工具的核心用法。

前置要求

  • 基础的命令行操作能力
  • 已安装必要的运行环境(如 Node.js、Python、Docker 等)
  • 拥有对应的 API 密钥或账号

安装步骤

  1. 环境准备:检查并安装所需依赖
  2. 获取凭证:注册账号并获取 API Key
  3. 初始化配置:按照向导完成初始设置
  4. 验证安装:运行测试命令确认可用

核心功能详解

本指南将逐一介绍各项核心功能的使用方法和最佳实践,包括但不限于:基本操作、高级配置、常见问题排查、性能优化建议等。

进阶技巧

  • 自定义快捷键和工作流
  • 与现有工具链的集成方案
  • 团队协作的最佳实践
  • 安全性和权限管理

故障排除

汇总了用户最常遇到的问题及其解决方案,包括网络连接问题、认证失败、输出异常等典型情况的排查思路。

使用手册

Docker入门 — AI项目容器化部署

Docker入门

指南概述

Docker入门 —— AI项目容器化部署 是一份从入门到精通的完整教程,帮助你快速掌握该工具的核心用法。

前置要求

  • 基础的命令行操作能力
  • 已安装必要的运行环境(如 Node.js、Python、Docker 等)
  • 拥有对应的 API 密钥或账号

安装步骤

  1. 环境准备:检查并安装所需依赖
  2. 获取凭证:注册账号并获取 API Key
  3. 初始化配置:按照向导完成初始设置
  4. 验证安装:运行测试命令确认可用

核心功能详解

本指南将逐一介绍各项核心功能的使用方法和最佳实践,包括但不限于:基本操作、高级配置、常见问题排查、性能优化建议等。

进阶技巧

  • 自定义快捷键和工作流
  • 与现有工具链的集成方案
  • 团队协作的最佳实践
  • 安全性和权限管理

故障排除

汇总了用户最常遇到的问题及其解决方案,包括网络连接问题、认证失败、输出异常等典型情况的排查思路。

使用手册

Claude Code 使用手册

Claude Code 是 Anthropic 推出的智能体式编程工具,可直接读取你的代码库、编辑文件、运行命令,并集成开发工具。支持终端、IDE 扩展、桌面应用与浏览器多种形态。

安装

  • macOS / Linux / WSL:curl -fsSL https://claude.ai/install.sh | bash
  • Windows PowerShell:irm https://claude.ai/install.ps1 | iex
  • Homebrew:brew install --cask claude-code
  • WinGet:winget install Anthropic.ClaudeCode

首次运行 claude 会引导登录(Claude 订阅或 Anthropic Console 账号),终端 CLI 与 VS Code 也支持第三方模型供应商。

快速开始

cd your-project
claude

常用能力

  • 多文件编辑与跨工具协作
  • 斜杠命令与权限审批
  • 第三方 Provider 接入(绕过官方登录)

适用场景:功能开发、Bug 修复、自动化重构与跨文件任务。

使用手册

Claude Desktop 使用手册

Claude Desktop 是 Anthropic 的桌面客户端,在 IDE / 终端之外以独立应用运行 Claude Code,可可视化查看 diff、并排多会话、定时任务与云端会话。

安装

  • macOS / Windows:从 Claude 官网下载安装包
  • 在桌面端登录 Claude 账号后即可使用

核心特性

  • 可视化 diff 审查代码改动
  • 多会话并排管理
  • 定时 recurring 任务
  • 启动云端会话(Cloud Sessions)

适用场景:不想依赖终端、希望图形化审查与多任务管理的开发者。

使用手册

OpenAI Codex CLI 使用手册

Codex CLI 是 OpenAI 官方的智能体式命令行编码工具,将 Codex 模型能力带入终端,支持代码读写、命令执行与多模态输入。

安装

npm install -g @openai/codex

需配置 OpenAI API Key(环境变量 OPENAI_API_KEY 或登录)。

常用命令

  • codex:启动交互式会话
  • codex exec "重构这个函数":一次性执行任务
  • codex --help:查看全部选项

配置

支持通过 ~/.codex/config.toml 配置模型、审批模式与网络访问策略。

适用场景:受 OpenAI 生态约束、需要官方 Codex 模型能力的终端工作流。

使用手册

Gemini CLI 使用手册

Gemini CLI 是 Google 开源的 AI 智能体,将 Gemini 模型能力直接带入终端,开源免费、支持超长上下文与多工具调用。

安装

npm install -g @google/gemini-cli
# 或免安装运行
npx @google/gemini-cli

需配置 Gemini API Key(GEMINI_API_KEY 或 Google 登录)。

常用命令

  • gemini:启动交互式会话
  • /help:查看斜杠命令
  • @path/to/file:在提示中引用文件
  • /chat save / /chat resume:保存与恢复会话

特性

  • 100 万 token 超长上下文
  • MCP 与扩展机制
  • 免费额度友好

适用场景:需要超长上下文、偏好 Google 模型与开源方案的开发者。

使用手册

OpenCode 使用手册

OpenCode 是一个开源的终端 AI 编码智能体,提供类 Cursor 的 TUI 交互体验,支持多种模型供应商与可扩展工具链。

安装

npm install -g opencode-ai

快速开始

opencode

启动后进入交互式 TUI,可选择模型供应商、会话管理与文件上下文。

核心特性

  • 终端 TUI 交互界面
  • 多模型 / 多 Provider 支持
  • 会话与上下文管理
  • 可扩展工具与技能

适用场景:喜欢终端 TUI、希望自托管与多模型切换的开发者。

使用手册

OpenClaw 使用手册

OpenClaw 是一个自托管的 AI 智能体多通道网关,可运行在任意操作系统,将 Discord、iMessage、Signal、Slack、Telegram、WhatsApp 等聊天应用连接到一个 Always-on 的 AI 助手。采用 MIT 开源协议。

环境要求

  • Node 24.15+(推荐),或 Node 22 LTS(22.22.3+),或 Node 25.9+
  • 一个 Provider 的 API Key
  • 约 5 分钟上手

安装与启动

openclaw onboard   # 引导式初始化
openclaw gateway   # 启动网关

核心能力

  • 多通道网关:单一 Gateway 同时服务所有已配置通道
  • 多智能体路由:按 agent / 工作区 / 发送者隔离会话
  • 媒体支持与插件通道(Matrix、Nostr、Twitch、Zalo 等)
  • 控制面板(Web Control UI)、CLI、移动节点

适用场景:希望把 AI 助手接入私人通讯软件、自托管且数据自主控制的开发者与高阶用户。

使用手册

Hermes Agent 使用手册

Hermes Agent 是一个面向任务自动化的 AI 智能体,支持模型路由、技能系统与记忆管理,可作为通用助手在终端中执行多步骤任务。

安装

npm install -g hermes-agent

快速开始

hermes

启动后可通过自然语言下达任务,支持工具调用、记忆与技能扩展。

核心特性

  • 技能系统(Skills)与记忆(Memory)管理
  • 多模型路由与 Provider 配置
  • 定时任务与子 Agent 编排

适用场景:需要可定制智能体、技能化工作流与长期记忆的自动化场景。

使用手册

Qoder CLI 使用手册

Qoder CLI 是 Qoder 提供的智能编程命令行工具,将 Qoder 的代码理解与生成能力带入本地终端工作流。

安装

npm install -g @qoder-ai/qodercli

快速开始

qoder

启动交互式会话后可直接对当前项目进行问答、改码与任务编排。

核心特性

  • 项目级代码理解与索引
  • 对话式改码与任务执行
  • 与 Qoder 平台能力联动

适用场景:偏好 Qoder 代码模型、希望在终端获得项目级智能编程支持的开发者。

使用手册

CodexHub CN 使用手册

📖 版本 v0.1.2 · 2026-07-18

CodexHub CN 使用手册

> 版本:v0.1.2 | 更新:2026-07-18 | 官网:https://agent.eake.cn/codexhub-cn/


目录

  1. 产品简介

  2. 下载与安装

  3. 首次启动

  4. 界面概览

  5. 工具管理

  6. Provider 与模型配置

  7. 聊天界面

  8. 斜杠命令

  9. MCP 管理

  10. 技能系统

  11. 截图工具

  12. 定时任务

  13. 账本功能

  14. Token 用量统计

  15. 设置与偏好

  16. 反馈与捐赠

  17. 版本更新

  18. 常见问题


1. 产品简介

1.1 什么是 CodexHub CN

CodexHub CN(CodexHub 中国版)是一款AI CLI 配置管理器,帮助开发者统一管理多款主流 AI Coding 工具的 API 配置,通过国内大模型 API 实现本地化工作流。

1.2 核心能力

能力说明
🔧 统一管理同时管理 8 款 AI CLI 工具的配置
🔄 一键切换在不同 Provider/模型之间秒级切换
💰 Token 统计实时记录每次 API 调用的用量与费用
🔌 MCP 扩展支持 MCP 服务器扩展工具能力
🎯 技能市场安装社区技能包,扩展工具能力
🛡️ 本地路由本地代理网关,API Key 不出本机
📊 账本功能记录使用账目,帮助成本管控
🖥️ 截图工具内置截图工具,辅助信息提取

1.3 支持的 CLI 工具

工具安装命令官方文档
Claude Codenpm install -g @anthropic-ai/claude-code<a href="https://code.claude.com/docs/en/cli-reference" target="blank" rel="noopener">官方文档
Claude Desktop<a href="https://claude.com/download" target="blank" rel="noopener">官方下载<a href="https://docs.anthropic.com/zh-CN/docs/claude-desktop" target="blank" rel="noopener">官方文档
Codex CLInpm install -g @openai/codex<a href="https://github.com/openai/codex" target="blank" rel="noopener">GitHub
Gemini CLInpm install -g @google/gemini-cli<a href="https://www.npmjs.com/package/@google/gemini-cli" target="blank" rel="noopener">npm
OpenCodenpm install -g opencode-ai<a href="https://github.com/opencode-ai/opencode" target="blank" rel="noopener">GitHub
OpenClawnpm install -g openclaw<a href="https://openclaw.ai" target="blank" rel="noopener">官网
Hermes Agentnpm install -g hermes-agent<a href="https://github.com/NousResearch/hermes-agent" target="blank" rel="noopener">GitHub
DeepSeek CLInpm install -g deepseekGitHub

1.4 系统要求

  • 操作系统:Windows 10/11(x64)

  • 磁盘空间:200MB+

  • 网络:需要访问目标 API(部分 Provider 需国际网络)


2. 下载与安装

2.1 下载地址

官网下载地址:https://agent.eake.cn/codexhub-cn/

提供三种安装包:

类型文件名说明
🪟 NSIS 安装包CodexHub CNx.x.xx64-setup.exe推荐,标准 Windows 安装向导
📦 MSI 安装包CodexHub CNx.x.xx64zh-CN.msi企业部署用,支持静默安装
💿 免安装版CodexHub CNx.x.x_x64-portable.zip解压即用,无需安装

2.2 安装步骤

NSIS 安装包(推荐):

  1. 下载 .exe 安装包

  2. 双击运行,点击「下一步」

  3. 选择安装路径(建议保持默认 C:Program FilesCodexHub CN

  4. 点击「安装」,等待完成

  5. 点击「完成」,启动 CodexHub CN

MSI 企业部署:

msiexec /i "CodexHub CNx.x.xx64_zh-CN.msi" /quiet

卸载方法:

  • 开始菜单 → CodexHub CN → 卸载

  • 或 Windows「设置」→「应用」→ 找到 CodexHub CN → 卸载


3. 首次启动

3.1 启动流程

首次启动会依次显示:

  1. 启动遮罩(约 7 秒)

- 显示进度条和加载提示

- 自动检测环境状态

  1. 环境检测

- 检测 Node.js 是否安装

- 检测各 CLI 工具是否已安装

- 检测 npm 全局目录

  1. 风险协议确认

- 首次必须阅读并勾选免责声明

- 双勾选后点击「我已阅读并同意」方可进入

  1. 欢迎/主界面

- 如果检测到未安装的工具,显示安装引导

- 如果环境正常,直接进入主界面

3.2 首次环境配置

启动后,CodexHub CN 会自动检测已安装的工具。未安装的工具会显示为红色状态,参考以下方式安装:

方式一:通过 CodexHub CN 一键安装

在工具列表中找到未安装的工具,点击绿色的「安装」按钮。

方式二:通过 npm 安装

npm install -g @anthropic-ai/claude-code

npm install -g @openai/codex

npm install -g @google/gemini-cli

npm install -g opencode-ai

npm install -g hermes-agent

npm install -g deepseek

> ⚠️ 注意:Claude Desktop 是图形化应用,需从官网下载安装包,不能通过 npm 安装。


4. 界面概览

4.1 主界面结构

┌──────────────────────────────────────────────────────────┐

│ [工具图标] CodexHub CN [⚙️] [💬] [🖼️] [📊] │ ← 顶部工具栏

├──────────┬───────────────────────────────────────────────┤

│ │ │

│ 工具列表 │ 主视图区域 │

│ (左侧) │ ┌─────────────────────────────────────────┐ │

│ │ │ 欢迎使用 CodexHub CN │ │

│ Claude │ │ ───────────────────────────── │ │

│ Claude │ │ 当前工具:Claude Code │ │

│ Desktop │ │ 模型:claude-sonnet-4-6 │ │

│ Codex │ │ Provider:Eake API │ │

│ Gemini │ └─────────────────────────────────────────┘ │

│ CLI │ │

│ OpenCode│ ┌─────────────────────────────────────────┐ │

│ OpenClaw│ │ 💬 聊天 / 📝 终端 切换 │ │

│ Hermes │ └─────────────────────────────────────────┘ │

│ DeepSeek│ │

│ │ ┌─────────────────────────────────────────┐ │

│ ────── │ │ [对话内容区域] │ │

│ [➕] │ │ │ │

│ │ └─────────────────────────────────────────┘ │

├──────────┴───────────────────────────────────────────────┤

│ Provider: Eake API | 模型: claude-sonnet-4-6 | Token 1.2K │ ← 底部状态栏

└──────────────────────────────────────────────────────────┘

4.2 顶部工具栏

图标名称功能
⚙️设置主题切换、缓存清理、关于
💬反馈提交问题或建议
🖼️截图启动截图工具(三件套)
📊账本查看使用账目与成本
🧩技能打开技能市场
🔌MCP管理 MCP 服务器
🤖AgentAgent 管理(版本升级等)
📦安装工具一键安装缺失的 CLI
🌐Provider添加/管理 API Provider
📢公告查看官方公告
捐赠支持项目发展

4.3 底部状态栏

显示当前活跃的:

  • Provider:当前使用的 API 来源

  • 模型:当前选中的模型

  • Token:本次会话累计 Token 消耗(点击可展开详情)


5. 工具管理

5.1 工具列表

左侧栏列出了所有 8 款支持的 CLI 工具。每款工具的状态指示:

状态颜色含义
🟢 绿色工具已安装且可用正常
🔴 红色工具未安装需安装
🟡 黄色工具已安装但无法运行检查 PATH 或版本
🟠 橙色可升级有新版本可用

5.2 一键安装

对于未安装的工具,点击工具卡片右侧的「安装」按钮,CodexHub CN 会自动调用 npm 安装对应工具包。

安装过程:

[████████████████████░░░░░] 80% — 安装 npm 包中...

5.3 版本检测

点击工具卡片的「🔄 刷新」按钮,可以重新检测该工具的本地版本和 npm 最新版本。

判断逻辑:

  • localVersion === npmVersion → 🟢 已是最新版

  • localVersion < npmVersion → 🟠 可升级

  • localVersion === null → 🔴 未安装

  • 获取 npm 版本失败 → 🟡 检测失败

5.4 一键升级

在工具列表中点击「全部升级」按钮,CodexHub CN 会自动将所有已安装但有可用更新的工具升级到最新版本。

5.5 诊断冲突

点击「🔎 一键检测」按钮,CodexHub CN 会扫描系统 PATH 和 npm 全局目录,检测以下问题:

  • 同一工具多处安装(PATH 重复)

  • 安装路径异常

  • 版本不一致

  • 命令无法直接运行

诊断结果以弹窗展示,显示每个工具的安装位置、版本和可运行状态。

5.6 卸载工具

在工具卡片上悬停,点击出现的「🗑️ 卸载」按钮。

> ⚠️ 注意:卸载操作只移除 npm 全局包,不影响本地项目中的安装。


6. Provider 与模型配置

6.1 什么是 Provider

Provider(服务商) 是 API 的来源。每个 Provider 包含:

  • 名称(如「火山引擎」「Eake API」)

  • API 地址(Base URL)

  • API Key

  • 可用模型列表

6.2 添加新 Provider

点击顶部「🌐 Provider」按钮 → 「➕ 添加 Provider」:

  1. 名称:填入服务商名称(如「我的火山引擎」)

  2. Base URL:API 接口地址(需包含 /v1 路径,如 https://ark.cn-beijing.volcengineapi.com/v1

  3. API Key:粘贴对应的 Key

  4. 图标:选择代表该 Provider 的 emoji 或图标

  5. 分类:Domestic(国内)/ International(国际)

点击「保存」。

6.3 模型选择

切换 Provider 后,点击模型下拉菜单可以看到该 Provider 支持的所有模型。

模型旁的标记含义:

标记含义
✅ 绿色支持 Function Calling(工具调用)
🟇 黄色支持聊天,但不支持工具调用
❌ 红色不支持聊天(嵌入/视觉/音频等专用模型)

能力标签

  • 代码 — 擅长代码生成

  • 推理 — 深度推理能力

  • 轻量 — 快速响应

  • 多模态 — 支持图文

  • 长上下文 — 超长上下文窗口

6.4 一键配置

对于常用的 Provider(如 Eake API、火山引擎等),CodexHub CN 提供了「一键配置」功能。

点击「🌐 Provider」→「⚡ 一键配置」,选择目标 Provider,填入 API Key,即可快速完成配置。

6.5 API Key 安全提示

  • API Key 不出本机:CodexHub CN 内置本地代理网关,所有 API 请求通过本地转发,Key 不明文暴露

  • Provider 隔离:不同 Provider 的 Key 独立存储,互不干扰

  • Key 隐藏:API Key 在界面上默认以 •••••••• 显示,点击眼睛图标可查看


7. 聊天界面

7.1 聊天模式

CodexHub CN 内置流式聊天,由 Rust 后端直接调用 API,将响应实时流式返回前端显示。

特点:

  • 实时流式输出,无需等待完整响应

  • Markdown 代码高亮

  • 支持表格、GFM 任务列表

  • 深色/浅色主题自适应

7.2 对话管理

  • 新建对话:点击输入框旁的「➕」或发送任意消息

  • 对话历史:左侧列表,按工具分组

  • 搜索历史:输入框上方搜索框搜索历史记录

  • 清除对话:输入 /clear 或点击工具栏清除按钮

7.3 会话持久化

CodexHub CN 自动保存对话历史到本地 SQLite 数据库。下次打开同一工具时,自动加载上次会话。


8. 斜杠命令

8.1 通用命令

以下斜杠命令在各工具中通用:

命令功能适用工具
/model切换模型全部
/help查看帮助全部
/clear清除对话全部
/costToken 用量统计全部
/status查看当前状态全部

8.2 Claude Code 专属命令

命令功能
/skills查看/安装技能
/memory管理项目记忆(CLAUDE.md)
/schedule设置定时任务
/plan生成执行计划
/compact压缩上下文,节省 Token
/init初始化项目配置
/review请求代码审查

8.3 Codex CLI 专属命令

命令功能
/goal设定长期目标
/skills技能市场
/init初始化项目
/plan生成执行计划

8.4 Gemini CLI 专属命令

命令功能
/skills扩展/Skills
/init初始化 GEMINI.md

8.5 OpenCode 专属命令

命令功能
/connect配置 API 提供商
/docs搜索文档
/skillsCode Skills

8.6 OpenClaw / Hermes Agent 专属命令

命令功能
/model切换模型
/terminal打开终端
/skills技能市场
/memory记忆管理
/schedule定时任务
/agent子 Agent

9. MCP 管理

9.1 什么是 MCP

MCP(Model Context Protocol) 是 Claude 官方推出的工具扩展协议,允许 AI 通过标准化接口调用外部工具(如数据库查询、Git 操作、API 调用等)。

9.2 MCP 预设市场

CodexHub CN 内置了常用 MCP 预设,点击「🔌 MCP」→「预设市场」,可以快速添加:

MCP 服务说明
GitHubGitHub API 操作(Issue、PR、文件)
PostgreSQL数据库查询
Puppeteer浏览器自动化
Filesystem本地文件读写
搜索搜索集成

9.3 添加自定义 MCP

点击「🔌 MCP」→「自定义」:

  1. 填写 MCP 服务名称

  2. 粘贴 MCP 服务器启动命令(通常是 npx @xxx/server-xxx

  3. 点击「添加」

9.4 启动与停止

每个 MCP 服务器可独立启动/停止:

  • 绿色 🟢 — 运行中

  • 灰色 ⚪ — 已停止

  • 红色 🔴 — 启动失败


10. 技能系统

10.1 什么是技能

技能(Skill) 是预置的 Markdown 指南文件,告诉 AI 如何处理特定任务。技能以自然语言触发,AI 会自动识别并应用。

示例技能:

  • code-review — 代码审查技能

  • firecrawl — 网页爬取技能

  • terminal-orchestration — 终端编排技能

10.2 技能市场

点击顶部「🧩 技能」按钮,进入技能市场:

分类筛选:全部 / 工具 / 效率 / 开发 / DevOps

安装技能

  1. 在技能市场找到目标技能

  2. 点击「安装到 CodexHub CN

  3. 等待安装完成(App 自动唤起并处理)

10.3 技能安装方式

方式说明
npm 安装安装为全局 npm 包,技能文件存储在 npm 包目录
ZIP 安装下载技能 ZIP 包,解压到本地技能目录
纯展示仅浏览,不安装

10.4 管理已安装技能

点击「🧩 技能」→「已安装」,可查看所有已安装技能。


11. 截图工具

11.1 功能概览

CodexHub CN 内置截图工具,提供三个核心功能:

功能说明快捷操作
截图截取屏幕任意区域点击顶部「🖼️」按钮
保存双击选区保存截图选中区域后双击
复制复制到剪贴板Ctrl+C 或点击复制按钮

11.2 使用方法

第一步:启动截图

点击顶部工具栏的「🖼️ 截图」按钮,屏幕变暗,出现十字光标。

第二步:绘制选区

  • 鼠标拖拽:绘制矩形选区

  • 8 个把手:选区四角和四边中点,可单独拖动调整大小

  • 整框拖动:在选区内部按住拖动,可整体移动位置

  • 最小尺寸:10×10 像素

第三步:保存

  • 双击选区:自动裁剪并保存到本地图片目录

  • Ctrl+C:复制截图到剪贴板

  • Esc:取消截图

11.3 缩放与拖动技巧

操作方法
调整宽度拖动左右两侧中点把手
调整高度拖动上下两侧中点把手
调整大小拖动四角把手
移动选区在选区内部拖动
等比缩放拖动角把手时按住 Shift

12. 定时任务

12.1 功能说明

CodexHub CN 支持设置定时任务,在指定时间自动执行 AI 对话任务。

12.2 创建定时任务

  1. 在聊天界面输入框输入 /schedule

  2. 或点击顶部「📅」定时任务按钮

  3. 设置任务内容、触发时间和重复规则

  4. 保存

12.3 支持的触发规则

类型说明
一次性在指定时间执行一次
每天每天固定时间执行
每周每周指定星期几执行
Cron 表达式自定义复杂触发规则

12.4 任务管理

在定时任务管理界面可以:

  • 查看 — 查看所有已创建的任务

  • 编辑 — 修改任务内容或触发时间

  • 暂停 — 临时停止某个任务

  • 删除 — 删除不再需要的任务


13. 账本功能

13.1 功能说明

账本记录每次 API 调用的详细费用,帮助追踪和控制使用成本。

13.2 访问账本

点击顶部「📊 账本」按钮。

13.3 账本内容

字段说明
日期调用发生的日期和时间
工具使用的是哪款 CLI 工具
模型调用的具体模型
输入 Token发送给 API 的 Token 数
输出 TokenAPI 返回的 Token 数
费用本次调用消耗的金额(按 Provider 单价计算)
ProviderAPI 来源

13.4 成本统计

账本顶部显示汇总数据:

  • 今日消费:当天累计费用

  • 本月消费:当月累计费用

  • 总消费:所有记录累计费用

支持按 Provider、按工具、按时间段筛选。


14. Token 用量统计

14.1 实时统计

底部状态栏实时显示当前会话的 Token 消耗。点击展开详情:

指标说明
输入 TokenInput Tokens
输出 TokenOutput Tokens
缓存命中Cache Hits(节省的费用)
当前费用按 Provider 单价计算
会话时长本次会话持续时间

14.2 历史统计

在「📊 账本」页面查看历史 Token 用量趋势图,支持按天/周/月聚合展示。


15. 设置与偏好

15.1 主题切换

点击「⚙️ 设置」→「🎨 主题」,在以下主题间切换:

主题说明
🌙 深色(默认)赛博朋克风格,cyan #00f0ff + purple #a855f7
☀️ 浅色明亮主题,适合白天或高亮环境

15.2 清除缓存

点击「⚙️ 设置」→「🗑️ 清除缓存」,可清除:

  • WebView 缓存(解决界面显示异常)

  • 临时文件

  • 历史对话缓存

> 💡 提示:清除 WebView 缓存后,部分页面需要重新加载,请耐心等待。

15.3 诊断工具冲突

点击「⚙️ 设置」→「🔎 诊断工具冲突」,执行完整的环境诊断(等同于工具页的「一键检测」)。

15.4 关于 CodexHub CN

点击「⚙️ 设置」→「ℹ️ 关于」,查看:

  • 当前版本号

  • 更新日志

  • 项目简介

  • 开源许可


16. 反馈与捐赠

16.1 提交反馈

点击顶部「💬 反馈」按钮,填写:

  1. 反馈类型:Bug 问题 / 功能建议 / 其他

  2. 联系方式(选填):邮箱或微信

  3. 详细描述:请尽量描述清楚问题现象、期望行为和复现步骤

16.2 捐赠支持

点击顶部「☕ 捐赠」按钮,支持项目发展。目前支持的捐赠方式:

  • 💚 微信支付

  • 💙 支付宝


17. 版本更新

17.1 检查更新

CodexHub CN 会在启动时自动检查更新。也可以手动检查:

点击「⚙️ 设置」→「🔄 检查更新」

17.2 更新弹窗

发现新版本时,会弹出更新提示:

  • 显示当前版本和新版本号

  • 显示更新日志

  • 提供「立即下载」和「稍后」按钮

17.3 下载安装

点击「立即下载」后,CodexHub CN 会:

  1. 从官网下载最新安装包

  2. 显示下载进度条

  3. 下载完成后自动启动安装程序

  4. 覆盖安装当前版本(用户数据不丢失)


18. 常见问题

Q1:启动后显示白屏怎么办?

原因:WebView 缓存损坏

解决

  1. 点击「⚙️ 设置」→「🗑️ 清除缓存」→「清除 WebView 缓存」

  2. 重启 CodexHub CN

  3. 如果仍有问题,手动删除 %LOCALAPPDATA%com.codexhubcn.appEBWebView 目录

Q2:工具显示红色"未安装"但已通过 npm 安装?

原因:npm 全局目录未加入系统 PATH

解决

  1. 点击工具列表的「🔎 一键检测」

  2. 查看诊断结果中的安装路径

  3. 将 npm 全局路径(如 C:Users你的用户名AppDataRoamingnpm)加入系统 PATH

  4. 重启 CodexHub CN

Q3:聊天发送消息后没有响应?

排查步骤

  1. 检查底部状态栏 Provider 是否配置了正确的 API Key

  2. 检查网络连接(部分 Provider 需要访问国际网络)

  3. 查看底部 Token 统计是否有报错信息

  4. 点击「⚙️ 设置」→「🔎 诊断工具冲突」检查环境

Q4:API Key 填了但模型下拉是空的?

原因:Provider 的 Base URL 格式不正确或 Key 无效

解决

  1. 确认 Base URL 包含完整路径(必须以 /v1 结尾)

  2. 确认 API Key 格式正确(UUID / sk-xxx 等)

  3. 尝试重新保存 Provider

Q5:MCP 服务器启动失败?

常见原因

  • npm 包未安装:运行 npm install -g @modelcontextprotocol/server-xxx

  • 网络问题:部分 MCP 服务器需要从 npm 安装

  • 权限不足:尝试以管理员身份启动 CodexHub CN

Q6:截图工具无法使用?

排查

  1. 确保已安装 Tauri WebView2 运行时

  2. 检查是否被安全软件拦截

  3. 尝试重启 CodexHub CN

Q7:如何查看详细的 Token 用量和费用?

点击底部状态栏的 Token 数字,或点击顶部「📊 账本」,可以查看完整的调用明细和费用汇总。

Q8:想同时使用多个工具的多个 API Key?

CodexHub CN 支持添加多个 Provider,每个 Provider 独立存储 API Key。在工具配置中选择对应的 Provider 即可。

Q9:技能无法安装?

排查

  1. 检查网络连接

  2. 确认 npm 可用(部分技能通过 npm 安装)

  3. 尝试 ZIP 方式安装(下载技能包后点击「从 ZIP 安装」)

Q10:卸载 CodexHub CN 后想重装,以前的设置会保留吗?

不会。卸载会清除所有用户数据(Provider 配置、对话历史、Token 统计等)。

如需备份,可手动导出:

  • 对话历史存储在 %APPDATA%com.codexhubcn.app 目录下的 SQLite 数据库

  • Provider 配置存储在 providers.db


附录

A. 快捷键参考

快捷键功能
Ctrl + Shift + P打开命令面板
Ctrl + L新建对话
Ctrl + K搜索历史
Esc取消截图 / 关闭弹窗
Ctrl + C复制选区截图

B. 目录结构

%APPDATA%com.codexhubcn.app

├── providers.db # Provider 和 API Key 配置

├── token_usage.db # Token 使用记录

├── mcp_servers.json # MCP 服务器配置

├── conversations # 对话历史

├── skills # 已安装技能

└── logs # 日志文件

C. 联系与支持

  • 官网:https://agent.eake.cn/codexhub-cn/

  • 反馈:通过 App 内「💬 反馈」提交

  • 技能提交:发送到 support@eake.cn


本手册最后更新于 2026-07-18,对应 CodexHub CN v0.1.2