Skip to main content
Zap is agent-native by design: every recipe is a portable skill directory with machine-readable frontmatter, and every CLI command emits structured JSON. Any agent that can run shell commands and read a URL can bootstrap a Zap project, author new recipes, and dispatch runs. This page walks through connecting each supported agent — Codex, Claude Code, Cursor, OpenClaw, Hermes, and any generic MCP-capable client — to the Zap skill registry and CLI.
This page focuses on the connection layer: how each agent finds Zap and executes it. For the agent behavioral contract (read SKILL.md first, keep spend opt-in, etc.), see Agent Setup. For the tools the Eve runtime exposes to agents, see Agent Overview.

The Skill Download URLs

Every agent bootstraps from the same three endpoints. Point your agent at these before any other configuration: Appending ?format=json returns { skill, hash, files: [{ path, content }] } instead of raw Markdown — preferable for programmatic ingestion.

CLI Contract

All agents drive Zap through the same CLI. Two commands are enough for a full flow:
Agents should always pass --json so output is machine-parseable. The result envelope contains runId, status, zapUrl, and a per-step breakdown — no additional API is needed to observe progress.

Per-Agent Setup

OpenAI Codex CLI

Codex reads project instructions from AGENTS.md at the repo root. zap init writes this file automatically. To point Codex at the remote registry as well, add a zap section to your Codex configuration or paste the following into a session prompt:
Codex will use the CLI directly through its shell tool; no MCP server is required.

Handshake Flow

Every supported agent follows the same startup sequence. If your agent isn’t listed above, replicate this flow:
1

Fetch the skill manifest

The response lists every published skill with its hash, path, and downloadUrl. Cache the manifest and diff against local agent/skills/ on subsequent starts to detect drift.
2

Read the core framework skill

This is the master Zap SKILL — recipe grammar, CLI vocabulary, and the mock-first execution model.
3

Read the authoring skill before editing recipes

Contains schema field reference, prompt conventions, and validation rules. Load it into context before any Zap.md edit.
4

Validate and run

Mock is the default. Only pass --live after the user has approved the quoted spend.

Live-Run Handshake

When a creator asks for a real (paid) run, every agent must follow the same three-step handshake:
1

Show the quote

Run in mock first with --json and surface the quoteUsd field to the user. Do not proceed if the quote exceeds budget.cap_usd.
2

Confirm credentials are present

For CLI runs, verify GMI_API_KEY (or the required provider key) is exported. For web runs, verify the creator has connected a wallet and uploaded keys via Auth & Secrets.
3

Dispatch with --live and capture the runId

Persist the returned runId so status can be polled with zap status <runId> or GET /runs/<runId>.
Never hardcode provider keys in a session prompt, agent config, or committed file. Store keys in the user’s shell environment (GMI_API_KEY), Supabase vault (for web runs), or a secrets manager — never in a .mdc, AGENTS.md, or JSON config that lives in the repo.
  • Agent Setup — the behavioral contract every agent must follow.
  • Agent Overview — Eve tools, pipeline grammar, and the primitive vs deterministic distinction.
  • Providers — the seven BYOK secret types and provider routing.
  • GMI Cloud (BYOK) — real live-run instructions for the primary video provider.