Install Guise CLI

The Guise command line interface provides access to Guise functionality, principally Guise Mummy for static site generation.

Guise CLI requires Java to be installed on your machine, with the correct JAVA_HOME environment variable set.

Install Java

Make sure the latest latest version of the Java Development Kit (JDK) is installed on your system.

The easiest way to get Java is from Adoptium. Download the Temurin™ JDK latest release and follow the installer instructions for your platform.
You must use Java 17 or later.
Whatever Java distribution you use, preferably make sure the download says “JDK” and not “JRE”.
The JAVA_HOME environment variable must be set correctly. (The installer will do this automatically if this feature is selected.)
Make sure the Java …/bin subdirectory is added your system PATH. (The installer will do this automatically if this feature is selected.)

You can verify you have correctly installed the JDK by entering the following at the command prompt; you must have version 17 or higher:

java --version

You should see something similar to the following:

openjdk 17.0.4 2022-07-19
OpenJDK Runtime Environment Temurin-17.0.4+8 (build 17.0.4+8)
OpenJDK 64-Bit Server VM Temurin-17.0.4+8 (build 17.0.4+8, mixed mode, sharing)

This same command may be used on Linux or Windows. The build number and details output for these platforms may vary slightly.

Install Guise CLI

Below find the instructions for installing and running Guise corresponding to your computer system. When you are finished, you can verify your installation by typing guise --version.

Windows Installation

Guise CLI comes with a standalone guise.exe file you can place in any directory, preferably on your path.

Find the latest Guise CLI version on Maven.
Click the download icon next to the latest version, and select bin.zip.
Download the guise-cli-x.x.x-bin.zip file, where x.x.x represents the version number.
Unzip the guise-cli-x.x.x-bin.zip file in a directory of your choice.
Inside the unzipped contents, find guise-cli-x.x.x\bin\guise.exe file and copy it to the desired location, preferably on your user path or system path.

If Java is correctly installed and the guise.exe file can be found on the path, you can run Guise CLI by simply typing guise and pressing Enter.

Linux Installation

Guise CLI comes with a version of its executable JAR with a self-contained shell script which you can invoke as guise.

Find the latest Guise CLI version on Maven.
Click the download icon next to the latest version, and select bin.tar.xz.
Download the guise-cli-x.x.x-bin.tar.xz file, where x.x.x represents the version number.
Extract the guise-cli-x.x.x-bin.tar.xz file in a directory of your choice. You can use the command tar -xvf guise-cli-x.x.x-bin.tar.xz, substituting the filename with correct version number.
Inside the unzipped contents, find the guise-cli-x.x.x/bin/guise file and copy it to the desired location, preferably on your user path or system path. Your Linux distribution may already have ~/.local/bin/ or ~/bin/ on your user path, providing an ideal spot to place the files. This file is already set to be executable and may be invoked as guise; it will use the installed Java to start the executable JAR inside the same file.

If Java is correctly installed and the guise file can be found on the path, you can run Guise CLI by simply typing guise and pressing Enter.

Other Platforms Installation

Because Guise is based on Java, it can be run directly from the executable JAR file on any system that supports the required version of Java. You do not need to perform the following installation if you already installed Guise CLI for your specific system above.

Find the latest Guise CLI version on Maven.
Click the download icon next to the latest version, and select either bin.tar.xz or bin.zip.
Download and extract the archive file.
Inside the unzipped contents, find the guise-cli-x.x.x/bin/guise-cli-x.x.x-exe.jar file and copy it to the desired location

If Java is correctly installed, you can run Guise CLI via the java -jar command:

java -jar /path/to/guise-cli-x.x.x/bin/guise-cli-x.x.x-exe.jar

Advanced users can create an alias for guise to the executable JAR file if your system supports it.

alias guise='java -jar /path/to/guise-cli-x.x.x/bin/guise-cli-x.x.x-exe.jar'