Global Environment Variables
The Styx server URL to connect to. Override the default server address by setting this environment variable.
Commands
styx query
Query the status of a node in the truthful membership system.Arguments
The identifier of the node to query
Output
The command displays:- alive: Confidence percentage that the node is alive
- dead: Confidence percentage that the node is dead
- unknown: Percentage of unknown status
- status: Overall assessment (REFUSED, DEAD, likely alive, likely dead, or uncertain)
Example
styx report
Submit a witness report about a target node’s status.Arguments
The identifier of the node submitting the report (witness)
The identifier of the node being reported on (target)
Confidence value that the target is alive (0.0 to 1.0)
Confidence value that the target is dead (0.0 to 1.0)
Confidence value representing uncertainty (0.0 to 1.0)
Response
Returns “report accepted” on success (HTTP 202) or an error status.Example
styx health
Check the health status of the Styx server.Arguments
None.Response
Returns “server: healthy” if the server is operational, or “server: unreachable” if the connection fails.Example
styx version
Display the Styx CLI version.Arguments
None.Example
Exit Codes
All commands follow standard exit code conventions:- 0: Success
- 1: Error (invalid arguments, server unreachable, or other failures)