https://github.com/sectly/edsign
A simple command-line tool for signing files with Ed25519
https://github.com/sectly/edsign
Last synced: about 1 year ago
JSON representation
A simple command-line tool for signing files with Ed25519
- Host: GitHub
- URL: https://github.com/sectly/edsign
- Owner: Sectly
- License: mit
- Created: 2024-04-13T09:43:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T09:50:12.000Z (about 2 years ago)
- Last Synced: 2025-03-10T07:17:07.625Z (over 1 year ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Edsign
Edsign is a simple command-line tool for signing files with Ed25519.
## Installation
You can install Edsign via npm:
```bash
npm install -g edsign
```
## Usage
```
Usage: edsign [options]
Options:
-V, --version output the version number
-s, --sign [comment] [keyPath] Sign files matching the glob pattern with the provided private key
-c, --create Create an Ed25519 key pair (private and public keys)
-v, --verify [publicKeyPath] Verify the signature of files matching the glob pattern with the provided public key (default: ~/.edsign/public.key)
-h, --help display help for command
```
### Signing Files
To sign files, you can use the `-s` or `--sign` option. You need to provide a file glob pattern, and optionally a comment and a custom key path. If no key path is provided, the tool will use the default private key path (`~/.edsign/private.key`).
Example:
```bash
edsign -s "path/to/files/*.txt" "Signed with Edsign" "custom/private/key/path"
```
### Creating Key Pair
To create an Ed25519 key pair, use the `-c` or `--create` option. This will generate a private key and its corresponding public key, saving them in the default key pair directory (`~/.edsign/`).
Example:
```bash
edsign -c
```
### Verifying Signatures
To verify the signatures of files, you can use the `-v` or `--verify` option. Provide a file or directory glob pattern, and optionally the path to the public key file. If no public key path is provided, the default public key path (`~/.edsign/public.key`) will be used.
Example:
```bash
edsign -v "path/to/files/*.txt" "custom/public/key/path"
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.