Install
Recommendedryvn to your PATH.
Homebrew
Authenticate
Log in with your Ryvn account using the browser-based device flow:https://.
The CLI fetches the instance’s public discovery document and derives the
issuer, Zitadel project, CLI device-flow client, console, and access proxy
URLs from that one address. It writes a profile named after the instance host
and makes that profile active. Use --profile as well when you want a
different profile name.
Profiles can include a tunnel-url field. This is the base URL used
when ryvn connect writes a kubeconfig for environment access.
Environments that require approval before granting cluster access are covered in
Just-in-time kubectl access.
Upgrade
The CLI checks for updates automatically. To upgrade:brew upgrade ryvn instead — ryvn upgrade is not supported for Homebrew installations.
Run your first commands
Commands follow a verb and a resource type. List your services, look at one installation, and stream its logs:-e selects the environment. Run ryvn --help for the full command list, or ryvn <command> --help for any one
command. The CLI reference covers each verb and the installation commands such as rollback, pin,
and restart.
Using the CLI with agents
For CI, remote agents, or shared automation, use a service user instead of sharing personal credentials. Service users provide scoped, programmatic access that you can assign and revoke independently.Create a service user
Service users provide scoped, programmatic access to your Ryvn organization. Create one from the CLI:Use service users via profiles
For agents running on your local machine, create a profile with the service user credentials:Use service users via environment variables
For CI pipelines, remote servers, or agent runtimes, pass credentials via environment variables:-e or --environment to commands that target an environment.
In GitHub Actions jobs with
permissions: id-token: write, the CLI authenticates as the repository’s CI identity and ignores RYVN_CLIENT_ID / RYVN_CLIENT_SECRET. To run a job as a service user instead, omit id-token: write. See Which identity a job uses.