Getting started
Overview
What the Verentis CLI is, how it authenticates, and how commands find your account and workspace.
The Verentis CLI wraps the Verentis platform API in a single verentis command. It handles
authentication, token exchange and scoping for you, so most of the time you work with high-level
commands (workspace, files, exec, publish) and never touch a raw HTTP call.
The three jobs it does
Accounts, workspaces, users, invitations, API keys and settings — the things an operator manages.
Mint scoped tokens, generate the platform's execution context, and run/debug scripts locally against real workspace files.
Create a publisher, sign packages, and publish/install .vpkg bundles on the marketplace.
How a command runs
It resolves your identity
The CLI reads the credential you signed in with (API key, identity token, or a device-flow session) and, for each request, exchanges it for a short-lived access token scoped to exactly what the command needs.
It resolves your context
Commands that act on a workspace or account use the value from --workspace / --account if given,
otherwise the defaults you set with verentis use, otherwise
a value derived from your identity.
It calls the platform
The request goes through the API gateway for your environment (--api-url, saved at login). Read
commands render a table by default, or JSON with --json. Errors are shown as compact RFC 7807
problem details.