CLI commands
atreoAGENT provides CLI subcommands for management and debugging. Run them inside the Docker container:
docker exec atreoagent atreoagent <command>Commands
Section titled “Commands”Start the agent daemon. This is the default command used by the Docker entrypoint.
atreoagent runStarts 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.
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.
status
Section titled “status”Show the agent’s configuration.
atreoagent statusOutput 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.
reroll
Section titled “reroll”Move this server to a new, randomly chosen overlay subnet. Use it when the atreoLINK app reports an overlay address conflict.
atreoagent reroll --yesWithout --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:
docker exec atreoagent atreoagent reroll --yesdocker compose restart atreoagentEvery 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.
atreoagent appsOutput includes:
- App name and slug.
- Internal URL the agent forwards to.
- Members with access.
Standard Docker log inspection works fine:
# Follow logs in real timedocker logs -f atreoagent
# Last 100 linesdocker logs --tail 100 atreoagent
# Filter for a specific subsystemdocker logs atreoagent 2>&1 | grep -i wireguarddocker logs atreoagent 2>&1 | grep -i proxydocker logs atreoagent 2>&1 | grep -i certdocker logs atreoagent 2>&1 | grep -i tunnelThe agent outputs one line per event.
Reading the notification API key
Section titled “Reading the notification API key”The current notification API key is stored at <DATA_DIR>/notify_api_key:
docker exec atreoagent cat /var/lib/atreoagent/notify_api_keyUse 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.
© 2026 atreoLABS. All rights reserved.
WireGuard is a registered trademark of Jason A. Donenfeld.

