Riven / CLI

Riven CLI

Manage your Riven services from the command line.

Create a Personal Access Token (PAT) from your Riven dashboard before signing in to the CLI.

1Install the CLI

Install the Riven CLI globally with npm.

npm install -g riven-cli

Once installed, the riven command will be available in your terminal.

riven login

When prompted, paste your Personal Access Token.

Paste your Riven PAT: **************

Press Enter to complete the authentication. Once verified, you're ready to use the CLI.

✓

A Personal Access Token is displayed only once when it is created. If you lose it, revoke the token from your dashboard and create a new one.

These commands are available after you sign in with your Personal Access Token.

riven whoami

Display the account associated with the current Personal Access Token.

riven logout

Remove your saved credentials and sign out of the CLI.

riven list services

List all services deployed in your Riven account.

riven list deployments {serviceId}

Show the deployment history for a specific service.

riven start {serviceId}

Start a stopped service.

riven stop {serviceId}

Stop a running service.

riven restart {serviceId}

Restart a running service.

riven delete {serviceId}

Permanently delete a service.

riven deploy {serviceId}

Create a new deployment for an existing service.