Pular para o conteúdo principal

CLI Reference

All commands support --config (config file path, default: ~/.nimbus/config.json) and --token (JWT bearer token, or NIMBUS_TOKEN env).

nimbus configure

Configure CLI credentials. Import from a JSON config file (downloaded from the GUI or bootstrap) or set individual flags.

# Import from JSON (recommended)
nimbus configure --from nimbus-config.json

# Override the API URL (e.g. when connecting from outside the WireGuard mesh)
nimbus configure --from nimbus-config.json --api-url https://<PUBLIC_IP>:8443

# Manual configuration
nimbus configure --api-url URL --access-key KEY --secret-key SECRET

nimbus bootstrap

Initialize the control plane and create the admin user.

nimbus bootstrap --api-url URL [--insecure]

nimbus version

Show client and server versions.

nimbus node

SubcommandDescriptionKey Flags
addAdd a node via SSH or locally--ip (required), --user, --port, --key, --password, --api-url, --name, --local
updateUpdate agent binary[node-id], --user, --port, --key, --password, --all, --local
listList all nodes
describeShow node details[id]
drainDrain a node[id]
deleteDelete a node[id]

nimbus swarm

SubcommandDescriptionKey Flags
createCreate a swarm group--name (required), --lb, --cloudflare
add-nodeAdd node to swarm--swarm (required), --node (required)
listList swarms
deleteDelete a swarm[id]
lb setDeploy EasyHAProxy--swarm (required)
lb removeRemove EasyHAProxy--swarm (required)
lb listList load balancers

nimbus compute

SubcommandDescriptionKey Flags
runCreate an instance--name, --image (required), --swarm or --k8s, --type, --replicas, --port, --domain, --volume, --env, --command, --platform
scaleScale replicas--id (required), --replicas (required)
listList instances
describeShow instance details[id]
terminateTerminate an instance[id]
stopStop an instance[id]
startStart an instance[id]
instance-typesList instance types
volume attachAttach volume--instance (required), --volume (required)
volume detachDetach volume--instance (required), --volume (required)

nimbus k8s

SubcommandDescriptionKey Flags
create-clusterCreate a K3s cluster--name (required), --nodes (required, comma-separated)
kubeconfigGet kubeconfig--name (required)
add-nodeAdd worker node--cluster (required), --node (required)
remove-nodeRemove worker node--cluster (required), --node (required)
listList clusters
delete-clusterDelete a cluster[id]
volume attachAttach NFS volume (PV+PVC)--cluster (required), --name (required), --size (required)
volume detachDetach NFS volume--cluster (required), --name (required)

nimbus s3

SubcommandDescriptionKey Flags
createDeploy MinIO instance--name (required), --swarm (required), --volume (required), --password, --license, --certs
listList S3 instances
deleteDelete S3 instance[id]

nimbus volume

SubcommandDescriptionKey Flags
createCreate NFS volume--name (required), --node (required), --folder (required)
listList volumes
deleteDelete volume[id]

nimbus service

SubcommandDescriptionKey Flags
deployDeploy compose stack--file (required), --swarm (required), --name, --env, --volume
listList services
describeShow service details[id]
removeRemove service[id]

nimbus manifest

SubcommandDescriptionKey Flags
applyProvision from manifest--file (required), --env, --prune
removeRemove manifest resources--file (required), --env

nimbus dns

SubcommandDescriptionKey Flags
setupConfigure local DNS resolution--swarm-id
removeRemove DNS configuration--swarm-id

nimbus gateway

SubcommandDescription
statusShow gateway routing table

nimbus iam

SubcommandDescriptionKey Flags
create-userCreate a user--username (required), --admin
create-keyGenerate API key pair--user-id (required)
get-tokenGet JWT token (HMAC auth)
set-passwordSet user password--user-id (required), --password (required)
loginLogin with password--username (required), --password (required)

nimbus cleanup

Force-clean a resource stuck in error state.

nimbus cleanup [resource-type] [resource-id]

Valid resource types: instance, cluster, s3, loadbalancer, swarm, volume.