Brakeman OSS

⚠️

Code Climate Quality is being replaced with Qlty Cloud

— New users should sign up directly at qlty.sh.
— To migrate an existing account, please see our Migration Guide.

Language / Framework: Ruby/Rails
Checks: 85
Categories: Security
Channels: stable: Brakeman v4.3.1, Brakeman v6.0.1

Brakeman OSS is a static analysis tool which checks Ruby on Rails applications for security vulnerabilities.

Enable the Plugin

To enable Brakeman analysis, add the following to your .codeclimate.yml configuration file:

plugins:
  brakeman:
    enabled: true

More information about the CLI is available in the README here: https://github.com/codeclimate/codeclimate

Brakeman versions

To use a newer version of Brakeman (v6.0.1), specify the brakeman-6-0-1 channel within your .codeclimate.yml configuration file:

plugins:
  brakeman:
    channel: brakeman-6-0-1
    enabled: true

Configure the Plugin

The Brakeman engine supports Brakeman configuration files (and ignore files) as described in the Brakeman documentation.

Sub-Directory Support

🚧

Sub-directory Support

If your application exists in a sub-directory, you can specify the sub-directory as an "app_path" in your config block. For example, if your rails app lives at "app/our_repo/", you would specify the following in your .codeclimate.yml:

plugins:
  brakeman:
    enabled: true
    config:
        app_path: app/our_repo

Understand the Plugin

Consult the official Brakeman documentation for more information about Brakeman analysis.