Abre em uma nova janelaAbre um site externoAbre um site externo em uma nova janela

Feche esta caixa de diálogo

Este site utiliza tecnologias como cookies para ativar funcionalidades essenciais do site, bem como para análise de dados, personalização e publicidade direcionada. Para saber mais, veja o seguinte link: Política de Privacidade

Fechar preferências de cookie

Render CLIv2.28.0

This reference is automatically generated from the Render CLI source.

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

shellCopy to clipboard

$ render help <command>

Global options

Top-level commands

docs

Open the Render docs in your browser

Usage:

bashCopy to clipboard

render docs

Examples:

bashCopy to clipboard

# Open Render documentation
render docs

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:

bashCopy to clipboard

render environments <projectID>

Examples:

bashCopy to clipboard

# List environments for a project
render environments prj-abc123

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:

bashCopy to clipboard

render kv-cli [keyValueID|keyValueName]

Examples:

bashCopy to clipboard

# Open an interactive kv-cli session
render kv-cli kv-abc123

# Pass through redis-cli arguments
render kv-cli kv-abc123 -- --scan

Options:

Global options only

login

Log in to Render using the Render Dashboard

Usage:

bashCopy to clipboard

render login

Examples:

bashCopy to clipboard

# Authenticate with Render
render login

Options:

Global options only

logout

Log out of Render

Usage:

bashCopy to clipboard

render logout

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:

bashCopy to clipboard

render logs

Examples:

bashCopy to clipboard

# Tail logs for a service
render logs --resources srv-abc123 --tail

# Query logs in a time range
render logs --resources srv-abc123 --start 2026-03-01T00:00:00Z --end 2026-03-01T01:00:00Z

# Output logs as JSON in non-interactive mode
render logs --resources srv-abc123 --output json

Options:

Global options, plus:

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:

bashCopy to clipboard

render pgcli [postgresID|postgresName]

Examples:

bashCopy to clipboard

# Open an interactive pgcli session
render pgcli pg-abc123

# Pass through pgcli arguments
render pgcli pg-abc123 -- --csv -q

Options:

Global options only

projects

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

Usage:

bashCopy to clipboard

render projects

Examples:

bashCopy to clipboard

# List projects in JSON
render projects --output json

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:

bashCopy to clipboard

render psql [postgresID|postgresName]

Examples:

bashCopy to clipboard

# Open an interactive psql session
render psql pg-abc123

# Execute a SQL command in non-interactive mode
render psql pg-abc123 --command "SELECT * FROM users;" --output text

# Pass through psql arguments
render psql pg-abc123 -- --csv -q

Options:

Global options, plus:

restart`` <resourceID>

Restart a service by resource ID

Usage:

bashCopy to clipboard

render restart <resourceID>

Examples:

bashCopy to clipboard

# Restart a service
render restart srv-abc123

# Restart a service without confirmation prompts
render restart srv-abc123 --confirm

Options:

Global options only

ssh`` [serviceID|serviceName|instanceID]

SSH into a service instance. This command only supports interactive mode.

You can specify the service ID, service name, or specific instance ID as an argument. To pass arguments to ssh, use: render ssh [serviceID|serviceName|instanceID] -- [ssh args]

Usage:

bashCopy to clipboard

render ssh [serviceID|serviceName|instanceID]

Examples:

bashCopy to clipboard

# Open an SSH session for a service
render ssh srv-abc123

# Connect to an ephemeral instance
render ssh srv-abc123 --ephemeral

# Connect to an ephemeral instance with a specific plan
render ssh srv-abc123 --ephemeral --plan 1c-2g

# Pass through ssh arguments
render ssh srv-abc123 -- -L 5432:localhost:5432

Options:

Global options, plus:

whoami

Display information about the current user

Usage:

bashCopy to clipboard

render whoami

Examples:

bashCopy to clipboard

# Show the currently authenticated user
render whoami

Options:

Global options only

workspaces

List workspaces available to your account

Usage:

bashCopy to clipboard

render workspaces

Examples:

bashCopy to clipboard

# List workspaces available to the current user
render workspaces

Options:

Global options only

Blueprints

blueprints validate`` [file]

Validate a Blueprint file for errors before committing.

Validates:

• YAML syntax
• Schema validation (Required fields, types)
• Semantic validation (valid plans, regions, etc.)
• Conflict checking against existing resources

Usage:

bashCopy to clipboard

render blueprints validate [file]

Examples:

bashCopy to clipboard

# Validate ./render.yaml
render blueprints validate

# Validate a specific Blueprint file
render blueprints validate ./my-blueprint.yaml

# Output validation results as JSON
render blueprints validate -o json

Options:

Global options, plus:

Deploys

deploys cancel`` <serviceID> <deployID>

Cancel a running deploy

Usage:

bashCopy to clipboard

render deploys cancel <serviceID> <deployID>

Examples:

bashCopy to clipboard

# Cancel a running deploy
render deploys cancel srv-abc123 dep-xyz789

Options:

Global options only

deploys create`` [serviceID]

Trigger a service deploy and stream logs in real time

Usage:

bashCopy to clipboard

render deploys create [serviceID]

Examples:

bashCopy to clipboard

# Trigger a deploy for a service
render deploys create srv-abc123

# Deploy a specific commit
render deploys create srv-abc123 --commit 0123abcd

# Wait until deploy completes
render deploys create srv-abc123 --wait

Options:

Global options, plus:

deploys list`` [serviceID]

List deploys for a service

Usage:

bashCopy to clipboard

render deploys list [serviceID]

Examples:

bashCopy to clipboard

# List deploys for a service
render deploys list srv-abc123

# Browse deploys interactively
render deploys list

Options:

Global options only

Jobs

jobs cancel`` <serviceID> <jobID>

Cancel a running job

Usage:

bashCopy to clipboard

render jobs cancel <serviceID> <jobID>

Examples:

bashCopy to clipboard

# Cancel a running job
render jobs cancel srv-abc123 job-xyz789

Options:

Global options only

jobs create`` [serviceID]

Create a new job for a service

Usage:

bashCopy to clipboard

render jobs create [serviceID]

Examples:

bashCopy to clipboard

# Create a job for a service
render jobs create srv-abc123 --start-command "bundle exec rake task"

# Create a job with a specific plan
# See https://render.com/docs/one-off-jobs for available job plans
render jobs create srv-abc123 --start-command "npm run worker" --plan-id plan-srv-006

Options:

Global options, plus:

jobs list`` [serviceID]

List jobs for a service

Usage:

bashCopy to clipboard

render jobs list [serviceID]

Examples:

bashCopy to clipboard

# List jobs for a service
render jobs list srv-abc123

# Browse jobs interactively
render jobs list

Options:

Global options only

Key Value

kv create

Create a new Render Key Value instance.

In interactive mode, a prompt guides you through each option one at a time. In non-interactive mode (--output text/json/yaml), flags use defaults if not supplied. Use --confirm to skip all prompts (including final confirmation) and create immediately. Output will be human-readable; use --output json/yaml/text for machine-readable output.

Usage:

bashCopy to clipboard

render kv create

Examples:

bashCopy to clipboard

# Interactive wizard (guided prompts for each option)
render kv create

# Specify all options; wizard still asks for confirmation before creating
render kv create --name my-cache --plan 256mb --region oregon

# Skip all prompts and create immediately (no confirmation)
render kv create --name my-cache --plan free --confirm

# Machine-readable output (non-interactive, no prompts)
render kv create --name my-cache --plan 256mb --output json

# Use as a cache with no on-disk persistence
render kv create --name my-cache --plan 256mb --persistence-mode off

# With IP allow-listing (repeat the flag for multiple entries)
render kv create --name my-cache \
--ip-allow-list "cidr=203.0.113.5/32,description=office" \
--ip-allow-list "cidr=10.0.0.0/8,description=internal"

Options:

Global options, plus:

kv delete`` <keyValueID|keyValueName>

Delete a Render Key Value instance.

Without --confirm, this command previews what would be deleted and makes no changes. Pass --confirm to actually delete the instance.

The positional argument accepts either a Key Value ID (red-...) or a name. If the name matches more than one instance, narrow the search with --environment <id|name>, or pass the Key Value ID directly.

Name lookup is scoped to your active workspace. If a name isn't found, switch workspaces with 'render workspace set <name|ID>' and try again, or pass the Key Value ID instead (which works across workspaces).

Usage:

bashCopy to clipboard

render kv delete <keyValueID|keyValueName>

Examples:

bashCopy to clipboard

# Preview deletion (no changes made)
render kv delete red-abc123def456ghi789jkl0

# Delete by ID
render kv delete red-abc123def456ghi789jkl0 --confirm

# Delete by name
render kv delete my-cache --confirm

# Disambiguate a name that exists in multiple environments
render kv delete my-cache --environment production --confirm

# JSON output
render kv delete red-abc123def456ghi789jkl0 --confirm --output json

Options:

Global options, plus:

kv get`` <keyValueID|keyValueName>

Get details and connection info for a Render Key Value instance.

The positional argument accepts either a Key Value ID (red-...) or a name. If the name matches more than one instance, narrow the search with --project <id|name>, --environment <id|name>, or pass the Key Value ID directly.

Usage:

bashCopy to clipboard

render kv get <keyValueID|keyValueName>

Examples:

bashCopy to clipboard

# Get by ID
render kv get red-abc123def456ghi789jkl0

# Get by name
render kv get my-cache

# Include connection strings (contains credentials)
render kv get my-cache --include-sensitive-connection-info

# Disambiguate by project
render kv get my-cache --project my-project

# Disambiguate a name that exists in multiple environments
render kv get my-cache --environment production

# JSON output
render kv get red-abc123def456ghi789jkl0 --output json

Options:

Global options, plus:

kv list

List Render Key Value instances in the active workspace.

Use --project to narrow results to a single project, --environment to narrow to a single environment, or both — when both are supplied, the environment is resolved within that project.

Usage:

bashCopy to clipboard

render kv list

Examples:

bashCopy to clipboard

# List all Key Value instances in the active workspace
render kv list

# List all Key Value instances in a project
render kv list --project my-project

# Filter by environment name
render kv list --environment production

# Disambiguate an environment name by project
render kv list --project my-project --environment production

# JSON output
render kv list --output json

Options:

Global options, plus:

kv resume`` <keyValueID|keyValueName>

Resume a suspended Render Key Value instance.

Usage:

bashCopy to clipboard

render kv resume <keyValueID|keyValueName>

Examples:

bashCopy to clipboard

# Resume by ID
render kv resume red-abc123def456ghi789jkl0

# Resume by name
render kv resume my-cache

# Disambiguate a name that exists in multiple environments
render kv resume my-cache --environment production

# JSON output
render kv resume red-abc123def456ghi789jkl0 --output json

Options:

Global options, plus:

kv suspend`` <keyValueID|keyValueName>

Suspend a Render Key Value instance.

Without --confirm, this command previews what would be suspended and makes no changes. Pass --confirm to actually suspend the instance.

Usage:

bashCopy to clipboard

render kv suspend <keyValueID|keyValueName>

Examples:

bashCopy to clipboard

# Preview suspension (no changes made)
render kv suspend red-abc123def456ghi789jkl0

# Suspend by ID
render kv suspend red-abc123def456ghi789jkl0 --confirm

# Suspend by name
render kv suspend my-cache --confirm

# Disambiguate a name that exists in multiple environments
render kv suspend my-cache --environment production --confirm

# JSON output
render kv suspend red-abc123def456ghi789jkl0 --confirm --output json

Options:

Global options, plus:

kv update`` <keyValueID|keyValueName>

Update an existing Render Key Value instance.

The positional argument is the target Key Value (ID red-... or name). At least one mutating flag must be supplied. Use --name to rename the instance; the positional argument always identifies the target and is never the new name.

Environment, project, workspace, and region are immutable. A Key Value instance cannot be moved between them; the --environment flag is for name disambiguation only.

Name lookup is scoped to your active workspace. If a name isn't found, switch workspaces with 'render workspace set <name|ID>' and try again, or pass the Key Value ID instead (which works across workspaces). If a name matches more than one instance, narrow the search with --environment <id|name>.

The --ip-allow-list flag replaces the server-side list; pass it once per entry. To remove all allow-list entries, pass --clear-ip-allow-list. The two flags are mutually exclusive.

Usage:

bashCopy to clipboard

render kv update <keyValueID|keyValueName>

Examples:

bashCopy to clipboard

# Rename
render kv update red-abc123def456ghi789jkl0 --name new-cache-name

# Change plan
render kv update my-cache --plan 1g

# Replace the IP allow-list (entire list, not append)
render kv update my-cache \
--ip-allow-list "cidr=203.0.113.5/32,description=office" \
--ip-allow-list "cidr=10.0.0.0/8,description=internal"

# Clear the IP allow-list
render kv update my-cache --clear-ip-allow-list

# Disambiguate a name that exists in multiple environments
render kv update my-cache --environment production --memory-policy queue

# Turn off on-disk persistence
render kv update my-cache --persistence-mode off

# JSON output
render kv update red-abc123def456ghi789jkl0 --plan 5g --output json

Options:

Global options, plus:

Postgres

pg create

Create a new Render Postgres database.

In interactive mode, a wizard guides you through the core choices for the database. The wizard owns those prompted values. Flag-only settings, such as --disk-size-gb, --database-name, --database-user, --ip-allow-list, and --read-replica, are still included in the create request.

Use --confirm to skip the wizard and create immediately from flags and defaults. When --confirm is used with the default interactive output mode, output is printed as text. Use --output json, yaml, or text for non-interactive output.

Usage:

bashCopy to clipboard

render pg create

Examples:

bashCopy to clipboard

# Launch the interactive wizard
render pg create

# Create immediately with defaults and text output
render pg create --confirm

# Create immediately with explicit values
render pg create --confirm --name analytics --plan 2c-8g --version 17 --region ohio

# Include flag-only settings while using the wizard for prompted values
render pg create \
--ip-allow-list "cidr=203.0.113.5/32,description=office" \
--ip-allow-list "cidr=10.0.0.0/8,description=internal"

# Machine-readable output
render pg create --output json

Options:

Global options, plus:

pg delete`` <postgresID|postgresName>

Delete a Render Postgres database.

Without --confirm, this command previews what would be deleted and makes no changes. Pass --confirm to actually delete the database.

The positional argument accepts either a Postgres ID (dpg-...) or a name. If the name matches more than one database, narrow the search with --project <id|name>, --environment <id|name>, or pass the Postgres ID directly.

Name lookup is scoped to your active workspace. If a name isn't found, switch workspaces with 'render workspace set <name|ID>' and try again, or pass the Postgres ID instead (which works across workspaces).

Usage:

bashCopy to clipboard

render pg delete <postgresID|postgresName>

Examples:

bashCopy to clipboard

# Preview deletion (no changes made)
render pg delete dpg-abc123def456ghi789jkl0

# Delete by ID
render pg delete dpg-abc123def456ghi789jkl0 --confirm

# Delete by name
render pg delete my-db --confirm

# Disambiguate a name that exists in multiple environments
render pg delete my-db --environment production --confirm

# Disambiguate a name that exists in multiple projects
render pg delete my-db --project analytics --confirm

# JSON output
render pg delete dpg-abc123def456ghi789jkl0 --confirm --output json

Options:

Global options, plus:

pg get`` <postgresID|postgresName>

Get details and connection info for a Render Postgres database.

Usage:

bashCopy to clipboard

render pg get <postgresID|postgresName>

Examples:

bashCopy to clipboard

# Get by ID
render pg get dpg-abc123def456ghi789jkl0

# Get by name
render pg get my-db

# Include connection strings (contains credentials)
render pg get my-db --include-sensitive-connection-info

# Disambiguate by project
render pg get my-db --project my-project

# Disambiguate a name that exists in multiple environments
render pg get my-db --environment production

# JSON output
render pg get dpg-abc123def456ghi789jkl0 --output json

Options:

Global options, plus:

pg list

List Render Postgres databases in the active workspace.

Usage:

bashCopy to clipboard

render pg list

Aliases:ls

Examples:

bashCopy to clipboard

# List all Postgres databases in the active workspace
render pg list

# List all Postgres databases in a project
render pg list --project my-project

# Filter by environment name
render pg list --environment production

# Disambiguate an environment name by project
render pg list --project my-project --environment production

# JSON output
render pg list --output json

Options:

Global options, plus:

pg resume`` <postgresID|postgresName>

Resume a suspended Render Postgres database.

Usage:

bashCopy to clipboard

render pg resume <postgresID|postgresName>

Examples:

bashCopy to clipboard

# Resume by ID
render pg resume dpg-abc123def456ghi789jkl0

# Resume by name
render pg resume my-db

# Disambiguate a name that exists in multiple environments
render pg resume my-db --environment production

# Disambiguate a name that exists in multiple projects
render pg resume my-db --project analytics

# JSON output
render pg resume dpg-abc123def456ghi789jkl0 --output json

Options:

Global options, plus:

pg suspend`` <postgresID|postgresName>

Suspend a Render Postgres database.

Without --confirm, this command previews what would be suspended and makes no changes. Pass --confirm to actually suspend the database.

Usage:

bashCopy to clipboard

render pg suspend <postgresID|postgresName>

Examples:

bashCopy to clipboard

# Preview suspension (no changes made)
render pg suspend dpg-abc123def456ghi789jkl0

# Suspend by ID
render pg suspend dpg-abc123def456ghi789jkl0 --confirm

# Suspend by name
render pg suspend my-db --confirm

# Disambiguate a name that exists in multiple environments
render pg suspend my-db --environment production --confirm

# Disambiguate a name that exists in multiple projects
render pg suspend my-db --project analytics --confirm

# JSON output
render pg suspend dpg-abc123def456ghi789jkl0 --confirm --output json

Options:

Global options, plus:

pg update`` <postgresID|postgresName>

Update an existing Render Postgres database.

The positional argument is the target database (ID dpg-... or name). At least one mutating flag must be supplied. Use --name to rename the database; the positional argument always identifies the target and is never the new name.

Environment, project, workspace, and region are immutable. A database cannot be moved between them; the --project and --environment flags are for name disambiguation only.

Only the fields you pass are changed; everything else is left untouched.

Name lookup is scoped to your active workspace. If a name isn't found, switch workspaces with 'render workspace set <name|ID>' and try again, or pass the Postgres ID instead (which works across workspaces). If a name matches more than one database, narrow the search with --project <id|name> or --environment <id|name>.

Usage:

bashCopy to clipboard

render pg update <postgresID|postgresName>

Examples:

bashCopy to clipboard

# Rename
render pg update dpg-abc123def456ghi789jkl0 --name application_db

# Change plan
render pg update my-db --plan 1c-4g

# Grow the disk and enable autoscaling
render pg update my-db --disk-size-gb 50 --disk-autoscaling

# Replace the IP allow-list (entire list, not append)
render pg update my-db \
--ip-allow-list "cidr=203.0.113.5/32,description=office" \
--ip-allow-list "cidr=10.0.0.0/8,description=internal"

# Clear the IP allow-list
render pg update my-db --clear-ip-allow-list

# Disambiguate a name that exists in multiple environments
render pg update my-db --environment production --plan 2c-8g

# JSON output
render pg update dpg-abc123def456ghi789jkl0 --plan 1c-4g --output json

Options:

Global options, plus:

Services

services

Lists all services and datastores for the active workspace. In interactive mode, you can view logs, restart services, trigger deploys, SSH into instances, and connect to Render Postgres databases and Render Key Value instances.

Usage:

bashCopy to clipboard

render services

Aliases:service

Available commands:

Examples:

bashCopy to clipboard

# List all services
render services

# Output as JSON
render services --output json

# Filter by environment
render services -e env-abc123

# Include preview environments
render services --include-previews

# Combine filters
render services -e env-abc123,env-def456 --include-previews --output json

Options:

Global options, plus:

services create

Create a new service on Render. This command only runs in non-interactive modes. Provide configuration options with flags.

Usage:

bashCopy to clipboard

render services create

Examples:

bashCopy to clipboard

# Create a service from repository configuration
render services create --name my-api --type web_service --repo https://github.com/org/repo --runtime node --build-command "npm install" --start-command "npm start" --output json

# Clone configuration from an existing service
render services create --from srv-abc123 --name my-api-clone --output json

Options:

Global options, plus:

services delete`` <serviceID|serviceName>

Delete a service on Render.

Without --confirm, this command previews what would be deleted and makes no changes. Pass --confirm to actually delete the service.

The positional argument accepts a service ID (including srv- or crn- IDs) or a name. Name lookup is scoped to your active workspace. If the name matches more than one service, pass the service ID directly.

This command only runs non-interactively. If --output interactive is requested, it falls back to text output.

Usage:

bashCopy to clipboard

render services delete <serviceID|serviceName>

Examples:

bashCopy to clipboard

# Preview deletion (no changes made)
render services delete srv-abc123def456ghi789jkl0

# Delete by ID
render services delete srv-abc123def456ghi789jkl0 --confirm

# Delete by name
render services delete my-api --confirm

# JSON output
render services delete srv-abc123def456ghi789jkl0 --confirm --output json

Options:

Global options only

services instances`` [serviceID]

List instances for a service

Usage:

bashCopy to clipboard

render services instances [serviceID]

Examples:

bashCopy to clipboard

# List instances for a service
render services instances srv-abc123

# Browse instances interactively
render services instances

Options:

Global options only

services update`` <service>

Update a service on Render. This command only runs in non-interactive modes.

Provide configuration updates with flags.

Usage:

bashCopy to clipboard

render services update <service>

Examples:

bashCopy to clipboard

# Rename a service
render services update my-service --name my-new-name --output json

# Change a service plan
render services update srv-abc123 --plan 2c-4g --output json

Options:

Global options, plus:

Skills

skills

Install and manage Render agent skills for AI coding tools such as Claude Code, Codex, OpenCode, and Cursor. Skills add deployment, debugging, and monitoring capabilities to your AI coding assistant.

Usage:

bashCopy to clipboard

render skills

Available commands:

Options:

Global options only

skills install

Install Render agent skills from https://github.com/render-oss/skills to detected AI coding tools.

Supported tools: Claude Code, Codex, OpenCode, Cursor.

Skills can be installed at two scopes:

• user: Install to ~/.{tool}/skills/ (default, current user only)
• project: Install to ./.{tool}/skills/ (committed to Git, all collaborators)

By default an interactive prompt lets you pick scope, tools, and skills. Use --scope, --tool, and --skill flags to skip the prompts (useful for CI).

Usage:

bashCopy to clipboard

render skills install

Examples:

bashCopy to clipboard

# Install skills interactively
render skills install

# Install for a specific tool and scope
render skills install --tool cursor --scope project

# Preview install changes
render skills install --dry-run

Options:

Global options, plus:

skills list

List installed Render skills and the AI tools they've been installed in. This reads from local state only, so the command doesn't require network access.

Use --scope to filter by installation scope (user or project).

Usage:

bashCopy to clipboard

render skills list

Examples:

bashCopy to clipboard

# List all installed skills
render skills list

# List project-scoped skills only
render skills list --scope project

Options:

Global options, plus:

skills remove

Remove previously installed Render skills from detected AI coding tools.

By default an interactive prompt lets you pick which skills to remove. Use --skill and --all flags to skip the prompts.

Use --scope to remove from a specific scope (user or project).

Usage:

bashCopy to clipboard

render skills remove

Examples:

bashCopy to clipboard

# Remove skills interactively
render skills remove

# Remove specific skills
render skills remove --skill render-deploy --skill render-debug

# Remove all project-scoped skills
render skills remove --all --scope project

Options:

Global options, plus:

skills update

Reinstall Render skills using the tool and skill selections saved by a previous "render skills install" run.

This fetches the latest version of each selected skill from the skills repository, compares with installed versions, and updates any that have changed.

Use --scope to update skills at a specific scope (user or project).

Usage:

bashCopy to clipboard

render skills update

Examples:

bashCopy to clipboard

# Update installed skills
render skills update

# Force reinstall all skills
render skills update --force

# Update project-scoped skills
render skills update --scope project

Options:

Global options, plus:

Workflows

workflows cancel`` <taskRunID>

Cancel an in-progress task run.

Use --local to cancel a task run in the local workflow development server.

Usage:

bashCopy to clipboard

render workflows cancel <taskRunID>

Examples:

bashCopy to clipboard

# Cancel a remote task run
render workflows cancel trn-abc123

# Cancel a task run in the local dev server
render workflows cancel --local trn-xyz789

Options:

Global options, plus:

workflows create

Create a new workflow service on Render.

In interactive mode, a form guides you through the required fields. In non-interactive mode, provide all required config with flags.

Environment variables (non-interactive only for now):

• Pass individual vars with --env-var``KEY=VALUE (repeatable).

• Load from one or more .env files with --env-file PATH (repeatable). Every

listed file must exist.

• Inline --env-var values override values from --env-file.

Usage:

bashCopy to clipboard

render workflows create

Examples:

bashCopy to clipboard

render workflows create
render workflows create --name my-workflow --repo https://github.com/org/repo --build-command "npm install" --runtime node --run-command "npm start" --region oregon -o json
render workflows create --repo . --name my-workflow --build-command "npm install" --runtime node --run-command "npm start"
render workflows create --repo . --name my-workflow --build-command "pip install -r requirements.txt" --runtime python --run-command ".venv/bin/python main.py" --env-file .env.production --env-var LOG_LEVEL=debug

Options:

Global options, plus:

workflows dev`` -- <command to start a workflow service>

Start a workflow service in development mode for local testing. Required input: --

This command runs your workflow service locally on port 8120, allowing you to list and run tasks without deploying to Render. Task runs and their logs are stored in memory, so you can query them after tasks complete.

The command will spawn a new subprocess with your specified command whenever it needs to run a task or list the defined tasks.

To interact with the local task server:

• Use the --local flag with other task commands (e.g., 'render workflows tasks list --local')

• Or set RENDER_USE_LOCAL_DEV=true when using the workflow client SDK

To use a different port:

• Specify --port when starting the dev server

• Then use --port with other task commands, or set RENDER_LOCAL_DEV_URL in the SDK

Environment variables:

• A .env file in the current directory is loaded automatically if present

• Use --env-file to load one or more specific files (later files override earlier ones)

• Loaded values override variables inherited from the parent shell

Usage:

bashCopy to clipboard

render workflows dev -- <command to start a workflow service>

Examples:

bashCopy to clipboard

# Start local workflow development server
render workflows dev -- "python main.py"

# Start local workflow development server on a custom port
render workflows dev --port 9000 -- "npm start"

# Load environment variables from custom files
render workflows dev --env-file .env --env-file .env.local -- "python main.py"

# List local tasks from another terminal
render workflows tasks list --local

Options:

Global options, plus:

workflows init

Scaffold a new Render Workflows project with example tasks.

Creates a working example project with task definitions, dependencies, and a README with instructions for local development and Client SDK integration.

In interactive mode you'll be prompted to select a language, template, output directory, and optional features. Use --confirm to skip all prompts and accept defaults, or pass individual flags to skip specific prompts.

With --confirm or non-interactive output (-o text/json/yaml), dependencies are installed and Git is initialized by default. Pass --install-deps=false or --git=false to opt out.

Usage:

bashCopy to clipboard

render workflows init

Examples:

bashCopy to clipboard

# Scaffold with default settings
render workflows init

# Skip prompts and use Python
render workflows init --confirm --language python

# Skip prompts and disable Git initialization
render workflows init --confirm --language python --git=false

# Customize output directory and enable optional features
render workflows init --language python --dir my-project --install-deps --git

# Use Node.js with a custom directory
render workflows init --language node --dir my-project

Options:

Global options, plus:

workflows list

List workflow services in your workspace

Usage:

bashCopy to clipboard

render workflows list

Examples:

bashCopy to clipboard

# List workflows in the active workspace
render workflows list

Options:

Global options only

workflows start`` [taskSlug]

Start a task with the provided input. In non-interactive mode, provide input with --input or --input-file.

You can specify the task by its workflow slug and task name (e.g., my-workflow/my-task), either as a positional argument or with --task.

Input Format: The input should be a JSON array where each element is an argument to the task. For example, if your task takes two arguments, provide: ["arg1", "arg2"]

You can provide input via:

• --input with inline JSON

• --input-file with a path to a JSON file

In interactive mode, you will be prompted to select the task and provide the input.

Usage:

bashCopy to clipboard

render workflows start [taskSlug]

Examples:

bashCopy to clipboard

# Start a task run by task slug
render workflows start my-workflow/my-task --input='["arg1"]'

# Start a task run with --task
render workflows start --task tsk-1234 --input='["arg1", "arg2"]'

# Start a task run with input from a file
render workflows start my-task --input-file=input.json

# Start against the local workflow development server
render workflows start my-task --local --input='["test"]'

Options:

Global options, plus:

workflows tasks

List tasks and manage their runs

Usage:

bashCopy to clipboard

render workflows tasks

Available commands:

Examples:

bashCopy to clipboard

# List tasks in a workflow version
render workflows tasks list wfv-1234

# Start a task run
render workflows tasks runs start --task my-task --input='["arg1"]'

# List task runs for a task
render workflows tasks runs list --task my-task

Options:

Global options, plus:

workflows tasks list`` [workflowVersionID]

List all tasks defined in a workflow version.

Tasks are user-defined functions registered with the Render Workflows SDK. Each time you release a workflow service, Render creates a new workflow version and registers all tasks it finds in that version.

In interactive mode, you will be prompted to select a workflow if not provided.

Local Development: When using the --local flag, you don't need to provide a workflow version ID. Instead, the command connects to your local dev server (default port 8120) to list tasks from your running workflow service. Start the dev server first with: render workflows dev -- ""

Usage:

bashCopy to clipboard

render workflows tasks list [workflowVersionID]

Examples:

bashCopy to clipboard

# List tasks for a workflow version
render workflows tasks list wfv-1234

# List tasks from local workflow development server
render workflows tasks list --local

Options:

Global options, plus:

workflows tasks runs

Manage runs of workflow tasks.

A task run represents a single execution of a task with specific input parameters. Use these commands to start new runs, view task run history, inspect details, and cancel in-progress runs.

Usage:

bashCopy to clipboard

render workflows tasks runs

Available commands:

Examples:

bashCopy to clipboard

# Start a task run
render workflows tasks runs start --task my-task --input='["arg1"]'

# List task runs for a task
render workflows tasks runs list --task my-task

# Show details for a task run
render workflows tasks runs show trn-1234

# Cancel a task run
render workflows tasks runs cancel trn-1234

Options:

Global options, plus:

workflows tasks runs cancel`` [taskRunID]

Cancel an in-progress task run.

Use --local to cancel a task run in the local workflow development server.

Usage:

bashCopy to clipboard

render workflows tasks runs cancel [taskRunID]

Examples:

bashCopy to clipboard

# Cancel a remote task run
render workflows tasks runs cancel trn-abc123

# Use the top-level shortcut
render workflows cancel trn-abc123

# Cancel a task run in the local dev server
render workflows tasks runs cancel --local trn-xyz789

Options:

Global options, plus:

workflows tasks runs list`` [taskID]

List all execution runs for a specific task.

A task run represents a single execution of a task with specific input parameters. This command shows the history of all runs for a given task.

You can specify the task by its workflow slug and task name (e.g., my-workflow/my-task), either as a positional argument or with --task.

In interactive mode, you will be prompted to select a task if not provided.

Usage:

bashCopy to clipboard

render workflows tasks runs list [taskID]

Examples:

bashCopy to clipboard

# List task runs by task ID
render workflows tasks runs list --task tsk-1234

# List task runs by task slug
render workflows tasks runs list --task my-workflow/my-task

# List task runs by passing the task as a positional argument
render workflows tasks runs list my-workflow/my-task

# List task runs from local workflow development server
render workflows tasks runs list --local --task my-task

Options:

Global options, plus:

workflows tasks runs show`` [taskRunID]

Display detailed information about a specific task run execution.

This command shows comprehensive information about a task run, including:

• Task run ID and status

• Input parameters provided

• Output or error result

• Start and completion timestamps

The task run ID is returned when you execute a task with: render workflows tasks runs start

In interactive mode, you will be prompted to select a task run if not provided.

Usage:

bashCopy to clipboard

render workflows tasks runs show [taskRunID]

Examples:

bashCopy to clipboard

# Show details for a task run
render workflows tasks runs show trn-1234

# Show details from local workflow development server
render workflows tasks runs show --local trn-5678

Options:

Global options, plus:

workflows tasks runs start`` [taskSlug]

Start a task with the provided input. In non-interactive mode, provide input with --input or --input-file.

You can specify the task by its workflow slug and task name (e.g., my-workflow/my-task), either as a positional argument or with --task.

You can provide input via:

• --input with inline JSON

• --input-file with a path to a JSON file

In interactive mode, you will be prompted to select the task and provide the input.

Usage:

bashCopy to clipboard

render workflows tasks runs start [taskSlug]

Examples:

bashCopy to clipboard

# Start a task run with inline JSON input
render workflows tasks runs start --task tsk-1234 --input='["arg1", "arg2"]'

# Start a task run by passing the task as a positional argument
render workflows tasks runs start my-workflow/my-task --input='["arg1"]'

# Start a task run with input from a file
render workflows tasks runs start --task my-task --input-file=input.json

# Start a task run against local workflow development server
render workflows tasks runs start --task my-task --local --input='["test"]'

Options:

Global options, plus:

workflows versions

List and release workflow versions

Usage:

bashCopy to clipboard

render workflows versions

Available commands:

Examples:

bashCopy to clipboard

# List versions for a workflow
render workflows versions list wf-abc123

# Release a new workflow version
render workflows versions release wf-abc123

Options:

Global options only

workflows versions list`` [workflowID]

List all versions of a workflow service.

Each time you release a workflow service, Render creates a new workflow version. A version represents a specific snapshot of your workflow service code and its registered tasks at the time of release.

This command displays all versions for a workflow, showing:

• Version ID

• Creation timestamp

• Associated tasks

In interactive mode, you will be prompted to select a workflow if not provided.

Usage:

bashCopy to clipboard

render workflows versions list [workflowID]

Examples:

bashCopy to clipboard

# List versions by workflow ID
render workflows versions list wf-1234

# List versions by workflow slug
render workflows versions list my-workflow-slug

Options:

Global options only

workflows versions release`` [workflowID]

Release a new version of a workflow service.

This command triggers a new release of your workflow service on Render. With a new release, Render:

1. Pulls the latest code from your repository (or a specific commit)

2. Builds your workflow service

3. Registers all tasks it finds in the service

4. Creates a new workflow version

You can optionally specify a commit ID to release a specific version of your code.

In interactive mode, you will be prompted to:

• Select a workflow if not provided

• Confirm the release

Usage:

bashCopy to clipboard

render workflows versions release [workflowID]

Examples:

bashCopy to clipboard

# Release a new version
render workflows versions release wf-1234

# Release from a specific commit
render workflows versions release wf-1234 --commit abc123

# Wait for release completion
render workflows versions release wf-1234 --wait

Options:

Global options, plus:

Workspace

workspace current

Show the currently selected workspace

Usage:

bashCopy to clipboard

render workspace current

Examples:

bashCopy to clipboard

# Show the active workspace
render workspace current

Options:

Global options only

workspace set`` [workspaceName|workspaceID]

Set the CLI's active workspace. All CLI commands run against the active workspace.

The active workspace is saved in cli.yaml in the Render CLI config directory. Set the RENDER_CLI_CONFIG_DIR environment variable to override this directory. If unspecified, the config file is saved in $HOME/.render/cli.yaml.

Usage:

bashCopy to clipboard

render workspace set [workspaceName|workspaceID]

Options:

Global options only

Copy page

Filter table of contents /

• Global options
• Top-level commands
  • docs
  • environments
  • kv-cli
  • login
  • logout
  • logs
  • pgcli
  • projects
  • psql
  • restart
  • ssh
  • whoami
  • workspaces
• Blueprints
  • blueprints validate
• Deploys
  • deploys cancel
  • deploys create
  • deploys list
• Jobs
  • jobs cancel
  • jobs create
  • jobs list
• Key Value
  • kv create
  • kv delete
  • kv get
  • kv list
  • kv resume
  • kv suspend
  • kv update
• Postgres
  • pg create
  • pg delete
  • pg get
  • pg list
  • pg resume
  • pg suspend
  • pg update
• Services
  • services
  • services create
  • services delete
  • services instances
  • services update
• Skills
  • skills
  • skills install
  • skills list
  • skills remove
  • skills update
• Workflows
  • workflows cancel
  • workflows create
  • workflows dev
  • workflows init
  • workflows list
  • workflows start
  • workflows tasks
  • workflows tasks list
  • workflows tasks runs
  • workflows tasks runs cancel
  • workflows tasks runs list
  • workflows tasks runs show
  • workflows tasks runs start
  • workflows versions
  • workflows versions list
  • workflows versions release
• Workspace
  • workspace current
  • workspace set

Did this page help?

AI assistant

Ready to help.

Usage policy

Example prompts

Add a custom domain

Describe service types

Restrict external access to database

Set Node.js version

Powered by Inkeep Logo

Render Discord