@mindbricks/mbx

Official CLI tool for the Mindbricks platform. Authenticate and manage your Mindbricks projects from the command line.

Installation

npm install -g @mindbricks/mbx

Quick Start

Login

Authenticate with your Mindbricks account:

mbx login

Check Authentication Status

View your current logged-in user:

mbx whoami

Export Project

Download and extract a project to a folder (auto-extracts by default):

mbx export <project-codename>

# Examples:
mbx export myproject                    # Exports and extracts to current directory
mbx export myproject -o ./downloads     # Exports and extracts to specified directory
mbx export myproject --zip              # Downloads as ZIP file (no extraction)
mbx export myproject -o ./downloads -z  # Downloads as ZIP to specified directory

Pull Service Update

Update a service with the latest version from Mindbricks:

mbx pull

# Can also specify a path
mbx pull ./path/to/project

The pull command:

• Reads the .mbx-services.json file to get available services
• Presents an interactive menu to select which service to pull
• Updates the selected service with the latest version from Mindbricks

Prerequisites:

• Must be run from a project directory containing .mbx-services.json
• If you don't have this file, run mbx list-service first to generate it

Logout

Log out and remove stored credentials:

mbx logout

Commands

| Command | Description | |---------|-------------| | mbx login | Authenticate with your Mindbricks account | | mbx logout | Log out and remove stored credentials | | mbx whoami | Display current authenticated user information | | mbx export <codename> | Export a project to local directory | | mbx pull | Pull latest service update (shows service selection menu) |

Options

Export Options

• -o, --output <path> - Specify output directory (default: current directory)
• -z, --zip - Keep as ZIP file without extracting (default: auto-extract to folder)

Authentication

The CLI stores your authentication token in ~/.mbx-token.json. This file is automatically created when you login and is used for all authenticated requests.

Requirements

• Node.js >= 16.0.0

License

MIT

Support

For issues and questions, please visit https://mindbricks.com/support