git-age prskr

Use this command to install git-age:

winget install --id=prskr.git-age -e

git-age is a Git smudge/clean filter designed to transparently encrypt and decrypt files within a Git repository, ensuring sensitive data remains secure while maintaining seamless workflow integration. It leverages age encryption for modern and efficient file protection.

Key Features:

Transparent Encryption/Decryption: Files are automatically encrypted upon commit and decrypted during checkout, with no disruption to the user experience.
Multi-User Support: Manages recipients' public keys, allowing secure collaboration among multiple users by re-encrypting files for new contributors.
Seamless Git Integration: Works as a smudge/clean filter, integrating effortlessly into existing Git workflows without requiring major changes.

Audience & Benefit: Ideal for developers and teams managing sensitive data in Git repositories. It provides robust encryption to protect intellectual property or personal information while keeping operations straightforward. This tool is particularly beneficial for those seeking integrated encryption within their version control system rather than external solutions.

git-age

Disclaimer

This project is based on age. I'm in no way affiliated with the original project.

A big shoutout to Filippo Valsorda for creating age and making it available to the public.

Introduction

Install

See INSTALL.md.

Getting started

Install hooks in global git config

git age install

This will add the git-age clean and smudge filters to your global git config.

Init repository to share secret files

git age init

# or if you want to add some comment to the generated key
git age init -c "My comment"

Add another user to an already prepared repository

Remarks: The repository has to be in a clean state i.e. no changes files.

Alice wants to share the secrets stored in her Git repository with Bob.

Bob installs git-age on his machine and configures his global git config

git age install

Bob generates a new key pair

git age gen-key

# or if you want to add some comment to the generated key
git age gen-key -c "My comment"

the generated private key will be stored automatically in your keys.txt

Bob sends his public key to Alice
Alice adds Bob's public key to her repository

git age add-recipient 

# or if you want to add some comment to the added key

git age add-recipient -c "My comment"

git age add-recipient will:

add the public key to the repository (.agerecipients file)
re-encrypt all files with the new set of recipients
commit the changes

As soon as Alice pushed the changes to the remote repository, Bob can pull the changes and decrypt the files.

Platform	Config path
Linux	`$XDG_CONFIG_HOME/git-age/keys.txt` i.e. `$HOME/.config/git-age.keys.txt`
macOS	`$HOME/Library/Application Support/git-age/keys.txt`
Windows	`%LOCALAPPDATA%\git-age\keys.txt`

git-age prskr

README

git-age

Disclaimer

Introduction

Install

Getting started

Install hooks in global git config

Init repository to share secret files

Add another user to an already prepared repository

Tips and tricks

Diff of text files

Configuration

Alternatives

Development

Required Tools

Install husky