Quickstart

Warnings and limits

Portal is open to anyone with an active Clusy account and a verified email address.
A connected provider is not usable capacity: check your account's quotas for the region, the machine family, spot and GPUs first. See Quotas and capacity.
A launch uploads your project directory: files over 100 MB are left out, and a project over 500 MB is refused.
A job's outputs are kept 7 days after it ends. Pull them before then.
Ctrl-C detaches from a job's output. It does not stop the job, and the machine keeps billing until the job ends or you stop it.

Install the CLI

curl -fsSL https://gateway.clusy.io/install.sh | sh

The installer puts portal on your PATH and runs portal setup, which registers Portal with Claude Code and Codex when they are installed and opens the browser to sign you in. See Install the CLI.

With a coding agent, give it set up https://portal.clusy.io/SKILL.md instead: it installs Portal, waits for your sign-in and connects the clouds you approve, which covers the next two steps. It then checks those clouds' GPU and Spot quotas and, if you agree, applies for what one job needs. See Set up your coding tool.

If you skipped sign-in during setup:

portal login

Approve the sign-in in the browser. The CLI gets a credential of its own; you never paste a token. See Sign in.

Connect a provider

See which cloud CLIs are signed in on this machine, then connect one with its own login:

portal connect --detect
portal connect aws --from-cli

--from-cli lists every step it will take in your account and asks before it makes anything. You can also connect from the console's Connect page. See Providers.

Compare quotes

portal prices --gpu T4
portal run train.py --gpu T4

Without --on, portal run only lists quotes: nothing is uploaded and nothing starts.

Launch

Pick a quote and pass its spec to --on, with a project name:

portal run train.py --gpu T4 --on SPEC --project demo -d

SPEC is the exact spec of the quote you picked, as portal run printed it. --project is required to launch (1 to 100 characters). -d returns once the job is queued. Script arguments go after --. See Run a job.

Watch it

portal ps
portal logs JOB --follow
portal explain JOB

JOB is a job id, a unique start of one, or the job's name. The console shows the same at portal.clusy.io/app.

Collect the outputs

When the job has ended:

portal pull JOB ./results

See Outputs and logs.