Skip to content
Define DoneDesign partners
Quickstart

Run Timaeus locally, then on real PRs

The fastest path starts with no API key. Run the demo, reproduce the proof harness, then add the GitHub Action in shadow mode.

timaeus — proof
01

Install

Clone the reference implementation and install dependencies.

pnpm install
02

Run the no-key demo

The demo runs locally with no API key, so you can see a verdict before wiring anything up.

pnpm demo
03

Run the proof harness

Reproduce the canonical proof corpus and confusion matrix.

pnpm proof
pnpm proof:report
04

Inspect a TaskScore

Every case emits a VLS TaskScore artifact you can read or pipe into CI.

cat proof/out/checkout-promo-code/taskscore.json
05

Add the GitHub Action

Run Timaeus on real agent PRs in shadow mode — it reports without blocking.

# .github/workflows/define-done.yml
- uses: definedone/timaeus-action@v0
  with:
    mode: shadow
06

Understand VLS

Verify your own artifacts against the spec's conformance corpus.

pnpm conformance:self
pnpm timaeus doctor
Reference

Full docs live in the Timaeus repo

These link out to the canonical docs rather than duplicating them.

READMEProject overviewQUICKSTARTNo-key first pathVLS specArtifact format & schemasImplementation docsGates, review, replayProof report exampleSample run output

The Timaeus repository is in private beta. Public release is in progress — design partners get access during the cohort.