CLI Reference

CLI Reference

A list of all CLI commands for BPM.

bpm help [TASK]

Shows a list of commands or provides more information about a specific command.

Project Commands

These commands are for use in developing a new BPM project.

bpm init [PATHS]

Create a new BPM project. If the directory does not exist, it will be created.

Options:

• --name=NAME Specify a different name for the project.
• --skip Skip any conflicting files.
• --app Manage app files as well as packages. (Always true for new directories.)

bpm add [PACKAGE]

Add a new dependency to a BPM project. This will update the project JSON and download the package.

Options:

• -v, --version=VERSION Specify a specific version to install
• -p, --project=PROJECT Specify project location other than working directory
• --pre, --prerelease Install a prerelease version
• --dev, --development Add as a development dependency
• -m, --mode=MODE Build mode for compilation - Default: production

bpm remove [PACKAGE]

Remove a dependency from a BPM project. This will update the project JSON.

Option:

• -p, [--project=PROJECT] Specify project location other than working directory
• -m, [--mode=MODE] Build mode for compilation - Default: production

bpm rebuild

Rebuild all project assets and dependencies. This allows the index.html to be loaded without a server for use in deployment.

Option:

• -m, --mode=MODE Build mode for compilation - Default: production
• -p, --project=PROJECT Specify project location other than working directory
• -u, --update Updates dependencies to latest compatible version

bpm preview

A live preview server for use in development. Equivalent to running bpm rebuild after every change.

Options:

• -m, --mode=MODE Build mode for compilation - Default: debug
• -p, --project=PROJECT Specify project location other than working directory
• --port=PORT Port to host server on - Default: 4020

Package Commands

These commands are for use in developing a new package for BPM.

bpm login

Log in to your GetBPM.org account.

Options:

• -u, --username=USERNAME Specify the username to login as
• -p, --password=PASSWORD Specify the login password

bpm pack [PACKAGE]

Bundle your package for distribution.

Options:

• -e, [--email=EMAIL] Specify an author email address

bpm push PACKAGE

Push your package to GetBPM.org.

bpm yank

Remove a version of your package from GetBPM.org.

Options:

• -v, --version=VERSION Specify a version to yank
• --undo Unyank package

bpm owner

This is a group of commands for managing package ownership.

bpm owner list [PACKAGE]

List all owners for the package.

bpm owner add [PACKAGE] [EMAIL]

Give permission for another user to manage you package.

bpm remove [PACKAGE] [EMAIL]

Remove a user's permission to manage your package.

Advanced Commands

bpm debug [OPTION] # Display various options for debugging

Display various options for debugging.

• build - Shows all project build settings
• repair - Verify and repair project

Options:

• -p, --project=PROJECT Specify project location other than working directory
• -m, --mode=MODE Build mode - Default: debug

bpm fetch [PACKAGE]

Fetch a bpm package to the local cache. Called by bpm add you shouldn't ever need to use this directly.

Options:

• -v, --version=VERSION Specify a version to install - Default: >= 0
• --pre, --prerelease Install a prerelease version

bpm fetched [PACKAGE]

List all locally cached packages. Normally you won't have to worry about this.

bpm list

By default lists all packages used by a project.

Options:

• -r, [--remote] Lists packages available on GetBPM.org.
• -a, [--all] Lists all versions available. (Useable with --remote only.)
• --pre, [--prerelease] Lists available pre-release versions. (Useable with --remote only.)
• --dev, [--development] Lists development dependencies for a project. (Local project only.)

bpm unpack [PACKAGE]

Extracts files from a bundled package (.bpkg).

Options:

• -t, --target=TARGET Unpack to given directory - Default: Current Directory