Scalix Hosting CLI

Status: In Development — The CLI builds and most commands work, but the deploy command has failing tests and the npm package (@scalix-world/cli) is a 0.0.1 placeholder. Do not install from npm yet.

Command-line interface for Scalix Hosting — deploy and manage applications from the terminal.

Installation

From source (development):

cd sdks/hosting-cli
npm install --ignore-scripts
npm run build
node dist/index.js --help

From npm (not yet available):

# npm install -g @scalix-world/cli  # placeholder only — real version not published yet

Authentication

Browser Login (default)

The easiest way to authenticate is through your browser:

scalix login

This opens your default browser to the Scalix login page. After you sign in, the CLI receives a token automatically through a local callback server and stores it at ~/.scalix/token (with 0600 permissions). No copy-pasting required.

You can also explicitly request browser login:

scalix login --browser

API Key Login

If you prefer to enter an API key manually (useful for CI/CD or headless environments):

scalix login --api-key

You will be prompted to enter your Scalix API key, which you can generate at https://scalix.world/settings/api-keys.

Direct Token

You can also pass a token directly:

scalix login --token <your-api-key>

Logout

To log out (removes the stored token):

scalix logout

Usage

Deploy an Application

# Deploy current directory
scalix deploy

# Deploy specific directory
scalix deploy --dir ./my-app

# Deploy with app name
scalix deploy --name my-awesome-app

# Deploy with environment variables
scalix deploy --env .env
scalix deploy --env-var NODE_ENV=production --env-var API_KEY=secret

The deploy command packages the directory into a ZIP (excluding node_modules and hidden files other than .env), uploads it to the Scalix Hosting API, and polls for deployment completion.

List Deployments

# List all deployments
scalix list

# Filter by status
scalix list --status ready

View Logs

# View logs for a deployment
scalix logs <deployment-id>

# Follow logs
scalix logs <deployment-id> --follow

# Show last 50 lines
scalix logs <deployment-id> --tail 50

Check Status

scalix status <deployment-id>

Update Deployment

# Update an existing deployment
scalix update <deployment-id>

# Update with new environment variables
scalix update <deployment-id> --env .env.production

Rollback Deployment

# Rollback to previous version (interactive)
scalix rollback <deployment-id>

# Rollback to specific version
scalix rollback <deployment-id> --version v1.2.3

# Rollback without confirmation
scalix rollback <deployment-id> --force

Configuration

# List configuration
scalix config --list

# Get configuration value
scalix config --get API_URL

# Set configuration value
scalix config --set API_URL=https://api.scalix.world

ScalixDB Database Management

Manage ScalixDB databases directly from the CLI.

Databases

# List all databases
scalix db list

# Create a new database
scalix db create --name my-db
scalix db create --name my-db --plan pro --region us-east-1

# Show database details
scalix db info <database-id>

# Delete a database (with confirmation)
scalix db delete <database-id>
scalix db delete <database-id> --force

Querying & Tables

# Execute a SQL query
scalix db query <database-id> --sql "SELECT * FROM users LIMIT 10"

# List tables
scalix db tables <database-id>

Monitoring

# Show database metrics (CPU, memory, connections, storage)
scalix db metrics <database-id>

# Show connection string
scalix db connection <database-id>

# Show database logs
scalix db logs <database-id>

# Show connection pooling status
scalix db pooling <database-id>

# List installed extensions
scalix db extensions <database-id>

Backups

# List backups
scalix db backup list <database-id>

# Create a backup
scalix db backup create <database-id>
scalix db backup create <database-id> --name "pre-migration"

# Restore from a backup
scalix db backup restore <database-id> <backup-id>

Branches

# List database branches
scalix db branches <database-id>

# Create a branch
scalix db branch create <database-id> --name staging

API Endpoints

All requests go to https://api.scalix.world (override with SCALIX_API_URL env var).

Authentication

| Method | Endpoint | Description | |--------|----------|-------------| | GET | /api/auth/me | Current user info | | POST | /api/auth/exchange-auth-code | Exchange auth code for token | | GET | /api/cli/auth/verify | Verify CLI token | | GET | /api/cli/auth/callback?state={state} | OAuth callback polling |

Hosting

| Method | Endpoint | Description | |--------|----------|-------------| | POST | /api/hosting/deploy | Deploy application | | GET | /api/hosting/deployments | List deployments | | GET | /api/hosting/deployments/{id} | Get deployment status | | PUT | /api/hosting/deployments/{id} | Update deployment | | DELETE | /api/hosting/deployments/{id} | Delete deployment | | POST | /api/hosting/deployments/{id}/rollback | Rollback deployment | | GET | /api/hosting/deployments/{id}/health | Deployment health check | | GET | /api/hosting/logs | Deployment logs | | GET/POST/DELETE | /api/hosting/domains | Domain management | | GET/POST/DELETE | /api/hosting/environment | Environment variables |

ScalixDB

| Method | Endpoint | Description | |--------|----------|-------------| | * | /api/scalixdb/databases/* | Database management |

Environment Variables

• SCALIX_API_URL: Override the API base URL (default: https://api.scalix.world)
• SCALIX_TOKEN: Can also be set as an environment variable instead of using scalix login

Current State

Build: passes (TypeScript compiles cleanly)

Tests: 129/136 pass — 7 failures:

• 6 in deploy command (broken mock setup — apiClient.post not being called)
• 1 in API utils (version string mismatch: test expects 1.0.0, code is 1.1.0)

What works: All commands build and compile. Auth, list, status, logs, config, db subcommands, domain, env, and health commands have passing tests.

What doesn't: The deploy command's test mocks are broken, and the Cloud API hosting endpoints may not all be live yet.

Limitations

• The npm package (@scalix-world/cli v0.0.1) is a placeholder — do not install from npm.
• The delete command depends on a Cloud API endpoint that may not exist yet.
• Deployment size is limited to 100 MB.
• Deploy command tests are failing (mock issues, not necessarily code issues).

Support

For issues and questions, visit: https://scalix.world/support