CLI Reference

The quazzar-cli tool lets you manage your Cloud OS server from the terminal. It is a separate binary from the main quazzar server and communicates with the Cloud OS REST API.

The CLI is not yet included in the main quazzar APT package. Install it separately via sudo apt install quazzar-cli once available, or build from source with make build-cli.

Installation

APT (when available)


sudo apt install quazzar-cli

Build from Source


git clone https://github.com/quazzar/cloud-os.git
cd cloud-os
make build-cli

The compiled binary is placed in ./bin/quazzar-cli.

Authentication

Before using the CLI, authenticate with your Cloud OS instance:


quazzar-cli login --server https://your-server.example.com

You will be prompted for your email and password. If 2FA is enabled, you will also be prompted for your TOTP code.

The authentication token is stored in ~/.quazzar/credentials.

Commands

System

Command	Description
`quazzar-cli status`	Show system overview (CPU, RAM, disk, app count, version, uptime)

Apps

Command	Description
`quazzar-cli apps list`	List all installed apps with status
`quazzar-cli apps install <template>`	Install an app from the template library
`quazzar-cli apps start <app-id>`	Start a stopped app
`quazzar-cli apps stop <app-id>`	Stop a running app
`quazzar-cli apps restart <app-id>`	Restart an app
`quazzar-cli apps logs <app-id>`	View app container logs (use `--follow` to tail)

Backups

Command	Description
`quazzar-cli backup create`	Trigger an immediate backup
`quazzar-cli backup list`	List all backups with status and size
`quazzar-cli backup verify <backup-id>`	Run integrity verification on a backup
`quazzar-cli backup health`	Show backup health summary and staleness warnings

Updates

Command	Description
`quazzar-cli update check`	Check for available Cloud OS updates
`quazzar-cli update apply`	Download and apply the latest update

Configuration

Command	Description
`quazzar-cli config get <key>`	Get a configuration value
`quazzar-cli config set <key> <value>`	Set a configuration value

Authentication

Command	Description
`quazzar-cli login`	Authenticate with a Cloud OS instance

Global Flags

Flag	Description
`--server <url>`	Cloud OS server URL (default: `http://localhost:8080`)
`--json`	Output in JSON format for scripting
`--no-color`	Disable colored output

Output Formats

By default, the CLI outputs human-readable colored tables. Use --json for machine-parseable output:


# Human-readable
quazzar-cli status
 
# JSON
quazzar-cli status --json

Example Output


$ quazzar-cli status
Quazzar Cloud OS v0.2.9
-------------------------
  CPU:    23.4%
  RAM:    3.2 / 8.0 GB (40%)
  Disk:   45.1 / 100.0 GB (45%)
  Apps:   12 running, 2 stopped
  Uptime: 14d 6h 32m

Shell Completions

Enable tab completion for your shell:


# Bash — add to ~/.bashrc
eval "$(quazzar-cli completion bash)"
 
# Zsh — add to ~/.zshrc
eval "$(quazzar-cli completion zsh)"
 
# Fish — add to ~/.config/fish/config.fish
quazzar-cli completion fish | source

Usage Examples


# Install an app and check its status
quazzar-cli apps install nextcloud
quazzar-cli apps list
 
# Create a backup
quazzar-cli backup create
quazzar-cli backup list
 
# Check for updates
quazzar-cli update check
 
# Tail app logs
quazzar-cli apps logs nextcloud --follow
 
# Scripting: restart all stopped apps
quazzar-cli apps list --json | \
  jq -r '.[] | select(.status == "stopped") | .id' | \
  xargs -I {} quazzar-cli apps start {}