<div align="center">
<!-- Logo -->
<a href="[https://codecharta.com/visualization/app/index.html?file=codecharta_visualization.cc.json.gz&file=codecharta_analysis.cc.json.gz¤tFilesAreSampleFiles=true](https://codecharta.com/visualization/app/index.html?file=codecharta_visualization.cc.json.gz&file=codecharta_analysis.cc.json.gz¤tFilesAreSampleFiles=true)">
<img src="https://raw.githubusercontent.com/maibornwolff/codecharta/main/logo/codecharta_logo.svg" alt="CodeCharta logo" width="200"/>
</a>
<!-- Releases -->
<p>
Latest Releases: <br>
<a href="https://github.com/MaibornWolff/codecharta/releases/tag/ana-1.142.0">
<img alt="Analysis Version Badge" src="https://img.shields.io/badge/1.142.0-x?style=plastic&label=Analysis&color=blue"></a>
<a href="https://github.com/MaibornWolff/codecharta/releases/tag/vis-1.142.0">
<img alt="Visualization Version Badge" src="https://img.shields.io/badge/1.142.0-x?label=Visualization&style=plastic&color=blue"></a>
</p>
<!-- Links -->
<p>
<a href="https://maibornwolff.github.io/codecharta/">Documentation</a> •
<a href="#features">Features</a> •
<a href="https://maibornwolff.github.io/codecharta/docs/overview/getting-started">Quickstart</a> •
<a href="#get-involved">Get Involved</a> •
<a href="#links">Links</a>
</p>
<!-- Analysis -->
<div>
<a href="https://github.com/MaibornWolff/codecharta/tree/ana-1.142.0">
<img alt="Release Analysis Badge" src="https://img.shields.io/github/check-runs/MaibornWolff/CodeCharta/ana-1.142.0?label=Release%20-%20Analysis&style=plastic"></a>
<a href="https://sonarcloud.io/dashboard?id=maibornwolff-gmbh_codecharta_analysis">
<img alt="Quality Gate Analysis" src="https://img.shields.io/sonar/quality_gate/maibornwolff-gmbh_codecharta_analysis/main?server=https%3A%2F%2Fsonarcloud.io&label=Quality%20Gate%20Analysis&style=plastic"></a>
<a href="https://sonarcloud.io/project/activity?id=maibornwolff-gmbh_codecharta_analysis&graph=coverage">
<img alt="Sonar Analysis Coverage" src="https://img.shields.io/sonar/coverage/maibornwolff-gmbh_codecharta_analysis/main?server=https%3A%2F%2Fsonarcloud.io&label=Coverage%20Analysis&style=plastic"></a>
</div>
<!-- Visualization -->
<div>
<a href="https://github.com/MaibornWolff/codecharta/tree/vis-1.142.0">
<img alt="Release Visualization Badge" src="https://img.shields.io/github/check-runs/MaibornWolff/CodeCharta/vis-1.142.0?label=Release%20-%20Visualization&style=plastic"></a>
<a href="https://sonarcloud.io/dashboard?id=maibornwolff-gmbh_codecharta_visualization">
<img alt="Quality Gate Visualization" src="https://img.shields.io/sonar/quality_gate/maibornwolff-gmbh_codecharta_visualization/main?server=https%3A%2F%2Fsonarcloud.io&label=Quality%20Gate%20Visualization&style=plastic"></a>
<a href="https://sonarcloud.io/project/activity?id=maibornwolff-gmbh_codecharta_visualization&graph=coverage">
<img alt="Sonar Visualization Coverage" src="https://img.shields.io/sonar/coverage/maibornwolff-gmbh_codecharta_visualization/main?server=https%3A%2F%2Fsonarcloud.io&label=Coverage%20Visualization&style=plastic"></a>
</div>
<br>
<!-- Web Studio -->
<a href="https://codecharta.com/visualization/app/index.html?file=codecharta_visualization.cc.json.gz&file=codecharta_analysis.cc.json.gz¤tFilesAreSampleFiles=true">
<img alt="Website Up Badge" src="https://img.shields.io/website?url=https%3A%2F%2Fcodecharta.com%2Fvisualization%2Fapp%2Findex.html%3Ffile%3Dcodecharta.cc.json.gz%26file%3Dcodecharta_analysis.cc.json.gz%26area%3Drloc%26height%3Dsonar_complexity%26color%3Dsonar_complexity&up_message=running&style=plastic&label=Web%20Studio">
</a>
<a href="https://codecharta.com/stg/visualization/index.html?file=codecharta_visualization.cc.json.gz&file=codecharta_analysis.cc.json.gz&area=rloc&height=functions&color=sonar_complexity&edge=avgCommits¤tFilesAreSampleFiles=true">
<img alt="Website Prerelease Badge" src="https://img.shields.io/website?url=https%3A%2F%2Fcodecharta.com%2Fstg%2Fvisualization%2Findex.html%3Ffile%3Dcodecharta.cc.json.gz%26file%3Dcodecharta_analysis.cc.json.gz%26area%3Drloc%26height%3Dfunctions%26color%3Dfunctions%26currentFilesAreSampleFiles%3Dtrue&up_message=running&style=plastic&label=Web%20Studio%20Prerelease%20Environment">
</a>
</div>
What is CodeCharta
Having trouble communicating the problems in your code base? Look no further, CodeCharta is able to visualise or even print your code base
in 3D! While showing you lots of different metrics to help you decide what to tackle next. CodeCharta is an open
source project mainly developed by MaibornWolff. You can find everything you need in
our Documentation.
Your Data Stays Local
All analysis and visualization happens entirely on your machine. No data is ever uploaded, shared, or transmitted to any external service without your explicit intent. Your code stays private and secure. CodeCharta has no analytics, tracking, or telemetry built-in.
Features
CodeCharta Shell (Analysis)
Our Shell is the heart of CodeCharta. It allows you to import metrics from various sources or parse your code base.
You need it to generate the data needed for our Web Studio. It supports different imports
from Sonar,
Tokei,
Code Maat,
Source Monitor,
or even CSV files! Or you can parse your code base directly with various
parsers for Git Log,
SVN Log,
Source Code,
and Raw Text.
Our Web Studio
allows you to visualize your code base in 3D. It takes the results from our Shell and displays them in a city-like map.
You can move around your code base, zoom in and out, and see the metrics of your code base in a 3D map.
Files with metrics become buildings where the area, height and color represent different metrics, you can freely choose!
Makes it easy to see the hotspots in your code base and find areas for improvement.
Ever wanted to touch that huge complex service? Download your map as a 3D model and print your code base!
Take it in your hands and show it to your colleagues.
Track changes
Compare two maps and see the delta between them. This allows you to see the changes in your code base over time.
Getting started
You can find our preferred way to get started
under Documentation - Quick Start Guide.
But if you already know what to do, here is how you install our CCSH.
# Install our codecharta shell globally
$ npm i -g codecharta-analysis
# Check if it is installed
$ ccsh - h
# done :)
Get Involved
Do you have a bug, feature request, or question? Please open a new issue.
Feedback is always welcome.
Want more information? Check out our documentation
and news.
Service Offerings
Your company needs professional support to analyse your code base? We offer a service to help you with that.
Software Health Check
A full Software Health Check for your codebase and everything around it. Click the link to learn
more: Software Health Check
Links
License
BSD-3-Clause License
Made with ❤ by MaibornWolff · GitHub @MaibornWolff
