使用文档页面

使用文档页面是 Claude Code Hub 内置的客户端配置指南，提供 Claude Code、Codex CLI、Gemini CLI 和 Droid CLI 等 AI 编程工具连接 CCH 服务的详细配置说明。

功能概述

使用文档页面为团队成员提供一站式的客户端配置指南，覆盖主流 AI 编程工具在不同操作系统上的安装和配置流程。

支持的 CLI 工具

工具	说明
Claude Code	Anthropic 官方 CLI 工具，支持 NPM 安装和原生安装两种方式
Codex CLI	OpenAI 官方编码代理，使用 Response API
Gemini CLI	Google 官方 CLI 工具，支持 Gemini API
Droid CLI	Factory AI 的跨平台 AI 编码代理

支持的操作系统

每种 CLI 工具都提供三个平台的完整指南：

macOS：支持 Homebrew 和 curl 安装
Windows：支持 PowerShell 和命令行安装
Linux：支持包管理器和 curl 安装

访问方式

从控制台访问

使用文档页面集成在 Claude Code Hub 控制台的导航菜单中：

登录 Claude Code Hub 控制台
点击顶部导航栏的「文档」链接
进入使用文档页面

导航路径：控制台 > 文档

URL 路径：/usage-doc

未登录访问

使用文档页面支持未登录访问，方便团队成员在配置客户端前查阅文档：

未登录时显示简化版头部，包含「登录控制台」按钮
已登录时显示完整的控制台导航

这种设计使得管理员可以直接分享文档页面链接给团队成员，无需先登录即可查看配置指南。

文档内容

环境准备

对于需要 Node.js 环境的工具（Claude Code、Codex、Gemini），文档提供详细的环境准备说明：

Node.js 安装方法（官方安装包、Homebrew、包管理器）
安装验证命令
常见问题解决方案

安装指南

每个 CLI 工具的安装部分包含：

安装命令：npm 全局安装或原生安装脚本
安装选项：稳定版、最新版、指定版本
验证命令：确认安装成功的检查命令

以 Claude Code 为例，支持两种安装方式：

安装方式	说明	适用场景
原生安装	使用官方安装脚本	推荐方式，支持自动更新
NPM 安装	通过 npm 全局安装	适合 Node.js 开发者

配置 CCH 服务

这是使用文档的核心部分，说明如何将 CLI 工具连接到你部署的 CCH 服务：

配置文件方式

每个 CLI 工具都提供配置文件示例，包含：

配置文件路径（不同系统）
完整的配置文件内容模板
关键配置项说明

环境变量方式

同时提供环境变量配置方式：

临时设置（当前会话有效）
永久设置（写入 shell 配置文件）
配置验证命令

VS Code 扩展配置

对于支持 VS Code 扩展的工具（Claude Code、Codex），文档额外提供：

扩展安装说明
配置文件位置和内容
与 CLI 配置的关系说明

启动与验证

配置完成后的验证步骤：

启动命令示例
预期输出说明
常见错误排查

常见问题

每个 CLI 工具都有针对性的故障排查指南：

命令找不到（PATH 配置问题）
连接失败（网络和配置问题）
更新命令

页面特性

动态服务地址

文档中的服务地址（ANTHROPIC_BASE_URL 等）会自动替换为当前访问的 CCH 服务地址，用户只需复制配置内容并填入自己的 API Key 即可使用。

目录导航

页面右侧提供目录导航：

桌面端：固定在右侧的目录面板
移动端：右下角浮动按钮，点击展开抽屉式目录

目录支持：

自动高亮当前阅读位置
点击快速跳转到对应章节
平滑滚动效果

快速链接

目录面板下方提供快速操作：

返回仪表盘：快速返回控制台首页（已登录时显示）
回到顶部：一键返回页面顶部

响应式设计

文档页面针对不同屏幕尺寸优化：

代码块支持横向滚动
移动端提供抽屉式导航
表格和列表自适应布局

无障碍支持

页面提供完整的无障碍支持：

Skip Links：快速跳转到主要内容或目录
ARIA 标签：屏幕阅读器友好
键盘导航：支持 Tab 键导航

与本文档站的关系

CCH 内置的使用文档页面和本文档站（docs-site）是两个独立的文档系统：

对比项	内置使用文档	文档站
位置	CCH 服务内部	独立部署
访问地址	`/usage-doc`	独立域名
内容重点	客户端配置指南	完整的产品文档
动态内容	自动填充服务地址	静态内容
目标读者	需要配置客户端的用户	所有用户
多语言	支持（next-intl）	中文为主

两者互为补充：

内置文档：聚焦于快速上手，适合分享给团队成员用于配置客户端
文档站：提供完整的功能说明、部署指南和管理操作文档