Skip to content

runbooks / command

Runbooks UI

Opens a local page with capabilities, runbooks, run history and coverage, through npm run runbooks:ui

❯ /runbooks:ui [--port n] [--model <model>]

Parameters

Starts a read-only server on 127.0.0.1 and gives you its URL. The page reads the files on disk each time it loads, so a run or an edit shows on reload. It has two sections. Runbooks lists each capability with its runbooks, their last full run and their history, and the entry points no runbook covers. A runbook's page draws its steps as a dependency tree from their Parents: lines. Coverage shows the numbers of /runbooks:coverage, overall and per slice, and the address #/coverage?path=<glob> (or feature, capability, role) shows a filtered scope. With role tracking on, a Roles section lists each role at #/roles, with its permissions and its results. The server runs until you ask the agent to stop it or the session ends. See the runbooks page.

Parameter What it does
--port n The port the server listens on. Defaults to 4020. Pass another one when 4020 is taken.
--model <m> Accepted like on every other command, and ignored: ui always runs in the main session, because its server must keep running after the command ends.
/runbooks:ui                # on port 4020
/runbooks:ui --port 4800    # on another port
/runbooks:ui --model haiku  # the same: ui stays in the main session

View source on GitHub