@vue-scan/scan

@vue-scan/scan is the core Vue Scan runtime for Vue 3 applications. Use it when you want to boot the scanner manually, expose its runtime API, or load it with a script tag.

Install

bun add -D @vue-scan/scan

Manual Boot

Call scan() on the client before or during app startup:

import { scan } from '@vue-scan/scan';

scan({
  enabled: true,
  allowProduction: false,
  logging: false,
  toolbar: {
    enabled: true,
    showFps: true,
  },
});

The package also exports stop, setOptions, getOptions, getReports, getStats, and registerVueApp.

Script Tag Usage

If your page already exposes the global Vue build on window.Vue, load the auto bundle directly:

<script>
  window.__VUE_SCAN_OPTIONS__ = {
    enabled: true,
    toolbar: {
      enabled: true,
      showFps: true,
    },
  };
</script>
<script src="https://unpkg.com/@vue-scan/scan/dist/auto.global.js" crossorigin="anonymous"></script>

If Vue is not loaded globally yet, include it first:

<script src="https://unpkg.com/vue@3/dist/vue.global.js" crossorigin="anonymous"></script>
<script src="https://unpkg.com/@vue-scan/scan/dist/auto.global.js" crossorigin="anonymous"></script>

Runtime API

When the scanner is active it also exposes window.__VUE_SCAN__ with:

• scan(options)
• stop()
• getOptions()
• setOptions(nextOptions)
• getReports()
• getStats()

Runtime Options

{
  enabled: true,
  allowProduction: false,
  logging: false,
  toolbar: {
    enabled: true,
    showFps: true,
  },
}

Legacy option names are still normalized:

• dangerouslyForceRunInProduction
• log
• showToolbar
• showFPS

Related Packages

• @vue-scan/vite-plugin-vue-scan for Vite projects
• @vue-scan/nuxt for Nuxt projects

Repository Docs

• Project workflow, release flow, and hotfix policy: https://github.com/ivan-cavero/vue-scan#git-flow
• Full installation and integration guide: https://github.com/ivan-cavero/vue-scan