Skip to main content

10-Minute Quickstart

Govern your first change end to end: install, open the console, run one story from idea to approval, watch the graph move. Every command below is real; outputs trimmed for readability.

1. Install (1 minute)​

pip install vyasa-vidhi
vyasa --version

2. See it (2 minutes)​

vyasa serve

Opens the console in your browser (address printed in the terminal). You see projects, a live graph, and detail panels — the same engine you'll drive from the terminal below, visualized. Leave it running; do the rest in a new terminal.

3. Start a project (1 minute)​

vyasa init startup --name refund-demo

Vyasa scaffolds a governed project and prints its suggested next steps — follow them literally; the product teaches its own loop:

Project created refund-demo
Workflow: Startup SDLC  |  Tier: standard  |  Stages: 2  |  Kinds: 6
Next steps
  Create nodes to define your work units:
    vyasa node create --type user-story --id <your-id>

4. Declare one piece of work (30 seconds)​

vyasa node create --type user-story --id US-1
Created node: US-1
Type:  user-story

A node is one card on the board: its own status, files, history.

5. Open a sitting (1 minute)​

A session needs eight details — skill, mode, stage, target, intent, work style, objective, flow. Miss any and Vyasa refuses with the exact fix (this refusal is normal — it's the product refusing to guess):

vyasa session start --skill ba --mode writing --stage spec-stage \
  --target US-1 --intent specify --flow simple \
  --work-style standard --objective 'capture refund policy change'
Session started: 94c3066f
Name:        US-1-spec-stage-specify
Risk score:  0

Behind that panel: the engine validated everything, locked the node (nobody else can work it now), and prepared a briefing for the worker. Stuck? Add --interactive and answer guided prompts instead of flags.

6. Produce the work (2 minutes — you play the assistant)​

Normally vyasa assistant use launches a real AI worker. Here, write its output by hand so you feel the mechanics — the engine cannot tell the difference, and that is the point. Create:

.vyasa/proposed-changes/94c3066f/content/docs/stories/US-1.md (use your real session id from step 5):

# US-1

## Title

Refund policy change: 30-day returns for all orders

## Description

As a shop owner, I want the refund policy extended from 14 to
30 days, so customers buy with confidence.

## Acceptance Criteria

- Policy page states a 30-day return window.
- Checkout confirmation mentions the 30-day window.
- Orders older than 30 days remain non-refundable.

Then check it and close the sitting:

vyasa validate --session 94c3066f
# Validation passed
vyasa session end 94c3066f
# Session ended: 94c3066f

7. Inspect, apply, approve (2 minutes)​

vyasa review diff 94c3066f
# NEW files: docs/stories/US-1.md (17 lines) + full content

vyasa apply approve --id 94c3066f --yes
# Applied: US-1 → docs/stories/US-1.md
# Files applied to project (status unchanged)

vyasa gate run --node US-1
# PASS schema-check · PASS score-above · PASS governance-rules

vyasa gate approve --node US-1
# Approved: US-1 — draft -> review
vyasa gate approve --node US-1
# Approved: US-1 — review -> approved

Notice the separation: applying moved the FILE; only gates moved the STATUS. Refresh your console — US-1 sits approved on the graph, with its history attached.

8. What just happened (30 seconds)​

You (governor) → session → worker output → validate → end →
review → apply → gate → APPROVED → trace

One loop, five stations, every step recorded. Everything else in these docs is this loop, larger: more kinds of work, validator scoring, team timelines, industry workflows.

Next: What Is Vyasa for the five words behind the loop — or jump to your door. Stuck anywhere? When It Says No.