GIT-ONLY-QUICKSTART.md markdown
39 lines 1.3 KB
Raw
sha256:c07f2f34a0db9f43fe866f157d1935322008545ff8940c06c7c921eb219c55ab NXP-b DONE: independent BV-r2 pass + ISR (SD-17) Human minor ⚠ breaking 1 day ago

Git-only quickstart (Overseer Kit)

Use this when you have a plain GitHub repo and no MuseHub. The kit’s governance features work on Git alone; Muse is optional.

Prerequisites

  • A clone of overseer-kit (or a path to its cli/ok shim)
  • A GitHub repository (empty or existing)
  • Python 3.11+ available to the shim (kit .venv is fine)

No Muse install is required for git-only.

Commands

From your consumer repo (or with -C <repo>):

# Greenfield (empty / new repo)
<path-to-overseer-kit>/cli/ok -C . init --regime git-only --non-interactive

# Status + footprint check
<path-to-overseer-kit>/cli/ok -C . status --check-footprint

# Governance hygiene probe (default dry-run — writes nothing)
<path-to-overseer-kit>/cli/ok -C . governance-sync --dry-run

# Freeze review on a sample artifact
<path-to-overseer-kit>/cli/ok -C . review --freeze docs/<artifact> --dry-run

For repos that already have hand-authored handover/roadmap files, use migrate (see docs/MIGRATE-EXISTING-REPO.md) instead of greenfield init.

Guardrails

  • K7: no core governance capability is MuseHub-only. git-only is a first-class baseline.
  • Never commit secrets into .overseer/config.yaml (names and booleans only).
  • Feature-branch commits only; do not auto-merge to main.
File History 1 commit
sha256:c07f2f34a0db9f43fe866f157d1935322008545ff8940c06c7c921eb219c55ab NXP-b DONE: independent BV-r2 pass + ISR (SD-17) Human minor 1 day ago