La CLI Coffrify met toute l'API REST v1 à portée de votre terminal. L'exécutable s'appelle cof, le paquet est publié sous @coffrify/cli, et chaque commande parle aux mêmes endpoints que l'API avec les mêmes clés. Cette page vous guide pour installer cof, l'authentifier avec une clé API, choisir l'environnement (test ou production), savoir où la configuration est stockée, puis lancer une première commande de vérification.
Installer la CLI
Trois canaux d'installation sont disponibles. Choisissez celui qui correspond à votre poste : Homebrew sur macOS et Linux, le script shell pour une installation autonome, ou npm si vous avez déjà Node.js. Tous installent le même exécutable cof.
Une fois l'installation terminée, vérifiez que l'exécutable répond et notez la version installée. La sortie indique le paquet et son numéro de version.
Obtenir une clé API
L'authentification repose sur une clé API, exactement comme pour les appels REST. Créez votre clé depuis la console développeur, puis copiez-la immédiatement : elle n'est affichée qu'une seule fois. Le préfixe de la clé indique l'environnement auquel elle donne accès.
| Préfixe | Environnement | Usage |
|---|---|---|
cof_test_ | Test | Données de test isolées, idéal pour développer et valider une intégration. |
cof_live_ | Production | Données réelles, transferts et coffres facturés. |
cof_sandbox_ | Sandbox | Bac à sable isolé et éphémère (24 h), réinitialisé automatiquement. |
Authentifier la CLI
Deux manières de fournir votre clé à cof. La plus simple consiste à l'enregistrer une fois dans la configuration locale avec cof config. La CLI réutilisera ensuite cette clé pour chaque commande, sans que vous ayez à la répéter.
Pour les environnements automatisés (intégration continue, conteneurs, scripts), préférez la variable d'environnement COFFRIFY_API_KEY. Quand elle est définie, la CLI l'utilise et vous n'écrivez aucune clé sur le disque. Elle a priorité sur la valeur enregistrée par cof config.
Choisir l'environnement
L'environnement n'est pas un réglage séparé : il est porté par la clé. Une clé cof_test_ agit sur l'espace de test, une clé cof_live_ sur la production, une clé cof_sandbox_ sur le bac à sable. Pour changer d'environnement, changez simplement de clé. Si vous travaillez sur plusieurs espaces, vous pouvez aussi fixer l'espace de travail visé dans la configuration.
Où est stockée la configuration
Les valeurs enregistrées par cof config (clé API, espace de travail) sont conservées dans un fichier de configuration local au compte utilisateur, lisible par lui seul. Si la variable COFFRIFY_API_KEY est présente dans l'environnement, elle l'emporte sur la valeur du fichier : pratique pour surcharger ponctuellement la clé sans toucher à votre configuration permanente.
Vérifier la connexion
Une fois la clé en place, confirmez que la CLI atteint bien l'API en listant vos transferts. Si l'authentification est correcte, vous obtenez une réponse (vide tant qu'aucun transfert n'existe) plutôt qu'une erreur.
Votre CLI est maintenant installée et authentifiée. Vous pouvez créer un transfert chiffré, ouvrir un coffre ou interroger le journal d'audit, le tout depuis votre terminal, en restant sur l'environnement de test tant que vous validez votre intégration.