seriatim/examples/README.md

Examples

These are small synthetic, copyable example assets for the implemented CLI commands. This directory is the canonical examples home for documentation.

Merge example

Inputs:

• minimal-merge/input-alice.json
• minimal-merge/input-bob.json
• minimal-merge/speakers.yml

Run:

go run ./cmd/seriatim merge \
  --input-file examples/minimal-merge/input-alice.json \
  --input-file examples/minimal-merge/input-bob.json \
  --speakers examples/minimal-merge/speakers.yml \
  --output-file /tmp/seriatim-example-merge.json

Normalize examples

Object-with-segments input:

go run ./cmd/seriatim normalize \
  --input-file examples/normalize/object-with-segments.json \
  --output-file /tmp/seriatim-example-normalize-object.json

Bare-array input:

go run ./cmd/seriatim normalize \
  --input-file examples/normalize/bare-segments-array.json \
  --output-file /tmp/seriatim-example-normalize-array.json

Trim example

Input artifact:

• trim/input-full.json

Run:

go run ./cmd/seriatim trim \
  --input-file examples/trim/input-full.json \
  --output-file /tmp/seriatim-example-trim.json \
  --keep "1-2"

Render example

Input artifact:

• render/input-intermediate.json

Expected Markdown output shape:

• render/output-markdown.md

Run:

go run ./cmd/seriatim render \
  --input-file examples/render/input-intermediate.json \
  --output-file /tmp/seriatim-example-render.md \
  --format markdown

YAML rule examples

• speakers.yml
• autocorrect.yml