Reference

trax-console

Source ConsoleCommandLine.cs, Connection/, Lists/, Screens/, Headless/

trax-console is the operations console in a terminal, for a host an operator reaches over SSH or anywhere without a browser. It sends only the documents the browser console sends, through a client trax client --operations --lang csharp writes from them (The operations console's client), so a host that serves the console registers everything it sends and the operations gate decides every request.

dotnet tool install --global Trax.Api.Console.Terminal
export TRAX_CONSOLE_API_KEY=$(pass show trax/prod-operator)
trax-console --host https://ops.example.com

What the host needs

A host that runs no persisted operations takes the documents' text instead: give --send-text.

Options

A credential is sent over HTTPS only, or to this machine; http:// to another host is refused.

The console

A tab per list (runs, dead letters, the work queue, manifests) and one for machines, the live feed of run state changes under them, and a status line. Runs, manifests and the feed leave out the scheduler's own trains, as the browser console does; the filter admin-trains=show brings them back to a list. A list is read again a moment after the host says it changed (onDataChanged), and when the socket comes back after a drop.

Everywhere, j and k move, g and G go to the top and the end, Ctrl+d and Ctrl+u move half a page, h and l go to the tab before and after, 1 to 5 go to a tab by number, and q closes a trace or an instance, or quits. The arrows work too.

The machines tab draws each machine as boxes and arrows: states in columns by how far they are from the initial one, each transition a line labelled with its command (on done for the outcome of a train the state invokes, after 30m for a timer), the current state of an instance in a double border. A transition three or more states take the same way (StartOver from anywhere) is said once under the graph rather than drawn from each. r turns the drawing between left to right and top to bottom (--vertical-graphs starts it top to bottom), and H and L scroll a graph wider than the screen. It also lists the machine's instances (s keeps the stuck ones), and opens one with its place on the graph, what it waits on, the runs it invoked and its history, read again when it changes. It is read only: the operations surface sends a machine no command.

                                 ╭─────────╮                          ╭───────────╮
               ┌───after 30m────▶│ Cleared │                        ┌▶│ Cancelled │
    ┌──────────┴┐                ╰─────────╯                        │ ╰───────────╯
 ●─▶│ Cart      ├──PlaceOrder──┐                                    │
    │ ↻ AddItem │              │                                    │
    └───────────┘              │ ┌─────────┐                        │ ╭───────────╮
                               └▶│ Ordered ├──on cancelled, failed──┘ │ Delivered │
                                 └────────┬┘                          ╰───────────╯
                                          │                            ▲
                                          └──────────on done───────────┘

JSON lines

With a command, trax-console prints JSON, one value per line, and says what went wrong on standard error. It exits with:

A host that answers CLIENT_OUTDATED in the middle of a session, after a deploy, is refused like one of another release at connect: the refusal names the code and the install line, here and in the console.

trax-console list dead-letters --where status=awaiting_intervention --take 100 | jq .id
trax-console bulk dead-letters requeue --where status=awaiting_intervention --expect 312 --dry-run

An agent run this way is an operator like any other: it holds its own key, the gate checks its roles, and the audit names it.

SDK Reference

UseTraxOperatorConsoleDocuments | UseTraxApiDashboard | Trax.Client