Quickstart

Getting started

Ship the dashboard in under an hour. Follow the checklist below or jump to the install guide for a deeper walkthrough.

Requirements

Node.js 20+ and pnpm 9+ (Corepack works out of the box)
VS Code 1.85+ with the TameAGENTS extension installed
Optional: Supabase instance for community rule packs
Terminal access to run pnpm scripts and Docker Compose

Helpful links

Install the extension + CLI

Install from VS Marketplace or Open VSX, then run `pnpm install` in this repo to make sure the shared schema package is built.

VS Marketplace Open VSX

Map existing agents.md files

Open the Agents Map (⌘⇧R / Ctrl+Shift+R) and let it index every agents.md, Copilot, Cursor, and JetBrains rule. Fix any “missing metadata” warnings before inviting contributors.

Wire CI + telemetry choices

Decide if telemetry (`tameagents.telemetry.enabled`) stays off, then add `tameagents report conflicts --json` to your CI job so merges fail when scopes fight.

Publish docs

Run `pnpm --filter @tameagents/website build` to bake this site, then deploy via Docker or Vercel. The sitemap + RSS keep search engines in sync.