pgpainless/pgpainless-cli/README.md

<!--
SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>

SPDX-License-Identifier: Apache-2.0
-->

# PGPainless-CLI

[![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.

It plugs `pgpainless-sop` into `sop-java-picocli`.

## Build
To build an executable, `gradle shadowJar` should be sufficient. The resulting jar file can be found in `pgpainless-cli/build/libs/`.

## Execute

The jar file produced in the step above is executable as is.

```
java -jar pgpainless-cli-XXX-all.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!
Reuse compliance 2021-10-07 15:48:52 +02:00			`<!--`
			`SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>`

			`SPDX-License-Identifier: Apache-2.0`
			`-->`

Add readmes for all modules 2021-07-17 00:27:58 +02:00			`# PGPainless-CLI`
Add README for sop module 2021-01-03 17:45:05 +01:00
Host javadoc on javadoc.io 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)`

Switch to version agnostic SOP spec URL 2022-05-07 22:15:13 +02:00			`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.`
Add readmes for all modules 2021-07-17 00:27:58 +02:00
			It plugs `pgpainless-sop` into `sop-java-picocli`.
Add README for sop module 2021-01-03 17:45:05 +01:00
			`## Build`
cli: Use dedicated shadow plugin for building fat jar 'gradle shadowJar' can be used to build a fat jar 'gradle jar' now only builds slim jar 2022-07-08 18:26:45 +02:00			To build an executable, `gradle shadowJar` should be sufficient. The resulting jar file can be found in `pgpainless-cli/build/libs/`.
Add README for sop module 2021-01-03 17:45:05 +01:00
			`## Execute`

Add readmes for all modules 2021-07-17 00:27:58 +02:00			`The jar file produced in the step above is executable as is.`

			```
cli: Use dedicated shadow plugin for building fat jar 'gradle shadowJar' can be used to build a fat jar 'gradle jar' now only builds slim jar 2022-07-08 18:26:45 +02:00			`java -jar pgpainless-cli-XXX-all.jar help`
Add readmes for all modules 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.
Add README for sop module 2021-01-03 17:45:05 +01:00
Update pgpainless-cli/README.md 2021-07-15 17:50:57 +02:00			`To discover all available commands use`
Add readmes for all modules 2021-07-17 00:27:58 +02:00
Add README for sop module 2021-01-03 17:45:05 +01:00			```
Update pgpainless-cli/README.md 2021-07-15 17:50:57 +02:00			`./pgpainless-cli help`
Add README for sop module 2021-01-03 17:45:05 +01:00			```

			`Enjoy!`