File: README.md

package info (click to toggle)
pgpainless 1.6.9-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,472 kB
  • sloc: java: 45,272; xml: 217; sh: 86; makefile: 74; python: 31
file content (34 lines) | stat: -rw-r--r-- 1,016 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<!--
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!