Skip to content

CLI commands

atreoAGENT provides CLI subcommands for management and debugging. Run them inside the Docker container:

Terminal window
docker exec atreoagent atreoagent <command>

Start the agent daemon. This is the default command used by the Docker entrypoint.

Terminal window
atreoagent run

Starts all subsystems: WireGuard, proxy, forward auth, notification API, tunnel client, and the maintenance loop.

Manually initiate device pairing with atreoLINK. Normally run does this automatically on first start; you’d only invoke pair directly if you need to re-pair after rotating the data volume.

Terminal window
atreoagent pair --atreolink-url https://api.atreolink.com
Flag Default Description
--atreolink-url https://api.atreolink.com Override the atreoLINK base URL (only useful for non-production environments).

After running, the command prints a one-time pair URL. Open it in a browser signed in to your atreoLINK account. See Pair your server for the full flow.

Show the agent’s configuration.

Terminal window
atreoagent status

Output includes:

  • Pairing status, device ID and apps hostname.
  • atreoLINK API and app URLs.
  • Data directory and WireGuard listen port.
  • This server’s overlay addressing: its IPv4 overlay IP and subnet, and their IPv6 counterparts.

It reads the config and data directory only, so it works whether or not the agent is running. For live state, check the logs.

Move this server to a new, randomly chosen overlay subnet. Use it when the atreoLINK app reports an overlay address conflict.

Terminal window
atreoagent reroll --yes

Without --yes it prints the current subnet and what will change, then exits. The new subnet takes effect the next time the agent starts, so restart it afterwards:

Terminal window
docker exec atreoagent atreoagent reroll --yes
docker compose restart atreoagent

Every device connected to the server gets a new tunnel address and picks it up on its next connect. Anything you’ve configured with the old subnet or overlay IP, such as a reverse proxy’s listen address or a static route, needs updating by hand. Entries that name 100.64.0.1 or 100.64.0.0/24 keep working.

List all apps registered in the ACL.

Terminal window
atreoagent apps

Output includes:

  • App name and slug.
  • Internal URL the agent forwards to.
  • Members with access.

Standard Docker log inspection works fine:

Terminal window
# Follow logs in real time
docker logs -f atreoagent
# Last 100 lines
docker logs --tail 100 atreoagent
# Filter for a specific subsystem
docker logs atreoagent 2>&1 | grep -i wireguard
docker logs atreoagent 2>&1 | grep -i proxy
docker logs atreoagent 2>&1 | grep -i cert
docker logs atreoagent 2>&1 | grep -i tunnel

The agent outputs one line per event.

The current notification API key is stored at <DATA_DIR>/notify_api_key:

Terminal window
docker exec atreoagent cat /var/lib/atreoagent/notify_api_key

Use it as the bearer token when calling POST /v1/notify. Rotate it from the atreoLINK dashboard under your server’s Settings; see the Notification API overview.

WireGuard is a registered trademark of Jason A. Donenfeld.