tiulpin/termbook
Build a termbook gallery, or diff committed captures against fresh ones.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| mode | "build" renders gallery.html. "diff" re-records every screen and compares against the captures committed at git HEAD. | no | build |
| version | termbook version to install. "latest" picks the most recent release; a tag like "v0.3.0" pins; "source" builds from cmd/termbook in the checked-out repo. | no | latest |
| source-path | Path to cmd/termbook when version=source. Relative to the workflow's working directory. | no | ./cmd/termbook |
| output | Path to write the generated gallery HTML to (build mode). | no | gallery.html |
| only | Render only the screen with this id (build mode). | no | — |
| working-directory | Directory containing .termbook/termbook.yml. | no | . |
| baseline | Directory of <id>.ansi files to diff against (diff mode). Mutually exclusive with baseline-ref. | no | — |
| baseline-ref | Git ref to diff against (e.g. main). Defaults to HEAD. Use the PR base ref for "what changed in this PR" workflows. | no | — |
| report-md | Markdown report path (diff mode). Designed for `gh pr comment --body-file`. | no | termbook-diff.md |
| report-html | Optional HTML report path (diff mode). Empty disables. | no | "" |
| fail-on-change | When "true" (default), diff mode exits non-zero on any change. Set to "false" to keep going so a later step can post the report. | no | true |
Outputs
| name | description |
|---|---|
| output | Path of the generated gallery HTML (build mode). |
| report-md | Path of the Markdown diff report (diff mode). |
| report-html | Path of the HTML diff report (diff mode), if requested. |
| changed | "true" when diff mode found at least one modified, added, or removed screen. |