Skip to content

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.

Install the agent as a system service.

Terminal window
sudo edgible agent install \
--type systemd \
--device-type serving \
--device-name my-first \
--non-interactive
FlagTypeDescription
--type <init>enumsystemd, launchd, or windows-service. Defaults to the platform default.
--device-type <role>enumserving (default) or gateway.
--device-name <name>stringName to register the new device under.
--device-id <id>stringRe-attach to an existing device by ID.
--device-password <pw>stringWhen re-attaching, the device’s password.
--dev / --localflagUse a locally-built agent rather than a released binary (development only).
--auto-install-depsflagAuto-install missing system dependencies (WireGuard, etc.) where possible.
--non-interactiveflagFail 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.

Start the agent service.

Terminal window
sudo edgible agent start
FlagDescription
--passthroughRun in the foreground instead of as a service (development).
--debugVerbose logging.
--dockerStart as a Docker container instead of a native daemon.
--rootForce running as root even if the install would otherwise downgrade.

Stop the agent service.

Terminal window
sudo edgible agent stop

Restart the agent service.

Terminal window
sudo edgible agent restart

Show whether the agent is running and recent connection state.

Terminal window
edgible agent status
edgible agent status --watch

Tail or page through the agent log file.

Terminal window
edgible agent logs --follow
edgible agent logs --lines 500 --level error
FlagDescription
-f, --followStream 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, --comprehensiveInclude stdout/stderr alongside the structured log.
--single-lineCollapse multi-line entries to one line each.
--stdout / --stderrShow only stdout or only stderr.

Remove the agent service.

Terminal window
sudo edgible agent uninstall
sudo edgible agent uninstall --remove-files --force
FlagDescription
--remove-filesAlso delete /var/lib/edgible, log files, and config.
--forceSkip confirmation prompts.

Change the running agent’s log level without an edit-and-restart cycle.

Terminal window
sudo edgible agent set-log-level --level debug
FlagDescription
-l, --level <level>New level: error, warn, info, debug.
--no-restartApply without restarting (where possible).

Snapshot the agent and host state to a JSON file for support.

Terminal window
edgible agent debug-dump --json --lines 500 > debug.json

Configure the agent’s WireGuard mode after install (rarely needed).

Terminal window
sudo edgible agent setup --wireguard-mode kernel
FlagDescription
--wireguard-mode <mode>kernel (default on modern Linux) or userspace.
--wireguard-go-binary <path>Path to a wireguard-go binary, for userspace mode.
--auto-installAuto-install missing dependencies.