1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-12-23 19:38:00 +01:00
pgpainless/pgpainless-cli/README.md
2021-10-07 16:28:31 +02:00

32 lines
866 B
Markdown

<!--
SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
SPDX-License-Identifier: Apache-2.0
-->
# PGPainless-CLI
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
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
```
Enjoy!