CLI reference
The bugmole and bm commands address the same CLI.
Core workflow
| Command | Purpose |
|---|---|
bugmole init |
Initialize a project and its local environment |
bugmole explore |
Inspect the project structure and identify journeys |
bugmole plan |
Produce an executable plan |
bugmole run |
Execute the selected plan |
bugmole serve |
Run the local project worker |
bugmole report |
Generate a report from run results |
bugmole review |
Review an execution or proposed change |
bugmole reset |
Remove project-scoped execution data after explicit confirmation |
The npm scripts are also available in a checkout:
npm run bugmole:explore
npm run bugmole:plan
npm run bugmole:run
npm run bugmole:report
bugmole serve prints the dashboard handoff URL and opens it in the default
browser. Use bugmole serve --no-open when the URL should only be printed.
Device onboarding
When a machine has no API key, initialization can start device onboarding:
bugmole init
The CLI prints a short-lived pairing code and opens the project registration page. The human code is not the machine credential. After the authorized claim completes, the generated key is written once to .bugmole.env as BUGMOLE_API_KEY.
Reset safety
bugmole reset is project-scoped and requires an explicit confirmation. It removes execution data such as runs, reports, progress, and cursor commits while preserving project registration and local source specifications.