Installation

Install the Scalix Cloud CLI, SDKs, and Terraform provider

CLI

The Scalix CLI is a native binary named scalix-cloud, providing a full command set for managing your cloud resources from the terminal.

bash

npm install -g scalix-cloud

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 below.

Verify installation

bash

scalix-cloud --version

Then authenticate with your API key from console.scalix.world:

bash

scalix-cloud login

Updating

The CLI does not self-update — update it through npm like any global package:

bash

npm update -g scalix-cloud     # update to the latest release
scalix-cloud --version         # confirm the new version

To install a specific version: npm install -g scalix-cloud@1.3.4. Release notes for every version are in the changelog.

Uninstalling

bash

npm uninstall -g scalix-cloud

The downloaded binary is stored inside the package itself, so uninstalling removes everything — no leftover files.

SDKs

TypeScript / JavaScript

bash

npm install @scalix-world/sdk

Every endpoint is an exported, fully-typed function — there is no client class to instantiate. Import the operations you need and pass your API key in the options:

typescript

import { executeSql } from "@scalix-world/sdk";
 
const opts = {
  headers: { Authorization: `Bearer ${process.env.SCALIX_API_KEY}` },
};
 
const { data, error } = await executeSql({
  ...opts,
  body: { query: "SELECT NOW()" },
});

Every call resolves to a { data, error, response } envelope — see the TypeScript SDK guide for the full walkthrough.

Python

bash

pip install scalix-sdk

Create one AuthenticatedClient and pass it to operations, which are grouped by service under scalix_sdk.generated.api.<tag>:

python

import os
from scalix_sdk import AuthenticatedClient
from scalix_sdk.generated.api.database import execute_sql
from scalix_sdk.generated.models import SqlRequest
 
client = AuthenticatedClient(
    base_url="https://api.scalix.world",
    token=os.environ["SCALIX_API_KEY"],
)
 
result = execute_sql.sync(client=client, body=SqlRequest(query="SELECT NOW()"))

Each operation exposes sync, sync_detailed, asyncio, and asyncio_detailed callables — see the Python SDK guide for the full walkthrough.

Keeping the SDKs up to date

bash

npm install @scalix-world/sdk@latest   # TypeScript
pip install --upgrade scalix-sdk       # Python

SDK versions follow the platform API line; minor and patch updates are backwards-compatible.

Terraform Provider

The Scalix Terraform provider exists but is not yet published to the Terraform Registry — publication is pending. Until it lands, install the provider binary via a local filesystem mirror (place it under ~/.terraform.d/plugins/registry.local/scalixworld/scalix/<version>/<os_arch>/) and reference the mirror source:

hcl

terraform {
  required_providers {
    scalix = {
      source  = "registry.local/scalixworld/scalix"
      version = "~> 0.1"
    }
  }
}
 
provider "scalix" {
  token = var.scalix_token  # or set SCALIX_TOKEN env var
}

Once the provider is on the public registry, the source becomes scalixworld/scalix.

Agent Tools

For AI agent integration, Scalix serves a REST tool surface through the platform gateway — no local install required:

bash

# List the available tools with their JSON schemas
curl https://api.scalix.world/api/v1/mcp \
  -H "Authorization: Bearer $SCALIX_API_KEY"
 
# Call a tool
curl -X POST https://api.scalix.world/api/v1/mcp/call \
  -H "Authorization: Bearer $SCALIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "get_schema", "arguments": {}}'

The catalog covers 40+ tools across the whole platform — database, storage, functions, compute, KV, events, cron, domains, builds, auth, and search. MCP clients (Claude Code, Cursor, custom agents) can also connect directly to the standard MCP endpoint at https://api.scalix.world/v1/mcp (JSON-RPC 2.0). The full OpenAPI 3.1 spec is published at https://api.scalix.world/openapi.json. See the agent tools docs for the tool catalog and client setup.