CodeScene¶
Welcome to the CodeScene documentation!
This documentation is divided into sections, each being suited for different types of information you might be looking for.
New Users¶
Getting Started helps you take the first steps after you discovered CodeScene. You will learn how to sign up, what CodeScene does, and how you run your first analysis.
CodeScene Terminology explains the concepts, analysis options, and metrics.
From Code to Delivery: meet the 4-factors of successful software¶
From Code to Delivery: the 4 factors model introduces the 4 factors essential to successful software development. We explain how the dashboards work and how you set up team specific dashboards.
Project Configuration¶
Project Configuration explains how you configure projects to get the most out of your analysis.
Analysis Documentation¶
Focus Areas walks you through specific features and aspects of the tool, focusing on how you use them to achieve certain goals.
Developer tools¶
CodeScene MCP Server: Bring Code Health Insights Into Your AI Workflow makes AI tools more helpful and reliable by grounding them in Code Health data.
PR Refactoring Agent lets reviewers trigger Code Health-guided refactoring directly from pull requests.
CodeScene CLI tool is a command-line tool which performs the same checks as the PR integration, but locally - on non-committed, staged changes or between select branches. Check the link for setup instructions. Note: Requires an access token.
Integrate Automated Code Health Reviews in Pull Requests and Merge Requests explains how CodeScene integrates with Pull Requests to serve as an automated code review and quality gate.
Check Code Coverage in Pull Requests and Merge Requests to enforce code coverage where it matters most.
Public API lets you automate CodeScene and access analysis data programmatically through the REST API.
Project management tools¶
Configure Project Management integration for Delivery explains how to integrate project management tools like Jira to measure lead times and related delivery metrics.
Account Administration: Invite Team Members¶
Organizational Accounts explains how to create organizational accounts in CodeScene so that all stakeholders in an organization can access and benefit from the analyses.
CodeScene Scope¶
Supported Programming Languages covers CodeScene’s language level support.
Supported Git Hosting Providers - CodeScene can analyze GitHub, Bitbucket, Azure DevOps and GitLab repositories.