Skip to content

CLI reference

Every family package exposes the same binary at vendor/bin/boost.

CommandPurpose
boost installScaffold boost.php (if missing), then run the interactive agent / vendor / tag picker
boost new <skill|guideline> <name>Scaffold a skill or guideline file with a frontmatter template (--description, --force)
boost scanRe-run the vendor allowlist picker — use after installing packages that publish skills or guidelines
boost remote [<owner>/<repo>]Read a GitHub repository of skills and pick which to declare in withRemoteSkills() (--ref, --mode)
boost syncFan skills, guidelines, and commands out to the selected agents
boost sync --checkDry run — report drift, write nothing. Offline. Gate CI on this
boost sync --scope=user [--all]User-scope sync, for globally-installed CLI tools
boost whereOrigin-traced listing of every skill, guideline, and command that would ship
boost where --diff=<name>Unified diff between a host override and the vendor copy
boost where --conventions [--json]Resolved conventions slots, their provenance, and block keep/drop status
boost doctorOffline health check — config, remote sources, cache, emitters, skill dependencies, token leaks
boost doctor --check-versionsOpt-in Packagist comparison for path-repository shadows. One HTTP call per package
boost doctor --check-conventionsReport conventions slot status: missing, unknown, file existence
boost doctor --check-stale-pathsRead-only audit of the retired-paths registry — what the next sync would clean up
boost tagsList available tags and their unlock counts across allowlisted vendors
boost validate [--strict]Validate withConventions([...]), scan for leaked tokens, check skill dependencies
boost slots [--missing|--filled]List conventions slots, optionally filtered by fill state
boost pathsList the path globs boost manages
boost convert-conventionsLegacy one-shot: extract 0.8.x marker YAML into boost.php. Hidden, not a contract

Exit codes

0 ok, 1 failure, 2 usage error.

boost doctor is advisory: it exits 0 unless the config itself fails to load. Gate CI on boost sync --check or boost validate --strict instead.

yaml
- name: Check agent config is in sync
  run: vendor/bin/boost sync --check && vendor/bin/boost validate --strict

Laravel applications

With project-boost-laravel, use the artisan commands instead of the bare binary. They run through the Laravel container, which bootstraps the Blade renderer and delivers laravel/boost's bundled skills to every agent:

bash
php artisan project-boost:sync
php artisan project-boost:reconcile

See Coexistence with laravel/boost.