Agent 工具教程

面向零基础用户的 AI Agent 工具使用教程文档站。

涵盖 Claude Code、Codex、OpenCode、Claude Desktop 等主流 Agent 工具的下载安装、配置和基本使用教程，以及 CC-Switch 代理切换工具的说明。

在线阅读 · 快速开始 · 文档结构 · 贡献指南

---

截图预览

文档首页

配置教程

CC-Switch 配置	Claude Code 配置

---

内容概览

快速上手

• 环境准备 — Node.js、Git 等必要软件安装
• 模型接入 — 主流 AI 服务商 API 信息（DeepSeek、Kimi、智谱、通义千问、Anthropic、OpenAI）

CC-Switch

• 下载安装 — CC-Switch 桌面端安装指南
• 配置 — 添加 Provider、切换模型、路由配置
• 常见问题 — 配置失败、切换不生效等问题排查

Agent 工具

工具	形态	适合场景
Claude Code	CLI / VSCode 插件	开发者日常编码，功能最全面
Claude Desktop	桌面应用	独立对话，不依赖编辑器
Codex	CLI / 插件 / 桌面应用	多平台 AI 编程助手
OpenCode	CLI / 桌面应用	轻量命令行 AI 编程工具

每款工具均包含：下载安装 → 配置 → 基本使用 → 命令速查 → 常见问题

附录

• 基础知识 — 终端使用、API 格式说明
• 常见错误速查 — 401、超时、模型不存在等错误解决方案

---

技术栈

• 文档框架: VitePress 1.6.4
• 语言: 中文 (zh-CN)
• 搜索: 本地搜索
• 部署: GitHub Pages

---

快速开始

环境要求

• Node.js >= 18
• pnpm（推荐）或 npm

本地开发

# 克隆仓库
git clone https://github.com/HanphoneJan/agent-guide.git
cd agent-guide

# 安装依赖
pnpm install

# 启动开发服务器（端口 25555，暴露到局域网）
pnpm dev

访问 http://localhost:25555 预览文档。

构建部署

# 构建生产版本
pnpm build

# 预览构建结果
pnpm preview

构建产物输出到 .vitepress/dist/，可直接部署到 GitHub Pages、Vercel、Netlify 等平台。

---

文档结构

agent-guide/
├── .vitepress/
│   ├── config.ts          # VitePress 配置（侧边栏、主题等）
│   └── theme/             # 自定义主题
├── public/
│   └── images/            # 文档截图和图片资源
│       ├── quick-start/
│       ├── cc-switch/
│       ├── claude-code/
│       ├── claude-desktop/
│       ├── codex/
│       └── opencode/
├── quick-start/           # 快速上手
│   ├── index.md           # 概览
│   ├── environment-setup.md   # 环境准备
│   └── api-and-models.md  # 模型接入
├── cc-switch/             # CC-Switch 教程
│   ├── download-and-install.md
│   ├── configuration.md
│   └── faq.md
├── agent-tools/           # Agent 工具教程
│   ├── claude-code/       # Claude Code
│   ├── claude-desktop/    # Claude Desktop
│   ├── codex/             # Codex
│   └── opencode/          # OpenCode
├── appendix/              # 附录
│   ├── basic-knowledge.md # 基础知识
│   └── common-errors.md   # 常见错误速查
├── index.md               # 入口页（自动跳转）
└── README.md              # 本文件

---

贡献指南

欢迎提交 Issue 和 Pull Request！

添加新工具教程

1. 在 agent-tools/ 下创建新目录，按现有结构添加页面：

   • download-and-install.md
   • configuration.md
   • basic-usage.md（可选）
   • command.md（可选）
   • faq.md（可选）

2. 在 .vitepress/config.ts 的 sidebar 中添加对应导航

3. 在 public/images/ 下创建对应图片目录

内容风格

• 面向零基础用户，步骤化、截图配合说明
• 使用简洁明了的语言，避免技术 jargon
• 每个步骤配截图，关键操作加粗提示

---

相关项目

• CC-Switch — API 配置管理工具
• Claude Code — Anthropic 官方 CLI
• OpenCode — 开源 AI 编程工具

---

Star History