onionshare/cli
2021-08-27 10:07:29 +10:00
..
onionshare_cli merge develop branch into client_auth_v3 branch and use our forked stem which works with poetry 2021-08-27 09:44:43 +10:00
tests Updated test cli settings 2021-07-22 02:37:24 +05:30
poetry.lock Upgrade to Stem 1.8.1 (our fork) to satisfy wheel build. Raise minimumHeight to avoid cutoff of client auth option in sharing settings 2021-08-27 10:07:29 +10:00
pyproject.toml merge develop branch into client_auth_v3 branch and use our forked stem which works with poetry 2021-08-27 09:44:43 +10:00
README.md Update CLI ASCII art in readme 2021-05-03 21:49:42 -07:00
setup.py Version bump to 2.3.3 2021-08-20 13:13:39 -07:00

╭───────────────────────────────────────────╮
│    *            ▄▄█████▄▄            *    │
│               ▄████▀▀▀████▄     *         │
│              ▀▀█▀       ▀██▄              │
│      *      ▄█▄          ▀██▄             │
│           ▄█████▄         ███        -+-  │
│             ███         ▀█████▀           │
│             ▀██▄          ▀█▀             │
│         *    ▀██▄       ▄█▄▄     *        │
│ *             ▀████▄▄▄████▀               │
│                 ▀▀█████▀▀                 │
│             -+-                     *     │
│   ▄▀▄               ▄▀▀ █                 │
│   █ █     ▀         ▀▄  █                 │
│   █ █ █▀▄ █ ▄▀▄ █▀▄  ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄   │
│   ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █   ▀▄▄   │
│                                           │
│          https://onionshare.org/          │
╰───────────────────────────────────────────╯

Installing OnionShare CLI

First, make sure you have tor installed. In Linux, install it through your package manager. In macOS, install it with Homebrew: brew install tor.

Then install OnionShare CLI:

pip install onionshare-cli

Then run it with:

onionshare-cli --help

Developing OnionShare CLI

You must have python3 and poetry installed.

Install dependencies with poetry:

poetry install

To run from the source tree:

poetry run onionshare-cli

To run tests:

poetry run pytest -v ./tests

Build a wheel package

poetry build

This will create dist/onionshare_cli-$VERSION-py3-none-any.whl.