Saphan StudioDocs
The console

The console

The owner's view of the record: the screens, the small number of acts, and the one thing it never does — fire a command for you.

For the owner and whoever reads the fleet on their behalf.

After reading it you can find any screen, know what each one is for, and decide a gate from the line the console hands you.

Before you start: an installed machine with an owner — the console is behind a login, and first run is how a machine gets one.

The console is the owner's view of the record — the signed, append-only account of everything the fleet did: which stream ran on which machine, what it cost, which gate a human decided and how, what a role said and what it returned.

Read this before the rest of the section. This console is in the product now — and whether it is on your machine depends on which release you installed, because it arrived after several of them. On a machine carrying an earlier release, /console serves the previous console, which is what this section's last four pages describe. ⇒ Check what you are looking at before you follow a page: the console described here has a sidebar in four groups, and the one it replaced does not.

Where a screen is drawn but its numbers do not yet come from the record, the page says so on that screen's own row — see Screens and routes.

The pictures in this section are rendered from the built console over a demonstration data set. They are evidence of layout and of the acts a screen offers — never of a real fleet's numbers, because publishing those would publish somebody's work.

PageWhat it answers
What the console isThe five sentences, and the boundary: it reads, you act.
Signing in and finding your wayThe passkey, the sidebar's four groups, Simple and Advanced, and how to read any screen.
YoursOverview, Inbox, Sparks, Notepad — what waits for your hand.
RolesThe three long-lived roles, a role's screen, the supervised CLI, and calling a new one.
DevelopmentStreams, Runners, Bug Harvester, Reports, Prompt Library, Docs.
GovernPolicies, Gates, Ledger and Costs — the rules, the human decisions, the money.
The fleetMesh, Machines and seats, Log, Memory.
SettingsWhat is yours per user, and what is an operator's act on the host.
Screens and routesEvery screen, its address, its group, and whether Simple shows it.
What it does not protect againstThe limits, stated as limits.

What this section does not cover

The console never fires a command for you, so no page here is a substitute for Working with git — that is where the acts live. ⚠ The previous console's pages are kept below and describe a different surface; they are labelled as such.

On this page