Skip to content

fdesjardins/wikiquote-cli

Repository files navigation

wikiquote-cli

Build Status NPM Version Coverage

Companion CLI for wikiquote package (https://github.com/fdesjardins/wikiquote)

Install

$ npm install -g wikiquote-cli

Usage

$ wikiquote -h

Get quotes from Wikiquote

Usage: wikiquote <cmd> [options]

Commands:
  wikiquote cache <cmd>            issue cache commands
  wikiquote list <name>            list quotes for a page name
  wikiquote random <name>          get a random quote from a page
  wikiquote search <query>         search for page names
  wikiquote completion             generate bash completion script

Options:
  -v, --version  Show version number                           [boolean]
  -h, --help     Show help                                     [boolean]

Examples:
  wikiquote random "Steve Jobs"
  wikiquote search "bill gates"

Cache & Offline Usage

You can speed up quote retrieval and store quotes by using the cache command:

Commands:
  wikiquote cache add <name>     cache quotes for a give page
  wikiquote cache clear <name>   clear the local cache
  wikiquote cache update <name>  update the local cache

Examples

Adding cache entries:

$ time wikiquote random 'Abraham Lincoln'
# 2.02s user 0.11s system 85% cpu 2.503 total

$ wikiquote cache add 'Abraham Lincoln'
Added "Abraham Lincoln" to cache

$ time wikiquote random 'Abraham Lincoln'
# 0.33s user 0.04s system 111% cpu 0.338 total

Use with other programs:

$ wikiquote random "Nikola Tesla" | cowsay
 _________________________________________
/ We crave for new sensations but soon    \
| become indifferent to them. The wonders |
| of yesterday are today common           |
\ occurrences. -- Nikola Tesla            /
 -----------------------------------------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

License

MIT © Forrest Desjardins