https://github.com/ammaaraslam/nodefeed-cli
A CLI to see what's happening on popular blogging platforms easily from your terminal.
https://github.com/ammaaraslam/nodefeed-cli
api cli hashnode nodejs terminal
Last synced: 6 months ago
JSON representation
A CLI to see what's happening on popular blogging platforms easily from your terminal.
- Host: GitHub
- URL: https://github.com/ammaaraslam/nodefeed-cli
- Owner: ammaaraslam
- License: mit
- Created: 2022-08-10T11:40:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-27T05:12:51.000Z (about 3 years ago)
- Last Synced: 2025-03-23T08:45:38.631Z (10 months ago)
- Topics: api, cli, hashnode, nodejs, terminal
- Language: JavaScript
- Homepage:
- Size: 211 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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**
```sh
# 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
```
## 💻 **Usage**
Basic usage:
```sh
nodefeed
```
> **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:
```sh
# get featured articles
nodefeed articles -f
```
## 🤝 **Contributing**
Please contribute using the [Github Flow](https://guides.github.com/introduction/flow). Create a branch, add commits and [open up a pull request](https://github.com/ammaaraslam/nodefeed/compare). *Make sure your PR isn't a duplicate*
Please also read [`CONTRIBUTING.md`](https://github.com/ammaaraslam/nodefeed/blob/master/CONTRIBUTING.md) and [`CODE_OF_CONDUCT.md`](https://github.com/ammaaraslam/nodefeed/blob/master/CODE_OF_CONDUCT.md)
## ⚙ **Development**
1. Clone the Repository
```sh
git clone https://github.com/ammaaraslam/nodefeed.git
```
2. Move into the working directory
```sh
cd nodefeed
```
3. Install Dependencies
```sh
npm install
```
4. Run the CLI in a local environment. (To view reflected changes)
```sh
# create update of the CLI locally.
npm link
# Use the CLI as usual.
nodefeed
```
## 👨💻 **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.
