https://github.com/phukon/gitkeykit
Setup pgp keys 🔑 and sign commits with ease.
https://github.com/phukon/gitkeykit
git gnupg gpg pgp public-key-infrastructure
Last synced: 8 months ago
JSON representation
Setup pgp keys 🔑 and sign commits with ease.
- Host: GitHub
- URL: https://github.com/phukon/gitkeykit
- Owner: phukon
- License: mit
- Created: 2024-03-02T21:39:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-25T19:17:07.000Z (8 months ago)
- Last Synced: 2025-01-25T19:21:54.774Z (8 months ago)
- Topics: git, gnupg, gpg, pgp, public-key-infrastructure
- Language: TypeScript
- Homepage: https://npmjs.com/gitkeykit
- Size: 167 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧰 GitKeykit
 
Simplify PGP key setup and signing commits on Linux and Windows.
## 📦 Installation
```bash
# Using npx (recommended)
npx gitkeykit
# Or install globally
npm install -g gitkeykit
```
## 🚀 Usage
### Basic Setup
```bash
# Start the interactive setup
gitkeykit
# Import existing PGP key
gitkeykit import my_key.txt
# Reset configurations
gitkeykit --reset
# Show version number
gitkeykit --version
# Display help information and available commands
gitkeykit --help
```
### Command Options
- `--reset` Reset Git and GPG configurations
- `--help` Show help information
- `--version` Show version number
- `--import ` Import and configure PGP key from file
## ✨ Features
- **Interactive Setup**: Guided process for creating or importing PGP keys
- **Cross-Platform**: Works seamlessly on both Linux and Windows
- **Secure Configuration**:
- Automatic Git signing setup
- GPG agent configuration
- Secure passphrase handling
- **Error Handling**: Clear error messages and recovery options
- **Backup & Reset**: Automatic backup of existing configurations with reset capability
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.