quotes-cli-garvit-budhiraja
v1.0.0
Published
A simple command-line tool to get random quotes from a `quotes.json` file. The tool can filter quotes by author, tags, popularity, and category. Install it globally and get inspired by quotes anytime!
Downloads
13
Maintainers
Readme
Quotes CLI
A simple command-line tool to get random quotes from a quotes.json
file. The tool can filter quotes by author, tags, popularity, and category. Install it globally and get inspired by quotes anytime!
Features
- Get a random quote
- Filter quotes by:
- Author
- Tags
- Popularity
- Category
Installation
To install, run:
npm install quotes-cli-garvit-budhiraja
To run the project locally:
- Clone this repository.
- Install the dependencies using
npm install
. - Run the tool globally using
npm link
.
git clone https://github.com/garvit-exe/quotes-cli.git
cd quotes-cli
npm install
npm link
Usage
Once the tool is installed globally, you can use the following commands to get random quotes.
Get a Random Quote
quotes-cli quote
Filter by Author
quotes-cli quote --author "Dr. Seuss"
Filter by Tags
quotes-cli quote --tags "happiness, life"
Filter by Popularity (minimum value)
quotes-cli quote --popularity 0.5
Filter by Category
quotes-cli quote --category "life"
Example
quotes-cli quote --author "Dr. Seuss" --category "life"
Possible Output:
"They say I'm old-fashioned, and live in the past, but sometimes I think progress progresses too fast!"
- Dr. Seuss
Contributing
Feel free to fork the project, open issues, or submit pull requests.