CLI Command Reference
Complete reference for all CreateOS CLI commands.
Global Flags
| Flag | Description |
|---|---|
--output json, -o json | Output results as JSON (supported on most commands) |
--debug, -d | Print HTTP request/response details (tokens are masked) |
--api-url | Override the API base URL |
--help, -h | Show help for any command |
Authentication
| Command | Description |
|---|---|
createos login | Sign in via browser (OAuth) or API token |
createos logout | Sign out and clear stored credentials |
createos whoami | Show the currently authenticated user |
Project Management
| Command | Description |
|---|---|
createos init | Link the current directory to a CreateOS project |
createos projects list | List all your projects |
createos projects get | Show details for a specific project |
createos projects delete | Delete a project |
Deployments
| Command | Description |
|---|---|
createos deploy | Deploy your project (auto-detects type) |
createos deploy --branch <name> | Deploy from a specific branch (VCS projects) |
createos deploy --image <ref> | Deploy a Docker image (image projects) |
createos deployments list | List deployments for a project |
createos deployments logs | View runtime logs |
createos deployments logs -f | Tail logs in real-time |
createos deployments build-logs | View build-time logs |
createos deployments retrigger | Redeploy an existing deployment |
createos deployments cancel | Cancel a running deployment |
createos deployments wakeup | Wake up a sleeping deployment |
Environment Variables
| Command | Description |
|---|---|
createos env list | List environment variables (masked by default) |
createos env set KEY=value | Set one or more variables |
createos env rm KEY | Remove a variable |
createos env pull | Download variables to a local .env file |
createos env push | Upload variables from a local .env file |
Examples
Bash1# Set multiple variables at once2createos env set DATABASE_URL=postgres://... API_KEY=sk-xxx34# Pull to local file for development5createos env pull67# Push from local file to remote8createos env push --force
Scaling
| Command | Description |
|---|---|
createos scale --show | View current resource allocation |
createos scale --replicas N | Set number of replicas (1–3) |
createos scale --cpu N | Set CPU in millicores (200–500) |
createos scale --memory N | Set memory in MB (500–1024) |
Example
Bash1createos scale --replicas 2 --cpu 300 --memory 512
Cron Jobs
| Command | Description |
|---|---|
createos cronjobs list | List all cron jobs |
createos cronjobs create | Create a new cron job |
createos cronjobs get | Show details for a cron job |
createos cronjobs update | Update a cron job |
createos cronjobs delete | Delete a cron job |
createos cronjobs suspend | Pause a cron job |
createos cronjobs unsuspend | Resume a paused cron job |
createos cronjobs activities | View execution history |
Example
Bash1createos cronjobs create \2 --name "nightly-cleanup" \3 --schedule "0 0 * * *" \4 --path /api/cleanup \5 --method POST
Custom Domains
| Command | Description |
|---|---|
createos domains list | List custom domains |
createos domains add <domain> | Add a domain (shows DNS records) |
createos domains verify | Check DNS propagation and wait |
createos domains delete | Remove a domain |
Workflow
Bash1# Add a domain — shows required DNS records2createos domains add api.myapp.com34# After configuring DNS, verify propagation5createos domains verify67# Or check once without waiting8createos domains verify --no-wait
Templates
| Command | Description |
|---|---|
createos templates list | Browse available templates |
createos templates info <id> | Show template details |
createos templates use <id> | Download and scaffold a project |
Status & Open
| Command | Description |
|---|---|
createos status | Project health dashboard |
createos open | Open project URL in browser |
createos open --dashboard | Open the CreateOS dashboard |
VMs
| Command | Description |
|---|---|
createos vms list | List VM instances |
createos vms get | VM details |
createos vms deploy | Deploy a new VM |
createos vms ssh | SSH into a VM |
createos vms reboot | Reboot a VM |
createos vms resize | Change VM size |
createos vms terminate | Destroy a VM |
Skills Marketplace
| Command | Description |
|---|---|
createos skills catalog | Browse the skills marketplace (interactive TUI) |
createos skills purchased | List your purchased skills |
OAuth Clients
| Command | Description |
|---|---|
createos oauth-clients list | List your OAuth clients |
createos oauth-clients create | Create a new OAuth client |
createos oauth-clients delete | Delete an OAuth client |
createos oauth-clients instructions | Setup instructions for a client |
Other
| Command | Description |
|---|---|
createos upgrade | Self-update to the latest version |
createos version | Print version, channel, and commit |
createos ask | Open AI assistant for infrastructure management |
Non-Interactive / CI Usage
All commands work in CI pipelines using flags instead of interactive prompts:
Bash1# Authenticate with token2createos login --token34# Deploy with explicit project5createos deploy --project <project-id>67# Set env vars8createos env set KEY=value --project <id> --environment <id>910# Delete with force (skip confirmation)11createos domains delete --project <id> --domain <id> --force12createos deployments cancel --project <id> --deployment <id> --force1314# JSON output for scripting15createos projects list --output json16createos status --output json | jq .