slipway-cli
v0.0.3
Published
CLI for Slipway - Deploy Sails apps with ease
Maintainers
Readme
slipway
The CLI for Slipway - the Sails-native deployment platform
Zero Dependencies
This CLI has no npm dependencies. It uses only Node.js 22+ built-ins:
node:util→parseArgsfor argument parsingnode:readline→ interactive promptsnode:fs→ config storage in~/.slipway/- Native
fetch→ HTTP requests - Native
fetchstreaming → application logs (SSE) and guarded Helm commands (NDJSON)
The CLI starts without installing third-party runtime dependencies.
Commands
# Slide into production!
slipway slide # Primary command
slipway deploy # Alias
slipway launch # Alias
# Project context
slipway init
slipway link my-project
# Databases
slipway db:create main-db --type=postgresql
slipway db:url main-db
slipway services
slipway backup:create main-db
# One custom domain per environment (run in a linked project)
slipway environment:update production --domain app.example.com
slipway environment:update production --domain "" # Remove custom domain
slipway environments
# Environment variables
slipway env:set KEY=value --env production
slipway env --env production
# Operations
slipway logs --project my-project --env production --follow --ndjson
slipway run --project my-project --env staging --file command.txt --json
slipway doctor --project my-project --env staging --app web --json
slipway app:inspect --project my-project --env staging --app web --json
slipway run:history --project my-project --env staging --app web --jsonSee stream and mutation contracts for targeting, machine output, input files/stdin, production write guards, and exit statuses. See CLI reliability contracts for cancellation, private receipts, guarded arming, app restart, authentication checks, and command-specific help.
Custom domains
A custom hostname belongs to an environment and is shared by its routed apps. Setting another hostname replaces the previous custom hostname. A generated hostname, when configured, remains available as a fallback.
Point DNS to your Slipway server before saving. A verified proxy route does not prove DNS propagation or certificate issuance. HTTPS becomes available after DNS and public ingress allow automatic certificate provisioning. Open the HTTPS URL to verify it. Slipway does not provide certificate inspection commands.
To remove a custom hostname, pass an empty string as shown above. Access then uses the configured generated hostname or the available direct-access route.
Installation
npm install -g slipway-cli
# or
npx slipway-cliPart of the Slipway Suite
- Slipway Dashboard - The web UI (root of this monorepo)
- sails-hook-slipway - The Sails hook for Bridge, Helm, telemetry
Where your apps slide into production.
Deployment readiness
Run slipway readiness --env production after pushing source. Add --app web to select an app, or --json to return the same structured report used by the dashboard. Required checks block deployment; recommendations and optional capabilities do not. See the readiness contract for source fingerprints, external connections, and explicitly required variables.
