Output formats

b8e scan and b8e ci render findings in one of four formats via --format. Each example below is a captured render of the same single finding.

Format	Use
pretty	Human-readable table (default).
json	The canonical wire payload for tooling.
sarif	SARIF 2.1.0 for code-scanning upload.
github	GitHub Actions workflow-command annotations.

--format pretty

binclusive scan — 1 file(s) under src, 1 finding(s)

components/Logo.tsx
  12:image-alt — Images must have alternate text

--format json

{
  "findings": [
    {
      "provenance": "deterministic",
      "location": {
        "kind": "source",
        "path": "src/components/Logo.tsx",
        "lineHash": "d41d8cd98f00b204e9800998ecf8427e",
        "index": 0
      },
      "criterion": "1.1.1",
      "element": "image-alt",
      "evidence": "Images must have alternate text",
      "platform": "web",
      "scope": "src"
    }
  ]
}

--format sarif

{
  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/main/sarif-2.1/schema/sarif-schema-2.1.0.json",
  "version": "2.1.0",
  "runs": [
    {
      "tool": {
        "driver": {
          "name": "Binclusive",
          "version": "1.0.0",
          "informationUri": "https://binclusive.io",
          "rules": [
            {
              "id": "image-alt",
              "shortDescription": {
                "text": "Images must have alternate text"
              },
              "helpUri": "https://binclusive.io/rules/image-alt"
            }
          ]
        }
      },
      "results": [
        {
          "ruleId": "image-alt",
          "level": "warning",
          "message": {
            "text": "Images must have alternate text\n\nImpact: \n\nRecommendation: "
          },
          "locations": [
            {
              "physicalLocation": {
                "artifactLocation": {
                  "uri": "components/Logo.tsx"
                },
                "region": {
                  "startLine": 12
                }
              }
            }
          ]
        }
      ],
      "automationDetails": {
        "id": "binclusive-audit/binclusive-scan"
      }
    }
  ]
}

--format github

::warning file=components/Logo.tsx,line=12,title=image-alt::Images must have alternate text