Repository files navigation

• Overview
• Why use the Coherence CLI?
• Install the CLI
• Getting Started
• Supported Coherence Versions
• Get Involved

The Coherence command line interface,cohctl, is a lightweight tool, in the tradition of tools such as kubectl,which can be scripted or used interactively to manage and monitor Coherence clusters. You can usecohctl to view cluster informationsuch as services, caches, members, etc, as well as perform various management operations against clusters.

The CLI accesses clusters using the HTTP Management over REST interface and therefore requires this to be enabled on any clustersyou want to monitor or manage. See theCoherence Documentationfor more information on setting up Management over REST.

NOTE: The CLI does not replace current management and monitoring tools such as theCoherence VisualVM Plugin,Enterprise Manager, orGrafana Dashboards, but complements andprovides a lightweight and scriptable alternative.

The CLI complements your existing Coherence management tools and allows you to:

• Interactively monitor your Coherence clusters from a lightweight terminal-based interface
• Monitor service "StatusHA" during rolling restarts of Coherence clusters
• Script Coherence monitoring and incorporate results into other management tooling
• Output results in various formats including text, JSON and utilize JsonPath to extract attributes of interest
• Gather information that may be useful for Oracle Support to help diagnose issues
• Connect to standalone or WebLogic Server based clusters from commercial versions 12.2.1.4 and above as well as the latestCoherence Community Edition (CE) versions
• Retrieve thread dumps across members
• Create, start and scale development clusters (experimental)

The Coherence CLI is available for macOS, Linux and Windows for x86 and Arm based processors.

For macOS and Linux platforms, use the following to install the latest version of the CLI:

curl -sL https://raw.githubusercontent.com/oracle/coherence-cli/main/scripts/install.sh| bash

Note: On linux,sudo is required to copycohctl to the destination directory/usr/local/bin/

For Windows, use the curl command below, then copycohctl.exe to a directory in your PATH:

curl -sLo cohctl.exe"https://github.com/oracle/coherence-cli/releases/download/1.8.0/cohctl-1.8.0-windows-amd64.exe"

Note: Change theamd64 toarm for ARM based processor in the URL above.

See theInstall guide formore information on downloading and installing the CLI.

Documentation for the Coherence CLI is availablehere

The fastest way to experience the Coherence CLI is to follow theQuick Start guide.

The CLI supports and is certified against the following Community and Commercial editions of Coherence:

Coherence Community Edition

• 24.09+
• 22.06+
• 14.1.2-0-+

Note: As CE 14.1.2-0-0 is out, CE 14.1.1-0+ is no longer supported or tested. Please use CE 14.1.2-0+

Coherence Grid/ Enterprise Edition

• 12.2.1.4.x - minimum patch level of 12.2.1.4.10+ required
• 14.1.1.0.x - minimum patch level of 14.1.1.0.5+ required
• 14.1.1.2206.x Feature Pack
• 14.1.2.0.x

Note: If you are on a patch set below the minimum recommended above, then CLI may work, but some functionality may not be available. Itis always recommended to upgrade to the latest Coherence patch as soon as you are able to.

We have apublic Slack channel where you can get in touch with us to ask questions about using the Coherence CLIor give us feedback or suggestions about what features and improvements you would like to see. We would loveto hear from you. To join our channel,pleasevisit this site to get an invitation.
The invitation email will include details of how to access our Slackworkspace. After you are logged in, please come to#coherence-cli and say, "hello!"

This project welcomes contributions from the community. Before submitting a pull request, pleasereview our contribution guide

Please consult thesecurity guide for our responsible security vulnerability disclosure process

Copyright (c) 2021, 2024 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown athttps://oss.oracle.com/licenses/upl/.