Skip to Content
v0.8.0 · shippedNative iOS / Android / Flutter / Capacitor SDKs, A2A discovery, SOC 2 readiness, residency, BYO storage, BYOK. Read the changelog →
Admin consoleOnboarding
Plan → Do → Check → Act storyboard before the checklist · · open live demo ↗

Onboarding

Route: /onboarding

Scenario: You signed up 5 minutes ago. Your goal: get a real bug report from your app into Mushi before your afternoon standup. This page takes you from zero to your first classified report in under 10 minutes.

The Onboarding wizard is the fastest path to a live pipeline. Work through the steps in order — each step unlocks the next.

Setup checklist

A progress strip tracks your completion status across five steps. Completed steps show a green tick; the current step glows.

Create a project

Enter a project name and click Create. A project is created immediately and becomes the active project.

After create, a success panel appears with:

  • Your Project ID (UUID) in a one-click copy chip
  • Prefilled mushi init --project-id … and mushi connect … commands
  • A shortcut to Generate API key on the Verify tab

This panel closes the gap between “I created something” and “I can paste credentials into the CLI.”

Generate an API key

Click Generate API key on the Verify tab to create an SDK-scoped key (report:write). The key is shown in plaintext exactly once — copy it immediately.

Not Settings → BYOK. Settings is for your own Anthropic/Firecrawl keys. SDK ingest keys are minted here on Verify (or from the Projects page key picker).

Test the connection

Click Submit test report to send a synthetic report through the full ingest pipeline. A status chip shows idle → running → pass / fail. A pass means the key is valid, the classify function ran, and the report appeared in the Reports queue.

Click Send another to fire additional test reports.

The Verify tab also shows a Time to first diagnosis card — the elapsed time from when you minted your first API key to when your first report was classified into a plain-English diagnosis. The target is under 2 minutes; the card reads “Under the 2-minute target ✓” once you beat it, or “Target: under 2 minutes” while pending. This is Mushi’s onboarding north-star metric.

Install the SDK

The SDK install configurator shows framework-specific install snippets (React, Next.js, React Native, Flutter, etc.) pre-filled with your API key and project ID. Copy and paste into your codebase.

Or run the CLI wizard from your app repo — see CLI ↔ console loop.

Go to dashboard

Once all steps are complete, a Go to Dashboard button appears. The setup checklist banner on the dashboard will clear.

CLI setup mode (?setup=cli)

When you run npx mushi-mushi without saved credentials, the wizard can open the console at:

/onboarding?tab=steps&setup=cli
BehaviorNormal onboardingsetup=cli
Create formHidden if you already have projectsAlways shown — add another project
Banner copyGeneric checklist”CLI setup — name your app below”
Success panelSame UUID + CLI commandsSame — optimized for paste-back into terminal

Use this path when the terminal wizard sent you here, or when you need a second project without leaving the onboarding UX.

CliSetupGuide strip

Several surfaces reuse the same 1-2-3 CLI setup strip (CliSetupGuide):

  • Connect hub when no SDK heartbeat has landed yet
  • Projects → New project empty state

Steps match the CLI ↔ console loop: create → mint key → mushi init or mushi connect.

PDCA Flow explainer

The onboarding page includes a static PDCA Flow diagram (the same diagram as on the dashboard, but with outcome copy instead of live counts) so new users understand what the four pipeline stages mean before they see live data.

One-time key reveal — the plaintext API key is shown exactly once after generation. Copy it before clicking away. If you lose it, generate a new key from the Projects page — you can’t recover the old one.

Troubleshooting the test report

If the test report shows fail:

SymptomLikely causeFix
401 UnauthorizedWrong API key in the SDK installRe-copy the key from the reveal card
429 Too Many RequestsYou’ve hit the hourly rate limitWait 60 seconds, try again
Status stuck at runningClassifier BYOK key missingGo to Settings → BYOK tab → add Anthropic key
Success but no report in Reports pageWrong project selected in the SDK snippetCheck projectId in your install code

What happens after setup

Once the SDK sends its first real report from your app:

  1. The dashboard First Report hero card appears and disappears.
  2. The report is classified and appears in the Reports & triage queue.
  3. The setup checklist on the dashboard marks “First report” as complete.

Restarting the tour

Click Restart tour at the bottom of the page to reset the checklist state and walk through setup again. This does not delete any existing projects or data.

API

POST /v1/admin/projects               { name }
POST /v1/admin/projects/:id/keys      { scope: 'ingest' }
POST /v1/admin/projects/:id/test-report
GET  /v1/admin/onboarding/time-to-first-diagnosis   → { keyMintedAt, firstDiagnosisAt, ms }
Last updated on
DashboardProjects