Awesome

AMC - Artemis Messaging Client

This project provides a command-line interface (CLI) for sending and receiving messages to/from Apache Artemis, using the AMQP 1.0 protocol. It works with other AMQP 1.0 brokers, too, but the names in the arguments & flags correspond to Artemis. There are also some features specific to Artemis like ANYCAST/MULTICAST routing. Testing has been done with Artemis only.

Usage

You can send a message with the following command:

amc put <queue-name> <message>

You can receive a message with the following command:

amc get <queue-name>

This will print the payload (data) to stdout and remove the message from the queue. Use peek instead of get to keep it in the queue.

You can wait for a message with the -w flag:

amc get -w <queue-name>

The following parameters and environment variables can be used for all commands:

  -s, --server string      server URL of the broker    [$AMC_SERVER]
  -u, --user string        username for SASL login     [$AMC_USER]
  -p, --password string    password for SASL login     [$AMC_PASSWORD]

Advanced Usage

You can set properties (metadata) for the message with the following flags:

amc put <queue-name> -P <key1>=<value1> -P <key2>=<value2> <message>

If a message has properties, the get command will show them automatically. You can suppress this behaviour with the -q flag:

  -q, --quiet    quiet about properties, show data only

Note that in the context of the AMQP 1.0 protocol, the properties are called "Application Properties". The protocol also defines a structure called "Properties" with a finite list of fields like message-id, user-id, etc. In amc we call them "MessageProperties" to avoid confusion. You can see them in verbose mode only.

Working with Files, Redirection of STDOUT

The message can be read from file:

amc put <queue-name> < message.dat

By redirecting the output of get the message data (and only the data) will be written to a file:

amc get <queue-name> > message.dat

The file will be exactly the same as it was sent! Without redirection amc adds a newline character at the end of the message data for better readability.

Testing

The tests are based on the bats testing framework (included) and depend on a local Artemis broker with its default settings.

If you have Docker you can spin up an Artemis container like so:

docker run --name artemis -d \
    -p 8161:8161 -p 5672:5672 \
    apache/activemq-artemis:latest-alpine

Port 5672 is the default port of the AMQP 1.0 protocol. Port 8161 provides access to the Artemis web console, where you can check the queues and messages manually. Default credentials are artemis/artemis.

Then you can start the tests:

./run-tests.sh

Contributing

Contributions are welcome. Please open an issue or submit a pull request. Use the latest version of Go and run tests with Artemis.

License

This project is licensed under the MIT License - see the LICENSE.md file for details