Docs
Getting Started

Getting Started

How to start using TSA CLI tool.

Installation

There are several ways to get TSA CLI tool:

  • Use Docker container
  • Download from GitHub Releases page
  • Build from sources

Using 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 (use the --help option).

All paths must be RELATIVE to the project dir.

All paths in ANALYZER_OPTIONS must be RELATIVE to SOURCES_DIR_ABSOLUTE_PATH.

Using Jar from GitHub Releases

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

Before using it, ensure you have the following installed:

Building from Sources

Refer to the Contribution document in TSA repository.

Quick Start

To get a list of available options, run:

java -jar tsa-cli.jar --help