Scanner reference

@guideai/scanner reads your source code and builds the knowledge base of your app's routes and elements.

InstallCopy Anchor Link

npm install --save-dev @guideai/scanner   # in your project
npm install -g @guideai/scanner           # or globally

The command it installs is guideai-scan.

OptionsCopy Anchor Link

Common commandsCopy Anchor Link

# Preview in the terminal
npx guideai-scan --dry-run

# Preview into a file you can inspect or upload later
npx guideai-scan --dry-run --output scan-results.json

# Scan and upload
npx guideai-scan --key sk_live_YOUR_ADMIN_KEY

# Scan an app in a sub-folder, upload, and keep a copy
npx guideai-scan --dir ./apps/web --key sk_live_YOUR_ADMIN_KEY --output scan-results.json

What it doesCopy Anchor Link

1. Detects your framework: Next.js (App and Pages Router), React Router, Vue Router / Nuxt, Angular, Remix, SvelteKit or plain HTML
2. Extracts your routes
3. Extracts interactive elements on each route
4. Gives every element a fingerprint so it can be found again after UI changes
5. Builds a map of how pages and elements relate
6. Uploads the result (unless --dry-run)

node_modules is always skipped. The scanner collects structure only: routes, elements and labels, not your data or secrets.

OutputCopy Anchor Link

{
  "framework": "nextjs-app-router",
  "routes": [],
  "elements": [],
  "ui_map": {},
  "duration_ms": 1234
}

Upload a file like this from Data & Insights → Knowledge Base → Upload Scan.

Build pluginsCopy Anchor Link

Scan automatically on every production build. Both plugins read the key from the GUIDEAI_API_KEY environment variable (or an apiKey option).

import { guideai } from '@guideai/scanner/vite'

export default { plugins: [guideai({ siteId: 'YOUR_SITE_ID' })] }

const { GuideAIWebpackPlugin } = require('@guideai/scanner/webpack')

module.exports = { plugins: [new GuideAIWebpackPlugin({ siteId: 'YOUR_SITE_ID' })] }

ErrorsCopy Anchor Link