Skip to content

TethysL CLI Installation

👉 All downloads available at: https://okeanids.mbari.org/dl/tethysl/.

Windows note (2022-08-04)

Recently, we have had issues with the Windows executable: It is generated apparently without any errors under our CI environment, but it ends up not being functional when launching it. While we can look into this issue, please use one of the other generated artifacts if possible.

macOS note

The executable for macOS is not signed, so it will not run right away when downloaded from the internet. A command like xattr -d com.apple.quarantine tethysl can be used to allow its execution.


There are two main types of CLI releases: JVM-based and binary. These are explained in more detail below but, in short, the former requires the java program available on the target system, while the latter does not as they are standalone executables.

JVM-based Release

By "JVM release" we mean an executable format that is to be run via the java program, which is part of a typical Java runtime environment installation.1 In this case, note that the tethysl executable itself is a shell script that takes care of launching TethysL via the java command, which is assumed to be on your PATH. If not already on your system, you can install Java from java.com.

Each Java based release of TethysL is packaged as a ZIP archive with name tethysl-X.Y.Z.zip, where X.Y.Z denotes the particular TethysL version.

  • Download the latest version tethysl-X.Y.Z.zip from this location.

  • Unzip 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 executable script to be installed. Typically, this could be under some location that you already have included as part of the PATH environment variable. Of course, feel free to use whatever practice for this purpose.

    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 actually correspond to the parent directory of bin/.

    Or, adjust PREFIX as needed and run the make command accordingly.


Binary Release

By "binary release" we mean a standalone, native tethysl executable. Each binary release is packaged as a ZIP archive, only containing the corresponding executable program for the target OS. The name of the archive is:

tethysl-X.Y.Z-<target-system>.zip

where X.Y.Z denotes the TethysL version and <target-system> indicates the particular target system.

Examples:

  • tethysl-X.Y.Z-x86_64-pc-linux.zip
  • tethysl-X.Y.Z-x86_64-apple-darwin.zip
  • tethysl-X.Y.Z-x86_64-pc-win32.zip

The contained executable program is named tethysl for Linux and macOS, and tethysl.exe for Windows.

  • Download the latest version tethysl-X.Y.Z-<target-system>.zip from this location.

  • Typically, you will want the CLI executable to be findable through the PATH environment variable. So, extract the executable from the zip in a location on your system that is either already part of the PATH or that you can add to the PATH.

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


  1. The TethysL application itself is written in Scala, one of the languages that target the Java virtual machine. Binary releases from the JVM version are created using GraalVM technology