galasa

Close menu
Open menu

Installing the Galasa CLI

This section provides details about how to download and install the Galasa command line interface tool (galasactl) on your local machine and tells you a little bit about getting started with the Galasa CLI commands.

Downloading the Galasa CLI

To install Galasa for using in the command-line you first need to download the binary file for the Galasa CLI from the Galasa cli respository in GitHub.

The following versions of the Galasa CLI are available to download for different operating systems and machine architectures:

Operating system Architecture Download
MacOSX x86_64 galasactl-darwin-x86_64
MacOSX arm64 galasactl-darwin-arm64
Linux x86_64 galasactl-linux-x86_64
Linux arm64 arm64 galasactl-linux-arm64
zLinux s390x galasactl-linux-s390x
Windows x86_64 galasactl-windows-x86_64.exe

Installing the Galasa CLI

Complete the following steps to install Galasa for using the command line:

On Mac or Unix:

  1. Find out the architecture of your machine by typing the command uname -m into your terminal.
  2. Download the appropriate binary of the Galasa CLI for your machine architecture from the Galasa cli repository in GitHub and re-name it to galasactl.
  3. Add Galasa CLI to your PATH to enable you to run CLI commands from anywhere on your file system without having to specify the absolute path. To set the path permanently, you need add the Galasa CLI path to your shell's initialization file. For example, if you downloaded the galasactl executable to a folder called ~/tools in your home directory, you need to add ~/tools to the list of directories that your shell searches through when you enter a command. You can do this by adding the line export PATH=$PATH:$HOME/tools to your shell’s initialization file (for example ~/.bashrc or ~/.zshrc).
  4. Set execute permission on the binary by running the chmod +x galasactl command in the directory containing galasactl.
  5. If you are using a Mac, you can set permission to open the Galasa CLI tool by running the xattr -dr com.apple.quarantine galasactl command in the directory containing galasactl.

You can now run the Galasa CLI too from any directory in your file system without having to specify the absolute path.

On Windows (Powershell):

  1. Download the binary and re-name it to galasactl.
  2. Add galasactl to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. For example, save the galasactl executable to a folder called ~/tools in your C: directory and run the set PATH "C:\tools;%PATH%" command to add it to your PATH.
  3. Open cmd.exe and type start galasactl.exe in the directory containing galasactl.

You can now run the Galasa CLI too from any directory in your file system without having to specify the absolute path.

Next steps

Find out more about the Galasa CLI commands by reading the Galasa CLI commands documentation.

Move on to the Initialising your local environment documentation to help you to set up some basic file structures and files in your home folder so that you can start using Galasa.