Skip to content
rytivdocs

CLI reference

CLI reference

Markdown

Every command of ry, the Rytiv CLI, generated from its source.

ry is the Rytiv command line. This reference is generated from the CLI’s own command definitions, so it lists exactly what ry --help and the help of each subcommand show.

Install

Section titled “Install”
curl -fsSL https://get.rytiv.com/install.sh | sh

The CLI is a Node.js package and needs Node.js 22.6 or newer. The installer checks the published checksum before it installs anything.

Sign in

Section titled “Sign in”
ry login

ry login shows a code that you confirm in the console. Where nobody can open a browser (CI, a coding agent), use a token instead: ry login --token <token>, or set RYTIV_TOKEN in the environment. Create tokens with ry tokens create.

Global options

Section titled “Global options”
  • -v, --version: Output the version number.
  • --json: Output raw JSON (scripting).
  • -P, --profile <name>: Which saved login to use for this call (does not change the default).

Every command accepts --json for machine-readable output, which is the form to use from scripts and agents.

Environment

Section titled “Environment”
  • RYTIV_TOKEN: the API token to use for this shell. It takes precedence over a saved login and is never written to disk.
  • RYTIV_ENDPOINT: the API endpoint to talk to. Without it, the CLI uses https://api.rytiv.app.
  • RYTIV_PROFILE: which saved login to use for this shell (see ry profile).

Commands

Section titled “Commands”
  • ry apps: Manage apps.
  • ry attach: Attach a resource to an app: injects the connection URL as a managed secret.
  • ry billing: What the current usage costs.
  • ry bucket: Manage object storage buckets (files for your apps).
  • ry computer: Links to watch or control a computer VM (images/computer), and who had control.
  • ry config: Manage the project file (rytiv.json).
  • ry console: Start a throwaway machine from this app’s last image and get a shell in it.
  • ry cron: Run something of an app on a schedule: call a path (the app is woken) or run a command on its own machine.
  • ry deploy: Deploy from a source directory (–source) or a prebuilt OCI image (–image); reads rytiv.json if present.
  • ry deploys: Deployment history of an app: which machines each deploy created and retired.
  • ry detect: What this project is and what it needs - reads the directory, changes nothing.
  • ry domains: Attach your own domains to an app.
  • ry exec: Run a command in a running machine and exit with its exit code (the command goes after –).
  • ry forward: Forward a local port to a port inside a machine, e.g. ry forward shop 8080:3000 (no public port needed).
  • ry git: Deploy on push: connect an app to a GitHub repository and see what pushes did.
  • ry job: Run one command in an app’s image on a throwaway machine, and get its result.
  • ry link: Let an app reach another app privately at <target>.internal (no public door needed).
  • ry links: Show the private app-to-app links in this workspace.
  • ry login: Sign in: shows a code to confirm in the console (–token stays for CI).
  • ry logs: Stream the console output of an app’s machines.
  • ry machine: Act on a single machine.
  • ry machines: List machines for an app.
  • ry mail: Transactional email: sending domains, log, inbox, suppressions.
  • ry maintenance: Switch an app’s maintenance mode: the edge answers every request with 503, the machines keep running.
  • ry new: Start a new project from a template - scaffolder plus the part that makes it deploy here.
  • ry postgres: Managed Postgres: create, branch, fork, sleep policy (stored; not in force on every host).
  • ry preview: One preview address per branch - opened by a push, closed by itself.
  • ry profile: Saved logins for lab, prod, …
  • ry protect: Give an app a protected view (password or share link).
  • ry proxy: Forward a local port to a machine, e.g. ry proxy my-db 15432:5432 then psql -h 127.0.0.1 -p 15432.
  • ry releases: The releases of an app: what went out, which one runs, and which ones a rollback can bring back.
  • ry resource: Manage attachable resources (redis, postgres).
  • ry rollback: Deploy an earlier release again, without a rebuild (default: the previous release that went live); secrets, settings, volumes and databases stay as they are.
  • ry sandbox: Short-lived machines for one task each - created from a template, removed at their deadline.
  • ry secrets: Manage app secrets.
  • ry ssh: An interactive shell in a running machine (over the Rytiv API, no SSH needed); real SSH for IDEs: ry ssh config.
  • ry ssh-keys: SSH public keys of this org (for ssh <app>@ssh.<domain>).
  • ry status: Overview of all apps and machine states.
  • ry tokens: API tokens for CI (org-scoped).
  • ry unlink: Remove a private link between two apps.
  • ry usage: Show metered usage with prices and total.
  • ry volume: Manage durable volumes (persistent block storage).
  • ry webhooks: Endpoints we call when a message is sent, bounces, is complained about, fails or arrives.
  • ry whoami: Show the identity behind the configured token: an org (product token) or the system (operator token).