mcpField
B
bootstrap-project

bootstrap-project

github.com/kylelundstedtAgent 工作流79 次安装
代码仓库

关于 bootstrap-project

用于为新建或现有项目建立 AI Agent 上下文的技能，适合希望 Claude Code、Codex 等 Agent 能快速理解项目的开发者。它会检查项目文件并生成 AGENTS.md、CLAUDE.md 符号链接及补充文档目录。

主要功能

  1. 01检查项目文件与技术栈
  2. 02生成项目 AGENTS.md
  3. 03创建 CLAUDE.md 符号链接
  4. 04建立 agent_docs/ 补充目录
  5. 05识别数据项目并记录布局

适用场景

  1. 01为新仓库建立 Agent 项目说明
  2. 02为缺少 AGENTS.md 的仓库补充上下文
  3. 03为数据项目记录目录约定

安装

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

$npx skills add https://github.com/kylelundstedt/dotfiles --skill bootstrap-project

安装后在 Claude Code 中输入/bootstrap-project确认已加载。

详细介绍

引导项目

设置 Agent 上下文文件，让 Claude Code、Codex 和其他 AI Agent 从第一个提示词开始就能理解项目。

何时使用此技能

在用户出现以下情况时使用：

  • 想从项目一开始就设置 Agent 上下文
  • 打开了一个缺少 AGENTS.md 的现有仓库
  • 表示“引导此项目”“设置 Agent 上下文”或类似诉求
  • 请求帮助创建 CLAUDE.md 或 AGENTS.md

步骤

1. 判断这是新项目还是现有项目

现有项目 — 当前目录包含源文件、README 或 .git 目录：

  • 跳至步骤 3。

新项目 — 当前目录不是项目，或用户想创建项目：

  • 询问：
    1. 项目名称 — 用作目录名称（kebab-case，例如 my-project）和 AGENTS.md 标题。
    2. 位置 — 父目录（默认：当前目录）。
    3. 简要说明 — 项目用途、预期技术栈、关键约束。这将在步骤 3 中取代基于文件的推断。
  • 创建目录：mkdir -p <location>/<project-name>
  • 进入该目录。
  • 运行 git init。
  • 根据描述的技术栈创建合适的 .gitignore（例如 Node、Python、Rust）。
2. 防止覆盖
  • 如果 AGENTS.md 已存在，停止并在覆盖前询问。
  • 如果 CLAUDE.md 已存在，且不是指向 AGENTS.md 的符号链接，停止并询问。
  • 如果 agent_docs/ 已存在，则跳过创建，但要说明这一点。
3. 收集项目上下文

如果以下文件或目录存在，请阅读（不要修改）：

  • README.md / README
  • package.json、pyproject.toml、Cargo.toml、go.mod 或同等清单文件
  • 顶层目录列表（向下一层）
  • CI 配置（.github/workflows/、.gitlab-ci.yml、Makefile、Justfile 等）

对于没有文件的新项目，请使用步骤 1 中用户提供的描述。

3b. 检测数据项目

如果该项目是数据管道或分析项目——例如 pyproject.toml 中有 dlt、sqlmesh、polars、duckdb 等依赖，存在 .duckdb 文件、ingest/ 或 transform/ 目录，或用户的描述表明属于此类项目——请建议采用 /data-pipelines 技能的目录布局：

ingest/          # Extraction and loading scripts
transform/       # SQL models or transformation logic
notebooks/       # marimo notebooks (.py files)
data/            # Local data files (gitignored)

将此布局纳入 AGENTS.md 的 Directory Structure 部分。对于新的数据项目，创建这些目录。对于已有不同布局的项目，记录现有内容——不要重构目录。

此外，在 Conventions 部分注明：“对于数据摄取、转换和分析工作，请使用 /data-pipelines 技能。”

4. 编写 AGENTS.md

在项目根目录创建 AGENTS.md。以下结构可供参考——每个部分都要根据步骤 3 收集的信息填写具体内容。省略不适用的部分。 输出中不得留下占位文本或尖括号标记。

结构：

  • 标题 — 项目名称。
  • 开篇句 — 一句话说明项目用途。
  • 技术栈 — 语言、框架、主要依赖项。
  • Directory Structure — 关键路径及其用途的表格。
  • Key Commands — 构建、测试、lint/格式化、开发服务器命令（仅列出现有的命令）。
  • Conventions — 编码风格、命名、分支模型、PR 流程。
  • Gotchas — Agent 应了解的非显而易见事项（环境变量、生成文件、单体仓库特性等）。
5. 创建 CLAUDE.md 符号链接
ln -s AGENTS.md CLAUDE.md

Claude Code 会读取 CLAUDE.md 获取项目指令。该符号链接可确保 AGENTS.md 是唯一可信来源。Codex 会直接读取 AGENTS.md——无需额外的符号链接。

6. 创建 agent_docs/ 目录
mkdir -p agent_docs

添加 agent_docs/README.md，以便 Git 跟踪该目录：

# agent_docs

Supplementary context for AI agents working in this repository.
Place architecture decisions, API specs, or onboarding notes here.
7. 汇报结果

打印已创建内容的摘要：

Created:
  AGENTS.md          — project context for AI agents
  CLAUDE.md          -> AGENTS.md (symlink)
  agent_docs/        — supplementary context directory

Next steps:
  - Review AGENTS.md and refine any sections
  - Add architecture docs or API specs to agent_docs/
  - Commit the new files

评论

支持 Markdown