Getting started

Installation

Install the dixy command with the one-line installer, or build DIXY from source.

One-line installer

Releases are published to roy-gunjan743/DIXY-CLI. The installer needs Java 21+, downloads the CLI jar, agent jar and launcher from a GitHub Release and installs them to ~/.dixy (Windows: %USERPROFILE%\.dixy).

macOS / Linux

$ curl -fsSL https://raw.githubusercontent.com/roy-gunjan743/DIXY-CLI/main/install.sh | sh

Windows PowerShell

$ irm https://raw.githubusercontent.com/roy-gunjan743/DIXY-CLI/main/install.ps1 | iex

Open a new terminal afterwards, then run dixy from any directory.

Pin, upgrade, uninstall

Re-running the installer upgrades the jars in place.

bash

# pin a version
$ sh install.sh --version 1.0.0
$ .\install.ps1 -Version 1.0.0
# uninstall
$ sh install.sh uninstall
$ .\install.ps1 -Uninstall

Build from source

bash

$ git clone https://github.com/roy-gunjan743/DIXY.git
$ cd DIXY
$ ./gradlew clean bootJar agentJar -x test

This produces two jars in build/libs/:

File	What it is
`virtual_deadlock_detection-0.0.1-SNAPSHOT.jar`	The DIXY application (REST API + CLI).
`virtual_deadlock_detection-0.0.1-SNAPSHOT-agent.jar`	The standalone -javaagent jar.

A plain ./gradlew build does not produce the agent jar — ask for agentJar explicitly.

Start PostgreSQL and Redis

DIXY stores telemetry in PostgreSQL and uses Redis. Both are needed for the shell and for live scans.

bash

$ docker compose up -d postgres redis
$ docker compose ps   # wait for vdd-postgres "healthy"

PostgreSQL listens on localhost:5434 and Redis on localhost:6379, matching DIXY's defaults. The schema is created by Flyway on first start.

Suggest an edit on GitHub