La CLI Coffrify est un outil en ligne de commande baptisé cof. Elle vous permet de piloter vos transferts de fichiers chiffrés, votre réception de documents (intake), vos coffres (data rooms) et vos webhooks directement depuis le terminal, sans écrire une seule ligne de code. Sous le capot, cof parle exactement à la même API REST v1 que vos applications, avec les mêmes clés et les mêmes scopes. Tout ce que vous pouvez faire en HTTP, vous pouvez le faire en ligne de commande, et inversement.
La CLI est pensée pour deux usages complémentaires. D'abord l'exploration interactive : créer un transfert à la volée, lister vos coffres, inspecter un webhook, sans quitter votre shell. Ensuite l'automatisation : chaque commande peut renvoyer du JSON brut, ce qui en fait une brique idéale pour vos scripts, vos tâches planifiées (cron) et vos pipelines d'intégration continue.
Ce que vous pouvez faire
La commande cof couvre les principales ressources de la plateforme. Chaque domaine fonctionnel correspond à un sous-ensemble de commandes, et chaque action requiert le scope correspondant sur votre clé.
- Transferts : créer un envoi chiffré, lister vos transferts, en consulter le détail ou en supprimer un.
- Réception (intake) : créer un point de réception, suivre les documents qui y sont déposés.
- Coffres (data rooms) : créer un coffre, gérer ses fichiers, dossiers, invités et exporter son contenu.
- Webhooks : enregistrer une URL de notification, lister vos webhooks, en tester la livraison.
- Audit et analytique : interroger le journal d'audit et consulter vos statistiques d'usage.
Mêmes clés, mêmes scopes que l'API
La CLId s'authentifie avec les mêmes clés API que vos appels HTTP. Une clé cof_live_ agit sur vos données de production, une clé cof_test_ sur votre environnement de test, et une clé cof_sandbox_ sur un bac à sable isolé valable 24 heures, idéal pour expérimenter sans conséquence. Les clés restreintes cof_rk_ limitent les actions autorisées selon les scopes qui leur sont attribués.
Comme pour l'API, chaque commande exige le scope adéquat. Par exemple, créer un transfert nécessite transfers:write, lister vos coffres collections:read, et interroger l'audit le scope correspondant. Si la clé utilisée ne porte pas le bon scope, la commande échoue avec une erreur scope_missing, exactement comme l'appel HTTP équivalent.
| Préfixe de clé | Environnement | Usage typique |
|---|---|---|
| cof_live_ | Production | Vos transferts et coffres réels |
| cof_test_ | Test | Intégration et recette |
| cof_sandbox_ | Bac à sable (24 h) | Expérimentation jetable et isolée |
| cof_rk_ | Restreinte | Scopes limités, automatisation ciblée |
Sortie JSON pour le scripting
Par défaut, cof affiche des résultats lisibles dans le terminal. Pour l'automatisation, ajoutez l'option --json afin d'obtenir la réponse brute de l'API, identique au corps JSON que renverrait l'appel HTTP correspondant. Vous pouvez alors enchaîner la sortie avec un outil comme jq pour extraire précisément les champs dont vous avez besoin.
Dans cet exemple, la commande crée un transfert, renvoie le JSON complet, puis jq en extrait l'URL de partage. Le même JSON contient l'identifiant du transfert, son short_code, son statut et sa date d'expiration, exactement comme la réponse de l'endpoint de création de transfert.
Un aperçu en pratique
Voici quelques commandes représentatives pour vous donner une idée du style de la CLI. Chacune appelle l'endpoint API correspondant, avec les mêmes paramètres.
/v1/transfersEndpoint appelé par cof transfers create pour créer un transfert chiffré et obtenir les URL de téléversement et l'URL de partage.GET/v1/transfersEndpoint appelé par cof transfers list, avec pagination par curseur (limit, cursor, has_more, next_cursor).Chiffrement de bout en bout
Vos données sont hébergées en Union européenne et chiffrées côté serveur par défaut. Pour les usages les plus sensibles, le mode de chiffrement de bout en bout (zero-knowledge) garde la clé chez vous : le serveur ne peut alors pas lire le contenu. La CLI s'appuie sur les mêmes garanties que l'API et n'expose aucun mécanisme interne, vous manipulez uniquement vos fichiers et vos métadonnées.
Installation et référence
Pour démarrer, installez la CLI puis configurez votre clé API afin que cof sache à quel espace et à quel environnement s'adresser. La référence détaille ensuite chaque commande, ses options et sa sortie JSON. Comme la CLI reflète l'API à l'identique, la documentation de référence de l'API REST v1 reste votre source la plus complète sur les paramètres acceptés et les champs renvoyés.