Back to Details

render-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Render CLI

Render CLI

The Render CLI manages services, databases, and deployments from the terminal. Supports interactive use, non-interactive scripting, and CI/CD automation.
Render CLI可通过终端管理服务、数据库和部署任务，支持交互式使用、非交互式脚本编写以及CI/CD自动化。

When to Use

使用场景

  • Deploying a service from the terminal or CI/CD
  • Tailing logs in real time
  • Opening psql to a Render Postgres database
  • SSHing into a running service or launching an ephemeral shell
  • Validating a 
    render.yaml
    Blueprint
  • Scripting Render operations in CI/CD pipelines
  • Installing agent skills for AI coding tools
  • 部署：从终端或CI/CD中部署服务
  • 实时查看日志：实时追踪日志
  • 连接psql：连接到Render Postgres数据库的psql会话
  • SSH连接：进入运行中的服务或启动临时shell
  • 验证Blueprint：验证
    render.yaml
    Blueprint文件
  • CI/CD脚本编写：在CI/CD流水线中编写Render操作脚本
  • 安装Agent技能：为AI编码工具安装agent技能

Installation

安装方式

MethodCommand
Homebrew
brew update && brew install render
Linux/macOS
curl -fsSL https://raw.githubusercontent.com/render-oss/cli/refs/heads/main/bin/install.sh | sh
Direct downloadGitHub releases
Build from source
git clone git@github.com:render-oss/cli.git && cd cli && go build -o render
After install, run 
render
with no arguments to confirm.
方法命令
Homebrew
brew update && brew install render
Linux/macOS
curl -fsSL https://raw.githubusercontent.com/render-oss/cli/refs/heads/main/bin/install.sh | sh
直接下载GitHub releases
从源码构建
git clone git@github.com:render-oss/cli.git && cd cli && go build -o render
安装完成后，运行无参数的
render
命令确认安装成功。

Authentication

身份验证

Interactive (local dev)

交互式（本地开发）

bash
render login
Opens the browser to generate a CLI token. Token is saved to 
~/.render/cli.yaml
. Tokens expire periodically—re-run 
render login
when prompted.
bash
render login
打开浏览器生成CLI令牌，令牌将保存到
~/.render/cli.yaml
。令牌会定期过期，提示时重新运行
render login
即可。

Non-interactive (CI/CD)

非交互式（CI/CD）

bash
export RENDER_API_KEY=rnd_...
API keys do not expire. Generate one from Account Settings > API Keys in the Dashboard. The API key takes precedence over CLI tokens when set.
Set the active workspace:
bash
render workspace set
bash
export RENDER_API_KEY=rnd_...
API密钥不会过期，可从控制台的账户设置 > API密钥生成。设置API密钥后，其优先级高于CLI令牌。
设置活跃工作区：
bash
render workspace set

Command Reference

命令参考

Core commands

核心命令

CommandPurposeKey flags
render login
Authenticate via browser—
render workspace set
Set active workspace—
render services
List all services and datastores
-o json
for scripting
render deploys create [SVC]
Trigger a deploy
--wait
, 
--commit SHA
, 
--image URL
render deploys list [SVC]
List deploys for a service
-o json
render logs -r [SVC]
View logs
--tail
for streaming
render psql [DB]
Open psql session
-c "SQL"
, 
-o json
, 
-- --csv
render ssh [SVC]
SSH into running instance
--ephemeral
/ 
-e
for isolated shell
render blueprints validate
Validate 
render.yaml
Defaults to 
./render.yaml
render skills [install|update|list]
Manage agent skills—
render workspaces
List workspaces
-o json
命令用途关键参数
render login
通过浏览器进行身份验证—
render workspace set
设置活跃工作区—
render services
列出所有服务和数据存储
-o json
用于脚本编写
render deploys create [SVC]
触发部署
--wait
, 
--commit SHA
, 
--image URL
render deploys list [SVC]
列出服务的所有部署记录
-o json
render logs -r [SVC]
查看日志
--tail
用于流式查看
render psql [DB]
打开psql会话
-c "SQL"
, 
-o json
, 
-- --csv
render ssh [SVC]
SSH进入运行中的实例
--ephemeral
/ 
-e
用于隔离shell
render blueprints validate
验证
render.yaml
默认验证
./render.yaml
render skills [install|update|list]
管理agent技能—
render workspaces
列出工作区
-o json

Non-interactive mode

非交互式模式

For CI/CD and scripts, always set:
FlagPurpose
-o json
(or 
yaml
, 
text
)		Machine-readable output
--confirm
Skip confirmation prompts
Output format precedence: 
--output
flag > 
RENDER_OUTPUT
env var > auto-detect (TTY → interactive, pipe → text).
bash
export RENDER_OUTPUT=json
render services --confirm
对于CI/CD和脚本，需始终设置：
参数用途
-o json
（或
yaml
, 
text
）		机器可读格式输出
--confirm
跳过确认提示
输出格式优先级：
--output
参数 > 
RENDER_OUTPUT
环境变量 > 自动检测（终端→交互式，管道→文本）。
bash
export RENDER_OUTPUT=json
render services --confirm

Deploy patterns

部署模式示例

bash
undefined
bash
undefined

Deploy and wait for completion (exits non-zero on failure)

部署并等待完成（失败时返回非零退出码）

render deploys create srv-xxx --wait --confirm -o json
render deploys create srv-xxx --wait --confirm -o json

Deploy a specific commit

部署特定提交版本

render deploys create srv-xxx --commit abc123 --wait --confirm
render deploys create srv-xxx --commit abc123 --wait --confirm

Deploy a specific Docker image

部署特定Docker镜像

render deploys create srv-xxx --image ghcr.io/org/app:v1.2.3 --wait --confirm
undefined
render deploys create srv-xxx --image ghcr.io/org/app:v1.2.3 --wait --confirm
undefined

Database queries

数据库查询示例

bash
undefined
bash
undefined

Single query, JSON output

单条查询，JSON格式输出

render psql db-xxx -c "SELECT NOW();" -o json
render psql db-xxx -c "SELECT NOW();" -o json

CSV output via psql passthrough

通过psql传递参数输出CSV格式

render psql db-xxx -c "SELECT id, email FROM users;" -o text -- --csv
undefined
render psql db-xxx -c "SELECT id, email FROM users;" -o text -- --csv
undefined

CI/CD Example (GitHub Actions)

CI/CD示例（GitHub Actions）

yaml
name: Deploy to Render
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install Render CLI
        run: |
          curl -L https://github.com/render-oss/cli/releases/download/v1.1.0/cli_1.1.0_linux_amd64.zip -o render.zip
          unzip render.zip
          sudo mv cli_v1.1.0 /usr/local/bin/render
      - name: Deploy
        env:
          RENDER_API_KEY: ${{ secrets.RENDER_API_KEY }}
        run: render deploys create ${{ secrets.RENDER_SERVICE_ID }} --wait --confirm -o json
Pin to a specific CLI version in CI to avoid breaking changes.
yaml
name: Deploy to Render
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install Render CLI
        run: |
          curl -L https://github.com/render-oss/cli/releases/download/v1.1.0/cli_1.1.0_linux_amd64.zip -o render.zip
          unzip render.zip
          sudo mv cli_v1.1.0 /usr/local/bin/render
      - name: Deploy
        env:
          RENDER_API_KEY: ${{ secrets.RENDER_API_KEY }}
        run: render deploys create ${{ secrets.RENDER_SERVICE_ID }} --wait --confirm -o json
在CI中固定CLI的特定版本，避免因版本更新导致的兼容性问题。

Local Config

本地配置

Config file: 
~/.render/cli.yaml
Override with 
RENDER_CLI_CONFIG_PATH
env var.
配置文件路径：
~/.render/cli.yaml
可通过
RENDER_CLI_CONFIG_PATH
环境变量覆盖默认路径。

Common Mistakes

常见错误

MistakeFix
Token expiredRe-run 
render login
Wrong workspaceRun 
render workspace set
to switch
Missing 
--confirm
in CI		Add 
--confirm
to skip interactive prompts
Using 
--output interactive
in CI		Use 
-o json
or 
-o text
in non-TTY environments
Deploying without 
--wait
in CI		Add 
--wait
so the job fails on deploy failure
错误解决方法
令牌过期重新运行
render login
工作区错误运行
render workspace set
切换工作区
CI中缺少
--confirm
参数		添加
--confirm
跳过交互式提示
在CI中使用
--output interactive
在非终端环境中使用
-o json
或
-o text
CI中部署未添加
--wait
添加
--wait
，使部署失败时任务也随之失败

References

参考文档

DocumentContents
references/command-cheatsheet.md
Full command list with flags, output examples, and scripting patterns
文档内容
references/command-cheatsheet.md
完整命令列表，包含参数、输出示例和脚本编写模式

Related Skills

相关技能

  • render-deploy — End-to-end deploy flows, MCP operations, Dashboard deeplinks
  • render-blueprints — 
    render.yaml
    authoring and validation
  • render-postgres — Database connections, 
    render psql
    usage
  • render-debug — Using 
    render logs
    and 
    render ssh
    for troubleshooting
  • render-deploy — 端到端部署流程、MCP操作、控制台深度链接
  • render-blueprints — 
    render.yaml
    编写与验证
  • render-postgres — 数据库连接、
    render psql
    使用方法
  • render-debug — 使用
    render logs
    和
    render ssh
    进行故障排查