summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornyxnor <nyxnor@protonmail.com>2021-08-30 22:54:24 +0200
committernyxnor <nyxnor@protonmail.com>2021-08-30 22:54:24 +0200
commitf0d823bdcc4ff12663d805fc98bf0656881ed409 (patch)
tree38e318a1f2a38aa81f4a536ff9b847b522dea378
parent3a07bbe16126c6b14fc7ff553d2ef441e959a333 (diff)
downloadonionshare-f0d823bdcc4ff12663d805fc98bf0656881ed409.tar.gz
onionshare-f0d823bdcc4ff12663d805fc98bf0656881ed409.zip
installation instructions
-rw-r--r--cli/README.md61
1 files changed, 58 insertions, 3 deletions
diff --git a/cli/README.md b/cli/README.md
index 744ece4d..b6cbfc08 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -22,14 +22,69 @@
## 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`.
+First, make sure you have `tor` and `python3` installed. In Linux, install it through your package manager. In macOS, install it with [Homebrew](https://brew.sh): `brew install tor`. Second, OnionShare is written in python, and you can install the command line version use python's package manager `pip`.
-Then install OnionShare CLI:
+### Requirements
+Debian/Ubuntu (APT):
```sh
-pip install onionshare-cli
+sudo apt-get install tor python3-pip
```
+Arch (Pacman):
+```sh
+sudo pacman -S tor python-pip
+```
+
+CentOS, Red Hat, and Fedora (Yum):
+```sh
+sudo yum install tor python3 python3-wheel
+```
+
+macOS (Homebrew):
+```sh
+brew install tor python
+sudo easy_install pip
+```
+
+### Main
+
+#### Installation
+
+Install OnionShare CLI:
+
+```sh
+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.
+
+Fist, discover what is your shell:
+
+```sh
+echo $SHELL
+```
+
+Then apply the path to your shell file:
+
+bash:
+
+```sh
+echo "PATH=\$PATH:~/.local/bin" >> ~/.bashrc
+source ~/.bashrc
+```
+
+zsh:
+
+```sh
+echo "PATH=\$PATH:~/.local/bin" >> ~/.zshrc
+source ~/.zshrc
+```
+
+#### Usage
+
Then run it with:
```sh