Skip to content

flowlayer-client-tui

// CLI / flowlayer-client-tuiv1.1.1

flowlayer-client-tui is the official terminal client for a running server session.

flowlayer-client-tui
flowlayer-client-tui -addr <host:port>
flowlayer-client-tui -addr <host:port> -token <value>
flowlayer-client-tui -config <path>
FlagMeaning
-addr <host:port>Server address
-token <value>Bearer token
-config <path>Read session.addr and session.token from config
-h, --helpPrint help
--versionPrint version

-v is not supported.

Default runtime options without flags:

  • addr: 127.0.0.1:6999
  • token: empty

If -config is provided:

  • read session.addr when present
  • read session.token when present

If CLI flags are explicitly provided, they override config values.

Resolved address must be a valid host:port.

Terminal window
flowlayer-client-tui -addr 127.0.0.1:6999 -token dev-token
flowlayer-client-tui -config ./flowlayer.tui.jsonc
  • 0: success, help, or version
  • 2: CLI usage/config resolution error
  • 1: runtime launcher error
  • positional arguments are rejected
  • unknown flags are rejected with usage help
  • config parsing is strict and fails on unsupported fields
  • -config can be combined with -addr or -token; CLI flags win
  1. Resolve addr and token from flags or config.
  2. Open a WebSocket to <addr>/ws with Authorization: Bearer <token>.
  3. Receive the initial snapshot, then live events until disconnect.
  4. On Ctrl-C or fatal protocol error, the TUI exits with the matching code.

Related docs: Client / TUI, Server and TUI Modes, Session Token, Download.