Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 1.71 KB

README.md

File metadata and controls

58 lines (35 loc) · 1.71 KB
Raw

yopass-cli

Build Status

PyPI version

This is a command-line tool to interact with a (the) yopass backend created by Johan Haals. Even though it is possible to use the service via the web-frontend I felt the necessity of a cli tool to use this awesome software in our automation projects.

This cli tool uses sjcl (just like the web-frontend) to perform encryption on the client side thus preventing your secret from ever leaving your os in a cleartext form.

Installation

yopass-cli requires python3+ to run.

$ pip install --user yopass-cli

Make sure to have the following 2 environment variables set before using:

  • YOPASS_BACKEND_URL

  • YOPASS_FRONTEND_URL

      $ export YOPASS_BACKEND_URL=https://api.yopass.se
  $ export YOPASS_FRONTEND_URL=https://yopass.se

If you use your own server, the front and backend URLs can be the same. For example: https://yopass.domain.net

Usage

yopass-cli send [OPTIONS] SECRET
cat <filename> | yopass-cli send [OPTIONS]
echo "<my passphrase" | yopass-cli send [OPTIONS]
yopass-cli get [OPTIONS] SID PASSPHRASE

Send Options:

--expires [1h|1d|1w]
--outmode [verbose|one-click-link|short-link|id]
--outformat [plain|json]

Get Options:

--outformat [plain|json]

Todos

  • testing
  • proper README

License

MIT

Free Software, Hell Yeah!

Contribution is welcome :) 🍺Cheers 🍺