setup-sandbox

设置 Sandbox

为已连接账户中的组织和艺人创建文件夹结构。

环境

• RECOUP_ACCOUNT_ID — 要获取数据的账户 ID。仅使用 Org API Key 时需要。使用 Personal API Key 时，省略 --account 标志，CLI 会自动使用已认证的账户。

步骤

1. 检查是否已设置 RECOUP_ACCOUNT_ID。如果已设置，在以下所有 CLI 命令中使用 --account $RECOUP_ACCOUNT_ID。如果未设置，省略 --account 标志。
2. 运行 recoup orgs list --json [--account $RECOUP_ACCOUNT_ID] 获取所有组织。
3. 对每个组织，运行 recoup artists list --org {organization_id} --json [--account $RECOUP_ACCOUNT_ID] 获取其艺人。
4. 创建文件夹结构，并在每个艺人文件夹中创建一个 RECOUP.md 标记文件：
   • 使用 CLI 响应中的 artistSlug 作为准确的目录名 — 绝不追加 UUID、ID 或后缀。
   • 如果 orgs/{org}/artists/{artist-slug}/ 已存在，则跳过。
   • 为每位新艺人运行 mkdir -p orgs/{org}/artists/{artist-slug}。
   • 使用下方模板写入 RECOUP.md。
5. 提交并推送：
   • git add -A && git commit -m "setup: create org and artist folders" && git push origin main

RECOUP.md

每个艺人目录的根目录下都有一个 RECOUP.md。这是身份文件 — 它将工作区关联到 Recoupable 平台。此文件存在即表示工作区已激活。

使用 CLI 响应中的数据填写：

---
artistName: {Artist Name}
artistSlug: {artist-slug}
artistId: {uuid-from-recoupable}
---

字段：

• artistName — CLI 中的显示名称（例如 Gatsby Grace）
• artistSlug — 小写 kebab-case 文件夹名称（例如 gatsby-grace）
• artistId — Recoup 中的 UUID