Installing the Hazelcast CLC

The Hazelcast Command-Line Client (CLC) is available to install in macOS, Linux, and Windows environments. You can install the Hazelcast CLC, using one of the following:

Downloading a pre-built binary
Windows installer
Building from source

Installing on macOS

The Hazelcast CLC is supported on macOS 12 or newer versions.

Build from Source

Make sure the following are installed:
- Git (check with the git --version command)
- GNU Make (check with the make --version command)
- Go v1.18 or newer (check with the go version command)

Clone the GitHub repository.

git clone https://github.com/hazelcast/hazelcast-commandline-client.git

Change into the hazelcast-commandline-client directory.
```
cd hazelcast-commandline-client
```
Run the following command to build the Hazelcast CLC.
```
make
```
The clc binary is created in the build directory.
Run the following command to start the Hazelcast CLC.
```
./build/clc
```

Installing on Linux

The Hazelcast CLC is supported on Ubuntu 18.04 or newer versions.

Build from Source

Make sure the following are installed:
- Git (check with the git --version command)
- GNU Make (check with the make --version command)
- Go v1.18 or newer (check with the go version command)

Clone the GitHub repository.

git clone https://github.com/hazelcast/hazelcast-commandline-client.git

Change into the hazelcast-commandline-client directory.
```
cd hazelcast-commandline-client
```
Run the following command to build the Hazelcast CLC.
```
make
```
The clc binary is created in the build directory.
Run the following command to start the Hazelcast CLC.
```
./build/clc
```

Installing on Windows

The Hazelcast CLC is supported on Windows 10 or newer versions.

Go to the latest release page, and locate the Windows installer file (hazelcast-clc-setup-5.2.0-BETA-3.exe).
Download and the run the installer on your system to start the installation wizard.
Follow the steps on the wizard; when you see the "Completing the Hazelcast CLC Setup Wizard" dialog, press Finish to complete the installation.
Start the Hazelcast CLC from the shortcut or by running the following command.
```
.\hazelcast-commandline-client\build\clc.exe
```

Verifying the Hazelcast CLC Installation

To check whether the Hazelcast CLC is installed properly, run the following command on a terminal.

clc version

You should see the Hazelcast CLC version information.

Uninstalling the Hazelcast CLC

Choose the option that corresponds to your installation method.

Windows
Source

Go to Apps & Features setting (Start menu → Windows Settings → Apps).
Locate Hazelcast CLC version 5.2.0-BETA-3 under Apps & Features list.
Right-click on it and select Uninstall.
Press Yes on the uninstallation dialog.

Delete the hazelcast-commandline-client directory.

Next Steps

In this section you’ve learnt how to install the Hazelcast CLC on the supported operating systems. To start using the Hazelcast CLC, check the following resources:

See Get Started for a complete introduction to the Hazelcast CLC.
See Configuration to configure the details of the connection between the Hazelcast CLC and a Hazelcast Platform cluster.
See Command Reference for a complete list and descriptions of commands you can use with the Hazelcast CLC.