Skip to content

checkov-docs/checkov-docs

Repository files navigation

ci codeql codecov Go Reference Go Report Card

checkov-docs

Generate documentation from checkov results.

Features

  • Generate Markdown table of checkov skipped results.
  • Supported formats: json.

Installation

brew install checkov-docs/tap/checkov-docs

Usage

To generate markdown table of checkov skipped rules, run the following command:

checkov-docs -i path/to/input/file -o path/to/output/file

Compatibility

This project follows the Go support policy. Only two latest major releases of Go are supported by the project.

Currently, that means Go 1.19 or later must be used when developing or testing code.

Credits

This project is inspired by terraform-docs.

License

MIT License