Download
Simple CLI wrapper for CodeGuru reviewer that provides a one-line command to scan a local clone of a repository and receive results. This CLI wraps the AWS CLI commands to communicate with AWS CodeGuru Reviewer. Using CodeGuru Reviewer may generate metering fees in your AWS account. See the CodeGuru Reviewer pricing for details. To run the CLI, we need to have a version of git, Java (e.g., Amazon Corretto) and the AWS Command Line interface installed. Verify that both applications are installed on our machine. We will also need working credentials on our machine to interact with our AWS account. You can always use the CLI with Admin credentials but if you want to have a specific role to use the CLI, your credentials must have the provided permissions. You can provide your own bucket name using the --bucket-name option. Note that, currently, CodeGuru Reviewer only supports bucket names that start with the prefix codeguru-reviewer- out of the box.
Features
- You can analyze a repository by providing the KMS key ID
- Searches for a file named .codeguru-ignore.yml where users can specify criteria based on which recommendations should be suppressed
- Suppressed recommendations will not be returned by the CLI, but still show up in the AWS console
- Only the version field is mandatory in the .codeguru-ignore.yml file
- You can use this CLI to run CodeGuru from inside your CI/CD pipeline
- To build the project, you need Java 8 or later
Project Samples
