arokettu/encryptor

1.1.5 2024-04-03 21:21 UTC

README

Packagist Packagist Gitlab pipeline status Codecov

A small and simple tool to encrypt small files with with libsodium.

Installation

Install for local user with composer:

composer global require arokettu/encryptor

Install globally by downloading prebuilt phar:

sudo wget https://github.com/arokettu/php-encryptor/releases/latest/download/encryptor.phar -O /usr/local/bin/encryptor
sudo chmod +x /usr/local/bin/encryptor

Simple usage

Encrypt file:

encryptor encrypt filename.txt

Decrypt file:

encryptor decrypt filename.txt.encrypted

You will be interactively asked for the password

Documentation

Read full documentation here: https://sandfox.dev/php/encryptor.html

Also on Read the Docs: https://php-encryptor.readthedocs.io/

License

The library is available as open source under the terms of the MIT License.