Logo Vincent
返回文章列表

Claude Code /init:10 秒自动生成 CLAUDE.md

Claude
Claude Code /init:10 秒自动生成 CLAUDE.md

什么是 /init

如果你用过 Claude Code,你一定知道 CLAUDE.md 这个文件——它是你给 Claude Code 的”项目说明书”,让它一启动就知道你的项目是什么、怎么构建、有哪些规范。

但手写 CLAUDE.md 有时候挺烦的,尤其是接手一个新项目或者老项目的时候,你自己都不一定能快速梳理清楚所有细节。

这就是 /init 命令的用武之地。

/init 是 Claude Code 的一个斜杠命令,在交互模式下运行,它会自动扫描你的整个代码仓库,然后生成一份 CLAUDE.md 文件。

简单来说:你不用自己写,让 Claude Code 帮你写。

它做了什么

当你在项目根目录运行 /init 时,Claude Code 会:

  1. 扫描项目结构 —— 遍历目录树,识别项目类型(Next.js?Express?Python?Monorepo?)
  2. 分析配置文件 —— 读取 package.jsontsconfig.jsonpyproject.tomlCargo.toml 等,提取技术栈、依赖、脚本命令
  3. 理解架构 —— 识别源码目录结构、核心模块、入口文件
  4. 检测开发规范 —— 查看 ESLint、Prettier、lint-staged 等配置,提取编码规范
  5. 生成 CLAUDE.md —— 把以上信息整理成一份结构化的 Markdown 文件,写入项目根目录

整个过程是自动的,你只需要确认一下生成的内容是否满意。

Monorepo 提示: /init 只扫描当前项目根目录。如果你的代码分布在多个仓库或并列的目录里,先运行 /add-dir,让 Claude 把它们都纳入视野,再生成 CLAUDE.md。

/init 五步自动生成流程

怎么用

基本用法

进入你的项目目录,启动 Claude Code,然后输入:

/init

就这么简单。Claude Code 会开始分析你的项目,几秒到几十秒后(取决于项目大小),它会生成 CLAUDE.md 的内容并展示给你预览。

确认没问题后,文件就会写入项目根目录。

适用场景

  • 新接手一个项目 —— 不熟悉代码?让 /init 先帮你梳理一遍,生成的 CLAUDE.md 本身就是一份不错的项目概览
  • 老项目补文档 —— 项目跑了几年,从来没有 CLAUDE.md?一个命令搞定
  • 快速上手开源项目 —— clone 下来,跑一个 /init,立刻有了项目的全局视角
  • 团队协作 —— 生成后提交到仓库,团队里每个人用 Claude Code 时都能受益

注意事项

  • /init 只能在 Claude Code 的交互模式下使用,不能在命令行直接 claude /init
  • 如果项目根目录已经有 CLAUDE.md,/init 会基于现有内容进行更新,不会直接覆盖
  • 生成的内容是一个不错的起点,但建议你根据实际情况手动调整和补充

生成的 CLAUDE.md 长什么样

/init 生成的 CLAUDE.md 通常包含以下几个部分:

# CLAUDE.md

## Project Overview

项目简介、技术栈、核心功能描述。

## Commands

常用的构建、测试、lint、部署命令。

## Architecture

目录结构说明、核心模块、数据流向。

## Code Style

编码规范、格式化配置、命名约定。

## Development Workflow

开发流程、分支策略、CI/CD 相关信息。

具体内容会根据你的项目类型和复杂度有所不同。一个简单的 Node.js 项目可能只有几十行,一个大型 monorepo 可能会更详细。

实际例子

例子一:Next.js 项目

在一个 Next.js 15 项目中运行 /init,生成的 CLAUDE.md 大致如下:

# CLAUDE.md

## Project Overview

A Next.js 15 application using App Router with TypeScript and Tailwind CSS.

## Commands

| Command         | Purpose             |
| --------------- | ------------------- |
| `npm run dev`   | Start dev server    |
| `npm run build` | Production build    |
| `npm run lint`  | Run ESLint          |
| `npm run test`  | Run tests with Jest |

## Architecture

- `src/app/` - App Router pages and layouts
- `src/components/` - Reusable UI components
- `src/lib/` - Utility functions and shared logic
- `src/styles/` - Global styles and Tailwind config

## Code Style

- TypeScript strict mode enabled
- Prettier with 2-space indent, single quotes
- ESLint with Next.js recommended rules

例子二:Monorepo 项目

在一个 Lerna + Nx 管理的 monorepo 中运行 /init

# CLAUDE.md

## Project Overview

A frontend monorepo managed by Lerna + Nx with npm workspaces.

## Commands

| Command         | Purpose                              |
| --------------- | ------------------------------------ |
| `npm run build` | Build all packages (lerna run build) |
| `npm run test`  | Test all packages                    |
| `npm run lint`  | Full pipeline: build → lint → test   |

## Monorepo Rules

- Install deps from root: `npm i <pkg> -w <sub-package>`
- Run scripts from root: `npm run <script> -w <sub-package>`
- Never cd into sub-packages to install or run scripts.

## Packages

- `packages/app` - Main web application (Next.js)
- `packages/ui` - Shared UI component library
- `packages/utils` - Common utility functions

例子三:Python 项目

在一个 FastAPI 项目中运行 /init

# CLAUDE.md

## Project Overview

A FastAPI REST API with SQLAlchemy ORM and PostgreSQL.

## Commands

| Command                         | Purpose           |
| ------------------------------- | ----------------- |
| `uvicorn app.main:app --reload` | Start dev server  |
| `pytest`                        | Run tests         |
| `alembic upgrade head`          | Run DB migrations |

## Architecture

- `app/main.py` - Application entry point
- `app/routers/` - API route handlers
- `app/models/` - SQLAlchemy models
- `app/schemas/` - Pydantic schemas
- `alembic/` - Database migrations

## Code Style

- Black formatter, line length 88
- isort for import sorting
- Type hints required on all functions

/init vs 手写 CLAUDE.md

/init 自动生成手动编写
速度几秒钟几十分钟
准确性基于代码分析,客观准确基于个人理解,可能遗漏
深度覆盖面广,但可能缺少业务上下文可以写入业务逻辑、��坑经验
维护项目变化后可以重新运行更新需要手动维护
最佳实践先 /init 生成基础版,再手动补充细节

/init 前后对比:无 CLAUDE.md vs 自动生成

我的建议是:先用 /init 生成一个基础版本,然后在此基础上手动补充。比如加上业务相关的注意事项、已知的坑、团队约定等——这些是 Claude Code 扫描代码扫不出来的。

写在最后

/init 是 Claude Code 里一个很小但很实用的命令。它解决的问题很简单:让你不用从零开始写 CLAUDE.md

对于新项目,它帮你快速建立 Claude Code 的项目认知。对于老项目,它帮你补上一直缺失的那份”AI 友好”��项目文档。

下次接手一个新项目的时候,试试在 Claude Code 里敲一个 /init,看看它对你的项目理解得怎么样。你可能会惊讶于它的准确程度——毕竟,代码不会骗人。

相关推荐

AI-first 创业公司,为什么只需要一种编程语言?

技术架构越简单 = AI Coding 效率越高。从 Java 的"防人"设计到 TypeScript 全栈通吃,聊聊 AI 时代创业公司的编程语言选择。

cc-ping:一行命令 Ping 所有 Claude Code 配置

用多个 Claude Code API Key 或中继?cc-ping 帮你管理配置、一键切换,还能并行 Ping 所有节点比速度。

震惊!程序员用这个工具,4分钟干完95分钟的活!效率暴涨24倍

躺床上发3条消息,4分钟搞定3个项目。传统方式需要95分钟,这就是冷兵器和热兵器的差距。

CCBot - 研发提效 24 倍

通过 IM 机器人控制 Claude Code,3 个项目 4 分钟全部搞定。传统编程需要 95 分钟,效率提升 24 倍。

Claude Code /add-dir:被低估的 Monorepo 神器

Claude Code 默认只能看到当前目录。/add-dir 打破这个限制——分享我每天跨 5 个仓库使用的经验。

Claude Code 省 Token 小技巧:感叹号的妙用

一个简单却容易被忽略的技巧——用感叹号直接执行命令,省 token、提速度、更可控。

我做了个机器人,让团队在飞书里用 Claude Code

CCBot 让你的团队在飞书群聊里直接用 Claude Code——不需要终端、不需要 SSH。开源、自部署、五分钟搞定。

Claude Code /btw 命令详解:不打扰主线的快问快答

详细介绍 Claude Code 的 /btw 命令——它是什么、怎么用、什么时候该用,以及它和子代理、/compact 的区别。

Claude Code /compact:释放上下文,不丢进度

任务做到一半上下文满了?/compact 帮你压缩对话继续干活——和 /clear、/rewind 的区别一次讲清。

Claude Code /config:一文搞懂所有可调设置

用 Claude Code 却从没打开过 /config?这篇带你逐项拆解——从权限模式到自动压缩,从主题切换到通知配置,帮你打造最顺手的 AI 编程环境。

Claude Code /context:你的上下文都被什么吃了?

对话到一半 Claude Code 说上下文不够了?/context 用一张可视化网格告诉你:上下文被什么占了、占了多少、怎么优化。

Claude Code /diff:这次对话改了什么,一目了然

Claude Code 帮你改了一堆文件,但你不确定到底改了什么?/diff 用交互式界面展示所有改动——既有 git 视角的全量 diff,也有按对话轮次拆分的逐步 diff。

Claude Code /fast:同样的 Opus,两倍速——值不值?

/fast 不会降级模型,还是 Opus,只是更快。什么时候该开、什么时候该关,以及实际体验差异。

Claude Code 引用外部知识的最佳实践:GitHub MCP + Context7

用 GitHub MCP 和 Context7 MCP 两个工具组合,解决 Claude Code 知识过时导致的代码错误问题。

Claude Code /hooks:让 AI 按你的规矩办事

想在 Claude Code 执行命令前自动检查?想在任务完成后自动通知?/hooks 让你用脚本、AI 甚至 HTTP 请求,在关键节点插入自定义逻辑。

Claude Code MCP:让 AI 连接 GitHub、数据库等一切工具

MCP 把 Claude Code 从代码阅读器升级为全栈 Agent。哪些 MCP 服务器值得装、配置怎么写,实测分享。

Claude Code /memory 详解:让 AI 真正记住你的项目

详细介绍 Claude Code 的 /memory 命令和记忆系统——CLAUDE.md 手动指令、Auto Memory 自动记忆、模块化规则,让 Claude 跨会话记住项目规范和个人偏好。

Claude Code /model:Opus、Sonnet、Haiku 怎么选?

不是每个任务都需要 Opus。怎么切换模型、哪个场景用哪个、怎么省 token 又不掉质量。

Claude Code /permissions:谁能干什么,你说了算

每次 Claude Code 要跑命令都弹窗问你?嫌烦又不敢全放开?/permissions 帮你精细控制每个工具的权限——该放的放,该拦的拦。

Claude Code /plan 详解:先想清楚再动手

详细介绍 Claude Code 的 /plan 命令和 Plan Mode——只读规划模式,让 Claude 先分析代码、制定方案,确认后再动手,避免复杂任务翻车。

Claude Code + Playwright MCP:AI 终于能"看见"页面了

一个 Modal 溢出的 bug,Claude Code 反复修了 5 次都没搞定。直到接入 Playwright MCP 让它真正看到页面,一次定位,一次修复。

Claude Code /resume 命令详解:别让对话白聊

详细介绍 Claude Code 的 /resume 命令——恢复历史对话、管理会话、实用技巧,让你的每一轮对话都不浪费。

Claude Code /review:让 AI 帮你做 Code Review

提了 PR 没人看?想在合并前多一道把关?/review 让 Claude Code 像一个资深开发者一样审查你的代码——还有 /ultrareview 和 /security-review 两个进阶选择。

Claude Code Skills 详解:打造你的专属命令库

详细介绍 Claude Code 的 Skills 功能——创建自定义斜杠命令、复用提示词模板、共享团队最佳实践,让 AI 编程更高效更一致。

Claude Code /stats:看看 AI 到底帮你写了多少代码

好奇 Claude Code 到底写了多少行代码?/stats 给你完整数据——token、编辑次数、工具调用,教你怎么看。

Claude Code /status 命令详解:一眼看清会话全貌

详细介绍 Claude Code 的 /status 命令——它是什么、怎么用、能看到哪些信息,以及它在日常工作流中的实际价值。

Claude Code /tasks 命令详解:后台任务尽在掌控

详细介绍 Claude Code 的 /tasks 命令——查看后台任务、管理并行 Agent、掌控长时间运行的进程,让多任务开发井井有条。

Claude Code /usage 命令详解:你的额度还剩多少

详细介绍 Claude Code 的 /usage 命令——查看用量、了解限额、避免突然被限速,让你对自己的额度心中有数。

Claude Code /vim:在 AI 编程助手里用 Vim 键位

习惯了 Vim 的操作方式?/vim 让你在 Claude Code 的输入框里用 hjkl 移动、dd 删行、ciw 替换单词——不用改变肌肉记忆。

Claude Code 使用指南:从安装到实战,一篇就够(2026)

用了半年 Claude Code 的经验总结——5 分钟安装配置、最常用的命令、CLAUDE.md 编写技巧,以及没人告诉你的实战心得。

Claude 全家桶:从聊天到写代码到自动办公,一文讲清楚

一篇文章带你了解 Anthropic 的 Claude 全家桶——Claude.ai、Claude Code、Claude Cowork,以及 Opus、Sonnet、Haiku 三大模型家族。

Claude Code /agents 详解:自定义 AI 子代理,各司其职

详细介绍 Claude Code 的 /agents 命令——查看、管理和创建自定义 Agent,让不同任务由专门的 AI 角色来执行,从代码探索到架构规划各司其职。

Claude Code /doctor 详解:一键诊断你的开发环境

详细介绍 Claude Code 的 /doctor 命令——自动检测安装状态、API 连接、MCP 配置、上下文用量等问题,帮你快速定位和修复环境故障。

Claude Code /effort 详解:控制 AI 思考的深度

详细介绍 Claude Code 的 /effort 命令——调节 Claude 的推理努力程度,在速度和质量之间找到最佳平衡点,让每一次对话都恰到好处。

Claude Code /cost 详解:你的 AI 编程到底花了多少钱

详细介绍 Claude Code 的 /cost 命令——实时查看会话 API 成本,了解各模型定价和 Token 消耗明细,让每一分钱都花得明明白白。

Claude Code /export 详解:把 AI 对话带走

详细介绍 Claude Code 的 /export 命令——将对话导出为文件或复制到剪贴板,方便分享、存档和复盘,让每一次有价值的对话都不浪费。

Claude Code /rewind 详解:AI 改错了?一键回退

详细介绍 Claude Code 的 /rewind 命令——将代码和对话回退到任意历史节点,支持只回退代码、只回退对话、或两者同时回退,是你和 AI 协作时的后悔药。

Claude Code /plugin 详解:给你的 AI 编程助手装插件

详细介绍 Claude Code 的 /plugin 命令——管理插件的安装、启用、禁用和更新,通过插件扩展 Claude Code 的命令、技能、Agent 和 Hook,打造你专属的 AI 编程工具链。

Claude Code /theme 详解:给你的终端换个好看的皮肤

详细介绍 Claude Code 的 /theme 命令——6 种预设主题 + 自动模式,支持深色/浅色、色盲友好、ANSI 兼容,60+ 色值覆盖终端全部 UI 元素。

Claude Code /insights 详解:用 AI 分析你自己用 AI 的方式

详细介绍 Claude Code 的 /insights 命令——五阶段数据分析流水线、七大洞察章节、多维度会话统计,用 Claude Opus 生成专属 HTML 使用报告。

Claude Code /rename 详解:给你的会话取个有意义的名字

详细介绍 Claude Code 的 /rename 命令——手动命名、AI 自动生成(Haiku 模型)、启动参数命名、Plan 模式自动命名,以及双标题系统与 Bridge 同步机制。

Claude Code settings.json 配置详解:5 层优先级、3 种文件路径,一篇搞懂

Claude Code 的 settings.json 到底放哪里?用户级、项目级、本地级有什么区别?什么是 managed-settings.json?一篇讲清 5 层配置的优先级规则、合并逻辑和实际使用场景。

Claude Code settings.json 详解(二):permissions 权限系统全解析

深入解析 Claude Code 的 permissions 配置——allow/deny/ask 三类规则、通配符语法、MCP 工具权限、defaultMode 各模式含义,以及 additionalDirectories 的作用。

Claude Code settings.json 详解(三):hooks 钩子全解析

深入解析 Claude Code 的 hooks 配置——四种钩子类型、核心事件(PreToolUse/PostToolUse/Stop/Notification)、stdin/stdout 协议、exit code 语义,以及实用配置示例。

Claude Code settings.json 配置模板:env、模型、认证等实用字段速查

Claude Code settings.json 常用字段速查表:env 环境变量、模型切换、apiKeyHelper 动态认证、Git 署名、思考深度、语言与界面、自动更新等,附可直接复制的配置示例。

Claude Code Agent Loop:拆解 AI 编程助手的心脏

Claude Code 是怎么一步步理解你的需求、调用工具、自我修复的?从源码角度拆解 Agent Loop 的核心架构——流式响应、并行工具执行、自动压缩、错误恢复,一次讲透。

© 2026 vincentqiao.com . 保留所有权利。