# Producing reports

The client can directly generate a few reports: these parameters are used to select which reports should be generated and, in some cases, what they should contain.

**`--report-json`**\
Produces a JSON report file of the analysis  (machine-readable)\
Example: **`--report-json=~/report.json`**

**`--report-pdf`**\
Produces a PDF report file of the analysis (human-readable)\
Example: **`--report-pdf=~/report.pdf`**

**`--report-junit`**\
Produces a Junit XML report file of the analysis (machine-readable)\
Example: **`--report-junit=~/report.xml`**

**`--report-console`**\
Emits  an analysis report on the console, a list of options separated by comma should be specified:\
\- color: enable colored output\
\- nocolor: disable colors and enhanced formatting (used on CI with bare-bone consoles)\
\- security: shows the security section\
\- stability; shows the stability section\
\- licensing: shows the licensing section \
Default: color if supported, includes all the sections\
Example: **`--report-console=nocolor,security,licensing`**

**`--report-threadfix`**\
Produces a report file compatible with the Threadfix format. See [the specific section](/management-platforms/threadfix.md) for further details.

**`--report-sbom`**\
Produces a SBOM report, the format is defined based on the extension of the file:

* .json - a standard licensing bible report, JSON format
* .pdf - a standard licensing bible report, PDF format
* .csv - a standard SBOM Meterian report, CSV format
* .cdx.xml - a standard CycloneDX SBOM report, XML format
* .cdx.json - a standard CycloneDX SBOM report, JSON format

Example: **`--report-sbom=sbom.cdx.xml`**

It's also possible to request multiple reports, separating the file names with a comma.

Example: **`--report-sbom=sbom.cdx.xml,bible.pdf`**

**`--report-gitlab`**\
Produces a gitlab-compatible report to be used with [GitLab Ultimate](/devops-integrations/gitlab-ultimate.md)\
Example: **`--report-gitlab=gitlab.json`**

**`--report-sarif`**\
Produces a SARIF report with the results from the analysis.\
Example: **`--report-sarif=report.sarif`**


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.meterian.io/the-client/command-line-parameters/producing-reports.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
