SDK reference
Published npm packages ship on independent semver tracks (see npm for live versions). Current workspace snapshots:
| Package | Version |
|---|---|
| @mushi-mushi/core, @mushi-mushi/web | 1.22.x |
| @mushi-mushi/react | 1.21.x |
| @mushi-mushi/react-native | 0.20.x |
| @mushi-mushi/cli | 0.23.x |
| @mushi-mushi/mcp | 0.18.x |
| @mushi-mushi/capacitor | 1.1.x |
| @mushi-mushi/node | 1.1.x |
| @mushi-mushi/angular, @mushi-mushi/vue, @mushi-mushi/svelte | 1.0.x |
| mushi-mushi (launcher) | 0.7.x |
See Project ID & API keys for credential formats (proj_* slug vs UUID, mushi_* vs mush_pk_* keys).
The JS packages are MIT-licensed; the server packages (@mushi-mushi/server, @mushi-mushi/agents, @mushi-mushi/verify) are AGPLv3 — true OSI open source. A small enterprise-edition boundary (packages/server/ee/) is source-available but commercial for production use.
Web & frameworks
| Package | Registry | Description |
|---|---|---|
@mushi-mushi/core | npm | Shared primitives: normaliseThrown, createBreadcrumbBuffer, captureEnvironment |
@mushi-mushi/web | npm | Browser SDK — shake widget, breadcrumbs, session replay, WASM pre-classifier |
@mushi-mushi/react | npm | React provider + hooks + <MushiRewardsBadge /> |
@mushi-mushi/vue | npm | Vue 3 plugin + composables |
@mushi-mushi/svelte | npm | Svelte stores + context |
@mushi-mushi/angular | npm | Angular DI service + directive |
@mushi-mushi/adapters | npm | Framework adapters (Next.js, SvelteKit, Nuxt, etc.) |
Server
| Package | Registry | Description |
|---|---|---|
@mushi-mushi/node | npm | Forward unhandled exceptions + HTTP error handlers |
Mobile & native
| Package | Registry | Description |
|---|---|---|
@mushi-mushi/react-native | npm | React Native SDK — shake, offline queue, Sentry bridge |
MushiMushi | SwiftPM + CocoaPods | iOS / macOS / tvOS native Swift SDK |
dev.mushimushi:sdk | Maven Central | Android Kotlin SDK, Compose UI, WorkManager queue |
mushi_mushi | pub.dev | Flutter pure-Dart SDK, sensors_plus shake detection |
@mushi-mushi/capacitor | npm | Capacitor plugin — wraps native SDKs for hybrid apps |
Tooling & automation
| Package | Registry | Description |
|---|---|---|
@mushi-mushi/cli | npm | Project setup, RAG indexing, report management, mushi migrate |
mushi-mushi | npm | Meta-launcher — npx mushi-mushi wizard |
@mushi-mushi/mcp | npm | MCP server — triage reports from Cursor, Claude, Codex |
@mushi-mushi/mcp-ci | npm | CI-aware MCP surface — attach to GitHub Actions |
eslint-plugin-mushi-mushi | npm | Lints for missing report calls and incorrect config |
Infrastructure & advanced
| Package | Registry | Description |
|---|---|---|
@mushi-mushi/wasm-classifier | npm | On-device WASM SLM — pre-classifies before sending |
@mushi-mushi/plugin-sdk | npm | Build your own Marketplace plugin |
@mushi-mushi/inventory-schema | npm | Zod schemas for inventory_nodes and user stories |
@mushi-mushi/inventory-auth-runner | npm | Auth-gated story runner for the QA coverage suite |
Recipes & presets
| Page | Description |
|---|---|
| SDK presets | production-calm, beta-loud, manual-only, internal-debug |
| Next.js App Router + CSP | Content-Security-Policy allowlist for the widget |
| Next.js static export | Static export + client-only init |
| Capacitor bottom dock | Anchor widget above tab bars |
| Sentry Replay coexistence | Run Mushi replay alongside Sentry |
| Screenshot preview & consent | Visible preview + privacy caption (screenshotSensitiveHint, 1.19+) |
Installation
# Minimal (browser app)
npm install @mushi-mushi/web
# React app
npm install @mushi-mushi/react
# React Native
npm install @mushi-mushi/react-native
# MCP server
npx @mushi-mushi/mcpUpgrade from 0.x
See the @mushi-mushi/* 0.x → 1.0 migration guide for breaking-change details and a codemod.
Last updated on