Ethan Lane
2e5f8c3633
# Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - Fix the unit tests "toBeCalledWith" assert being deprecated - Update the "sortBy" variable to be a string literal - Add an output to file option to the CLI - Reorganise the code so there's less repeated code - Update the tests so the CLI logic is tested quicker #138, #76, #80 ## Type of change Please delete options that are not relevant. - [x] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [x] This change requires a documentation update # How Has This Been Tested? Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration. # Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that provde my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Reviewed-on: #182 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com>
2.6 KiB
CLI
Since Version 2.2, Random Bunny contains a command line interface (CLI).
Downloads
The project can be downloaded as a binary for your system via the GitHub Releases or Gitea Releases page.
We currently support:
- Linux (x64)
- Windows (x64)
- macOS (x64, Arm64*)
The git repository can also be cloned and ran via yarn build and yarn start.
NOTE: We are aware of a bug in the macOS Arm64 builds failing to execute. For now you're still able to use the x64 builds under Rosetta fine. This will hopefully be fixed in a future release.
Default Output
By default, the command will fetch a random image from r/rabbits and return it in a human-readable output.
$ randombunny
Archived = false
Downvotes = 0
Hidden = false
Permalink = /r/Rabbits/comments/1av1rg9/cute_baby_bun/
Subreddit = Rabbits
Subreddit Subscribers = 486084
Title = Cute baby bun
Upvotes = 211
Url = https://i.redd.it/sfz0srdrimjc1.png
Help
The command also includes a help option in case you are stuck.
$ randombunny --help
# or
$ randombunny -h
Usage: random-bunny [options]
Get a random image url from a subreddit of your choosing
Options:
-V, --version output the version number
-s, --subreddit <subreddit> The subreddit to search (default: "rabbits")
-j, --json Output as JSON
-q, --query-metadata Include query metadata in result
-o <file> Output to file
--sort <sort> Sort by (choices: "hot", "new", "top", default: "hot")
-h, --help display help for command
JSON output
You can also convert the output into JSON, if you need to input it to another program.
$ randombunny --json
# or
$ randonbunny -j
{"Archived":false,"Downs":0,"Hidden":false,"Permalink":"/r/Rabbits/comments/1av1rg9/cute_baby_bun/","Subreddit":"Rabbits","SubredditSubscribers":486085,"Title":"Cute baby bun","Ups":210,"Url":"https://i.redd.it/sfz0srdrimjc1.png"}
Sort
You can also choose the sorting option which reddit will use to return the available posts to randomise from.
This defaults to "hot". The valid options are "hot", "new", and "top".
$ randombunny --sort hot
$ randombunny --sort new
$ randomBunny --sort top
Subreddit
You can change the subreddit which the command fetches from.
This defaults to "rabbits"
$ randombunny --subreddit rabbits
$ randombunny -s horses
Output to file
If you'd rather send the output to a file, you can supply the -o flag.
$ randombunny -o ~/Desktop/output.txt