# JSON Output

Safety can generate JSON output, useful for parsing and analyzing the results of a scan. To do so, run the following command.

```
safety scan --output json
```

The JSON output is displayed in the terminal, as shown below. To save the JSON output to a file, use the following command, replacint `test.json` with your desired file name.

```
safety scan --output json >test.json
```

<figure><img src="https://1428014516-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0ABDwXSDJWM5juLdc6ie%2Fuploads%2Fgit-blob-18fb430c07713b209bfab803183487b67c4ea00a%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

### JSON structure

The resulting output is a JSON with the following sections:

`meta` contains meta information about the scan, such as timestamps, what was scanned, packages found and vulnerabilities found

`scanned_packages` is an array of packages (and versions) that were found during the scan

`affected_packages` is an array of packages that were found to have relevant vulnerabilities

`vulnerabilities` is an array of vulnerabilities that were found relating to the packages in the scan

`ignored_vulnerabilities` is an array of vulnerabilities that were found but were ignored via a command line argument or the safety policy file.

`remediations` an array of remediation (fix) recommendations for each package with relevant vulnerabilities.

`announcements` an array of announcements (messages) from the Safety team. These are not generally related to the packages of vulnerabilities found, but rather are more general announcements, such as announcing a new version of the Safety scanner.


---

# 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.safetycli.com/safety-docs/output/json-output.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.
