Reference

CLI Reference

Complete SkyPort CLI command reference

CLI Reference

Complete reference of all SkyPort CLI commands.

Global Options

-v, --verbose              Enable verbose output
-vv, --very-verbose        Enable very verbose output
--format FORMAT            Output format (json, yaml, table)
--server SERVER            Target server
--no-color                 Disable colored output
--help                     Show help
--version                  Show version

Commands

Server Commands

skyport status             # Server status
skyport system info        # System information
skyport metrics            # System metrics
skyport stop               # Stop server

Authentication

skyport auth login         # Login to remote server
skyport auth logout        # Logout
skyport auth token         # Manage API tokens

Docker Commands

# Container management
skyport docker ps                    # List containers
skyport docker ps -a                 # List all containers
skyport docker run [OPTIONS] IMAGE   # Run container
skyport docker start CONTAINER       # Start container
skyport docker stop CONTAINER        # Stop container
skyport docker restart CONTAINER     # Restart container
skyport docker rm CONTAINER          # Remove container
skyport docker exec CONTAINER CMD    # Execute command
skyport docker logs CONTAINER        # View logs
skyport docker top CONTAINER         # View processes
skyport docker stats [CONTAINER]     # View stats
skyport docker inspect CONTAINER     # View details

# Image management
skyport docker images                # List images
skyport docker pull IMAGE            # Pull image
skyport docker build -t TAG .        # Build image
skyport docker tag SOURCE TARGET     # Tag image
skyport docker push IMAGE            # Push image
skyport docker rmi IMAGE             # Remove image
skyport docker search TERM           # Search Docker Hub

# Volume management
skyport docker volume ls             # List volumes
skyport docker volume create NAME    # Create volume
skyport docker volume rm NAME        # Remove volume
skyport docker volume prune          # Remove unused volumes

# Network management
skyport docker network ls            # List networks
skyport docker network create NAME   # Create network
skyport docker network rm NAME       # Remove network

PM2 Commands

skyport pm2 list                     # List processes
skyport pm2 start SCRIPT [OPTIONS]   # Start process
skyport pm2 stop NAME                # Stop process
skyport pm2 restart NAME             # Restart process
skyport pm2 delete NAME              # Delete process
skyport pm2 restart all              # Restart all
skyport pm2 stop all                 # Stop all
skyport pm2 delete all               # Delete all
skyport pm2 scale NAME NUM           # Scale processes
skyport pm2 logs [NAME]              # View logs
skyport pm2 flush                    # Clear logs
skyport pm2 monit                    # Monitor processes
skyport pm2 describe NAME            # Process details
skyport pm2 save                     # Save process list
skyport pm2 startup                  # Auto-startup
skyport pm2 unstartup                # Disable auto-startup

VPS Commands

skyport vps list                     # List servers
skyport vps add-server [OPTIONS]     # Add server
skyport vps remove SERVER            # Remove server
skyport vps ssh SERVER               # SSH to server
skyport vps exec SERVER CMD          # Execute command
skyport vps scp SRC DST              # Copy files
skyport vps info SERVER              # Server info
skyport vps disk SERVER              # Disk usage
skyport vps ps SERVER                # Processes
skyport vps firewall list SERVER     # List rules
skyport vps firewall add SERVER      # Add rule
skyport vps firewall rm SERVER RULE  # Remove rule

Marketplace Commands

skyport marketplace list             # List installed apps
skyport marketplace search TERM      # Search apps
skyport marketplace info NAME        # App details
skyport marketplace install NAME     # Install app
skyport marketplace uninstall NAME   # Uninstall app

Project Commands

skyport project list                 # List projects
skyport project create NAME          # Create project
skyport project delete NAME          # Delete project
skyport project info NAME            # Project details

Logs Commands

skyport logs [NAME]                  # View logs
skyport logs [NAME] -f               # Follow logs
skyport logs [NAME] --lines N        # View N lines
skyport logs [NAME] --grep PATTERN   # Search logs
skyport logs [NAME] --since TIME     # Logs since time

Server Management

skyport server add [OPTIONS]         # Add server
skyport server list                  # List servers
skyport server remove SERVER         # Remove server
skyport server set-default SERVER    # Set default

Examples

Docker Examples

# Run Nginx
skyport docker run -d -p 80:80 nginx:latest

# Build and run app
skyport docker build -t my-app:1.0 .
skyport docker run -d -p 3000:3000 my-app:1.0

# Clean up
skyport docker stop <id>
skyport docker rm <id>
skyport docker rmi my-app:1.0

PM2 Examples

# Start Node.js app
skyport pm2 start app.js --name "app"

# Start with npm
skyport pm2 start "npm start" --name "app"

# Scale to 4 instances
skyport pm2 scale app 4

# View logs
skyport pm2 logs app -f

VPS Examples

# Add SSH server
skyport vps add-server --name prod --host 1.2.3.4 --user ubuntu

# Execute command
skyport vps exec prod "docker ps"

# View disk usage
skyport vps disk prod

Exit Codes

CodeMeaning
0Success
1General error
2Misuse of command
127Command not found

More: CLI Installation | Authentication

SkyPort

SkyPort Docs

Self-hosted infrastructure platform