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.0HomeDocumentation (Quality)RecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
      HomeDocumentation (Quality)
    discard

    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
    • 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
    • Dart Code Metrics [draft]
    • 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
    • Semgrep [draft]

    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

    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
    • 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
    • Dart Code Metrics [draft]
    • 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
    • Semgrep [draft]

    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
    Only admins can see thisEnable it for everyone

    Getting Started with Code Climate Quality

    • Adding Your First Repo
    • Configuring Your Analysis
    • Setting Up Test Coverage
    View All 8

    Working with Repositories

    • Importing a Repository
    • Removing a Repository
    • Overview
    View All 10

    GitHub

    • GitHub Pull Requests
    • Linking/Unlinking Your GitHub User
    • Setting GitHub OAuth Permission Levels
    View All 5

    Analysis Configuration

    • Available Analysis Plugins
    • Excluding Files and Folders
    • Disabling Individual Checks
    View All 6

    Analysis Concepts

    • Churn
    • Cognitive Complexity
    • Cyclomatic Complexity
    View All 5

    Integrations

    • Asana
    • Beanstalk
    • Campfire
    View All 10

    User Settings

    • Enabling Two-Factor Authentication
    • Email Notifications
    • Changing Your Email Address
    View All 6

    Organizations and Teams

    • Organization Settings
    • Invite Team Members
    • Starting and Managing Per-User Subscriptions
    View All 7

    Related Tools

    • Browser Extension
    • Code Climate Test Reporter
    • Code Climate API
    View All 7

    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
    View All 19

    Plugins

    • ApexMetrics
    • Bandit
    • Brakeman OSS
    View All 52

    Test Reporter

    • Code Climate Test Reporter
    • Configuring Test Coverage
    • Test Coverage Troubleshooting Tips
    View All 13

    Code Climate Developer Program

    • Engine QA Process and Spreadsheet
    • Code Climate Engine Lifecycle
    • Building a Code Climate Engine