prezly/clubhouse-export-tool

PHP CLI tool to export all your Clubhouse data into a single JSON file

Clubhouse JSON Export Tool

PHP CLI tool to export all your Clubhouse data into a single JSON file

Requirements

• PHP 7.3+
• Composer

Getting started

1. Clone the code with git:

git clone git@github.com:prezly/clubhouse-export-tool.git

2. Install Composer dependencies:

   composer install

3. Put Clubhouse access token into the .env file.

   • Go to your Clubhouse dashboard

   • Navigate to Settings > My Account > API Tokens and generate an environment-specific token.

     See Clubhouse documentation on obtaining a token: https://help.clubhouse.io/hc/en-us/articles/205701199-Clubhouse-API-Tokens

   • Paste the token into .env replacing "paste-your-token-here" text

Usage

Export all your Clubhouse data into a single JSON file:

php export.php > data/clubhouse.json

Supported sections:

• categories
• entity-templates
• epic-workflow
• epics
• files
• groups
• iterations
• labels
• linked-files
• members
• milestones
• projects
• repositories
• stories
• teams
• workflows

Exporting only sepcific sections

php export.php epics > data/epics.json

Other tools

There is an official clubhouse/exporter package from Clubhouse, but it has a few differences:

• clubhouse/exporter does export shortened story objects (no comments or description).
• clubhouse/exporter does not export story history records.
• clubhouse/exporter stores every section into a separate file. This may be okay for you, but we needed everything into a single file, so we could use JSONata to manipulate the whole dataset.

---

Brought to you with ❤️ by Prezly.