Skip to content
Reoclo Reoclo Reoclo Docs

reoclo servers

reoclo servers ls
reoclo servers get <idOrSlug>
reoclo servers metrics <idOrSlug>
reoclo servers set-slug <idOrSlug> <newSlug>
reoclo servers power <on|off|shutdown|reboot|reset|status|capabilities> <idOrSlug>

Server commands cover read access plus slug renaming. Provisioning and runner installation continue to live in the dashboard.

Slugs

Section titled “Slugs”

Every server has a tenant-unique slug, a URL- and shell-friendly identifier derived from the server’s name (for example, Reoclo Production → reoclo-production). Slugs are the recommended way to refer to a server in CLI commands and tab completion:

Terminal window
reoclo logs tail --server reoclo-production --source container --name nginx
reoclo shell reoclo-pilot-01
reoclo exec reoclo-production -- df -h

Slugs are stable across renames: changing a server’s display name in the dashboard does not change its slug. To explicitly change a slug, use set-slug (see below).

Server names (with spaces or capitals) are still accepted for backward compatibility, but they are no longer offered in tab completion.

ls

Section titled “ls”

Lists every server in the active tenant with its slug, name, hostname, IP, status, and runner connection state.

Terminal window
$ reoclo servers ls
SLUG               NAME            HOSTNAME             IP           STATUS  RUNNER
reoclo-production  Reoclo Prod     prod-web-1.local     10.0.0.10    ACTIVE  v1.4.2
reoclo-pilot-01    Reoclo Pilot    staging-web.local    10.0.0.11    ACTIVE  v1.4.2
prawnwire-mail     Prawnwire Mail  mail-bastion.local   10.0.0.12    ONLINE  v1.4.2

JSON output for scripting:

Terminal window
reoclo servers ls -o json

get <idOrSlug>

Section titled “get <idOrSlug>”

Shows the full record for one server: hostname, IP, environment, runner version, last seen timestamp, attached domains, and any health check failures.

You can pass any of: the slug, the UUID, or the human-readable name. The CLI resolves these through a small local cache to avoid an extra round trip.

Terminal window
reoclo servers get reoclo-production
reoclo servers get 019dc1a8-841f-7102-ac5d-3ee9e9353795
reoclo servers get "Reoclo Production"   # backward compatibility

metrics <idOrSlug>

Section titled “metrics <idOrSlug>”

Returns the most recent CPU, memory, and disk readings reported by the runner.

Terminal window
$ reoclo servers metrics reoclo-production
cpu:   12% (1m), 18% (5m), 22% (15m)
mem:   3.2 GB / 8.0 GB (40%)
disk:  /        24 GB / 80 GB (30%)
       /var/lib 8.2 GB / 40 GB (20%)

set-slug <idOrSlug> <newSlug>

Section titled “set-slug <idOrSlug> <newSlug>”

Changes a server’s slug. Tenant-scoped uniqueness is enforced. If the new slug is already in use by another server in the same tenant, the API returns 409.

Terminal window
$ reoclo servers set-slug reoclo-production prod
✓ slug updated: reoclo-production → prod

The slug must match ^[a-z0-9]+(?:-[a-z0-9]+)*$ (lowercase alphanumerics and hyphens, no leading/trailing/double hyphens).

power <action> <idOrSlug>

Section titled “power <action> <idOrSlug>”

Drives the cloud provider’s power controls for a cloud-managed server. These commands act at the provider (hypervisor) level and are distinct from reoclo servers reboot, which reboots the operating system through the runner.

Terminal window
reoclo servers power on <idOrSlug>
reoclo servers power off <idOrSlug>          # hard power cut
reoclo servers power shutdown <idOrSlug>     # graceful shutdown
reoclo servers power reboot <idOrSlug>       # provider reboot
reoclo servers power reset <idOrSlug>        # hard reset
reoclo servers power status <idOrSlug>       # live provider power state
reoclo servers power capabilities <idOrSlug> # what the provider supports

Power operations are available only on servers that have a cloud provider and credentials configured, and only for operations the provider supports. Run capabilities to see the supported set and whether cloud credentials are configured:

Terminal window
$ reoclo servers power capabilities reoclo-production
provider          hetzner
capabilities      power_on, power_off, shutdown, reboot, reset
cloud_configured  true

If the server is not cloud-managed the API returns 400; if the provider does not support the requested action it returns 422. In both cases the CLI prints a hint pointing you at power capabilities.

off, shutdown, reboot, and reset prompt for confirmation. Pass --yes to skip the prompt (for scripts). The actions dispatch asynchronously and return immediately:

Terminal window
$ reoclo servers power off reoclo-production --yes
✓ power-off dispatched: reoclo-production
  Cloud power_off dispatched

Add --wait to block until the server reaches its target power state (running for on, stopped for off and shutdown), giving up after --wait-timeout seconds (default 120):

Terminal window
$ reoclo servers power off reoclo-production --yes --wait
✓ power-off dispatched: reoclo-production
waiting for 'reoclo-production' to reach 'stopped' (up to 120s)...
✓ 'reoclo-production' is now 'stopped'

Cloud power operations require an interactive organization login. They are not available to automation credentials.

Exit codes

Section titled “Exit codes”
CodeMeaning
0Success
1Server-side error
3Authentication failure
4Permission denied (authenticated, but not allowed)
5Server not found
7Control plane unreachable: DNS, connection refused, or timeout (CLI 0.55.0+; earlier report 1)
Section titled “Related”