YAML

Generate scan results in human-readable YAML format.

Output scan results as YAML. It carries the same data as JSON but the indentation-based format makes it easier to skim.

Usage

noir scan . -f yaml --no-log

Example Output

The structure mirrors the JSON format: an endpoints list with URL, HTTP method, parameters, source code paths, and tags for each entry.

---
endpoints:
- callees: []
  url: /
  method: GET
  internal: false
  details:
    code_paths:
    - path: spec/functional_test/fixtures/crystal/kemal/src/testapp.cr
      line: 3
    technology: crystal_kemal
  protocol: http
  kind: ""
  tags: []
  params:
  - name: x-api-key
    value: ""
    param_type: header
    tags: []
- callees: []
  url: /query
  method: POST
  internal: false
  details:
    code_paths:
    - path: spec/functional_test/fixtures/crystal/kemal/src/testapp.cr
      line: 17
    technology: crystal_kemal
  protocol: http
  kind: ""
  tags: []
  params:
  - name: my_auth
    value: ""
    param_type: cookie
    tags: []
  - name: query
    value: ""
    param_type: form
    tags: []
passive_results: []
errors: []