CLI overview
The edgible CLI is the primary interface to the platform. It uses a <noun> <verb> structure: edgible application list, edgible device health, edgible stack deploy. Most subcommands have short aliases (edgible app list, edgible dev health) and most accept --json for machine-readable output.
The command tree
Section titled “The command tree”| Noun | Aliases | What it does |
|---|---|---|
auth | — | Log in, log out, switch organizations. |
agent | — | Install, start, stop, log into the local agent daemon. |
device | dev | List, delete, and health-check devices in your organization. |
application | app | Create, update, delete, and inspect applications. Manage API keys and short codes. |
stack | — | Deploy, tear down, validate, diff multi-application YAML files. |
gateway | gw | Manage user-owned gateway devices. |
config | — | Read and write CLI configuration. |
discover | — | Detect local container/VM tooling and system capabilities. |
connectivity | — | Network connectivity tests for an application. |
ai | — | Set up a local Ollama instance and optionally publish it. |
Global flags
Section titled “Global flags”These work on every command:
| Flag | What it does |
|---|---|
--no-color | Suppress ANSI color codes in output. |
--plain | Emit plain text — no colors, no emoji, no Unicode flourishes. |
--help | Show the command’s help and exit. |
--version | Show the CLI version and exit. |
Where credentials live
Section titled “Where credentials live”The CLI stores its state — auth tokens, active organization, device credentials — in a single JSON file:
| Platform | Path |
|---|---|
| Linux | ~/.local/share/edgible/config.json |
| macOS | ~/Library/Application Support/Edgible/config.json |
| Windows | %APPDATA%\Edgible\config.json |
Inspect it with edgible config list. Edit it through the CLI rather than by hand — the file shape is not a stable interface.
Installing the CLI
Section titled “Installing the CLI”The CLI ships as a single Node binary. Download from the releases page or install via your platform package manager. After install, confirm with:
edgible --versionPermissions
Section titled “Permissions”Most commands run as your normal user. The few that need root are agent lifecycle commands (agent install, agent start, agent stop, agent uninstall) — these touch systemd, WireGuard, and iptables. The CLI will tell you to re-run with sudo if you forget.