Language / Framework: Ruby/Rails
Checks: 59
Categories: Security
Brakeman version 4.3.1

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

🚧

• Due to the acquisition of Brakeman, we're currently not able to upgrade our OSS Brakeman plugin to use Brakeman's latest version.

• Brakeman has asked that we direct all feedback around this issue to [email protected]. They'll be able to provide some further context on when we'll be able to update the Brakeman plugin on codeclimate.com.

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

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.