CLI Reference

Dawn ships a single dawn binary with six commands. Every command reads dawn.config.ts from the current working directory and operates on the app rooted there.

dawn check

Validates the app structure and configuration.

dawn check

Checks:

• dawn.config.ts exists and has only supported fields.
• package.json exists.
• Every route has exactly one of workflow, graph, or chain exported from index.ts.
• Every route's state.ts exports a named state type.
• No tool files have invalid shapes.

Exits non-zero on any violation with a detailed message.

dawn routes

Lists every route Dawn discovered and its computed pathname.

dawn routes

Output:

/hello/[tenant]   workflow   src/app/(public)/hello/[tenant]/index.ts
/admin/users      graph      src/app/(internal)/admin/users/index.ts

Use this to confirm that route groups and dynamic segments are being parsed the way you expect.

dawn typegen

Regenerates dawn.generated.d.ts from the current state of every tool file.

dawn typegen

dawn run

Executes a single route invocation with JSON stdin/stdout.

echo '{"tenant":"acme"}' | dawn run '/hello/[tenant]'

Flags:

• --url <url> — run against a live dev server instead of the in-process runtime.
• --stream — use the /runs/stream endpoint (requires --url) and pipe SSE events to stdout.

dawn test

Runs every colocated run.test.ts scenario in the app.

dawn test

Flags:

• --url <url> — run against a live dev server.
• --filter <pattern> — only run scenarios whose describe/test name matches.

Exits non-zero on any failure with a diff per mismatched scenario. See Testing for scenario authoring.

dawn dev

Starts the local runtime — hot reload + LangGraph Platform protocol.

dawn dev --port 3001

Flags:

• --port <n> — HTTP port (default 3000).
• --host <addr> — bind address (default 127.0.0.1).

See Dev Server for the full protocol reference and architecture notes.

Exit codes