cottage

cottage ist ein GitOps-Tool für Teams zur Verwaltung von age-verschlüsselten Secrets in Git-Repositories.

Es bietet einen einfachen Workflow zum Verschlüsseln/Entschlüsseln von Secrets, zur Verwaltung von Empfängern und hält Secrets aus dem Repository heraus, während die einfache Weitergabe über VCS weiterhin möglich ist. cottage generiert außerdem geschwärzte Vorschauen verschlüsselter Secrets für bessere Sichtbarkeit und unterstützt sowohl persistente als auch temporäre Entschlüsselungs-Workflows, wobei sichergestellt wird, dass Secrets niemals im Klartext committet werden.

1. Funktionen
2. Installation
3. Editor-Integrationen
   1. VS Code-Erweiterung
   2. Cursor- und Eclipse-Erweiterung
   3. Vim-Plugin
4. KI-Agenten-Integrationen
   1. Claude Code-Integration
   2. GitHub Copilot-Integration
   3. Codex-Integration
   4. Antigravity (agy)-Integration
   5. Cursor-Integration
5. Schnellstart
6. GitOps
7. Git-Hooks
8. Zugriffskontrolle
   1. Regeln
   2. Verifizierung
9. Jeder Anbieter als Upstream
   1. Beispiel-Plugins
10. Mit jedem Gerät synchronisieren
11. Mehr erfahren
12. Fehlerbehebung
13. Vergleich
    1. age vs. andere Verschlüsselung
    2. cottage vs. SOPS
    3. cottage vs. dotenvx
    4. cottage vs. agebox

Funktionen

• Sicher vor Offenlegung: Nutzt Rusts Typsystem, um sicherzustellen, dass Fehler niemals versehentlich Secrets offenlegen können.
• Teamfreundlich: Teile öffentliche Schlüssel (Empfänger) im Repository, halte private Schlüssel (Identitäten) lokal.
• Zugriffskontrolle: Einfache Allow/Deny-Regeln zur Steuerung, welche Secrets für welche Empfänger verschlüsselt werden.
• Verwaltet .gitignore: Aktualisiert .gitignore automatisch, um unverschlüsselte Secrets aus dem Repository herauszuhalten.
• Vorschauen: Generiert zeitgestempelte geschwärzte Vorschauen verschlüsselter Secrets für bessere Sichtbarkeit.
• Aussagekräftige Diffs: Hält Git-Diffs sauber und überprüfbar, während ctg diff den Diff lokal geänderter Secrets mit den getrackten verschlüsselten Gegenstücken anzeigt.
• Checksummen-Verifizierung: Verhindert Manipulation durch Überprüfung, dass verschlüsselte Secrets und Empfängerlisten mit den Metadaten übereinstimmen.
• Git-Hooks: Einfache Einrichtung von Git-Hooks zum automatischen Prüfen/Verschlüsseln von Secrets vor dem Commit und Entschlüsseln nach dem Checkout.
• Persistenter Secrets-Workflow: ctg decrypt/sync behält entschlüsselte Secrets auf der Festplatte.
• Intelligenter Bereinigungs-Lebenszyklus: ctg run (Kurzform ctgx) und ctg edit entschlüsseln Secrets vor der Operation und behalten sie auf der Festplatte, wenn sie bereits vorher vorhanden waren, oder bereinigen sie danach automatisch, wenn sie es nicht waren.
• Bereinigung nach Abschluss: ctg encrypt --clean, ctg run --clean und ctg edit --clean stellen sicher, dass entschlüsselte Dateien von der Festplatte bereinigt werden, auch wenn sie vorher vorhanden waren.
• Umgebungsinjektions-Workflow: ctg env injiziert entschlüsselte Secrets als Umgebungsvariablen, um einen Befehl auszuführen, ohne sie überhaupt auf die Festplatte zu schreiben.
• Sicheres Secret-Piping: ctg cat PATH entschlüsselt im Speicher und gibt auf stdout aus, für direktes stdin-Piping an andere Tools.
• Bereinigung: ctg clean löscht alle entschlüsselten Secrets aus dem lokalen Repository, damit du deine KI-Agenten mit etwas weniger Sorge laufen lassen kannst.
• Unterstützt jj und Nicht-Git-Verzeichnisse: ctg init verwandelt jedes Verzeichnis in einen Secret-Store.
• Mit jedem Anbieter synchronisieren: Ermöglicht die Konfiguration jedes Anbieters mit einer API als Upstream und die Nutzung von ctg pull/diff/push wie git pull/diff/push.
• Mit jedem Gerät synchronisieren: Mit cottage verschlüsselte und in einem Git-Repository verwaltete Secrets können geräteübergreifend mit Cottage Sync synchronisiert werden.

Installation

# rust: cargo-binstall/cargo
cargo binstall --locked cottage
cargo install --locked cottage

# python: pip/uv/uvx
pip install cottage
uv pip install cottage
uvx --from cottage ctg --version

# node: yarn/pnpm/npx
yarn global add @sayanarijit/cottage
pnpm add -g @sayanarijit/cottage
npx -p @sayanarijit/cottage ctg --version

Auch als Docker-Images verfügbar:

# Docker
docker run --rm -v $PWD:/app sayanarijit/cottage --version

# Podman
podman run --rm -v $PWD:/app quay.io/sayanarijit/cottage --version

Oder lade die neueste Version von GitHub herunter.

Editor-Integrationen

VS Code-Erweiterung

Verwende die Cottage VS Code-Erweiterung, um ctg zu installieren, Copilot-Sicherheits-Hooks hinzuzufügen, Dateien aus dem Explorer zu verschlüsseln und .cott.age-Dateien über den Editor-Workflow zu öffnen.

Installiere sie aus dem Visual Studio Marketplace oder baue und installiere sie lokal aus vscode-plugin-cottage.

Cursor- und Eclipse-Erweiterung

Lade die VSX-Datei herunter und installiere sie in deiner Cursor- oder Eclipse-IDE. Sie funktioniert ähnlich wie die VS Code-Erweiterung.

Vim-Plugin

Verwende das cottage.vim-Plugin, um Secrets aus Vim oder Neovim zu verschlüsseln/entschlüsseln.

KI-Agenten-Integrationen