From eee6279d7873a92ea3f3c1e2f0ae0eb946b9b9b8 Mon Sep 17 00:00:00 2001 From: grym Date: Fri, 2 Dec 2022 17:05:19 -0500 Subject: [PATCH] Expand help text --- README.org | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/README.org b/README.org index 8908a72..6d111fb 100644 --- a/README.org +++ b/README.org @@ -29,6 +29,71 @@ oxo --help ╰──────────────────────────────────────────────────────────────────────────────╯ #+end_example +#+begin_src bash :results output replace :tangle no +oxo files --help +#+end_src + +#+RESULTS: +#+begin_example + + Usage: oxo files [OPTIONS] FILES... + + Upload one or more files. + +╭─ Arguments ──────────────────────────────────────────────────────────────────╮ +│ * files FILES... [default: None] [required] │ +╰──────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────╮ +│ --expires INTEGER Expiration time, in hours or epoch milliseconds │ +│ [default: None] │ +│ --base-url TEXT [env var: OXO_BASE_URL] [default: https://0x0.st] │ +│ --help Show this message and exit. │ +╰──────────────────────────────────────────────────────────────────────────────╯ + +#+end_example + +#+begin_src bash :results output replace :tangle no +oxo repost --help +#+end_src + +#+RESULTS: +#+begin_example + + Usage: oxo repost [OPTIONS] URLS... + + Repost one or more urls. + +╭─ Arguments ──────────────────────────────────────────────────────────────────╮ +│ * urls URLS... [default: None] [required] │ +╰──────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────╮ +│ --base-url TEXT [env var: OXO_BASE_URL] [default: https://0x0.st] │ +│ --help Show this message and exit. │ +╰──────────────────────────────────────────────────────────────────────────────╯ + +#+end_example + +#+begin_src bash :results output replace :tangle no +oxo shorten --help +#+end_src + +#+RESULTS: +#+begin_example + + Usage: oxo shorten [OPTIONS] URLS... + + Shorten one or more urls. + +╭─ Arguments ──────────────────────────────────────────────────────────────────╮ +│ * urls URLS... [default: None] [required] │ +╰──────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────╮ +│ --base-url TEXT [env var: OXO_BASE_URL] [default: https://0x0.st] │ +│ --help Show this message and exit. │ +╰──────────────────────────────────────────────────────────────────────────────╯ + +#+end_example + ** Installation *** pipx [[https://pypa.github.io/pipx/][pipx]] automates the creation of isolated runtimes for python CLI utilities like