grym
/
oxo
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Expand help text

This commit is contained in:
grym 2022-12-02 17:05:19 -05:00
parent 3c2f105c7b
commit eee6279d78
1 changed files with 65 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.org
View File

@ -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