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.

platform-tui is the official terminal interface to Golain. It ships from the ilyama repository under tools/platform-tui/. Use it two ways:
ModeHowBest for
TUIRun platform-tui with no subcommandInteractive browsing, stats, live event stream
CLIplatform-tui <command> [flags]Scripts, CI, JSON output
Both modes share the same credential profiles and org/project context.

​
Install

→ Install platform-tui

​
Quick example

platform-tui login
platform-tui context set --org=my-org --project=my-project
platform-tui fleets list
platform-tui devices list --fleet=sensors
platform-tui --output=json devices mqtt-details sensor-01 --fleet=sensors

​
Global flags

FlagDefaultDescription
--profiledefaultNamed credential profile
--outputtabletable, json, or jsonl
--yesfalseSkip confirmation prompts
Exit codes: 0 success · 1 error · 2 not found.

​
Feature parity with console

AreaCLI support
Orgs, projects, fleets, devicesFull CRUD
TagsFull CRUD
OTA releases & deploymentsFull CRUD + trigger/cancel
IntegrationsList accounts & bindings
UsersList org members
EventsAudit, MQTT, TSDB snapshots + live SSE watch
Edge syncLineages, schema reviews, staged/written rows

​
TUI highlights

Interactive screens include Stats & graphs, Event stream, Data explorer (QueryScript), and Edge sync governance. See TUI guide.

​
vs Golain CLI

platform-tuigolain-cli
ScopeFull platform APIDevices + SSH focus
Outputtable/json/jsonlHuman tables
TUIYesNo
SSH to deviceNoYes (golain ssh)
Use both: platform-tui for fleet ops, golain-cli for field SSH.

Login & profiles

Zitadel device authorization flow.

CLI reference

All subcommands and examples.