{"loggedIn":false,"search":{"token":"NmM0OGIzNTRjYzg2YzZjZGY1Zjk3M2Q0MTRiZjU0Mjk4NjZhZTBhZjNkNWRhMzcxZjJiYmJiZTlmMjgwM2IxYXRhZ0ZpbHRlcnM9cHJvamVjdDo1N2UxNzIzNTQ2M2E5MTIwMDA2ZDZlN2QsKGhpZGRlbjpub25lLGhpZGRlbjpmYWxzZSksKHZlcnNpb246bm9uZSx2ZXJzaW9uOjU3ZTE3MjM1NDYzYTkxMjAwMDZkNmU3Zik=","filters":"tagFilters=project:57e17235463a9120006d6e7d,(hidden:none,hidden:false),(version:none,version:57e17235463a9120006d6e7f)","app":"T28YKFATPY","modules":{"landing":true,"docs":true,"examples":true,"reference":false,"blog":false,"discuss":false,"suggested_edits":true}}}

Code Climate

  • Documentation
  • Contact Support

    • Need help?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.0HomeDocumentationReferenceReferenceAnnouncementsSupportPage Not FoundSearch{{state.current().params.custompage}}
      HomeDocumentation
    {{ showTitle() }}
    discard

    Search results for "{{ search.query }}"

    No results found for "{{search.query}}".
    • Guide

      Guide

      {{result.type}}Reference

      Announcement

      Support

      Page

    View All Results

    Getting Started

    • Adding your first repo
      • Configuring Your Analysis
        • Adding Code Climate to Your Workflow
          • Setting Up Test Coverage
            • Introducing Code Climate to your team

              Working with Repositories

              • Importing a Repository
                • Removing a Repository
                  • Feed
                    • Code
                      • Issues
                        • Branches & Comparisons
                          • Trends
                            • Open Source (Free)
                              • Repository Settings

                                Analysis Configuration

                                • Switching to engines-based analysis
                                  • Available Analysis Engines
                                    • Configuring Your Code Climate Analysis
                                      • Ratings and GPA's
                                        • Excluding Files and Folders
                                          • Disabling Individual Engines
                                            • Disabling Individual Checks
                                              • Marking False Positives
                                                • Example .codeclimate.yml
                                                  • Default Analysis Configuration
                                                    • Engine Channels
                                                      • Setting Up Test Coverage
                                                        • Configuring The Prepare Step

                                                          Analysis Concepts

                                                          • Churn
                                                            • Cyclomatic Complexity
                                                              • Duplication

                                                                Integrations

                                                                • Asana
                                                                  • Beanstalk
                                                                    • Bitbucket
                                                                      • Bitbucket Pipelines
                                                                        • Campfire
                                                                          • Flowdock
                                                                            • GitHub
                                                                              • GitLab
                                                                                • JIRA
                                                                                  • HipChat
                                                                                    • Lighthouse
                                                                                      • Pivotal Tracker
                                                                                        • Slack

                                                                                          User Settings

                                                                                          • Enabling Two-Factor Authentication
                                                                                            • Linking/Unlinking Your GitHub User
                                                                                              • Email Notifications
                                                                                                • Changing Your Email Address
                                                                                                  • Changing your Profile Picture
                                                                                                    • Deleting Your User
                                                                                                      • Setting GitHub OAuth Permission Levels

                                                                                                        Organizations and Teams

                                                                                                        • Organization Settings
                                                                                                          • Invite Team Members
                                                                                                            • Managing Your Teams
                                                                                                              • Starting and Managing Per-User Subscriptions
                                                                                                                • Managing Invoices
                                                                                                                  • Billing FAQ
                                                                                                                    • Deleting Your Organization

                                                                                                                      Related Tools

                                                                                                                      • Browser Extension
                                                                                                                        • Command Line Interface (CLI)
                                                                                                                          • Atom Package
                                                                                                                            • Vim Plugin
                                                                                                                              • Code Climate API

                                                                                                                                Enterprise (On-premise)

                                                                                                                                • Code Climate: Enterprise Basics
                                                                                                                                  • Installation
                                                                                                                                    • Authorization Settings
                                                                                                                                      • Public Organizations
                                                                                                                                        • Analysis Settings
                                                                                                                                          • Setting Up Test Coverage
                                                                                                                                            • GitHub: Integration
                                                                                                                                              • GitHub: Creating a Code Climate GitHub Client Application
                                                                                                                                                • Atlassian Stash: Post-Receive Hooks
                                                                                                                                                  • Atlassian Stash: Pull Requests
                                                                                                                                                    • Maintenance Mode (Pausing Analysis)
                                                                                                                                                      • Release Urgency Levels
                                                                                                                                                        • VMWare Installation
                                                                                                                                                          • Enterprise API
                                                                                                                                                            • Code Climate Enterprise Glossary
                                                                                                                                                              • Self-Signed Certificates
                                                                                                                                                                • Browser Extension Configuration

                                                                                                                                                                  FAQ & Troubleshooting

                                                                                                                                                                  • Analysis Error Codes
                                                                                                                                                                    • Code Analysis Not Available
                                                                                                                                                                      • Code Climate Glossary
                                                                                                                                                                        • Code Climate lost connection to my repository.
                                                                                                                                                                          • Fixing branches and pull requests
                                                                                                                                                                            • How Grades are Calculated
                                                                                                                                                                              • I'm seeing a 422 Permission error!
                                                                                                                                                                                • I'm seeing a 403 Permission error!
                                                                                                                                                                                  • Missing Settings Link
                                                                                                                                                                                    • My Git server is behind a firewall. Can I use Code Climate?
                                                                                                                                                                                      • My repository isn't listed when I try to add it to Code Climate.
                                                                                                                                                                                        • Test Coverage Troubleshooting Tips
                                                                                                                                                                                          • The first analysis of my repository errored
                                                                                                                                                                                            • Troubleshooting Engine Timeouts
                                                                                                                                                                                              • 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?
                                                                                                                                                                                                    • Approve Code Climate as a third-party application in GitHub
                                                                                                                                                                                                      • FAQ

                                                                                                                                                                                                        Engines

                                                                                                                                                                                                        • ApexMetrics
                                                                                                                                                                                                          • Brakeman OSS
                                                                                                                                                                                                            • Brakeman Pro
                                                                                                                                                                                                              • Bundler-Audit
                                                                                                                                                                                                                • Checkstyle
                                                                                                                                                                                                                  • CoffeeLint
                                                                                                                                                                                                                    • Credo
                                                                                                                                                                                                                      • CSSLint
                                                                                                                                                                                                                        • Duplication
                                                                                                                                                                                                                          • ember-watson
                                                                                                                                                                                                                            • ESLint
                                                                                                                                                                                                                              • FIXME
                                                                                                                                                                                                                                • Foodcritic
                                                                                                                                                                                                                                  • GNU Complexity
                                                                                                                                                                                                                                    • gofmt
                                                                                                                                                                                                                                      • golint
                                                                                                                                                                                                                                        • govet
                                                                                                                                                                                                                                          • Haxe Checkstyle
                                                                                                                                                                                                                                            • hlint
                                                                                                                                                                                                                                              • kibit
                                                                                                                                                                                                                                                • markdownlint
                                                                                                                                                                                                                                                  • Node Security Project (nsp)
                                                                                                                                                                                                                                                    • pep8
                                                                                                                                                                                                                                                      • Phan
                                                                                                                                                                                                                                                        • PHP Code Sniffer
                                                                                                                                                                                                                                                          • PHP Mess Detector
                                                                                                                                                                                                                                                            • PMD
                                                                                                                                                                                                                                                              • Radon
                                                                                                                                                                                                                                                                • Reek
                                                                                                                                                                                                                                                                  • RuboCop
                                                                                                                                                                                                                                                                    • RubyMotion
                                                                                                                                                                                                                                                                      • SCSS Lint
                                                                                                                                                                                                                                                                        • ShellCheck
                                                                                                                                                                                                                                                                          • Stylelint
                                                                                                                                                                                                                                                                            • Tailor
                                                                                                                                                                                                                                                                              • Vint
                                                                                                                                                                                                                                                                                • Flog

                                                                                                                                                                                                                                                                                  Test Reporters

                                                                                                                                                                                                                                                                                  • Ruby
                                                                                                                                                                                                                                                                                    • JavaScript
                                                                                                                                                                                                                                                                                      • PHP
                                                                                                                                                                                                                                                                                        • Python
                                                                                                                                                                                                                                                                                          • Travis CI Ruby Test Coverage
                                                                                                                                                                                                                                                                                            • Travis CI JavaScript Test Coverage
                                                                                                                                                                                                                                                                                              • Travis CI PHP Test Coverage
                                                                                                                                                                                                                                                                                                • Travis CI Python 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 thisEnable it for everyone

                                                                                                                                                                                                                                                                                                        Recent Posts

                                                                                                                                                                                                                                                                                                        • Welcome to Code Climate Platform

                                                                                                                                                                                                                                                                                                        Archive

                                                                                                                                                                                                                                                                                                        • November 2015 (1)

                                                                                                                                                                                                                                                                                                        Getting Started

                                                                                                                                                                                                                                                                                                        • Adding your first repo
                                                                                                                                                                                                                                                                                                        • Configuring Your Analysis
                                                                                                                                                                                                                                                                                                        • Adding Code Climate to Your Workflow
                                                                                                                                                                                                                                                                                                        View All 5

                                                                                                                                                                                                                                                                                                        Working with Repositories

                                                                                                                                                                                                                                                                                                        • Importing a Repository
                                                                                                                                                                                                                                                                                                        • Removing a Repository
                                                                                                                                                                                                                                                                                                        • Feed
                                                                                                                                                                                                                                                                                                        View All 9

                                                                                                                                                                                                                                                                                                        Analysis Configuration

                                                                                                                                                                                                                                                                                                        • Switching to engines-based analysis
                                                                                                                                                                                                                                                                                                        • Available Analysis Engines
                                                                                                                                                                                                                                                                                                        • Configuring Your Code Climate Analysis
                                                                                                                                                                                                                                                                                                        View All 13

                                                                                                                                                                                                                                                                                                        Analysis Concepts

                                                                                                                                                                                                                                                                                                        • Churn
                                                                                                                                                                                                                                                                                                        • Cyclomatic Complexity
                                                                                                                                                                                                                                                                                                        • Duplication

                                                                                                                                                                                                                                                                                                        Integrations

                                                                                                                                                                                                                                                                                                        • Asana
                                                                                                                                                                                                                                                                                                        • Beanstalk
                                                                                                                                                                                                                                                                                                        • Bitbucket
                                                                                                                                                                                                                                                                                                        View All 13

                                                                                                                                                                                                                                                                                                        User Settings

                                                                                                                                                                                                                                                                                                        • Enabling Two-Factor Authentication
                                                                                                                                                                                                                                                                                                        • Linking/Unlinking Your GitHub User
                                                                                                                                                                                                                                                                                                        • Email Notifications
                                                                                                                                                                                                                                                                                                        View All 7

                                                                                                                                                                                                                                                                                                        Organizations and Teams

                                                                                                                                                                                                                                                                                                        • Organization Settings
                                                                                                                                                                                                                                                                                                        • Invite Team Members
                                                                                                                                                                                                                                                                                                        • Managing Your Teams
                                                                                                                                                                                                                                                                                                        View All 7

                                                                                                                                                                                                                                                                                                        Related Tools

                                                                                                                                                                                                                                                                                                        • Browser Extension
                                                                                                                                                                                                                                                                                                        • Command Line Interface (CLI)
                                                                                                                                                                                                                                                                                                        • Atom Package
                                                                                                                                                                                                                                                                                                        View All 5

                                                                                                                                                                                                                                                                                                        Enterprise (On-premise)

                                                                                                                                                                                                                                                                                                        • Code Climate: Enterprise Basics
                                                                                                                                                                                                                                                                                                        • Installation
                                                                                                                                                                                                                                                                                                        • Authorization Settings
                                                                                                                                                                                                                                                                                                        View All 17

                                                                                                                                                                                                                                                                                                        FAQ & Troubleshooting

                                                                                                                                                                                                                                                                                                        • Analysis Error Codes
                                                                                                                                                                                                                                                                                                        • Code Analysis Not Available
                                                                                                                                                                                                                                                                                                        • Code Climate Glossary
                                                                                                                                                                                                                                                                                                        View All 19

                                                                                                                                                                                                                                                                                                        Engines

                                                                                                                                                                                                                                                                                                        • ApexMetrics
                                                                                                                                                                                                                                                                                                        • Brakeman OSS
                                                                                                                                                                                                                                                                                                        • Brakeman Pro
                                                                                                                                                                                                                                                                                                        View All 37

                                                                                                                                                                                                                                                                                                        Test Reporters

                                                                                                                                                                                                                                                                                                        • Ruby
                                                                                                                                                                                                                                                                                                        • JavaScript
                                                                                                                                                                                                                                                                                                        • PHP
                                                                                                                                                                                                                                                                                                        View All 8

                                                                                                                                                                                                                                                                                                        Code Climate Developer Program

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