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.

golain-cli is a focused CLI for operators who need quick device list and SSH access through Golain’s MQTT bridge. It lives in golain-io/golain-cli.

​
When to use it

Use golain-cliUse platform-tui instead
SSH into a named deviceFull fleet CRUD, OTA, integrations
Quick device status checkJSON/CI automation
Field technician laptopTUI data explorer, edge sync

​
Typical session

golain login
golain set --org-id=YOUR_ORG --project-id=YOUR_PROJECT --fleet-id=YOUR_FLEET
golain devices
golain ssh "sensor-01"

​
Commands at a glance

CommandPurpose
golain loginOAuth2 browser login (Zitadel)
golain setDefault org, project, fleet IDs
golain devicesList fleet devices with status
golain device <name>Device detail and monitoring
golain ssh <name>Interactive shell via MQTT bridge
golain configShow saved configuration
Global flag: -c, --config for alternate config file path.

​
Requirements on device

SSH requires Omega (or compatible edge client) with:
  • RPC and SSH modules enabled
  • security.capabilities allowing remote shell
  • Device online and authenticated to MQTT
Configure edge capabilities in Omega configure.

Install

Build and install golain-cli.

Commands

Full command reference.