Skip to content

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.

NounAliasesWhat it does
authLog in, log out, switch organizations.
agentInstall, start, stop, log into the local agent daemon.
devicedevList, delete, and health-check devices in your organization.
applicationappCreate, update, delete, and inspect applications. Manage API keys and short codes.
stackDeploy, tear down, validate, diff multi-application YAML files.
gatewaygwManage user-owned gateway devices.
configRead and write CLI configuration.
discoverDetect local container/VM tooling and system capabilities.
connectivityNetwork connectivity tests for an application.
aiSet up a local Ollama instance and optionally publish it.

These work on every command:

FlagWhat it does
--no-colorSuppress ANSI color codes in output.
--plainEmit plain text — no colors, no emoji, no Unicode flourishes.
--helpShow the command’s help and exit.
--versionShow the CLI version and exit.

The CLI stores its state — auth tokens, active organization, device credentials — in a single JSON file:

PlatformPath
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.

The CLI ships as a single Node binary. Download from the releases page or install via your platform package manager. After install, confirm with:

Terminal window
edgible --version

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.