自学教程

Claude Code 项目初始化

简介

Claude Code 项目初始化,是在现有代码仓库中生成 Claude 专用配置文件、项目规则,让 Claude 自动理解项目架构、代码规范、技术栈,减少每次对话重复说明项目信息。
初始化完成后,Claude 会自动读取项目上下文,代码修改风格统一,减少错误改动。

前置条件

  1. 已安装 Claude Code CLI
  2. 本地项目文件夹(Git仓库推荐)
  3. 终端,进入项目根目录

步骤1:执行初始化命令

在项目根目录终端运行:

claude init

该命令会交互式引导生成项目配置,不会自动修改你的业务代码。

步骤2:交互式配置向导

执行命令后,按提示依次填写:

  1. 项目描述:简单说明项目用途、技术栈(例如:Nuxt4 前端项目,使用 TailwindCSS V4,Shadcn/ui)
  2. 项目目录范围:选择允许 Claude 读取/修改的目录;可排除 node_modules、.git、构建产物目录
  3. 代码规范:语言风格、命名规范、格式要求(ESLint、Prettier 规则)
  4. 技术约束:禁止使用的API、依赖版本限制、架构约束
  5. 是否启用自动读取git信息:推荐开启,Claude 可读取git变更,理解最近改动

向导完成后,会在项目根目录生成 .claude/ 文件夹。

步骤3:配置文件说明

.claude/ 目录下核心文件:

  • settings.json:项目全局配置,模型、接口地址、最大上下文等
  • instructions.md:项目专属指令(最重要),每次对话 Claude 都会优先读取此文件
  • ignore:忽略文件列表,语法类似 .gitignore,填写不需要 Claude 访问的文件

示例 .claude/instructions.md

# 项目规则
技术栈:Nuxt4 + TailwindCSS V4 + Shadcn/ui
编码规范:
1. 使用 TypeScript,开启严格模式
2. 组件使用组合式API
3. 样式统一使用Tailwind,禁止自定义css
4. 修改代码前,先输出Coding Plan
禁止:直接修改数据库相关代码

示例 .claude/ignore

node_modules
dist
.build
.env
*.pem

步骤4:验证初始化结果

claude doctor

claude doctor 用于检测项目配置、权限、API连接状态。
输出 All checks passed 代表初始化成功。

测试指令验证:

介绍当前项目架构

Claude 会读取 .claude/instructions.md 内容,结合项目文件给出对应回答。

可选:手动创建配置(不使用 claude init)

如果不想使用交互式命令,可以手动新建 .claude 目录,自行创建上面三个配置文件。

最佳实践

  1. 将 .claude/ 提交到 Git(不要放入密钥,密钥放在环境变量)
  2. 项目变更、技术栈升级时,同步更新 instructions.md
  3. 敏感环境变量、私钥一定要写入 .claude/ignore,防止被读取

常见问题

  1. 执行 claude init 无响应
    检查网络,升级CLI版本:claude update
  2. Claude 仍然读取到 .env 密钥
    确认 .claude/ignore 添加 .env,重启 Claude Code 会话
  3. instructions.md 不生效
    路径必须是 .claude/instructions.md,名称大小写不能错;新建对话才会加载最新指令

安全提示

  • 不要在 instructions.md 写入密钥、密码等敏感信息
  • 使用 .claude/ignore 屏蔽证书、私钥、本地配置文件

0 条笔记