> For the complete documentation index, see [llms.txt](https://docs.safetycli.com/safety-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.safetycli.com/safety-docs/output/json-output.md).
# 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
```
### 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.safetycli.com/safety-docs/output/json-output.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.
