Get Started
DocsTrack 2specs
/llms.txt
Spec-Driven Delivery4 min readbrevio-core v0.11.1

Starter Specs (brevio-core init --specs: CLAUDE.md, CONSTITUTION.md, roadmap.json)

Plain-English Summary (For Anyone)

Give your coding agents written project rules and a task list

brevio-core can write three starter files for your repository: CLAUDE.md (agent instructions), CONSTITUTION.md (the invariants you want kept) and roadmap.json (a machine-readable task list). They are starting points that you edit.

Why this matters:
Agents work better when the boundaries of a project are written down where they read them.
The files are plain text and JSON, committed to git and reviewed like code.
`init` also adds a short rules block to AGENTS.md, which most agents read before they start.
When to use:Run once on a new repository, or when you bring a new coding agent to an existing one.
Technical Contract (For Engineers)
Line-level rules
CLI Invocation Signature:
brevio-core connect [--root ROOT] [--dry-run] [--yes] [--force] [--json] | brevio-core init --specs
Latency / Execution
Not measured for 0.11.1
Token Cost
No model call. No API key.
Exit Codes
0 = success; 1 = findings; 2 = usage error
Artifacts & Files Generated:
CLAUDE.mdCONSTITUTION.mdroadmap.json
Visual Execution Pipeline
5-Stage Progressive Flow
01Local
Detect
Detect Python, TypeScript and Node code and the coding clients here
02Writes nothing
List
connect --dry-run lists the files it would write
03--yes to skip
Write
Write CLAUDE.md, CONSTITUTION.md and roadmap.json after a yes
04Yours
Edit
Replace the starter text with your own invariants

Why Write the Rules Down

In Plain English:Without written boundaries, an agent asked to add a small feature may replace your database client, change your UI framework, or add a library you do not want.
brevio-core writes three starter files from templates, with no model call. They are meant to be edited: the starter text is generic, and the value comes from the invariants of your own project.

CLAUDE.md: Agent Instructions

In Plain English:Tells Claude Code and other agents how to work in this project.
`CLAUDE.md` is the file Claude Code reads on startup. The starter points it at AGENTS.md and CONSTITUTION.md. Add your build, test and lint commands and any codebase layout notes.

CONSTITUTION.md: Your Architectural Invariants

In Plain English:The rules of your repository, written in your words.
`CONSTITUTION.md` holds the invariants you want every change to respect, for example 'every query on a tenant table filters by tenant_id' or 'money is stored as integer cents'. The example below is an illustration of what a team might write, not what brevio-core generates.
A CONSTITUTION.md Written by a Team (Example)
Fixed (After)Exit 0
# Project Constitution

## 1. Security & Multi-Tenancy
- Every database query on a scoped table filters by `tenant_id`.
- Credentials come from environment variables, not from source files.

## 2. Billing
- Prices are stored as integer cents.
- No floating-point arithmetic on money.

roadmap.json: A Machine-Readable Task List

In Plain English:A structured list of tasks that your agents, or you, can pick from.
`roadmap.json` holds `items`, each with an `id`, a `title`, a `priority` (P0, P1 or P2), a `type`, a list of `acceptance_criteria` and a `status` (the starter items begin as `todo`). `brevio-core task` reads the roadmap when it is given a task id.

Interactive Rule Explorer

Explore the brevio-core rules and load their examples into the panel on the right.

129 / 129 rules