Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ilyama.golain.io/llms.txt

Use this file to discover all available pages before exploring further.

Launch the TUI with no subcommand:
platform-tui
platform-tui --profile=prod

Key bindings

KeyAction
/ Navigate list
Enter / Select / drill down
EscGo back
/Filter list
n / pNext / previous page
rReload current screen
q / Ctrl+CQuit
Orgs → Projects → Project menu
                    ├── Fleets → Devices → Device detail (MQTT + tags)
                    ├── OTA Releases → Deployments
                    ├── Integrations (bindings)
                    ├── Stats & Graphs
                    ├── Event Stream (live SSE)
                    ├── Data Explorer (QueryScript)
                    └── Edge Sync
                         ├── Lineages
                         └── Schema Reviews → Review detail

Stats & graphs

Shows device connectivity as Unicode gauge bars:
  DEVICES
  Total                42
  Online               [████████░░░░░░░░░░░░░░░░░░░░░░]  43%   18 / 42
  Offline              [███░░░░░░░░░░░░░░░░░░░░░░░░░░░]  24%   10 / 42
  Never connected      [████████░░░░░░░░░░░░░░░░░░░░░░]  33%   14 / 42

Device detail

Select a device to view:
  • MQTT broker host, port, TLS, client ID
  • Allowed topic filters (kind, access, pattern)
  • Tags on the device

Event stream

Connects to GET /projects/{id}/events/stream with 24h replay on connect. Events appear as:
[HH:MM:SS.mmm] domain.entity.action  outcome  message
Press r to reconnect; ↑/↓ to scroll history.

Data explorer

Posts QueryScript v2 JSON to POST /projects/{id}/queryscript.
  • Edit JSON in the textarea
  • Ctrl+Enter to run
  • Browse tabular results in scrollable viewport
  • e edit · r re-run

Edge sync

Governance UI for SQLite replication:
  1. Lineages — active sync pipelines from edge devices
  2. Select lineage → schema fingerprints
  3. d — staged payloads · w — written/materialized rows
  4. s / w toggle on data screen
  5. Schema reviews — claim, approve, or reject schema changes
Written data reads the relational mirror when provisioned; otherwise defaults to QueryScript against telemetry tables. → Full guide: Edge SQLite sync · platform-tui Edge Sync

Screenshots

The ilyama repo includes generated TUI screenshots under tools/platform-tui/test/screenshots/ for regression testing — useful as visual reference when writing internal runbooks.