A newer version of Hazelcast CLC is available.

View latest


The clc command comes with subcommands for managing many aspects of a Hazelcast cluster.


clc [command] [subcommand] [options]

You can use clc [command] help for information on a specific command. The synopsis for each command shows its parameters and their usage.

Global Options

Parameter Description Default

--config, -c

Path to the configuration file in YAML format.

The following locations are tried in order for the existence of config.yaml

  1. Current working directory

  2. The parent directory of the clc executable

  3. $CLC_HOME/default directory

--format, -f

Set the output format

  • csv

  • delimited: By tab characters

  • json

  • table

  • Interactive mode: table

  • Non-interactive mode: delimited


Set the log level, one of:

  • debug

  • info

  • warning

  • error



Set the log path. Use stderr to log to the screen (stderr).

$CLC_HOME/logs/YYYY-MM-DD.log where YYYY-MM-DD is today’s date.

--quiet, -q

Prevent displaying unnecessary output.



Enable output with more information.



Command Description

clc shell

Start a Hazelcast CLC shell.

clc help

Display help information for the clc command.

clc completion

Generate shell autocompletion.

clc home

Print CLC home directory.

clc config

Manage the configuration used by the Hazelcast CLC.

clc map

Manage map data structures.

clc sql

Execute SQL queries.

clc object

Commands for generic distributed data structures.

clc version

Get version information.