Installation

To start using TSA, you can either use the prebuilt artifacts (depending on your operating system) or build the artifacts yourself from the source code.


Running Prebuilt Artifacts

Using a Docker Container

docker run --platform linux/amd64 -it --rm \
-v [SOURCES_DIR_ABSOLUTE_PATH]:/project \
ghcr.io/espritoxyz/tsa:latest \
[ANALYZER_OPTIONS]

Here:

  • SOURCES_DIR_ABSOLUTE_PATH – the absolute path to the directory containing the source code of the project you want to analyze;
  • ANALYZER_OPTIONS – analyzer options (see the Use Cases Guide, or use the --help option).
NOTE: All paths must be RELATIVE to the project dir.
NOTE: All paths in ANALYZER_OPTIONS must be RELATIVE to SOURCES_DIR_ABSOLUTE_PATH.
NOTE: Use WSL on the Windows machine.

Using JAR Executables

The Releases page provides a JAR executable tsa-cli.jar.

Before using it, ensure you have the following installed:

Then, you can access the tool by running the JAR executable from the command line:

java -jar tsa-cli.jar

Building from sources

  1. Install all prerequisites:
  2. Clone the repository
     git clone https://github.com/espritoxyz/tsa/ 
  3. Run
     ./gradlew tsa-cli:shadowJar 
    from the root of the project to build the tool JAR executable (will be located in the build dir of the tsa-cli module)