https://github.com/mirkoschubert/node-gpg
A Node.js wrapper for gpg
https://github.com/mirkoschubert/node-gpg
gnupg gnupg2 gpg gpg-encryption gpg-signature pgp wrapper
Last synced: about 1 year ago
JSON representation
A Node.js wrapper for gpg
- Host: GitHub
- URL: https://github.com/mirkoschubert/node-gpg
- Owner: mirkoschubert
- License: mit
- Created: 2018-11-02T08:46:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-07T09:51:35.000Z (almost 4 years ago)
- Last Synced: 2024-08-09T02:34:54.308Z (almost 2 years ago)
- Topics: gnupg, gnupg2, gpg, gpg-encryption, gpg-signature, pgp, wrapper
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 8
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-gpg
**node-gpg** is a wrapper for Node.js so you can use [GnuPGP](https://www.gnupg.org) in your applications. I was working on an Mailspring plugin for GPG and needed a connection to the GPG keyring. Since most of the wrappers didn't work for me, I simply wrote one myself.
*Please note, that this node module is still work in progress! I tested it with my own keyring on macOS and for me it's working so far. But I can't guarantee that it's working for everyone else.*
## Usage
To install this package is easy: Simply use your favorite package manager and type the following command:
```
npm install node-gpg
```
There are [some examples](https://github.com/mirkoschubert/node-gpg/tree/master/examples) for encrypting, decrypting, signing and verifying messages. Please use them to learn how to use the API of this module. Promises have been made, so async/ await should work just fine. :smirk:
## Credits
This package is inspired by, but not based on [drudge/node-gpg](https://github.com/drudge/node-gpg), but without him I wouldn't have written this code so fast.