Render CLI Reference

Look up supported commands and options.

Render CLIv2.36.0

This reference is automatically generated from the Render CLI source.

View documentation for any command in the CLI itself by running the following:

Global options

OptionDescription

--confirm

Skip all confirmation prompts

--output, -o

Set output format to interactive, json, yaml, or text. Auto-switches to text on non-TTY

Top-level commands

docs

Open the Render docs in your browser

Usage:

Examples:

Options:

Global options only

environments <projectID>

List environments for a specified project in the active workspace. In interactive mode you can view each environment's individual services.

Usage:

Examples:

Options:

Global options only

kv-cli [keyValueID|keyValueName]

Open a redis-cli or valkey-cli session for a Render Key Value instance. This command only supports interactive mode.

You can optionally pass the key value ID or name as an argument. To pass arguments to redis-cli or valkey-cli, use: render kv-cli [keyValueID|keyValueName] -- [redis-cli args]

Usage:

Examples:

Options:

Global options only

login

Log in to Render using the Render Dashboard

Usage:

Examples:

Options:

Global options only

logout

Log out of Render

Usage:

Options:

Global options only

logs

View logs for services and datastores.

Use flags to filter logs by resource, instance, time, text, level, type, host, status code, method, or path. Unlike in the Render Dashboard, you can view logs for multiple resources at once.

In interactive mode you can update the filters and view logs in real time, or set --tail=true to stream new logs.

Usage:

Examples:

Options:

Global options, plus:

OptionDescription

--direction

Set log query direction (backward or forward)

--end

Filter logs at or before the specified end time

--host

Filter logs by comma-separated host values

--instance

Filter logs by comma-separated instance IDs

--level

Filter logs by comma-separated log levels

--limit

Limit the number of logs returned

--method

Filter logs by comma-separated HTTP methods

--path

Filter logs by comma-separated request paths

--resources, -r

Filter logs by comma-separated resource IDs (Required in non-interactive mode)

--start

Filter logs at or after the specified start time

--status-code

Filter logs by comma-separated status codes

--tail

Stream new logs

--task-id

Filter logs by comma-separated task IDs

--task-run-id

Filter logs by comma-separated task run IDs

--text

Filter logs by comma-separated text values

--type

Filter logs by comma-separated log types

pgcli [postgresID|postgresName]

Open a pgcli session to a Render Postgres database instance. This command only supports interactive mode.

You can optionally pass a database ID or name as an argument. To pass arguments to pgcli, use: render pgcli [postgresID|postgresName] -- [pgcli args]

Usage:

Examples:

Options:

Global options only

projects

Browse projects in the active workspace. In interactive mode, select a project to view its environments.

Usage:

Examples:

Options:

Global options only

psql [postgresID|postgresName]

Open a psql session to a Render Postgres database.

Optionally pass the database ID or name as an argument. To pass arguments to psql, use: render psql [postgresID|postgresName] -- [psql args]

For non-interactive usage, use the --command flag: render psql [postgresID|postgresName] -c "SELECT * FROM users;" -o text

Additional psql flags can be passed after --: render psql [postgresID|postgresName] -c "SELECT 1;" -o json -- --csv -q

Usage:

Examples:

Options:

Global options, plus:

OptionDescription

--command, -c

Execute a SQL command in non-interactive mode

restart <resourceID>

Restart a service by resource ID

Usage:

Examples:

Options:

Global options only

ssh [serviceID|serviceName|instanceID]

SSH into a service instance.

Specify a service ID, service name, or instance ID. Put SSH arguments after --: render ssh [serviceID|serviceName|instanceID] -- [ssh args]

For non-interactive use, specify a service or instance and set --output text. With a service, SSH connects to any available instance. The command streams SSH output without formatting. The json and yaml output formats stream the same raw output as text.

SSH uses your local SSH keys. Add the public key to your Render account before you connect. See https://render.com/docs/ssh#ssh-setup.

Usage:

Examples:

Options:

Global options, plus:

OptionDescription

--ephemeral, -e

Connect to an ephemeral instance

--plan

Plan name to use for the ephemeral instance (e.g. 0.5c-512mb, 1c-2g, 2c-4g). Only valid with --ephemeral.

whoami

Display information about the current user

Usage:

Examples: