From e36fcd2fb79c897f5bac7d987ae7a4684fbf0a87 Mon Sep 17 00:00:00 2001 From: Ethan Lane Date: Wed, 19 Jun 2024 18:14:27 +0100 Subject: [PATCH] Update documentation --- docs/cli.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index dbe1f20..f4906bd 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -53,9 +53,9 @@ Options: -s, --subreddit The subreddit to search (default: "rabbits") -j, --json Output as JSON -q, --query-metadata Include query metadata in result + -o Output to file --sort Sort by (choices: "hot", "new", "top", default: "hot") -h, --help display help for command -✨ Done in 0.32s. ``` ## JSON output @@ -95,3 +95,11 @@ 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 +```