mcpField
I
init-claude-md

init-claude-md

github.com/tushaarmehtaaAgent 工作流1241 次安装2 周前更新
代码仓库

关于 init-claude-md

这项项目阅读技能指导 Claude 为代码库编写简洁准确的 CLAUDE.md，重点核实技术栈、命令、关键文件和项目特有注意事项。

主要功能

  1. 01检查项目结构与清单文件
  2. 02识别框架和依赖
  3. 03核实开发命令及运行要求
  4. 04梳理重要文件与入口
  5. 05记录约定和常见陷阱

适用场景

  1. 01让 Claude 熟悉陌生代码库
  2. 02记录已核实的本地开发命令

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/tushaarmehtaa/tushar-skills --skill init-claude-md

安装后在 Claude Code 中输入/init-claude-md确认已加载。

详细介绍

阅读项目。编写一份 CLAUDE.md，让 Claude 从第一条消息起就能准确了解项目背景。

步骤

1. 阅读项目
ls -la
cat package.json 2>/dev/null
cat README.md 2>/dev/null | head -60
cat .env.example 2>/dev/null
ls src/ app/ lib/ backend/ frontend/ api/ 2>/dev/null

确定：语言、框架、入口点、项目类型（Web 应用、API、CLI、库、移动应用）。

2. 检测技术栈

阅读依赖清单：

  • package.json — Node/React/Next.js。注明主要版本。Next.js 15 与 14 之间存在破坏性差异。
  • Cargo.toml — Rust
  • requirements.txt / pyproject.toml — Python
  • go.mod — Go
  • src-tauri/ — Tauri（Rust + Web 前端）

列出框架、ORM/数据库客户端、身份验证提供商和关键外部服务。

3. 验证命令

不要想当然地使用 npm run dev。检查 package.json 脚本、Makefile、justfile 或 README：

cat package.json | grep -A 20 '"scripts"'
cat Makefile 2>/dev/null | grep "^[a-z]"

对每条命令，注明预期端口、所需环境变量，以及是否需要 venv 或特定运行时版本。

4. 梳理关键文件

遍历目录结构。注明：

  • 主入口点
  • 核心业务逻辑
  • 会改变行为的配置文件（身份验证配置、数据库架构、计费）
  • 容易出问题的文件（迁移、Webhook、支付处理程序）
  • 不明显的位置（例如，Tauri 后端中的 src-tauri/src/lib.rs）
5. 找出注意事项

查找：

  • // DO NOT MODIFY、// IMPORTANT 或 // WARNING 等注释
  • 非标准约定或项目特有的模式
  • 单体仓库或多包结构
  • 本地运行需要 API 密钥的外部服务
  • 已知问题、TODO 或 WIP 分支
6. 编写 CLAUDE.md
# Project Name

One sentence on what this is.

## Commands
\`\`\`bash
# dev (runs on port XXXX)
command here

# build
command here

# test
command here
\`\`\`

## Key Files
- `path/to/entry.ts` — what it does
- `path/to/config.ts` — what it controls

## Stack
- Framework + version
- Database + ORM
- Auth provider
- Key external services

## Gotchas
- Non-obvious things that would trip someone up
- What not to touch without reading X first
- Any invariants the code depends on

保持在 60 行以内。省略不适用的章节。简短准确的 CLAUDE.md 总是胜过冗长凑数的文档。

评论

支持 Markdown