Skip to content
Tenzro
Documentation menu
Build and operate

Terminal console

tenzro-tui is an interactive terminal console for a node, built on the TypeScript SDK: five read-only screens, one status word, plain output for scripts. Built from the repository.

tenzro-tui is an interactive console for a Tenzro node, built on the TypeScript SDK. It answers what an operator asks first: is the node running, is it at the tip of the chain, what does it hold, who validates and what is being decided.

It only reads. Sending, signing and every key operation stay in the tenzro CLI, where the key is held by the machine's hardware, and nothing secret is ever shown.

Build and run

The package is not published to npm yet, so build it from the repository. It needs Node.js 22 or newer and depends on the sibling SDK by path.

bash
git clone https://github.com/tenzro/tenzro-network
cd tenzro-network/sdk/tenzro-ts-sdk && npm ci
cd ../tenzro-tui && npm ci && npm run build
node dist/src/cli.js --rpc http://127.0.0.1:8545
OptionMeaning
--rpc <url>Node JSON-RPC endpoint. Default: $TENZRO_RPC_URL, else http://127.0.0.1:8545.
--api <url>Node REST endpoint, when it is not derived from --rpc.
--address <0x...>The account the Wallet screen shows. Default: $TENZRO_ADDRESS, else the node's payee.
--plainPrint one text report and exit.
--no-colorNo color. NO_COLOR is honored as well.

Screens and keys

KeyScreen
1Overview: node state, version, uptime, roles and disk; chain id, height, finalized height, sync and peers; identity
2Wallet: balance and nonce of one account (press e to choose it)
3Models: what the node holds, engine, visibility, loaded and serving
4Validators: the registered set and each self stake
5Governance: proposals with kind, status, track and tally

Tab and Shift-Tab (or the left and right arrows) change screen. Up and Down, or j and k, move in a list. r refreshes now; the screen also refreshes every 5 seconds. ? shows the help overlay and Esc closes it or cancels an edit. q or Ctrl-C quits and restores the terminal. The window must be at least 80 by 24; below that the console says so instead of drawing.

The header always shows one status word: OK, WATCH, DOWN or UNKNOWN. Color is a second channel only. With NO_COLOR set or --no-color, the words, bold and reverse video carry the meaning. When the node stops answering, the last values stay on screen marked STALE.

Scripts and pipes

When output is not a terminal, or with --plain, tenzro-tui prints one text report and exits. The exit code is 0 when the node is OK and 1 otherwise, so a script can use it as a health check. Bad options exit 2.

bash
node dist/src/cli.js --rpc http://127.0.0.1:8545 --plain | head -3
ExploreJoin the network