CLI Overview

The official zensailor CLI manages your instance from the terminal — for deployments, backups, nodes, networks, and CI scripts. It runs on Node.js 22.13 and newer on Linux, macOS, and Windows.

Install#

Download the CLI package from your ZenSailor dashboard under API Documentation → Download CLI, then install it globally:

BASH

# Install the downloaded package globally
npm install --global ./zensailor-cli-*.tgz

In Windows PowerShell, resolve the downloaded filename before passing it to npm:

POWERSHELL

$cliPackage = Get-ChildItem .\zensailor-cli-*.tgz | Sort-Object LastWriteTime -Descending | Select-Object -First 1
npm install --global $cliPackage.FullName
zensailor login

Create an API token in Settings → Security before running zensailor login. The CLI stores the instance URL and token in ~/.zensailor/config.json with owner-only file permissions. Run zensailor --help to explore organizations, projects, environments, templates, services, nodes, and system tools.

Release-matched and self-hosted: the release pipeline compiles the CLI, embeds the tarball in the control-plane image, and makes it available from the authenticated dashboard. No npm registry or third-party package host is involved.

Command groups#

Group	Purpose
`login`, `logout`, `config`	Authentication and saved configuration
`org`	Organizations, members, roles, deployment concurrency
`project`, `env`	Projects and environments (create, update, clone, remove)
`service`	Deploy, deployments, operations, tags, webhooks, compose, windows, backups
`domain`	Service domains
`env-var`	Environment variables, scoped
`node`	Node inventory, capacity, maintenance, decommission
`container`	Container workbench: ps, inspect, logs, files, start/stop/restart/rm
`system`	Orchestrator health, queue, retries, DNS defaults, prune
`network`	Organization-managed networks
`template`, `addon`	Template catalogue and managed databases
`instance`	Instance status, stats, update, config
`ssh-key`	SSH keys for Git providers and node provisioning
`completion`	Shell completion generation

See the CLI Reference for full command documentation.

Install#

First login#

Command groups#