Quick Start
You have an AI-built repo. You want to ship it without the vibe hangover.
Synced β 2026-05-12
source: docs/QUICK_START.md
Quick Start
You have an AI-built repo. You want to ship it without the vibe hangover.
1. Install
Browser-guided path for the human kickoff:
curl -fsSL https://vibecrafted.io/install.sh | bash -s -- --gui
The bootstrap explains what it will do and asks before proceeding on an
attended terminal. Pass --yes if you want to pre-approve that bootstrap
prompt.
This path stages the control plane, bootstraps the foundation layer, and runs the compact installer truth used by automation as well.
Compact path for scripting or terminal-only installs:
curl -fsSL https://vibecrafted.io/install.sh | bash
Non-destructive. Interactive. Tells you what it does before it does it.
Asks before touching your shell config. Everything reversible with
make -C $VIBECRAFTED_ROOT/.vibecrafted/tools/vibecrafted-current uninstall.
Inside a local checkout, make vibecrafted runs the terminal-native installer
wizard (default shell-first front door) and make install stays
direct/non-interactive. If you prefer the browser-guided surface, run
make wizard or the alias make gui-install.
After install, open a new terminal or:
source "${XDG_CONFIG_HOME:-$HOME/.config}/vetcoders/vc-skills.sh"
2. Verify
make -C $VIBECRAFTED_ROOT/.vibecrafted/tools/vibecrafted-current doctor
Green means ready. Yellow means the doctor tells you why.
3. Orient your agent
Go to any git repo:
cd $VIBECRAFTED_ROOT/your-project
vibecrafted init claude
This runs vibecrafted init claude β the command-deck front door for vc-init.
Your agent gets three things before touching anything:
- Intentions β what was done before (indexed session history)
- Sight β what the code looks like now (structural map via loctree)
- Ground truth β whether quality gates actually pass
Your agent now has orientation instead of assumptions.
4. Build something
vibecrafted implement codex --prompt "Add user authentication with JWT"
vibecrafted implement runs the autonomous delivery contract in vc-implement
(justdo remains an alias for existing prompts and shell environments):
- Orient β map the repo, load prior intent, and choose the smallest shape that works
- Implement β make the change, add tests, and integrate with the live runtime
- Converge β run followup, then
vc-marblesif P0 or P1 findings remain - Return β hand back a verified surface with the next truthful move called out
5. Run phases individually
vibecrafted scaffold claude --prompt "Plan the auth architecture" # vc-scaffold
vibecrafted init claude # vc-init
vibecrafted intents codex --prompt "Audit what from the plan landed" # vc-intents
vibecrafted workflow claude --prompt "Plan and implement auth" # vc-workflow
vibecrafted review codex --prompt "Audit the auth changes" # vc-review
vibecrafted marbles codex --count 3 --depth 3 # vc-marbles
vibecrafted ownership codex --prompt "Take this surface to done" # vc-ownership
vibecrafted dou claude --prompt "Audit launch readiness" # vc-dou
vibecrafted decorate codex --prompt "Polish the surface" # vc-decorate
vibecrafted hydrate codex --prompt "Package the product" # vc-hydrate
vibecrafted release codex --prompt "Prepare release steps" # vc-release
6. Multi-agent research
For hard problems, send the same question to multiple planners:
Research: what is the best auth strategy for this codebase?
vc-partner sends the same plan to Claude, Codex, and Gemini independently.
You get three expert opinions. Synthesize the strongest parts. Resume the
winning agent into implementation.
7. Convergence loops
When the code is close but not done:
vibecrafted marbles codex --prompt "Fill the gaps on the auth module" --count 3
The agent enters a convergence loop β tools find what is wrong, agent fixes it, tools check the new landscape, repeat. Stops when no tool can find a single remaining accusation.
The tab trick
Type vibecrafted help for the command deck. Once shell helpers are loaded,
vc- wrappers stay available as shortcuts.
For the full route inventory, see SKILLS. For the framework-wide flow map, see WORKFLOWS.
Preparing the public launch surface and directory submissions? Use Release Kickoff together with Submission Forms.
//πππππππππππ.