clc

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

Synopsis

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.

Parameter Description Default

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` Current working directory The parent directory of the `clc` executable `$CLC_HOME/default` directory
`--format, -f`	Set the output format `csv` `delimited`: By tab characters `json` `table`	Interactive mode: `table` Non-interactive mode: `delimited`
`--log.level`	Set the log level, one of: `debug` `info` `warning` `error`	`info`
`--log.path`	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.	`false`
`--verbose`	Enable output with more information.	`false`

--config, -c

Path to the configuration file in YAML format.

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

--format, -f

Set the output format

--log.level

Set the log level, one of:

info

--log.path

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.

false

--verbose

Enable output with more information.

false

Command Description

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.

Start a Hazelcast CLC shell.

clc help

Display help information for the clc command.

Generate shell autocompletion.

Print CLC home directory.

Manage the configuration used by the Hazelcast CLC.

Manage map data structures.