ASSIS

Generate UML diagrams from Java code.

Getting Started

Do you have a terminal available?
Check the Getting Started Guide.

The instructions below were validated with ASSIS v0.9.4-beta.

Usage

Get the latest version

Download the latest release from:
https://github.com/masmangan/assis/releases

For v0.9.4-beta, the released CLI artifact is:

https://github.com/masmangan/assis/releases/download/v0.9.4-beta/assis-cli-0.9.4-beta.jar Older releases are kept for reference, but documentation always targets the latest release.

Run ASSIS

ASSIS scans your source folder for .java files and generates a PlantUML class diagram (class-diagram.puml).

Place the JAR in the project root folder (or any folder of your choice).

Run ASSIS from the command line:

java -jar assis-cli-0.9.4-beta.jar

After execution, a class-diagram.puml file will be generated.

The diagram can be edited and rendered using:

• PlantUML Online Server: https://www.plantuml.com/plantuml/uml/
• IDE plugins (e.g., Eclipse, VS Code)

The .puml file can also be embedded in Markdown documents.

Development

Build

mvn -DskipTests package

Run with JAR (from source build)

java -jar assis-cli/target/assis-cli-0.9.4-beta.jar

Run with Maven

mvn -q -DskipTests exec:java -Dexec.mainClass=io.github.masmangan.assis.cli.AssisApp

ASSIS Classes Overview

License

This project is licensed under the MIT License.

Use of Artificial Intelligence

ASSIS was developed with the assistance of Artificial Intelligence tools used in a conversational and reflective role (e.g., architectural discussion, diagram modeling, and documentation), rather than as inline code generation or autonomous programming agents.

All final decisions and implementations remain the responsibility of the author.

References

ASSIS uses existing open-source tools as building blocks:

• PlantUML — UML tool
  https://plantuml.com

• JavaParser — Java source code parser
  https://javaparser.org