Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/therebelrobot/gpgez

A CLI wrapper for common GPG commands, cuz typing sux
https://github.com/therebelrobot/gpgez

Last synced: 9 days ago
JSON representation

A CLI wrapper for common GPG commands, cuz typing sux

Awesome Lists containing this project

README

        

# gpgez

A wrapper for common GPG commands, cuz typing sux

## Installation

```
npm install gpgez -g
```

## Usage

### help

```
$ gpgez --help

gpgez v0.0.1
A wrapper for common GPG commands, cuz typing sux

License: ISC
Author: Trent Oswald (@therebelrobot)
Homepage: https://github.com/therebelrobot/gpgez

Usage:
gpgez [options]

Options:
-h, --help Show this help dialog
-v, --verbose Enable verbose mode
-#, --debug Enable Developer Debug mode
--version Print version number

Methods:
All Methods have their own help dialog. Simply use:
gpgez [command] --help or gpgez [command] -h

gen Generate keypair
gen-revoke Generate revocation certificate from email or Key ID
list list PGP keys, public and private
fingerprint View fingerprint for key
send Send PGP key to keyserver
get Get PGP key from keyserver
sign Sign either a public key or a file/message
edit Edit public key, set trust
trust Edit public key, set trust (alias of edit)
export Export public key
import Import a signed public key
encrypt Encrypt file/message
decrypt Decrypt file/message
verify Verify the public key of a signed file/message
```

### version

```
$ gpgez --version

gpgez v1.0.0
A wrapper for common GPG commands, cuz typing sux

License: ISC
Author: Trent Oswald (@therebelrobot)
Homepage: https://github.com/therebelrobot/gpgez
```

### gen

```
$ gpgez gen --help

Usage:
gpgez gen
Generate keypair
Starts generating private/public keypair.
```

### gen-revoke

```
$ gpgez gen-revoke --help

Usage:
gpgez gen-revoke
Generate revocation certificate from email or Key ID
is the email address or keyID of the keypair.
```

### list

```
$ gpgez list --help

Usage:
gpgez list [--private] [--public]
list PGP keys, public and private
Lists all GPG keys on the system, filtered by flag (defaults to both)
```

### fingerprint

```
$ gpgez fingerprint --help

Usage:
gpgez fingerprint
View fingerprint for key
is the email address or keyID of a keypair, public or private.
```

### send

```
$ gpgez send --help

Usage:
gpgez send to
Send PGP key to keyserver
is the email address or keyID of the keypair,
and is a working keyserver.
```

### get

```
$ gpgez get --help

Usage:
gpgez get from
Get PGP key from keyserver
is the email address or keyID of the keypair, public or private,
and is a working keyserver.
```

### sign

```
$ gpgez sign --help

Usage:
gpgez sign [with ]
gpgez sign [to ]
Sign either a public key or a file
(optional, defaults to message signing) is the email address or keyID of the keypair to sign, is the name of the output file,
(optional, defaults to default private key) is the email address or keyID of the keypair to encrypt with, (optional, defaults to stdout) is the filename to save the output to.
```

### edit

```
$ gpgez edit --help

Usage:
gpgez edit
Edit public key, set trust
is the email address or keyID of the keypair.
```

### trust

```
$ gpgez trust --help

Usage:
gpgez trust
Edit public key, set trust (alias of edit)
is the email address or keyID of the keypair.
```

### export

```
$ gpgez export --help

Usage:
gpgez export to
Export public key
is the email address or keyID of the keypair,
and is the name of the output file.
```

### import

```
$ gpgez import --help

Usage:
gpgez import
Import a signed public key
is the name of the file to import.
```

### encrypt

```
$ gpgez encrypt --help

Usage:
gpgez encrypt for [to ]
Encrypt file
is the name of the output file,
(optional, defaults to default private key) is the email address or keyID of the keypair to encrypt with,
(optional, defaults to stdout) is the filename to save the output to.
```

### decrypt

```
$ gpgez decrypt --help

Usage:
gpgez decrypt [to ]
Decrypt file
is the name of the file to decrypt,
(optional, defaults to default private key) is the email address or keyID of the keypair to decrypt with,
(optional, defaults to stdout) is the filename to save the output to.
```

### verify

```
$ gpgez verify --help

Usage:
gpgez verify
Verify the public key of a signed file
is the name of the file to verify.
```

## License
[ISC](https://tldrlegal.com/license/-isc-license)

Copyright (c) 2015, Trent Oswald (@therebelrobot)

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/therebelrobot/gpgez/trend.png)](https://bitdeli.com/free "Bitdeli Badge")