Manual 0.8.0

How-to guides

Each page here gets one goal done. The configuration page comes first where it can do it, and the command line is on every page. Open the one whose title is what you are trying to do.

Every revetly command on these pages is written bare. Where the engine runs as a compose service, Run a revetly command says what to type, once, rather than on every page. The watch loop is the exception: it runs inside the engine service and is detached with a flag of Docker's, so Run watch unattended writes those commands whole and the page that restarts one follows it.

Every guide states at its top what it asks of you. The rest of the manual explains why the rules are what they are. The words this engine uses is where to start. Engine config surface & local-only assumptions says what a setting is.

If this instance is new, read Your first hour before any of them. It is one path with no choices, from the download to an instance that has read something. It covers the guides below in order, on the branch that gives the instance a provider key rather than declaring none.

Get running

From a tarball to an instance that has read something and can answer about it. Two of these are alternatives: give the instance a provider key where it reads with an LLM, or declare no provider at all where it does not.

Sources

Connecting the folders, repositories and boards this instance reads, and the tracker it writes approved stories to.

Agents

Reaching this instance from the client that drafts and approves.

The loop

One guide per named gesture: grounding, drafting, capturing, deciding, shipping.

Keep it reading

Keeping the corpus current, reaching back into history, and moving to a later engine.

Grow it

A second project, a connection two projects share, and a setting one project states for itself.

Keep it safe

Snapshotting before a move, and moving an instance.

How these pages are written

Every page in this folder holds to one shape. The goal is in the title. The configuration page comes before the command line. A result is written as what you should see. A test resolves every control, command and sentence a guide names against what this engine paints and prints. The rules are stated once, in the how-to section of the words this engine uses.