Skip to content
Slipwaydocs

CLI overview

The slipway CLI is the same binary as the server and runner. It talks to the Connect API, so everything you can do in the UI you can script. The CLI is Apache-2.0.

Install

Section titled “Install”
Terminal window
# Homebrew
brew install --cask slipway-systems/tap/slipway     # macOS; on Linux use the deb, rpm, apk or tarball


# or download a release archive / deb / rpm / apk from the GitHub releases page
slipway version

A container image with the CLI is the runner image: ghcr.io/slipway-systems/slipway-runner.

Sign in

Section titled “Sign in”
Terminal window
slipway login                                   # opens a browser, approve the code shown in the terminal
slipway login --server https://ci.example.com   # a self-hosted server
slipway login --no-browser                      # print the URL instead
echo "$SLIPWAY_TOKEN" | slipway login --server https://ci.example.com --with-token   # CI and headless

Credentials are saved as a named context (default name derived from the server host). Tokens are never printed.

Contexts, org and project

Section titled “Contexts, org and project”
Terminal window
slipway context list
slipway context use staging-server
slipway org list
slipway org switch acme
slipway project list
slipway project use api            # remembered for later commands
slipway whoami -v                  # who you are, plus effective permissions

Override per command: --context, --org, -p/--project.

Output

Section titled “Output”
Flag Effect
--json Machine-readable JSON on stdout
-q, --quiet Only identifiers, one per line, for piping
--no-color Disable colour (also automatic when stdout is not a terminal)
Terminal window
slipway run list --status failed --json | jq -r '.[].id'
slipway run list -q --pipeline api | head -1 | xargs slipway logs

Human output is a table or a live job/step tree on a terminal.

Exit codes and CI

Section titled “Exit codes and CI”

Commands that wait (--wait, --watch, run watch) exit non-zero when the run or deployment does not succeed, so they gate CI steps naturally. Usage errors use a distinct exit code from operational failures.

Terminal window
slipway deploy api 1.4.0 --env staging --wait || exit 1

Environment

Section titled “Environment”
Variable Purpose
SLIPWAY_TOKEN Token to use instead of a saved context (CI)
SLIPWAY_SERVER Server URL
SLIPWAY_CONTEXT Context name
SLIPWAY_ORG, SLIPWAY_PROJECT Default organisation and project
SLIPWAY_CONFIG Path to the CLI config file

The full list of commands and flags: CLI reference.