Choose your path

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 spans a cloud platform, web UI, operator CLIs, and on-device software. Use this page to pick the workflow that matches your role.

​

Decision guide

​

Web console (pw)

Best for: fleet managers, support engineers, day-to-day device operations.

• Visual dashboards, OTA wizards, integration setup
• Mock mode for local UI development (VITE_MOCK_AUTH=true)
• Requires only a browser and Zitadel login

→ Console overview · Quickstart

​

Platform CLI — platform-tui

Best for: DevOps, SRE, agents, CI pipelines, power users who want JSON output.

• Full CRUD for orgs, projects, fleets, devices, tags, OTA, integrations
• Interactive TUI when run without subcommands
• Device authorization login; profiles for staging vs production

→ Platform CLI overview

​

Golain CLI

Best for: operators who need SSH into devices through the MQTT bridge.

• golain login → golain set → golain devices → golain ssh <name>
• Focused command set; production endpoints baked in

→ Golain CLI overview

​

Omega edge runtime

Best for: firmware and edge engineers shipping software onto Linux, macOS, or Windows hardware.

• Profile-driven YAML (clients/*.yaml)
• Modules: shadow, OTA, heartbeat, RPC, SQLite replication, robotics, etc.
• JITR for certificate-based enrollment against ilyama

→ Edge overview

​

Self-hosted operator

Best for: running the full ilyama stack on your own VM with TLS, internal PKI, and Zitadel.

• vm-edge bundle: Traefik, Let’s Encrypt (Cloudflare DNS-01), data-plane mTLS
• Distinct from laptop make dev-infra (no TLS, local only)

→ Self-hosted overview

​

Typical end-to-end flow

1. Operator creates org/project/fleet in console or platform-tui.
2. Edge engineer builds Omega with make build-client CLIENT=ilyama-edge, enrolls via JITR, connects MQTT.
3. Support monitors connectivity in console Event Stream or platform-tui events watch.
4. Release engineer publishes OTA release, creates deployment, triggers rollout.
5. Field tech uses golain ssh for interactive shell when RPC/SSH module is enabled on device.

​

Local development vs production

→ Local development