Skip to main content

Bitrise RDE CLI

The Bitrise RDE CLI lets you manage Remote Dev Environments from your terminal: create and connect to sessions, transfer files, and start AI coding agents. The CLI is open source, and all RDE commands live under bitrise-cli rde.

If you just want to get started fast, follow the Quickstart. This page is the broader reference for what the CLI can do.

Installing the CLIClick to copy link

Install the latest version with the install script:

curl -fsSL https://app.bitrise.io/cli/install.sh | bash

This installs the bitrise-cli binary to ~/.local/bin. Make sure that directory is on your PATH. You can also download a build from the GitHub releases or install from source with go install github.com/bitrise-io/bitrise-cli@latest.

Signing inClick to copy link

Sign in to your Bitrise account. This opens your browser to authenticate:

bitrise-cli auth login

Check your status with bitrise-cli auth status, and sign out with bitrise-cli auth logout. For non-interactive use, such as CI, set the BITRISE_TOKEN environment variable to a personal access token, or pipe a token into bitrise-cli auth login --with-token.

If you belong to more than one workspace, set the one to use with the --workspace flag or the BITRISE_WORKSPACE_ID environment variable.

Managing sessionsClick to copy link

The bitrise-cli rde session commands cover the full session lifecycle:

CommandWhat it does
bitrise-cli rde session create NAMECreate a session from a --template, or directly with --image and --machine-type.
bitrise-cli rde session listList your sessions and their status.
bitrise-cli rde session view SESSION_IDShow a session's details, including connection credentials.
bitrise-cli rde session exec SESSION_ID -- COMMANDRun a command in the session over SSH.
bitrise-cli rde session open-vnc SESSION_IDOpen a VNC viewer to the session's desktop (macOS only).
bitrise-cli rde session upload SESSION_ID LOCAL_PATH REMOTE_FOLDERUpload a file or folder into the session.
bitrise-cli rde session download SESSION_ID REMOTE_PATH LOCAL_PATHDownload a file or folder from the session.
bitrise-cli rde session terminate SESSION_IDStop the machine but keep the session for later.
bitrise-cli rde session restore SESSION_IDRestart a terminated session from its persistent disk.
bitrise-cli rde session delete SESSION_IDPermanently delete a terminated session.

Running AI coding agentsClick to copy link

The bitrise-cli rde claude command creates a session, clones your current repository branch into it, and drops you into Claude Code running on the cloud machine. While the agent works, the CLI keeps a secure connection open so it can open a VNC viewer or transfer files to and from your local machine.

note

If you belong to more than one workspace, set the one to use with the --workspace flag or the BITRISE_WORKSPACE_ID environment variable.

This is the recommended way to start. For the full walkthrough, see the Quickstart. To return to a session later, use bitrise-cli rde claude --continue or bitrise-cli rde claude --resume.

tip

To avoid authenticating Claude Code every time, save your credential once in the Bitrise RDE UI. Sessions that include it will start with Claude Code already authenticated.

Templates, saved inputs, and machine optionsClick to copy link

The CLI also manages the configuration objects behind your sessions:

  • bitrise-cli rde template: list, create, view, update, and delete templates.
  • bitrise-cli rde saved-input: list, create, view, update, and delete saved inputs.
  • bitrise-cli rde image list: list the stacks available to you.
  • bitrise-cli rde machine-type list --image NAME: list the machine types that work with a given stack.

Full command referenceClick to copy link

For every command, flag, and argument, see the open-source repository and its generated reference: bitrise-io/bitrise-cli.