Skip to content

AllenAI2014/vibecoding-bootstrap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vibecoding-bootstrap

English | 中文


English

A one-command engineering baseline generator for vibecoding projects. Stop losing context between AI sessions — this skill sets up governance files, test scaffolds, git discipline, and a session handoff protocol so every new conversation picks up right where you left off.

The Problem

Vibecoding beginners hit the same walls:

  • Have ideas and architecture docs, but don't know how to set up a proper project structure
  • Don't know git — break something, can't roll back
  • Switch conversations, AI forgets all prior progress
  • Rules and decisions only live in chat history, never written down

What This Skill Does

  1. Generates an engineering skeleton — directories, baseline docs, test entry points
  2. Built-in session entry protocol — every new AI session reads progress / memory / index before touching code
  3. Beginner-friendly git rhythm — commit after every session, tag milestones, rollback guide
  4. Self-check mode (--mode check) — see what's set up and what's missing

Output Structure

After running, your repo gets:

AGENTS.md                              # Long-term repo rules + session entry protocol
README.md                              # Project entry point with new-session guide
CHANGELOG.md                           # Version history
.gitignore                             # Stack-specific ignores
docs/
├── progress.md                        # Cross-session progress sync
├── project_memory.md                  # Long-term memory (pitfalls, constraints)
├── PROJECT_INDEX.md                   # Directory responsibilities & dependency map
├── TEST_MATRIX.md                     # Human-readable test descriptions
├── engineering/engineering-playbook.md # Engineering workflow norms
├── runbooks/git-remote-setup.md       # Git guide for beginners
└── adr/ADR-0001-engineering-baseline.md

Python projects also get pyproject.toml, Makefile, and test stubs based on your chosen test profile.

Quick Start

# Clone or copy the skill into your project
cp -r vibecoding-bootstrap/.  your-project/.agents/skills/bootstrap-project/

# Run
python3 .agents/skills/bootstrap-project/scripts/bootstrap_project.py \
  --root "$PWD" \
  --project-name "My Project" \
  --arch-doc "docs/architecture.md"

# Self-check (no writes)
python3 .agents/skills/bootstrap-project/scripts/bootstrap_project.py \
  --root "$PWD" --mode check

Options

Flag Default Description
--root (required) Project root directory
--project-name directory name Project display name
--arch-doc none Architecture doc path (repeatable)
--stack auto auto / python / node / generic
--test-profile standard minimum / standard / advanced
--overwrite none Comma-separated files to replace (originals backed up as .bak)
--mode write write = create files; check = audit only

Test Profiles

Profile What you get
minimum One smoke test (governance files exist)
standard Smoke + unit test placeholder (recommended for beginners)
advanced Three-layer: invariants + integration + replay (for data pipelines)

Using with Different AI CLIs

This skill works with Claude Code, Codex CLI, and Gemini CLI. See Installation below.

Installation

Claude Code

mkdir -p .claude/skills
cp -r claude-code/ .claude/skills/bootstrap-project/
cp -r scripts/ .claude/skills/bootstrap-project/scripts/
cp -r references/ .claude/skills/bootstrap-project/references/

Or symlink for shared use:

mkdir -p .claude/skills
ln -s "$(pwd)" .claude/skills/bootstrap-project

Codex CLI

mkdir -p .agents/skills
cp -r codex/ .agents/skills/bootstrap-project/
cp -r scripts/ .agents/skills/bootstrap-project/scripts/
cp -r references/ .agents/skills/bootstrap-project/references/

Gemini CLI / Others

Call the script directly and pass the SKILL.md content as context:

python3 scripts/bootstrap_project.py --root "$PWD" --project-name "My Project"

Requirements

  • Python >= 3.8 (no third-party dependencies)
  • git (only needed for --mode check)

License

MIT


中文

一条命令生成 vibecoding 项目的工程基线。不再因为换会话丢上下文 —— 这个 skill 帮你建好治理文件、测试脚手架、git 纪律和会话交接协议,让每次新对话都能无缝接续。

解决什么问题

vibecoding 新手的典型卡点:

  • 有想法、有架构文档,但不知道怎么起步建工程目录
  • 不懂 git,改崩了不知道怎么回滚
  • 换了一次对话,AI 就忘了之前的进度
  • 规范只存在于聊天里,下次又要重新讲一遍

这个 Skill 做了什么

  1. 一次命令生成工程骨架 — 目录 + 基线文档 + 测试入口
  2. 内置会话开场协议 — 任何新会话的 AI 都先读 progress / memory / index
  3. 新手友好的 git 节奏 — 每次对话结束三件事、回滚指南、打 tag
  4. 自检模式 (--mode check) — 随时看"我哪里还没搞好"

产出结构

运行后你的仓库会多出:

AGENTS.md                              # 仓库长期规则 + 会话开场协议
README.md                              # 项目入口 + 新会话引导
CHANGELOG.md                           # 版本变化
.gitignore                             # 按技术栈生成
docs/
├── progress.md                        # 跨会话进度同步
├── project_memory.md                  # 长期记忆(踩过的坑、关键约束)
├── PROJECT_INDEX.md                   # 目录职责与依赖方向
├── TEST_MATRIX.md                     # 人可读测试说明
├── engineering/engineering-playbook.md # 工程工作规范
├── runbooks/git-remote-setup.md       # 新手 git 完整指南
└── adr/ADR-0001-engineering-baseline.md

Python 项目还会生成 pyproject.tomlMakefile 和对应档位的测试桩。

快速开始

# 把 skill 复制到你的项目
cp -r vibecoding-bootstrap/. your-project/.agents/skills/bootstrap-project/

# 运行
python3 .agents/skills/bootstrap-project/scripts/bootstrap_project.py \
  --root "$PWD" \
  --project-name "我的项目" \
  --arch-doc "docs/架构蓝图.md"

# 自检(不写文件)
python3 .agents/skills/bootstrap-project/scripts/bootstrap_project.py \
  --root "$PWD" --mode check

参数说明

参数 默认值 说明
--root (必填) 项目根目录
--project-name 目录名 项目显示名
--arch-doc 架构文档路径(可重复)
--stack auto auto / python / node / generic
--test-profile standard minimum / standard / advanced
--overwrite 逗号分隔的允许覆盖文件(原文件备份为 .bak
--mode write write = 生成文件;check = 仅审计

测试档位

档位 产出
minimum 一条 smoke test(治理文件存在)
standard smoke + 单元测试占位(推荐给新手)
advanced 三层:不变量 + 集成 + 回放(适用于数据管道)

适配不同 AI CLI

本 skill 兼容 Claude Code、Codex CLI、Gemini CLI。安装方式见上方英文部分的 Installation

环境要求

  • Python >= 3.8(无第三方依赖)
  • git(仅 --mode check 需要)

许可证

MIT

About

One-command engineering baseline generator for vibecoding projects. Sets up governance files, test scaffolds, git discipline, and session handoff protocol. Works with Claude Code, Codex CLI, and Gemini CLI.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors