diff options
Diffstat (limited to 'cli/README.md')
| -rw-r--r-- | cli/README.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/cli/README.md b/cli/README.md new file mode 100644 index 00000000..06bb18cf --- /dev/null +++ b/cli/README.md @@ -0,0 +1,68 @@ +``` + @@@@@@@@@ + @@@@@@@@@@@@@@@@@@@ + @@@@@@@@@@@@@@@@@@@@@@@@@ + @@@@@@@@@@@@@@@@@@@@@@@@@@@@@ + @@@@@@@@@@@@@@@@@@@@@@@@@@@@@ ___ _ + @@@@@@ @@@@@@@@@@@@@ / _ \ (_) + @@@@ @ @@@@@@@@@@@ | | | |_ __ _ ___ _ __ + @@@@@@@@ @@@@@@@@@@ | | | | '_ \| |/ _ \| '_ \ + @@@@@@@@@@@@ @@@@@@@@@@ \ \_/ / | | | | (_) | | | | + @@@@@@@@@@@@@@@@ @@@@@@@@@ \___/|_| |_|_|\___/|_| |_| + @@@@@@@@@ @@@@@@@@@@@@@@@@ _____ _ + @@@@@@@@@@ @@@@@@@@@@@@ / ___| | + @@@@@@@@@@ @@@@@@@@ \ `--.| |__ __ _ _ __ ___ + @@@@@@@@@@@ @ @@@@ `--. \ '_ \ / _` | '__/ _ \ + @@@@@@@@@@@@@ @@@@@@ /\__/ / | | | (_| | | | __/ + @@@@@@@@@@@@@@@@@@@@@@@@@@@@@ \____/|_| |_|\__,_|_| \___| + @@@@@@@@@@@@@@@@@@@@@@@@@@@@@ + @@@@@@@@@@@@@@@@@@@@@@@@@ + @@@@@@@@@@@@@@@@@@@ + @@@@@@@@@ +``` + +## Installing OnionShare CLI + +First, make sure you have `tor` installed. In Linux, install it through your package manager. In macOS, install it with [Homebrew](https://brew.sh): `brew install tor`. + +Then install OnionShare CLI: + +```sh +pip install onionshare-cli +``` + +Then run it with: + +```sh +onionshare-cli --help +``` + +## Developing OnionShare CLI + +You must have python3 and [poetry](https://python-poetry.org/) installed. + +Install dependencies with poetry: + +```sh +poetry install +``` + +To run from the source tree: + +```sh +poetry run onionshare-cli +``` + +To run tests: + +```sh +poetry run pytest -v ./tests +``` + +## Build a wheel package + +```sh +poetry build +``` + +This will create `dist/onionshare_cli-$VERSION-py3-none-any.whl`. |