From 8fe90a4d321575333179a493f3bc26ad87a390c8 Mon Sep 17 00:00:00 2001 From: amckenzie Date: Fri, 12 Jul 2019 14:50:30 +0100 Subject: [PATCH] Rename project and update readme --- CHANGELOG.md | 4 +--- README.md | 32 ++++++++++++++++++++------------ pom.xml | 4 ++-- 3 files changed, 23 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d055a2..2dedfd2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,13 +5,11 @@ on [Keep a CHANGELOG](http://keepachangelog.com/). This project adheres to ## [Unreleased] ### Added +- Initial release of the catchup-shuttering-manager CLI tool, supporting invocation of the event sourcing frameworks SHUTTER, UNSHUTTER, CATCHUP, REBUILD operations. - New command '--list' which lists the commands available on your Wildfly instance. - Authentication to a remote Wildfly instance with commands '--username' and '--password' ### Changed - Application now run in a Weld container to allow for dependency injection -## [1.0.0] - 2019-06-19 -### Added -- Initial release of the catchup-shuttering-manager CLI tool, supporting invocation of the event sourcing frameworks SHUTTER, UNSHUTTER, CATCHUP, REBUILD operations. diff --git a/README.md b/README.md index 15b80a2..5b57450 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ # Framework Jmx Command Client -[![Build Status](https://travis-ci.org/CJSCommonPlatform/catchup-and-shuttering-manager.svg?branch=master)](https://travis-ci.org/CJSCommonPlatform/catchup-and-shuttering-manager) [![Coverage Status](https://coveralls.io/repos/github/CJSCommonPlatform/catchup-and-shuttering-manager/badge.svg?branch=master)](https://coveralls.io/github/CJSCommonPlatform/catchup-and-shuttering-manager?branch=master) +[![Build Status](https://travis-ci.org/CJSCommonPlatform/framework-jmx-command-client.svg?branch=master)](https://travis-ci.org/CJSCommonPlatform/framework-jmx-command-client) [![Coverage Status](https://coveralls.io/repos/github/CJSCommonPlatform/framework-jmx-command-client/badge.svg?branch=master)](https://coveralls.io/github/CJSCommonPlatform/framework-jmx-command-client?branch=master) + +Command line client tool for running Framework System Commands against any framework based context. + +From Framework 6.0.0 and above ## Usage -catchup-shuttering-manager - -c,--command Framework command to execute. - -h,--help Show help. - -ho,--host Hostname or IP address of the Wildfly server. Defaults to localhost - -p,--port Wildfly management port. Defaults to 9990 (the default for Wildfly) - -u, --username Optional username for Wildfly management security - -pw, --password Optional password for Wildfly management security - -l, --list List of all framework commands - +**java -jar framework-jmx-command-client.jar _\_** + +- **-c,--command** _The name of the System Command to run_ +- **-h,--host** _Hostname or IP address of the Wildfly server. Defaults to localhost_ +- **-p,--port** _Wildfly management port. Defaults to 9990 (the default for Wildfly)_ +- **-u, --username** _Optional username for Wildfly management security_ +- **-pw, --password** _Optional password for Wildfly management security_ +- **-l, --list** _Shows a list of all framework System Commands and exits_ +- **--help** _Show help message and exits._ - java -jar catchup-shuttering-manager.jar -c "PING" +### For example +_java -jar framework-jmx-command-client.jar --command PING_ + +Would run the command 'PING' against a local wildfly instance with no authentication - Note: If you are running wildfly on your local machine and running as the same user as the one you are +###### Note: + If you are running wildfly on your local machine and running as the same user as the one you are logged in as, then username/password are not required. (However, if running wildfly in a virtual machine like vagrant, username and password will be required) diff --git a/pom.xml b/pom.xml index 6290567..01c7996 100644 --- a/pom.xml +++ b/pom.xml @@ -11,11 +11,11 @@ 1.7.1 - catchup-shuttering-manager + framework-jmx-command-client 1.0.0-SNAPSHOT - catchup-shuttering-manager + framework-jmx-command-client 4.0.1 6.0.0-RC4