Skip to Content
v1.33.8 · shipped One-screen report · Looks like your app Read the changelog →
SDK referenceOverview

SDK reference

Mushi Mushi’s npm packages ship on independent semver tracks (see npm  for live versions). Current workspace snapshots:

PackageVersion
@mushi-mushi/core, @mushi-mushi/web1.33.x
@mushi-mushi/react1.33.x
@mushi-mushi/react-native0.24.x
@mushi-mushi/cli0.37.x
@mushi-mushi/mcp0.30.x
@mushi-mushi/capacitor1.1.x
@mushi-mushi/node1.3.x
@mushi-mushi/angular, @mushi-mushi/vue, @mushi-mushi/svelte1.0.x
mushi-mushi (launcher)0.8.x

See Project ID & API keys for credential formats (project UUID, and the one mushi_… key format every SDK and the MCP server share).

Maturity, honestly

Version numbers don’t tell the maturity story (a 1.0.x wrapper can be younger and less used than a 0.x SDK), so this table says it directly: what each tier means and where each package sits.

TierWhat it meansPackages
Battle-testedRuns in production apps daily, including the Mushi Mushi console itself; full capture surface; deep test suites@mushi-mushi/core, @mushi-mushi/web, @mushi-mushi/react, @mushi-mushi/react-native, @mushi-mushi/cli, @mushi-mushi/mcp
SolidComplete for the documented surface, used in real apps, smaller scope@mushi-mushi/capacitor, @mushi-mushi/node, @mushi-mushi/adapters
Functional wrapperThin framework binding over @mushi-mushi/web (100 to 200 lines each); everything documented works, but expect fewer framework-specific niceties@mushi-mushi/vue, @mushi-mushi/svelte, @mushi-mushi/angular
Native previewFull native implementations, not yet published to CocoaPods, Maven Central or pub.dev; install from the GitHub repoiOS (Swift), Android (Kotlin), Flutter

If a “functional wrapper” is missing something you need, the underlying @mushi-mushi/web API is always available alongside it, and issues  for framework bindings get prioritized by demand.

The JS packages are MIT-licensed; the server packages (@mushi-mushi/server, @mushi-mushi/agents, @mushi-mushi/verify) are AGPLv3, an OSI-approved open-source license. A small enterprise-edition boundary (packages/server/ee/) is source-available but commercial for production use.

Web & frameworks

PackageRegistryDescription
@mushi-mushi/corenpmShared primitives: normaliseThrown, createBreadcrumbBuffer, captureEnvironment
@mushi-mushi/webnpmBrowser SDK: report widget, breadcrumbs, session replay, optional WASM pre-classifier
@mushi-mushi/reactnpmReact provider + hooks + <MushiRewardsBadge />
@mushi-mushi/vuenpmVue 3 plugin + composables
@mushi-mushi/sveltenpmSvelte stores + context
@mushi-mushi/angularnpmAngular service, error handler and provideMushi()
@mushi-mushi/adaptersnpmInbound observability webhooks (Sentry, Datadog, Bugsnag, …)

Server

PackageRegistryDescription
@mushi-mushi/nodenpmForward unhandled exceptions + HTTP error handlers

Mobile & native

PackageRegistryDescription
@mushi-mushi/react-nativenpmReact Native SDK: shake-to-report, bottom-sheet widget, offline queue
MushiMushiPreview: SwiftPM from master (no CocoaPods yet)iOS / macOS / tvOS native Swift SDK
dev.mushimushi:mushi-androidPreview: build from source (not on Maven Central yet)Android Kotlin SDK, bottom-sheet widget, file-backed queue
mushi_mushiPreview: git: dependency (not on pub.dev yet)Flutter SDK written in Dart, sensors_plus shake detection
@mushi-mushi/capacitornpmCapacitor plugin that wraps the native SDKs for hybrid apps

Tooling & automation

PackageRegistryDescription
@mushi-mushi/clinpmProject setup, RAG indexing, report management, mushi migrate
mushi-mushinpmLauncher: the npx mushi-mushi setup wizard
@mushi-mushi/mcpnpmMCP server: triage reports from Cursor, Claude, Codex
@mushi-mushi/mcp-cinpmGitHub Action: triage-coverage gate, fix dispatch, pre-release gates, crawler sign-in
eslint-plugin-mushi-mushinpmLint rules for empty event handlers (no-dead-handler) and leftover mock data (no-mock-leak)

Infrastructure & advanced

PackageRegistryDescription
@mushi-mushi/wasm-classifiernpmOn-device pre-classifier (heuristic; ONNX mode experimental) that drops junk before sending
@mushi-mushi/plugin-sdknpmBuild your own Marketplace plugin
@mushi-mushi/inventory-schemanpmZod schemas for inventory_nodes and user stories
@mushi-mushi/inventory-auth-runnernpmLogs in with Playwright from your inventory.yaml auth script so the crawler can reach pages behind a login

Recipes & presets

PageDescription
SDK presetsproduction-calm, beta-loud, manual-only, internal-debug
Next.js App Router + CSPContent-Security-Policy allowlist for the widget
Next.js static exportStatic export + client-only init
Capacitor bottom dockAnchor widget above tab bars
Sentry Replay coexistenceRun Mushi 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/mcp

Upgrade from 0.x

See the @mushi-mushi/* 0.x → 1.0 migration guide for breaking-change details and a codemod.

Last updated on