Loading…
Loading documentation...
Install @serversareup/cli v0.2.0, authenticate with a scoped token and manage servers, resource groups, locks and cloud services.
Commands checked on 2026-11-12 with @serversareup/cli (sau) 0.2.0, Node.js 24 LTS.
You will have the official sau command-line interface (@serversareup/cli v0.2.0) installed on your workstation or CI runner, authenticated against https://serversareup.com/api/v1, configured with your preferred output format (table, json, jsonc, tsv, yaml, or none) and --query selector, and ready to operate all 34 top-level command groups across compute, SSH, billing, Resource Manager, security, storage, databases, and Managed SaaS.
node --version; Node.js 24 LTS recommended).sau_... Personal Access Token created at Account settings > API keys (/account/api-keys). See Create a scoped API key and send your first v1 request.@serversareup/cli is distributed directly from Servers Are Up (https://serversareup.com/downloads/serversareup-cli.tgz) and source—it is not published on the public npm registry, and the binary is always sau.@serversareup/cli from the signed tarball (or build from source)Install the sau binary globally from the platform's hosted tarball, or run npx / build from packages/cli in a local checkout:
npm install -g https://serversareup.com/downloads/serversareup-cli.tgz
sau --version
sau --help
sau --version prints 0.2.0.
Sign in interactively or pass --token (in CI/CD runners, prefer setting the SAU_API_TOKEN environment variable so nothing is written to disk):
sau auth login --token sau_your_token_here
sau auth status
sau account
Configure default output formatting, Resource Group, and region locally—or pass --remote to synchronize your Portal and AI Agent Write Guardrail preferences across /dashboard/resource-manager, CLI, and MCP:
sau config set output table
sau config set group prod-core-rg --remote
sau config set location us-central-sau-1 --remote
sau config show --remote
Use the core compute commands (instances, ssh, ssh-keys, console, snapshots, backups, catalog, orders, billing) for day-to-day VM operations:
# List servers as a formatted table or filter JSON fields with --query
sau instances list
sau -o json --query "0.id" instances list
# Inspect one server, restart it, or create a pre-deploy snapshot
sau instances get <instance-id>
sau snapshots create <instance-id> --name "before-deploy"
sau instances power <instance-id> restart
# Open an interactive SSH session using an ephemeral key lease
sau ssh <instance-id>
sau v0.2.0 includes 22 Cloud Platform command groups mapped 1:1 to /api/v1/*, every one supporting -o <json|jsonc|table|tsv|yaml|none> and --query <expr>:
# Resource Groups, Tags, Locks, RBAC, Diagnostics & Quotas
sau group create prod-core-rg --location us-central-sau-1 --tags "env=prod,team=platform"
sau lock create protect-prod --group prod-core-rg --level CanNotDelete
sau role list -o table
sau quota list -o table
sau group export -f hcl -g prod-core-rg
# Azure-Hosted Cloud Blob Storage, Multi-Model Cloud DB & Key Vault
sau storage blobs-list -o table
sau cosmosdb list -o table
sau keyvault secret-set DATABASE_URL "postgresql://..." --vault default-vault
# Network Checkpoints, Cloud DNS, Cloud SIEM, Security Posture & SaaS Catalog
sau network checkpoints-list -o table
sau sentinel kql "SecurityEvent | where Severity == 'HIGH' | limit 10"
sau security posture
sau saas catalog --query "vector" -o table
You can also execute any sau ... command directly inside your browser from the Cloud Shell bar in Operations > Resource manager & settings (/dashboard/resource-manager) without installing anything locally!
Run a multi-format verification across account identity, quotas, and activity logs:
sau version
sau quota list -o table
sau monitor activity-log --limit 5 -o yaml
All three commands return exit code 0 with formatted output matching -o table and -o yaml.
command not found: sau after npm install -g. Your global npm bin directory (npm prefix -g/bin) is not on your shell PATH. Add export PATH="$(npm prefix -g)/bin:$PATH" to ~/.zshrc or ~/.bashrc.Missing API token in CI pipelines. Export SAU_API_TOKEN="sau_..." in the CI job's environment variables instead of calling sau auth login.sau group delete, sau cosmosdb delete, sau saas cancel) fails with 409 Conflict (RESOURCE_LOCKED). A CanNotDelete or ReadOnly lock is protecting that resource! Inspect locks with sau lock list -o table and remove the lock explicitly only if deletion is intentional.-o tsv or -o json --query <selector> inside shell scripts instead of parsing human table borders with awk.sau config set aiWriteMode READ_ONLY --remote (or SAFE_MUTATIONS) when sharing a workspace with autonomous coding agents so destructive operations stay gated at the control plane.sau usage vs automated CI jobs so you can revoke either independently on /account/api-keys.Every Servers Are Up virtual machine and container includes an integrated HTML5 browser-based SSH, RDP, and VNC console in your dashboard, default-off inbound firewall rules with per-IP allow-lists, and full programmatic control via REST API v1 and Model Context Protocol (MCP). Explore our Virtual Datacenter Plans or reach out to Servers Are Up Support.