Output Formats

The scan command supports five output formats via --format. The review command supports three formats (text, json, sarif) — see review output formats below.

text (default)

Human-readable output to stderr. A progress bar shows scan progress. Findings include file path and line number.

greengate scan

json

Machine-readable JSON written to stdout. Status messages and progress go to stderr, so you can pipe stdout cleanly.

greengate scan --format json
greengate scan --format json | jq '.findings[] | select(.rule | startswith("SAST"))'

{
  "total": 1,
  "findings": [
    {
      "rule": "SAST/EvalUsage",
      "file": "./src/utils.js",
      "line": 42,
      "severity": "critical"
    }
  ]
}

sarif

SARIF 2.1.0 JSON written to stdout. Upload directly to GitHub Advanced Security for inline PR annotations.

greengate scan --format sarif > results.sarif

In GitHub Actions:

- name: Secret & SAST Scan
  run: greengate scan --format sarif > results.sarif
  continue-on-error: true

- name: Upload SARIF
  uses: github/codeql-action/upload-sarif@v4
  with:
    sarif_file: results.sarif

junit

JUnit XML written to stdout. Compatible with Jenkins, Azure DevOps, CircleCI, and any CI system that consumes JUnit test reports.

greengate scan --format junit > results.xml

Each finding becomes a <testcase> with a <failure> element. The suite name is greengate and the classname is the file path.

In Jenkins:

sh 'greengate scan --format junit > results.xml || true'
junit 'results.xml'

In Azure DevOps:

- script: greengate scan --format junit > results.xml
  continueOnError: true
- task: PublishTestResults@2
  inputs:
    testResultsFormat: JUnit
    testResultsFiles: results.xml

gitlab

GitLab SAST Security Scanner JSON (schema v15.0.6) written to stdout. Upload as a GitLab security artifact to display findings in Merge Request security reports.

greengate scan --format gitlab > gl-sast-report.json

In .gitlab-ci.yml:

secret-scan:
  script:
    - greengate scan --format gitlab > gl-sast-report.json
  artifacts:
    reports:
      sast: gl-sast-report.json

Severity mapping: critical → Critical, high → High, medium → Medium, low → Low.

---

review command formats

The review command outputs PR complexity and new-code coverage gap analysis in three formats.

text (default)

greengate review --base HEAD~1

╔══ PR Review ════════════════════════════════╗
  Complexity Score : 47  (Normal Review ~23 min)
  Files changed    : 5
  Lines added/del  : +120 / -34
  Cyclomatic nodes : 18
╚═════════════════════════════════════════════╝

New-Code Coverage: 73.3%  ✗ (target: 80%)

  src/engine.rs      12/15 added lines covered  (80.0%) ✓
  src/scanner.rs      6/11 added lines covered  (54.5%) ✗
    Uncovered lines: 88, 89, 92, 95, 101

Complexity tiers:

Score	Label
0–20	Quick Review
21–50	Normal Review
51–100	Complex Review
101+	Large PR — consider splitting

json

Machine-readable JSON to stdout.

greengate review --base HEAD~1 --format json | jq .

{
  "complexity": {
    "score": 47,
    "tier": "Normal Review",
    "estimated_review_minutes": 23,
    "files_changed": 5,
    "lines_added": 120,
    "lines_removed": 34,
    "cyclomatic_nodes": 18
  },
  "coverage": {
    "new_code_coverage_pct": 73.3,
    "target_pct": 80.0,
    "covered_lines": 18,
    "uncovered_lines": 7,
    "files": [
      {
        "path": "src/engine.rs",
        "added_lines": 15,
        "covered": 12,
        "uncovered": 3,
        "coverage_pct": 80.0,
        "uncovered_line_numbers": [44, 57, 61]
      }
    ]
  },
  "passed": false
}

sarif

SARIF 2.1.0 with one result per uncovered added line. Rule ID: GG/NewCodeUncovered, severity: warning.

greengate review --base HEAD~1 --format sarif > review.sarif

Upload to GitHub Advanced Security alongside scan SARIF output for unified inline annotations:

- name: PR Review SARIF
  if: github.event_name == 'pull_request'
  run: |
    greengate review \
      --base "${{ github.event.pull_request.base.sha }}" \
      --coverage-file coverage/lcov.info \
      --format sarif > review.sarif || true

- name: Upload Review SARIF
  uses: github/codeql-action/upload-sarif@v3
  with:
    sarif_file: review.sarif
  continue-on-error: true