revier is a project-grouped control surface for running coding agents: it shows
what every agent across every project is doing and reaches the one that needs
you. A target is reached one way — run-or-raise it, revier's or its command's;
a second press returns to the project's home. An agent or shell tab is a
launcher: each press opens one more. Go, ports-and-adapters, with the policy in
internal/core and every tool-specific fact behind a port in pkg/revier.
Every route below is mandatory, not advisory. Load the document BEFORE the first action of that kind — loading it afterwards does not count, and no route becomes skippable because the change looks small.
MUST read docs/CHANGE-WORKFLOW.md before the first edit to ANY file in this repository, and before any git command that writes. No change is made in the main checkout; the doc says where it is made instead.
MUST read docs/OVERVIEW.md before your first rg, grep,
ls or Glob of the source tree, and before writing any plan. Which package
owns a decision is not guessable from the tree.
MUST read docs/CODING.md before creating or editing ANY file
under cmd/, pkg/, internal/, or scripts/. Two invariants there are not
visible from the code — what a host must never do, and what Open owes Match.
MUST read docs/design/README.md before the first edit
under pkg/revier/, internal/core/ or docs/design/, and before writing a
plan that changes what a docs/design/decisions.md entry describes. The
design set carries the decision log, including which earlier models were
superseded and why, so a rejected idea is not re-proposed as new.
MUST read docs/TESTING.md before writing a test, before
your first go test or mise run test*, and before reporting a change as
green. The layer a test belongs in decides whether it can run at all on a
machine with no display.
MUST read docs/REVIEWING.md before reviewing a PR or a diff. It carries the quality rules that no tool checks: today, how a Go comment cites a decision.
MUST read docs/RUNNING.md before running anything that
opens a window, starts a terminal, or talks to a window manager — for
example ./bin/revier, revier, go run ./scripts/drive, or any tmux,
herdr, kitten or wctl command. revier acts on the user's live desktop;
the doc carries the substrates that verify a change without touching it.
MUST read docs/MONITORING.md before you open a log file
or anything else under the state directory (~/.local/state/revier by
default), before you run revier events or revier state, and before you
explain a past run, restore or keypress. Every process writes to one daily
file, so a line means nothing until you know which process wrote it.
MUST read docs/RELEASING.md before tagging a version,
before editing .github/workflows/release.yml or .goreleaser.yaml, and
before adding, renaming or removing a released artifact. The workflow is
dispatched by hand, and the dispatched ref must be the tagged commit.
MUST read docs/DOCUMENTING.md AND invoke the
instruction-writing:writing-project-docs skill before creating or editing ANY
Markdown file — the root steering files, anything under docs/,
docs/design/ or docs/user-guide/. The three trees have different owners and
different registers.