Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kodie/stack-fanatic-cli
A CLI tool for checking the progress of the badge you are tracking on your Stack Overflow profile.
https://github.com/kodie/stack-fanatic-cli
badge badges cli command-line command-line-tool google node node-js node-module nodejs puppeteer stack-overflow stackexchange stackoverflow
Last synced: 3 days ago
JSON representation
A CLI tool for checking the progress of the badge you are tracking on your Stack Overflow profile.
- Host: GitHub
- URL: https://github.com/kodie/stack-fanatic-cli
- Owner: kodie
- License: mit
- Created: 2019-07-03T17:35:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T19:52:46.000Z (almost 2 years ago)
- Last Synced: 2024-04-25T18:02:25.489Z (8 months ago)
- Topics: badge, badges, cli, command-line, command-line-tool, google, node, node-js, node-module, nodejs, puppeteer, stack-overflow, stackexchange, stackoverflow
- Language: JavaScript
- Size: 167 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Stack Fanatic CLI
[](https://www.npmjs.com/package/stack-fanatic-cli)
[](https://travis-ci.org/kodie/stack-fanatic-cli)
[](https://www.npmjs.com/package/stack-fanatic-cli)
[](https://github.com/standard/standard)
[](license.md)
A CLI tool for checking the progress of the badge you are tracking on your [Stack Overflow](https://stackoverflow.com) profile.
## Installation
```shell
npm install --global stack-fanatic-cli
```
## Usage
```
$ stack-fanatic --help
Usage
$ stack-fanatic
[--debug]
[--plain]
[[email protected]]
[--login-password=password1345]
[--site=https://stackoverflow.com]
[--user-data-dir=/tmp/stack-fanatic]
Options
--debug Output debugging info in the console
--login-email The email address asssociated with the Stack Overflow account that you would like to log in to
--login-password The password for the StackOverflow account that you would like to log in to
--plain Only display the badge status text, no fancy box
--site The URL for the Stack Exchange site that you would like to pull badge info from
Should include the protocol at the beginning and no trailing slash (Defaults to "https://stackoverflow.com")
--user-data-dir Directory to save session data and cache to (Defaults to ""./userData")
Examples
$ stack-fanatic
$ stack-fanatic --site=https://gamedev.stackexchange.com
$ stack-fanatic [email protected] --login-password=password1234
```
*Note: When you first run stack-fanatic, you will be prompted for a login email and password if you do not supply one using the options.*
### Example Response
```
┌─────────────────────────────────┐
│ │
│ Fanatic (Gold) - 2/100 (2%) │
│ │
└─────────────────────────────────┘
```
#### with the `--plain` option
```
Fanatic (Gold) - 2/100 (2%)
```
## Cheater, Cheater, Pumpkin Eater
**DISCLAIMER: I take no responsibility for any consequences that happen as a result of using this tool in the following way:**
Install this tool on a server and set up a cron job to run it on a daily basis to get the [Enthusiast](https://stackoverflow.com/help/badges/71/enthusiast) and [Fanatic](https://stackoverflow.com/help/badges/83/fanatic) badges:
1. Run `npm install --global stack-fanatic-cli` *(If installing on Ubuntu Trusty, you'll need the `libnss3` package)*
2. Run `stack-fanatic` *(It'll ask you to log in initially, after that your session data will be saved)*
3. Find out where your node and stack-fanatic executables are located by running `which node` and `which stack-fanatic`
4. Run `crontab -e` and add something like the following: *(of course replacing the email address and executable paths with your own)*
This will check my badge progress every day at noon and email me the results:
```
[email protected]
0 12 * * * TERM=dumb /srv/users/serverpilot/.nvm/versions/node/v8.16.0/bin/node /srv/users/serverpilot/.nvm/versions/node/v8.16.0/bin/stack-fanatic --plain
```
*`TERM=dumb` is required at the begining of the command to get rid of any errors resulting from the process not running in a real terminal and `--plain` is required at the end of the command so that you don't end up with a bunch of invalid characters in your email as a result of the fancy box that is printed in the terminal.*
Read more about crontab [here](https://www.adminschoice.com/crontab-quick-reference).
## Related
* [stack-fanatic](https://github.com/kodie/stack-fanatic) - The module that powers this tool
## License
MIT. See the [LICENSE file](LICENSE.md) for more info.