triad-cli

CLI — command reference

The triad binary (from @triadjs/cli) dispatches to subcommands. Configs are discovered by walking upward from the cwd unless --config is passed.

Top-level flags (work on every subcommand)

Flag	Purpose
-c, --config <path>	Override triad.config.ts path
-r, --router <path>	Override the router file (bypasses config)

The CLI loads the config with jiti, so TypeScript configs work out-of-the-box without a build step.

triad test

Runs every behavior in the router as an in-process test. Also runs channel behaviors.

triad test
triad test --bail
triad test --filter createPet

Flag	Effect
--bail	Stop on first failure
--filter <pattern>	Only run endpoints/channels whose name contains <pattern>

Reads from config: test.setup, test.teardown, test.bail. Exits 1 if any scenario fails or errors.

Common failure modes:

• servicesFactory failed → your test-setup.ts default export throws
• Unrecognized assertion: "..." → your then phrase doesn't match the parser — see the triad-behaviors skill
• Handler returned status N which is not declared → missing entry in responses
• Response body for status N does not match declared schema → handler output doesn't satisfy the declared schema

triad docs

Generates OpenAPI 3.1 from HTTP endpoints. Also writes an AsyncAPI 3.0 sibling file if the router has channels.

triad docs
triad docs --output ./generated/api.yaml
triad docs --format json

Flag	Effect
-o, --output <path>	Output path (default: ./generated/openapi.yaml)
-f, --format <format>	yaml or json (defaults to file extension)

Reads from config: docs.output, docs.format. When channels exist, writes asyncapi.yaml (or .json) beside the OpenAPI file.

Never hand-edit the output. The next triad docs run will blow away your edits. If you need something Triad doesn't model, use the OpenAPI generator's merge option programmatically (see @triadjs/openapi).