TethysL CLI Installation¶
Java based executables as well a binary executables for various platforms are made available at: https://okeanids.mbari.org/dl/tethysl/. These are described below.
Java-based Release¶
Note
The Java based release is the recommended installation option as most TethysL development and testing is primarily done on this environment. On the other hand, although generated automatically from the Java-based release,1 the binary releases are not as fully tested and may be unexpected issues with them.
Artifact | Contains |
---|---|
tethysl-X.Y.Z.zip |
tethysl launcher script and supporting files |
A "Java release" means an executable format that is to be run via the java
program,
which is part of a typical Java runtime environment installation.
The tethysl
executable itself is a shell script that launches TethysL via
the java
command, which is assumed to be on your PATH
.
If not already on your system, you can install Java using common package managers
or directly from java.com.
-
Unzip
tethysl-X.Y.Z.zip
in some location of your choice. This will create a directorytethysl-X.Y.Z/
under that location. -
Open a terminal session and
cd
to the extractedtethysl-X.Y.Z
directory. -
Run
make install
as follows depending on where you want thetethysl
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 ofbin/
. -
Binary Release¶
Note
The native binaries are automatically generated from the Java-based release, but are not yet as stable and fully functional in general, or all of them available for the latest TethysL release.
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 thePATH
. -
To verify the installation, run
tethysl --help
, which should display the usage message on your terminal.
-
TethysL is written in Scala, one of the languages that target the Java Virtual Machine (JVM). Binary releases from the JVM version are created using GraalVM technology. ↩