在30秒内生成您的 CLAUDE.md(交互脚本)
发布: (2026年2月15日 GMT+8 13:28)
3 分钟阅读
原文: Dev.to
Source: Dev.to
它的功能
claude-md-generator.sh 是一个 Bash 脚本,会询问你关于项目的八个问题,并生成一个 CLAUDE.md 文件,内容包括:
- 项目概述和技术栈
- 代码风格和测试命令
- 语言特定规则(七种预设:Python、JavaScript/TypeScript、Go、Rust、Java、Shell、Other)
可选安全模块
- 危险命令保护(
rm -rf、git reset --hard等) - 外部操作门禁(在
git push、API 调用等之前需要批准) - 错误追踪约定
试一试
交互模式
交互式回答八个问题:
curl -sLO https://gist.githubusercontent.com/yurukusa/9e710dece35d673dd71e678dfa55eaa3/raw/claude-md-generator.sh
bash claude-md-generator.sh
默认模式
使用合理的默认值生成文件,且不出现提示:
bash claude-md-generator.sh --defaults
自定义输出路径
bash claude-md-generator.sh --defaults --output ./my-project/CLAUDE.md
输出示例
使用默认参数运行脚本会生成包含八个章节的文件。下面是一个裁剪后的示例:
# CLAUDE.md — My Project
## Project Overview
...
## Tech Stack & Language Rules
- Language: Python
- Run `python -m py_compile` after editing .py files
...
## Dangerous Command Protection
NEVER run these commands without explicit user approval:
- `rm -rf`
- `git reset --hard`
...
## External Action Safety
Before any external action (git push, API calls, posting):
1. State what you're about to do
2. Wait for approval
...
每个章节都是有条件的——如果你对某个安全特性回答“否”,该章节将被省略,只保留你真正需要的内容。
为什么要有它
在没有 CLAUDE.md 的情况下让 Claude Code 自动运行可能导致:
- 意外对被视为“临时”的目录执行
rm -rf - 未经批准的 GitHub 推送
- Lint 规则违规和代码风格漂移
- 会话重启时上下文丢失
精心编写的 CLAUDE.md 可以防止上述所有问题。此脚本汇集了数月试验和错误的经验教训。
获取脚本
- 独立 Gist: claude-md-generator.sh
- 更大工具集的一部分: claude-code-ops-starter – 包含四个免费安全钩子、生成器以及
CLAUDE.md模板
无需除 Bash 之外的依赖,无网络请求,MIT 许可证。脚本大约运行 30 秒,安全规则会在每个 Claude Code 会话中持续生效。