Docs · quickstart

From nothing to a verified change.

Four steps, one real task. About ten minutes. You need Python 3.10+ and a coding agent you already use.

Install the CLI

One package from edify-agents-cli on PyPI, zero runtime dependencies, and it puts edify on your PATH. To keep it in its own environment, pipx install edify-agents-cli or uv tool install edify-agents-cli work too.

pip install edify-agents-cli

Install the harness into a repository

Detects the stack, extracts the graph, scrapes conventions, installs the matching skills, writes a short CLAUDE.md, and records every file. Not on Claude Code? Use edify init new . to set up every runtime at once.

cd your-repository && edify init

Check the install

Green, amber or red, and exactly where. Amber means it works, degraded.

edify doctor

Run one real task in your agent

Write a short brief, then run the five commands in order. Read what the first three produce before moving on.

/spec → /plan → /tasks → /build → /verify

Skip past the film

edify init --yesreal output · edify-agents-cli 0.2.0 · 5-file sample repo

edify init --yes

reading every file, building the map

mirroring skills into each runtime

stack fastapi, python

manager - test runner pytest

graph 21 nodes · 28 edges · 5 files

conventions scraped from config files · zero model calls

skills 7 installed · 5 did not match this stack

index 71 lookup rows

mcp registry seeded with one entry: the docs server

commands 5 installed under .edify/commands/

CLAUDE.md written

agents claude · 5 commands · 7 skills

governance 33 files recorded in .edify/governance.tsv

Next: /spec — write the spec before anything else.

No model is called during edify init. The numbers are what the extractor found, and they will be different on your repository.

A question, answered from the map. Not a new chatbot.

edify graph · edify doctorreal output

edify graph where is_expired

→ src/auth/clock.py:6 symbol is_expired

edify graph dependents is_expired

→ src/auth/session.py:3 symbol create_session

edify graph references create_session

→ src/api.py:7 login · src/api.py:11 refresh

edify doctor

ok install edify 0.2.0 · 12 library entries

degraded extractor Python parsed exactly, the rest scanned

ok graph 21 nodes · 28 edges

amber means it works, degraded, and says where

/spec → /plan → /tasks → /build → /verify

Write a short brief, then run the five commands in order. Read what the first three produce before moving on.

EDIFY

docs · four steps, one real task

Now run it on one real task.

docs/quickstart.md · questions to Discussions · bugs and graph gaps to Issues

Reference

The full documentation lives in the repository.

Plain Markdown, versioned with the code, so it never describes a different release than the one you installed.

docs/quickstart.mdQuickstartinstall, init, one real task docs/cli.mdCLI referenceevery command, with real output docs/agents.mdWorks with your agentsix runtimes, one methodology docs/graph.mdThe codebase graphcoverage, honestly stated docs/verification.mdVerificationevidence over assertion docs/privacy.mdPrivacyno telemetry, and how to check docs/troubleshooting.mdTroubleshootingwhat edify doctor is telling you docs/faq.mdFAQthe questions people ask first

Help

Stuck? Ask where the answer stays findable.

Questions and ideas go to Discussions. Reproducible bugs, install problems and graph gaps go to Issues. There is no Discord yet.

Discussions ↗ Open an issue ↗