Hazelcast Logo
  • Platform
  • Solutions
  • Resources
  • Developers
  • Docs
Hazelcast Logo
  • Platform
  • Solutions
  • Resources
  • Developers
  • Docs
Hazelcast Platform
5.4
  • Hazelcast Platform
  • Management Center
  • Hazelcast Cloud
  • Hazelcast CLC
  • Hazelcast Operator
  • Tutorials
  • 5.7-SNAPSHOT
  • 5.6
  • 5.5
  • 5.4
  • 5.3
  • 5.2
  • 5.1
  • 5.0
  • Get started
    • What’s new in 5.4
    • What is Hazelcast Platform
    • Available versions
    • Start a local cluster
      • Docker
      • CLI
      • Binary
      • Java Embedded
    • Get started with Enterprise Edition
      • Persist Map Entries on Disk
      • Authenticate Client Connections
      • Replicate a Map over Clusters in a WAN
      • Deploy Blue-Green Clusters
    • Get started with SQL
      • Get Started with SQL Over Maps
      • Get Started with SQL Over Kafka
      • Get Started with SQL Over Files
    • Get started with a Hazelcast Client
    • Getting Support
  • Install & upgrade
    • Overview
      • Available Topologies
      • Versioning and Compatibility
      • Deploying on Cloud
        • Deploying a Cluster on Amazon AWS
        • Deploying a Cluster on Microsoft Azure
        • Deploying a Cluster on Google Cloud Platform
      • Deploying on Docker
    • Install Enterprise Edition
      • Managing Enterprise license keys
    • Install Community Edition
    • Using the Data Migration Tool
    • Upgrades
      • Upgrading from Jet
      • Upgrading from IMDG 4.x
      • Upgrading from IMDG 3.12.x
      • Migrating Data from IMDG 3.12.x
        • DMT Command Reference
    • Release notes
      • 5.4.3
      • 5.4.2
      • 5.4.1
      • 5.4.0
  • Develop & build
    • Architecture
      • Overview
      • Data Partitioning and Replication
      • Jet: How Hazelcast Models and Executes Jobs
      • Cooperative Multithreading
      • How Hazelcast Handles Event Disorder
      • Jet: Sliding Window Aggregation
      • In-Memory Storage
    • Best Practices
      • Capacity Planning
      • Performance Tips
      • Back Pressure
      • Pipelining
      • AWS Deployments
      • Threading
      • Near Cache
      • Data Affinity
    • Member/Client Discovery
      • Discovery Mechanisms
      • Discovering Members by TCP
      • Discovering Members by Multicast
      • Discovering Java Clients
    • Kubernetes
      • Overview
      • Deploy Hazelcast using Kubernetes
      • Hazelcast Platform Operator
      • Discovery and Partitioning
      • Persistence
      • Troubleshooting and Limitations
      • Helm Charts
        • Hazelcast Chart
        • Hazelcast Enterprise Edition Chart
        • Helm Upgrade Guide
        • Adding Custom Jar
        • Enabling External Access
        • Configuring SSL
        • Dynamic Persistence Configuration
    • Distributed Data Structures
      • Overview
      • Map
        • Overview
        • Configuring Maps
        • Creating a Map
        • Reading Data From a Map
        • Updating Map Entries
        • Setting the In-Memory Format of Map Entries
        • Making Your Map Data Safe
        • Managing Map Memory
        • Locking Maps
        • Acting Upon Changes to a Map
        • Reading Map Metrics
        • Entry Processor
      • JCache
        • Overview
        • JCache Overview
        • JCache Setup and Configuration
        • JCache Providers
        • JCache API
        • JCache - Hazelcast Instance Integration
        • Hazelcast JCache Extension - ICache
        • Testing for JCache Specification Compliance
      • Queue
      • Priority Queue
      • MultiMap
      • Set
      • List
      • Ringbuffer
      • Topic
      • Reliable Topic
      • FencedLock
      • IAtomicLong
      • ISemaphore
      • IAtomicReference
      • ICountDownLatch
      • CPMap
      • PN Counter
      • Flake ID Generator
      • Replicated Map
      • Cardinality Estimator Service
      • Event Journal
    • Distributed Computing
      • Executor Services
    • Java Executor Service
      • Java Executor Service
      • Durable Executor Service
      • Scheduled Executor Service
      • User Code Namespaces
      • Enable User Code Namespaces
      • Static Configuration
        • Member Configuration
        • Data Structures
        • Programmatic Configuration
      • Dynamic Configuration API
        • Configure Client
      • Non-associated Namespaces
      • Security
      • Migrate from User Code Deployment
      • User Code Deployment
        • Deploying User Code on the Member
        • Deploying User Code from Clients
        • Accessing Domain Objects Without Domain Classes
    • Data Ingestion & Query
      • Ingesting Data from External Sources
      • Running Distributed Queries
    • Building a Cache with MapStore
      • Using the generic MapLoader
      • Using the generic MapStore
      • Implementing a Custom MapStore
      • Configuring a MapStore
      • Map Operations that Trigger Methods on a MapStore
    • Building Data Pipelines
      • About Data Pipelines
      • Get Started
        • Get Started with Stream Processing (Embedded)
        • Get Started with Stream Processing (Client/Server)
      • Ingesting Data from Sources
        • Overview
        • Creating a Custom Streaming Source
        • Adding Batching to a Custom Source
      • Processing Data
        • Transforms
        • Building a Custom Aggregate Operation
        • Apply a Custom Transform with Python
      • Sending Results to Sinks
        • Overview
        • Create a Custom Sink
      • Stream Processing
        • About Stream Processing Pipelines
        • Apply Windowed Aggregation
        • Subscribe to Changes to a Map
        • Enrich a Stream
        • Mapping Data in a Pipeline Using a a gRPC Service
        • Change Data Capture (CDC)
          • Setting Up a Database for Change Data Capture
          • Capture Changes from MySQL
          • Capture Changes from PostgreSQL
          • Join Change Data Capture Records
        • Extract Transform Load (ETL)
          • Connect to Apache Kafka
          • Connect to Amazon Kinesis
          • Group Messages from Apache Pulsar
      • Serializing Pipelines
      • Configuring Jobs
      • Securing Jobs
      • Submitting Jobs
      • Managing Jobs
      • Monitoring Jobs
      • Updating Jobs
      • Testing Sources and Sinks for XA Transaction Support
    • SQL
      • Overview
      • SQL Over Maps
        • Tutorial
        • Queries
        • Mappings
      • SQL Over Kafka
        • Tutorial
        • Mappings
      • SQL Over File Systems
        • Tutorial
        • Mappings
      • SQL Over JDBC
        • Mappings
      • SQL Over MongoDB
        • Mappings
      • Working with JSON
      • Stream Processing
      • Query Parameters
      • Finding Mappings
      • Improving Performance
      • Reflection Configuration
      • Troubleshooting
      • Statements
        • Overview
        • ALTER JOB
        • CREATE DATA CONNECTION
        • CREATE INDEX
        • CREATE JOB
        • CREATE MAPPING
        • CREATE SNAPSHOT
        • CREATE VIEW
        • DELETE
        • DROP DATA CONNECTION
        • DROP JOB
        • DROP MAPPING
        • DROP SNAPSHOT
        • DROP VIEW
        • EXPLAIN
        • INSERT INTO/SINK INTO
        • SELECT
        • SHOW JOBS
        • SHOW RESOURCES
        • SHOW MAPPINGS
        • UPDATE
      • Functions and Expressions
      • SQL Data Types
      • User-Defined Types in SQL
      • Optimizing SQL queries
        • Partition Pruning
      • Predicates API
    • Predicates API
    • Improving Query Performance
      • Indexing Maps
      • Caching Deserialized Values
      • Preventing Out of Memory Exceptions when Querying a Map
    • Java Executor Service
      • Java Executor Service
      • Durable Executor Service
      • Scheduled Executor Service
    • User Code Namespaces
      • Enable User Code Namespaces
      • Static Configuration
        • Member Configuration
        • Data Structures
        • Programmatic Configuration
      • Dynamic Configuration API
        • Configure Client
      • Non-associated Namespaces
      • Security
      • Migrate from User Code Deployment
      • User Code Deployment
        • Deploying User Code on the Member
        • Deploying User Code from Clients
        • Accessing Domain Objects Without Domain Classes
    • Serialization
      • Overview
      • Compact Serialization
        • Compact Serialization Binary Specification
      • HazelcastJsonValue
      • Custom Serialization
      • Other Serialization Options
        • IdentifiedDataSerializable
        • DataSerializable
        • Java Serializable and Externalizable
        • Portable
        • Global Serializer
        • HazelcastInstanceAware
      • Configuring Serializers
    • Listening to Events
      • Overview
      • Cluster Events
      • Event Listeners for Hazelcast Clients
      • Global Event Configuration
      • Distributed Object Events
    • Transactions
      • Creating a Transaction Interface
      • Providing XA Transactions
    • Testing Applications
      • Overview
      • Testing Jobs
      • Hazelcast Simulator
    • Troubleshooting
      • Overview
      • Error Handling Strategies for Jobs
      • Actions and Remedies for Alerts
      • Recovery from a Partial or Total Failure
      • Recovery from Client Connection Failures
      • Common Exception Types
  • Operate & manage
    • Configuration
      • Overview
      • Static Configuration
        • Member Configuration Files
        • Configuring Hazelcast in Embedded Mode
        • System Props and Environment Variables
        • JVM Parameters
        • Configuring Hazelcast in Spring
        • Configuration Pattern Matcher
        • Using Wildcards
      • Dynamic Configuration
        • Overview
        • Programmatic API
        • Update and Reload with REST
        • Configuration Options
      • Phone Homes
    • Configuring Logging
    • Maintaining a Cluster
      • Rolling Upgrades
      • Monitoring
      • Cluster and Member States
      • Filtering Members with Attributes
      • Lite Members
      • Shutting Down
      • Cluster Utilities
    • Partition Groups and Networking
      • Grouping Clusters
      • Grouping Partitions
      • Networking
    • Configuring the Jet Engine
    • Securing a Cluster
      • Security Overview
      • Security Defaults
      • Security Hardening Recommendations
      • Enabling JAAS Security
      • TLS/SSL
        • TLS/SSL Basics
        • Integrating OpenSSL / BoringSSL
        • Other TLS-Related Configurations
      • Authentication Types
        • Default authentication
        • Simple Authentication
        • JAAS authentication
      • Security Realms
      • Cluster Member Security
      • Client Security
      • Socket Interceptor
      • Security Interceptor
      • Advanced Security Features
        • Logging Auditable Events
        • Validating Secrets Using Strength Policy
        • FIPS 140-2
        • Security Debugging
        • Encryption
    • Configuring for Fault Tolerance
      • Backups
      • Persistence
        • Overview
        • Configuration
        • Backups
        • Force-start
        • Partial-start
        • Intel Optane DC
        • Copying Data
        • Performance Benchmark
        • Design Details
      • Detecting Failures
        • Failure Detectors
        • Deadline Failure Detector
        • Phi Accrual Failure Detector
        • Ping Failure Detector
      • Connection Timeouts
      • Fault Tolerance for Jobs
      • Handling Network Partitions
        • Network Partitioning
        • Partial Network Partitions
        • Dealing with Network Partitions
        • Split-Brain Protection
        • Split-Brain Recovery
      • High-Density Memory Store
    • CP Subsystem
      • Overview
      • Configuration
      • Management
      • Best Practices
    • Synchronizing Data Across Clusters
      • WAN Replication Overview
      • WAN Replication Modes
      • WAN Quickstart
      • Configuring WAN Replication
      • Configuring for IMap and ICache
      • Advanced Features
      • Fine-Tuning WAN Replication
      • Failure Detection and Recovery
      • REST API for WAN Wrap-Up
    • Thread-Per-Core (TPC)
    • Extending Hazelcast
      • OperationParker
      • Discovery SPI
      • Config Properties SPI
    • OSGI
      • OSGI Support
      • API
      • Configuring Hazelcast OSGI Support
      • Design
      • Using Hazelcast OSGI Service
  • Integrate
    • Overview
    • Integrate with Spring
      • Overview
      • Configuring Hazelcast in Spring
      • Enabling SpringAware Objects
      • Adding Caching to Spring
      • Configuring Hibernate Second-Level Cache
      • Configuring Hazelcast Transaction Manager
      • Spring Best Practices
    • Messaging System Connectors
      • Overview
      • Apache Kafka Connector
      • Amazon Kinesis Connector
      • JMS Message Queue Connector
    • Database & CDC Connectors
      • JDBC Connector
      • CDC Connector
      • Elasticsearch Connector
      • MongoDB Connector
    • File Connectors
      • Unified File Connector
      • Legacy File Connector
    • Hazelcast Data Structure Connectors
      • Map Connector
      • JCache Connector
      • List Connector
      • Map Connector
      • Reliable Topic Connector
    • Kafka Connect Source Connectors
    • Socket Connector
    • Test Source Connectors
    • Custom Connectors
  • Clients & APIs
    • Overview
    • Java Client
    • C++ Client
    • .NET Client
    • REST API
      • Community Edition REST API
    • Memcache Client
    • Python Client
    • Node.js Client
    • Go Client
  • Tools & plugins
    • Management Center
    • Platform Operator
    • Command Line Client (CLC)
    • Simulator
    • Hazelcast Plugins
      • Cloud Discovery Plugins
      • Web Session Replication Plugins
      • Framework Integration Plugins
      • Other Integrations
  • Reference
    • Glossary
    • System Properties
    • Frequently Asked Questions
    • Metrics
  • Platform
  • Tools & plugins
  • Command Line Client (CLC)

Hazelcast Command-Line Client

API docs
5.7-SNAPSHOT 5.6 5.5 5.4 5.3 5.2 5.1 5.0

The Hazelcast Command-Line Client (CLC) is a command-line tool that allows you to connect to and interact with clusters on Hazelcast Platform and Hazelcast Cloud. You can use the CLC to execute commands through a terminal. See its documentation for example use cases, tutorials, and supported commands.

Platform Operator Simulator
Edit this page Report an issue
Was this helpful?

Thank you for your feedback.

×

Send us your feedback

Thank you for helping us improve Hazelcast documentation.

Help and support

Report an issue Ask Community Online Training Contact Support
Terms of service Privacy Contact us