Skip to content

commands.md

Latest commit

 

History

History
119 lines (93 loc) · 4.27 KB

commands.md

File metadata and controls

119 lines (93 loc) · 4.27 KB

Commands Reference

All ShipNode commands with descriptions.

Setup Commands

Command Description
shipnode init Initialize project configuration (interactive)
shipnode init --non-interactive Initialize without prompts (for CI)
shipnode init --template <name> Use a framework preset
shipnode init --print Print config without writing
shipnode setup Install Node.js, PM2, Caddy on server

Deploy Commands

Command Description
shipnode deploy Deploy your app
shipnode deploy --skip-build Skip build step
shipnode deploy --dry-run Preview without deploying
shipnode deploy --config <file> Use specific config file
shipnode deploy --profile <name> Use shipnode.<name>.conf

Monitor Commands

Command Description
shipnode status Rich status dashboard
shipnode logs Stream live PM2 logs
shipnode metrics Real-time CPU/memory monitor
shipnode releases List all releases

Manage Commands

Command Description
shipnode rollback Rollback to previous release
shipnode rollback <n> Rollback n releases
shipnode rollback <timestamp> Rollback to specific release
shipnode restart Restart app gracefully
shipnode stop Stop app
shipnode unlock Clear stuck deployment lock

Customize Commands

Command Description
shipnode eject Eject PM2 + Caddy templates
shipnode eject pm2 Eject only PM2 template
shipnode eject caddy Eject only Caddy template
shipnode config Show resolved config values
shipnode config validate Validate config without deploying

Environment Commands

Command Description
shipnode env Upload .env to server
shipnode env pull Download .env from server
shipnode env list List environment variables
shipnode run "<cmd>" Run a command on the server in the app context using the configured Node.js runtime
shipnode run "<cmd>" --tty Force an interactive TTY session
shipnode run "<cmd>" --profile <name> Run using shipnode.<name>.conf
shipnode run "<cmd>" --config <file> Run using a specific config file

shipnode run executes inside $REMOTE_PATH/current, sources $REMOTE_PATH/shared/.env when present, and uses the project runtime from NODE_VERSION through mise when available. Before executing the command, ShipNode repairs execute bits only for package-declared binaries in node_modules (node_modules/.bin targets and package.json bin entries), avoiding common package CLI Permission denied errors without chmodding the whole app tree.

Backup Commands

Command Description
shipnode backup setup Install/update database backup script and systemd timer
shipnode backup run Run a database backup immediately
shipnode backup status Show timer status, recent logs, and local backups
shipnode backup list List uploaded backups in S3

User Commands

Command Description
shipnode user sync Sync users from users.yml
shipnode user list List provisioned users
shipnode user remove <user> Revoke user access
shipnode mkpasswd Generate password hash

CI/CD Commands

Command Description
shipnode ci github Generate GitHub Actions workflow
shipnode ci env-sync Sync config to GitHub secrets
shipnode ci env-sync --all Sync config + .env

Diagnostic Commands

Command Description
shipnode doctor Pre-flight checks
shipnode doctor --security Security audit
shipnode harden Server hardening wizard
shipnode upgrade Upgrade ShipNode

Other Commands

Command Description
shipnode help Show help message
shipnode version Show version
shipnode migrate Migrate to release structure

Global Flags

Flag Description
--help, -h Show help
--version, -v Show version
--quiet, -q Suppress output
--debug Enable debug mode