Getting Started
Deploy your first app in under 2 minutes.
Requirements
- Linux/Unix (Debian, Ubuntu, etc.)
- Node.js 20+
- PM2 (auto-installed by shyp init)
- Nginx (optional, for domains)
- Git
Note: Windows is not supported. Shyp is designed for Linux deployment.
1
Install Shyp
npm install -g shyp2
Initialize Shyp
This creates the configuration directory and checks for prerequisites.
shyp initThis creates /etc/shyp/ with the following structure:
/etc/shyp/
├── config.yaml # Global configuration
├── apps/ # App configurations
├── engines/ # Engine configurations (multi-module apps)
└── state/ # Runtime state (ports, deployments)3
Add an App
Run the interactive wizard to configure your first app:
shyp add my-appOr provide options directly:
shyp add my-app --repo git@github.com:you/my-app.git --domain my-app.comThis creates a config file at /etc/shyp/apps/my-app.yaml
4
Sync Configuration
Generate Nginx configs, provision SSL certificates, and reload services:
shyp sync5
Deploy
Pull the latest code, build, and start your app:
shyp deploy my-app6
Check Status
View all your apps and their health:
$ shyp status
Apps
──────────────────────────────────────────────────────────────────────
NAME STATUS PORT MEMORY UPTIME DOMAIN
my-app ● online 3001 156MB 2d 4h my-app.com