{{PROJECT_DISPLAY_NAME}}

{{ONE_LINE_PITCH — the benefit for the reader, not how it works}}

{{TWO_LINE_DESCRIPTION — what the tool is, what it analyses, and what it does not need (e.g. no instrumentation, no test run)}}

Quick start · {{FEATURES_SHORT_TITLE}} · CI · How it works · Docs

---

See it in action

{{EXAMPLE_INPUT_CODE}}

$ {{BINARY_NAME}} {{EXAMPLE_FILE}} {{EXAMPLE_FLAGS}}

{{EXAMPLE_OUTPUT}}

{{OUTPUT_FORMATS_SENTENCE — e.g. "The same report is available as JSON and SARIF, so it lands directly in GitHub Code Scanning."}}

Quick start

With Docker — nothing to install but a container runtime:

docker run --rm -v "$PWD:/work" \
  {{DOCKER_IMAGE}}:{{VERSION_TAG}} {{EXAMPLE_FILE}} {{EXAMPLE_FLAGS}}

On a whole project — {{PROJECT_MODE_SENTENCE}}:

{{BINARY_NAME}} {{PROJECT_MODE_FLAGS}}

From source ({{TOOLCHAIN_REQUIREMENTS}}) — see Building.

What it catches

Rule	{{RULE_FLAG}}	Catches
{{RULE_1_NAME}}	{{RULE_1_ID}}	{{RULE_1_SUMMARY}}
{{RULE_2_NAME}}	{{RULE_2_ID}}	{{RULE_2_SUMMARY}}
{{RULE_3_NAME}}	{{RULE_3_ID}}	{{RULE_3_SUMMARY}}
{{...}}	{{...}}	{{...}}

{{DEFAULT_RULES_SENTENCE — e.g. "All rules run by default."}} Each one documents what it proves and what it deliberately does not in docs/rules.md.

In CI

permissions:
  contents: read
  security-events: write   # for the Code Scanning upload

steps:
  - uses: actions/checkout@v4
  - uses: {{GITHUB_ORG}}/{{REPO_NAME}}@{{ACTION_MAJOR_TAG}}
    with:
      {{ACTION_INPUT_1}}: {{ACTION_VALUE_1}}
      fail-on: error

{{CI_PARAGRAPH — how the action runs, what it uploads, and the exit-code contract (found something vs could not analyze).}} Full guide: docs/github-action.md.

How it works

{{PIPELINE_ASCII_DIAGRAM — input ──▶ stage ──▶ stage ──▶ output}}

{{HOW_IT_WORKS_PARAGRAPH — one or two key design choices and why.}}

Known limits — {{KNOWN_LIMITS — the one or two gaps a user is most likely to hit.}} Details in docs/rules.md.

Use it as a library

{{MINIMAL_API_EXAMPLE — 5 to 10 lines}}

Embed it with CMake FetchContent (tag {{VERSION_TAG}}); a complete consumer lives in {{CONSUMER_EXAMPLE_DIR}}/. API reference: docs/api.md.

Building

{{BUILD_COMMANDS}}
{{TEST_COMMAND}}

Documentation

Rules & limits	{{DOC_RULES_SUMMARY}}
CLI reference	{{DOC_CLI_SUMMARY}}
GitHub Action	{{DOC_ACTION_SUMMARY}}
Architecture	{{DOC_ARCHITECTURE_SUMMARY}}
{{EXTRA_DOC_TITLE}}	{{EXTRA_DOC_SUMMARY}}

Contributing

Issues and PRs welcome — see CONTRIBUTING.md. Part of the CoreTrace toolset, alongside {{SIBLING_PROJECT_LINKS}}.

Licensed under {{LICENSE_NAME}}.