1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-01 01:55:59 +01:00
pgpainless/pgpainless-cli/README.md

35 lines
1,016 B
Markdown
Raw Normal View History

2021-10-07 15:48:52 +02:00
<!--
SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
SPDX-License-Identifier: Apache-2.0
-->
2021-07-17 00:27:58 +02:00
# PGPainless-CLI
2021-01-03 17:45:05 +01:00
2022-02-11 14:23:19 +01:00
[![javadoc](https://javadoc.io/badge2/org.pgpainless/pgpainless-cli/javadoc.svg)](https://javadoc.io/doc/org.pgpainless/pgpainless-cli)
PGPainless-CLI is an implementation of the [Stateless OpenPGP Command Line Interface](https://datatracker.ietf.org/doc/draft-dkg-openpgp-stateless-cli/) specification based on PGPainless.
2021-07-17 00:27:58 +02:00
It plugs `pgpainless-sop` into `sop-java-picocli`.
2021-01-03 17:45:05 +01:00
## Build
To build an executable, `gradle shadowJar` should be sufficient. The resulting jar file can be found in `pgpainless-cli/build/libs/`.
2021-01-03 17:45:05 +01:00
## 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-all.jar help
2021-07-17 00:27:58 +02:00
```
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!