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

Bug report widget for Vue 3

This page adds a report button to a Vue 3 app. When something breaks, your users tap it and write one sentence. You get the likely cause in plain English, with a fix your AI editor can apply.

The fastest way is npx mushi-mushi in your app’s folder: it gets your keys, installs the package and prints the code below for you to paste. The steps match the React quickstart; only the install and the start-up call differ.

Get your project ID and API key

The SDK needs two values from a Mushi Mushi project.

  • Fastest: run npx mushi-mushi in your app’s folder. It signs you in through the browser, creates or picks a project, installs the SDK and writes both values to .env.local.
  • By hand: create a free account  (no card) and create a project. The panel that opens shows the project ID and an API key that starts with mushi_. Copy the key now: it is shown once. You can mint another under Set up → Test it → Generate API key.
  • Self-hosting? Your own console gives you the same two values. See Self-hosting.

Put them in .env.local as VITE_MUSHI_PROJECT_ID and VITE_MUSHI_API_KEY.

Install and register the plugin

pnpm add mushi-mushi
src/main.ts
import { createApp } from 'vue' import { MushiPlugin } from 'mushi-mushi/vue' import App from './App.vue' createApp(App) .use(MushiPlugin, { projectId: import.meta.env.VITE_MUSHI_PROJECT_ID, apiKey: import.meta.env.VITE_MUSHI_API_KEY, }) .mount('#app')
You’ll see: a small report button in the corner of your app. Tap it, send one sentence, and the report shows in the console  within seconds.

Starting a new Vue app? npx mushi-mushi --template vue my-app makes one with Mushi Mushi already in it (how).

API detail: mushi-mushi/vue. Widget behavior: mushi-mushi.

Last updated on