CLI
Install, configure and use the Boilerplate command line tools.
What BPCLI is for
Boilerplate CLI is the terminal tool for working with Boilerplate from a local project. The command is bpcli. It is useful when Store work needs to move into a real development environment: installing packages, auditing dependencies, downloading component archives, publishing from Git and checking the current user session.
Common use cases
Use BPCLI when you want to search Boilerplate Store from a terminal, install components into a project, download archives for later inspection, audit dependencies or initialize a supported JavaScript, TypeScript, Java, Groovy or Kotlin project. The CLI also supports login, logout, user information and publishing flows.
Supported platforms
| Platform | Installer | Standalone binary | Architectures |
|---|---|---|---|
| Windows | .exe | bpcli.exe | x64 |
| Linux Debian | .deb | bpcli | x64, arm64 |
| macOS | .pkg | bpcli | x64, arm64 |
| Linux Alpine | .apk | bpcli | x64, arm64 when available |
Linux Alpine can appear on the CLI page as a separate platform, but it may be marked as coming soon. Check the current CLI page before planning an Alpine installation.
What BPCLI reads and writes
BPCLI reads project manifests, lockfiles, local configuration, authentication state and Store package metadata. Commands that modify a project can update manifests, lockfiles, downloaded archives or local Boilerplate metadata. Commands that query Store return package, product, user or dependency data and should be run from the project root when the command depends on local files.