Crates.io | rabbiteer |
lib.rs | rabbiteer |
version | 1.4.1 |
source | src |
created_at | 2016-12-04 23:28:29.213776 |
updated_at | 2018-09-09 07:56:01.217009 |
description | AMQP/RabbitMQ input/output CLI tool |
homepage | |
repository | https://github.com/algesten/rabbiteer-rs |
max_upload_size | |
id | 7467 |
size | 39,923 |
CLI tool for publishing and subscribing to RabbitMQ.
Install Cargo (Rust).
$ brew install rust
Install rabbiteer.
$ cargo install rabbiteer
The command has two "modes", publish
and subscribe
.
$ rabbiteer [general opts] publish/subscribe [specific opts]
$ rabbiteer --help
...
OPTIONS:
-h, --host <host> RabbitMQ host [default: 127.0.0.1]
-p, --password <password> Password to authenticate with [default: guest]
-P, --port <port> Port to connect to [default: 5672]
-U, --url <url> AMQP connection url (amqp://user:pass@host:port/vhost)
-u, --user <user> User to authenticate with [default: guest]
-v, --vhost <vhost> Virtual host [default: ]
The connection string can be set using the AMQP_URL
environment
variable.
$ export AMQP_URL="amqp://joe:secret@myspecialhost/somevhost"
$ rabbiteer subscribe -e ttninjs-batch
The connection can be specified in a JSON file pointed out by CONF
environment variable.
$ cat conf-localhost.json
{
"amqp": {
"connection": {
"host": "localhost",
"vhost": "docker",
"login": "admin",
"password": "admin"
}
}
}
$ export CONF=conf-localhost.json
$ rabbiteer subscribe -e ttninjs-batch
Publishing pushes data from stdin or a file to an exchange.
$ rabbiteer publish --help
...
FLAGS:
--rpc Publish as RPC with replyTo and wait for reply.
OPTIONS:
-c, --content-type <content_type> Content type such as application/json. Inferred from filename if
possible.
-e, --exchange <exchange> Exchange to publish to [default ]
-f, --file <file> Filename (- is stdin) [default: -]
-H, --header <header>... Header on the form "My-Header: Value"
-r, --routing-key <routing_key> Routing key [default: ]
-z, --priority <priority> Priority
-t, --rpctimeout <rpctimeout> RPC timeout in milliseconds
Provide the content-type as arg.
$ echo "{\"panda\":true}" | \
rabbiteer -u admin -p admin -v prod publish -e myexchange -c application/json
Content-type is inferred if possible.
$ rabbiteer -u admin -p admin -v prod publish -e myexchange -H "batch: true" -f ./foo.json
Using the replyTo
header.
$ CONF=conf.json rabbiteer publish -e myservice -r somecall --rpc -f ./foo.json
Calls myservice/somecall
using the contents of file foo.json
and sets up
a replyTo
header and waits the the rpc reply. The reply will be printed
to stdout.
Subscribing binds an anonymous queue to an exchange and listens to messages pushed to that exchange. The messages can either be dumped to stdout or as files to a directory.
$ rabbiteer subscribe --help
...
FLAGS:
-i, --info Include delivery info (and headers).
OPTIONS:
-e, --exchange <exchange> Exchange to subscribe to
-o, --output <output> Output directory (- is stdout) [default: -]
-r, --routing-key <routing_key> Routing key [default: #]
Outputs the body of each message to stdout. Makes no conversion of the body. If the body is binary, you will see gibberish in the terminal.
$ rabbiteer -u admin -p admin -v prod subscribe -e myexchange
...
-i
means we make a JSON wrapping of the message so we can include
some basic information about the delivery.
This always produces a JSON structure. When the body is binary (as
indicated by content_type
), the data is base64 encoded and when the
type is text/...
, we output it as a JSON string.
The format is:
{
"deliver":{
"consumer_tag":"amq.ctag-Tjxx5Qy5zAr0o_yiLOsNEg",
"delivery_tag":1,
"redelivered":false,
"exchange":"myexchange",
"routing_key":"text"
},
"props":{
"content_type":"application/json",
"headers":{
"backendUpdate":false,
"batch":false,
"index":"dist-text",
"oper":"index"
}
},
"data": "body"
}
$ rabbiteer -u admin -p admin -v prod subscribe -e myexchange -i
...
With -o
the body of each individual message is output to a separate
file. The header fileName
can be supplied by the sender, in which case
that file is (over-)written.
$ rabbiteer -u admin -p admin -v prod subscribe -e myexchange -o /tmp
...
The MIT License (MIT)
Copyright (c) 2014-2016 rabbiteer devs
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.