PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2025-09-09 18:29:39 +02:00
Code Issues Releases Wiki Activity

Add readmes for all modules

Browse source
This commit is contained in:
Paul Schaub 2021-07-17 00:27:58 +02:00
parent 88faaf5dd0
commit 4244107994
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
5 changed files with 77 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
pgpainless-cli/README.md
View file

@ -1,15 +1,24 @@
# PGPainless-SOP
# PGPainless-CLI
PGPainless-SOP is an implementation of the [Stateless OpenPGP Command Line Interface](https://tools.ietf.org/html/draft-dkg-openpgp-stateless-cli-01) specification based on PGPainless.
PGPainless-CLI is an implementation of the [Stateless OpenPGP Command Line Interface](https://tools.ietf.org/html/draft-dkg-openpgp-stateless-cli-01) specification based on PGPainless.
It plugs `pgpainless-sop` into `sop-java-picocli`.
## Build
To build an executable, `gradle jar` should be sufficient. The resulting jar file can be found in `pgpainless-sop/build/libs/`.
## Execute
Alternatively you can use the provided `./pgpainless-cli` script to execute PGPainless' Stateless Command Line Interface from within Gradle.
The jar file produced in the step above is executable as is.
```
java -jar pgpainless-cli-XXX.jar help
```
Alternatively you can use the provided `./pgpainless-cli` script to directly build and execute PGPainless' Stateless Command Line Interface from within Gradle.
To discover all available commands use
```
./pgpainless-cli help
```