Compare commits

...

2 Commits

Author SHA1 Message Date
grym 85db3a0b5a Merge branch 'master' of tildegit:grym/oxo 2022-12-01 12:19:21 -05:00
grym f315d76e46 Update readme 2022-12-01 12:18:02 -05:00
1 changed files with 28 additions and 25 deletions

View File

@ -4,43 +4,46 @@ command line use.
** Installation
*** pipx
#+begin_src bash
pipx install git+https://tildegit.org/grym/oxo
pipx install git+https://tildegit.org/grym/oxo@master # or @tag-of-your-choice
#+end_src
*** pip
#+begin_src bash
python3 -m venv oxovenv
oxovenv/bin/pip install git+https://tildegit.org/grym/oxo
oxovenv/bin/pip install git+https://tildegit.org/grym/oxo@master # or @tag-of-your-choice
ln -s oxovenv/bin/oxo ${HOME}/.local/bin # optional.
#+end_src
*** development
#+begin_src bash
git clone https://tildegit.org/grym/oxo
cd oxo
python -m venv ./venv
./venv/bin/python -m pip install --upgrade pip setuptools wheel
./venv/bin/python -m pip install -e '.[dev]'
make install
#+end_src
** Use
Each of the three endpoints supported by 0x0 has an associated subcommand.
#+begin_src text
Usage: oxo [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion Install completion for the
current shell.
--show-completion Show completion for the
current shell, to copy it
or customize the
installation.
--help Show this message and
exit.
Commands:
files Upload one or more files.
repost Repost one or more urls.
shorten Shorten one or more urls.
#+begin_src bash :results output replace :tangle no
./venv/bin/oxo --help
#+end_src
#+begin_example
Usage: oxo [OPTIONS] COMMAND [ARGS]...
A command line utility for 0x0.st compliant pastebins.
To use a different 0x0 site, set `OXO_BASE_URL` in your environment, or
specify it in the relevant subcommand.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version Show the version and exit. │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy │
│ it or customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ files Upload one or more files. │
│ repost Repost one or more urls. │
│ shorten Shorten one or more urls. │
╰──────────────────────────────────────────────────────────────────────────────╯
#+end_example