Skip to content
Get Started

CLI Reference

Start a development server with hot reload:

Terminal window
zebric dev --blueprint blueprint.toml --port 3000 --seed
FlagDefaultDescription
-b, --blueprint <path>blueprint.jsonPath to blueprint file
-p, --port <number>3000Port to listen on
-h, --host <host>localhostHost to bind to
--seed—Seed database with sample data

Validate a blueprint without starting the engine:

Terminal window
zebric validate --blueprint blueprint.toml

Returns validation errors and warnings without starting a server. Useful for CI checks.

VariableDescription
SLACK_BOT_TOKENSlack bot token (for Slack notification adapter)
SLACK_SIGNING_SECRETSlack webhook signing secret

API key environment variables are defined per key in [[auth.apiKeys]] using the keyEnv field.

zebric dev takes its host, port, and Blueprint path from command-line flags; it does not read HOST or PORT.

The lower-level zebric-engine binary additionally reads:

VariableDescription
DATABASE_URLSQLite or PostgreSQL connection URL
ZEBRIC_RATE_LIMIT_MAXMaximum requests in one rate-limit window
ZEBRIC_RATE_LIMIT_WINDOW_MSRate-limit window length in milliseconds

zebric-engine defaults to --host 0.0.0.0, while zebric dev defaults to localhost.

Run the repository’s internal Big Zebra benchmark harness. This command forwards remaining arguments to benchmark/cli.mjs in the current workspace and is intended for Zebric contributors rather than application deployment.

Run integration tests for example blueprints:

Terminal window
pnpm --filter @zebric/framework-stories test

Stories validate that blueprint parsing, page routing, form configuration, workflow wiring, and notification setup all remain correct.

Parse and validate a Blueprint without a model or running application:

Terminal window
zebric-agent validate [blueprint] [--workspace <root>] [--json]

The Blueprint defaults to blueprint.toml, and the workspace defaults to the current directory. The resolved path must remain inside the workspace.

Run one non-interactive agent task:

Terminal window
zebric-agent run \
--prompt <text> \
--model <provider:model> \
[--connect <url>] \
[--credential-env <name>] \
[--workspace <root>] \
[--approve-operation <operation-id>] \
[--run-id <id>] \
[--json]

--approve-operation may be repeated and requires --connect. Mutations whose exact operation ID is absent are rejected locally. --run-id requires an approved operation and contributes to deterministic idempotency keys. --credential-env names an environment variable; it never accepts the credential value directly.

With --json, success and failure are written as one JSON object. Configured application credentials are redacted from both output paths.

CodeCategory
0Success
1Internal error
2Invalid CLI or agent configuration
3Blueprint validation failure
4Mutation approval rejected
5Authentication or authorization failure
6State or idempotency conflict
7Incomplete execution, such as job observation timeout

See Get Started with Zebric Agent for a complete read-only invocation.