Skip to content

phukon/gitkeykit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

75 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿงฐ GitKeykit

GitHub release (with filter) npm downloads

for_preferred_anon-min

Simplify PGP key setup and signing commits on Linux and Windows.

๐Ÿ“ฆ Installation

# Using npx (recommended)
npx gitkeykit 

# Or install globally
npm install -g gitkeykit 

๐Ÿš€ Usage

Basic Setup

# 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 <key_path.txt> 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.