Skip to content

CLI Usage

The cli module produces a self-contained native binary — no JVM required at runtime.

Installation / macOS Note

If you downloaded the pre-compiled binary for macOS, Gatekeeper may prevent it from running. You can clear the quarantine attribute by running:

bash
xattr -d com.apple.quarantine <path-to-binary>

Basic usage

bash
# Convert a Shearwater CSV (24 core columns)
dive-telemetry --format shearwater dive-log.csv

# Convert a Garmin FIT file with a custom output path
dive-telemetry --format garmin --output my-dive.csv ACTIVITY.fit

# Enable interpolation for smoother video 
dive-telemetry --format shearwater --interpolate dive-log.csv

# Enable all output plugins (49 columns)
dive-telemetry --format shearwater --technical-oc --technical-ccr --safety-stop dive-log.csv

The output file defaults to <input-basename>-telemetry.csv in the same directory as the input.

Options

OptionDescription
INPUTPath to the input dive log file (required)
-f, --formatDive computer format: shearwater or garmin (required)
-o, --outputOutput file path (default: <input>-telemetry.csv)
-i, --interpolateResample to 1-second intervals
-t, --technical-ocEnable Technical Open Circuit columns (NDL, deco, clear)
-c, --technical-ccrEnable Technical CCR columns (PPO2, dilPO2)
-s, --safety-stopEnable Safety Stop Timer column
-p, --pressure-unitTank pressure unit: default, psi, or bar
-h, --helpShow help message and exit

Building native binaries

PlatformCommandOutput
macOS (Apple Silicon)./gradlew :cli:macosArm64Binariescli/build/bin/macosArm64/releaseExecutable/cli.kexe
macOS (Intel)./gradlew :cli:macosX64Binariescli/build/bin/macosX64/releaseExecutable/cli.kexe
Linux (x86_64)./gradlew :cli:linuxX64Binariescli/build/bin/linuxX64/releaseExecutable/cli.kexe
Windows (x86_64)./gradlew :cli:mingwX64Binariescli/build/bin/mingwX64/releaseExecutable/cli.exe

Linux and Windows binaries are cross-compiled from macOS and are not CI-validated.

Running on JVM (without a native binary)

bash
./gradlew :cli:jvmRun --args="--format shearwater dive-log.csv"