effortlessmetrics/tokmd
Generate deterministic repo receipts, review summaries, gates, and sensor reports with tokmd
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 4, 2026
- License
- Apache 2.0
Pinned Snippet
uses: effortlessmetrics/tokmd@f5f810eb24de214aee19da2f902bd1a829d2d9d0 # v1.14.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| mode | tokmd mode to run. Omit for the existing module + export flow. Supported values: module, export, gate, cockpit, sensor, baseline, packet. | — | "" |
| version | Version of tokmd to install. Defaults to the latest release. | — | latest |
| paths | Paths to scan | — | . |
| module-roots | Module roots (comma-separated) | — | crates,packages |
| top | Number of rows to show in summary | — | 20 |
| format | Export format (json, jsonl, csv) | — | json |
| base | Base git ref for mode: cockpit or mode: sensor. Omit to infer from pull request base or origin/HEAD. | — | "" |
| head | Head git ref for mode: cockpit or mode: sensor | — | HEAD |
| artifact | Whether to upload generated tokmd files as workflow artifacts | — | true |
| comment | Whether to post the generated Markdown summary as a pull request comment | — | true |
| review-packet | Whether mode: cockpit should emit a review packet directory and prepare a hosted comment copy | — | false |
| preset | Analysis preset for mode: packet (analyze.md / analyze.json). | — | bun-ub |
| output-dir | Output directory for mode: packet artifacts and manifest.json. | — | sensors/tokmd |
| syntax | Whether mode: packet should request optional syntax.json evidence. | — | true |
| context-budget | Token budget for the mode: packet context.md artifact. | — | 64000 |
| fail-on | Failure policy for mode: packet status: failed, partial, or never. | — | failed |
| runtime | Runtime used to obtain tokmd: binary (default) or container. The container runtime anonymously pulls the publication GHCR image and runs it against the mounted workspace; it requires a Linux runner with Docker and is only supported for verification-gated tags (see docs/specs/packet-ghcr-runtime.md). Pin version to a verified tag; mutable tags such as latest are rejected for the container runtime. | — | binary |
| image | Container image reference (without tag) for runtime: container. Defaults to the publication registry. The tag is derived from the version input. Only verification-gated tags are accepted; see docs/specs/packet-ghcr-runtime.md. | — | ghcr.io/effortlessmetrics/tokmd |
Outputs
| name | description |
|---|---|
| receipt | Path to the generated receipt file |
| summary | Path to the generated Markdown summary/comment file |
| gate-verdict | Path to the generated gate verdict JSON file |
| cockpit-report | Path to the generated cockpit report JSON file |
| review-packet | Path to the generated cockpit review packet directory when mode: cockpit and review-packet: true are used |
| sensor-report | Path to the generated sensor report JSON file |
| baseline-report | Path to the generated baseline JSON file |
| packet-status | Evidence packet status from manifest.json for mode: packet (complete, partial, or failed) |
| packet-manifest | Path to the generated evidence packet manifest.json for mode: packet |
| packet-dir | Evidence packet output directory for mode: packet |
| review-priority-count | Count of manifest review_priority entries for mode: packet |
| warnings-count | Count of manifest warnings for mode: packet |
| errors-count | Count of manifest errors for mode: packet |
| artifact-name | Uploaded workflow artifact name when artifact upload is enabled |
| tokmd-version | Version reported by the resolved tokmd runtime binary |