Skip to content

1ctl CLI reference

1ctl is the command-line interface for Satusky. It talks to the Satusky API at https://api.satusky.com/v1/cli by default and sends a valid API token in the x-satusky-api-key header.

The CLI is intentionally thin. Builds, deployment reconciliation, DNS checks, billing, machine inventory, and Kubernetes operations happen server-side.

1ctl
Flag Type Required Default Description
--profile, -p string No — Profile to use for this command (e.g. –profile local)
--api-url string No — API URL override for this command (highest priority, overrides profile and env var)
--output, -o string No "table" Output format: table or json
--help, -h boolean No — Show help
--version, -v boolean No — Print the version
Command Description
admin Perform guarded platform administration operations
init Create a satusky.toml config file in the current directory
launch Interactive wizard: detect runtime, write satusky.toml, ready to deploy
deploy Build and deploy an application
app Manage deployed applications
logs View application logs
doctor Diagnose auth, backend reachability, zones, clusters, and live deployments
domains Add, list, and inspect custom domains for your apps
config Manage environment variables
secret Manage secrets
volumes Inspect, detach, and destroy persistent volumes
postgres Manage SatuSky managed Postgres clusters
valkey Manage SatuSky managed Valkey services
nats Manage NATS marketplace deployments
machine Manage machines and check availability
cluster View cluster and zone information
marketplace Browse and deploy marketplace apps
package Create and publish marketplace packages
auth Authenticate and manage credentials for SatuSky Cloud
profile Manage named configuration profiles (API endpoints + credentials)
org Manage organizations
user Manage user account
token Manage API tokens
credits Manage credits and billing
pricing View machine pricing configurations
audit View audit logs
notifications Manage notifications
completion Generate and install shell completion scripts

API URL priority is:

  1. --api-url
  2. SATUSKY_API_URL
  3. Active profile URL
  4. https://api.satusky.com/v1/cli

Use --output json or -o json when scripting:

Terminal window
1ctl app list -o json
1ctl -o json machine list

Current CLI argument normalization supports global output flags before or after subcommands for common forms.

satusky.toml is the deployment manifest read by 1ctl deploy. CLI flags override satusky.toml; satusky.toml overrides CLI defaults.

[app]
name = "api"
port = 8080
cpu = "0.5"
memory = "256Mi"

See satusky.toml for the current schema.