george/PBinCLI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update rst readme, remove unused import

Browse Source
This commit is contained in:
r4sas
2019-06-21 13:32:46 +00:00
parent 5d988e01fc
commit dc034b1d55
5 changed files with 23 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.rst
View File

@@ -10,81 +10,74 @@
:alt: GitHub tag
.. image:: https://img.shields.io/github/release/r4sas/PBinCLI.svg
:target: https://github.com/r4sas/PBinCLI/releases/
:alt: GitHub release
.. image:: https://api.codacy.com/project/badge/Grade/4f24f43356a84621bbd9078c4b3f1b70
:target: https://www.codacy.com/app/r4sas/PBinCLI?utm_source=github.com&utm_medium=referral&utm_content=r4sas/PBinCLI&utm_campaign=Badge_Grade
:alt: Codacy Badge
PBinCLI
=======
`PrivateBin <https://github.com/PrivateBin/PrivateBin/>`_ CLI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PBinCLI is command line client for `PrivateBin <https://github.com/PrivateBin/PrivateBin/>`_ written on Python 3.
Installing
----------
.. code-block:: bash
$ virtualenv --python=python3 venv
$ . venv/bin/activate
$ pip install pbincli
virtualenv --python=python3 venv
. venv/bin/activate
pip install pbincli
Usage
-----
By default pbincli configured to use https://paste.i2pd.xyz/ for sending and receiving pastes. No proxy used by default.
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:
.. code-block::
.. code-block:: ini
server=https://paste.i2pd.xyz/
proxy=http://127.0.0.1:3128
Run inside ``venv`` command:
.. code-block::
$ pbincli send --text "Hello!"
.. code-block:: bash
pbincli send --text "Hello!"
Or use stdin input to read text for paste:
.. code-block::
.. code-block:: bash
$ pbincli send - <<EOF
pbincli send - <<EOF
Hello! This is test paste!
EOF
It will send string ``Hello! This is test paste!`` to PrivateBin.
To send file use ``--file`` or ``-f`` with filename. Example:
.. code-block::
$ pbincli send -c "My document" -f info.pdf
.. code-block:: bash
pbincli send -c "My document" -f info.pdf
To retrieve paste from server, use ``get`` command with paste info.
It must be formated like ``pasteID#passphrase``. Example:
.. code-block::
$ pbincli get 49eeb1326cfa9491#vfeortoVWaYeJlviDdhxQBtj5e0I2kArpynrtu/tnGs=
.. code-block:: bash
pbincli get 49eeb1326cfa9491#vfeortoVWaYeJlviDdhxQBtj5e0I2kArpynrtu/tnGs=
More info you can find by typing
.. code-block::
$ pbincli [-h] {send, get, delete}
.. code-block:: bash
pbincli [-h] {send, get, delete}
TODO
----