Code Climate
Documentation (Quality)
Contact Support
Code Climate API
Need help with Code Climate Quality?
Look no further.
01
Adding a Repo
How to sign up and add your first repository.
02
Configuration
Customize your analysis to achieve your goals.
03
Workflow
Working with Code Climate on pull requests and code merges.
04
Test Coverage
Add context to your analysis for a complete health check.
05
Team Onboarding
How to best collaborate on your code quality goals.
Popular Links
Analysis Tools
View supported languages and engines
Browser Extension
View issues and test coverage without leaving GitHub
v1.0
Home
Documentation (Quality)
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Documentation (Quality)
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
Getting Started with Code Climate Quality
Adding Your First Repo
Configuring Your Analysis
Setting Up Test Coverage
Introducing Code Climate to Your Team
Adding Code Climate to Your Workflow
Default Analysis Configuration
Advanced Configuration
Supported Languages for Maintainability
Working with Repositories
Importing a Repository
Removing a Repository
Overview
Progress
Issues
Code
Branches & Comparisons
Trends
Open Source (Free)
Repository Settings
GitHub
GitHub Pull Requests
Linking/Unlinking Your GitHub User
Setting GitHub OAuth Permission Levels
Approve Code Climate as a third-party application in GitHub
My GitHub organization isn't listed when I try to add it to Code Climate.
Analysis Configuration
Available Analysis Plugins
Excluding Files and Folders
Disabling Individual Checks
Plugin Channels
Configuring The Prepare Step
Delegated Analysis Configuration
Analysis Concepts
Churn
Cognitive Complexity
Cyclomatic Complexity
Duplication
Maintainability
Integrations
Asana
Beanstalk
Campfire
Flowdock
GitHub Issues
JIRA
HipChat
Lighthouse
Pivotal Tracker
Slack
User Settings
Enabling Two-Factor Authentication
Email Notifications
Changing Your Email Address
Changing your Profile Picture
Deleting Your User
Resetting your Browser Extension Token
Organizations and Teams
Organization Settings
Invite Team Members
Managing Your Teams
Starting and Managing Per-User Subscriptions
Managing Invoices
Billing FAQ
Deleting Your Organization
Code Climate Permissions by Role
Related Tools
Browser Extension
Code Climate Test Reporter
Code Climate API
Command Line Interface (CLI)
Atom Package
Vim Plugin
API
FAQ & Troubleshooting
My repository isn't listed when I try to add it to Code Climate.
My organization isn't listed when I try to add it to Code Climate.
Missing Settings Link
Analysis Error Codes
Code Analysis Not Available
Code Climate Glossary
Code Climate lost connection to my repository
Fixing branches and pull requests
I'm seeing a 422 Permission error!
I'm seeing a 403 Permission error!
The first analysis of my repository errored
Troubleshooting Plugin Timeouts
Troubleshooting Plugin Memory Exhaustion
What happens after Code Climate runs an analysis?
User with email address already exists
What happens when I change the default branch for a repository?
How are maintainability ratings calculated?
FAQ
I'm seeing a 412 SAML Github protection error!
Plugins
ApexMetrics
Bandit
Brakeman OSS
Bundler-Audit
Checkstyle
CodeNarc
CoffeeLint
Cppcheck
Credo
CSSLint
EditorConfig
ember-watson
ESLint
FIXME
Flog
Foodcritic
git.legal
GNU Complexity
gofmt
golint
govet
Grep
HAML-Lint
Haxe Checkstyle
hlint
kibit
markdownlint
Node Security Project (nsp)
pep8
Phan
PHP Code Sniffer
PHP Mess Detector
PMD
Pylint
Radon
Reek
RuboCop
RubyMotion
Sass Lint
Scalastyle
SCSS Lint
ShellCheck
SonarJava
SonarPHP
SonarPython
Stylelint
SwiftLint
Tailor
Vint
TSLint
Test Reporter
Code Climate Test Reporter
Configuring Test Coverage
Test Coverage Troubleshooting Tips
Test Coverage - Branch Names
My diff-coverage and total-coverage statuses are hanging on my PR
Finding Your Test Coverage ID
Travis CI Test Coverage
Solano CI Test Coverage
CircleCI Test Coverage
Codeship CI Test Coverage
Semaphore CI Test Coverage
Jenkins Test Coverage
GitHub Actions Test Coverage
Code Climate Developer Program
Engine QA Process and Spreadsheet
Code Climate Engine Lifecycle
Building a Code Climate Engine
Support
Only admins can see this
Enable it for everyone
Brakeman OSS
Suggest Edits
Updated 5 months ago
Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}
Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}
Brakeman OSS
Suggested Edits are limited on API Reference Pages
You can only suggest edits to Markdown body content, but not to the API spec.
Updated 5 months ago