Claude Code 是 Anthropic 推出的一个 agentic 编码工具 (agentic coding tool),可以在命令行(terminal)中运行,或者集成在一些支持终端的 IDE 中,借助 Claude 的语言模型能力来辅助写代码、重构、调试、维护、理解代码库等。

在深入 CLAUDE.md 之前,先快速了解 Claude Code 是什么,以及它如何与项目交互。
- Claude Code 是 Anthropic 提供的一个命令行(CLI)工具 / 编程代理(agentic coding)工具,允许你用自然语言直接与代码库交互:让 Claude 理解你的项目结构、生成/修改代码、执行 shell 命令、提交 Git 更改等。
- 它并不是简单的代码补全或聊天机器人,而是能主动采取操作(编辑文件、运行命令、Git 操作等)的智能体。
- Claude Code 会尝试把项目的上下文(文件内容、历史、提示)纳入考虑,以便做出合理决策。
- 启动时,Claude Code 会 递归向上 从当前目录开始查找 CLAUDE.md 或 CLAUDE.local.md(目前主流是 CLAUDE.md)文件,并把这些内容作为“记忆”或“上下文”读入。
- 如果某些子目录(子树)也有 CLAUDE.md,在进入这些子目录、读取这些子树时,这些子树中的 CLAUDE.md 也会被包含进上下文。它不会在启动时就预先载入它们。
- CLAUDE.md 的内容会成为 Claude 的默认 “系统提示 / 背景” 的一部分,也就是说,Claude 在思考/决策时会参考它里面的说明。
- 在对话过程中你可以用快捷方式(如以 # 开头的行)把内容写入 CLAUDE.md。例如:
- Claude 会提示你把这行放入哪个记忆文件(即哪个 CLAUDE.md)里。
- 在对话中你也可以用 /memory 命令直接编辑记忆文件(即打开 CLAUDE.md 或其他记忆文件进行修改)。
- CLAUDE.md 支持导入其他文件(@path/to/file.md 语法),这样你可以把说明或配置拆成多个文件。
- 为了避免冲突或安全隐患,导入语法在 Markdown 的代码块或反引号( “
或)中不会被解释为导入。
Mac & Liunx 配置方式
确保系统已安装 Node.js 18+ 版本
1.安装 Homebrew (mac推荐)
如果尚未安装 Homebrew:
2. 安装 Node.js
使用 Homebrew:
2. 安装 Claude Code
3. 配置Claude API 密钥
国内使用 Claude Code 的主要挑战是网络限制和高昂的费用,通常需要借助第三方镜像或代理服务
小编直接用的神马中转API(api.whatai.cc) 获取Auth Token

方法一:使用 Bash(推荐)
方法二:使用 Zsh(如果使用 Oh My Zsh)
注意: 永久设置后需要重启终端才能生效。
4. 启动使用 Claude Code
首次启动后需要先进行主题的选择等操作:
- • 选择喜欢的主题(回车)
- • 确认安全须知(回车)
- • 使用默认 Terminal 配置(回车)
- • 信任工作目录(回车)
- • 开始编程!🚀

CLAUDE.md 是 Claude 在启动时就会读取并纳入思考的背景说明文件。其作用包括:
- 为项目/团队设定 “行为指南”
例如:变量命名规则、代码风格、重要模块说明、工具脚本使用方式、开发者约定等。这样 Claude 在做决定或修改代码时更符合团队规范。
- 减少每次提示重复写背景
因为是在启动时就载入,后续你对 Claude 发出的自然语言提示,就可以省掉再次讲述这些约定或规则。
- 引导 Claude 行为 / 限制其权限 / 指定工具
你可以在 CLAUDE.md 中说明哪些工具是安全可用的、哪些要谨慎,或者告诉 Claude “在遇到这种情况用这个脚本 / 命令”。
- 项目结构说明 / 关键模块和约定
在多人协作或大型项目中,CLAUDE.md 能帮助 Claude 快速理解模块职责、入口文件、依赖关系等,从而做出更合理的建议。
- 分层记忆 / 子目录定制
项目中不同子模块、子目录可以有自己的 CLAUDE.md 来定制局部行为。这样即使在子模块中调用 Claude,也能参考子模块的特定规则。
- 导入 / 组合多个说明
通过 @ 语法,你可以将不同功能模块的说明拆入多个 .md 文件,然后在主 CLAUDE.md 中导入。这样结构更清晰,便于维护。
- 提升 Claude 决策质量 / 减少猜测
许多用户反馈:写得越规范、说明越明确的 CLAUDE.md,Claude 的输出越稳定、符合预期。
综上,CLAUDE.md 是 Claude Code 的“驾驶舱说明书”,好好写能显著提升体验。
下面是一个比较系统的步骤(从零开始):
- 在项目根目录运行:
- Claude Code 会尝试读取项目结构、关键文件、依赖等,然后自动生成一个初步的 CLAUDE.md。
- 生成之后建议你人工审核、修改。
- 通常放在项目根目录:./CLAUDE.md。
- 对于 monorepo 或多模块项目,也可以在父目录或子目录放额外的 CLAUDE.md。当 Claude 在子目录中工作时,会优先载入子目录的 CLAUDE.md。
- 你还可以在用户目录(如 ~/.claude/CLAUDE.md)放个人偏好 / 跨项目的说明。
- 目前 CLAUDE.local.md(旧名)已逐渐弃用,推荐用导入机制替代。
下面是一个推荐的内容结构与写作规范,可根据团队 / 项目情况增删:
@README.md
@docs/api-guidelines.md
写作建议:
- 保持简洁与清晰,避免把过多细节塞进去。过长的背景可能反而让 Claude 更难抓住重点。
- 用自然语言写规则,而不是只给代码片段。Claude 能理解这种指令。
- 在规则中适度给出例子 / 模板,帮助 Claude 理解意思。
- 当项目演变、规范变更时,及时更新 CLAUDE.md。
- 对于团队项目,可以把主 CLAUDE.md 提交到版本控制,让团队成员共享。
如前文所述,为了避免让 CLAUDE.md 变得臃肿,你可以把不同模块或子系统的规则分别写入独立 .md 文件,然后在主文件用导入语法引用。例如:
这样结构清晰、易于维护。
注意:导入语法在代码块 / 反引号内不会生效。
在有了 CLAUDE.md 之后,我们聊聊 Claude Code 的一些基本用法和交互流程。
- 使用 npm 全局安装(前提是已安装 Node.js):
- 初次启动会走配置流程,包括 OAuth、API key、权限授权等。
- 安装后可以执行 claude doctor 检查环境与版本状态。
- 在 Windows 上可能需要在 WSL 或 Git Bash 环境下运行。
以下是 Claude Code 常用的交互指令与技巧:
此外,有些命令可以结合 shell 管道使用,例如:
这会把 logs.txt 的内容输入 Claude 作为上下文。
还有无头 / 自动化模式(用于脚本、CI 等):
- 使用 -p 提示 + –output-format stream-json 获取 JSON 输出
- 无头模式不会保留对话上下文(每次是独立的请求)
从一个自然语言需求走到代码变更,大致流程可能像:
- 启动 Claude:claude
- 提出需求:> 给这个项目添加一个用户登录注册功能
- Claude 会扫描 CLAUDE.md、项目文件,列出一个 plan(子任务清单),可能先让你确认 plan
- 你确认 plan 后,Claude 会依次对文件做更改(生成、修改、删除等),在每步修改前询问你是否接受
- 最后 Claude 会生成提交、PR、commit message 等
- 你可以接着让 Claude 审查改动、写文档、重构、修 bug 等
在这个过程中,CLAUDE.md 的规则和约定会被 Claude 用来指导其行为。
下面给你几个完整的示例,演示 CLAUDE.md + 提示 + Claude 的输出 / 行动。
项目结构:
CLAUDE.md(初稿):
提示给 Claude:
Claude 的可能行为 / 输出(模拟):
- Claude 读取 CLAUDE.md,理解项目背景、约定
- 扫描项目文件结构,发现 src/user.js 和 tests/user.test.js
- 返回一个 plan,比如:
3. 你确认后,Claude 逐步生成代码更动,询问你是否接受每一步 4. 最终生成提交(如 “user: add register & login with tests”)
你如果接着说:
Claude 会给你代码审查意见,比如密码加盐策略、错误处理、异常捕获等。
假设项目比较大,有前端、后端两个模块,各自有不同规则。你可以这样写主 CLAUDE.md:
然后在 frontend/CLAUDE.md:
在 backend/CLAUDE.md:
当你在 backend/ 目录中运行 Claude,Claude 会读取 backend/CLAUDE.md 并结合主 CLAUDE.md 的通用规则一起理解你的指令。
然后你可以在 backend 目录中给 Claude 说:
Claude 会根据 backend/CLAUDE.md 的规则,用 Express 写出合规风格的代码。
假设你有一个日志文件 error.log,内容是一个堆栈跟踪 / 异常信息。你希望 Claude 帮你分析错误。
命令行:
(或者用 /prompt 模式)
Claude 会接受日志内容作为输入,上下文中又有 CLAUDE.md 的项目背景,从而给你更贴近项目的错误分析建议。
下面是一些社区 / 官方推荐的技巧,帮你写好 CLAUDE.md、提升 Claude Code 的效率和稳定性。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/226618.html