pgpainless/pgpainless-cli/README.md

27 lines
754 B
Markdown
Raw Normal View History

2021-07-17 00:27:58 +02:00
# PGPainless-CLI
2021-01-03 17:45:05 +01:00
2021-07-17 00:27:58 +02:00
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`.
2021-01-03 17:45:05 +01:00
## Build
To build an executable, `gradle jar` should be sufficient. The resulting jar file can be found in `pgpainless-sop/build/libs/`.
## Execute
2021-07-17 00:27:58 +02:00
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.
2021-01-03 17:45:05 +01:00
2021-07-15 17:50:57 +02:00
To discover all available commands use
2021-07-17 00:27:58 +02:00
2021-01-03 17:45:05 +01:00
```
2021-07-15 17:50:57 +02:00
./pgpainless-cli help
2021-01-03 17:45:05 +01:00
```
Enjoy!