Installation

The recommended way of using CorrLang is by using the command line interface (CLI) corrl (ˈkɔːrᵊl). You can download the binary for your operating system and architecture directly from GitHub.

  1. Download the corrl-windows-amd64.exe and rename it to corrl.exe
  2. Make a new folder to put the executable, e.g. C:\Users\{your username}\CorrLang.
  3. In order to run CLI in a terminal, you will have to add that folder to your %PATH% environment variable. The easiest way is via the GUI: Press the Windows button and search for “Control panel”. In the control planel navigate to System and Security > System > Advanced system settings. In the latter window, there will be an Environment Variables button press it, select the Path entry in the User variables section and add the path above.
  4. Open a new terminal window (PowerShell or CMD): Your should be able to enter corrl info.

First, you need to find out what type of processor your have: Press the Apple icon in the top left and select the About this Mac. If it says Apple M.. in the Chip section, you will have to use the arm64 version otherwise amd64.

  1. Download the correct corrl-macos-{arch} file that matches your processor architecture and rename it to corrl.
  2. Place the exctracted corrl binary somewhere in you file system where you want executables to live, e.g., /Users/{your-username}/.local/bin is a common choice.
  3. Remove the Apple quarantine flag from the binary: xattr -d com.apple.quarantine ~/.local/bin/corrl
  4. Make sure the binary is executable: chmod +x ~/.local/bin/corrl
  5. Make sure that the above file path is part of you $PATH system environment variable: export PATH=$PATH:/Users/{your-username}/.local/bin. Remember to put this statement into your ~./.zshrc if you do not want to enter it into every new terminal session.
  1. Download corrl-linux-amd64 or corrl-linux-arm64 depending on you processor architecture and rename the file to corrl.
  2. Place the file, where you want your executables to be, e.g. /home/{your-username}/.local/bin.
  3. Make sure the binary is executable: chmod +x ~/.local/bin/corrl
  4. Make sure that the above file path is part of you $PATH system environment variable: export PATH=$PATH:/home/{your-username}/.local/bin. Remember to put this statement into your ~./.bashrc if you do not want to enter it into every new terminal session.

The corrl binary itself is just a thin service client that is meant to interact with a daemon (background) process, which does the “heay lifting”. The latter is referred to as core service and requires the Java virtual machine (JVM) to run. The CLI will automate installing the core service itself but you have to make sure to have some Java runtime with at least version 21 installed.

To install the core service, simply run:

corrl install

This will pull the latest release of the CorrLang core service into your CORRLANG_HOME. By default, this will be a directory called .corrlang/, right beneath your HOME directory.

To check what version of the core-service is installed, you can run

corrl info

As said above, the “heavy-lifting” is done by this core-service. Hence, you will have to start it whenever you are working with CorrSpecs, alignment, etc.

The service is started with:

corrl up

and stopped with:

corrl down

You can check the current status of the service with:

corrl status