Skip to content

Getting Started

Prerequisites

Set your API key:

bash
export ANTHROPIC_API_KEY="sk-ant-..."

Or use claude login if you have Claude Code installed.

Install

bash
npm install -g vibe-racer

Verify the installation:

bash
vibe-racer --version
# 0.2.0

Your First Race

1. Initialize your project

Navigate to any project directory and run:

bash
cd your-project
vibe-racer init

This creates:

  • .vibe-racer.yml -- configuration file
  • plans/ -- directory for task plan documents

2. Create a task

bash
vibe-racer new "Add user authentication"

This creates plans/0001_add-user-authentication/ with:

  • state.yml -- pipeline state tracker
  • 00_objective.md -- your objective template

3. Write your objective

Open plans/0001_add-user-authentication/00_objective.md and describe what you want to build. Be as detailed or as brief as you like -- the race engineer will ask clarifying questions.

Then tick the checkbox at the bottom:

markdown
- [x] Ready to advance to Objective Review

4. Drive the first lap

bash
vibe-racer drive

The race engineer picks up your task, reads the objective, and generates product-scoping questions in 01_product_questions.md. Each question includes the race engineer's recommended answer pre-filled.

5. Review at the pit stop and iterate

Open the questions file. Read each answer. Edit only what you disagree with. Then tick the checkbox at the bottom and drive again:

bash
vibe-racer drive

Repeat this cycle through all 5 laps:

Lap 1: Objective -> Lap 2: Product -> Lap 3: Design -> Lap 4: Plan -> Lap 5: Execute

6. Check the pit wall

At any point, see where your tasks stand:

bash
vibe-racer pitwall

What Happens at Each Lap

LapYou doRace engineer does
ObjectiveWrite what you want to buildReviews, asks product questions
ProductReview/edit pre-filled answersWrites product spec, asks design questions
DesignReview/edit pre-filled answersWrites design spec, asks plan questions
PlanReview/edit pre-filled answersWrites implementation plan + execution playbook
ExecuteReview the plan, tick the checkboxImplements code milestone by milestone

Tips

  • You don't need to fill everything in -- the race engineer pre-fills recommended answers. Only edit disagreements.
  • If the race engineer needs more info, it will radio back with follow-up questions and uncheck the checkbox. Answer them and re-tick.
  • Small tasks? The race engineer can flag them as trivial during objective review, skipping product and design laps.
  • Need to discuss? Use vibe-racer radio to open an interactive session with the race engineer at a pit stop.

Released under the MIT License.