onionshare

mirror of https://github.com/onionshare/onionshare.git synced 2024-12-25 15:29:42 -05:00

History

Saptak S d421bfa14b Pins flask-socketio to 5.0.1 in pyproject.toml Also updates the RELEASE.md to document the need to update the socket.io.min.js file whenever we want to update flask-socketio to ensure that they are compatible with each other, failing which, the chat stops works.		2021-05-07 01:25:39 +05:30
..
onionshare_cli	Merge pull request #1345 from micahflee/1275_fix_website_mode	2021-05-05 21:14:35 +00:00
tests	Move the cleanup() function from Onionshare class to Web class, so that the list of files to be cleaned up is always available (needed for website temp files)	2021-05-04 16:21:42 +10:00
poetry.lock	Use colorama for terminal colors, to get Windows support	2021-05-02 15:13:50 -07:00
pyproject.toml	Pins flask-socketio to 5.0.1 in pyproject.toml	2021-05-07 01:25:39 +05:30
README.md	Update CLI ASCII art in readme	2021-05-03 21:49:42 -07:00
setup.py	Version bump to 2.3.2 and update changelog, and upgrade PySide to 5.15.2	2021-05-03 18:50:01 -07:00

README.md

╭───────────────────────────────────────────╮
│    *            ▄▄█████▄▄            *    │
│               ▄████▀▀▀████▄     *         │
│              ▀▀█▀       ▀██▄              │
│      *      ▄█▄          ▀██▄             │
│           ▄█████▄         ███        -+-  │
│             ███         ▀█████▀           │
│             ▀██▄          ▀█▀             │
│         *    ▀██▄       ▄█▄▄     *        │
│ *             ▀████▄▄▄████▀               │
│                 ▀▀█████▀▀                 │
│             -+-                     *     │
│   ▄▀▄               ▄▀▀ █                 │
│   █ █     ▀         ▀▄  █                 │
│   █ █ █▀▄ █ ▄▀▄ █▀▄  ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄   │
│   ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █   ▀▄▄   │
│                                           │
│          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.