r4sas/PBinCLI
1
1
Fork 1
mirror of https://github.com/r4sas/PBinCLI synced 2025-01-26 06:24:36 +00:00
Code Issues Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
R4SAS 2018-09-22 01:33:21 +03:00
parent 6b33a741ba
commit 29e0af1a05
1 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -8,40 +8,52 @@ Installing
```bash ```bash
$ virtualenv --python=python3 venv $ virtualenv --python=python3 venv
$ . venv/bin/activate $ . venv/bin/activate
$ pip install -r requirements.txt $ pip install pbincli
``` ```
Usage Usage
----- -----
Edit variables `server`, `proxies` and `useproxy` in `pbincli/settings.py` to your values. By default pbincli configured to use https://paste.i2pd.xyz/ for sending and receiving pastes. No proxy used by default.
You can create config file with variables `server` and `proxy` in `~/.config/pbincli/pbincli.conf` to use different settings.
Example contents:
```
server=https://paste.i2pd.xyz/
proxy=http://127.0.0.1:3128
```
Run inside `venv` command: Run inside `venv` command:
$ ./cli send --text "Hello!" $ pbincli send --text "Hello!"
Or use stdin input to read text for paste: Or use stdin input to read text for paste:
$ ./cli send - <<EOF $ pbincli send - <<EOF
Hello! Hello! This is test paste!
This is test paste!
EOF EOF
It will send string `Hello!` to PrivateBin. It will send string `Hello! This is test paste!` to PrivateBin.
To send file use `--file` or `-f` with filename. Example: To send file use `--file` or `-f` with filename. Example:
$ ./cli send -c "My document" -f info.pdf $ pbincli send -c "My document" -f info.pdf
To retrieve paste from server, use `get` command with paste info. To retrieve paste from server, use `get` command with paste info.
It must be formated like `pasteID#passphrase`. Example: It must be formated like `pasteID#passphrase`. Example:
$ ./cli get 49eeb1326cfa9491#vfeortoVWaYeJlviDdhxQBtj5e0I2kArpynrtu/tnGs= $ pbincli get 49eeb1326cfa9491#vfeortoVWaYeJlviDdhxQBtj5e0I2kArpynrtu/tnGs=
More info you can find by typing More info you can find by typing
$ ./cli [-h] {send, get, delete} $ pbincli [-h] {send, get, delete}
TODO
----
Write a more complete usage documentation.
License License
------- -------