Rat is a simple command line tool that helps me automate repetitive tasks for my favorite web services and software products which expose a REST API. The general guideline for all commands rat supports is that they should perform only one thing preferably with one HTTP call only. This guideline follows the UNIX principle that tools should to one thing and complex behaviour is achieved by pipelining.
Table of Contents
CenterDevice
bash
rat centerdevice auth
rat centerdevice collections
rat centerdevice delete
rat centerdevice download
rat centerdevice refresh_token
rat centerdevice search
rat centerdevice status
rat centerdevice upload
Pocket
bash
rat pocket auth
rat pocket list
rat pocket archive
rat pocket readd
rat pocket favorite
rat pocket unfavorite
rat pocket delete
Slack
bash
rat slack auth
Stocks
bash
rat stocks
Please use Homebrew to install rat on your system.
bash
brew install lukaspustina/os/rat
Pleae add my [PackageCloud] open source repository and install rat via apt.
bash
curl -s https://packagecloud.io/install/repositories/lukaspustina/opensource/script.deb.sh | sudo bash
sudo apt-get install rat
rat is automatically build on Windows via AppVeyor to ensure is compiles and runs fine but binaries are currently not provided. Please compile it from source.
Please install Rust via rustup and then run
bash
cargo install rat
There are two response output modes, i.e., JSON and HUMAN, and three message levels, i.e., QUIET, NORMAL, and VERBOSE.
In human output mode tries to give a concise representation if the received information. In json output mode, rat tries to pass the whole json response to the user -- if any is available. The output mode can be selected with the parameter --output <humen|json>, e.g., rat --output json ...
The message output levels configure how talkative rat is during execution. The quiet level reduces outputs to real responses only while the normal level tries to give some feedback to the user about the start and end of a request. The verbose level goes one step further and tries to inform the user about each step of the processing. The message level can be chosen with the parameters --quiet or --verbose, respectively. If none of these switches is activated, the message level is set to normal. For example, rat --verbose ... selects the verbose message level.
rat centerdevice auth and follow the instructions.
rat centerdevice refresh_token
Show my collections: rat centerdevice collections
Show my as well as public collections: rat centerdevice collections --public-collections
Search collections: rat centerdevice collections <search filter>
Cache collection names for other commands: rat centerdevice collections --cache
Download document into current directory with original filename: rat centerdevice download excbd68a-c397-id46-9350-a4fd4022fe8c
Download document with new filename: rat centerdevice download excbd68a-c397-id46-9350-a4fd4022fe8c -f new_filename
Search for documents with filename README.md, tagged with documentation, and some fulltext: rat centerdevice search -f README.md -t documentation -t rat "the Rest Api Tool"
Search again, but now post-process JSON response with jq: rat --output json --quiet centerdevice search -f README.md -t documentation "the Rest Api Tool" | jq .
Expand search to public collections: ... --public-collections
Upload documen with tags: rat centerdevice upload README.md -t documentation -t rat
Upload document to collection: rat centerdevice upload README.md --collection <collection id>
Upload document to collection using collection cache: rat centerdevice upload README.md --Collection <cached collection name>
rat centerdevice delete excbd68a-c397-id46-9350-a4fd4022fe8c
Create a new application and add the newly created consumer key to your rat configuration, section [pocket] as consumer_key = '<consumer key'.
rat pocket auth and follow the instructions.
rat pocket archive|readd|favorite|unfavorite|delete <article ids>...
Search in title and URL of all articles ...
rat pocket list rustList all ...
unread articeles: rat pocket list
archived articeles: rat pocket list --state archived
articles: rat pocket list --state all
unread articles tagged with Rust: rat pocket list --tag Rust
unread articles, added between 2 weeks and 1 week ago: rat pocket list --since 2w --until 1w
List ids of all unread articles added 2 weeks or later ago and create a comma separated list: rat pocket list --until 2w --output id | paste -s -d . -
List all unread articles that contain a video: rat --output json --quiet pocket list | jq '.list | .[] | select(.has_video | test("1") ) | { id: .item_id, title: .resolved_title }'
Filter articles that contain Rust in title and URL, and create comma separated id list: rat -o json --quiet pocket list | jq -r '.list | .[] | { title: .given_title, id: .item_id, url: .given_url } | select((.title | test("Rust")) or (.url | test("Rust"))) | .id' | paste -s -d , -
Create a new application and add the newly created Client ID and Client Secret to your rat configuration, section [slack] as client_id = '<client id>' and client_secret = '<client secret', respectively.
rat slack auth and follow the instructions.
by company name: rat stocks "Comdirect"
by WKN: rat stocks 542800"
```bash rat feedly
rat elasticsearch browse
rat elasticsearch status -- curl -s http://
rat slack channel list
rat slack user list
rat slack send
rat bosun browse
rat bosun incidents show --open
rat bosun incidents ack|close --ids
[X] Clap
[X] Fill out Cargo.toml
[X] Error Chain
[X] Distributions
[X] Brew
[X] Debian
[X] Finish Pocket
[X] Output
[X] General option
[X] colors: regular, info(blue), warnings(yellow), error(red)
[X] add info msgs to modules
[x] quiet option
[X] Add output format parameter
[X] Apply output format to all, well, outputs
[X] Slack Auth
[X] CenterDevice Auth
[X] CenterDevice Upload
[X] Checkout mime_multipart 0.5 with my patch included
[X] Move centerdevice browse-status to status --browse
[X] Enchance Auths by --browser which opens a browser window.
[X] Enhance Pocket
[X] Add --since and --until parameters for search
[X] Select human outout fields: id, title, url
[X] Update documentation
[X] Refactor auth modules - cf. branch
[X] Slack: Move HTTP calls to client mod
[X] Replace curl with hyper
[X] Pocket: Move HTTP calls to client mod
[X] Replace Pocket list and search by search that optionally takes a search term
[X] Travis
[X] packagecloud.io
[X] Add Badges for Travis in Cargo.toml and Readme
[X] Wait for new select release and then let Travis publish to crates.io
[X] CenterDevice
[X] Refactor client lib
[X] search for collections
[X] upload to collection
[X] named collections
[X] upload to named collections
[X] delete document
[X] Token Refresh / Error messages when token has expired
[X] Elastic tabstops for output where appropriate
[ ] Tests
[ ] Make better use of error_chain
[ ] by using Foreign errors
[ ] by using ensure!
Dockerize runs for better backtraces
bash
docker run -v $PWD:/volume -w /volume -t clux/muslrust:nightly sh -c "cargo run"
[ ] Run Clippy once cargo in nightly works again -- cf. http://asquera.de/blog/2017-03-03/setting-up-a-rust-devenv/
[ ] Move to future based clients -- cf. http://asquera.de/blog/2017-03-01/the-future-with-futures/
-- Before first 1.0 release
[ ] Documentation
[ ] Cleanup of Readme; esp. Todos
Testing
Common Pattern for test setups, also see this ```Rust
fn makesurefooworks() { setup(|&fixturestate| { ... }); } ```