Skip to content

Reference

CodeMeaning
0Success
1Validation / data error (bad JSON, invalid capture, unknown command)
2Filesystem error (file not found, permission denied, I/O error)

WebSketch CLI works with WebSketch IR capture files (JSON). Each capture is a tree of UINode objects where every node carries:

  • role — One of 23 UI primitives (PAGE, BUTTON, NAV, CARD, INPUT, etc.)
  • bbox — Viewport-relative bounding box [x, y, w, h] in [0, 1] range
  • text — Text signal with hash, length, and classification
  • children — Nested child nodes
AspectDetail
Data touchedWebSketch IR JSON files (read), rendered ASCII/diff/fingerprint output (write to stdout/files)
Data NOT touchedNo telemetry, no analytics, no network calls, no credential storage
PermissionsRead: input JSON files. Write: output files to user-specified paths
NetworkNone — fully offline CLI tool
PackageRole
websketch-irCore IR grammar and serialization
websketch-extensionChrome extension for in-browser capture
websketch-vscodeCapture pages right from VS Code
websketch-mcpMCP server for LLM agent integration
websketch-demoInteractive playground and visualization