Commands
Complete reference for all Shyp CLI commands.
Available Commands
shyp init
Initialize Shyp on this server
Usage
shyp init [options]Options
| -f, --force | Reinitialize even if already initialized |
Example
shyp initDetails
Creates /etc/shyp/ directory structure, checks for Node.js, PM2, Nginx, and Git. Installs PM2 globally if not present.
shyp status
Show status of all apps and engines
Usage
shyp statusExample
$ shyp status
Apps
──────────────────────────────────────────────────────────────────────
NAME STATUS PORT MEMORY UPTIME SSL DOMAIN
my-app ● online 3001 156MB 2d 4h 89d my-app.com
api-server ● online 3002 89MB 5d 12h 45d api.example.comDetails
Displays all configured apps with their PM2 status, port, memory usage, uptime, SSL certificate days remaining, and domain.
shyp deploy
Deploy an app or engine
Usage
shyp deploy <name> [options]Options
| -m, --module <module> | Deploy a specific engine module |
Example
shyp deploy my-appDetails
Pulls latest code from git, runs build command, restarts PM2 process. For engines, use --module to deploy a specific module.
shyp add
Add a new app configuration
Usage
shyp add <name> [options]Options
| -r, --repo <url> | Git repository URL |
| -d, --domain <domain> | Domain name |
| -t, --type <type> | App type (nextjs, node, static, script) |
| -p, --port <port> | Port number |
Example
shyp add my-app --repo git@github.com:you/my-app.git --domain my-app.comDetails
Creates a YAML config file in /etc/shyp/apps/. Without options, runs an interactive wizard that guides you through prerequisites and configuration.
shyp sync
Sync configs, provision SSL certs, reload Nginx
Usage
shyp sync [options]Options
| -n, --dry-run | Show what would be done without making changes |
Example
shyp syncDetails
Generates Nginx configuration files from app configs, provisions SSL certificates with Let's Encrypt for domains without certs, and reloads Nginx.
shyp start
Start the webhook server
Usage
shyp startExample
shyp startDetails
Starts the webhook listener as a PM2 process on port 9000. Listens for GitHub webhooks and triggers deployments automatically.
shyp logs
View deployment logs for an app
Usage
shyp logs <name> [options]Options
| -f, --follow | Follow log output (tail -f) |
| -n, --lines <number> | Number of lines to show (default: 50) |
Example
shyp logs my-app -fDetails
Shows deployment logs from /var/log/shyp/<name>.log. Use --follow to stream new logs as they appear.
shyp ports
Show port allocations
Usage
shyp portsExample
$ shyp ports
Port Allocations
──────────────────────────────────────────
PORT TYPE APP
3001 standard my-app
3002 standard api-server
4040 engine wyrt (http)
8080 engine wyrt (websocket)Details
Displays all allocated ports across apps and engines. Useful for debugging port conflicts.
shyp doctor
Check system health and prerequisites
Usage
shyp doctorExample
$ shyp doctor
System Health Check
──────────────────────────────────────────
✓ Node.js v20.10.0
✓ PM2 5.3.0
✓ Nginx 1.24.0
✓ Git 2.39.2
✓ Certbot 2.6.0Details
Verifies all required tools are installed and accessible. Reports versions and any missing dependencies.