Skip to content

edgible agent

Manage the local Edgible agent (daemon installations only)

Check local agent status

Terminal window
edgible agent status [flags]
FlagDescription
--watchWatch status changes in real-time

Install and configure the local agent as a daemon (systemd)

Terminal window
edgible agent install [flags]
FlagDescription
--type <type>Installation type (systemd)
--device-type <deviceType>Device type: serving (default).
--devRun in development mode (foreground, no daemon)
--localUse local agent build from agent-v2/dist/ (development only)
--non-interactiveNon-interactive mode for CI/VMs: use config, —device-name to create a device, or —device-id/—device-password, skip prompts
--device-name <name>Create a new device with this name (non-interactive); alternative to —device-id/—device-password
--device-id <id>Device ID (non-interactive); can use EDGIBLE_DEVICE_ID
--device-password <password>Device password (non-interactive); can use EDGIBLE_DEVICE_PASSWORD
--auto-install-depsInstall missing dependencies (WireGuard, Caddy, etc.) without prompting
--skip-dep-checkSkip the dependency check entirely (for pre-provisioned hosts/CI images that already have the tools)
--vmInstall the agent inside an isolated QEMU VM (serving, Linux host)
--vm-memory <mb>VM memory in MB (with —vm; default 4096)
--vm-cpus <n>VM vCPU count (with —vm; default 2)
--vm-base-image <path>Override the guest base image qcow2 (with —vm)

Provision agent files + daemon unit without a device (identity-free; pair with agent enroll)

Terminal window
edgible agent provision [flags]
FlagDescription
--type <type>Installation type (systemd)
--device-type <deviceType>Device type: serving (default)
--localUse local agent build from agent-v2/dist/ (development only)
--non-interactiveNon-interactive mode for CI/VMs: skip prompts
--auto-install-depsInstall missing dependencies (WireGuard, Caddy, etc.) without prompting

Bind a device to an already-provisioned agent and start it (the identity-bound half of install)

Terminal window
edgible agent enroll [flags]
FlagDescription
--type <type>Daemon type the agent was provisioned as (systemd)
--device-type <deviceType>Device type: serving (default)
--localPair with a —local provision (development only)
--non-interactiveNon-interactive mode for CI/VMs: use config, —device-name to create a device, or —device-id/—device-password, skip prompts
--device-name <name>Create a new device with this name (non-interactive); alternative to —device-id/—device-password
--device-id <id>Device ID (non-interactive); can use EDGIBLE_DEVICE_ID
--device-password <password>Device password (non-interactive); can use EDGIBLE_DEVICE_PASSWORD

Start the local agent (uses the device configured during install)

Terminal window
edgible agent start [flags]
FlagDescription
--passthroughRun agent with interactive output (required for sudo password prompt)
--debugEnable debug logging
--rootRun agent with sudo/root privileges (required for WireGuard and iptables management)

Stop the local agent

Terminal window
edgible agent stop [flags]

Restart the local agent

Terminal window
edgible agent restart [flags]

Manage the VM-isolated agent install (edgible agent install —vm)

Terminal window
edgible agent vm [flags]

Open an interactive SSH shell into the agent VM

Terminal window
edgible agent vm ssh [flags]

Attach to the agent VM console (headless; use agent vm ssh)

Terminal window
edgible agent vm console [flags]

Build the guest base image used by VM-isolated installs

Terminal window
edgible agent vm build-image [flags]

View agent logs

Terminal window
edgible agent logs [flags]
FlagDescription
-f, --followFollow log output in real-time
-n, --lines <number>Number of lines to show
-l, --level <level>Log level filter (error, warn, info, debug, all)
-m, --module <module>Filter logs by module name (comma-separated for multiple modules, e.g., “agent,caddy”)
-c, --comprehensiveShow comprehensive diagnostics (raw output without filtering)
--single-lineExclude data and error traces from output (single line per log entry)
--stdoutRead from stdout.log instead of agent.log
--stderrRead from stderr.log instead of agent.log

Uninstall the agent daemon

Terminal window
edgible agent uninstall [flags]
FlagDescription
--remove-filesAlso remove agent files and configuration
--forceSkip confirmation prompts

Set the agent log level

Terminal window
edgible agent set-log-level [flags]
FlagDescription
-l, --level <level>Log level: debug, info, warn, or error
--no-restartDo not restart the agent after updating log level

Trigger an immediate full-state reconcile against the local running agent (debug / recovery)

Terminal window
edgible agent reconcile [flags]
FlagDescription
--jsonEmit the raw reconcile report as JSON
--timeout <ms>Maximum time to wait for the agent to respond

Setup agent dependencies and configure the agent

Terminal window
edgible agent setup [flags]
FlagDescription
--wireguard-mode <mode>WireGuard mode: kernel or userspace
--wireguard-go-binary <path>Path to wireguard-go binary (only used with userspace mode)
--auto-installAutomatically install missing dependencies without prompting