Boozey

Boozey is a library (and cli tool) for querying the Open Beer Database API v1.

Usage

You can use this in either node.js as a library or from the cli.

Node.js

Get it from npm:

npm install boozey

Use it as a package:

var boozey = require('boozey');

boozey.beers.all().pipe(process.stdout);

You can pass in any of the arguments as defined on the website:

boozey.beers.all({
    query: 'ale',
    order: 'id',
    dir: 'ASC',
    page: 1,
    perPage: 10,
    token: '<API token>'
}).pipe(process.stdout);

To get back a single beer use the get method:

boozey.beers.get(3).pipe(process.stdout);

cli

Install it as a global npm package:

npm install -g boozey

Usage: boozey [options]

  Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    -k, --key <key>            API key
    -b, --beers                Gets a list of beers
    -p, --pretty               Pretty print the result
    --page [page]              Page number to get
    -pp, --per-page [perPage]  Records per page
    --order-by [order]         Field to order by
    -d, --direction [dir]      Sort order direction, ASC or DESC
    -q, --query [query]        Query to use to filter the data set
    -i, --id <id>              Id of the specific beer to get

For example (pretty prints the first 5 beers):

boozey -b -p -pp 5

License

MIT

Author

Aaron Powell