Subject

Command Help

Use `bpcli help` and the command list for daily CLI work.

Open help

Run bpcli help whenever you need the full command list, flags, examples or command-specific notes.

bpcli help

On Windows, if you are running the standalone binary from the current folder, use:

.\bpcli.exe help

Commands from help

Command	Alias	Purpose
`audit`	`a`	Audit project dependencies for known security vulnerabilities.
`version`	`v`	Print the current `bpcli` version and package metadata.
`install`	`i`	Install dependencies through Boilerplate storage and fallback registries.
`installationMethod`	`im`	Choose the default Gradle installation method in local config.
`init`		Initialize a new project from built-in templates.
`run`		Run a project script, Java build task or executable.
`scriptList`	`sl`	List runnable project scripts or global BPCLI commands.
`deptree`	`dt`	Display the dependency tree from the current `.bplock` file.
`why`		Explain why a dependency exists in the current project.
`upgrade`		Upgrade or downgrade BPCLI.
`login`		Authenticate BPCLI with Boilerplate.
`logout`		Remove the saved Boilerplate login token.
`search`	`s`	Search Boilerplate Store packages.
`setup`		Install or activate supported runtimes and build tools.
`update`	`u`	Update project dependencies through the BPCLI install flow.
`productInfo`	`pi`	Fetch product information by package name or internal product ID.
`publish`	`p`	Prepare a Boilerplate publish URL for the current Git project.
`remove`	`r`	Remove dependencies from the project or global Boilerplate libs directory.
`isLoggedIn`	`ili`	Report whether BPCLI has an authenticated Boilerplate session.
`getUserInfo`	`gui`	Fetch the current authenticated user profile.
`userComponents`	`uc`	List components available to the authenticated user.
`langs`	`l`	List languages supported by BPCLI workflows.
`packageManager`	`pm`	List package managers supported by BPCLI.
`config`	`c`	Read or update local BPCLI configuration.
`download`		Download Boilerplate package archives without installing them.

Command input and output notes

Command family	Reads	Writes or returns
Auth	Token, browser login or saved session	Saved session state, user profile or login status.
Install/update/remove	Project manifest, lockfile, package names and package manager	Updated dependencies, lockfiles and install logs.
Search/product info	Store query text, package name or product ID	Product metadata, versions, pricing and availability.
Audit/deptree/why	Manifest and lockfile data	Dependency tree, vulnerability or dependency explanation output.
Init/setup/run	Template, runtime, package manager or script name	Project files, tool setup results or script output.
Publish	Git repository metadata and current project state	Publish URL or handoff metadata for Store publishing.

Use command-specific help when arguments are unclear. Prefer explicit package names, output directories and JSON flags in scripts so automation does not depend on interactive prompts.

Common examples

bpcli login
bpcli login --token "$BPCLI_TOKEN"
bpcli search --text react
bpcli install express lodash
bpcli download react react-dom --output ./downloads
bpcli audit --lang ts --pm npm --json
bpcli init --template typescript --name demo-app --dir ./demo-app
bpcli publish --private
bpcli config --set minimum-age 14d

Formatting output for automation

When --json is available, pipe JSON output to your CI parser instead of scraping terminal text. For example, bpcli audit --json should be easier to gate in CI than a colored text report. For commands that download or modify files, treat the exit code plus resulting file changes as the output contract.

CLI-Related Subjects

Getting Started Troubleshooting