GridGain Developers Hub

Cli Config

CLI Configuration Parameters

ignite.jdbc.key-store.path=
ignite.cluster-endpoint-url=http://localhost:10300
ignite.jdbc.client-auth=
ignite.rest.key-store.password=
ignite.jdbc.key-store.password=
ignite.cli.sql.multiline=true
ignite.cli.syntax-highlighting=true
ignite.cli.color-scheme=solarized-dark
ignite.cli.pager.enabled=true
ignite.cli.pager.command=less -RFX
ignite.cli.sql.display-page-size=1000
ignite.rest.trust-store.path=
ignite.jdbc.trust-store.password=
ignite.auth.basic.username=
ignite.jdbc-url=jdbc:ignite:thin://127.0.0.1:10800
ignite.rest.key-store.path=
ignite.rest.trust-store.password=
ignite.jdbc.trust-store.path=
ignite.auth.basic.password=
Property Default Description

ignite.jdbc.key-store.path

Path to the JDBC keystore file for SSL/TLS client authentication.

ignite.cluster-endpoint-url

http://127.0.1.1:10300

URL endpoint for connecting to the Ignite cluster REST API.

ignite.jdbc.client-auth

If JDBC client authorization is enabled in CLI.

ignite.rest.key-store.password

Password for the REST API keystore file.

ignite.jdbc.key-store.password

Password for the JDBC keystore file.

ignite.cli.sql.multiline

true

Enables multiline input mode for SQL commands in the CLI.

ignite.cli.syntax-highlighting

true

Enables syntax highlighting in CLI output.

ignite.cli.color-scheme

solarized-dark

Color theme for CLI output. See the Color Themes section for more information.

ignite.cli.pager.enabled

true on UNIX, false on Windows

Enables pager for long output in CLI.

ignite.cli.pager.command

less -RFX on UNIX, more on Windows

Command used for paging output.

ignite.cli.sql.display-page-size

1000

Number of rows fetched per page when displaying SQL query results in the CLI.

ignite.rest.trust-store.path

Path to the REST API truststore file for SSL/TLS server verification.

ignite.jdbc.trust-store.password

Password for the JDBC truststore file.

ignite.auth.basic.username

Username for basic authentication when connecting to the cluster.

ignite.jdbc-url

jdbc:ignite:thin://127.0.0.1:10800

JDBC connection URL for connecting to the Ignite cluster.

ignite.rest.key-store.path

Path to the REST API keystore file for SSL/TLS client authentication.

ignite.rest.trust-store.password

Password for the REST API truststore file.

ignite.jdbc.trust-store.path

Path to the JDBC truststore file for SSL/TLS server verification.

ignite.auth.basic.password

Password for basic authentication when connecting to the cluster.

Color Themes

The CLI tool supports multiple color themes to improve readability in different terminal environments. The following themes are available:

  • solarized-dark - Default theme, optimized for readability on dark backgrounds.

  • dark - High-contrast theme for dark backgrounds.

  • solarized-light - Alternative theme, optimized for readability on light backgrounds.

  • light - Dark colors theme for light backgrounds.

To change the color theme, use the following command:

cli config set ignite.cli.color-scheme=solarized-light

Pager Configuration

The CLI tool automatically uses paging for long outputs. The pager mode is enabled by default on UNIX systems and can be configured with the following parameters:

  • ignite.cli.pager.enabled - Enable or disable the pager functionality.

  • ignite.cli.pager.command - Specify the command to use for paging (default: less -RFX on UNIX, more on Windows).

  • ignite.cli.sql.display-page-size - Set the number of rows fetched per page for SQL results (default: 1000).

To disable the pager:

cli config set ignite.cli.pager.enabled=false

You can also use a custom pager command by setting it in the configuration:

cli config set ignite.cli.pager.command="less -S"

Configuration Profiles

GridGain CLI supports configuration profiles to manage different sets of settings.

Use the following commands to create and manage profiles:

  • Create a new configuration profile:

    cli config create <profile_name>

  • Switch to an existing profile:

    cli config activate <profile_name>

  • Display all available profiles:

    cli config list

  • Display the currently used profile with all custom settings:

    cli config show

Each profile stores its own CLI-specific settings, allowing isolated configurations for different use cases.

© 2026 GridGain Systems, Inc. All Rights Reserved. Privacy Policy | Legal Notices. GridGain® is a registered trademark of GridGain Systems, Inc.
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.

Last updated on Mar 06, 2026