CLI Reference

Complete reference for the sp command-line tool.

Quick overview

bash
sp <command> [options]

All commands

CommandDescription
sp setupDeploy your full stack for the first time
sp statusShow health of all services and access URLs
sp add <service>Enable an optional service (n8n, calcom, pocketbase, adminer)
sp remove <service>Disable a service, optionally keeping data
sp exportCreate an encrypted full backup
sp restore --file <path>Restore from a backup file
sp update [target]Update CLI or plugin bundle
sp credShow stored credentials (masked)
sp restart [service]Restart all or a specific service
sp logs <service>Tail container logs
sp healthcheckCheck service health and send alerts
sp shellOpen an interactive REPL session
sp cleanupRemove the entire ServicePlus installation
sp reset-passwordChange master password using security answer
sp versionShow CLI version

Getting help

Every command supports a --help flag:

bash
sp setup --help
sp add --help

Interactive shell

For multiple operations without re-entering your master password each time, use the interactive shell:

bash
sp shell