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.

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

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

--timeout

Timeout for operation to complete.

The duration is a string in the form of AMOUNTunit where AMOUNT is an integer, and unit is one of the following:

ms: milliseconds
s: seconds
m: minutes
h: hours

Underscore (_) character is ignored in the AMOUNT. unit is optional and defaults to s if not specified.

The following are a few of the valid DURATIONs:

5: 5 seconds
5s: 5 seconds
10000ms: 10000 milliseconds
10_000_000ms: 10000000 milliseconds

This is a client-side timeout, the operation you started maybe in progress on the server-side even if the given timeout is exceeded.

Commands

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 script`	Execute CLC script.
`clc sql`	Execute SQL queries.
`clc job`	Create and manage Jet jobs.
`clc snapshot`	Manage Jet job snapshots.
`clc viridian`	Cloud related operations.
`clc object`	Commands for generic distributed data structures.
`clc version`	Get version information.

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.