#pabal-app-review-miner Docs

#Setup

  1. Clone and enter this repository.
git clone https://github.com/quartz-labs-dev/pabal-app-review-miner.git
cd pabal-app-review-miner
  1. Install dependencies and build.
npm install
npm run build
  1. Prepare registered-apps.json with pabal-store-api-mcp.

Set up pabal-store-api-mcp first by following:

Then run icon setup in this repository:

npm run setup:icon
Manual setup (if you do not use pabal-store-api-mcp)
mkdir -p ~/.config/pabal-mcp
chmod 700 ~/.config/pabal-mcp
cat > ~/.config/pabal-mcp/registered-apps.json <<'JSON'
{
  "apps": [
    {
      "slug": "golden-horizon",
      "name": "Golden Horizon",
      "appStore": {
        "bundleId": "com.quartz.goldenhorizon",
        "appId": "1234567890"
      },
      "googlePlay": {
        "packageName": "com.quartz.goldenhorizon"
      }
    }
  ]
}
JSON
chmod 600 ~/.config/pabal-mcp/registered-apps.json
npm run setup:icon
Optional: notes and quick validation

--my-app is resolved from ~/.config/pabal-mcp/registered-apps.json.

npm run review:collect -- --my-app golden-horizon --apps apps.json --limit 1

#Documentation Map

  • Review Commands: Collect competitor app reviews from App Store/Google Play and save raw JSON data.
  • Report Commands: Use collected reviews to translate data, render shared-viewer bundles, and manage backlog/preview state.