Start in your repository
Requires Node.js 22 or newer.init from your application repository. Its optional wizard offers project
or global CLI installation, MCP configuration, skills, and an SDK. Use arrow
keys for one choice, Space to toggle checkboxes, and Enter to continue. Review
the exact changes before applying; skip anything you do not need.
Setup then offers browser sign-in and selects or creates a project with its
Default environment. It saves public IDs in firedrill.config.json, not
credentials. It does not select Tools, run your application, or upload your
repository. MCP browser authorization remains separate.
npx firedrill-run offers setup on its first interactive launch in a repository.
Later bare launches show a compact welcome. Use npx firedrill-run install to
reopen the choices, or npx firedrill-run init --skip-install for account/project
setup only. JSON and CI modes never prompt or install implicitly.
Use the same prefix for another command:
firedrill command. Without a global
installation, replace firedrill with
npx firedrill-run.
Prefer a project-local installation?
Prefer a project-local installation?
npx firedrill-run;
bare npx firedrill is not the fresh installer and can resolve an unrelated
package.Let your coding agent prepare the simulation
For Codex, use its native MCP and plugin commands:Run an existing recipe
With a recipe prepared for your actual application:--choose to
select scenarios using Space. Discovery reads valid recipe JSON in the current
directory and firedrill/; it does not invent a recipe or run a target to find one.
An exact path also works: firedrill simulate firedrill/scenario.json.
simulate creates a retained batch and runs command or HTTP targets from this
machine. For preparation without execution, use firedrill doctor or
firedrill preview. Native callbacks use the TypeScript or
Python SDK.
The result includes batch/run IDs, a recovery operation ID, and an authenticated report link. Use returned IDs—not the labels below:
Automation and recovery
Use--json --non-interactive for scripts. These modes never open menus or a
browser and never install implicitly. Explicit install selections return a
read-only plan until --yes is supplied; see optional installation.
CI supplies a scoped FIREDRILL_TOKEN through its secret store; see CI.
firedrill simulate --resume OPERATION_ID. Use follow BATCH_ID only to observe: it never dispatches target work.
See the command reference for scope selection, queue-only submission, retained reads, and exit codes.