Claude Code 完全指南

从安装配置到高级工作流、子代理与技能,覆盖 Claude Code 全技能栈的中文速查手册。

Star 数
★ 4.7k
最近更新
今天
License
MIT
主语言
Python

30 秒速览

运行形态
命令行工具
可在哪里用
平台专用Claude CodeClaude.ai(部分支持)
费用
软件免费,模型调用费用自付
上手难度
低 · 几分钟可跑通
开始前需要
Node.js 18+Git 2.23+Shell / 命令行网络访问本地文件系统MCP Server
典型场景
初学者需要快速安装并配置 Claude Code,可通过本文的 Quick Start 和安装命令完成环境搭建。
不适合
  • 只使用其他 AI 编程代理(如 Codex、Gemini CLI)的团队
  • 没有 Claude Pro/Max/Team/Enterprise 或 Console 付费账户的用户

这个 Agent 能做什么,适合哪些场景?

这是一个社区维护的 Claude Code 使用指南仓库,系统整理了从入门到高级用户所需的全部知识:包括原生安装器与 npm 两种安装方式、环境变量与配置文件(CLAUDE.md、.claude/rules)、Slash 命令与 CLI 参数速查表、键盘快捷键与 Vim 模式、MCP 与 Hooks 集成、安全与权限设置,以及自动化(PR 审查、Issue 分类)和故障排查章节。手册以表格和命令示例为主,便于快速检索。它面向的是 Anthropic Claude Code 命令行工具的使用者,帮助用户在终端中更高效地利用 Claude 进行编程开发。仓库还附带了官方文档链接和其他生态资源(如 Discord 集成、技能仓库),但内容本身不包含可执行的 Agent 代码,完全依赖 Anthropic 的 Claude Code 环境。

该仓库是一个文档型项目,不提供可执行代码,但详细说明了 Claude Code 的完整操作流程。它教授如何通过原生安装器(curl 脚本)或 npm 安装 Claude Code,如何设置 ANTHROPIC_API_KEY 或通过 claude auth login 认证,并清晰列出所有 Slash 命令(如 /init、/plan、/mcp、/agents、/compact)和 CLI 参数(如 -p、--output-format json、--allowedTools)。它解释了四个层级的内存文件(企业 CLAUDE.md、项目 CLAUDE.md、用户 ~/.claude/CLAUDE.md 和本地 CLAUDE.local.md)的加载顺序,并提供了 MCP 服务器的配置管理(claude mcp add/list)和 Hooks 事件。同时涵盖自动化场景,如利用 claude -p --json-schema 获取结构化输出、用 --bg 运行后台会话,以及用 --auto-pr-review 进行 PR 审查。

  1. 初学者需要快速安装并配置 Claude Code,可通过本文的 Quick Start 和安装命令完成环境搭建。
  2. 日常开发中希望让 Claude 更符合项目规范,可在 CLAUDE.md 中定义架构和编码标准,并利用 /init 自动生成。
  3. 需要控制 Claude 的文件系统访问权限,可通过 --allowedTools、--permission-mode plan 或安全管理器(如安全审计策略)进行限制。
  4. 想要将 Claude Code 接入外部服务,可参考 MCP 章节配置自定义 MCP 服务器(如 Discord、GitHub)。
  5. 进行批量代码审查或 PR 评论,可使用 /code-review --comment 或 /ultrareview 命令(需配合 GitHub 集成)。
  6. 团队希望统一开发规范,可利用 .claude/rules/ 目录将规则模块化,并通过源控制共享。

如何安装或部署这个 Agent?

本仓库是文档,无需安装。若要使用 Claude Code 本身,请遵循其安装方法:

- macOS/Linux: curl -fsSL https://claude.ai/install.sh | bash
- Windows (PowerShell): irm https://claude.ai/install.ps1 | iex

- 或使用 npm: npm install -g @anthropic-ai/claude-code(需 Node.js 18+)。
安装后运行 claude --version 验证。

如何使用这个 Agent?

  1. 在项目目录中运行 claude 启动交互式会话。
  2. 首次使用时,运行 claude auth login 登录 Anthropic 账户,或设置 ANTHROPIC_API_KEY 环境变量。
  3. 按需配置环境变量:例如 export ANTHROPIC_MODEL="sonnet"、export CLAUDE_CODE_USE_BEDROCK=1。
  4. 创建 CLAUDE.md 文件编写项目说明,或使用 /init 自动生成。
  5. 使用 /plan、/compact、/mcp 等命令管理会话。
  6. 查阅本指南的 Slash 命令表和 CLI 参数表,按需使用。

这个 Agent 有哪些优点和局限?

优点
  • 覆盖 Claude Code 全部核心功能,从安装、配置到高级特性(如子代理、技能、后台任务)均有文档。
  • 提供大量可直接复制的命令示例,减少试错成本,适合快速上手和查阅。
  • 包含环境变量和配置文件的内存层级说明,帮助用户管理跨项目的一致性。
  • 汇总了 MCP 集成、Hooks 等扩展机制,方便用户扩展 Claude Code 的能力。
局限
  • 仅面向 Claude Code 一种工具,不适用其他 AI 编码代理,具有强平台锁定性。
  • 内容为静态文档,依赖 Anthropic 官方更新,可能滞后于 Claude Code 的最新变化。
  • 未包含实际可运行的 Agent 代码,无法直接与其他系统集成,需结合官方 CLI 使用。
  • 部分高级特性(如 Agent Teams)需额外配置或实验性开关,实施时需自行测试。

这个 Agent 与同类方案有什么区别?

与相关度最高的同类 agent 并排比较关键指标。

Agent 源码审查 形态 / 费用 Star 最近更新 主语言 完整支持的平台
Claude Code 完全指南 当前 29 · 缺口较多 命令行工具免费 + 模型费 ★ 4.7k 今天 Python Claude Code
ZCF - 零配置代码流程 51 · 缺口较多 命令行工具免费 + 模型费 ★ 6.1k 1 个月前 TypeScript Codex · Claude Code
Endoplexity 浏览器智能控制 67 · 存在缺口 浏览器扩展付费 ★ 180 2 个月前 TypeScript Claude.ai
Tokless 57 · 缺口较多 命令行工具免费 ★ 293 今天 Go Codex · Claude Code

FollowAgents 如何评估这个 Agent?

FollowAgents 源码审查 · FARS-2.1
缺口较多
29/ 100 五分制 1.5 / 5
信任安全 0/29
可靠稳定 3/14
适用触发 8/18
规范维护 8/18
有效结果 7/13
证据核验 3/8
查看各维度的扣分理由
信任安全0 / 29 · 0.0/5

证据显示这是一个文档仓库,没有可执行代码或权限配置。因此,所有信任相关标准(最小权限、用户确认、数据流透明、敏感数据处理、依赖安全、外部影响、回滚、来源归属)均得0分。没有证据表明存在恶意行为,但也没有任何安全机制。

可靠稳定3 / 14 · 1.1/5

自一致性:README结构清晰,但部分内容(如环境变量列表)可能不完整,且未提供验证方法,得1分。依赖可用性:依赖外部服务(Anthropic API、GitHub),但未提供依赖的可用性保证,得1分。失败消息:未提供错误处理或故障排除的详细说明,得0分。

适用触发8 / 18 · 2.2/5

受众与场景:明确面向从初学者到高级用户的Claude Code用户,覆盖多种场景,得2分。能力边界:未明确说明文档的适用范围或限制,得1分。触发精度:不适用,得0分。环境适配:提供了多平台(Windows、macOS、Linux)的安装和配置说明,得2分。

规范维护8 / 18 · 2.2/5

信息架构:目录清晰,内容组织良好,得2分。安装说明:提供了多种安装方式,得2分。命名稳定性:未提及命名约定,得1分。示例与FAQ:提供了大量命令示例,但缺少FAQ,得2分。已知限制:未提及,得0分。许可证:MIT许可证,得2分。版本与变更日志:有CHANGELOG.md,但未说明版本策略,得1分。维护责任:有GitHub Actions自动同步,但未明确维护者,得1分。

有效结果7 / 13 · 2.7/5

输出可用性:提供了大量可直接使用的命令和配置,得2分。边际价值:作为社区指南,提供了官方文档之外的实用信息,得2分。成本效益:免费开源,但需要用户自行评估,得1分。

证据核验3 / 8 · 1.9/5

声明可追溯性:部分内容引用了官方文档,但未提供具体链接,得1分。跨来源佐证:未提供多个来源的验证,得1分。事实与推断分离:未明确区分事实和推断,得1分。

风险与缓解建议
  • 源码中未见:最小权限约束只授予完成任务所需的权限:用专用账号或只读令牌,并限定可访问的目录和仓库。
  • 源码中未见:执行前用户确认开启或自行加上执行前确认;先在沙箱或测试环境跑通,确认行为后再接入真实数据。
  • 源码中未见:数据流向说明运行时观察它连接了哪些外部服务(代理或防火墙日志);弄清数据去向之前不要输入敏感数据。
  • 源码中未见:敏感信息处理使用专用、低权限、可随时吊销的 API 密钥,不要复用生产凭据,也不要让密钥出现在日志里。
  • 源码中未见:依赖安全审查安装前固定版本并做一次依赖扫描(如 npm audit、pip-audit);优先放在容器里运行。
  • 源码中未见:外部影响披露先弄清它会写入、发送或修改哪些外部系统,用测试账号或测试仓库验证后再接入正式环境。
  • 源码中未见:回滚或恢复路径运行前先备份,或在 git 分支、快照上操作,确保改动可以撤销。
  • 源码中未见:来源归属可核验从官方仓库或包源安装,核对发布者和仓库地址,避免同名仿冒包。
  • 该仓库为文档性质,不包含可执行代码,因此无法评估实际运行时的安全性和可靠性。
  • 环境变量和配置示例可能包含过时或不准确的信息,用户应参考官方文档进行验证。
  • 自动同步工作流会从外部源拉取内容,存在供应链风险,但未发现恶意行为。
证据充分度:低 评估于 2026年8月9日 审查版本 74c5ead3594f 评估后仓库已有新提交,评分可能未覆盖最新改动
查看完整评分方法 →

常见问题

这个仓库是官方文档的副本吗?
不是,这是社区维护的指南,内容整合了官方文档和社区经验,但并非官方副本,带有额外示例和技巧。
我需要付费订阅才能使用 Claude Code 吗?
Claude Code 支持免费试用和订阅,也可通过 API 计费。具体取决于你的 Anthropic 账户类型,本指南不涉及付费细节。
如何确保我的代码安全?
建议限制工具权限(如 --allowedTools),使用 plan 模式预览变更,并遵循安全最佳实践(如不提交真实 API 密钥)。
如果遇到 MCP 服务器连接问题怎么办?
可查阅本指南的 Troubleshooting 章节,通常需要检查 MCP_TIMEOUT 和网络配置,或使用 claude mcp list 诊断。
在 GitHub 查看 ↗ 安装 ↓

对比同类 Agent

用同一套 FARS 评审,横向比较这个 Agent 所属的短名单。

相关 Agents