Run the export

Run the local export and check the files it creates.

This page explains the current PluralBridge command-line export path in plain language. The commands run on your computer and write exported Simply Plural data into local folders.

Review safety notes Back to install steps

Before you start

You should already have Python 3, a Bash-compatible shell, the PluralBridge files, and your Simply Plural API token ready. Run these commands from the main PluralBridge folder, the folder that contains README.md, docs, scripts, and website.

Your exported files can contain private System information, notes, avatars, timestamps, custom fields, and other sensitive data. Keep the export folder private.

Step 1: Open your shell in the PluralBridge folder

Open Git Bash on Windows, or Terminal on macOS or Linux. Change into the folder where you placed the PluralBridge files.

cd PluralBridge

The folder name may be different if you downloaded a ZIP file or placed the files somewhere else. The important point is that you are in the main folder before running the export commands.

Step 2: Put your Simply Plural token into the shell

PluralBridge reads your Simply Plural API token from an environment variable named SP_TOKEN. This command lets you paste the token without printing it back onto the screen.

read -s -p "Paste Simply Plural token: " SP_TOKEN
echo
export SP_TOKEN

Check that a token was captured without revealing the token itself:

printf 'Token length: %s\n' "${#SP_TOKEN}"

A number greater than zero means the shell has a token value. Do not paste the token into screenshots, public issues, chat rooms, pull requests, or shared documents.

Step 3: Export JSON data

Run the JSON export script:

python scripts/python/export_json.py --output-dir exports/json

Successful output creates JSON files under exports/json. The exact files depend on your Simply Plural account data and the current script version.

Step 4: Export avatar images

After members.json exists, run the avatar export script:

python scripts/python/export_avatars.py --members-json exports/json/members.json --output-dir exports/member_images

Successful output creates image files under exports/member_images when avatar URLs are available.

Step 5: Check what was created

A successful local export should leave private files in local export folders such as:

exports/json for exported JSON data.
exports/member_images for downloaded avatar images.
Additional export folders or manifest files as scripts are added or documented.

Back up the exports folder somewhere private and durable. Do not commit it to GitHub.

Common warning signs

Token length: 0 means the token was not captured by the shell.
A missing exports/json folder means the JSON export did not complete successfully.
A missing exports/json/members.json file means the avatar export cannot run yet.
Authentication or authorization errors usually mean the token is missing, pasted incorrectly, or no longer valid.

Optional database migration

PluralBridge also includes SQL Server migration scripts that can load exported JSON into database tables, constraints, and readable views. That path is mainly for developers, technically comfortable users, validation work, reporting, and future viewer development.

Current source instructions

The repository remains the command source for the current scripts and documentation:

https://github.com/needsofmany/PluralBridge