Skip to content
Boomin Boomin Developers

CLI Guide

The boominjs package ships both a browser SDK and a CLI.

Terminal window
npx boominjs --help

Every command supports -h and --help.

Login

Section titled “Login”
Terminal window
npx boominjs login

The CLI creates a short-lived login session, opens Boomin in your browser, and waits for approval. This is the same pattern used by tools like Wrangler: credentials are granted in the browser, not typed into the terminal.

Init

Section titled “Init”
Terminal window
npx boominjs init

init logs in if needed, selects or creates an organization and creator program, ensures a Creator Connect public key exists, appends local origins, and writes .env.local.

Useful flags:

Terminal window
npx boominjs init --yes
npx boominjs init --dry-run
npx boominjs init --origin http://localhost:3000
npx boominjs init --program-name "Launch Creator Program"

Status and logout

Section titled “Status and logout”
Terminal window
npx boominjs status
npx boominjs status --json
npx boominjs logout

Scopes

Section titled “Scopes”
Terminal window
npx boominjs scopes
npx boominjs scopes --json
npx boominjs scopes explain units:create

Platform smoke

Section titled “Platform smoke”
Terminal window
npx boominjs platform smoke --read-only --token sk_boomin_live_...
npx boominjs platform smoke --write --cleanup --token sk_boomin_live_...
npx boominjs platform smoke --all-scopes --cleanup --json

Agents should prefer --json when they need machine-readable output.

--all-scopes creates a temporary all-scope token when no token is passed, executes every V1 scope through the Platform scope executor, cleans up created smoke objects when --cleanup is present, and revokes the temporary token.