1.0.11 • Published 2 years ago
shelves-cli v1.0.11
shelves
Shelves is a command line utility to help you manage your books. Use it to:
- keep track what books you want to read
- where you're up to in a book
- notes and bookmarks
Installing
npm
If you have the NodeJS runtime installed in your system, you can install the package via:
npm install -g shelves-cliThen you can use it with the keyword shelves. See the commands section for examples.
homebrew
If you don't have NodeJS or would rather use Homebrew, you can also install the tool via Homebrew:
brew tap pigeonseverywhere/shelves
brew install shelvesUninstalling
TODO
Commands
| Command | Flags | Arguments | Description |
|---|---|---|---|
| add | title | add a book to your shelf | |
| remove | title | remove a book from your shelf | |
| list | list all books | ||
| read | title | start/keeping reading a book - add notes, bookmarks, or update your progress | |
| view | --verbose | title | view details of a book. Show bookmarks and notes when used with verbose flag |
add
list
read
view
When using the verbose flag: