Cloud Docs

On-Prem Docs

Community

Step-by-step guides and explanations to help you get started with CodeScene and understand its key features.

Getting Started

3-Step Developer Onboarding Guide

A Strategic 5-Week Onboarding Framework for Engineering Teams seeking to prevent and reduce Technical Debt.

Reducing Technical Debt: CodeScene Rollout Steps that Work

Benefit from AI-acceleration without the risks by transforming AI tools like Github Copilot and Claude from a simple code generator into an engineering partner that understands and protects code quality with this 4-step guide.

Safeguarding AI Generated Code: CodeScene Rollout Steps that Work

A 6-Step Guide for finding the files and functions that once refactored will deliver the greatest return on investment, taking targeted action and proactively mitigating active risks

Guided Workflow for Paying Down Technical Debt

Getting Started Guide For New Users

Getting Started with CodeScene when Your Repositories Are in Azure DevOps

Getting Started with CodeScene when Your Repositories Are in GitHub

Steps for realising quantifiable results from day one

New Customers: CodeScene Mission & Rollout Guide

Guides to help you set up and use CodeScene Cloud - from connecting repositories to configuring integrations and running your first analysis.

Cloud

Step-by-step guides for enabling CodeScene’s Cloud pull request integration with your Git provider - including setup instructions for GitHub, GitLab, Bitbucket, and Azure DevOps.

Setting Up PR Integration

Step-by-step instructions to connect CodeScene Cloud with your project management tool and configure projects, work items, and workflow settings for seamless integration.

Setting Up PM Integration

Instructions for installing, configuring, and managing your self-hosted CodeScene instance - including setup, repository connections, and integrations.

On-premise

Step-by-step guides for enabling CodeScene’s On-premise pull request integration with your Git provider - including setup instructions for GitHub, GitLab, Bitbucket, and Azure DevOps.

Step-by-step instructions to connect CodeScene On-premise with your project management tool and configure projects, work items, and workflow settings for seamless integration.

Setting Up PM Integration 

Getting Started with PDF Reports

Hands-on tutorials and examples to help you deepen your understanding and make the most of CodeScene’s capabilities.

Tutorials

Setting up the Pull Request Integration for Context-Aware Quality Gates

With Custom Code Health rules, you can tailor CodeHealth for YOUR organisation to eliminate noise, focus on what matters in your context, and maintain alignment between code quality metrics and business objectives.
 

How to customize Code Health rules with .codescene/code-health-rules.json

Identify, Visualize, and Manage Technical Debt

Configuration of the PM Integration

4 Factors Dashboard: Filters and Drill Down

CodeScene's Active Authors

Create An Organizational Account

CodeScene Proxy Configuration

Prioritizing Technical Debt with Hotspots

Visualize and Measure the Code Health of Your System

Automated Code Reviews with CodeScene's Pull Request Integration

Fully Automated Code Health Review | Select Code Quality profiles | Quality gates for PRs

Guides for customers using CodeScene MCP Server bundled with a full CodeScene license.

CodeHealth™ MCP server (Suite Edition)

With CodeScene’s MCP Server, your AI becomes more than just a code generator, it becomes a true engineering partner that understands and protects your project’s code quality. Follow these steps to set it up in Visual Studio Code.

Quick Start Guide: Running CodeScene's MCP Server in VS Code

With CodeScene’s MCP Server, your AI becomes more than just a code generator, it becomes a true engineering partner that understands and protects your project’s code quality. Follow these steps to set it up with Claude Code.

Quick Start Guide: Running CodeScene's MCP with Claude Code

Guides for customers that have purchased a CodeHealth™ Single-User MCP license without a full CodeScene license.

CodeHealth™ MCP server (Single-User License)

What is CodeScene Single-User MCP?

Installing CodeScene Single-User MCP

What can CodeScene Single-User MCP do?

Where to find more detailed documentation and get help with CodeScene Single-User MCP

FAQ: CodeScene Single-User MCP

How to reset Single-User MCP access token?

How to start your Single-User MCP free trial and get your access token

How to access and use the Stripe Customer Portal

Helpful guides for using the Cloud version of CodeScene, including setup, configuration, and subscription management.

Subscription

How to Cancel Your CodeScene Cloud Subscription?

How to Update Your Billing and Payment Information?

How to Delete Your CodeScene Account?

What Happens to Your Data and Projects After the CodeScene Trial Ends?

Organizational Accounts

How Can I Share My Account with My Colleagues?

How to Create an Organizational Account?

How to Invite Members to Your Organization?

How To Resolve a 'No Account Found' Issue When Inviting Someone to CodeScene Cloud?

Who Are Collaborators in CodeScene?

Organizational Accounts - FAQs

How to Convert Your Individual Account to an Organizational Account?

How to Analyze Private Repos Owned by the GitHub Organization I'm a Member of?

How to Resolve Organization Access Issues When OAuth App Restrictions Are Enabled?

What Should I do if I Can’t Access CodeScene Cloud After Changing my GitHub Account?

What to Do If You Can’t Be Added to a CodeScene Organization (GitLab)?

Which Git Hosting Providers Does CodeScene Support?

What Are the Project Limitations for CodeScene Cloud Trial Accounts?

How to Resolve Missing Repositories When Adding a Project in CodeScene?

How to Resolve the OAuth Token Error?

How to Re-authorize the CodeScene Repositories Application?

Why Do I Receive an Error When Logging into CodeScene Using Azure AD?

Helpful guides for installing, configuring, and managing the On-premise version of CodeScene.

On-Premise

How to Deploy CodeScene On-prem?

How to Enable OKTA Single Sign-on (SSO)?

How Can I Ensure Smooth Performance of the CodeScene Server?

What Are CodeScene’s Deployment and System Requirements?

What Are the Recommendations for Setting Up an External Database in CodeScene?

What to Check if You Cannot Log in with a New License?

How to Activate an On-Premise License?

How to Configure a Proxy Server for CodeScene?

What to Check When Migrating CodeScene On-Prem Data to a New Machine?

How to Import Analysis Results in CodeScene On-Prem?

What is the Latest On-Prem Version?

Where Can I Find the Logs?

How to Solve the 'No Git Repositories Found Under Your Given Directory' Issue?

How to Resolve an Issue during On-prem Trial Activation?

How Is Offline Mode Used in CodeScene?

How to Add a Self-signed Certificate?

How to Change Admins in CodeScene On-Prem?

How to Resolve Permission Error When Configuring CodeScene?

How to Resolve 'No Valid Cloned Repositories' Error When Using Perforce Instead of Git?

How to Create and Use Personal Access Tokens in CodeScene?

The CodeScene Docker Image: Change of the CodeScene User UID and Group GID

What to Check When Updating a Client's Secret Keys in OAuth2?

How to Resolve an Invalid Email Error During the Account Creation Process?

How to Solve the License Limitations Exceeded Issue?

Why Don't All Users Show Up When Adding Them Under Groups?

How to Resolve Email Report Sending Failures Due to Timeouts?

Why Does CodeScene Request GitHub Access to 'Organizations and Teams' for New Users?

How Does CodeScene Detect Patterns in Code Comments?

How to Set Environment Variables When Using a systemd Service Wrapper for CodeScene?

The most common questions about CodeScene’s setup, configuration, integrations, and analysis results.

FAQs

Guides and answers to the most. common questions regarding the CodeScene MCP Server, IDE extensions and CLI Tool

AI Developer Suite & IDE Extensions

MCP Server

CodeScene ACE

CLI Tool

Visual Studio Code IDE Extension

JetBrains IDE Extension

Project Configuration

What Exclusion Options Are Available in CodeScene?

How does Rule Order Impact Code Health Analysis When Using Multiple Rule Sets in code-health-rules.json file?

Project Management (PM) Integration

What is Considered Unplanned Work?

How to Handle a Timeout Error During PM Analyses?

What to Do When the Ticket ID Pattern Does Not Match Jira Tickets?

What Does the 'Map Commit to Pull Requests Issues' Option Do?

How to Change the Ticket ID Mapping?

Which Information is Retrieved from Jira When PM Integration Is Enabled?

Why Are No Issues Fetched After Setting Up the PM Integration in Azure DevOps?

Teams & Developers

Why Do I Still Not See the Team-Code Alignment Graph After Updating Teams?

How to Reuse the Teams/Developers Configuration?

What Are Team-Code Alignment Scores?

What are Knowledge Distribution Scores?

How To Minimize Developer On & Off-boarding Risks?

What Do the Specific Filters Mean When Organizing Teams and Developers?

How to Resolve the 'Two Developers Mapped to a Single Identity' Issue?

Can I Anonymize Users in CodeScene After They Leave the Company?

How to Handle Authors with Multiple Names in CodeScene?

How is 'author_contributions_fragmentation' Calculated?

Is It Possible to Add Developers to Multiple Teams?

What does the Commit Pattern "none" Mean?

Pull Request (PR) Integration

Azure PR Integration - FAQs

How to Resolve an 'Invalid URL Given' Error in On-Prem GitLab PR Integration?

How to Resolve Access Denied Error While Enabling PR Integration (Azure)? 

What to Do when the PR Integration Fails Due to an Invalid OAuth Token

GitLab PR Integration - FAQs

How to Interpret Delta Analysis Results and Quality Gates in CodeScene?

How to Configure and Use Settings Presets for PR Integration (On-prem)?

How to Disable Email Notifications for PRs?

Best Practices for Working with Pull Requests

How to Change the Git Account Making PR Comments?

What does the Option “Only analyze PRs targeting the branch selected in the project repository configuration” Mean? 

Analysis

Why is My Initial Analysis Taking a Long Time?

How to Analyse Different Branches of the Same Git Repository with CodeScene?

How to Run Analyses in Parallel?

How CodeScene Counts Lines of Code?

How to Find Retrospective Analysis?

How do I trigger an analysis on demand?

REST API

Where to Find the CodeScene REST API Documentation?

How Do I Use CodeScene's REST API On-Prem? 

Code Health

How is Code Health Calculated?

Why does CodeScene Show 'N/A' Code Health Score for Some Files?

How is Code Health for a Team Calculated?

How to Adapt Code Health to Your Coding Standards?

What Are the Different Code Health Scores?

What Are the Examples of Code Health Quality Issues?

What Are the Default Threshold Values for Different Programming Languages?

What Are Organizational Smells in Virtual Code Review?

What Are Configurable Code Duplication Criteria in Custom Code Health?

Code Coverage

How Do I Troubleshoot Code Coverage Issues in CodeScene?

How to Check if Code Coverage Data is Uploaded for a Repository?

Where to Find the .edn File for Code Coverage in CodeScene On-prem?

How cs-coverage pload Handles Multiple Metrics?

What Do Code Coverage Warnings Mean in CodeScene?

New validation for code coverage uploads in CodeScene’s CLI

What are the Refactoring Recommendations?

What Are the Performed Refactorings in CodeScene?

Which Programming Languages Does CodeScene Support?

What Is CodeScene’s 4-Factor Dashboard?

Does CodeScene Support Self-Hosted GitLab?

How to Clear All Browser Cache or Clear Cache for a Specific Site?

How do I View a List of My Active Authors?

Active Authors Explained

How Does CodeScene Approach Test Code vs. Application Code?

What IP Addresses Are Used by CodeScene?

How to Delete a Project?

How to Delete a Repository?

How Does CodeScene Parse the GitLab CODEOWNERS File?

How to Handle Subscription, Trial, and Account Management Issues?