Portaldocs
Getting started

Sign in

Sign in with your Clusy account, in the browser and from the CLI, and what each role in a workspace may do.

Warnings and limits

  • Portal is open to anyone with an active Clusy account and a verified email address.
  • Never paste a token into a chat or a command line. portal login approves the CLI in the browser and stores its credential itself.
  • Sensitive actions (connections, secrets, settings, agent tokens, approving a machine) need a Clusy sign-in from the last 5 minutes.
  • A console session ends after 12 hours without use, and after 7 days in any case.
  • A device code lasts 10 minutes.

In the browser

Open portal.clusy.io/app and continue with Clusy. Portal uses your Clusy account; it keeps no password of its own.

The session lasts while you use it: it is renewed as you work, ends after 12 hours without use, and after 7 days at most.

From the CLI

portal login

The browser opens on an approval page. Approve it, and the CLI receives a credential of its own and stores it. You never see or paste it.

OptionWhen to use it
--no-browserPrints the approval page instead of opening it, so you can open it on any device.
--deviceUses a device code: the terminal shows a code like ABCD-EFGH; compare it with the one the approval page shows before you approve. The code lasts 10 minutes.
--reauthStarts a fresh sign-in instead of reusing the current one.

portal setup signs in the same way when no sign-in exists. The CLI's credential renews itself every 15 minutes and lasts until it is revoked. You can revoke it in the console under Settings, Agents.

Fresh sign-in

Some actions need a Clusy sign-in from the last 5 minutes: adding or changing a connection, storing or deleting a secret, changing settings, making an agent token and approving a machine. The console asks you to confirm it is you, and the waiting action goes ahead once you have.

Workspaces and roles

Each admitted person gets a workspace of their own, as its Owner. What each role may do:

RoleMay
Viewerread jobs, logs, usage, connections and settings
Operatoralso run, move, suspend, resume and stop jobs
Administratoralso add, change and remove connections and secrets
Owneralso change settings, approve machines, clean up leaked resources and make agent tokens

Agent tokens

A coding tool or a script can use an agent token (ptl_...). An Owner makes one in the console under Settings, Agents:

  • its access: read, run jobs, or run jobs and manage connections. An agent token is never given admin access;
  • an optional budget, which caps each job the token starts;
  • how long it lasts: 1, 7 or 30 days (7 by default).

The token is shown once. Revoke it under Settings, Agents. portal setup and portal login make a sign-in of their own for the CLI and its coding tools, so most people never need a token.

On this page