BuddyBoss Bundler CLI

1.3.1 · active · verified Sun Apr 19

The BuddyBoss Bundler (version 1.3.1) is a command-line interface (CLI) tool designed to facilitate the rapid deployment of code changes to a BuddyBoss Test App running on a mobile device. It enables developers to quickly iterate on their BuddyBoss App customizations by pushing updates directly from their local Git repository. The tool operates by establishing a development session through a QR code scan after the test app is put into a development mode (shaking the device). It streamlines the development workflow for BuddyBoss App developers, focusing on efficiency and immediate feedback loops during the customization process, contrasting with traditional app store submission cycles. It is actively maintained with regular updates, and its primary differentiator is its direct integration with the BuddyBoss mobile app development ecosystem.

Common errors

```
`buddyboss-bundler: command not found`
```
cause The `buddyboss-bundler` package was not installed globally, or the npm global binaries directory is not included in your system's PATH.

fix Install the package globally: `npm install -g buddyboss-bundler`. If the error persists, verify that your system's PATH environment variable includes the directory where npm global packages are installed (e.g., `~/.npm-global/bin` or `/usr/local/bin`).
```
Failed to connect: Invalid App ID or App Key provided
```
cause The BuddyBoss App ID or App Key entered during the CLI prompt was incorrect, or the development session on the mobile device was not properly initiated or timed out.

fix Double-check the BuddyBoss App ID and App Key for any typos. Ensure the BuddyBoss Test App on your device is actively in a development session (shaken the phone) and is ready to scan the QR code before entering credentials and initiating the connection.
```
QR Code Scan Failed: No device detected
```
cause The mobile device did not successfully scan the QR code displayed in the terminal, or there was a network connectivity issue preventing the device from communicating with the bundler.

fix Ensure your device's camera is clean and centered on the QR code. Confirm both your development machine and mobile device are on the same local network. Check for any firewall rules that might block communication between the two.

Warnings

gotcha The BuddyBoss Bundler is primarily designed as a global CLI tool. Installing it locally (`npm install buddyboss-bundler`) will not place `buddyboss-bundler` in your system's PATH, preventing direct execution from the command line.
Fix: Always install the package globally using `npm install -g buddyboss-bundler` to ensure the command is available system-wide.
gotcha A development session must be explicitly started on your mobile device (by shaking the phone within the BuddyBoss Test App) *before* attempting to connect with the `buddyboss-bundler` CLI. Failure to do so will result in connection errors.
Fix: Before running `buddyboss-bundler` and scanning the QR code, ensure you have shaken your phone to activate the development session prompt within your BuddyBoss Test App.

Install

npm install buddyboss-bundler npm
yarn add buddyboss-bundler yarn
pnpm add buddyboss-bundler pnpm

Quickstart

This quickstart demonstrates the global installation and execution of the BuddyBoss Bundler CLI, including the necessary steps for connecting to a BuddyBoss Test App on a mobile device to deploy code changes.

# 1. Ensure Node.js and npm are installed on your system.
# 2. Download your BuddyBoss Test App to your phone and launch it.
# 3. Shake your phone to initiate a Development Session within the app.
# 4. In your command line, navigate into your Git repository directory containing your BuddyBoss App code.
cd /path/to/your/buddyboss-app-repository

# 5. Install the BuddyBoss Bundler globally using npm.
npm install -g buddyboss-bundler

# 6. Run the BuddyBoss Bundler command.
buddyboss-bundler

# 7. Follow the prompts in your terminal:
#    - Enter your BuddyBoss App ID (obtained from your BuddyBoss account).
#    - Enter your BuddyBoss App Key.
#    - Scan the QR code displayed in your terminal with your device's BuddyBoss Test App to connect and deploy changes.

view raw JSON →