A newer version of Hazelcast CLC is available.

View latest

Configuration for Hazelcast CLC

Hazelcast CLC allows you to configure settings for cluster connection credentials, using a configuration file. Some of those settings may be overriden using global command-line parameters.

CLC has a simple YAML configuration, usually named config.yaml. This file can exist anywhere in the file system, and can be used with the --config (or -c) flag:

clc -c test/config.yaml

If there is a config.yaml in the same directory with the CLC binary and the configuration was not explicitly set, CLC tries to load that configuration file:

ls -lh
total 17M
-rwxrwxr-x 1 yuce yuce  17M Nov 26 23:11 clc*
-rw------- 1 yuce yuce  200 Nov 26 23:12 config.yaml

configs directory in $CLC_HOME is special, it contains all the configurations known to CLC. You can use the clc home command in order to see where $CLC_HOME is:

clc home

Known configurations can be directly specified by their names, instead of the full path. clc config list command lists the configurations known to CLC:

# List configurations
$ clc config list

# Start CLC shell with configuration named prod
$ clc -c pr-3066

If no configuration is specified, the default configuration is used.

CLC Configuration with Command-Line Parameters

Command-line parameters are for overriding some configuration settings in the configuration file, such as the log settings.

You can override the values in the configuration file by providing the following command-line parameters to any clc command:

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.