receipt-md usage

Synopsis

receipt-md 1.00 (1.0.0)

Usage:
  receipt-md [options] <title> <pass|fail> [file]
  receipt-md --title <title> --pass|--fail [--note text] [--out file]

Write a markdown receipt:
  # <title>
  - timestamp: <ISO>
  - result: PASS|FAIL
  - note: ...   (optional, repeatable)

Default file: ./RECEIPT.md
Exit 0 on PASS, 1 on FAIL (the file is still written).

Options:
  -h, --help         Show this help and exit 0
  -V, -v, --version  Print 1.0.0 and exit 0
  --title <text>     Receipt title
  --pass / --fail    Result (aliases: pass|ok|true|1 and fail|false|0)
  --note <text>      Extra note line (repeatable)
  --out <file>       Output markdown path
  --json             Also write a JSON sidecar next to the markdown
                     (and print JSON to stdout)

Examples:
  receipt-md "CI" pass
  receipt-md --title e2e --fail --note "timeout" --out ./artifacts/RECEIPT.md
  receipt-md "build" pass --json

Tip: receipt-md --help and -h print this text. receipt-md --version and -V print 1.0.0.

Flags and arguments

The complete flag list is in receipt-md --help (shown above). Human output is the default; pass --json where supported.

Exit codes

Code	Meaning
`0`	PASS receipt written.
`1`	FAIL receipt written, or usage error. The markdown is still written on FAIL.

Configuration

Default file is `./RECEIPT.md`. `--json` also writes a JSON sidecar.

Worked examples

Success path

Write a PASS receipt.

receipt-md "CI" pass

/abs/RECEIPT.md

Failure path

FAIL receipts are still written; the process exits 1.

receipt-md --title e2e --fail --note timeout --out ./artifacts/RECEIPT.md

./artifacts/RECEIPT.md

Exit code is 1.