https://github.com/algesten/rabbiteer-rs
AMQP input/output cli tool
https://github.com/algesten/rabbiteer-rs
Last synced: about 1 month ago
JSON representation
AMQP input/output cli tool
- Host: GitHub
- URL: https://github.com/algesten/rabbiteer-rs
- Owner: algesten
- License: mit
- Created: 2016-12-04T23:21:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-26T20:38:19.000Z (about 6 years ago)
- Last Synced: 2025-03-18T10:01:42.326Z (about 1 month ago)
- Language: Rust
- Size: 82 KB
- Stars: 14
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Rabbiteer for Rust
==================
CLI tool for publishing and subscribing to RabbitMQ.
## Install
Install Cargo (Rust).
$ brew install rust
Install rabbiteer.
$ cargo install rabbiteer
## Command format
The command has two "modes", `publish` and `subscribe`.
$ rabbiteer [general opts] publish/subscribe [specific opts]
### General options
$ rabbiteer --help
...
OPTIONS:
-h, --host RabbitMQ host [default: 127.0.0.1]
-p, --password Password to authenticate with [default: guest]
-P, --port Port to connect to [default: 5672]
-U, --url AMQP connection url (amqp://user:pass@host:port/vhost)
-u, --user User to authenticate with [default: guest]
-v, --vhost Virtual host [default: ]
### Environment variables
#### AMQP_URL
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
```
#### CONF file
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
```
## Publish
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 such as application/json. Inferred from filename if
possible.
-e, --exchange Exchange to publish to [default ]
-f, --file Filename (- is stdin) [default: -]
-H, --header ... Header on the form "My-Header: Value"
-r, --routing-key Routing key [default: ]
-z, --priority Priority
-t, --rpctimeout RPC timeout in milliseconds
### Example
#### From stdin
Provide the content-type as arg.
$ echo "{\"panda\":true}" | \
rabbiteer -u admin -p admin -v prod publish -e myexchange -c application/json
#### From a file
Content-type is inferred if possible.
$ rabbiteer -u admin -p admin -v prod publish -e myexchange -H "batch: true" -f ./foo.json
#### Supports RabbitMQ style RPC
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.
## Subscribe
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 to subscribe to
-o, --output Output directory (- is stdout) [default: -]
-r, --routing-key Routing key [default: #]
### Example
#### To stdout
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
...
##### With delivery info
`-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:
```json
{
"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
...
#### To a directory
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
...
## License
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.