CLI reference

Commands, global flags and configuration for the cloister command-line tool.

Updated 15 October 2026

The cloister CLI wraps the API. Every command accepts --output json for scripting.

Configuration

The CLI reads, in order: command-line flags, environment variables, then ~/.config/cloister/config.toml.

Variable Purpose
CLOISTER_TOKEN Project token
CLOISTER_REGION Default region
CLOISTER_API_URL Override the API endpoint

Commands

Command Does
cloister plans list List plans and their availability
cloister nodes create Provision a node
cloister nodes list List nodes in the project
cloister nodes get <id> Show one node
cloister nodes delete <id> Release a node and stop billing
cloister attest get <id> Download attestation evidence
cloister attest verify <id> Verify evidence against a policy
cloister keys release <uri> Release a key to a verified node
cloister clusters create Reserve a cluster
cloister volumes create Create a block volume
cloister firewall allow Open a port on public interfaces
cloister audit Stream the project audit log

Global flags

Flag Meaning
--project <id> Act on a different project than the token’s default
--region <id> Region for commands that need one
--output table|json Output format
--quiet Print only identifiers

Exit codes

Code Meaning
0 Success
1 The request failed; the API error is printed
2 Invalid flags or arguments
3 Attestation verification failed