audit Verified current stable Not installed? Package Management

Audit / Generate Security Report Json

Generate Security Report Json

Generates a JSON format security audit report using PNPM.

$
Terminal
pnpm audit --json > <path/to/audit-report.json>

When To Use

During routine security compliance checks or before a production release.

Pro Tip

Use the `--silent` flag to suppress output to the console and only write JSON to the file, avoiding clutter in your terminal.

Command Result

What happens when it runs

Shell behavior

Primary Effect

Writes to file. The command sends content into the output file instead of printing the final result to the terminal.

Terminal Expectation

A successful run is usually quiet. Verify the destination file after execution rather than expecting visible stdout.

Troubleshooting

Common pitfalls

One of the input files does not exist

Solution: Check each input path before running the command.

The destination file or directory is not writable

Solution: Verify write permissions on the target path and parent directory.

Shell redirection points to the wrong file

Solution: Double-check the output path before executing, especially when overwriting with >.

Command Breakdown

What each part is doing

pnpm
Base Command
The executable that performs this operation. Here it runs Audit before the shell applies any redirect operators.
--json
Command Option
Tool-specific option used by this command invocation.
>
Output Redirection
Writes the command output to the output file, replacing any existing content.
<path/to/audit-report.json>
Destination Path
The file that receives the final written output.

Alternative Approaches

Comparable commands in other tools

Alternative package management tools for the same job.