Comment utiliser l'application CLI

L'outil CLI d'ayming IP Secure, disponible sur npm, permet une interaction directe avec les fonctionnalités d'IP Secure depuis le terminal. Rapide et facile à installer, cet outil offre une manière efficace d'effectuer des opérations telles que le hachage de fichiers, l'obtention de certificats, et la création de projets directement depuis votre ligne de commande.

Commandes Local

Pour hacher un fichier ou un répertoire avec sha512, utilisez : (si aucune valeur n'est spécifiée, hache le répertoire courant)

ipsecure hash [options] [valeur]

Pour obtenir un certificat de contribution avec l'identifiant de la contribution, utilisez :

ipsecure certificate [options] [valeur]

Pour créer un projet sur la plateforme, de manière à ce que le projet soit créé avec l'utilisateur actuel comme propriétaire, utilisez :

ipsecure create-project [options]

Ajouter ses clés d'API dans l'environnement

La configuration des clés pour IPsecure peut se faire soit par l'environnement, en définissant les variables suivantes, soit directement via les paramètres d'options mentionnés dans la documentation. Pour configurer via l'environnement, mettez à jour les variables IP_SECURE_PRIVATE_KEY , IP_SECURE_API_KEY , et IP_SECURE_PROJECT_ID avec vos informations. Par exemple :

Sur Linux/MacOS :

export IP_SECURE_PRIVATE_KEY="votre_clé_privée"

export IP_SECURE_API_KEY="votre_clé_api"

export IP_SECURE_PROJECT_ID="votre_id_projet"

Sur Windows :

set IP_SECURE_PRIVATE_KEY=votre_clé_privé

set IP_SECURE_API_KEY=votre_clé_api

set IP_SECURE_PROJECT_ID=votre_id_projet

Ces configurations permettent une utilisation plus fluide de l'outil CLI en évitant la répétition des paramètres pour chaque commande.

Options communes

Options disponibles :

• -i, --identifier <identifiant> : Identifiant priver du client ou adresse e-mail sur IP-Secure.
• -p, --private-key <cléPrivée> : Clé privée d'api.
• -k, --api-key <cléAPI> : Clé API utilisée.
• -p, --project-id <idProjet> : Identifiant du projet utilisé pour signer le certificat.
• --title <titre> : Titre de la contribution.
• -d, --description <description> : Description de la contribution ou du produit.
• -t, --tags <tags> : Tags de la contribution (séparés par des virgules).

Exemple d'utilisation pour hacher un fichier ou un répertoire spécifique en utilisant les options appropriées :

ipsecure hash --identifier utilisateur@example.com --private-key maClePrivee --api-key maCleAPI --project-id monProjetId --title "Mon Titre" --description "Ma description" --tags "tag1,tag2" [valeur]

Cela permettra de hacher le fichier ou le répertoire spécifié avec sha512, tout en utilisant les informations fournies pour signer le certificat associé à cette opération.

Commandes GIT

Vous pouvez ajouter l'option -s pour le synchroniser avec IP Secure et créer un certificat dans la blockchain.

Pour hacher un commit, utilisez : (prend un commit en argument, par défaut c'est HEAD). Si l'option -f est spécifiée, cela hachera également les fichiers modifiés dans le commit.

ipsecure hash-commit [commit]

Pour hacher un merge, utilisez : (prend un commit en argument, par défaut c'est HEAD) Si l'option -f est spécifiée, cela hachera également les fichiers modifiés dans le merge.

ipsecure hash-merge [commit]

Pour hacher un dépôt, utilisez : (prend un commit en argument, par défaut c'est HEAD)

ipsecure hash-repo [commit]