RabbitLabs/random-bunny
5
0
Fork 0
Code Issues 9 Pull requests 11 Projects 1 Releases 18 Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
Ethan Lane 2024-06-19 18:14:27 +01:00
parent d21a6b4dba
commit e36fcd2fb7
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/cli.md
View file

@ -53,9 +53,9 @@ Options:
-s, --subreddit <subreddit> The subreddit to search (default: "rabbits") -s, --subreddit <subreddit> The subreddit to search (default: "rabbits")
-j, --json Output as JSON -j, --json Output as JSON
-q, --query-metadata Include query metadata in result -q, --query-metadata Include query metadata in result
-o <file> Output to file
--sort <sort> Sort by (choices: "hot", "new", "top", default: "hot") --sort <sort> Sort by (choices: "hot", "new", "top", default: "hot")
-h, --help display help for command -h, --help display help for command
✨ Done in 0.32s.
``` ```
## JSON output ## JSON output
@ -95,3 +95,11 @@ This defaults to "rabbits"
$ randombunny --subreddit rabbits $ randombunny --subreddit rabbits
$ randombunny -s horses $ 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
```