mcpField
R
revenuecat-cli

revenuecat-cli

github.com/revenuecat开发76432 次安装1 天前更新
代码仓库

关于 revenuecat-cli

revenuecat-cli 是 RevenueCat 官方命令行界面，可管理项目、应用、产品、权益、套餐、图表、商店状态和 Paywall。它提供机器可读输出和可查询的命令模式，适用于终端、CI 和 Agent 工作流。

主要功能

  1. 01管理项目、应用和产品目录
  2. 02查看图表与客户数据
  3. 03生成、编辑和发布 Paywall
  4. 04上传 Paywall 媒体与字体
  5. 05以 JSON 查询命令和模式

适用场景

  1. 01从终端管理 RevenueCat 资源
  2. 02在 CI 或 Agent 脚本中自动执行操作
  3. 03编辑 Paywall 并上传相关素材
  4. 04执行前查看准确的命令参数

MCP 相关

该 CLI 覆盖 RevenueCat MCP 服务端提供的许多操作，并额外支持编辑 Paywall 及上传媒体或字体。MCP 服务端则包含 CLI 不具备的一些 SDK 功能门控和实验工具。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/revenuecat/ai-toolkit --skill revenuecat-cli

安装后在 Claude Code 中输入/revenuecat-cli确认已加载。

详细介绍

revenuecat-cli：在终端中使用 RevenueCat

rc 是 RevenueCat 官方命令行界面。它涵盖了与 RevenueCat MCP 服务大致相同的项目、应用、产品、权益、套餐、付费墙、图表和商店状态操作（CLI 还支持生成／编辑付费墙，以及上传付费墙图片／字体；MCP 服务则提供 CLI 不具备的一些 SDK 功能门控和实验工具）。可以使用当前可用的任一方式；本指南介绍 CLI 的使用方法。

首次运行命令前

CLI 需要 shell。如果没有 shell（例如在只能使用 MCP 服务的聊天应用中），请使用 MCP，或告知用户要运行哪个 rc 命令，或要前往哪个控制面板页面。

  1. 检查是否已安装： rc --version。如果失败，请任选一种方式：

    • 无需安装即可运行：在下文每处出现 rc 的地方使用 npx @revenuecat/cli <command>。需要 Node。最适合 CI 和 Agent 沙盒。
    • 在 macOS/Linux 上安装：brew install RevenueCat/tap/rc。
    • 使用 npm 安装：npm install -g @revenuecat/cli。

    安装会更改用户的机器，因此运行 brew 或 npm install -g 前请先征求许可。运行命令所需的权限之外，npx 无需额外权限。

  2. 检查是否已登录： rc auth status --json。CLI 不会与 MCP 服务共用登录状态。如果没有有效凭据，请让用户自行运行 rc auth login：该命令会打开浏览器进行 OAuth 登录。在 CI 中，设置 RC_API_KEY 或传入 --api-key。

  3. 检查项目： 传入 --project-id <id>，或让用户使用 rc projects use 设置默认项目。

CLI 使用 RevenueCat 密钥（sk_...）进行身份验证；这是正确的，因为 CLI 是服务端工具。它与为客户端应用代码获取的 公开 SDK 密钥（appl_/goog_/amzn_）不同。切勿将密钥放入应用，也不要让用户在聊天中粘贴密钥。

探索功能

CLI 可以自行说明功能。不要猜测命令或标志，应向二进制文件查询：

  • rc commands --json 会列出完整的命令树。功能 ID 采用冒号形式（apps:create、products:store:plan）。
  • rc commands --schemas --json 会在一次调用中返回所有命令的标志、参数和示例。这是 Agent 获取各命令详细信息最可靠的方式。
  • rc schema <command> --json 会返回单个命令的详细信息，但命令必须使用以空格分隔的词元（rc schema apps create），而不能使用 rc commands 中的冒号形式。rc schema apps:create 会静默地返回根架构；因此如有疑问，请使用 rc commands --schemas。
  • rc --help 和 rc <noun> --help 会提供易读的帮助信息。

输出约定

  • --json 会提供稳定、机器可读的输出。数据写入 stdout，进度和其他提示信息写入 stderr。
  • 外层结构为 { "data": ... }，但 data 下的结构因命令而异：列表通常使用 data.items[]，但有些命令会使用其他键（图表使用 data.names[]）。请检查架构或响应，不要假定使用 data.items。
  • --no-input 不会提示，而是直接失败。请在脚本、CI 和 Agent 中使用。
  • --yes / -y 会跳过变更类命令的确认提示。
  • --project-id <id> 用于选择项目（也可以使用 rc projects use 设置默认项目）。请在脚本中显式传入。
  • 退出代码：0 成功，1 错误，2 用法错误，4 身份验证错误，5 未找到，6 受到速率限制。

常见操作

使用 rc commands --schemas --json（或 rc schema <space-separated command>）查询准确的标志。常用命令名：

  • 项目和应用：rc projects list|create|use、rc apps list|create|keys
  • 目录：rc products ...、rc entitlements ...、rc offerings ...、rc packages ...
  • 商店凭据和状态：rc setup apple|google、rc products store plan|apply|sync
  • 数据：rc charts list|show、rc customers ...
  • 付费墙：rc paywalls generate|edit|publish（仪表板设计/审查指南：revenuecat-paywall-design）
  • 付费墙媒体和字体：rc media-assets list|upload <file>、rc fonts list|upload <file>。MCP 无法上传这些文件；请勿在浏览器中使用仪表板。
  • 仪表板：rc open [section] [id] --print（资源 URL：revenuecat-dashboard-links）

图片：jpg/png/webp/avif/heic/heif，最大 2 MiB。字体：ttf/otf，最大 5 MiB。请先在磁盘上写入或生成文件，再传入该路径。使用 rc schema media-assets upload / rc schema fonts upload 确认标志。

优先使用专用命令。仅当 CLI 尚未支持相应端点时，才使用 rc api <METHOD> <path>。

评论

支持 Markdown