Skytells CLI

Control the Skytells platform from your terminal — deploy apps, manage databases, stream logs, and automate workflows without opening a browser.

Command-Line Interface

The Skytells CLI (@skytells/cli) gives you full terminal-based access to the platform. Every operation available in the Console is accessible from the command line, with machine-readable JSON output for scripting and CI/CD pipelines.

npm install -g @skytells/cli
skytells auth login

What You Can Do

Deploy apps

Trigger deployments, redeploy on demand, and stream deployment logs in real time.

Manage databases

Provision PostgreSQL, MySQL, MariaDB, MongoDB, and Redis instances in seconds.

Stream logs

Tail live logs from any app or service without touching the Console.

Automate workflows

Script multi-step operations and integrate with CI/CD using JSON output.

How the CLI Fits Into the Platform

The CLI is not a separate product — it is a terminal projection of the same platform you access through the Console and APIs. Every command maps to an authenticated API call under the hood, which means:

The same API keys and personal access tokens that authenticate your HTTP requests also authenticate CLI sessions.
Project-scoped access keys (set via skytells link or the SKYTELLS_ACCESS_KEY environment variable) scope the CLI to a specific project, matching the permission model used by the API. See CLI Configuration for the full precedence order.
Output produced by --json flags is the same JSON shape returned by the REST API, making it safe to pipe into scripts or CI/CD systems.

This means you can switch freely between the Console, the SDK, and the CLI during development — they all operate on the same resources with the same auth model. There is no separate account or credential system to maintain.

Authentication and Credential Model

The CLI authenticates via the same credential types available to every other Skytells interface:

Method	How it works	When to use
Device flow (`skytells login`)	OAuth 2.0 device authorization — opens a browser, stores a token at `~/.config/skytells/credentials.json`	Interactive development sessions
Personal access token (`SKYTELLS_TOKEN`)	Long-lived token scoped to your account	Automation, scripts, shared environments
Project access key (`SKYTELLS_ACCESS_KEY`)	Project-scoped key with explicit permission grant	CI/CD pipelines, per-project isolation

The CLI applies credentials in this order: environment variables → stored credentials file → interactive login prompt. See Authenticate with Skytells CLI for the full authentication reference.

Credentials stored by skytells login live at ~/.config/skytells/credentials.json by default. Override the location with SKYTELLS_CONFIG_DIR if your environment requires a custom path.

Full CLI Documentation

For installation, commands, configuration, and troubleshooting, see the CLI guide.

How is this guide?