This is an automated email from the ASF dual-hosted git repository.
jbertram pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git
The following commit(s) were added to refs/heads/main by this push:
new 4967a0c4ba NO-JIRA clarify CLI docs
4967a0c4ba is described below
commit 4967a0c4ba807968df2c22a8974fc5d1349aa7b4
Author: Justin Bertram <[email protected]>
AuthorDate: Mon Jun 17 14:06:56 2024 -0500
NO-JIRA clarify CLI docs
---
docs/user-manual/using-cli.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/user-manual/using-cli.adoc b/docs/user-manual/using-cli.adoc
index 9c49a6707f..5a936edca4 100644
--- a/docs/user-manual/using-cli.adoc
+++ b/docs/user-manual/using-cli.adoc
@@ -1,6 +1,9 @@
= Command Line Interface
ActiveMQ Artemis has a Command Line Interface (CLI) that can used to manage a
few aspects of the broker like instance creation, basic user management, queue
& address management, etc.
+This interface is designed for simple use-cases with _humans_ in mind.
+It is not an exhaustive set of commands for complete broker management.
+There is a comprehensive xref:management.adoc[management API] available with
many operations that return JSON formatted output which is better suited for
use in scripts and other automated processes.
There are two ways the CLI can be used:
@@ -9,13 +12,10 @@ There are two ways the CLI can be used:
All commands available through the traditional CLI commands are also available
through the shell interface.
-One benefit of the traditional CLI commands is that they can be used in your
own bash scripts for automation, etc.
-
One benefit of the shell is that it will *reuse* some information as you
repeat commands.
For example, once you supply the broker URI and username & password to one
command those values will be transparently applied other commands in the same
shell session.
Of course, the shell also allows you to avoid retyping `./artemis` for every
command.
-
== Getting Help
You can get a complete list of available commands by typing:
@@ -415,4 +415,4 @@ Connection brokerURL = tcp://localhost:61616
|ExpiryQueue |ExpiryQueue |0 |0
|0 |0 |0 |0 |ANYCAST |
|TEST |TEST |0 |8743
|8743 |0 |0 |0 |ANYCAST |
|activemq.management.2a...|activemq.management.2a...|1 |0
|0 |0 |0 |0 |MULTICAST |
-----
\ No newline at end of file
+----
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
For further information, visit: https://activemq.apache.org/contact
