Skip to Content
v0.8.0 · shippedNative iOS / Android / Flutter / Capacitor SDKs, A2A discovery, SOC 2 readiness, residency, BYO storage, BYOK. Read the changelog →
SDK referencemushi-mushi (launcher)

mushi-mushi — the one-command launcher

npx mushi-mushi is the single entry point on npm: it auto-detects your framework, picks the right @mushi-mushi/* SDK, writes MUSHI_PROJECT_ID and MUSHI_API_KEY into .env.local, and prints the snippet to paste into your app.

Try it

npx mushi-mushi

Equivalent commands — all three run the same wizard from @mushi-mushi/cli:

npx mushi-mushi # the launcher (this package) npm create mushi-mushi # via the npm-create convention npx @mushi-mushi/cli init # the scoped name

What it detects

FrameworkDetected from
Next.jsnext.config.*, app/ directory
Nuxtnuxt.config.*
SvelteKitsvelte.config.* + @sveltejs/kit dep
Angularangular.json
React (Vite)vite.config.* + react dep
Vue 3 (Vite)vite.config.* + vue@^3 dep
Svelte (Vite)vite.config.* + svelte dep
Expoapp.json + expo dep
React Native CLIreact-native dep without Expo
Capacitorcapacitor.config.*
Vanillafallback

The package manager is detected from the lockfile (pnpm-lock.yaml, yarn.lock, bun.lockb, package-lock.json). Env-var prefixes are chosen by framework: NEXT_PUBLIC_…, NUXT_PUBLIC_…, VITE_…, EXPO_PUBLIC_….

Idempotent

Running the wizard a second time is safe:

  • Existing MUSHI_* env vars are never overwritten.
  • The snippet is reprinted, but no extra dependency installs run if the SDK is already present.
  • A pre-flight check warns if .env.local isn’t gitignored, so secrets don’t accidentally end up in source control.

When to use the launcher vs the CLI directly

Use the launcher when you want one URL to give a teammate (“npx mushi-mushi and you’re done”).

Use @mushi-mushi/cli directly if you want to run subcommands beyond init — e.g. mushi report list, mushi triage, or the mushi migrate migration helper.

Last updated on