@mushi-mushi/cli
@mushi-mushi/cli
Your AI wrote it. Mushi tells you why it broke.
The mushi command for Mushi Mushi. Install the SDK in your app, connect your editor, then read bugs, dispatch fixes and merge them without leaving the terminal.
flowchart LR
A["mushi init<br/>SDK in your app"] --> B["mushi setup<br/>editor reads diagnoses"] --> C["mushi reports<br/>see what broke"] --> D["mushi fix<br/>agent opens a draft PR"] --> E["mushi fixes merge"]
Quick start
npx mushi-mushi # the SDK wizard (same as: npx @mushi-mushi/cli init)
npx mushi-mushi setup --ide cursor # connect your editor: cursor, claude, continue or zed
npm install -g @mushi-mushi/cli # optional: a global `mushi` command
The wizard detects your framework and package manager, checks your credentials, installs the right SDK, writes framework-prefixed env vars (NEXT_PUBLIC_, VITE_, EXPO_PUBLIC_…) to .env.local, prints the snippet to paste, and offers to send a test report. It never overwrites an existing env var or edits your code.
Credentials come from the console: the project ID is on the Projects page; the API key is under Setup → Verify → Generate API key (report:write), not the AI keys in Settings. No project yet? The wizard can open the console for you.
For your editor, mushi setup writes the hosted MCP entry by default: the editor opens a browser sign-in on first use and no key is stored on disk. Add --stdio for a local server instead.
Commands
| Group | Commands |
|---|---|
| Set up | init, login, setup, connect, doctor, upgrade, nudge, completion |
| Bugs | reports list/show/search/triage, lessons list/show |
| Fixes | fix <reportId>, fixes tail/merge/refresh-ci/review/verify, verify workflow |
| Ship | sourcemaps upload, deploy check, migrate, audit |
| Test and UX | qa stories/runs/run, tdd gen/pending/approve/improve, stories map, ux |
| Account | whoami, status, usage, billing, keys, integrations, slack |
mushi --help and mushi <command> --help list every command and flag.
Common tasks
mushi doctor --fix # check SDK, ingest and dispatch; fix what's safe locally
mushi reports list --status new --severity critical # what broke
mushi fix <reportId> --wait # an agent opens a draft PR for it
mushi fixes merge <fixId> # merge it and mark the report Fixed
mushi upgrade # bump @mushi-mushi/* to the latest stable
mushi upgrade --check # CI: exit 0 current, 1 outdated, 2 registry down
mushi sourcemaps upload --release "$GITHUB_SHA" --dir ./dist
mushi ux ui # the local UX studio (see @mushi-mushi/ux)
In CI or scripts, skip the prompts:
mushi init --yes --project-id <uuid> --api-key mushi_xxx --skip-test-report
MUSHI_API_KEY=mushi_xxx mushi connect --project-id <uuid> --endpoint <url> --wait # wire a repo, wait for the first SDK heartbeat
Other init flags: --framework next, --cwd apps/web (monorepos), --endpoint <url> (self-hosted), --skip-install.
Environment variables
| Variable | Purpose |
|---|---|
MUSHI_API_KEY |
API key. Prefer it over --api-key, which shows up in ps |
MUSHI_PROJECT_ID |
Project UUID |
MUSHI_API_ENDPOINT |
API base URL (defaults to Mushi Cloud) |
MUSHI_CONSOLE_URL |
Console base for links and browser opens |
MUSHI_BYOK_KEY |
Key for mushi keys add, kept out of shell history |
MUSHI_NO_UPDATE_CHECK=1 |
Skip the "newer version" hint |
MUSHI_DEBUG=1 |
Full stack traces on error |
Config lives in ~/.config/mushi/config.json, written with mode 0o600 (a legacy ~/.mushirc is auto-migrated). --endpoint must be https:// except on localhost.
Programmatic use
| Import | Exports |
|---|---|
@mushi-mushi/cli/init |
runInit, InitOptions |
@mushi-mushi/cli/detect |
Framework and package-manager detection |
@mushi-mushi/cli/version |
MUSHI_CLI_VERSION |
Learn more
CLI reference · CLI and console loop · MCP setup
License
MIT
Related Packages
One command adds a bug report widget to any app. The bug mediator for AI-built a...
Run `npm create mushi-mushi` to add the Mushi Mushi bug-reporting SDK to your ex...
Bug report and user feedback widget for the web. The bug mediator for AI-built a...
AI agent skills for Contentrain — workflow procedures, framework integration gui...
Version History
| Version | Released | License |
|---|---|---|
| 0.33.0 | MIT | |
| 0.32.0 | MIT | |
| 0.31.0 | MIT | |
| 0.30.6 | MIT | |
| 0.30.5 | MIT | |
| 0.30.4 | MIT | |
| 0.30.3 | MIT | |
| 0.30.2 | MIT | |
| 0.30.1 | MIT | |
| 0.30.0 | MIT | |
| 0.29.2 | MIT | |
| 0.29.1 | MIT | |
| 0.29.0 | MIT | |
| 0.28.0 | MIT | |
| 0.27.1 | MIT | |
| 0.27.0 | MIT | |
| 0.26.1 | MIT | |
| 0.26.0 | MIT | |
| 0.25.0 | MIT | |
| 0.24.0 | MIT | |
| 0.23.1 | MIT | |
| 0.23.0 | MIT | |
| 0.22.1 | MIT | |
| 0.22.0 | MIT | |
| 0.21.0 | MIT | |
| 0.20.0 | MIT | |
| 0.19.0 | MIT | |
| 0.18.2 | MIT | |
| 0.18.1 | MIT | |
| 0.18.0 | MIT |
Showing the latest 30 of 53. See every release on npm