CLI reference
The agent binary is engress-agent. Run engress-agent --help for the live list; this page mirrors the current release.
Top-level commands
| Command | Description |
|---|---|
engress-agent version | Print version and commit SHA |
engress-agent tunnel | Manage outbound tunnels to engress-edge |
engress-agent completion | Generate shell completion scripts |
tunnel serve
Register with Edge and proxy HTTP from yamux streams to a local backend.
engress-agent tunnel serve [flags]
| Flag | Default | Description |
|---|---|---|
--edge-host | 127.0.0.1 | Edge public hostname |
--edge-port | 7443 | Edge tunnel port |
--endpoint-id | (required) | Endpoint ID to register with Edge |
--local | (empty) | Local TCP backend (e.g. 127.0.0.1:11434); empty uses built-in smoke handler |
Example for Ollama:
engress-agent tunnel serve \
--edge-host tunnel.engress.io \
--edge-port 7443 \
--endpoint-id "11111111-1111-1111-1111-111111111111" \
--local 127.0.0.1:11434
tunnel connect
Open a TCP/yamux tunnel to Edge and proxy stdin/stdout. Used for smoke tests and low-level debugging — not the normal path for exposing a model.
engress-agent tunnel connect [flags]
| Flag | Default | Description |
|---|---|---|
--edge-host | 127.0.0.1 | Edge public hostname |
--edge-port | 7443 | Edge tunnel port |
--local | (empty) | Optional local TCP addr to proxy (e.g. 127.0.0.1:18080) |
Global flags
| Flag | Description |
|---|---|
-h, --help | Help for any command |
Next
How it works — what happens after the agent connects.