Skip to main content
Sightmap is an open YAML format and CLI for sharing runtime context about a web app. A .sightmap/ directory checked into your repo names views, components, and API requests; memory notes record runtime quirks, invariants, and shortcuts that source code does not explain. Agents curate the map against the running app. Definitions link back to source files, and Sightmap-enabled tools read the same checked-in context.

​
What an agent sees

The same date picker appears differently in a bare accessibility snapshot and one enriched by Sightmap:
A bare accessibility snapshot has no view name, component identity, or indication that the textbox accepts typed dates. With Sightmap, the agent sees the current view, the picker’s typed-input shortcut, the disabled state of past dates, and a link to the source file.

​
Get started

Quickstart

Install the CLI, then have your agent build a .sightmap/ against any running web app.

CLI reference

sightmap commands for browser sessions, snapshots, coverage, selectors, and corpus health.

The spec

The version 1 YAML format for views, components, requests, and memory, with its JSON Schema and conformance fixtures.

Authoring

How agents inspect the running app, verify selectors, and maintain .sightmap/.

​
How Sightmap works

An agent does the mapping. You install the skills once and review the diff before it lands.
1

Install the skills (once)

Run npm install -g @sightmap/sightmap, then sightmap skills install to add the sightmap-authoring and sightmap-browser skills to your agent harness. This is the one-time human setup.
2

Point your agent at the running app

Give your agent the app’s URL and ask it to build a sightmap. It runs sightmap browser start to launch Chrome and a local corpus server that reloads the YAML as it changes.
3

The agent maps each view

Through the sightmap-authoring skill, the agent runs sightmap snapshot --coverage on each route, names the interactive nodes that come back unattributed, and repeats until every view reports zero orphaned nodes.
4

Review and check in

The agent validates and lints as it goes. You review the diff and commit .sightmap/ — Sightmap-enabled agents and tools then read the same checked-in context.
Sightmap is an MIT-licensed specification with one reference implementation: the sightmap CLI and Go library. The spec, implementation, conformance fixtures, and these docs live in one repo at github.com/sightmap/sightmap.