Local

If you want to run the latest development version or contribute to CodeCharta, you can build both the Analysis (CCSH) and the Visualization (Web Studio) from source.

Prerequisites

• Node >= 20
• Java >= 11
• Git

Clone the repository

git clone https://github.com/MaibornWolff/codecharta
cd codecharta

Build the Analysis (CCSH)

The analysis is a Kotlin project built with Gradle. From the repository root:

cd analysis

# Build and install the ccsh distribution locally
./gradlew installDist

After the build finishes, the ccsh executable is available at ./build/install/codecharta-analysis/bin/ccsh:

./build/install/codecharta-analysis/bin/ccsh -h

This binary behaves exactly like the globally installed ccsh, so you can run any parser, importer or filter through it — for example the Unified Parser:

./build/install/codecharta-analysis/bin/ccsh unifiedparser -o=tutorial <path/to/your/project>

See CodeCharta Shell for interactive mode and the full list of tools.

Build & run the Visualization (Web Studio)

The visualization is an Angular application. From the repository root:

cd visualization

# Install dependencies
npm install

# Start the development server
npm run dev

This serves the Web Studio locally so you can import the cc.json.gz files generated by the CCSH.

To create a production build instead, run:

npm run build