Skip to main content
When you finish, you’ll have run a command on a Voyager cloud GPU and released it.
Before you start: a paid Voyager workspace (Starter or above). The machine bills Voyager credits by the minute until you release it; this quickstart takes a few minutes on render-lite, the cheapest preset.
1

Install the CLI

It installs voyager-cloud for your user (no sudo) and checks the download against its published checksum.
Check it: voyager-cloud --version. Later, voyager-cloud update updates it.
2

Sign in

Your browser opens; sign in with your Voyager account. Check who you are and which workspace pays with voyager-cloud whoami (switch with voyager-cloud whoami --workspace <workspace>).On a server or in CI, set VOYAGER_API_KEY to an API key from voyager.so/dashboard/api instead, or run voyager-cloud login --key, which reads it from that variable. Credentials are kept in one private file in your user config folder, never in the system keychain. voyager-cloud logout signs out and revokes them.
3

Lease a machine

--wait returns once the machine is ready, usually within a couple of minutes. Note its id (mch_…); the commands below take the id or the name.
4

Run a command

exec waits, streams the output and exits with the command’s exit code, so scripts and agents can check it. Everything after -- runs on the machine.
5

Move files

push skips files that haven’t changed, so pushing the same folder again is quick.
6

Release it

Release prints what the machine cost. It stops billing straight away.

​
Check it worked

voyager-cloud list shows your machine as released, with its cost. If you forget to release a machine, it pauses itself after 15 minutes idle; it doesn’t bill for the GPU while paused, but release it when you’re done.

​
Commands

Every command takes --json, which prints the API’s objects unchanged, so scripts and agents can read every field. Environment: VOYAGER_API_KEY (use a key instead of signing in) and VOYAGER_API_URL (default https://api.voyager.so).

​
If something went wrong

Cloud machines need a paid workspace, Starter or above, with a completed payment. The error includes the billing link; owners and admins can upgrade at voyager.so/dashboard/billing. If you belong to more than one workspace, check voyager-cloud whoami shows the one with the plan.
Open a new terminal so it picks up the install folder, or add the folder the installer printed to your PATH.
GPUs are sometimes all in use. failed machines don’t bill. Try again, or lease another preset (render-lite is often free sooner).

​
Next

Machines and cost

Leasing options, pausing, snapshots and what a machine costs.

Render with Vork

The render loop for Vork scenes.