Skip to content

init — 项目初始化

  • 触发方式: /init 或关键词「初始化项目」「create CLAUDE.md」
  • 适用场景: 新项目接入 Claude Code、为已有项目创建文档
  • 不适用场景: 更新已有 CLAUDE.md(直接编辑)

功能概述

init 分析当前项目并生成 CLAUDE.md 文件。这个文件是 Claude Code 理解项目的核心入口,包含架构、技术栈、约定和关键文件路径。

触发条件

以下情况会自动触发 init

  • 提到「初始化」「init project」
  • 新项目想接入 Claude Code
  • 使用 /init 命令

使用示例

示例 1:初始化新项目

/init

Claude 会扫描项目结构,生成包含以下内容的 CLAUDE.md:

markdown
# Project Name

## Architecture
- Monorepo with pnpm workspaces
- Frontend: React + TypeScript
- Backend: Node.js + Express

## Key Directories
- `packages/web/` — Frontend app
- `packages/api/` — Backend API
- `packages/shared/` — Shared types and utils

## Conventions
- Use functional components, no class components
- API routes follow RESTful conventions
- Tests colocated with source files

示例 2:指定技术栈

/init 这是一个 Next.js 14 + Prisma + PostgreSQL 项目,使用 App Router

示例 3:Python 项目

/init FastAPI 后端项目,使用 SQLAlchemy + Alembic

CLAUDE.md 内容

章节说明
Architecture项目架构概要
Tech Stack使用的技术和版本
Key Directories核心目录说明
Conventions代码约定和规范
Commands常用命令(构建、测试、部署)
Gotchas需要注意的陷阱和例外

注意事项

  • CLAUDE.md 应该简洁,不是 README 的替代品
  • 避免过于详细的 API 文档 — Claude 可以通过代码了解
  • 约定和陷阱是最有价值的部分 — 告诉 Claude 反直觉的地方
  • 首次生成后建议审查和编辑,确保准确性
  • 可以后续手动更新,init 不会覆盖已有 CLAUDE.md

相关 Skills