From zero to your first VibeCrafted loop.

Install the framework, verify the control plane, then run a real workflow inside a live repository. The goal is first signal fast, not endless setup.

Step 1

Install the framework

Use the public bootstrap path. It stages a local snapshot under ~/.vibecrafted/tools/ and runs the orchestrator from that local copy.

curl -fsSLO https://raw.githubusercontent.com/VetCoders/vibecrafted/main/install.sh
bash install.sh

Open a new terminal when the install finishes, or source the installed helper file directly in your current shell.

Step 2

Run the doctor

Check the staged control plane, shell helpers, and optional foundations before you blame the workflow.

vibecrafted doctor

If something is yellow, the doctor tells you what is missing instead of leaving you to guess.

Step 3

Bootstrap context inside a real repo

Move into the project you actually care about, then give the agent the prompt that forces context gathering before edits.

cd ~/your-project
vc-init claude

vc-init reads history, maps structure, and runs quality gates before implementation starts.

Step 4

Hand over a real task

Once the context is anchored, run the full delivery path or a narrower workflow depending on how much control you want.

vc-justdo codex "Add user authentication with JWT"
vc-workflow claude "Plan and implement auth module"

Use Just do for end-to-end ownership. Use vc-workflow when you want explicit Examine -> Research -> Implement structure.

Step 5

Spawn the fleet when one model is not enough

External agent helpers are there for parallel fieldwork and durable artifacts, not for theatre.

vibecrafted codex implement .vibecrafted/plans/my-plan.md
vibecrafted claude research .vibecrafted/plans/my-plan.md
vibecrafted gemini implement .vibecrafted/plans/my-plan.md

Step 6

Close the loop before you call it done

Shipping in VibeCrafted means code quality, product-surface truth, and packaging truth.

vc-dou claude
vc-hydrate codex
vc-release codex

The framework is complete when a stranger can discover, understand, install, and trust the thing, not when your tests stop yelling.

What you need

Minimal prerequisites

  • macOS or Linux
  • Git, Python 3.10+, and make
  • One or more agent CLIs: Codex, Claude, or Gemini
  • Optional but high-value foundations: loctree, aicx, prview, ScreenScribe

What you get

Operational surfaces after install

  • A central skill store under ~/.vibecrafted/skills/
  • Artifacts grouped by repo and date under ~/.vibecrafted/artifacts/
  • Shell helpers for spawning, observing, marbles, DoU, hydrate, and release
  • A staging-friendly control plane under ~/.vibecrafted/tools/