User Documentation
Welcome to the user documentation of CodeCharta!
This page will give you an overview over all major aspects of the programs documentation. As CodeCharta essentially consists of two projects (analysis and visualisation), parts of the documentation are also split between them.
Note: This documentation explains how to use CodeCharta. If you want to develop on it, our developer documentation can be found in our GitHub repository.
How to use CodeCharta
If you are completely new to CodeCharta, please read the Quick-Start Guide, which explains the basics of it.
If you want to install CodeCharta, you will find a guide on how it can be installed locally here. We also provide docker containers for both parts of CodeCharta. Documentation for these containers can be found here.
Analysis-specific docs
Generally, the analysis part of CodeCharta is used to generate metrics from code. For more information refer to the analysis page. If you want to learn how to use the CLI-tool of the analysis, check out the CodeCharta Shell page. The CodeCharta Shell consists of a variety of different tools, which each have their own page in “analysis tools”. We also go into detail about our views on metrics here and how you can use custom metrics in CodeCharta here.
Visualization-specific docs
The visualization part of CodeCharta displays code files as buildings of a city where their area, height and color represent different metrics. To quickly try it out, you can view the web visualization. You can learn more about the visualization here or view the controls here. The visualization also includes three features that can make it easier to analyze code. These are custom views, which serve as presets for display configurations, the suspicious metrics, which highlight higher than usual metrics and the risk profile, which gives a quick overview of the codes’ complexity.
How-Tos
We provide several how to articles, that describe how to perform different tasks in CodeCharta.
For example, this article describes how to set up SonarQube and use our sonar-importer to visualize the generate metrics.
Click here to see all available How-To articles.
Changelog
Changelogs are kept separate for the Analysis and the Visualisation.
A list of analysis changelogs can be found here
A list of visualisation changelogs can be found here
A combined list of all changelogs sorted by date can be found here