Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gratitude5dee/Zap/llms.txt

Use this file to discover all available pages before exploring further.

Zap lets you define reusable generative video recipes in a single Zap.md file, then run them with zero spend in mock mode or against real AI providers with a single flag. The @wzrdtech/zap CLI scaffolds projects, validates recipes, and orchestrates multi-step pipelines across GMI Cloud, fal, and bring-your-own-key providers — all enforced by per-recipe budget caps.

Quickstart

Scaffold a project, write your first recipe, and run a mock pipeline in under five minutes.

Zap Spec

Understand the Zap.md recipe format — inputs, steps, budget, and output declaration.

CLI Reference

Every command from zap init to zap doctor, with flags and real output examples.

Providers

Route pipelines through GMI Cloud, fal, or your own keys stored securely in Supabase.

​
How It Works

1

Scaffold a project

Run npx @wzrdtech/zap@0.1.0 init my-app to create a Zap project with the correct directory structure, package scripts, and a sample recipe.
2

Author a recipe

Use zap new <slug> to scaffold agent/skills/zap-<slug>/Zap.md with YAML frontmatter defining inputs, pipeline steps, budget cap, and output format.
3

Validate and lint

Run zap validate to check frontmatter correctness and variable references. Run zap lint to catch policy warnings like live provider defaults.
4

Run mock or live

Execute zap run <Zap.md> for a zero-cost mock run, or add --live to submit real provider jobs — budget is enforced automatically before any spend.

​
Key Features

Recipe Files

Zap.md combines YAML pipeline metadata with human-readable context in a single Markdown file that agents and creators both understand.

Mock by Default

Every CLI run defaults to mock mode — deterministic zero-cost outputs for testing. Flip to live only when you’re ready to spend.

Budget Enforcement

Per-recipe cap_usd is enforced at the CLI and web runtime before any provider job is submitted.

Multi-Provider

Route individual steps to GMI Cloud or fal, or bring your own keys for Runware, Prodia, OpenRouter, and more.

Eve Agent Runtime

Skill directories are portable agent capabilities. Coding agents can read, edit, validate, and run recipes through the same CLI.

Web Studio

The creator studio at /studio gives a chat-style interface to run and iterate on Zaps without touching the command line.

Build docs developers (and LLMs) love

Get started for freeTalk to us