Adapty 开发者 CLI 快速入门指南

Adapty CLI 让你可以完全通过命令行完成应用配置。如果你偏好终端工具或 MCP 客户端，可以用它来替代看板快速入门。

完成后，你的应用、访问等级、产品、流程或付费墙以及版位都将显示在 Adapty 看板中。

如果您在 Claude Cowork 中运行 CLI，请先在 Claude 中进行配置——请参阅在 Claude Cowork 中设置 Adapty CLI。

1. 安装 CLI

需要 Node.js 18 或更高版本。

运行以下命令安装 CLI：

npm install -g adapty

或者，直接运行：

npx adapty auth login

2. 身份验证

运行登录命令，将 CLI 连接到您的 Adapty 账户。

adapty auth login

CLI 将打开一个浏览器标签页。将终端中显示的代码与浏览器中显示的代码进行匹配，然后点击 Authorize。身份验证完成后，终端将显示确认信息。

3. 创建您的应用

Adapty 中的应用代表您的移动应用程序。一个 Adapty 应用可同时连接 App Store 和 Google Play——无论您在多少个商店上架，只需创建一个即可。

adapty apps create --title "My App" --platform ios --platform android --apple-bundle-id com.example.app --google-bundle-id com.example.app

adapty apps create --title "My App" --platform ios --apple-bundle-id com.example.app

adapty apps create --title "My App" --platform android --google-bundle-id com.example.app

该命令会返回一个 <app-id>。后续所有命令都需要用到这个 ID。

4. 创建访问等级（可选）

访问等级用于控制用户购买后可以访问的内容。与其在应用中检查用户是否购买了某个特定产品，不如检查用户是否拥有某个访问等级。这样可以将应用逻辑与具体的产品 ID 解耦。

每个新应用都会自动创建一个 premium 访问等级。对于大多数应用，你可以跳过这一步。 在第 5 步中直接使用 premium 作为访问等级 ID 即可。

仅当不同产品为不同用户组解锁不同功能时才运行此命令——例如，“Basic” 订阅用户和 “Pro” 订阅用户可以访问应用的不同部分。

adapty access-levels create --app <app-id> --sdk-id "pro" --title "Pro"

• --sdk-id 是你在应用代码中用于检查某功能是否对用户开放的标识符（例如 if user.hasAccessLevel("pro")）。如果跳过此步骤并使用默认访问等级，其 --sdk-id 为 premium。
• --title 是在 Adapty 看板中供你参考的显示标签。

该命令返回一个 <access-level-id>。

5. 创建产品

在 Adapty 中，产品代表应用内销售的任何内容——订阅或一次性购买。来自 App Store Connect 和 Google Play 的商品可以归并为一个 Adapty 产品，统一管理。

你需要从各应用商店获取产品 ID：从 App Store Connect 获取 Apple 产品 ID，从 Google Play Console 获取 Android 产品 ID 和基础方案 ID。详情请参阅产品。

如果你跳过了第 4 步，请使用第 3 步 apps create 命令返回的 default_access_level.id 作为你的 <access-level-id>。

adapty products create --app <app-id> --title "My Product" --access-level-id <access-level-id> --period monthly --ios-product-id <your.apple.id> --android-product-id <your.google.id> --android-base-plan-id <your.base-plan.id>

adapty products create --app <app-id> --title "My Product" --access-level-id <access-level-id> --period monthly --ios-product-id <your.apple.id>

adapty products create --app <app-id> --title "My Product" --access-level-id <access-level-id> --period monthly --android-product-id <your.google.id> --android-base-plan-id <your.base-plan.id>

该命令会返回一个 <product-id>。

如果你还通过 Stripe 或 Paddle 在网页端销售该产品，请将相应 ID 添加到同一命令中。详情请参阅命令参考中的 products create。

6. 创建流程或付费墙

每个产品都必须先放入流程或付费墙中，才能在应用中展示。请选择其中一种：

• 流程是您在无代码流程与付费墙编辑工具中设计、由 Adapty SDK 原生渲染的单个或多个页面：付费墙页面、用户引导、问卷。如果您希望由 Adapty 来渲染购买页面，请选择流程。流程需要 Adapty SDK 4.0 或更高版本。
• 付费墙是一组不含设计的产品集合。如果您在自己的应用代码中渲染购买页面，只需要 Adapty 提供产品（可选附带远程配置），请选择付费墙。

一个版位只服务于一种内容类型，因此请在第 7 步之前做好决定。

6a. 创建流程

CLI 会创建流程记录。流程的页面内容存储在构建器配置中，这是一个 CLI 不会自动生成的 JSON 文档。如需从终端编写配置，请使用 flow-generator skill，它会自动驱动 CLI 完成操作。

创建流程：

adapty flows create --app <app-id> --name "Onboarding"

该命令会返回一个 <flow-id>。

使用 flow-generator skill 或在 Flow & Paywall Builder 中构建页面。无论哪种方式，结果都是一个已保存的草稿，用户暂时看不到。

发布流程：

adapty flows publish --app <app-id> <flow-id>

该命令会请求确认。发布在后台运行，请使用 adapty flows get --app <app-id> <flow-id> 持续检查状态，直到显示 published。若状态为 publication_failed，可通过 flows config get 查看失败原因。版位只接受已发布的流程。

6b. 创建付费墙

付费墙是承载产品的容器。

adapty paywalls create --app <app-id> --title "My Paywall" --product-id <product-id>

adapty paywalls create --app <app-id> --title "My Paywall" --product-id <product-id-1> --product-id <product-id-2>

该命令会返回一个 <paywall-id>。

7. 创建版位

版位是您在应用中展示流程或付费墙的位置。您在应用代码中唯一需要硬编码的就是版位 ID，其他所有内容——向哪些用户展示哪个流程或付费墙——都可以在看板中管理，无需发布新版本。

--developer-id 是您稍后在应用代码中向 Adapty 查询该位置应显示什么内容时所引用的字符串。请根据位置选择一个能描述其用途的名称，例如 "main"、"onboarding" 或 "settings"。

adapty placements create --app <app-id> --title "Onboarding" --developer-id "onboarding" --audiences '[{"content_type":"flow","segment_ids":[],"flow_id":"<flow-id>","priority":0}]'

adapty placements create --app <app-id> --title "Main" --developer-id "main" --audiences '[{"content_type":"paywall","segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'

--audiences 标志控制哪些用户可以看到哪个流程或付费墙。上面的示例设置了一个默认目标受众：该版位的所有用户都会看到相同的内容。一个版位只服务于一种内容类型，因此每个目标受众条目必须携带相同的 content_type。如需按市场细分进行定向，请参阅命令参考中的目标受众结构。

接下来做什么

所有实体现在都可以在 Adapty 看板 中查看。接下来：

• 修改已有流程 — 向 flow-generator 技能 描述所需更改，或在 Flow & Paywall Builder 中直接打开该流程进行编辑。
• 在应用中渲染付费墙 — 使用 SDK 获取付费墙及其产品，然后用自己的代码构建页面。
• 集成 Adapty SDK — 将 SDK 添加到你的应用中，以获取并展示版位内容。
• 将不同用户市场细分路由到不同的流程或付费墙 — 请参阅命令参考中的 placements update 和 segments list。