edgible agent
These commands operate on the agent installed on the local machine. They generally need sudo because they manage a system service, WireGuard, and iptables.
edgible agent install
Section titled “edgible agent install”Install the agent as a system service.
sudo edgible agent install \ --type systemd \ --device-type serving \ --device-name my-first \ --non-interactive| Flag | Type | Description |
|---|---|---|
--type <init> | enum | systemd, launchd, or windows-service. Defaults to the platform default. |
--device-type <role> | enum | serving (default) or gateway. |
--device-name <name> | string | Name to register the new device under. |
--device-id <id> | string | Re-attach to an existing device by ID. |
--device-password <pw> | string | When re-attaching, the device’s password. |
--dev / --local | flag | Use a locally-built agent rather than a released binary (development only). |
--auto-install-deps | flag | Auto-install missing system dependencies (WireGuard, etc.) where possible. |
--non-interactive | flag | Fail rather than prompt. Required for scripting. |
A first-time install creates the device, generates credentials, saves them to the local config, and lays down the service unit.
edgible agent start
Section titled “edgible agent start”Start the agent service.
sudo edgible agent start| Flag | Description |
|---|---|
--passthrough | Run in the foreground instead of as a service (development). |
--debug | Verbose logging. |
--docker | Start as a Docker container instead of a native daemon. |
--root | Force running as root even if the install would otherwise downgrade. |
edgible agent stop
Section titled “edgible agent stop”Stop the agent service.
sudo edgible agent stopedgible agent restart
Section titled “edgible agent restart”Restart the agent service.
sudo edgible agent restartedgible agent status
Section titled “edgible agent status”Show whether the agent is running and recent connection state.
edgible agent statusedgible agent status --watchedgible agent logs
Section titled “edgible agent logs”Tail or page through the agent log file.
edgible agent logs --followedgible agent logs --lines 500 --level error| Flag | Description |
|---|---|
-f, --follow | Stream new log lines as they’re written. |
-n, --lines <n> | Show the last N lines. Default 100. |
-l, --level <level> | Filter by error, warn, info, debug, or all. |
-m, --module <name> | Filter by source module. |
-c, --comprehensive | Include stdout/stderr alongside the structured log. |
--single-line | Collapse multi-line entries to one line each. |
--stdout / --stderr | Show only stdout or only stderr. |
edgible agent uninstall
Section titled “edgible agent uninstall”Remove the agent service.
sudo edgible agent uninstallsudo edgible agent uninstall --remove-files --force| Flag | Description |
|---|---|
--remove-files | Also delete /var/lib/edgible, log files, and config. |
--force | Skip confirmation prompts. |
edgible agent set-log-level
Section titled “edgible agent set-log-level”Change the running agent’s log level without an edit-and-restart cycle.
sudo edgible agent set-log-level --level debug| Flag | Description |
|---|---|
-l, --level <level> | New level: error, warn, info, debug. |
--no-restart | Apply without restarting (where possible). |
edgible agent debug-dump
Section titled “edgible agent debug-dump”Snapshot the agent and host state to a JSON file for support.
edgible agent debug-dump --json --lines 500 > debug.jsonedgible agent setup
Section titled “edgible agent setup”Configure the agent’s WireGuard mode after install (rarely needed).
sudo edgible agent setup --wireguard-mode kernel| Flag | Description |
|---|---|
--wireguard-mode <mode> | kernel (default on modern Linux) or userspace. |
--wireguard-go-binary <path> | Path to a wireguard-go binary, for userspace mode. |
--auto-install | Auto-install missing dependencies. |