AutoKap
Get started
DocsAI Agent Skill

AI Agent Skill

Let your coding agent (Claude Code, Cursor, Codex) create accurate AutoKap presets using its knowledge of your project.

What is the AutoKap skill?

The AutoKap skill is a markdown file that gives your coding agent all the context it needs to generate correct preset configurations. Your agent already knows your project's routes, components, and UI — the skill teaches it how to translate that knowledge into AutoKap presets.

Prerequisites

Before installing the skill, make sure you have the following:

  1. A coding agent that supports custom skills or commands — Claude Code, Cursor, Windsurf, or OpenAI Codex.
  2. An AutoKap account with at least one project created in the dashboard.
  3. For direct API mode (optional): a CLI key already linked to the machine. Agents can read the stored key from ~/.autokap/config.json instead of asking for another credential.

What the skill file contains

AutoKap now has one canonical skill source that is packaged per agent. For Codex, the install is a local bundle with SKILL.md plus companion reference files. For Claude Code, Cursor, Windsurf, Copilot, and manual HTTP downloads, AutoKap compiles the same source into a flattened single-file export. In both forms, your agent gets the preset contract, opcode guidance, variant rules, and the instructions needed to map your codebase to valid presets.

Choose your agent

Select your AI coding agent below. All install commands will adapt automatically.

Install path: .claude/commands/autokap-preset.md

One-liner install (no Node.js needed)

Download the flattened skill export directly into your project:

Shell
curl -fsSL "https://autokap.app/api/skill?agent=claude" -o .claude/commands/autokap-preset.md

On Windows (PowerShell):

PowerShell
irm "https://autokap.app/api/skill?agent=claude" -OutFile .claude/commands/autokap-preset.md

Install via npx

Use npx to install the skill without a global install:

Shell
npx autokap@latest skill --agent claude

Install via global CLI

If you have the CLI installed globally:

Shell
autokap skill --agent claude

Manual download

Or download the agent-specific flattened export directly from this page:

Download SKILL.md

Verify the installation

After installing, verify the skill file or bundle is in place:

Shell
ls .claude/commands/autokap-preset.md

Then test it by asking your agent a simple question:

Text
What AutoKap preset fields are available for configuring a capture?

If the agent lists preset fields like url, pages, targets, themes, and langs, the skill is correctly installed.

Usage

Once installed, ask your coding agent to create a preset by referencing the skill. The agent will analyze your project and generate a complete preset configuration. Example prompt:

Text
Using the autokap-preset skill, inspect this codebase and create a preset for my project "MyApp" (https://myapp.com).

I want to capture the homepage hero section and the pricing page with both light and dark themes. Inspect auth, locale, and theme handling before writing the preset, then sync it so I can run it directly.

Your agent will usually create the preset directly in your AutoKap project by reusing the CLI key already stored on your machine. If direct sync is unavailable, it can fall back to outputting the full preset JSON.

What happens next

After your agent generates a preset, the default path is direct sync to your AutoKap project using the stored CLI key. Manual JSON import is only the fallback path.

  • Default with direct sync enabled: the agent creates the preset directly in your AutoKap project via the REST API, reusing the CLI key stored in ~/.autokap/config.json — no extra credential or manual step needed.
  • Fallback without API mode: the agent outputs the full preset JSON so you can import it manually from the dashboard.

In both cases, once the preset exists in AutoKap, you can run it from the dashboard or the CLI to start capturing.

Direct sync mode

To let your agent use the default one-shot flow and create presets directly in your AutoKap project without copy-paste, first authenticate the CLI once with autokap login <your-cli-key>. The agent then reuses the stored key from ~/.autokap/config.json for programmatic access:

Shell
npx autokap skill --agent claude \
  --project-url https://myapp.com \
  --project-id YOUR_PROJECT_ID

Good to know

Stored CLI key

No extra credential is required. Once the CLI is linked on this machine, the same stored CLI key is reused for preset creation, endpoint access, and other programmatic flows. To run captures, use the CLI: autokap run <preset-id>.

Version control

The skill file can be committed to your repository. This way, every team member and CI environment gets the same skill automatically. The file contains no secrets because credentials are read from the local CLI config at runtime.

Keeping the skill up to date

When AutoKap adds new preset fields or capabilities, re-run the agent-specific install command so AutoKap can regenerate the right packaging format. Codex gets the refreshed bundle, while other agents get a refreshed single-file export. If you downloaded the skill manually, re-download it from this page.

Project context matters

The skill works best when your agent has full access to your project's source code. The more routes, components, and selectors the agent can see, the more accurate the generated presets will be. If you're working on a monorepo, point the agent at the relevant package or app directory for best results.