CLI Reference

A full command set for managing Scalix Cloud from the terminal

Installation

The Scalix CLI is a native binary named scalix-cloud, installed via npm:

bash

npm install -g scalix-cloud
scalix-cloud --version

The npm package is a thin launcher that downloads the prebuilt binary for your platform (Linux x64/arm64, macOS Apple Silicon and Intel, Windows x64) with checksum verification. Everything the CLI does is also available through the console, the REST API, and the SDKs.

To update: npm update -g scalix-cloud (the CLI does not self-update). Releases: github.com/scalixworld/scalix-cloud-cli.

Authentication

bash

scalix-cloud login          # log in with your API key
scalix-cloud logout         # Clear credentials
scalix-cloud whoami         # Show current user
scalix-cloud config         # View/set configuration

Command Groups

Database

bash

scalix-cloud db query "SELECT * FROM users"     # Execute SQL
scalix-cloud db query "SELECT * FROM users WHERE id = $1" --params '[42]'
scalix-cloud db tables                           # List tables
scalix-cloud db schema                           # Inspect full schema
scalix-cloud db schema table users               # Inspect specific table

Functions

bash

scalix-cloud fn list                             # List functions
scalix-cloud fn deploy api --source ./api --runtime node   # Deploy from source
scalix-cloud fn deploy api --image registry/img:v1         # Deploy a container image
scalix-cloud fn invoke api --data '{"key":"val"}'  # Invoke
scalix-cloud fn delete <function-id>             # Delete

fn deploy requires either --source <path> or --image <image>. Runtimes: node, python.

Storage

bash

scalix-cloud storage mb scalix://my-bucket       # Create bucket
scalix-cloud storage ls scalix://my-bucket/      # List objects
scalix-cloud storage cp file.txt scalix://bucket/  # Upload
scalix-cloud storage cp scalix://bucket/f.txt ./ # Download
scalix-cloud storage rm scalix://bucket/file.txt # Delete
scalix-cloud storage rb scalix://my-bucket       # Remove bucket

KV Store

bash

scalix-cloud kv set key value                    # Set
scalix-cloud kv set key value --ttl 60           # Set with TTL
scalix-cloud kv get key                          # Get
scalix-cloud kv del key                          # Delete
scalix-cloud kv list --prefix "user:"            # List keys

Events

bash

scalix-cloud events topic create my-topic        # Create topic
scalix-cloud events topics                       # List topics
scalix-cloud events publish my-topic order.created '{"order_id": "ord_123"}'  # Publish: <topic> <event_type> <json>
 
scalix-cloud events subs                         # List subscriptions

Subscriptions are created via the REST API or the console.

Cron

bash

scalix-cloud cron create job "0 * * * *" --action-type function --config '{"function_id":"<fn-id>"}'
scalix-cloud cron list                           # List schedules
scalix-cloud cron trigger job                    # Manual trigger
scalix-cloud cron executions job                 # Execution history
scalix-cloud cron delete job                     # Delete

AI

bash

scalix-cloud ai infer "Hello" --model scalix-lumio-lite   # Prompt is positional
scalix-cloud ai models                           # List models

Scalix Run

bash

scalix-cloud run deploy --name api --image img:v1 --port 8080
scalix-cloud run list                            # List services
scalix-cloud run get <service-id>                # Service details
scalix-cloud run scale <id> --min-instances 3 --max-instances 10
scalix-cloud run rollback <service-id>           # Rollback
scalix-cloud run instances <service-id>          # List instances

Organization & Project

bash

scalix-cloud org get <org-id>                    # Show an organization
scalix-cloud project list                        # List projects
scalix-cloud usage current                       # Current month usage
scalix-cloud usage history --periods 6           # Usage history
scalix-cloud usage limits                        # Tier limits vs usage

Domains

bash

scalix-cloud domain add myapp.com               # Add domain
scalix-cloud domain list                         # List domains
scalix-cloud domain rm myapp.com                 # Remove domain

Deploy

Deployments build from a Git repository, not a local directory. Push your code, then deploy a service or function from the repo:

bash

scalix-cloud run deploy --name my-app --image <registry-ref>   # Deploy a Run service
scalix-cloud fn deploy my-fn --runtime node --source <git-url> # Deploy a function

The build service auto-detects the runtime from package.json, requirements.txt, go.mod, Cargo.toml, or Dockerfile in the repo.

Logs

bash

scalix-cloud logs <deployment-id>                # Show recent logs (snapshot)

Data Migration

bash

scalix-cloud migrate db import --source postgres://...  # Import database
scalix-cloud migrate storage sync \
  --source-endpoint https://s3.amazonaws.com --source-bucket my-aws-bucket \
  --source-access-key AKIA... --source-secret-key ... \
  --target-bucket my-bucket                             # Import storage

Export

bash

scalix-cloud export all --output scalix_export.tar.gz  # Full project export
scalix-cloud export db --output ./backup/              # Database only
scalix-cloud export kv                                 # KV store only
scalix-cloud export storage                            # Storage only

Compliance

bash

scalix-cloud compliance audit-export             # Export audit logs

Other

bash

scalix-cloud status                              # Platform health
scalix-cloud version                             # CLI version
scalix-cloud completions bash                    # Shell completions