Subject

Getting Started

Start with the CLI page, choose a version, validate the package and verify the command.

First-time setup path

A normal first setup starts on the CLI page at https://boilerplate.com/cli. Select the operating system tab, choose the version you want, pick the installer or standalone binary for your architecture and download it from the page. When the page provides a terminal command, you can use that command instead of downloading manually.

After downloading, validate the package when you are installing on a shared workstation, production machine or CI runner. Then install the package or run the standalone binary directly. Close and reopen the terminal so updated PATH settings are loaded, then run bpcli version and bpcli help.

bpcli version
bpcli help
bpcli isLoggedIn
bpcli langs
bpcli packageManager

These commands confirm that BPCLI is available, print the installed version, show the command reference, check authentication state and list supported language and package-manager workflows.

Command output modes

Human-readable output is intended for local use. Commands that support --json should be preferred in CI, scripts and tooling because the output can be parsed safely. When a command modifies files, check the changed manifest or lockfile before committing.

Version selection

Use release builds for normal work. Nightly builds are useful only when you need a newer fix or feature and are comfortable with a less stable build. The CLI page loads version metadata dynamically, so the selector on that page should be treated as the source of truth before downloading.

Package validation

For Linux Debian, Linux Alpine and macOS downloads, the CLI page can show SHA1 values. Use this validation pattern:

f="./<downloaded-file>"
s=<expected-sha1>
[ "$(sha1sum "$f" | cut -d' ' -f1)" = "$s" ] && echo "OK" || echo "SHA1 mismatch"