Skip to content

TethysL CLI Installation

Requirement

TethysL requires the java program (part of a typical Java runtime environment installation) for execution of TethysL.1 You can install Java using common package managers or directly from java.com.

The tethysl executable itself is a shell script that launches TethysL via the java command.

TethysL installation

TethysL releases are packaged in ZIP format, available at https://okeanids.mbari.org/dl/tethysl/.2

Artifact Contains
tethysl-X.Y.Z.zip tethysl launcher script and supporting files

  • Unzip the latest tethysl-X.Y.Z.zip in some location of your choice. This will create a directory tethysl-X.Y.Z/ under that location.

  • Open a terminal session and cd to the extracted tethysl-X.Y.Z directory.

  • Run make install as follows depending on where you want the tethysl bash executable script to be installed.

    Examples:

    • To install tethysl under the default location ~/local/bin/:

      make install

    • To install tethysl under /opt/tethysl/bin/:

      sudo make install PREFIX="/opt/tethysl"

    NOTE: The PREFIX value to be indicated should be the parent directory of bin/.

Binary Releases

Note

The Java based release (described above) is the recommended installation option as most TethysL development and testing is done on this environment. The binary releases3, although generated automatically from the Java release, are not stabilized and tested as thoroughly.

Artifact Contains
tethysl-X.Y.Z-x86_64-pc-linux.zip tethysl Linux binary
tethysl-X.Y.Z-x86_64-apple-darwin.zip tethysl macOS binary
tethysl-X.Y.Z-x86_64-pc-win32.zip tethysl.exe Windows binary

A binary release means a standalone, native tethysl executable. Depending on target platform, each binary release is packaged as a ZIP archive, only containing the corresponding executable program, which is named tethysl for both Linux and macOS, and tethysl.exe for Windows.

macOS note

The executable binary for macOS is not signed, so it will not run right away when downloaded from the internet. Try running xattr -d com.apple.quarantine tethysl to allow its execution.

  • Typically, you will want the CLI executable to be findable through the PATH environment variable. Extract the executable from the zip in a location that is part of the PATH.

  • To verify the installation, run tethysl --help, which should display the usage message on your terminal.

  1. TethysL is written in Scala, one of the languages that target the Java Virtual Machine (JVM). ↩

  2. You will also see tethysl-X.Y.Z.jar artifacts; these are used by the TethysL VSCode extension. ↩

  3. Binary releases from the JVM version are created using GraalVM technology. ↩