The 41 documents that ship with vibecrafted.
Install path, architecture, vc-* skills reference, release discipline,
FAQ. Sourced from the canonical repo at vetcoders/vibecrafted
and synced to this site. No marketing prose: each document is the same
one an operator reads at the terminal.
Getting started
Install Vibecrafted, verify the runtime, and complete your first workflow.
-
What is Vibecrafted
A local-first release engine that runs coding agents through a disciplined lifecycle, from first draft to shippable product.
Open -
Install
Install Vibecrafted on macOS, Linux or Windows through WSL2, and verify the result with doctor.
Open -
Build from source
Clone the repository, install from the checkout, run the gates, and build your own signed desktop artifact.
Open -
Quick start
Your first five minutes: orient an agent, run a workflow, watch the run, and find the durable report.
Open -
First run
What happens on your first Vibecrafted command, how missing agent CLIs are reported, and how to read doctor on a fresh install.
Open -
Update and rollback
How vibecrafted update publishes atomic runtime generations, how to roll back by pointer, and how to uninstall cleanly.
Open
Concepts
The operating model: living trees, evidence, runtime generations, and delivery truth.
-
Architecture
The Vibecrafted runtime topology: one control plane owns run truth, every other surface is a projection.
Open -
Living Tree
The shared-checkout doctrine: agents work in one moving tree by default; verifier-gated fleet dispatches may isolate cuts in worktrees under a single integrator.
Open -
Read–Write cadence
Why the lifecycle alternates read-only perception with write action, and how the runtime enforces the split.
Open -
Runtime capsule
Installed runtime generations: immutable directories, an atomic current pointer, a hash-bound manifest, and safe rollback.
Open -
Delivery proof
Evidence discipline: report frontmatter, claims versus settlement, the f/x/n ledger, and why a process exit never finalizes anything.
Open -
Agents
The fleet model: five equal agent CLIs, one launcher shape, honest attribution, and headless workers that survive terminal loss.
Open
CLI
Command-line surfaces for health, status, updates, workflows, and receipts.
-
CLI Overview
Command anatomy of the vibecrafted CLI: management commands, skill launchers, agent modes, uniform flags, and aliases.
Open -
Management Commands
Reference for vibecrafted management commands: init, status, doctor, receipt, settlements, update, resume, version, uninstall, help.
Open -
Workflow Launchers
The skill launcher catalogue: the canonical pipeline order and every additional skill with its purpose and an example invocation.
Open -
Following Runs: Observe and Await
How to follow dispatched runs with observe and await, where run truth lives on disk, and the three-signal rule for declaring a run finished.
Open -
vc-frame: The Terminal Dashboard
Operator dashboard surfaces: vibecrafted dashboard layouts, session management, gui and tui, and the headless-worker invariant.
Open
Lifecycle
The craft, converge, and ship stages that move a repository toward release.
-
Lifecycle Overview
The vc-ship umbrella: one mission through eleven supervised stages, the baton relay, stage reports as cargo, and launch forms.
Open -
The Eleven Stages
Reference for the eleven lifecycle stages: order, READ/WRITE phase, purpose, tooling, and what each stage report must show.
Open -
Lifecycle Supervision
The human-controls verbs for lifecycle runs: status, approve, interrupt, fallback, force-audit, accept-dou, and dead-worker recovery.
Open
Dispatch
How work is routed to agents and how completed runs settle.
-
Dispatch Overview
Deterministic dispatch lines: what vibecrafted dispatch does, when to use it instead of ship, and the doctor, dry-run, and resume flags.
Open -
Dispatch Schema (vibecrafted.dispatch.v1)
TOML reference for dispatch plans: meta, policy, phases, cuts, verify matchers, recovery, and placeholder rendering.
Open -
Agent-agnostic worktree runtime migration
Move active fleets from provider-specific worktrees and shared Cargo outputs to the canonical Vibecrafted runtime geometry.
Open -
Briefs and Reports: The Worker Contract
The worker contract: brief files as mission input, the report path environment contract, report frontmatter fields, and where artifacts land.
Open
Server
Local control-plane services, integrations, and operator interfaces.
-
Server overview
The local control-plane server: one read model over ~/.vibecrafted/control_plane, served as a dashboard, HTTP API, and SSE stream.
Open -
HTTP API
Read-model reference for the local server: health, control-plane state, runs, lifecycle runs, and the SSE event stream.
Open -
MCP server
The vibecrafted-mcp stdio server: board, run, and lifecycle tools that give agents the same control-plane truth as the HTTP API.
Open -
Slack gateway
An always-on Slack bridge bound to the omni-observer: mention-to-run dispatch, status commands, and a fail-closed policy surface.
Open
Skills
The vc-* skills, when to invoke them, and the evidence they leave behind.
-
Skills overview
What a Vibecrafted skill is, the three ways to invoke one, and how READ and WRITE skills divide the lifecycle.
Open -
Skills catalog
Every shipped skill grouped by pipeline position, with phase, purpose, and an example invocation.
Open -
Authoring skills
Write your own vc-* skill: scaffold the layout, meet the frontmatter contract, wire the launcher, and pass the discoverability gates.
Open
Configuration
Runtime and agent configuration contracts.
-
Configuration
The config surfaces of Vibecrafted: the install manifest, the state root, the installed runtime root, and XDG config.
Open -
Environment variables
Stable environment variables you can set, and the worker-injected variables you should read but never set yourself.
Open -
Terminal frontier
The optional operator terminal layer: starship prompt, atuin history, and vc-frame layouts installed from the runtime generation.
Open
Troubleshooting
Diagnose install, runtime, and agent failures with concrete checks.
-
Doctor
vibecrafted doctor is the canonical health gate: what it audits, how to read the output, and how receipt adds provenance.
Open -
Common issues
A failure playbook: symptom, diagnose command, and fix for the most frequent install and runtime problems.
Open -
FAQ
Answers to the questions engineers ask before they trust the runtime — installation, agents, workflows, and licensing.
Open
Reference
Stable contracts, schemas, security guidance, and terminology.
-
Glossary
Definitions of the Vibecrafted vocabulary: baton, control plane, marbles, settlement, waves, and the rest.
Open -
Design decisions
Public digest of the accepted architecture decision records: standalone justdo and one owner per truth domain.
Open -
Security
Security posture: local-first data, verified installs, secret hygiene gates, known boundaries, and how to report a vulnerability.
Open -
Versioning
Release conventions: MAJOR.MINOR.PATCH versions, +g<sha> build provenance, changelog discipline, and how to verify what you run.
Open