Skip to main content

Quick Start

Use this to install VibeGov, a repo-local governance framework for AI-assisted software delivery, quickly with the hardened bootstrap contract.

Quick Start is the action path. Use Start Here only when you still need to choose between orientation, install, operating guidance, and deeper governance reading.

TLDR​

Use this page when you want the fastest practical path to bootstrap a repo with VibeGov.

Minimum takeaway:

  • Quick Start is a compressed path into the same bootstrap contract, not a separate weaker contract.
  • Choose init, update, or review before running the prompt.
  • Stop before product-code implementation once governance, specs, workflow, continuity, and reporting surfaces are ready.

Next action:

Bootstrap now uses one canonical contract with explicit modes:

  • init
  • update
  • review

Use Bootstrap as the canonical contract surface.

If you need the support docs​

Quick Start is the short path, not the whole support surface. When those topics come up, jump directly to:

  • GitHub Project Bootstrap for GitHub preflight, board setup, repo linkage, and GitHub-state reconciliation
  • INIT-TODO.md for durable prerequisite/remediation capture
  • Bootstrap Update if the repo already has bootstrap state and needs normalization
  • Bootstrap Review if you need an audit against the same contract without claiming missing work was completed

Copy-paste bootstrap prompt​

Run VibeGov bootstrap in mode: <init|update|review>.
Read and follow:
- https://vibegov.io/agent.txt
- https://vibegov.io/bootstrap.json
- https://vibegov.io/docs/bootstrap/

Use the same canonical bootstrap contract for all modes.
Do not fork or weaken the pass gate by mode.

Fast contract summary:
1) Create/normalize `.governance/rules/`, `.governance/project/`, and `.governance/specs/`.
2) Install the active VibeGov rule set (`GOV-01` through `GOV-13`) in `.governance/rules/`.
3) Detect existing provider-native rules dirs and mirror only when already present.
4) Create/normalize `PROJECT_INTENT.md`.
5) Create `SPEC-001` (feature spec, or bootstrap/governance-setup spec when product intent is still vague).
6) Map backlog to spec sections.
7) Install/verify early bootstrap artifacts before implementation:
   - `AGENTS.md`
   - `INIT-TODO.md`
   - PR template
   - branch-protection checklist
   - documented default issue-pickup flow
8) Install/verify continuity bootstrap expectations before implementation:
   - documented continuity layers
   - repo-local continuity paths or equivalent scaffolding
   - checkpoint trigger guidance
   - session-diary guidance for recurring contexts
   - promotion guidance between continuity layers
9) If `git` is available but the current folder is not yet an initialized repo, run `git init` first and record the pre-init local state you are preserving; remote setup is not required for that pre-step.
10) Classify repo start state (branch, clean/dirty, untracked, uncommitted) and declare commit policy (`required|allowed|forbidden`).
11) For GitHub repos, run preflight before board mutation; if required capability is missing, record exact remediation in `INIT-TODO.md`.
12) If GitHub automation is available, adopt/create/normalize one canonical board target; prefer copying a configured template for new boards; normalize `Status`/`Project Priority`/`Order`/`Priority`/`Size`; normalize the default table view to `Title`, `Assignees`, `Status`, `Project Priority`, `Order`, `Priority`, `Repository`; document backlog pickup as `Project Priority` group then `Order` inside the group; link the repo; and report intentionally empty boards, view-capability blockers, or duplicate-board cleanup explicitly when relevant.
13) Write durable bootstrap reporting artifacts under `.governance/project/bootstrap/` plus a historical run bundle under `.governance/project/bootstrap/history/<timestamp>/`.
14) Reconcile docs/artifacts against final live git/GitHub state.
15) Then stop before product-code implementation.

Use [Bootstrap](/docs/bootstrap) as the canonical full contract when any detail matters.

Canonical URLs​

Notes​

  • Quick Start is a compressed path into the current bootstrap contract, not a separate weaker contract.
  • Scaffold-only output is incomplete for GitHub-hosted repos unless missing operational pieces are explicitly blocked and reported.
  • If product intent is unclear, do not invent domain direction from repo name.
  • Prefer bootstrap/update remediation that preserves valid artifacts and only repairs weak/missing/contradictory state.
  • If you hit GitHub board/preflight questions, jump to GitHub Project Bootstrap.
  • If you need durable prerequisite or remediation capture, jump to INIT-TODO.
  • If any detail matters, defer to Bootstrap as the canonical full contract.