The Render CLI

Render CLIv2.12.0

Use the Render CLI to manage your Render services and datastores directly from your terminal:

Among many other capabilities, the CLI supports:

Triggering service deploys, restarts, and one-off jobs
Opening a psql session to your database
Viewing and filtering live service logs
Validating render.yaml files for Render Blueprints
Installing Render agent skills for AI coding tools

The CLI also supports non-interactive use in scripts and CI/CD.

Please submit bugs and feature requests on the CLI's public GitHub repository.

Use any of the following methods to install the Render CLI or upgrade to the latest version:

Run the following commands:

Run the following command:

Open the CLI's GitHub releases page.
Download the executable that corresponds to your system's architecture.

If you use an architecture besides those provided, you can build from source instead.

We recommend building from source only if no other installation method works for your system.

Install the Go programming language if you haven't already.
Clone and build the CLI project with the following commands:

After installation completes, open a new terminal tab and run render with no arguments to confirm.

The Render CLI uses a CLI token to authenticate with the Render platform. Generate a token with the following steps:

Run the following command:

Your browser opens a confirmation page in the Render Dashboard.
Click Generate token.

The CLI saves the generated token to its local configuration file.
When you see the success message in your browser, close the tab and return to your terminal.
The CLI prompts you to set your active workspace.

You can switch workspaces at any time with render workspace set.

You're ready to go!

Common commands

This is not an exhaustive list of commands.

Run render with no arguments for a list of all available commands.
Run render help <command> for details about a specific command.

By default, the Render CLI uses interactive, menu-based navigation. This default is great for manual use, but not for scripting or automation.

Configure the CLI for non-interactive use in CI/CD and other automated environments with the following steps:

The Render CLI can authenticate using an API key instead of render login. Unlike CLI tokens, API keys do not periodically expire. For security, use this authentication method only for automated environments.

Generate an API key with these steps.
In your automation's environment, set the RENDER_API_KEY environment variable to your API key:

If you provide an API key this way, it always takes precedence over CLI tokens you generate with render login.

2. Set non-interactive command options

Set the following options for all commands you run in non-interactive mode:

For example, to list the active workspace's services in JSON format:

You can also set the output format globally with the RENDER_OUTPUT environment variable:

This example action provides similar functionality to Render's automatic Git deploys. You could disable auto-deploys and customize this action to trigger deploys with different conditions.

To use this action, first set the following secrets in your repository:

By default, the Render CLI stores its local configuration at the following path:

You can change this file path by setting the RENDER_CLI_CONFIG_PATH environment variable.

For security, CLI tokens periodically expire. If you don't use the Render CLI for a while, you might need to re-authenticate with render login.

View a list of your active CLI tokens from your Account Settings page in the Render Dashboard. You can manually revoke a CLI token that you no longer need or that might be compromised. Expired and revoked tokens do not appear in the list.

View on GitHub