render
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseRender CLI Skill
Render CLI 技能
Manage Render cloud services and datastores directly from the terminal using the Render CLI.
使用Render CLI直接从终端管理Render云服务和数据存储。
When to Use
适用场景
- Deploying or restarting a Render service
- Listing services, deploys, or datastores
- Opening SSH or psql sessions to Render resources
- Viewing live service logs
- Validating blueprint files
render.yaml - Scripting Render operations in CI/CD
- 部署或重启Render服务
- 列出服务、部署或数据存储
- 开启SSH或psql会话连接至Render资源
- 查看服务实时日志
- 验证蓝图文件
render.yaml - 在CI/CD中编写Render操作脚本
Requirements
前提条件
- CLI installed (
renderor other methods)brew install render - Authenticated via or
render loginenv varRENDER_API_KEY
- 已安装CLI(可通过
render或其他方式安装)brew install render - 通过或
render login环境变量完成身份验证RENDER_API_KEY
Commands
命令
Authentication
身份验证
bash
undefinedbash
undefinedInteractive login (opens browser)
交互式登录(打开浏览器)
render login
render login
Or set API key for non-interactive use
或设置API密钥用于非交互场景
export RENDER_API_KEY=rnd_...
undefinedexport RENDER_API_KEY=rnd_...
undefinedWorkspaces
工作区
bash
undefinedbash
undefinedList workspaces
列出工作区
render workspaces
render workspaces
Set active workspace
设置活跃工作区
render workspace set
undefinedrender workspace set
undefinedServices
服务
bash
undefinedbash
undefinedList all services and datastores (interactive)
列出所有服务和数据存储(交互式)
render services
render services
List services as JSON (non-interactive)
以JSON格式列出服务(非交互式)
render services --output json --confirm
undefinedrender services --output json --confirm
undefinedDeploys
部署
bash
undefinedbash
undefinedList deploys for a service
列出某个服务的部署记录
render deploys list [SERVICE_ID]
render deploys list [SERVICE_ID]
Trigger a deploy
触发一次部署
render deploys create [SERVICE_ID]
render deploys create [SERVICE_ID]
Deploy a specific commit
部署指定提交版本
render deploys create [SERVICE_ID] --commit [SHA] --confirm
render deploys create [SERVICE_ID] --commit [SHA] --confirm
Deploy a specific Docker image
部署指定Docker镜像
render deploys create [SERVICE_ID] --image [URL] --confirm
render deploys create [SERVICE_ID] --image [URL] --confirm
Deploy and wait for completion (useful in CI)
部署并等待完成(适用于CI场景)
render deploys create [SERVICE_ID] --wait --confirm
undefinedrender deploys create [SERVICE_ID] --wait --confirm
undefinedSSH
SSH连接
bash
undefinedbash
undefinedSSH into a running service instance
SSH连接至运行中的服务实例
render ssh [SERVICE_ID]
render ssh [SERVICE_ID]
Launch an ephemeral shell (isolated, no start command)
启动临时shell(隔离环境,无启动命令)
render ssh [SERVICE_ID] --ephemeral
undefinedrender ssh [SERVICE_ID] --ephemeral
undefinedPostgres (psql)
Postgres(psql)
bash
undefinedbash
undefinedOpen interactive psql session
打开交互式psql会话
render psql [DATABASE_ID]
render psql [DATABASE_ID]
Run a single query
执行单个查询
render psql [DATABASE_ID] -c "SELECT NOW();" -o text
render psql [DATABASE_ID] -c "SELECT NOW();" -o text
Query results as JSON
以JSON格式返回查询结果
render psql [DATABASE_ID] -c "SELECT id, name FROM projects LIMIT 5;" -o json
render psql [DATABASE_ID] -c "SELECT id, name FROM projects LIMIT 5;" -o json
CSV output via psql passthrough
通过psql透传输出CSV格式结果
render psql [DATABASE_ID] -c "SELECT id, email FROM users;" -o text -- --csv
undefinedrender psql [DATABASE_ID] -c "SELECT id, email FROM users;" -o text -- --csv
undefinedBlueprints
蓝图
bash
undefinedbash
undefinedValidate render.yaml (defaults to ./render.yaml)
验证render.yaml(默认路径为./render.yaml)
render blueprints validate
render blueprints validate
Validate a specific file
验证指定文件
render blueprints validate path/to/render.yaml
undefinedrender blueprints validate path/to/render.yaml
undefinedNon-Interactive Mode
非交互模式
For scripting and CI/CD, use these flags:
| Flag | Description |
|---|---|
| Output format: |
| Skip confirmation prompts |
You can also set output format globally:
bash
export RENDER_OUTPUT=json对于脚本编写和CI/CD场景,可使用以下参数:
| 参数 | 说明 |
|---|---|
| 输出格式: |
| 跳过确认提示 |
你也可以全局设置输出格式:
bash
export RENDER_OUTPUT=jsonTips
小贴士
- Run with no arguments to see all available commands
render - Run for details on any command
render help <command> - Service IDs are optional in interactive mode — the CLI will prompt you to select
- Use on
--waitin CI to block until the deploy finishes (non-zero exit on failure)deploys create - CLI tokens expire periodically — re-authenticate with if needed
render login - Config is stored at (override with
~/.render/cli.yaml)RENDER_CLI_CONFIG_PATH
- 直接运行命令可查看所有可用指令
render - 运行查看任意命令的详细说明
render help <command> - 在交互模式下,服务ID为可选参数——CLI会提示你进行选择
- 在CI场景中,对使用
deploys create参数可阻塞至部署完成(部署失败时返回非零退出码)--wait - CLI令牌会定期过期——若需要,使用重新验证
render login - 配置文件存储在(可通过
~/.render/cli.yaml覆盖默认路径)RENDER_CLI_CONFIG_PATH