🚀 Usage Guide¶
Run help for quick usage:
gcm help
Commands¶
| Command | Description |
|---|---|
| gcm setup | Initialize encryption rules. |
| gcm add-users | Add trusted GPG collaborators. |
| gcm list-users | Show currently authorized users. |
| gcm rotate-users | Replace GPG key for a user. |
| gcm revoke-users | Remove access from users. |
| gcm destroy | Remove git-crypt encryption (dangerous). |
Adding Users¶
gcm add-users
You will be prompted:
- number of users
- GPG Key IDs (email / fingerprint / short ID)
- key trust is verified automatically
Example:
GPG key identifier for user 1: 1234567890ABCDEF
[OK] Added GPG user: Alice Jones <alice@example.com>
Listing Users¶
gcm list-users
Output:
Current git-crypt users:
- Alice <alice@example.com> (1234567890ABCDEF)
- Bob <bob@example.com> (FEDCBA0987654321)
Rotating Keys¶
Used when a user generates a new key:
gcm rotate-users
Revoking Users¶
gcm revoke-users
When needed:
- Employee leaves the company
- Third-party contract ends
- Compromised key must be removed
Destroy Encryption¶
Removes all git-crypt functionality:
gcm unencrypt
⚠️ This cannot be undone without re-encrypting data