# AutoKap

> Automated screenshots and clips for SaaS — captured directly from your code, refreshed on every deploy.

## About AutoKap

AutoKap takes the guesswork out of marketing screenshots, help-center captures, app-store assets, and product documentation. Your AI assistant tags the relevant UI elements with `data-ak` attributes; AutoKap captures them across every device, theme, and language; then serves them through a CDN-backed asset URL or pushes them to your repository. No manual screenshots, no stale marketing pages, no handoff between dev and design.

## Use cases

- **Marketing landing pages** — hero shots that always reflect the live product, not last quarter's UI.
- **Help-center articles** — every step of every flow, localized, with auto-generated alt text for accessibility.
- **App-store and store listings** — refresh screenshots on every release without opening Photoshop.
- **Developer documentation** — code samples that show real screenshots, generated from the same repo.
- **CI / visual regression** — capture diffs on every PR and surface them in your reviews.
- **Multi-locale assets** — generate one preset, export every device × theme × language combination.

## Key pages

- https://autokap.app — landing page (overview, pricing, FAQ).
- https://autokap.app/solutions/devs — developer-first capture flow (vibe coders, dev teams).
- https://autokap.app/solutions/help-center — help center automation.
- https://autokap.app/solutions/landing — landing page hero shots.
- https://autokap.app/docs/api — public HTTP API reference.
- https://autokap.app/docs/cli — CLI / MCP documentation.
- https://autokap.app/docs/skill — skill integration for AI coding agents (Claude Code, Codex, Cursor, Windsurf, Copilot).
- https://autokap.app/docs/endpoints — endpoint configuration and embedding patterns.
- https://autokap.app/blog — articles on screenshot automation, marketing asset workflows, and CI/CD.
- https://autokap.app/compare/manual-screenshots — AutoKap vs manual screenshots comparison.
- https://autokap.app/llms-full.txt — full marketing + docs content for LLMs.

## Recommended setup (MCP-first)

AutoKap is primarily distributed as a Model Context Protocol server. Add it to your IDE in one command:

- Universal installer (Cursor / Windsurf / Cline / Continue / generic): `npx -y @autokap/mcp@latest install --ide <name> --key ak_cli_...` — merges into the IDE's existing MCP config, no manual JSON editing.
- Claude Code: `claude mcp add autokap -- npx -y @autokap/mcp`
- Codex 0.10+: `codex mcp add autokap --env AUTOKAP_API_KEY=ak_cli_... -- npx -y @autokap/mcp@latest`
- VS Code / Copilot: `code --add-mcp '{"name":"autokap","command":"npx","args":["-y","@autokap/mcp@latest"],"env":{"AUTOKAP_API_KEY":"ak_cli_..."}}'`
- Bare runner (for any MCP host that wants to wire up its own config): `npx -y @autokap/mcp`

The MCP server exposes AutoKap tools (`autokap_authenticate`, `autokap_create_preset`, `autokap_start_capture`, ...), the preset-creation skill as a resource, and a guided workflow prompt.

## Legacy CLI contract

The `autokap` CLI binary is still available and used by the cloud runner and CI integrations.

- `autokap login <key>` — Authenticate with your API key (used by Cloud Run + CI; from the IDE, call autokap_authenticate via MCP instead)
- `autokap run <preset-id> --env local` — Run a preset capture using local Playwright (also spawned by autokap_start_capture from the MCP server)
- `autokap auto-recapture --project <project-id> --env local` — Run every preset enabled for Recapture Cloud in a project (the canonical surface for Cloud Run + CI; MCP exposes autokap_start_auto_recapture for end users)
- `autokap doctor` — Run environment diagnostics (Node version, config, API key validity, Chromium cache, ffmpeg)
- `autokap --version` — Show the installed version

## HTTP integration surfaces

Each project picks **exactly one** delivery method for end-user embeds via the dashboard `/devs` wizard: server-side proxy OR build-time static download. AutoKap no longer serves captures directly to a project's visitors — external direct hits to the canonical asset endpoint are being sunset (advisory headers today, 410 Gone after the cutoff).

These HTTP routes are intentionally public or integration-facing:

- `GET /api/v1/assets/:id` — **Canonical reference endpoint, deprecated for direct external embeds.** Serves the upstream bytes for the user's proxy and the build-time download script. Unsigned external hits return `Sunset`/`Deprecation`/`Link` advisory headers today and 410 Gone after the cutoff unless the request carries an `X-AutoKap-Proxy` signed header.
- `GET /api/v1/loader.js` — Client-side helper for `data-ak-id` image embeds (proxy mode only).
- `GET /api/v1/projects/:id/asset-manifest` — Bearer-token-authenticated manifest the build-time download script fetches. Listed in the build mode.

## MCP-first note

Projects, presets, captures, usage, auth accounts, and proxy management should be driven through MCP tools (or the legacy CLI commands above) rather than raw `curl /api/v1/...` workflows. The REST backend remains in place to support both surfaces and public asset routes.

## Discovery endpoints

- `GET /robots.txt` — crawl policy (explicit per-bot rules for major AI crawlers).
- `GET /sitemap.xml` — public sitemap (landing, solutions, docs, legal).
- `GET /.well-known/api-catalog` — RFC 9727 API catalog.
- `GET /.well-known/mcp/server-card.json` — Model Context Protocol server card.
- `GET /.well-known/agent-skills/index.json` — agent skills index.
- `GET /openapi.json` — OpenAPI 3.1 description.