QUICK START FIG. 09 Β· DWG VC-009

From zero to your first Vibecrafted loop.

Install Vibecrafted, run doctor, then start one real workflow inside a live repository.

From AI-generated repo to launch-ready product.

Back to Overview Open Framework
STEPS Β· 06 STAGES INSTALL β†’ SHIP
  1. Β§ 01 Step 1

    Install the framework

    Use the public bootstrap path. For the browser installer, run make vibecrafted in the repo.

    $ curl -fsSL https://vibecrafted.io/install.sh | bash

    Use the direct | bash path only when you already want compact automation instead of the guided kickoff.

  2. Β§ 02 Step 2

    Run the doctor

    Check the install, shell helpers, and required foundations before starting a workflow.

    $ vibecrafted doctor

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

  3. Β§ 03 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 $VIBECRAFTED_ROOT/your-project vibecrafted init claude

    vibecrafted init is the main front door. It reads history, maps structure, and runs quality gates before implementation starts.

  4. Β§ 04 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.

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

    Use vibecrafted justdo for end-to-end ownership. Use vibecrafted workflow when you want explicit Examine -> Research -> Implement structure.

  5. Β§ 05 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

    These are the friendly launcher surfaces. The portable spawn-script contract lives in the Runtime Contract.

  6. Β§ 06 Step 6

    Close the loop before you call it done

    Shipping in πš…πš’πš‹πšŽπšŒπš›πšŠπšπšπšŽπš. means code quality, product-surface truth, and packaging truth.

    $ vibecrafted dou claude --prompt "Audit launch readiness" vibecrafted decorate codex --prompt "Polish the release surface" vibecrafted hydrate codex --prompt "Package the product" vibecrafted release codex --prompt "Prepare release steps"

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

FOUNDATIONS Β· CANONICAL SOURCES PREREQ β†’ SURFACE
What you need

Minimal prerequisites

  • macOS or Linux
  • Git, Python 3.10+, and make
  • One or more agent CLIs: Codex, Claude, or Gemini
  • Required foundations: loctree and aicx
  • Recommended evidence tools: prview and ScreenScribe
What you get

Operational surfaces after install

  • A central skill store under $VIBECRAFTED_ROOT/.vibecrafted/skills/
  • Artifacts grouped by repo and date under $VIBECRAFTED_ROOT/.vibecrafted/artifacts/
  • Shell helpers for spawning, observing, marbles, DoU, hydrate, and release
  • A staging-friendly control plane under $VIBECRAFTED_ROOT/.vibecrafted/tools/
Canonical sources
Answered FAQ Foundation Stack Markdown Version Runtime Contract ScreenScribe Review Gate Content Truth Matrix
Next step

Once quickstart makes sense, move into the explanatory layer.

FAQ Foundation Overview