init-project

Featured

初始化项目 AI 上下文,生成/更新根级与模块级 CLAUDE.md 索引

AI & Automation 6,083 stars 421 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 88/100

Stars 20%
100
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
57
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

## 用法 `/init-project <项目摘要或名称>` ## 目标 以"根级简明 + 模块级详尽"的混合策略初始化项目 AI 上下文: - 在仓库根生成/更新 `CLAUDE.md`(高层愿景、架构总览、模块索引、全局规范)。 - 在识别的各模块目录生成/更新本地 `CLAUDE.md`(接口、依赖、入口、测试、关键文件等)。 - ✨ **为了提升可读性,会在根 `CLAUDE.md` 中自动生成 Mermaid 结构图,并为每个模块 `CLAUDE.md` 添加导航面包屑**。 ## 编排说明 **步骤 1**:调用 `get-current-datetime` 子智能体获取当前时间戳。 **步骤 2**:调用一次 `init-architect` 子智能体,输入: - `project_summary`: $ARGUMENTS - `current_timestamp`: (来自步骤1的时间戳) ## 执行策略(由 Agent 自适应决定,不需要用户传参) - **阶段 A:全仓清点(轻量)** 快速统计文件与目录,识别模块根(package.json、pyproject.toml、go.mod、apps/_、packages/_、services/\* 等)。 - **阶段 B:模块优先扫描(中等)** 对每个模块做"入口/接口/依赖/测试/数据模型/质量工具"的定点读取与样本抽取。 - **阶段 C:深度补捞(按需)** 若仓库较小或模块规模较小,则扩大读取面;若较大,则对高风险/高价值路径分批追加扫描。 - **覆盖率度量与可续跑** 输出"已扫描文件数 / 估算总文件数、已覆盖模块占比、被忽略/跳过原因",并列出"建议下一步深挖的子路径"。重复运行 `/init-project` 时按上次索引做**增量更新**与**断点续扫**。 ## 安全与边界 - 只读/写文档与索引,不改源代码。 - 默认忽略常见生成物与二进制大文件。 - 结果在主对话打印"摘要",全文写入仓库。 ## 输出要求 - 在主对话中打印"初始化结果摘要",包含: - 根级 `CLAUDE.md` 是否创建/更新、主要栏目概览。 - 识别的模块数量及其路径列表。 - 每个模块 `CLAUDE.md` 的生成/更新情况。 - ✨ **明确提及"已生成 Mermaid 结构图"和"已为 N 个模块添加导航面包屑"**。 - 覆盖率与主要缺口。 - 若未读全:说明"为何到此为止",并列出**推荐的下一步**(例如"建议优先补扫:packages/auth/src/controllers")。

Details

Author
UfoMiao
Repository
UfoMiao/zcf
Created
1 years ago
Last Updated
1 weeks ago
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Featured

claude-md

按最佳实践创建或更新 CLAUDE.md 文件,以便为 AI agent 提供最优的项目入门上下文

41,440 Updated 5 days ago
luongnv89
AI & Automation Listed

academic-project-init

AI 学术研究项目初始化(乔淼PhD · AI学术训练营 · AI学术工作流)。为一篇论文建标准项目结构:01_选题 / 02_文献(pdf_download·模块·深读)/ 03_方法 / 04_数据 / 05_全文初稿 / 06_skill源材料 + CLAUDE.md(命名规则与产出位置总表)+ AGENTS.md。初始化后,选题/文献搜索/文献分析/研究设计/数据分析/全文初稿等 skills 都能按命名表自动读写、互相衔接。Trigger on:"初始化一个学术项目"、"新建论文项目文件夹"、"建一个 AI 学术工作流项目"、"set up an academic paper project"、"initialize research project folder"。

7 Updated 1 months ago
qiaomiaojoe
Data & Documents Listed

project

新工作项目文件夹初始化(三档标准:最小 / 流水线 / 板块):盘点目录 → 判断要不要 git / 该上哪一档 → 生成 .gitignore / README / CLAUDE.md / TODO / 口径记录 / 在线资产注册表 / snapshots 骨架 → 密钥扫描 → 首提交,并核查本机备份状态。凡用户新建/接手一个工作目录、说"给这个文件夹加 git"、"初始化项目"、"这个项目要怎么建"、"要不要 gitignore"、"帮我把这个目录规范起来"、"新开一个 xx 项目",或在一个没有 .git / 没有 CLAUDE.md 的目录里开始做数据分析、运营、外链、PR 类工作时,都��本 skill——哪怕用户只提到其中一件(比如只问 gitignore),也应走完整流程判断其余项是否需要。不用于纯软件工程仓库的脚手架(那有语言自带工具)。

0 Updated 2 weeks ago
yaotong34