Agent Commands
The knot agent CLI runs inside a space and talks to the local agent. This page is an overview of every command group; each feature page linked below covers its commands in depth.
| Command | Description |
|---|---|
knot agent space shutdown |
Request an immediate shutdown of the space. |
knot agent space restart |
Request a stop and restart of the space. |
knot agent space set-note --note "…" |
Set the space’s short description — see Notes. |
knot agent space get-field / set-field |
Read and write custom fields of the space. |
knot agent wait-for-start [--timeout 300] |
Block until the space has fully started. |
knot agent event --type … --name … --payload … |
Emit an event to configured event sinks — see Event Sinks. |
knot agent jobs list / run |
List and trigger scheduled jobs — see Jobs. |
knot agent methods register / unregister |
Register space methods — see Methods. |
knot agent port forward / list / stop |
Space-to-space port forwarding — see Space-to-Space Port Forwarding. |
knot agent run-script |
Run a script inside the space — see Provisioning. |
knot agent skills list / show / update / delete |
Manage in-space skills — see Skills. |
knot agent connect list / delete |
List and remove client connections to the space. |
knot agent tunnel … |
Create and manage agent tunnels — see Agent Tunnels. |
shutdown Command
The shutdown command allows the space to request an immediate shutdown. To execute this command, run:
knot agent space shutdownrestart Command
The restart command allows the space to request a restart. To execute this command, run:
knot agent space restartwait-for-start Command
Scripts that run early in a space’s lifecycle can wait until every service has started:
knot agent wait-for-start --timeout 120The command exits 0 once the space reports started, or non-zero if the timeout is reached.