Files
spinifex/docs/spinifex-admin-cli
Julian Sommer 355decd406 docs: tweaks
2026-03-31 13:10:59 +10:00
..
2026-03-31 13:10:59 +10:00

title, description, category, tags, resources
title description category tags resources
Spinifex Admin CLI Complete reference for the Spinifex administration CLI. Manage accounts, nodes, VMs, and services. Administration
cli
admin
reference
title url
Spinifex Repository https://github.com/mulgadc/spinifex

Spinifex Admin CLI

Complete reference for the Spinifex administration CLI.

Table of Contents


Overview

The spx binary is the central administration tool for managing your Spinifex infrastructure. It provides commands for cluster initialization, account management, node operations, VM lifecycle, and service control.

Binary location: /usr/local/bin/spx (binary install) or ~/Development/mulga/spinifex/bin/spx (source install)

All services in the Spinifex platform are managed through this single binary.

Instructions

Account Management

spx admin account create --name myteam
export AWS_PROFILE=spinifex-myteam

Node Management

spx get nodes
NAME    STATUS    IP              REGION           AZ               UPTIME   VMs
node1   Ready     127.0.0.1       ap-southeast-2   ap-southeast-2a  2m       0
node2   Ready     127.0.0.2       ap-southeast-2   ap-southeast-2a  2m       0
node3   Ready     127.0.0.3       ap-southeast-2   ap-southeast-2a  2m       0

Monitor Resources

spx top nodes

Image Management

spx admin images list
spx admin images import --name debian-12-arm64

Cluster Shutdown

spx admin cluster shutdown

Troubleshooting

Permission Denied Running Spinifex

The binary may not be executable. Fix permissions:

chmod +x /usr/local/bin/spx

If you get permission errors during operations, ensure you're running with appropriate privileges. Some OVN and networking commands require sudo.

Services Fail to Start

Check the daemon logs for specific errors:

ls ~/spinifex/logs/
cat ~/spinifex/logs/spinifex.log

Common causes include port conflicts, missing OVN configuration, or untrusted CA certificates.