Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2024-12-28 08:49:30 -05:00
Code Issues Packages Projects Releases Wiki Activity
aecaae896d
onionshare/cli
History
Micah Lee aecaae896d
Make CLI throw an error if it cannot find tor binary
2020-11-29 11:08:46 -08:00
..
onionshare_cli Make CLI throw an error if it cannot find tor binary 2020-11-29 11:08:46 -08:00
tests Remove obsolete resource path tests 2020-11-08 14:51:45 -08:00
poetry.lock Update CLI deps 2020-11-17 18:46:04 -08:00
pyproject.toml Move psutil dependency from desktop to CLI 2020-11-17 17:45:04 -08:00
README.md Write unified release documentation, move licenses into the root, and delete some unnecessary files from desktop/install 2020-11-04 16:51:48 -08:00
setup.py Version bump to 2.3.dev2, and update Linux installation in docs 2020-11-08 20:45:54 -08:00

README.md 

                     @@@@@@@@@                      
                @@@@@@@@@@@@@@@@@@@                 
             @@@@@@@@@@@@@@@@@@@@@@@@@              
           @@@@@@@@@@@@@@@@@@@@@@@@@@@@@            
             @@@@@@@@@@@@@@@@@@@@@@@@@@@@@           ___        _               
               @@@@@@         @@@@@@@@@@@@@         / _ \      (_)              
         @@@@    @               @@@@@@@@@@@       | | | |_ __  _  ___  _ __    
       @@@@@@@@                   @@@@@@@@@@       | | | | '_ \| |/ _ \| '_ \   
     @@@@@@@@@@@@                  @@@@@@@@@@      \ \_/ / | | | | (_) | | | |  
   @@@@@@@@@@@@@@@@                 @@@@@@@@@       \___/|_| |_|_|\___/|_| |_|  
      @@@@@@@@@                 @@@@@@@@@@@@@@@@    _____ _                     
      @@@@@@@@@@                  @@@@@@@@@@@@     /  ___| |                    
       @@@@@@@@@@                   @@@@@@@@       \ `--.| |__   __ _ _ __ ___ 
       @@@@@@@@@@@               @    @@@@          `--. \ '_ \ / _` | '__/ _ \
        @@@@@@@@@@@@@         @@@@@@               /\__/ / | | | (_| | | |  __/
         @@@@@@@@@@@@@@@@@@@@@@@@@@@@@             \____/|_| |_|\__,_|_|  \___|
           @@@@@@@@@@@@@@@@@@@@@@@@@@@@@            
             @@@@@@@@@@@@@@@@@@@@@@@@@              
                @@@@@@@@@@@@@@@@@@@                 
                     @@@@@@@@@

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.