onionshare/cli
dependabot[bot] e63ffe7ece
Bump pytest from 7.2.1 to 7.3.1 in /cli
Bumps [pytest](https://github.com/pytest-dev/pytest) from 7.2.1 to 7.3.1.
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/7.2.1...7.3.1)

---
updated-dependencies:
- dependency-name: pytest
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-05-22 05:45:03 +00:00
..
onionshare_cli Update default PT settings 2023-02-05 12:19:48 -08:00
tests Upgraded desktop/{onionshare,tests} to PySide6 2022-10-23 14:09:56 +02:00
poetry.lock Bump pytest from 7.2.1 to 7.3.1 in /cli 2023-05-22 05:45:03 +00:00
pyproject.toml Merge branch 'fix-builds' of github.com:onionshare/onionshare into pyside6-package 2023-04-19 18:27:37 +05:30
README.md Delete unused Qt5 files after Windows build 2021-12-23 11:49:43 -08:00
setup.py Update copyright year to 2022 2022-01-16 16:15:49 -08:00

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

Installing OnionShare CLI

First, make sure you have tor and python3 installed. In Linux, install it through your package manager. In macOS, install it with Homebrew: brew install tor. Second, OnionShare is written in python, and you can install the command line version use python's package manager pip.

Requirements

Debian/Ubuntu (APT):

sudo apt-get install tor python3-pip

Arch (Pacman):

sudo pacman -S tor python-pip

CentOS, Red Hat, and Fedora (Yum):

sudo yum install tor python3 python3-wheel

macOS (Homebrew):

brew install tor python
sudo easy_install pip

Main

Installation

Install OnionShare CLI:

pip install --user onionshare-cli

Set path

When you install programs with pip and use the --user flag, it installs them into ~/.local/bin, which isn't in your path by default. To add ~/.local/bin to your path automatically for the next time you reopen the terminal or source your shell configuration file, do the following:

Apply the path to your shell file:

printf "PATH=\$PATH:~/.local/bin\n" >> ~/.${SHELL##*/}rc
. ~/.${SHELL##*/}rc

Usage

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