pp-render
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinese<!-- GENERATED FILE — DO NOT EDIT.
This file is a verbatim mirror of library/cloud/render/SKILL.md,
regenerated post-merge by tools/generate-skills/. Hand-edits here are
silently overwritten on the next regen. Edit the library/ source instead.
See AGENTS.md "Generated artifacts: registry.json, cli-skills/". -->
<!-- 生成文件 — 请勿编辑。
本文件是library/cloud/render/SKILL.md的完全镜像,
在合并后由tools/generate-skills/工具重新生成。此处手动编辑的内容会在下次重新生成时被静默覆盖。请改为编辑library/下的源文件。
详见AGENTS.md中的“生成产物:registry.json, cli-skills/”。 -->
Render — Printing Press CLI
Render — Printing Press CLI
Prerequisites: Install the CLI
前提条件:安装CLI
This skill drives the binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
render-pp-cli- Install via the Printing Press installer:
bash
npx -y @mvanhorn/printing-press install render --cli-only - Verify:
render-pp-cli --version - Ensure (or
$GOPATH/bin) is on$HOME/go/bin.$PATH
If the install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.3 or newer):
npxbash
go install github.com/mvanhorn/printing-press-library/library/cloud/render/cmd/render-pp-cli@latestIf reports "command not found" after install, the install step did not put the binary on . Do not proceed with skill commands until verification succeeds.
--version$PATH本Skill驱动二进制文件。**在调用本Skill的任何命令之前,您必须确认CLI已安装。**如果未安装,请先执行以下步骤安装:
render-pp-cli- 通过Printing Press安装器安装:
bash
npx -y @mvanhorn/printing-press install render --cli-only - 验证:
render-pp-cli --version - 确保(或
$GOPATH/bin)已添加到$HOME/go/bin环境变量中。$PATH
如果安装失败(如无Node环境、离线等),可以改用Go直接安装(要求Go 1.26.3或更高版本):
npxbash
go install github.com/mvanhorn/printing-press-library/library/cloud/render/cmd/render-pp-cli@latest如果安装后执行返回“command not found”,说明安装步骤未将二进制文件添加到中。请在验证成功前不要执行本Skill的命令。
--version$PATHWhen to Use This CLI
何时使用本CLI
Use render-pp-cli when you need to reason about your Render footprint as a whole, not one resource at a time. It shines for env-var promotion across environments, blueprint drift checks in CI, monthly cost rollups, preview cleanup, and audit-log forensics. For one-off interactive workflows like or , the official CLI is fine — render-pp-cli covers those too but its real value is the analytical commands the dashboard hides.
render psqlrender ssh当您需要整体管理Render资源,而非逐个处理单个资源时,可以使用render-pp-cli。它在跨环境同步环境变量、CI中的蓝图漂移检查、月度成本汇总、预览环境清理以及审计日志取证等场景下表现出色。对于或这类一次性交互式工作流,官方CLI已足够——render-pp-cli也支持这些操作,但它真正的价值在于提供了仪表盘所隐藏的分析类命令。
render psqlrender sshUnique Capabilities
独特功能
These capabilities aren't available in any other tool for this API.
这些功能是其他基于该API的工具所不具备的。
Local state that compounds
可累积的本地状态
-
— Compare env vars between any two services, env-groups, or a service vs an env-group, three-way diff style.
env diffReach for this when promoting config across environments — it's the cheapest way to see what's actually different without click-through.bashrender-pp-cli env diff srv-staging-api srv-prod-api --json -
— Copy env vars from a source service or env-group to a target with --only/--exclude/--dry-run.
env promoteUse when shipping a known-good staging config to prod without dragging dev-only keys along.bashrender-pp-cli env promote --from srv-staging-api --to srv-prod-api --exclude DEBUG_TOKEN --dry-run -
— Compare a checked-in render.yaml against live workspace state and report added/removed/modified entities by name.
driftRun this in CI to fail builds when someone edits prod through the dashboard instead of the blueprint.bashrender-pp-cli drift --blueprint render.yaml --json -
— Sum monthly cost across services, postgres, key-value, redis, and disks; group by project, environment, or owner.
costReach for this on the Friday cost-review or when finance asks 'what would happen if we downsized these three services?'bashrender-pp-cli cost --group-by project --json -
— For each service, fetch last --since 7d of CPU and memory; compute p95 utilization; flag services breaching --high or --low thresholds against plan capacity.
rightsizeRun this before the cost rollup to find quick downsizing wins or services about to throttle.bashrender-pp-cli rightsize --since 7d --high 80 --low 20 --json
-
— 以三方对比的方式,比较任意两个服务、env-group,或服务与env-group之间的环境变量差异。
env diff当您需要跨环境同步配置时可以使用此命令——这是无需点击操作即可查看实际差异的最简方式。bashrender-pp-cli env diff srv-staging-api srv-prod-api --json -
— 从源服务或env-group复制环境变量到目标服务或env-group,支持
env promote/--only/--exclude参数。--dry-run当您需要将经过验证的 staging 配置同步到生产环境,同时排除仅用于开发的密钥时使用此命令。bashrender-pp-cli env promote --from srv-staging-api --to srv-prod-api --exclude DEBUG_TOKEN --dry-run -
— 将已提交的render.yaml与实时工作区状态进行对比,按名称报告新增、移除或修改的实体。
drift在CI中运行此命令,当有人通过仪表盘而非蓝图修改生产环境时,可使构建失败。bashrender-pp-cli drift --blueprint render.yaml --json -
— 汇总服务、Postgres、键值存储、Redis和磁盘的月度成本;支持按项目、环境或所有者分组。
cost在周五成本审查或财务询问“如果我们缩减这三个服务的规模会怎样?”时使用此命令。bashrender-pp-cli cost --group-by project --json -
— 针对每个服务,获取过去
rightsize的CPU和内存数据;计算p95利用率;标记超出--since 7d或低于--high阈值的服务。--low在成本汇总前运行此命令,可快速找到缩减规模的空间或即将出现性能瓶颈的服务。bashrender-pp-cli rightsize --since 7d --high 80 --low 20 --json
Lifecycle hygiene
生命周期管理
-
— List preview services older than --stale-days N; delete in bulk on --confirm.
preview-cleanupUse when the monthly bill spikes and you suspect orphaned preview envs.bashrender-pp-cli preview-cleanup --stale-days 14 --confirm -
— Find unattached disks, empty env-groups, custom-domains pointing at deleted services, registry credentials referenced by no service, and disk snapshots beyond retention.
orphansAudit cleanup, billing review, and SOC 2 evidence-gathering all start here.bashrender-pp-cli orphans --json
-
— 列出超过
preview-cleanup天的预览服务;使用--stale-days N参数可批量删除。--confirm当月度账单激增且您怀疑存在孤立预览环境时使用此命令。bashrender-pp-cli preview-cleanup --stale-days 14 --confirm -
— 查找未挂载的磁盘、空的env-group、指向已删除服务的自定义域名、无服务引用的注册表凭据,以及超出保留期限的磁盘快照。
orphans审计清理、账单审查和SOC 2证据收集都可以从这个命令开始。bashrender-pp-cli orphans --json
Agent-native plumbing
Agent原生功能
-
— For a given env-var key, list every service and env-group that defines it with hash, length, and last-modified timestamp (never raw value).
env whereFirst call during a credential rotation or a 'who uses this secret' audit.bashrender-pp-cli env where STRIPE_KEY --json -
— Merge deploys, events, and audit-logs for one service into one chronological table for a given window.
incident-timelineFirst command on-call should run during a 2am page after a deploy.bashrender-pp-cli incident-timeline srv-checkout-api --since 2h --json -
— FTS5 search across cached audit logs by actor, target, action, and time window.
audit searchUse during SOC 2 evidence-gathering or to answer 'who rotated this key last quarter'.bashrender-pp-cli audit search --actor riley@example.com --target STRIPE_KEY --since 30d --json -
— Show commit range, env-var changes, image-tag changes, and plan/region/scale changes between two deploys of one service.
deploys diffFirst command in a post-deploy regression triage — answers 'what actually changed'.bashrender-pp-cli deploys diff srv-checkout-api dep-aaa dep-bbb --json
-
— 针对指定的环境变量键,列出所有定义了该变量的服务和env-group,包含哈希值、长度和最后修改时间戳(绝不会返回原始值)。
env where在凭据轮换或“谁在使用这个密钥”审计时,首先调用此命令。bashrender-pp-cli env where STRIPE_KEY --json -
— 将指定服务的部署记录、事件和审计日志合并为一个按时间排序的表格,时间范围可自定义。
incident-timeline在凌晨2点收到部署后的告警时,值班人员应首先运行此命令。bashrender-pp-cli incident-timeline srv-checkout-api --since 2h --json -
— 通过FTS5搜索缓存的审计日志,支持按执行者、目标、操作和时间范围筛选。
audit search在SOC 2证据收集或回答“上季度谁轮换了这个密钥”时使用此命令。bashrender-pp-cli audit search --actor riley@example.com --target STRIPE_KEY --since 30d --json -
— 显示同一服务两次部署之间的提交范围、环境变量变化、镜像标签变化以及计划/区域/规模变化。
deploys diff在部署后回归问题排查时,首先运行此命令——它能回答“实际发生了哪些变化”。bashrender-pp-cli deploys diff srv-checkout-api dep-aaa dep-bbb --json
Command Reference
命令参考
blueprints — Blueprints allow you to define your resources in a file and automatically sync changes to your Render services.
The API gives control over how your Blueprints are used to create and manage resources.
render.yaml- — Disconnect the Blueprint with the provided ID. Disconnecting a Blueprint stops automatic resource syncing via the...
render-pp-cli blueprints disconnect - — List Blueprints for the specified workspaces. If no workspaces are provided, returns all Blueprints the API key has...
render-pp-cli blueprints list - — Retrieve the Blueprint with the provided ID.
render-pp-cli blueprints retrieve - — Update the Blueprint with the provided ID.
render-pp-cli blueprints update - — Validate a
render-pp-cli blueprints validateBlueprint file without creating or modifying any resources. This endpoint checks the syntax...render.yaml
cron-jobs — Manage cron jobs
disks — Disks allow you to attach persistent storage to your services.
- — Attach a persistent disk to a web service, private service, or background worker. The service must be redeployed for...
render-pp-cli disks add - — Delete a persistent disk attached to a service. All data on the disk will be lost. The disk's associated service...
render-pp-cli disks delete - — List persistent disks matching the provided filters. If no filters are provided, returns all disks you have...
render-pp-cli disks list - — Retrieve the persistent disk with the provided ID.
render-pp-cli disks retrieve - — Update the persistent disk with the provided ID. The disk's associated service must be deployed and active for...
render-pp-cli disks update
env-groups — Manage env groups
- — Create a new environment group.
render-pp-cli env-groups create - — Delete the environment group with the provided ID, including all environment variables and secret files it contains.
render-pp-cli env-groups delete - — List environment groups matching the provided filters. If no filters are provided, all environment groups are returned.
render-pp-cli env-groups list - — Retrieve an environment group by ID.
render-pp-cli env-groups retrieve - — Update the attributes of an environment group.
render-pp-cli env-groups update
environments — Manage environments
- — Create a new environment belonging to the project with the provided ID.
render-pp-cli environments create - — Delete the environment with the provided ID. Requires the environment to be empty (i.e., it must contain no services...
render-pp-cli environments delete - — List a particular project's environments matching the provided filters. If no filters are provided, all environments...
render-pp-cli environments list - — Retrieve the environment with the provided ID.
render-pp-cli environments retrieve - — Update the details of the environment with the provided ID.
render-pp-cli environments update
events — View events for a service, postgres or key value
- — Retrieve the details of a particular event
render-pp-cli events <eventId>
key-value — Key Value allows you to interact with your Render Key Value instances.
- — Create a new Key Value instance.
render-pp-cli key-value create - — Delete a Key Value instance by ID.
render-pp-cli key-value delete - — List Key Value instances matching the provided filters. If no filters are provided, all Key Value instances are...
render-pp-cli key-value list - — Retrieve a Key Value instance by ID.
render-pp-cli key-value retrieve - — Update a Key Value instance by ID.
render-pp-cli key-value update
logs — Logs allow you to retrieve logs for your services, Postgres databases, and redis instances.
You can query for logs or subscribe to logs in real-time via a websocket.
- — Removes the log stream for the specified workspace.
render-pp-cli logs delete-owner-stream - — Removes the log stream override for the specified resource. After deletion, the resource will use the workspace's...
render-pp-cli logs delete-resource-stream - — Returns log stream information for the specified workspace.
render-pp-cli logs get-owner-stream - — Returns log stream override information for the specified resource. A log stream override takes precedence over a...
render-pp-cli logs get-resource-stream - — List logs matching the provided filters. Logs are paginated by start and end timestamps. There are more logs to...
render-pp-cli logs list - — Lists log stream overrides for the provided workspace that match the provided filters. These overrides take...
render-pp-cli logs list-resource-streams - — List all values for a given log label in the logs matching the provided filters.
render-pp-cli logs list-values - — Open a websocket connection to subscribe to logs matching the provided filters. Logs are streamed in real-time as...
render-pp-cli logs subscribe - — Updates log stream information for the specified workspace. All logs for resources owned by this workspace will be...
render-pp-cli logs update-owner-stream - — Updates log stream override information for the specified resource. A log stream override takes precedence over a...
render-pp-cli logs update-resource-stream
maintenance — The endpoints allow you to retrieve the latest maintenance runs for your Render services. You can also reschedule maintenance or trigger it to start immediately.
Maintenance- — List scheduled and/or recent maintenance runs for specified resources.
render-pp-cli maintenance list - — Retrieve the maintenance run with the provided ID.
render-pp-cli maintenance retrieve - — Update the maintenance run with the provided ID. Updates from this endpoint are asynchronous. To check your update's...
render-pp-cli maintenance update
metrics — The endpoints allow you to retrieve metrics for your services, Postgres databases, and redis instances.
Metrics- — Get the number of active connections for one or more Postgres databases or Redis instances.
render-pp-cli metrics get-active-connections - — Get bandwidth usage for one or more resources.
render-pp-cli metrics get-bandwidth - — Get bandwidth usage for one or more resources broken down by traffic source (HTTP, WebSocket, NAT, PrivateLink)....
render-pp-cli metrics get-bandwidth-sources - — Get CPU usage for one or more resources.
render-pp-cli metrics get-cpu - — Get the CPU limit for one or more resources.
render-pp-cli metrics get-cpu-limit - — Get CPU target for one or more resources.
render-pp-cli metrics get-cpu-target - — Get persistent disk capacity for one or more resources.
render-pp-cli metrics get-disk-capacity - — Get persistent disk usage for one or more resources.
render-pp-cli metrics get-disk-usage - — Get HTTP latency metrics for one or more resources.
render-pp-cli metrics get-http-latency - — Get the HTTP request count for one or more resources.
render-pp-cli metrics get-http-requests - — Get the instance count for one or more resources.
render-pp-cli metrics get-instance-count - — Get memory usage for one or more resources.
render-pp-cli metrics get-memory - — Get the memory limit for one or more resources.
render-pp-cli metrics get-memory-limit - — Get memory target for one or more resources.
render-pp-cli metrics get-memory-target - — Get seconds of replica lag of a Postgres replica.
render-pp-cli metrics get-replication-lag - — Get the total number of task runs completed for one or more tasks. Optionally filter by state (succeeded/failed) or...
render-pp-cli metrics get-task-runs-completed - — Get the total number of task runs queued for one or more tasks.
render-pp-cli metrics get-task-runs-queued - — List instance values to filter by for one or more resources.
render-pp-cli metrics list-application-filter-values - — List status codes and host values to filter by for one or more resources.
render-pp-cli metrics list-http-filter-values - — The path suggestions are based on the most recent 5000 log lines as filtered by the provided filters
render-pp-cli metrics list-path-filter-values
metrics-stream — Manage metrics stream
- — Deletes the metrics stream for the specified workspace.
render-pp-cli metrics-stream delete-owner - — Returns metrics stream information for the specified workspace.
render-pp-cli metrics-stream get-owner - — Creates or updates the metrics stream for the specified workspace.
render-pp-cli metrics-stream upsert-owner
notification-settings — Notification Settings allow you to configure which notifications you want to recieve, and
where you will receive them.
- — List notification overrides matching the provided filters. If no filters are provided, returns all notification...
render-pp-cli notification-settings list-notification-overrides - — Update notification settings for the owner with the provided ID.
render-pp-cli notification-settings patch-owner - — Update the notification override for the service with the provided ID.
render-pp-cli notification-settings patch-service-notification-overrides - — Retrieve notification settings for the owner with the provided ID. Note that you provide an owner ID to this...
render-pp-cli notification-settings retrieve-owner - — Retrieve the notification override for the service with the provided ID. Note that you provide a service ID to this...
render-pp-cli notification-settings retrieve-service-notification-overrides
organizations — Manage organizations
owners — Manage owners
- — List the workspaces that your API key has access to, optionally filtered by name or owner email address.
render-pp-cli owners list - — Retrieve the workspace with the provided ID. Workspace IDs start with
render-pp-cli owners retrieve. If you provide a user ID (starts with...tea-
postgres — Postgres endpoints enable you to interact with your Render Postgres databases.
You can manage databases, exports, recoveries, and failovers.
- — Create a new Postgres instance.
render-pp-cli postgres create - — Delete a Postgres instance by ID. This operation is irreversible, and all data will be lost.
render-pp-cli postgres delete - — List Postgres instances matching the provided filters. If no filters are provided, all Postgres instances are returned.
render-pp-cli postgres list - — Retrieve a Postgres instance by ID.
render-pp-cli postgres retrieve - — Update a Postgres instance by ID.
render-pp-cli postgres update
projects — Manage projects
- — Create a new project.
render-pp-cli projects create - — Delete the project with the provided ID. Requires all of the project's environments to be empty (i.e., they must...
render-pp-cli projects delete - — List projects matching the provided filters. If no filters are provided, all projects are returned.
render-pp-cli projects list - — Retrieve the project with the provided ID.
render-pp-cli projects retrieve - — Update the details of a project. To update the details of a particular environment in the project, instead use the...
render-pp-cli projects update
redis — Manage redis
- — Create a new Redis instance. This API is deprecated in favor of the Key Value API.
render-pp-cli redis create - — Delete a Redis instance by ID. This API is deprecated in favor of the Key Value API.
render-pp-cli redis delete - — List Redis instances matching the provided filters. If no filters are provided, all Redis instances are returned....
render-pp-cli redis list - — Retrieve a Redis instance by ID. This API is deprecated in favor of the Key Value API.
render-pp-cli redis retrieve - — Update a Redis instance by ID. This API is deprecated in favor of the Key Value API.
render-pp-cli redis update
registrycredentials — Manage registrycredentials
- — Create a new registry credential.
render-pp-cli registrycredentials create-registry-credential - — Delete the registry credential with the provided ID.
render-pp-cli registrycredentials delete-registry-credential - — List registry credentials matching the provided filters. If no filters are provided, returns all registry...
render-pp-cli registrycredentials list-registry-credentials - — Retrieve the registry credential with the provided ID.
render-pp-cli registrycredentials retrieve-registry-credential - — Update the registry credential with the provided ID. Services that use this credential must be redeployed to use...
render-pp-cli registrycredentials update-registry-credential
services — Services allow you to manage your web services, private services, background workers, cron jobs, and static sites.
- — Creates a new Render service in the specified workspace with the specified configuration.
render-pp-cli services create - — Delete the service with the provided ID.
render-pp-cli services delete - — List services matching the provided filters. If no filters are provided, returns all services you have permissions...
render-pp-cli services list - — Retrieve the service with the provided ID.
render-pp-cli services retrieve - — Update the service with the provided ID.
render-pp-cli services update
task-runs — Manage task runs
- — Cancel a running task run with the provided ID.
render-pp-cli task-runs cancel - — Kicks off a run of the workflow task with the provided ID, passing the provided input data.
render-pp-cli task-runs create-task - — Retrieve the workflow task run with the provided ID.
render-pp-cli task-runs get - — List task runs that match the provided filters. If no filters are provided, all task runs accessible by the...
render-pp-cli task-runs list - — Establishes a unidirectional event stream. The server sends events as lines formatted per the SSE spec. Clients...
render-pp-cli task-runs stream-events
tasks — Manage tasks
- — Retrieve the workflow task with the provided ID.
render-pp-cli tasks get - — List workflow tasks that match the provided filters. If no filters are provided, all task definitions accessible by...
render-pp-cli tasks list
users — The endpoints allow you to retrieve information about the authenticated user
User- — Retrieve the user associated with the provided API key.
render-pp-cli users
webhooks — Webhooks allows you to manage your Render webhook configuration.
- — Create a new webhook.
render-pp-cli webhooks create - — Delete the webhook with the provided ID.
render-pp-cli webhooks delete - — List webhooks
render-pp-cli webhooks list - — Retrieve the webhook with the provided ID
render-pp-cli webhooks retrieve - — Update the webhook with the provided ID.
render-pp-cli webhooks update
workflows — Manage workflows
- — Create a new workflow service with the specified configuration.
render-pp-cli workflows create - — Delete the workflow service with the provided ID.
render-pp-cli workflows delete - — Retrieve the workflow service with the provided ID.
render-pp-cli workflows get - — List workflows that match the provided filters. If no filters are provided, all workflows accessible by the...
render-pp-cli workflows list - — Update the workflow service with the provided ID.
render-pp-cli workflows update
workflowversions — Manage workflowversions
- — Creates and deploys a new version of a workflow.
render-pp-cli workflowversions create-workflow-version - — Retrieve the specific workflow service version with the provided ID.
render-pp-cli workflowversions get-workflow-version - — List known versions of the workflow service with the provided ID.
render-pp-cli workflowversions list-workflow-versions
blueprints — Blueprints允许您在文件中定义资源,并自动同步变更到Render服务。
API提供了对Blueprints创建和管理资源方式的控制。
render.yaml- — 断开指定ID的Blueprint。断开后,将停止通过Blueprint自动同步资源...
render-pp-cli blueprints disconnect - — 列出指定工作区的Blueprint。如果未指定工作区,将返回API密钥有权访问的所有Blueprint...
render-pp-cli blueprints list - — 获取指定ID的Blueprint详情。
render-pp-cli blueprints retrieve - — 更新指定ID的Blueprint。
render-pp-cli blueprints update - — 验证
render-pp-cli blueprints validateBlueprint文件,无需创建或修改任何资源。此端点会检查语法...render.yaml
cron-jobs — 管理定时任务
disks — Disks允许您为服务挂载持久存储。
- — 为Web服务、私有服务或后台工作者挂载持久磁盘。服务必须重新部署才能...
render-pp-cli disks add - — 删除服务挂载的持久磁盘。**磁盘上的所有数据将丢失。**关联的服务...
render-pp-cli disks delete - — 列出符合筛选条件的持久磁盘。如果未指定筛选条件,将返回您拥有的所有磁盘...
render-pp-cli disks list - — 获取指定ID的持久磁盘详情。
render-pp-cli disks retrieve - — 更新指定ID的持久磁盘。关联的服务必须处于已部署且活跃状态才能...
render-pp-cli disks update
env-groups — 管理环境变量组
- — 创建新的环境变量组。
render-pp-cli env-groups create - — 删除指定ID的环境变量组,包括其中所有环境变量和机密文件。
render-pp-cli env-groups delete - — 列出符合筛选条件的环境变量组。如果未指定筛选条件,将返回所有环境变量组。
render-pp-cli env-groups list - — 通过ID获取环境变量组详情。
render-pp-cli env-groups retrieve - — 更新环境变量组的属性。
render-pp-cli env-groups update
environments — 管理环境
- — 为指定ID的项目创建新环境。
render-pp-cli environments create - — 删除指定ID的环境。要求环境为空(即不包含任何服务...
render-pp-cli environments delete - — 列出指定项目中符合筛选条件的环境。如果未指定筛选条件,将返回所有环境...
render-pp-cli environments list - — 获取指定ID的环境详情。
render-pp-cli environments retrieve - — 更新指定ID的环境详情。
render-pp-cli environments update
events — 查看服务、Postgres或键值存储的事件
- — 获取指定事件的详情
render-pp-cli events <eventId>
key-value — Key Value允许您与Render Key Value实例交互。
- — 创建新的Key Value实例。
render-pp-cli key-value create - — 通过ID删除Key Value实例。
render-pp-cli key-value delete - — 列出符合筛选条件的Key Value实例。如果未指定筛选条件,将返回所有Key Value实例...
render-pp-cli key-value list - — 通过ID获取Key Value实例详情。
render-pp-cli key-value retrieve - — 通过ID更新Key Value实例。
render-pp-cli key-value update
logs — Logs允许您获取服务、Postgres数据库和Redis实例的日志。
您可以查询日志或通过WebSocket实时订阅日志。
- — 删除指定工作区的日志流。
render-pp-cli logs delete-owner-stream - — 删除指定资源的日志流覆盖配置。删除后,资源将使用工作区的...
render-pp-cli logs delete-resource-stream - — 返回指定工作区的日志流信息。
render-pp-cli logs get-owner-stream - — 返回指定资源的日志流覆盖信息。日志流覆盖配置优先级高于工作区的...
render-pp-cli logs get-resource-stream - — 列出符合筛选条件的日志。日志按开始和结束时间戳分页。还有更多日志...
render-pp-cli logs list - — 列出指定工作区中符合筛选条件的日志流覆盖配置。这些覆盖配置优先级...
render-pp-cli logs list-resource-streams - — 列出符合筛选条件的日志中指定日志标签的所有值。
render-pp-cli logs list-values - — 打开WebSocket连接,订阅符合筛选条件的日志。日志将实时流式传输...
render-pp-cli logs subscribe - — 更新指定工作区的日志流信息。该工作区下所有资源的日志将...
render-pp-cli logs update-owner-stream - — 更新指定资源的日志流覆盖信息。日志流覆盖配置优先级高于工作区的...
render-pp-cli logs update-resource-stream
maintenance — 端点允许您获取Render服务的最新维护记录。您还可以重新安排维护时间或立即触发维护。
Maintenance- — 列出指定资源的已计划和/或最近的维护记录。
render-pp-cli maintenance list - — 获取指定ID的维护记录详情。
render-pp-cli maintenance retrieve - — 更新指定ID的维护记录。此端点的更新是异步的。要检查更新的...
render-pp-cli maintenance update
metrics — 端点允许您获取服务、Postgres数据库和Redis实例的指标数据。
Metrics- — 获取一个或多个Postgres数据库或Redis实例的活跃连接数。
render-pp-cli metrics get-active-connections - — 获取一个或多个资源的带宽使用情况。
render-pp-cli metrics get-bandwidth - — 获取一个或多个资源按流量来源(HTTP、WebSocket、NAT、PrivateLink)拆分的带宽使用情况...
render-pp-cli metrics get-bandwidth-sources - — 获取一个或多个资源的CPU使用率。
render-pp-cli metrics get-cpu - — 获取一个或多个资源的CPU限制。
render-pp-cli metrics get-cpu-limit - — 获取一个或多个资源的CPU目标值。
render-pp-cli metrics get-cpu-target - — 获取一个或多个资源的持久磁盘容量。
render-pp-cli metrics get-disk-capacity - — 获取一个或多个资源的持久磁盘使用率。
render-pp-cli metrics get-disk-usage - — 获取一个或多个资源的HTTP延迟指标。
render-pp-cli metrics get-http-latency - — 获取一个或多个资源的HTTP请求数。
render-pp-cli metrics get-http-requests - — 获取一个或多个资源的实例数量。
render-pp-cli metrics get-instance-count - — 获取一个或多个资源的内存使用率。
render-pp-cli metrics get-memory - — 获取一个或多个资源的内存限制。
render-pp-cli metrics get-memory-limit - — 获取一个或多个资源的内存目标值。
render-pp-cli metrics get-memory-target - — 获取Postgres副本的复制延迟秒数。
render-pp-cli metrics get-replication-lag - — 获取一个或多个任务已完成的任务运行总数。可按状态(成功/失败)或...筛选
render-pp-cli metrics get-task-runs-completed - — 获取一个或多个任务已排队的任务运行总数。
render-pp-cli metrics get-task-runs-queued - — 列出一个或多个资源可用于筛选的实例值。
render-pp-cli metrics list-application-filter-values - — 列出一个或多个资源可用于筛选的状态码和主机值。
render-pp-cli metrics list-http-filter-values - — 路径建议基于符合筛选条件的最近5000条日志行生成
render-pp-cli metrics list-path-filter-values
metrics-stream — 管理指标流
- — 删除指定工作区的指标流。
render-pp-cli metrics-stream delete-owner - — 返回指定工作区的指标流信息。
render-pp-cli metrics-stream get-owner - — 创建或更新指定工作区的指标流。
render-pp-cli metrics-stream upsert-owner
notification-settings — Notification Settings允许您配置想要接收的通知类型和接收渠道。
- — 列出符合筛选条件的通知覆盖配置。如果未指定筛选条件,将返回所有通知...
render-pp-cli notification-settings list-notification-overrides - — 更新指定ID所有者的通知设置。
render-pp-cli notification-settings patch-owner - — 更新指定ID服务的通知覆盖配置。
render-pp-cli notification-settings patch-service-notification-overrides - — 获取指定ID所有者的通知设置。请注意,您需要提供所有者ID给此...
render-pp-cli notification-settings retrieve-owner - — 获取指定ID服务的通知覆盖配置。请注意,您需要提供服务ID给此...
render-pp-cli notification-settings retrieve-service-notification-overrides
organizations — 管理组织
owners — 管理所有者
- — 列出API密钥有权访问的工作区,可按名称或所有者邮箱地址筛选。
render-pp-cli owners list - — 获取指定ID的工作区详情。工作区ID以
render-pp-cli owners retrieve开头。如果您提供的是用户ID(以...开头)tea-
postgres — Postgres端点允许您与Render Postgres数据库交互。
您可以管理数据库、导出、恢复和故障转移。
- — 创建新的Postgres实例。
render-pp-cli postgres create - — 通过ID删除Postgres实例。此操作不可逆,所有数据将丢失。
render-pp-cli postgres delete - — 列出符合筛选条件的Postgres实例。如果未指定筛选条件,将返回所有Postgres实例。
render-pp-cli postgres list - — 通过ID获取Postgres实例详情。
render-pp-cli postgres retrieve - — 通过ID更新Postgres实例。
render-pp-cli postgres update
projects — 管理项目
- — 创建新的项目。
render-pp-cli projects create - — 删除指定ID的项目。要求项目的所有环境为空(即必须...
render-pp-cli projects delete - — 列出符合筛选条件的项目。如果未指定筛选条件,将返回所有项目。
render-pp-cli projects list - — 获取指定ID的项目详情。
render-pp-cli projects retrieve - — 更新项目详情。如果要更新项目中特定环境的详情,请改用...
render-pp-cli projects update
redis — 管理Redis
- — 创建新的Redis实例。此API已废弃,建议使用Key Value API。
render-pp-cli redis create - — 通过ID删除Redis实例。此API已废弃,建议使用Key Value API。
render-pp-cli redis delete - — 列出符合筛选条件的Redis实例。如果未指定筛选条件,将返回所有Redis实例...
render-pp-cli redis list - — 通过ID获取Redis实例详情。此API已废弃,建议使用Key Value API。
render-pp-cli redis retrieve - — 通过ID更新Redis实例。此API已废弃,建议使用Key Value API。
render-pp-cli redis update
registrycredentials — 管理注册表凭据
- — 创建新的注册表凭据。
render-pp-cli registrycredentials create-registry-credential - — 删除指定ID的注册表凭据。
render-pp-cli registrycredentials delete-registry-credential - — 列出符合筛选条件的注册表凭据。如果未指定筛选条件,将返回所有注册表...
render-pp-cli registrycredentials list-registry-credentials - — 获取指定ID的注册表凭据详情。
render-pp-cli registrycredentials retrieve-registry-credential - — 更新指定ID的注册表凭据。使用此凭据的服务必须重新部署才能使用...
render-pp-cli registrycredentials update-registry-credential
services — Services允许您管理Web服务、私有服务、后台工作者、定时任务和静态站点。
- — 在指定工作区中创建新的Render服务,使用指定配置。
render-pp-cli services create - — 删除指定ID的服务。
render-pp-cli services delete - — 列出符合筛选条件的服务。如果未指定筛选条件,将返回您有权访问的所有服务...
render-pp-cli services list - — 获取指定ID的服务详情。
render-pp-cli services retrieve - — 更新指定ID的服务。
render-pp-cli services update
task-runs — 管理任务运行
- — 取消指定ID的正在运行的任务。
render-pp-cli task-runs cancel - — 启动指定ID的工作流任务运行,并传递指定的输入数据。
render-pp-cli task-runs create-task - — 获取指定ID的工作流任务运行详情。
render-pp-cli task-runs get - — 列出符合筛选条件的任务运行。如果未指定筛选条件,将返回您有权访问的所有任务运行...
render-pp-cli task-runs list - — 建立单向事件流。服务器按SSE规范格式发送事件行。客户端...
render-pp-cli task-runs stream-events
tasks — 管理任务
- — 获取指定ID的工作流任务详情。
render-pp-cli tasks get - — 列出符合筛选条件的工作流任务。如果未指定筛选条件,将返回您有权访问的所有任务定义...
render-pp-cli tasks list
users — 端点允许您获取已认证用户的信息
User- — 获取与指定API密钥关联的用户信息。
render-pp-cli users
webhooks — Webhooks允许您管理Render Webhook配置。
- — 创建新的Webhook。
render-pp-cli webhooks create - — 删除指定ID的Webhook。
render-pp-cli webhooks delete - — 列出Webhook
render-pp-cli webhooks list - — 获取指定ID的Webhook详情
render-pp-cli webhooks retrieve - — 更新指定ID的Webhook。
render-pp-cli webhooks update
workflows — 管理工作流
- — 使用指定配置创建新的工作流服务。
render-pp-cli workflows create - — 删除指定ID的工作流服务。
render-pp-cli workflows delete - — 获取指定ID的工作流服务详情。
render-pp-cli workflows get - — 列出符合筛选条件的工作流。如果未指定筛选条件,将返回您有权访问的所有工作流...
render-pp-cli workflows list - — 更新指定ID的工作流服务。
render-pp-cli workflows update
workflowversions — 管理工作流版本
- — 创建并部署工作流的新版本。
render-pp-cli workflowversions create-workflow-version - — 获取指定ID的特定工作流服务版本详情。
render-pp-cli workflowversions get-workflow-version - — 列出指定ID工作流服务的已知版本。
render-pp-cli workflowversions list-workflow-versions
Finding the right command
查找合适的命令
When you know what you want to do but not which command does it, ask the CLI directly:
bash
render-pp-cli which "<capability in your own words>"which02--help当您知道要做什么但不知道对应的命令时,可以直接询问CLI:
bash
render-pp-cli which "<用您自己的语言描述功能>"which02--helpRecipes
使用示例
Promote staging env to prod, exclude debug keys
将Staging环境变量同步到生产环境,排除调试密钥
bash
render-pp-cli env promote --from srv-staging --to srv-prod --exclude DEBUG_TOKEN,SENTRY_DEV_DSNFirst diff to see what would change, then promote with the dev-only keys filtered out. Add --apply after review to actually issue the writes.
bash
render-pp-cli env promote --from srv-staging --to srv-prod --exclude DEBUG_TOKEN,SENTRY_DEV_DSN先使用diff命令查看会发生哪些变化,然后排除仅用于开发的密钥后进行同步。审核后添加参数以实际执行写入操作。
--applyFind every service that uses a secret before rotating it
在轮换密钥前查找所有使用该密钥的服务
bash
render-pp-cli env where STRIPE_KEY --json --select 'service.name,service.id,updatedAt'Returns service names, IDs, and timestamps for every place STRIPE_KEY is referenced — your rotation checklist.
bash
render-pp-cli env where STRIPE_KEY --json --select 'service.name,service.id,updatedAt'返回所有引用STRIPE_KEY的服务名称、ID和时间戳——这就是您的轮换清单。
Friday cost rollup grouped by project
按项目分组的周五成本汇总
bash
render-pp-cli cost --group-by project --json --select 'project,monthly_usd,resource_count'Joins cached service/postgres/kv/disk plans against a curated price table; export to CSV for finance.
bash
render-pp-cli cost --group-by project --json --select 'project,monthly_usd,resource_count'将缓存的服务/Postgres/键值存储/磁盘计划与精选价格表关联;导出为CSV文件提供给财务部门。
Detect blueprint drift in CI
在CI中检测蓝图漂移
bash
render-pp-cli drift --blueprint render.yaml --json --quiet || exit 1Exits non-zero when the live workspace diverges from the checked-in blueprint; wire it into your CI pipeline.
bash
render-pp-cli drift --blueprint render.yaml --json --quiet || exit 1当实时工作区与已提交的蓝图不一致时,返回非零退出码;将其集成到您的CI流水线中。
Incident timeline for a service over the last 2 hours
服务过去2小时的事件时间线
bash
render-pp-cli incident-timeline srv-checkout-api --since 2h --json --select 'timestamp,kind,actor,summary'Merges deploys + events + audit-logs into one chronological table — answers 'what changed' during an on-call page.
bash
render-pp-cli incident-timeline srv-checkout-api --since 2h --json --select 'timestamp,kind,actor,summary'将部署记录+事件+审计日志合并为一个按时间排序的表格——回答值班告警期间“发生了哪些变化”的问题。
Auth Setup
认证设置
Render uses bearer-token auth. Set RENDER_API_KEY (generate one at https://dashboard.render.com/u/settings#api-keys), or run to paste it interactively. Every command sends ; doctor verifies the key is live.
render-pp-cli auth set-token <RENDER_API_KEY>Authorization: Bearer <key>Run to verify setup.
render-pp-cli doctorRender使用Bearer令牌认证。设置RENDER_API_KEY(可在https://dashboard.render.com/u/settings#api-keys生成),或运行`render-pp-cli auth set-token <RENDER_API_KEY>Authorization: Bearer <key>`;doctor命令会验证令牌是否有效。
交互式粘贴令牌。每个命令都会发送运行验证设置是否正确。
render-pp-cli doctorAgent Mode
Agent模式
Add to any command. Expands to: .
--agent--json --compact --no-input --no-color --yes-
Pipeable — JSON on stdout, errors on stderr
-
Filterable —keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
--selectbashrender-pp-cli blueprints list --agent --select id,name,status -
Previewable —shows the request without sending
--dry-run -
Offline-friendly — sync/search commands can use the local SQLite store when available
-
Non-interactive — never prompts, every input is a flag
-
Explicit retries — useonly when an already-existing create should count as success, and
--idempotentonly when a missing delete target should count as success--ignore-missing
在任何命令后添加参数。它会展开为:。
--agent--json --compact --no-input --no-color --yes-
可管道化 — 标准输出为JSON,错误输出到标准错误
-
可筛选 —参数保留字段子集。点路径可深入嵌套结构;数组可遍历元素。对于冗长的API,这是缩小上下文范围的关键:
--selectbashrender-pp-cli blueprints list --agent --select id,name,status -
可预览 —参数显示请求但不发送
--dry-run -
离线友好 — 同步/搜索命令在可用时可使用本地SQLite存储
-
非交互式 — 从不提示,所有输入均通过标志参数提供
-
显式重试 — 仅当已存在的创建操作应视为成功时使用,仅当缺失的删除目标应视为成功时使用
--idempotent--ignore-missing
Response envelope
响应包
Commands that read from the local store or the API wrap output in a provenance envelope:
json
{
"meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
"results": <data>
}Parse for data and to know whether it's live or local. A human-readable summary is printed to stderr only when stdout is a terminal — piped/agent consumers get pure JSON on stdout.
.results.meta.sourceN results (live)从本地存储或API读取数据的命令会将输出包装在来源信息包中:
json
{
"meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
"results": <data>
}解析获取数据,表示数据是实时的还是本地的。仅当标准输出为终端时,才会向标准错误输出人类可读的摘要——管道/Agent消费者仅会在标准输出获取纯JSON。
.results.meta.sourceN results (live)Agent Feedback
Agent反馈
When you (or the agent) notice something off about this CLI, record it:
render-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
render-pp-cli feedback --stdin < notes.txt
render-pp-cli feedback list --json --limit 10Entries are stored locally at . They are never POSTed unless is set AND either is passed or . Default behavior is local-only.
~/.render-pp-cli/feedback.jsonlRENDER_FEEDBACK_ENDPOINT--sendRENDER_FEEDBACK_AUTO_SEND=trueWrite what surprised you, not a bug report. Short, specific, one line: that is the part that compounds.
当您(或Agent)发现此CLI存在问题时,请记录反馈:
render-pp-cli feedback "--since参数是包含性的,但文档说是排他性的"
render-pp-cli feedback --stdin < notes.txt
render-pp-cli feedback list --json --limit 10反馈条目存储在本地文件中。除非设置了且传递了参数或,否则反馈不会被POST发送。默认行为是仅存储在本地。
~/.render-pp-cli/feedback.jsonlRENDER_FEEDBACK_ENDPOINT--sendRENDER_FEEDBACK_AUTO_SEND=true请写下让您感到意外的内容,而不是正式的错误报告。简短、具体、单行描述:这样的反馈才更有价值。
Output Delivery
输出交付
Every command accepts . The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:
--deliver <sink>| Sink | Effect |
|---|---|
| Default; write to stdout only |
| Atomically write output to |
| POST the output body to the URL ( |
Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.
每个命令都支持参数。输出会发送到指定的目标,同时也会(或替代)输出到标准输出,这样Agent无需手动管道即可路由命令结果。支持三种目标:
--deliver <sink>| 输出目标 | 效果 |
|---|---|
| 默认值;仅输出到标准输出 |
| 原子性地将输出写入 |
| 将输出内容POST到指定URL(使用 |
不支持的协议会返回结构化错误,并列出支持的类型。Webhook失败会返回非零退出码,并在标准错误输出日志中记录URL和HTTP状态码。
Named Profiles
命名配置文件
A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.
render-pp-cli profile save briefing --json
render-pp-cli --profile briefing blueprints list
render-pp-cli profile list --json
render-pp-cli profile show briefing
render-pp-cli profile delete briefing --yesExplicit flags always win over profile values; profile values win over defaults. lists all available profiles under so introspecting agents discover them at runtime.
agent-contextavailable_profiles配置文件是一组保存的标志值,可在多次调用中复用。当定时Agent每次运行都使用相同配置调用同一命令时,可使用此功能——即HeyGen的“Beacon”模式。
render-pp-cli profile save briefing --json
render-pp-cli --profile briefing blueprints list
render-pp-cli profile list --json
render-pp-cli profile show briefing
render-pp-cli profile delete briefing --yes显式标志参数始终优先于配置文件值;配置文件值优先于默认值。命令会在下列出所有可用配置文件,以便自省Agent在运行时发现它们。
agent-contextavailable_profilesAsync Jobs
异步任务
For endpoints that submit long-running work, the generator detects the submit-then-poll pattern (a // field in the response plus a sibling status endpoint) and wires up three extra flags on the submitting command:
job_idtask_idoperation_id| Flag | Purpose |
|---|---|
| Block until the job reaches a terminal status instead of returning the job ID immediately |
| Maximum wait duration (default 10m, 0 means no timeout) |
| Initial poll interval (default 2s; grows with exponential backoff up to 30s) |
Use async submission without when you want to fire-and-forget; use when you want one command to return the finished artifact.
--wait--wait对于提交长时间运行任务的端点,生成器会检测提交-轮询模式(响应中包含//字段以及对应的状态端点),并为提交命令添加三个额外标志:
job_idtask_idoperation_id| 标志 | 用途 |
|---|---|
| 阻塞直到任务进入终端状态,而非立即返回任务ID |
| 最大等待时长(默认10分钟,0表示无超时) |
| 初始轮询间隔(默认2秒;指数退避增长至30秒) |
当您想触发即忘时,使用异步提交且不添加;当您想让一个命令返回完成的结果时,使用。
--wait--waitExit Codes
退出码
| Code | Meaning |
|---|---|
| 0 | Success |
| 2 | Usage error (wrong arguments) |
| 3 | Resource not found |
| 4 | Authentication required |
| 5 | API error (upstream issue) |
| 7 | Rate limited (wait and retry) |
| 10 | Config error |
| 错误码 | 含义 |
|---|---|
| 0 | 成功 |
| 2 | 使用错误(参数错误) |
| 3 | 资源未找到 |
| 4 | 需要认证 |
| 5 | API错误(上游问题) |
| 7 | 速率限制(请等待后重试) |
| 10 | 配置错误 |
Argument Parsing
参数解析
Parse :
$ARGUMENTS- Empty, , or
help→ show--helpoutputrender-pp-cli --help - Starts with → ends with
install→ MCP installation; otherwise → see Prerequisites abovemcp - Anything else → Direct Use (execute as CLI command with )
--agent
解析:
$ARGUMENTS- 为空、或
help→ 显示--help输出render-pp-cli --help - 以开头 → 以
install结尾 → MCP安装;否则 → 参见顶部的前提条件mcp - 其他内容 → 直接使用(以标志执行CLI命令)
--agent
MCP Server Installation
MCP服务器安装
Install the MCP binary from this CLI's published public-library entry or pre-built release, then register it:
bash
claude mcp add render-pp-mcp -- render-pp-mcpVerify:
claude mcp list从本CLI的已发布公共库条目或预构建版本安装MCP二进制文件,然后注册:
bash
claude mcp add render-pp-mcp -- render-pp-mcp验证:
claude mcp listDirect Use
直接使用
- Check if installed: If not found, offer to install (see Prerequisites at the top of this skill).
which render-pp-cli - Match the user query to the best command from the Unique Capabilities and Command Reference above.
- Execute with the flag:
--agentbashrender-pp-cli <command> [subcommand] [args] --agent - If ambiguous, drill into subcommand help: .
render-pp-cli <command> --help
- 检查是否已安装:如果未找到,提供安装选项(参见顶部的前提条件)。
which render-pp-cli - 将用户查询与上述独特功能和命令参考中的最佳命令匹配。
- 使用标志执行:
--agentbashrender-pp-cli <command> [subcommand] [args] --agent - 如果存在歧义,查看子命令帮助:。
render-pp-cli <command> --help