Skip to content

Command line

The API container has a trixos command for scripts and quick checks. Run it on the panel host:

Terminal window
docker compose exec api trixos <command>
Command Does
trixos power status [--json] The stored power state of every server, how old it is and the BMC state (ok, the last error, needs credentials or no BMC)
trixos power refresh [--server <id|hostname>]… [--json] Reads the power state from the BMCs now, for all servers or the given ones

The poller reads the power state of every server every POLLER_POWER_INTERVAL_S seconds (default 60), and Refresh power on the server list does the same as trixos power refresh.

Command Does
trixos license status [--json] State, edition, servers used, lease and last check-in; exit code 1 when the panel isn’t usable
trixos license check Check in with the license server now
trixos license activate <key> Activate a Pro or Enterprise key
trixos license community <email> Activate the Community Edition
trixos license deactivate Release the license, for example before moving to a new installation

See Licensing.

Command Does
node --import tsx apps/api/src/cli/create-user.ts --username <name> --role admin Create a user, or reset its password; without --password a random one is printed
node --import tsx apps/api/src/cli/seed.ts Add the built-in OS catalogue (also done on every start with MIGRATE_ON_START=true)

Run these with docker compose exec api … as well.