2020-10-13 01:40:55 -04:00
```
2021-05-04 00:49:42 -04:00
╭───────────────────────────────────────────╮
│ * ▄▄█████▄▄ * │
│ ▄████▀▀▀████▄ * │
│ ▀▀█▀ ▀██▄ │
│ * ▄█▄ ▀██▄ │
│ ▄█████▄ ███ -+- │
│ ███ ▀█████▀ │
│ ▀██▄ ▀█▀ │
│ * ▀██▄ ▄█▄▄ * │
│ * ▀████▄▄▄████▀ │
│ ▀▀█████▀▀ │
│ -+- * │
│ ▄▀▄ ▄▀▀ █ │
│ █ █ ▀ ▀▄ █ │
│ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │
│ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │
│ │
│ https://onionshare.org/ │
╰───────────────────────────────────────────╯
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` .