templ.js

Command Overview

templjs provides three primary commands:

• render
• validate
• init

Global flags:

• -h, --help: show usage/help text
• --version: print the CLI version
• -q, --quiet: suppress non-error output
• -v, --verbose: print diagnostic details
• --json: machine-readable output envelopes

Architecture

• CLI command registration and output-policy wiring: src/packages/cli/src/cli.ts
• ADRs:
  • ADR 005: Monorepo
  • ADR 006: Testing Strategy

render

Implementation:

• Command registration/action: src/packages/cli/src/cli.ts
• Command implementation: src/packages/cli/src/commands/render.ts

templjs render --template <path> --input <path|-> [options]

Options:

• -t, --template <path>
• -i, --input <path>
• -o, --output <path>
• -w, --watch
• --input-format <json|yaml|toml|xml>
• --output-format <text|json|html|markdown>
• --experimental-stream-json
• --no-validate-input
• --no-validate-output

Watch mode behavior:

• --json --watch emits JSON envelopes for each render/error event.
• --quiet --watch suppresses non-error output.
• --verbose --watch keeps diagnostic logging enabled.

validate

Implementation:

• Command registration/action: src/packages/cli/src/cli.ts
• Command implementation: src/packages/cli/src/commands/validate.ts

templjs validate --template <path> [--schema <path>] [--input <path>]

init

Implementation:

• Command registration/action: src/packages/cli/src/cli.ts
• Command implementation: src/packages/cli/src/commands/init.ts

templjs init --format <markdown|html|json|yaml> [--output <path>]

Examples

Implementation jump points:

• CLI entrypoint and option handling: src/packages/cli/src/cli.ts
• Render command behavior (including watch mode): src/packages/cli/src/commands/render.ts

Render to stdout:

templjs render -t examples/markdown-report/template.md.templ -i examples/markdown-report/data.json

Render to file:

templjs render -t template.md.templ -i data.json -o out.md

Watch mode JSON output:

templjs --json render -t template.md.templ -i data.json --watch

This site is open source. Improve this page.