A newer version of Hazelcast CLC is available.

View latest

Installing the Hazelcast CLC

5.4.0 5.3.7 5.3.6 5.3.5 5.3.4 5.2.1

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:

  • Using an install script on Linux or macOS

  • Windows installer

  • Downloading a pre-built binary

Installing on macOS

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

  1. Run the following command to install CLC using the install script we provide:

    curl https://hazelcast.com/clc/install.sh | bash

Installing on Linux

The Hazelcast CLC runs on any recent Linux distribution. We test it on Ubuntu 22.04.

  1. Run the following command to install CLC using the install script we provide:

    curl https://hazelcast.com/clc/install.sh | bash

Installing on Windows

The Hazelcast CLC is supported on Windows 10 or newer versions. We provide pre-built binaries only for 64bit Intel/AMD architecture.

  1. Go to the releases page, and locate the Windows installer file (hazelcast-clc-setup-v5.3.6.exe).

  2. Download and the run the installer on your system to start the installation wizard.

  3. Follow the steps on the wizard; when you see the "Completing the Hazelcast CLC Setup Wizard" dialog, press kbd:[Finish] to complete the installation.

  4. clc.exe is automatically added to the PATH environment variable, so it can be started in the terminal without its full path.

  5. Start the Hazelcast CLC from the start menu or by running the following command.

    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

If installed, the Hazelcast CLC version information displays.

Uninstalling the Hazelcast CLC

Choose the option that corresponds to your installation method.

  • Windows

  • Install Script (Linux/macOS)

  1. Go to Apps & Features setting (Start menu → Windows Settings → Apps).

  2. Locate Hazelcast CLC version 5.3.6 under Apps & Features list.

  3. Right-click on it and select Uninstall.

  4. Press kbd:[Yes] on the uninstallation dialog.

Delete the $HOME/.hazelcast 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.