CLI & TUI
Skyport CLI
Install, configure, and connect the SkyPort CLI.
The SkyPort CLI is the operator-facing binary. It is named skyport and uses local config plus remote server profiles.
Verify The Binary
terminal
skyport --version
skyport help
Local State
The CLI stores its local data under ~/.skyport/.
~/.skyport/
├── config.yaml
├── data/
├── workspace/
├── logs/
├── cache/
└── tmp/
Connect To A Server
terminal
skyport server add --name local --url http://localhost:8080
skyport server list
If you are using multiple environments, select the profile explicitly:
terminal
skyport --server local status
Authenticate
terminal
skyport login
skyport whoami
The CLI stores the returned access token locally for the selected profile.
Output Modes
The root command supports a simple output switch:
terminal
skyport --output json docker ps
skyport --output table pm2 list
Global Flags
--configsets the config file path.--serverchooses a server profile or id.--outputswitches betweentableandjson.
Shell Completion
terminal
skyport completion bash
skyport completion zsh
skyport completion powershell
PATH Verification
Linux and macOS
terminal
which skyport
echo $PATH
Windows
Make sure the folder containing skyport.exe is in Path, then restart the terminal.
CLI Automation Examples
Inspect a server
terminal
skyport status
skyport whoami
Inspect resources
terminal
skyport docker ps
skyport pm2 list
skyport server ssh
Project and deployment flow
terminal
skyport project list
skyport project pull https://github.com/example/app.git --name app
skyport deploy --project-path ./app --start-cmd "npm run start"
Troubleshooting
skyport not found
terminal
which skyport
No active server profile
terminal
skyport server list
skyport server add --name local --url http://localhost:8080
Auth token missing or invalid
terminal
skyport login
skyport logout
skyport login
Next: CLI Commands Reference | CLI Reference