This repository provides an automated code graph analysis pipeline built on jQAssistant and Neo4j. It supports Java and experimental TypeScript analysis, capturing both the structure and evolution of your code base.
Ever wondered which libraries matter most, how your modules build on each other, which parts have few contributors, which files change together, or where structural anomalies emerge?
This project helps uncover such patterns through graph-based analysis, visualization, and machine learning — offering hundreds of expert-level reports for deep code insights.
Curious? Explore the examples at code-graph-analysis-examples and get started with GETTING_STARTED.md 🚀
- Analyze static code structure as a graph
- Supports Java Code Analysis
- Supports Typescript Code Analysis (experimental)
- Fully automated pipeline for Java from tool installation to report generation
- Fully automated pipeline for Typescript from tool installation to report generation
- Fully automated local run
- Easily integrable into your continuous integration pipeline
- More than 200 CSV reports for dependencies, metrics, cycles, annotations, algorithms and many more
- Jupyter notebook reports for dependencies, metrics, visibility and many more
- Anomaly detection powered by unsupervised machine learning and explainable AI
- Graph structure visualization
- Automated reference document generation
- Runtime and library independent automation using shell scripts
- Tested on MacOS (zsh), Linux (bash) and Windows (Git Bash)
- Comprehensive list of Cypher queries
- Example analysis for AxonFramework
- Example analysis for react-router
- November 2025: Removed deprecated (since version 2.x) "graph-visualization" node package
- November 2025: Treemap charts for anomalies and archetypes
- October 2025: Graph visualizations for anomaly archetypes
- October 2025: Anomaly archetypes with markdown summary
- August 2025: Association rule mining for co-changing files in git history
- August 2025: Anomaly detection powered by unsupervised machine learning and explainable AI
- May 2025: Migrated to Neo4j 2025.x and Java 21.
Here is an overview of Jupyter Notebooks reports from code-graph-analysis-examples. For a complete list, see the Jupyter Notebook Report Reference.
- External Dependencies contains detailed information about external library usage (Notebook).
- Git History contains information about the git history of the analyzed code (Notebook).
- Internal Dependencies is based on Analyze java package metrics in a graph database and also includes cyclic dependencies (Notebook).
- Method Metrics shows how the effective number of lines of code and the cyclomatic complexity are distributed across the methods in the code (Notebook).
- Node Embeddings shows how to generate node embeddings and to further reduce their dimensionality to be able to visualize them in a 2D plot (Notebook).
- Object Oriented Design Quality Metrics is based on OO Design Quality Metrics by Robert Martin (Notebook).
- Overview contains overall statistics and details about methods and their complexity. (Notebook).
- Visibility Metrics (Notebook).
- Wordcloud contains a visual representation of package and class names (Notebook).
- Java Archetypes Treemap (Python Script)
This project includes several reports that use Neo4j's Graph Data Science Library. These reports are part of the code-graph-analysis-examples repository. For a full list of reports, check out the CSV Cypher Query Report Reference.
Here are some reports that utilize Neo4j's Graph Data Science Library from code-graph-analysis-examples. For a complete list, see the CSV Cypher Query Report Reference.
- Centrality with Page Rank (Source Script)
- Community Detection with Leiden (Source Script)
- Node Embeddings with HashGNN (Source Script)
- Path Finding with all pairs shortest path (Source Script)
- Similarity with Jaccard (Source Script)
- Topology Sort (Source Script)
Here are some fully automated graph visualizations utilizing GraphVizfrom code-graph-analysis-examples:
- Java Artifact Build Levels (Query, Source Script)
- Java Artifact Longest Path Contributors (Query, Source Script)
- Java Package Top #1 Authority Archetype and contributing packages (Query, Source Script)
- Analyze java dependencies with jQAssistant
- Analyze java package metrics in a graph database (Part 2)
Run scripts/checkCompatibility.sh to check if all required dependencies are installed and available in your environment.
-
Java 21 is required since Neo4j 2025.01. See also Changes from Neo4j 5 to 2025.x.
-
Java 17 is required for Neo4j 5.
-
On Windows it is recommended to use the git bash provided by git for windows.
-
jq the "lightweight and flexible command-line JSON processor" needs to be installed. Latest releases: https://github.com/jqlang/jq/releases/latest. Check using
jq --version. -
Set environment variable
NEO4J_INITIAL_PASSWORDto a password of your choice. For example:export NEO4J_INITIAL_PASSWORD=neo4j_password_of_my_choiceTo run Jupyter notebooks, create an
.envfile in the folder from where you open the notebook containing for example:NEO4J_INITIAL_PASSWORD=neo4j_password_of_my_choice
- Python is required for Jupyter Notebook and Python reports.
- Either Conda or Python's build-in module venv a required as environment manager.
- For Conda, use for example Miniconda or Anaconda(Recommended for Windows).
- To use venv, no additional installation is needed. For that the environment variable
USE_VIRTUAL_PYTHON_ENVIRONMENT_VENVneeds to be set to'true'. - Chromium will automatically be downloaded if needed for Jupyter Notebook PDF reports generation.
- Add this line to your
~/.bashrcfile if you are using Anaconda3:/c/ProgramData/Anaconda3/etc/profile.d/conda.sh. Try to find a similar script for other conda package managers or versions. - Run
conda initin the git bash opened as administrator. Running it in normal mode usually leads to an error message.
-
Please follow the description on how to create a json file with the static code information of your Typescript project here: https://github.com/jqassistant-plugin/jqassistant-typescript-plugin
This could be as simple as running the following command in your Typescript project:npx --yes @jqassistant/ts-lce
-
The cloned repository or source project needs to be copied into the directory called
sourcewithin the analysis workspace, so that it will also be picked up during scan by resetAndScan.sh and optional importGit.sh.
See GETTING_STARTED.md on how to get started on your local machine.
See INTEGRATION.md on how to integrate code analysis in your continuous integration pipeline. Currently (2025), only GitHub Actions are supported.
The Code Structure Analysis Pipeline utilizes GitHub Actions to automate the whole analysis process:
- Use GitHub Actions Linux Runner
- Checkout GIT Repository
- Setup Java
- Setup Python with Conda package manager Mambaforge
- Setup Python with venv
- Download artifacts and optionally source code that contain the code to be analyzed scripts/downloader
- Setup Neo4j Graph Database (analysis.sh)
- Setup jQAssistant for Java and Typescript analysis (analysis.sh)
- Start Neo4j Graph Database (analysis.sh)
- Generate CSV Reports scripts/reports using the command line JSON parser jq
- Uses Neo4j Graph Data Science for community detection, centrality, similarity, node embeddings and topological sort (analysis.sh)
- Generate Jupyter Notebook reports using these libraries specified in the conda-environment.yml:
- HPCC-Systems (High Performance Computing Cluster) Web-Assembly (JavaScript) containing a wrapper for GraphViz to visualize graph structures.
- GraphViz for CLI Graph Visualization
- Check links in markdown documentation (GitHub workflow) uses markdown-link-check.
Big shout-out 📣 to all the creators and contributors of these great libraries 👍. Projects like this wouldn't be possible without them. Feel free to create an issue if something is missing or wrong in the list.
COMMANDS.md contains further details on commands and how to do a manual setup.
CSV_REPORTS.md lists all CSV Cypher query result reports inside the results directory. It can be generated as described in Generate CSV Report Reference.
JUPYTER_REPORTS.md lists all Jupyter Notebook reports inside the results directory. It can be generated as described in Generate Jupyter Notebook Report Reference.
IMAGES.md lists all PNG images inside the results directory. It can be generated as described in Generate Image Reference.
SCRIPTS.md lists all shell scripts of this repository including their first comment line as a description. It can be generated as described in Generate Script Reference.
CYPHER.md lists all Cypher queries of this repository including their first comment line as a description. It can be generated as described in Generate Cypher Reference.
Cypher is Neo4j’s graph query language that lets you retrieve data from the graph.
ENVIRONMENT_VARIABLES.md contains all environment variables that are supported by the scripts including default values and description. It can be generated as described in Generate Environment Variable Reference.
CHANGELOG.md contains all changes of this repository.
-
How can i run an analysis locally?
👉 Check the prerequisites. 👉 See Start an analysis in the Commands Reference. 👉 To get started from scratch see GETTING_STARTED.md. -
How can i explore the Graph manually? 👉 After analysis start Neo4j and open the Neo4j Web UI (
http://localhost:7474/browser). -
How can i add a CSV report to the pipeline?
👉 Put your new cypher query into the cypher directory or a suitable (new) sub directory.
👉 Create a new CSV report script in the scripts/reports directory. Take for example OverviewCsv.sh as a reference.
👉 The script will automatically be included because of the directory and its name ending with "Csv.sh". -
How can i add a Jupyter Notebook report to the pipeline?
👉 Put your new notebook into the jupyter directory.
👉 The file will then automatically be picked up by executeJupyterNotebookReport.sh. -
How can i analyze a different code basis automatically?
👉 Create a new download script like the ones in the scripts/downloader directory. Take for example downloadAxonFramework.sh as a reference for Java projects and downloadReactRouter.sh as a reference for Typescript projects. 👉 After downloading, run analyze.sh. You can find these steps also in the pipeline as a reference. -
How can i trigger a full re-scan of all artifacts?
👉 Delete the fileartifactsChangeDetectionHash.txtin theartifactsdirectory. 👉 Delete the filetypescriptFileChangeDetectionHashFile.txtin thesourcedirectory to additionally re-scan Typescript projects. -
How can i enable PDF generation for Jupyter Notebooks (depends on chromium, takes more time)?
👉 Set environment variableENABLE_JUPYTER_NOTEBOOK_PDF_GENERATIONto anything except an empty string. Example:export ENABLE_JUPYTER_NOTEBOOK_PDF_GENERATION="true"
👉 Alternatively prepend your command with
ENABLE_JUPYTER_NOTEBOOK_PDF_GENERATION="true"like:ENABLE_JUPYTER_NOTEBOOK_PDF_GENERATION=true ./../../scripts/analysis/analyze.sh
-
How can i disable git log data import?
👉 Set environment variableIMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENTtonone. Example:export IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT="none"
👉 Alternatively prepend your command with
IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT="none":IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT="none" ./../../scripts/analysis/analyze.sh👉 An in-between option would be to only import monthly aggregated changes using
IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT="aggregated":IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT="aggregated" ./../../scripts/analysis/analyze.sh -
Why are some Jupyter Notebook reports skipped? 👉 The custom Jupyter Notebook metadata property
code_graph_analysis_pipeline_data_validationcan be set to choose a query from cypher/Validation that will be executed preliminary to the notebook. If the query leads to at least one result, the validation succeeds and the notebook will be run. If the query leads to no result, the notebook will be skipped. For more details see Data Availability Validation. -
How can i increase the heap memory when scanning large Typescript projects?
👉 Use the environment variable TYPESCRIPT_SCAN_HEAP_MEMORY in megabyte (default = 4096):TYPESCRIPT_SCAN_HEAP_MEMORY=16384 ./../../scripts/analysis/analyze.sh
-
How can i continue on errors when scanning Typescript projects instead of cancelling the whole analysis?
👉 Use the profileNeo4j-latest-continue-on-scan-errors(default =Neo4j-latest):./../../scripts/analysis/analyze.sh --profile Neo4j-latest-continue-on-scan-errors
-
How can i reduce the memory (RAM) consumption?
👉 Use the profileNeo4j-latest-low-memory(default =Neo4j-latest):./../../scripts/analysis/analyze.sh --profile Neo4j-latest-low-memory
- code-graph-analysis-examples
- Bite-Sized Neo4j for Data Scientists
- The Story behind Russian Twitter Trolls
- Graphs for Data Science and Machine Learning
- Modularity
- Graph Data Science Centrality Algorithms
- Graph Data Science Community Detection Algorithms
- Graph Data Science Community Similarity Algorithms
- Graph Data Science Community Topological Sort Algorithm
- Node embeddings for Beginners