cubecli

command module
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2026 License: MIT Imports: 5 Imported by: 0

README

CubeCLI

The official command-line interface for CubePath Cloud.

Built in Go — single binary, no dependencies, blazing fast.

Installation

Quick install (Linux / macOS)
curl -fsSL https://raw.githubusercontent.com/CubePathInc/cubecli/main/install.sh | sh
Manual download

Download the latest release for your platform from the Releases page.

From source
go install github.com/CubePathInc/cubecli@latest
Self-update

Once installed, CubeCLI can update itself:

cubecli update

Quick Start

# Configure your API token
cubecli config setup

# List your projects
cubecli project list

# List VPS instances
cubecli vps list

# Get help on any command
cubecli <command> --help

Configuration

CubeCLI reads credentials from (in order):

  1. CUBE_API_TOKEN environment variable
  2. ~/.cubecli/config.json config file
# Set up interactively (validates the token)
cubecli config setup

# Or use an environment variable
export CUBE_API_TOKEN="your-api-token"

# Optionally override the API URL
export CUBE_API_URL="https://api.cubepath.com"

Commands

Compute
Command Description
cubecli vps create Create a new VPS instance
cubecli vps list List all VPS instances
cubecli vps show <id> Show VPS details
cubecli vps destroy <id> Destroy a VPS instance
cubecli vps power start|stop|restart|reset <id> Power management
cubecli vps resize <id> Resize a VPS
cubecli vps change-password <id> Change root password
cubecli vps reinstall <id> Reinstall OS
cubecli vps backup list|create|restore|delete <id> Backup management
cubecli vps backup settings|configure <id> Auto-backup settings
cubecli vps iso list|mount|unmount <id> ISO management
cubecli vps plan list List available plans
cubecli vps template list List OS templates
Baremetal
Command Description
cubecli baremetal deploy Deploy a new baremetal server
cubecli baremetal list List all baremetal servers
cubecli baremetal show <id> Show server details
cubecli baremetal sensors <id> Show BMC sensor data
cubecli baremetal power start|stop|restart <id> Power management
cubecli baremetal reinstall start|status <id> OS reinstallation
cubecli baremetal monitoring enable|disable|status <id> Monitoring
cubecli baremetal rescue <id> Boot into rescue mode
cubecli baremetal reset-bmc <id> Reset the BMC
cubecli baremetal ipmi <id> Create IPMI proxy session
cubecli baremetal model list List available models
Networking
Command Description
cubecli network create|list|update|delete Private networks
cubecli floating-ip list|acquire|release Floating IP management
cubecli floating-ip assign|unassign <address> IP assignment
cubecli floating-ip reverse-dns <address> Reverse DNS
cubecli location list List available locations
cubecli ddos-attack list View DDoS attack history
DNS
Command Description
cubecli dns zone list|show|create|delete Zone management
cubecli dns zone verify|scan <uuid> Zone verification & import
cubecli dns record list|create|update|delete Record management
cubecli dns soa show|update <uuid> SOA configuration
Load Balancers
Command Description
cubecli lb list|show|create|update|delete LB management
cubecli lb resize <uuid> Resize a load balancer
cubecli lb listener create|update|delete Listener management
cubecli lb target add|update|remove|drain Target management
cubecli lb health-check configure|delete Health check config
cubecli lb plan list List available plans
CDN
Command Description
cubecli cdn zone list|show|create|update|delete Zone management
cubecli cdn zone pricing <uuid> Zone pricing details
cubecli cdn origin list|create|update|delete Origin management
cubecli cdn rule list|show|create|update|delete Edge rules
cubecli cdn waf list|show|create|update|delete WAF rules
cubecli cdn metrics summary|requests|bandwidth|cache Analytics
cubecli cdn metrics top-urls|top-countries|top-asn Top analytics
cubecli cdn plan list List available plans

Global Flags

--json       Output in JSON format
-v, --verbose    Enable verbose output
-h, --help       Help for any command

Destructive commands (delete, destroy, etc.) will prompt for confirmation unless --force / -f is passed.

JSON Output

Every command supports --json for scripting and piping:

# Get VPS list as JSON
cubecli vps list --json

# Pipe to jq
cubecli vps list --json | jq '.[].vps[].name'

# Use in scripts
VPS_ID=$(cubecli vps list --json | jq -r '.[0].vps[0].id')

Shell Completions

# Bash
cubecli completion bash > /etc/bash_completion.d/cubecli

# Zsh
cubecli completion zsh > "${fpath[1]}/_cubecli"

# Fish
cubecli completion fish > ~/.config/fish/completions/cubecli.fish

# PowerShell
cubecli completion powershell > cubecli.ps1

Building from Source

git clone https://github.com/CubePathInc/cubecli.git
cd cubecli
make build
./cubecli version
Build with version info
make build VERSION=1.0.0

License

Copyright CubePath, Inc. All rights reserved.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
cdn
dns
lb
vps
internal
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL