mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-26 14:22:05 +01:00

History

Paul Schaub 4244107994 Add readmes for all modules		2021-07-17 00:27:58 +02:00
..
src	Use picocli's builtin help command	2021-07-15 17:49:30 +02:00
build.gradle	Base PGPainlessCLI on new sop-java module	2021-07-15 17:03:56 +02:00
README.md	Add readmes for all modules	2021-07-17 00:27:58 +02:00

README.md

SOP-Java-Picocli

Implementation of the Stateless OpenPGP Command Line Interface specification. This terminal application allows generation of OpenPGP keys, extraction of public key certificates, armoring and de-armoring of data, as well as - of course - encryption/decryption of messages and creation/verification of signatures.

Install a SOP backend

This module comes without a SOP backend, so in order to function you need to extend it with an implementation of the interfaces defined in sop-java. An implementation using PGPainless can be found in the module pgpainless-sop, but it is of course possible to provide your own implementation.

Just install your SOP backend by calling

// static method call prior to execution of the main method
SopCLI.setSopInstance(yourSopImpl);

Usage

To get an overview of available commands of the application, execute

java -jar sop-java-picocli-XXX.jar help

If you just want to get started encrypting messages, see the module pgpainless-cli which initializes sop-java-picocli with pgpainless-sop, so you can get started right away without the need to manually wire stuff up.

Enjoy!