Installing Salt CLI
Installing Salt CLI
The Salt CLI is distributed as a zipfile that runs under Linux, macOS and Windows. The installation process downloads the zipfile, unzips the downloaded file, and adds a shortcut for running salt in the target platform.
In brief: Assuming that you want to place the Salt CLI in a given <TARGET_DIR> directory:
For macOS/Linux (bash):
For Windows (PowerShell):
The following sections describe in more detail each step.
Download Salt CLI
Run the one of the following which better matches your preferences:
For mac/Linux (bash):
On Windows (PowerShell):
Verify the Integrity
To ensure that the downloaded installation script checksum matches the checksum published in Xygeni repository, meaning that probably it was not tampered with:
On mac/Linux (bash):
If under macOS, as
sha256sumis probably not installed in your host, you may:(2) or use
shasum -a 256instead orsha256sumif theshasumcommand is installed,On Windows (PowerShell):
Unzip the CLI
TARGET_DIR is the path where the zipfile contents will be extracted. Replace it with your
For mac/Linux (bash):
On Windows (PowerShell):
In what follows, the location of the Salt CLI is TARGET_DIR/xygeni_salt
Set Alias for Salt
The Salt CLI command is either a bash salt or PowerShell salt.ps1 script under TARGET_DIR/xygeni_salt. It is convenient to use an alias for running the command without providing its full path. You may add TARGET_DIR/xygeni_salt to the PATH, or alternatively add an alias or shell function:
For mac/Linux (bash):
On Windows (PowerShell):
The salt CLI is now available for running using salt alias. Run salt --help to show the help for the different commands available.
Execute Salt
Once installed, you can execute salt.
Please note that you need to provide a Xygeni Token to salt to make it work.
Last updated