CLI Reference

Complete reference for all slipp commands. Commands follow a consistent pattern:

• Singular = action (slipp run, slipp deploy)
• Plural = manage resources (slipp runs, slipp secrets)

slipp [OPTIONS] COMMAND [ARGS]

Global Options

Option	Description
-v, --verbose	Enable verbose logging
-o, --output	Output format: table (default), json
-V, --version	Show version and exit
--help	Show help message

---

Operations

Commands for monitoring and managing deployed services.

ps

List running services across registered projects (like docker ps).

slipp ps [OPTIONS]

Option	Description
-p, --project	Filter by project name
--refresh	Force re-discovery (bypass cache)
--all	Include system services

Examples

# List all services
slipp ps

# Filter by project
slipp ps -p myproject

# Fresh discovery
slipp ps --refresh

# JSON output
slipp ps -o json

logs

View service logs (journalctl or container logs).

slipp logs <service> [OPTIONS]

Option	Description
-f, --follow	Follow log output
-n, --lines	Number of lines (default: 50)
--all	Include system services in discovery

Examples

# View last 50 lines
slipp logs synapse

# Follow logs
slipp logs synapse -f

# Last 100 lines
slipp logs synapse -n 100

status

Display detailed service status (like systemctl status).

slipp status <service> [OPTIONS]

Option	Description
--all	Include system services in discovery

exec

Execute a command on VPS or in a container.

slipp exec "<command>"
slipp exec <service> "<command>"

Option	Description
-u, --user	Override user (root, postgres, www-data)

Examples

# Execute on VPS
slipp exec "df -h"

# Execute in container
slipp exec synapse "cat /data/homeserver.yaml"

# Execute as root
slipp exec -u root "systemctl restart nginx"

ssh

Open interactive shell on VPS or container service.

slipp ssh [service]

Option	Description
-u, --user	Override user

Examples

# SSH to VPS
slipp ssh

# Shell into container
slipp ssh synapse

# As specific user
slipp ssh -u postgres

host

Output host connection info (pipeable).

slipp host [project]

Option	Description
--ip	Output IP only
--user	Output user only
--port	Output port only

Examples

# Get connection string
slipp host
# Output: slipp@192.168.1.100

# Get IP for scripting
slipp host --ip
# Output: 192.168.1.100

# Specific project
slipp host myproject --ip

---

Development

Commands for local development workflows.

run

Execute a run profile for local development with remote infrastructure.

slipp run <name> [OPTIONS] [-- ARGS]

Option	Description
--cmd	Command (creates/updates profile)
--env	Environment variable KEY=VALUE (repeatable)
--vault	Vault project(s) for secrets (repeatable)
--tunnel-out	Reverse tunnel local_port:domain@host
--tunnel-in	Forward tunnel service:port@host

Create Profile

# Create and run profile
slipp run dev \
  --cmd "npm run dev" \
  --tunnel-out 5173:app.example.com@myserver \
  --vault myproject

Use Profile

# Run saved profile
slipp run dev

# Pass additional args
slipp run dev -- --port 3000

# Override at runtime
slipp run dev --env DEBUG=true

Tip

See Local Development Guide for tunnel concepts.

runs

Manage saved run profiles.

runs list

slipp runs list

Lists all saved profiles with their commands, vaults, and tunnels.

runs remove

slipp runs remove <name>

Remove a saved run profile.

launch

Generate complete Ansible project from codebase.

slipp launch [OPTIONS]

Option	Description
-n, --name	Project name (required)
-e, --env	Environment (default: production)
-d, --dir	Directories to scan (repeatable)
--dry-run	Show what would be done
--reconfigure	Re-prompt for inventory config
--proxy	Reverse proxy: caddy, none

Example

# Generate Ansible project
slipp launch --name myapp

# Multiple directories
slipp launch --name myapp -d ./frontend -d ./backend

# Different environment
slipp launch --name myapp --env staging

generate

Generate specific Ansible project files.

generate dockerfile

slipp generate dockerfile [OPTIONS]

Generate only Dockerfiles for detected services.

generate scaffold

slipp generate scaffold [OPTIONS]

Generate project scaffolding without Dockerfiles.

generate full

slipp generate full [OPTIONS]

Generate complete project (Dockerfiles + scaffolding).

---

Tags

Manage Ansible tag presets for deployments.

tag

Show a tag preset’s configuration.

slipp tag <preset>

Example

slipp tag install
# Output:
#   --tags: install-all
#   --skip-tags: import-postgres

tags

Manage tag presets.

tags list

slipp tags list

List all configured tag presets.

tags add

slipp tags add <name> [OPTIONS]

Option	Description
-t, --tags	Ansible tags to run (comma-separated)
--skip-tags	Ansible tags to skip (comma-separated)

Example

slipp tags add install --tags install-all --skip-tags import-postgres
slipp tags add setup --tags setup-all

tags remove

slipp tags remove <name>

Remove a tag preset.

---

Secrets

Generate and manage vault secrets.

secret

Generate a cryptographically secure secret.

slipp secret [OPTIONS]

Option	Description
-b, --bytes	Bytes of entropy (default: 32 = 256-bit)
--base64	Output as base64 instead of hex
--ulid	Output as ULID (ignores —bytes)
--jwk	Output as RSA JWK keypair
--bits	RSA key size for —jwk (default: 2048)

Examples

# Generate 256-bit hex secret
slipp secret
# Output: 64 hex chars

# Base64 encoding
slipp secret --base64

# Generate JWK keypair
slipp secret --jwk

# Generate ULID
slipp secret --ulid

secrets

Manage vault secrets.

secrets list

slipp secrets list [target] [secret_name]

List secrets in a vault, or show available vaults if no target specified.

Examples

# Show available vaults
slipp secrets list

# List secrets in project vault
slipp secrets list myproject

# Get template string for specific secret
slipp secrets list myproject db_password
# Output: {{ db_password }}

secrets add

slipp secrets add <name> [target] [OPTIONS]

Option	Description
-b, --bytes	Bytes of entropy (default: 32)
--jwk	Generate RSA JWK keypair
--bits	RSA key size for —jwk (default: 2048)

Examples

# Add random secret to current project vault
slipp secrets add vault_db_password

# Add to specific project
slipp secrets add vault_api_key myproject

# Add JWK keypair
slipp secrets add vault_signing_key --jwk

secrets sync

slipp secrets sync <path> [OPTIONS]

Scan YAML for {{ vault_* }} references and auto-generate secrets.

Option	Description
-b, --bytes	Bytes of entropy (default: 32)
-f, --force	Overwrite existing vault.yml

Example

slipp secrets sync inventory/host_vars/myhost/vars.yml
# Creates vault.yml with generated secrets for all {{ vault_* }} refs

Caution

Always encrypt vault files after creation:

ansible-vault encrypt inventory/host_vars/myhost/vault.yml

---

Images

Container image operations.

image push

Push local container image to VPS via SSH.

slipp image push <image> [OPTIONS]

Option	Description
--host	Target host/project
-n, --name	Rename image on VPS

Examples

# Push image
slipp image push myapp:latest

# Push to specific project host
slipp image push myapp:latest --host myproject

# Rename on push
slipp image push myapp:v1.2.3 --name myapp:latest

images list

List container images on VPS.

slipp images list [OPTIONS]

Option	Description
--host	Target host/project
-f, --filter	Filter by name pattern

Examples

# List all images
slipp images list

# Filter by pattern
slipp images list --filter "myapp*"

---

Management

Project and configuration management.

projects

Manage registered projects.

projects list

slipp projects list

List all registered projects with their paths.

projects add

slipp projects add <name> [OPTIONS]

Register the current directory as a project.

projects remove

slipp projects remove <name>

Unregister a project.

config

Show current project configuration.

slipp config

Displays:

• Project name, inventory, playbook, vault paths
• Hosts from inventory
• Global registry status

Supports -o json for machine-readable output.

---

Bootstrap

VPS bootstrap operations for initial setup.

bootstrap account

Create slipp service account on VPS.

slipp bootstrap account <host> [OPTIONS]

Option	Description
--root-user	Root user for initial connection (default: root)
--ssh-key	SSH private key path
-p, --port	SSH port (default: 22)
--user	Service account name (default: slipp)
--dry-run	Show what would be done

Example

slipp bootstrap account 192.168.1.100 --port 22

# Dry run first
slipp bootstrap account myserver.com --dry-run

This command:

1. Creates the slipp user account
2. Copies SSH keys from root
3. Configures passwordless sudo
4. Verifies the setup

bootstrap proxy

Setup dev proxy infrastructure for --tunnel-out.

slipp bootstrap proxy <host> [OPTIONS]

Option	Description
-e, --email	Email for Let’s Encrypt certificates (required)
-p, --fallback-port	Port for existing HTTPS service (default: 9443)

Example

slipp bootstrap proxy myproject --email admin@example.com

Installs Caddy dev proxy for routing production domains to local tunnels.

bootstrap registry

Setup container registry authentication on VPS.

bootstrap registry ghcr

slipp bootstrap registry ghcr [OPTIONS]

Option	Description
--host	Target host/project
-u, --user	GitHub username
-t, --token	GitHub PAT (or set GITHUB_TOKEN)

bootstrap registry dockerhub

slipp bootstrap registry dockerhub [OPTIONS]

Option	Description
--host	Target host/project
-u, --user	Docker Hub username
-t, --token	Docker Hub token (or set DOCKER_TOKEN)

Examples

# GitHub Container Registry
slipp bootstrap registry ghcr --user myuser

# Docker Hub
slipp bootstrap registry dockerhub --user myuser

---

Deploy

Execute Ansible playbook to deploy services.

slipp deploy [target] [preset] [OPTIONS]

Argument	Description
target	Environment name or tag preset (default: production)
preset	Tag preset when using slipp deploy <env> <preset>

Option	Description
-n, --name	Project name (creates/updates slipp.yaml)
--dry-run	Show what would be done
-i, --inventory	Custom inventory file path
--playbook	Custom playbook file path
--vault	Path to vault file
-r, --requirements	Path to requirements.yml
--roles	Role search directories (repeatable)
--galaxy-path	Install path for external roles
--force-requirements	Force reinstall roles
-t, --tags	Ansible tags to run
--skip-tags	Ansible tags to skip

Examples

# Deploy with defaults
slipp deploy

# Use tag preset
slipp deploy install

# Deploy to staging with preset
slipp deploy staging install

# First-time setup
slipp deploy --name myproject -i inventory/hosts

# Dry run
slipp deploy --dry-run

Tip

Create tag presets for common deployments:

slipp tags add install --tags install-all
slipp deploy install