Package Exports

create-mushi-mushi

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (create-mushi-mushi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

create-mushi-mushi

One-line setup for the Mushi Mushi bug-reporting + AI triage SDK.

npm create mushi-mushi
# or
pnpm create mushi-mushi
yarn create mushi-mushi
bun create mushi-mushi

What it does

Detects your framework — Next.js, Nuxt, SvelteKit, Angular, Expo, Capacitor, plain React/Vue/Svelte, or vanilla JS.
Picks the right SDK — @mushi-mushi/react, @mushi-mushi/vue, @mushi-mushi/svelte, @mushi-mushi/angular, @mushi-mushi/react-native, @mushi-mushi/capacitor, or @mushi-mushi/web.
Detects your package manager — uses npm, pnpm, yarn, or bun based on your lockfile.
Writes env vars — MUSHI_PROJECT_ID and MUSHI_API_KEY land in .env.local with the right framework prefix (NEXT_PUBLIC_, NUXT_PUBLIC_, VITE_).
Warns about .gitignore — won't ship secrets if your env file isn't ignored.
Prints the provider snippet — framework-specific code to paste in.
Sends a test report (opt-in) — closes the loop so you see your first classified bug immediately.

This is a scaffold for existing projects — it does not generate a new app from scratch. Run it from the project root of an existing app.

Flags

npm create mushi-mushi -- --framework next
npm create mushi-mushi -- --project-id proj_xxx --api-key mushi_xxx
npm create mushi-mushi -- --skip-install
npm create mushi-mushi -- --skip-test-report
npm create mushi-mushi -- --cwd apps/web
npm create mushi-mushi -- --endpoint https://mushi.your-company.com
npm create mushi-mushi -- -y
npm create mushi-mushi -- --help

npm create and pnpm create need the -- separator before flags. Yarn 1 and Bun do not.

Equivalent commands

npx mushi-mushi               # shorter
npx @mushi-mushi/cli init     # scoped name

Troubleshooting

Wrong framework detected? Pass --framework <id> explicitly. Valid IDs: next, react, vue, nuxt, svelte, sveltekit, angular, expo, react-native, capacitor, vanilla.
Running in a monorepo? cd into the package you want Mushi in first, or pass --cwd apps/web.
npx cache serving an old version? Run npm cache clean --force or npx mushi-mushi@latest.
Non-interactive (CI)? Pass all of --yes, --project-id, and --api-key. The wizard exits with a clear error otherwise.
Key pasted with quotes/whitespace? The wizard strips them, but still validates against mushi_[A-Za-z0-9_-]{10,} / proj_[A-Za-z0-9_-]{10,}.

Security

Credentials accepted via --api-key flag leak into ps -ef. Prefer the interactive prompt on dev machines; on CI, pass them via the environment and an explicit --api-key "$MUSHI_API_KEY" at the boundary.
The ~/.mushirc credentials cache is written with mode 0o600 (owner read/write only) on Unix.
All env-file writes strip CR/LF/NUL from secrets to prevent accidental .env injection.

License

MIT

_{Monorepo scale (June 2026): 47 edge functions · 256 SQL migrations · 13 outbound plugins · 11 inbound adapters · 18 pipeline agents. Canonical counts: docs/stats.md · pnpm docs-stats}