Skip to main content

pan account

Sign this machine in to your overdeck.ai account with GitHub’s device flow. Sign-in is optional: pan share needs it, and pan join runs this sign-in itself when the machine is not signed in (see pan share and pan join). It is the prerequisite for the directory (PAN-2356) and Shared Sessions; see anywhere. You can also sign in from the dashboard: Settings → Anywhere → Account → Sign in, in a browser on this machine. It writes the same account.json as pan account login, and the directory connection picks it up at once.

login

Runs the device flow:
verification_uri always comes from the account service’s response; pan account never hardcodes the sign-in host. The base URL resolves in order: --base-url, then the OVERDECK_ACCOUNT_URL environment variable, then the default https://account.overdeck.ai. It must use https, or http on localhost, 127.0.0.1 or [::1], and have no path, query or fragment. Anything else exits 1 before any network call with Invalid account service URL: <url>. An unsupported platform exits 1 before any network call:
Signing in again on a machine that already has a token prints:
and still runs the flow: the service rotates this machine’s token in place. On success:
If your GitHub account is not on the invite list, or you cancel the GitHub step:
Other failures: The sign-in code expired. Run: pan account login; Cannot start sign-in at <baseUrl>: HTTP <status> when the service answers the first request with an error status; Sign-in failed: <error> when polling returns an error other than pending, slow down, denied or expired; Cannot reach <baseUrl>: <reason> when the first request fails with a network error three times in a row (it is retried after 1 s and 2 s), or when three polls in a row fail with a network error or an HTTP 5xx answer (then <reason> is HTTP <status>). <reason> names the underlying network cause when there is one, for example fetch failed (ECONNRESET: socket hang up); or, if a token arrived but reading the account afterward failed, the token is still saved and it prints Signed in (device <label>, <deviceId>), but could not read the account: <reason>. Run: pan account status.

status

With no stored token:
(exit 0; sign-in is optional). Otherwise this calls GET /v1/me against the stored base URL and prints:
or, when the account’s grant has expired, Access: expired on <date>; ask the operator to renew the invite. If this machine’s token was revoked or the account was deleted: This machine's sign-in is no longer valid (<error>). Run: pan account login, exit 1; the token file is kept so you can see this message again rather than silently sign you out. If the account service is unreachable: Signed in as <login> (account service unreachable: <reason>), exit 1, using the login cached in the token file. status shows no plan. To see your plan and relay use, open the account page at https://account.overdeck.ai/account, or Settings → Anywhere → Account in the dashboard.

logout

Revokes this machine’s device on the account service (DELETE /v1/devices/<deviceId>) and deletes the local token file either way, since a 204, 401 or 404 all mean the device is gone or already invalid:
If the service cannot be reached, or answers with a status other than 204, 401 or 404, the token file is still deleted locally, and this prints to stderr and exits 1:
With no stored token: Not signed in., exit 0, no network call. logout never touches anything under ${OVERDECK_HOME} besides account.json: not the Session Vault key, not environment-id.json.

The token file

${OVERDECK_HOME}/account.json, mode 0600, written atomically. Holds a format version v (always 1), baseUrl, accessToken, deviceId, label, githubLogin, githubId and signedInAt. A corrupt or unreadable file is never rewritten silently: reading it fails with a message naming the path and Delete it to sign out locally. It never holds the Session Vault key, a vault passphrase, or any conversation content; see pan vault for those.

Get help

Still stuck? Ask on the Overdeck Discord or file a GitHub Issue.