Deploy servers with the CLI

The bitqate servers commands cover containers and game servers: create them from an image, a game catalog, a Dockerfile or a connected git repository, then manage power, ports, startup and deployments. Install the CLI and log in first.

Create a server

bitqate servers create

On a terminal the wizard asks for a Source, then Region, Size (presets with monthly prices), optional environment variables as KEY=VALUE lines, a Name, and Billed to. It ends with a review and the charged total before creating.

Pick a source

Docker image, any public image reference:

bitqate servers create --name api --region ca-mo-01 --memory-mb 1024 --cpus 1 --disk-gb 10 --image ghcr.io/org/app:latest

Deploy a Docker image has more on registries and volumes.

Game server, from the built-in catalog. Pass the game name (case-insensitive) or a raw egg URL:

bitqate servers create --game paper --name minecraft --region ca-mo-01 --memory-mb 2048 --cpus 2 --disk-gb 10
bitqate servers create --egg-url https://bitqate.com/eggs/egg-paper.json ...

The catalog includes Minecraft (Paper, Vanilla, Forge), Rust, Valheim, Terraria and more; the wizard lists them with a filter. Game eggs fill in the image, startup command and variables for you.

Dockerfile, a local file up to 64 KB:

bitqate servers create --name app --region ca-mo-01 --memory-mb 1024 --cpus 1 --disk-gb 10 --dockerfile ./Dockerfile

GitHub: --git creates a git-mode server. Connecting the repository itself happens in the dashboard afterwards (API tokens can't link your git account); see Deploy from a GitHub repository.

Common flags

Sizes and prices come from the current price list (bitqate prices); the wizard shows the monthly cost before you confirm.

After creating

bitqate servers list
bitqate servers get api
bitqate servers install-state api
bitqate servers wait api --status online

Like VMs, you can refer to a server by name, short ID or UUID. install-state shows installing/installed/failed; the wizard waits for installation for every source.

Configure

bitqate servers startup api --command "./run.sh" --env MODE=prod
bitqate servers ports api --port 25566:udp --port 8080

--port is internalPort[:tcp|udp] (tcp by default) and replaces the whole extra-ports list; pass none to clear it.

Power

bitqate servers stop api --wait
bitqate servers start api --wait
bitqate servers restart api --wait

Deployments (git servers)

bitqate servers deploy api --follow
bitqate servers deployments list api
bitqate servers deployments get api <deploy-id>
bitqate servers deployments logs api <deploy-id>

--follow streams the build log and exits non-zero when the deployment fails.

Backups and delete

bitqate servers backups list api
bitqate servers backups create api
bitqate servers backups restore api <backup-id>
bitqate servers backups delete api <backup-id>

bitqate servers delete api

On a terminal, delete shows what you'll get back; Refund $8.20 to your account balance and the backup count; then asks you to type the name. In a script, --yes skips that.