Docs / Reference
CLI
8 minute read
The simplicloud CLI is one Python file with no dependencies. It covers servers, apps, databases, Spaces, DNS and billing; add --json to any command to script it.
1. Install
You need Python 3.9 or newer, which macOS and most Linux distributions already have. Download the CLI into a folder on your PATH:
Terminal
mkdir -p ~/.local/bincurl -fsSLo ~/.local/bin/simplicloud \https://console.simplicloud.ai/cli/simplicloud.pychmod +x ~/.local/bin/simplicloudsimplicloud --version
To update, run the same curl command again. On Windows, use WSL.
2. Sign in
Create an API key in the console, then run auth init and paste it. The key is saved in ~/.config/simplicloud/config.toml, readable only by you.
Terminal
simplicloud auth init? API key: ••••••••••••✓ Signed in to korafoods as [email protected] (Owner)simplicloud auth whoami
In CI, skip
auth init and set SIMPLICLOUD_TOKEN and SIMPLICLOUD_ORG as secrets instead. Environment variables win over the config file.3. Servers and volumes
| Command | What it does |
|---|---|
simplicloud servers list | List servers in the current project |
simplicloud servers create web-1 --plan s1 --image ubuntu-24.04 --ssh-key laptop | Create a server |
simplicloud servers ssh web-1 | SSH in through the gateway |
simplicloud servers resize web-1 --plan s2 | Move to a bigger plan |
simplicloud servers reboot web-1 | Reboot; also power-off, power-on |
simplicloud servers delete web-1 | Delete the server |
simplicloud volumes create data-01 --size 50 --attach web-1 | Create and attach a volume |
simplicloud snapshots create web-1 | Take a snapshot |
4. Apps and databases
| Command | What it does |
|---|---|
simplicloud apps create storefront --repo kora/storefront --plan basic | Create an app from GitHub |
simplicloud apps deploy storefront | Deploy the latest commit |
simplicloud apps logs storefront --follow | Stream runtime logs |
simplicloud apps env set storefront KEY=value | Set an environment variable |
simplicloud databases create orders-db --engine postgresql --plan standard | Create a database |
simplicloud databases uri orders-db | Print the connection string |
simplicloud databases users add orders-db reporting | Add a database user |
simplicloud databases backups orders-db | List backups |
5. Spaces, DNS and billing
| Command | What it does |
|---|---|
simplicloud buckets create product-images --acl private | Create a bucket |
simplicloud buckets keys create ci-uploads | Create an access key pair for S3 tools |
simplicloud dns add korafoods.ng | Add a domain |
simplicloud dns records add korafoods.ng CNAME www storefront.apps.simplicloud.ai | Add a record |
simplicloud billing balance | Wallet balance and days left |
simplicloud billing invoices | List VAT invoices |
6. Scripting
Every command takes --json, --project and --org. Exit codes are 0 on success and non-zero on any error, so scripts can stop early.
Terminal
# names of every stopped serversimplicloud servers list --json | jq -r '.[] | select(.status=="off") | .name'# create in Staging without changing your defaultsimplicloud apps create storefront-staging --repo kora/storefront \--branch develop --plan basic --project staging
Was this page helpful?