Skip to content

A CLI to see what's happening on popular blogging platforms easily from your terminal.

License

Notifications You must be signed in to change notification settings

ammaaraslam/nodefeed-cli

Repository files navigation

nodefeed

See what's happening on popular blogging platforms easily from your terminal.

  • Get articles from popular blogging platforms like Hashnode.
  • Filter articles by latest, featured, trending and user.
  • Data displayed in a beautiful tabular format.

Note:- As of the first release the CLI supports only articles from Hashnode. Future releases will include articles from Dev.to, Medium, etc.

Installation

# This command installs the CLI globally (recommended)
npm install -g nodefeed

# Or run the following command along with the usage. (This will install the CLI everytime you run it)
npx nodefeed <command> <option>

💻 Usage

Basic usage:

nodefeed <command> <option>

Commands:

  • help - Print help info
  • articles - Get articles Hashnode

Options:

  • -c, --clear - Clear the console on every task.
  • -d, --debug - Print debug info.
  • -v, --version - Print CLI version.
  • -l, --latest - Filter latest articles.
  • -f, --featured - Filter featured articles.
  • -u, --user - Filter articles by user.
  • -t, --trending - Filter trending articles.
  • -c, --community - Filter trending articles.

Example usage:

# get featured articles
nodefeed articles -f

🤝 Contributing

Please contribute using the Github Flow. Create a branch, add commits and open up a pull request. Make sure your PR isn't a duplicate Please also read CONTRIBUTING.md and CODE_OF_CONDUCT.md

Development

  1. Clone the Repository
git clone https://github.com/ammaaraslam/nodefeed.git
  1. Move into the working directory
cd nodefeed
  1. Install Dependencies
npm install
  1. Run the CLI in a local environment. (To view reflected changes)
# create update of the CLI locally.
npm link

# Use the CLI as usual.
nodefeed <command> <option>

👨‍💻 Author

Ammaar Aslam

Twitter 🐦 - @itsammaar_7
Instagram 📸 - @itsammaar_7
GitHub 🐱 - @ammaaraslam
Hashnode 📚 - @ammaaraslam

🙏 Support

If you found the app helpful, consider supporting me with a coffee.

About

A CLI to see what's happening on popular blogging platforms easily from your terminal.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published