cottage

cottage est un outil GitOps permettant aux équipes de gérer des secrets chiffrés avec age dans des dépôts git.

Il fournit un workflow simple pour chiffrer/déchiffrer des secrets, gérer les destinataires et garder les secrets hors du dépôt tout en permettant un partage facile via VCS. cottage génère également des aperçus expurgés des secrets chiffrés pour une meilleure visibilité et prend en charge les workflows de déchiffrement persistants et temporaires, tout en garantissant que les secrets ne sont jamais commités en clair.

1. Fonctionnalités
2. Installation
3. Intégrations d'éditeurs
   1. Extension VS Code
   2. Extension Cursor et Eclipse
   3. Plugin Vim
4. Intégrations d'agents IA
   1. Intégration Claude Code
   2. Intégration GitHub Copilot
   3. Intégration Codex
   4. Intégration Antigravity (agy)
   5. Intégration Cursor
5. Démarrage rapide
6. GitOps
7. Hooks Git
8. Contrôle d'accès
   1. Règles
   2. Vérification
9. N'importe quel fournisseur comme upstream
   1. Plugins d'exemple
10. Synchronisation avec n'importe quel appareil
11. En savoir plus
12. Dépannage
13. Comparaison
    1. age vs autres chiffrements
    2. cottage vs SOPS
    3. cottage vs dotenvx
    4. cottage vs agebox

Fonctionnalités

• Sûr face à l'exposition : Utilise le système de types de Rust pour garantir que les bugs ne puissent jamais exposer accidentellement des secrets.
• Adapté aux équipes : Partagez les clés publiques (destinataires) dans le dépôt, gardez les clés privées (identités) en local.
• Contrôle d'accès : Règles simples d'autorisation/refus pour contrôler quels secrets sont chiffrés pour quels destinataires.
• Gère .gitignore : Met automatiquement à jour .gitignore pour garder les secrets non chiffrés hors du dépôt.
• Aperçus : Génère des aperçus expurgés horodatés des secrets chiffrés pour une meilleure visibilité.
• Diffs riches : Garde le git diff propre et révisable, tandis que ctg diff affiche le diff des secrets modifiés localement avec leurs équivalents chiffrés suivis.
• Vérification de checksum : Empêche la falsification en vérifiant que les secrets chiffrés et les listes de destinataires correspondent aux métadonnées.
• Hooks Git : Configurez facilement des hooks git pour vérifier/chiffrer automatiquement les secrets avant commit et les déchiffrer après checkout.
• Workflow de secrets persistants : ctg decrypt/sync conserve les secrets déchiffrés sur le disque.
• Cycle de nettoyage intelligent : ctg run (raccourci ctgx) et ctg edit déchiffrent les secrets avant l'opération, les conservant sur le disque s'ils étaient déjà présents auparavant ou les nettoyant automatiquement ensuite s'ils ne l'étaient pas.
• Nettoyage à la fin : ctg encrypt --clean, ctg run --clean et ctg edit --clean garantissent que les fichiers déchiffrés sont nettoyés du disque même s'ils étaient présents auparavant.
• Workflow d'injection d'environnement : ctg env injecte les secrets déchiffrés comme variables d'environnement pour exécuter une commande, sans les écrire sur le disque.
• Pipe sécurisé de secrets : ctg cat PATH déchiffre en mémoire et affiche sur stdout pour un pipe direct vers stdin d'autres outils.
• Nettoyage : ctg clean supprime tous les secrets déchiffrés du dépôt local pour vous permettre d'exécuter vos agents IA avec un peu moins d'inquiétude.
• Prend en charge jj et les répertoires non-git : ctg init transforme n'importe quel répertoire en coffre de secrets.
• Synchronisation avec n'importe quel fournisseur : Vous permet de configurer n'importe quel fournisseur disposant d'une API comme upstream, et d'utiliser ctg pull/diff/push comme git pull/diff/push.
• Synchronisation avec n'importe quel appareil : Les secrets chiffrés avec cottage et gérés dans un dépôt git peuvent être synchronisés entre appareils avec Cottage Sync.

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

Également disponible sous forme d'images docker :

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

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

Ou téléchargez la dernière version depuis GitHub.

Intégrations d'éditeurs

Extension VS Code

Utilisez l'extension Cottage VS Code pour installer ctg, ajouter des hooks de sécurité Copilot, chiffrer des fichiers depuis l'Explorateur et ouvrir les fichiers .cott.age via le workflow de l'éditeur.

Installez-la depuis le Visual Studio Marketplace, ou compilez et installez-la localement depuis vscode-plugin-cottage.

Extension Cursor et Eclipse

Téléchargez le fichier VSX et installez-le dans votre IDE Cursor ou Eclipse. Il fonctionne de manière similaire à l'extension VS Code.

Plugin Vim

Utilisez le plugin cottage.vim pour chiffrer/déchiffrer des secrets depuis Vim ou Neovim.

Intégrations d'agents IA