Skip to main content
VertaaUX Docs

Commands

All available commands in the VertaaUX VS Code Extension

Commands

The VertaaUX VS Code Extension provides three commands for scanning code and viewing results.

Command Reference

CommandTitleDescription
vertaaux.scanCurrentFileVertaaUX: Scan Current FileScan the active editor for UX issues
vertaaux.scanWorkspaceVertaaUX: Scan WorkspaceScan all matching files in the workspace
vertaaux.showIssuesVertaaUX: Show Issues PanelOpen the Issues TreeView

Scan Current File

Command ID: vertaaux.scanCurrentFile

Analyzes the currently open file for UX and accessibility issues.

How to Run

  1. Command Palette: Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux), type "Scan Current File"
  2. Keyboard Shortcut: (Not bound by default - see Custom Keybindings)

Prerequisites

  • MCP Server running in HTTP mode
  • Active editor with a supported file type

Supported File Types

ExtensionFramework
.tsxReact TypeScript
.jsxReact JavaScript
.vueVue.js
.htmlStatic HTML
.svelteSvelte

What Happens

  1. Extension reads the active document content
  2. Sends code to MCP Server via HTTP POST
  3. MCP Server calls VertaaUX API for analysis
  4. Results are filtered by confidence threshold
  5. Issues appear as VS Code diagnostics (underlines in code)
  6. Issues TreeView is updated

Output

  • Diagnostics: Squiggly underlines appear at issue locations
  • Problems Panel: Issues listed with severity and message
  • Issues TreeView: Hierarchical view of issues by file
Problems Panel:
  Button.tsx (2 issues)
    Line 5: [warning] Touch target may be too small
    Line 8: [info] Consider adding aria-label

Scan Workspace

Command ID: vertaaux.scanWorkspace

Scans all supported files in your workspace for UX issues.

How to Run

  1. Command Palette: Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux), type "Scan Workspace"

Prerequisites

  • MCP Server running in HTTP mode
  • Workspace folder open

What Happens

  1. Extension identifies all supported files in the workspace
  2. Sends file contents to MCP Server in batches
  3. Results are aggregated and displayed
  4. Progress notification shows scan status

Performance Notes

  • Large workspaces may take longer to scan
  • Scans files matching supported extensions only
  • Results are cached until next scan
  • Consider scanning individual files during development

Output

All issues across the workspace appear in:

  • Problems Panel: Grouped by file
  • Issues TreeView: Navigable tree structure

Show Issues Panel

Command ID: vertaaux.showIssues

Opens the VertaaUX Issues TreeView panel.

How to Run

  1. Command Palette: Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux), type "Show Issues Panel"
  2. Activity Bar: Click the VertaaUX icon in the left sidebar

What It Does

Opens the VertaaUX activity bar panel containing the Issues TreeView. This provides a dedicated view for browsing scan results outside the Problems panel.

See Issues Panel for detailed usage.


Custom Keybindings

The extension does not define default keyboard shortcuts. You can add custom keybindings in VS Code:

  1. Open Keyboard Shortcuts: Cmd+K Cmd+S (Mac) or Ctrl+K Ctrl+S (Windows/Linux)
  2. Search for "vertaaux"
  3. Click the + icon to add a keybinding

Example keybindings.json:

[
  {
    "key": "cmd+shift+v",
    "command": "vertaaux.scanCurrentFile",
    "when": "editorTextFocus"
  },
  {
    "key": "cmd+shift+alt+v",
    "command": "vertaaux.scanWorkspace"
  }
]

Choose shortcuts that don't conflict with existing VS Code bindings. The examples above use Cmd+Shift+V which is typically unbound.


Error States

ErrorCauseSolution
"Cannot connect to MCP server"Server not runningStart MCP Server with --http flag
"No active editor"No file openOpen a supported file type
"Unsupported file type"File extension not recognizedUse a supported extension (.tsx, .jsx, etc.)
"Scan timeout"Analysis took too longTry a smaller file or check network

Was this page helpful?

On this page