Install

Every install path for the Sightmap toolchain. Pick the one that matches your role.

Packages

Package	Install	What it gives you
`@sightmap/sightmap`	`pnpm add -D @sightmap/sightmap`	Core library + `sightmap` CLI. `init` (zero-to-one installer), `fmt` (canonical formatter), `validate`, `lint`, `check`, `match`, `explain`.
`@sightmap/react`	`pnpm add @sightmap/react @sightmap/sightmap`	React Router 7 adapter. `<SightmapProvider>`, Vite plugin, `sightmap-react` CLI.
`@sightmap/mcp`	`pnpm add -D @sightmap/mcp`	MCP server with browser tools and curation tools. Wraps `@playwright/mcp`.
`@sightmap/playwright`	`pnpm add -D @sightmap/playwright @playwright/cli`	Sightmap-aware wrapper around `@playwright/cli`. Same enriched snapshots as `@sightmap/mcp`, no MCP protocol overhead.
`@sightmap/agent-browser`	`pnpm add -D @sightmap/agent-browser agent-browser`	Sightmap-aware wrapper around Vercel’s `agent-browser` CLI. Same four enriched commands; passes through `-p <provider>` for hosted Chrome (Browserless, Browserbase, Kernel, …).
`@sightmap/plugin`	`/plugin marketplace add sightmap/plugin` then `/plugin install sightmap@sightmap`	Claude Code plugin: slash commands, skills, curator subagents, and advisory hooks. Multi-host manifests for Codex, Cursor, OpenCode.

@sightmap/sightmap is a peer dep of @sightmap/react — install it alongside.

CLI bins

The packages ship four CLIs:

Bin	Ships in	Commands
`sightmap`	`@sightmap/sightmap`	`init`, `fmt`, `validate`, `lint`, `check`, `match`, `explain`, `check-conventions`
`sightmap-playwright`	`@sightmap/playwright`	`snapshot`, `match`, `act`, `network`, plus full `@playwright/cli` passthrough
`sightmap-agent-browser`	`@sightmap/agent-browser`	`snapshot`, `match`, `act`, `network`, plus full `agent-browser` passthrough (incl. `-p <provider>`)

All commands accept --json for machine-readable output and --cwd <dir> to run from outside the project. See CLI reference for the full command list.

Claude Code plugin

The plugin ships through the Claude Code marketplace. In Claude Code:

/plugin marketplace add sightmap/plugin
/plugin install sightmap@sightmap

Plugin source lives in sightmap/plugin. Per-harness manifests under .claude-plugin/, .codex-plugin/, .cursor-plugin/, and .opencode/ mean the same plugin installs across all four hosts.

Each manifest declares a compatibleMcpVersion field. When sightmap init runs the manual path, or when the plugin spawns its bundled MCP, that field pins the @sightmap/mcp version — see Plugin (Claude Code) for details.

For local plugin development:

git clone https://github.com/sightmap/plugin
cd plugin
# follow the plugin repo's README for the symlink dev setup

The hook scripts shell out to npx --no-install sightmap by default. Override with SIGHTMAP_BIN if you need a pinned binary path.

Editor schema validation

Add this header to your .sightmap/ YAML files for in-editor validation in VS Code (yaml-language-server):

# yaml-language-server: $schema=https://raw.githubusercontent.com/sightmap/spec/main/spec/v1/sightmap.schema.json

Requirements

Node 20+
pnpm 10+ (or npm / yarn — pnpm is what we test against)
TypeScript ~5.7 if you’re consuming the library types

Quickstart — install through populated .sightmap/, agent-driven against your running app.
Authoring overview — once everything is installed.