Skip to main content
Version: 5.7.1

Environment Variables

The Hazelcast CLC recognizes the following environment variables.

Environment VariableDescriptionDefault
CLC_CLIENT_LABELSSets the client labels. The labels must be separated by commas. This value is used in Cloud and Management Center. See Management Center documentation for more information.CLC,USER@HOST-TIMESTAMP
CLC_CLIENT_NAMESet a custom client name. The client name appears in the Cloud dashboard and in the cluster metrics of Management Center.USER@HOST-TIMESTAMP
CLC_HOMEOverrides the CLC home directory. You can find out the current CLC home directory using clc home command.%HOMEDRIVE%:%HOMEPATH%\AppData\Roaming\Hazelcast on Windows, $HOME/.hazelcast on other platforms.
CLC_MAX_COLSSets the maximum width of a column in a table output. This is useful when the width cannot be determined.Terminal width.
CLC_SKIP_SERVER_VERSION_CHECKSome Hazelcast CLC features require the cluster to be of a certain version. If set to 1, this variable disables the version check performed by the CLC.0 (false)
CLC_CLOUD_API_KEYSets the Cloud API key.
CLC_CLOUD_API_SECRETSets the Cloud API secret.
CLC_CONFIGSets the configuration CLC will use if --config flag is not specified.
HZ_PHONE_HOME_ENABLEDEnables phone home collection for CLC usage statistics. Set 'false' to disable phone homes.true

The following environment variables are experimental and may be removed in a future version.

Environment VariableDescriptionDefault
CLC_EXPERIMENTAL_FORMATTERSets a formatter for the highlighting of SQL syntax, either: terminal, terminal8, terminal16, terminal256, or terminal16m. Only with the gohxs readline implementation.
CLC_EXPERIMENTAL_READLINESets the readline implementation, either gohxs or ny.ny for Windows, gohxs for other platforms.
CLC_EXPERIMENTAL_STYLERSets a color theme for the highlighting of SQL syntax. See Chroma styles for the options. Only with the gohxs readline implementation.clc-default
NO_COLORDisables color output if set to 1.0 (false)
CLC_SKIP_UPDATE_CHECKDisables checking new version of CLC.0 (false)