Expand help text
This commit is contained in:
parent
3c2f105c7b
commit
eee6279d78
65
README.org
65
README.org
|
@ -29,6 +29,71 @@ oxo --help
|
||||||
╰──────────────────────────────────────────────────────────────────────────────╯
|
╰──────────────────────────────────────────────────────────────────────────────╯
|
||||||
|
|
||||||
#+end_example
|
#+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
|
** Installation
|
||||||
*** pipx
|
*** pipx
|
||||||
[[https://pypa.github.io/pipx/][pipx]] automates the creation of isolated runtimes for python CLI utilities like
|
[[https://pypa.github.io/pipx/][pipx]] automates the creation of isolated runtimes for python CLI utilities like
|
||||||
|
|
Loading…
Reference in New Issue