Skip to content

Install the CLI

You'll need the following to run iridium locally:

Or try it for free

Download the release package:

$ wget

Unzip the package

$ tar -xzf iridium-0.2.1-bin.tar.gz

For the rest of this setup all commands are run from the root of the distribution folder, so switch to it:

$ cd iridium-0.2.1-bin

Verify Installation

You can check that you successfully installed iridium by executing the cli tool

$ bin/iridium --help

Your output should be similar to the following

bin/iridium --help
Usage: iridium [-hV] [COMMAND]
iridium management cli
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
  init  inits the system
  run   run iridium

List the contents of the file by executing

ls -1f

The following directories and files are created


Descriptions of each file or folder are below; |Directory / File | Description | ||| | tools | holds tool configurations to help Iridium run, e.g. Docker Compose | | conf | Configuration files for Iridium | | lib | jars used by Iridium | | bin | the iridium entry point |

Now you can stand up Iridium locally