2020-10-13 01:40:55 -04:00
```
@@@@@@@@@
@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ ___ _
@@@@@@ @@@@@@@@@@@@@ / _ \ (_ )
@@@@ @ @@@@@@@@@@@ | | | |_ __ _ ___ _ __
@@@@@@@@ @@@@@@@@@@ | | | | '_ \| |/ _ \| '_ \
@@@@@@@@@@@@ @@@@@@@@@@ \ \_/ / | | | | (_) | | | |
@@@@@@@@@@@@@@@@ @@@@@@@@@ \___/|_| |_|_|\___/|_| |_|
@@@@@@@@@ @@@@@@@@@@@@@@@@ _____ _
@@@@@@@@@@ @@@@@@@@@@@@ / ___| |
@@@@@@@@@@ @@@@@@@@ \ `--.| |__ __ _ _ __ ___
@@@@@@@@@@@ @ @@@@ `--. \ '_ \ / _` | '__/ _ \
@@@@@@@@@@@@@ @@@@@@ /\__/ / | | | (_| | | | __ /
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ \____/|_| |_|\__,_|_| \___|
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@
@@@@@@@@@
```
## 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:
2020-10-15 19:30:30 -04:00
```sh
2020-10-13 01:40:55 -04:00
pip install onionshare-cli
```
Then run it with:
2020-10-15 19:30:30 -04:00
```sh
2020-10-13 01:40:55 -04:00
onionshare-cli --help
```
## Developing OnionShare CLI
You must have python3 and [poetry ](https://python-poetry.org/ ) installed.
Install dependencies with poetry:
2020-10-15 19:30:30 -04:00
```sh
2020-10-13 01:40:55 -04:00
poetry install
```
To run from the source tree:
2020-10-15 19:30:30 -04:00
```sh
2020-10-13 01:40:55 -04:00
poetry run onionshare-cli
```
To run tests:
2020-10-15 19:30:30 -04:00
```sh
2020-10-14 23:42:20 -04:00
poetry run pytest -v ./tests
2020-10-13 01:40:55 -04:00
```
2020-10-15 19:30:30 -04:00
## Build a wheel package
```sh
poetry build
```
This will create `dist/onionshare_cli-$VERSION-py3-none-any.whl` .