Getting Started

Install the CLI, authenticate, link your project, and deploy — all in under 2 minutes.

Prerequisites

macOS or Linux (Windows: download binary)
A CreateOS account

Step 1: Install

macOS (Homebrew)

Bash
1brew install createos

macOS / Linux (curl)

Bash
1curl -sfL https://raw.githubusercontent.com/NodeOps-app/createos-cli/main/install.sh | sh -

Verify

Bash
1createos version

Expected output:

CreateOS CLI (version: v1.0.0)
  Channel: stable
  Commit:  abc123

Step 2: Authenticate

Bash
1createos login

Opens your default browser for OAuth sign-in. The CLI stores the session and auto-refreshes it — you won't need to re-login.

API token (for CI/CD and headless environments)

Bash
1createos login --token

Paste your API key when prompted. Get your key from Profile Settings > API Keys in the CreateOS dashboard.

Verify authentication

Bash
1createos whoami

Expected output:

ID:          abc-123-def
Email:       [email protected]
Created At:  January 15, 2026

Step 3: Link your project

Navigate to your project directory and link it:

Bash
1cd my-api/
2createos init

The CLI lists your projects and lets you pick one interactively. If you know the ID:

Bash
1createos init --project <project-id>

This creates a .createos.json file in your directory. All subsequent commands auto-detect the project — no need to pass --project every time.

.createos.json is automatically added to .gitignore.

Step 4: Deploy

Bash
1createos deploy

The CLI auto-detects your project type and deploys:

Project type	What happens
VCS (GitHub)	Triggers deployment from the latest commit
Upload	Zips your local directory and uploads it
Docker image	Deploys the specified image

Build logs stream in real-time. When deployment succeeds, you get your live URL:

  Building v12...

  Step 1/4: Installing dependencies...
  Step 2/4: Building application...
  Step 3/4: Running tests...
  Step 4/4: Packaging container...

  ✓ Deployed (v12)

  ℹ Live at: https://my-api.nodeops.app

Deploy a specific branch

Bash
1createos deploy --branch staging

Deploy a Docker image

Bash
1createos deploy --image myapp:v1.0

Step 5: Verify

Check your project status:

Bash
1createos status

Open in browser:

Bash
1createos open

Tail runtime logs:

Bash
1createos deployments logs -f

Next steps

Task	Command	Docs
Set environment variables	`createos env set KEY=value`	Environment Variables
Add a custom domain	`createos domains add myapp.com`	Custom Domains
Scale resources	`createos scale --replicas 2`	Scaling
Schedule a cron job	`createos cronjobs create`	Cron Jobs
Use in CI/CD	`createos deploy --project $ID`	CI/CD Usage
See all commands	`createos --help`	Command Reference

Updating

The CLI checks for updates automatically. To upgrade:

Bash
1createos upgrade

Or via Homebrew:

Bash
1brew upgrade createos

100,000+ Builders. One Workspace.