Github Reviewer Quickstart
This guide will help you set up the Zenable Github Reviewer in your local IDE (Cursor or Windsurf).
End-user installation
Install your Github Reviewer here: Github Reviewer
Configuration
You can configure our tool using either TOML or YAML format. To do so, create a file named zenable_config.toml
or zenable_config.yaml
in any directory of your repository.
TOML Example:
YAML Example:
Both formats are supported—choose the one that best fits your workflow.
Available options
skip_filenames
: List of filenames to skip. This is a list of filenames, not a glob pattern.
Troubleshooting
If you’re having issues with the Github Reviewer, try the following:
-
Check that you only have one configuration file in your repository, either
zenable_config.toml
orzenable_config.yaml
. If you have multiple in different directories, the Github Reviewer will fail to load the configuration and will use the default configuration. -
Check that the file its a valid TOML or YAML file and that the structure is correct.