Guide utilisateur

Guide de démarrage utilisateur

Pré-requis:

D'abord il faut installer nodejs sur votre machine et utiliser ensuite le framework coporal pour faire tourner le projet. Il faut aussi obligatoirement installer le readline-sync, c'est ce qui permet l'interaction entre l'utilisateur et la console.

• Caporal "npm install caporal"
• readline-sync "npm install readline-sync"

Lancer le programme

Entrer "node caporalCli.js" pour avoir accès à toutes les commandes et leurs utilisations.

**Vérifier un fichier au format vCard **

Elle permet de vérifier la validité du fichier par rapport au format vCard.

La commande :

node caporalCli.js checkvcf < chemin du fichier complet >
**exemple : **
node caporalCli.js checkvcf librairie/data/contact.vcf (ne pas oublier l'extension du fichier en .vcf)

** Vérifier un fichier au format Baseprospect (un fichier texte .txt) **

Elle permet de vérifier la validité du fichier par rapport au format Bp.

La commande :

node caporalCli.js checkbp < chemin du fichier complet >
**exemple : **
node caporalCli.js checkbp librairie/data/contact.txt (ne pas oublier l'extension du fichier en.txt)

**Afficher le journal **

Elle permet d'afficher sur la console les opérations commises avec le programme.

La commande :

node caporalCli.js journal
**exemple : **
node caporalCli.js journal
(pas besoin de spécifier le chemin, celui-ci est clairement spécifié dans le code tout comme l'extension)

Générer un fichier filtrer par rapport à un prospect d'un fichier vcf

Elle permet de récupérer les coordonnées d'un contact avec son nom.

La commande :

node caporalCli.js searchvcf < chemin du fichier complet > < texte de la recherche > (ne pas oublier le / s'il y a un espace)
**exemples : **
node caporalCli.js searchvcf librairie/data/contact.vcf Dupont
node caporalCli.js searchvcf librairie/data/contact.vcf Jean/Paul

Générer un fichier filtrer par rapport à un prospect d'un fichier Bp

Elle permet de récupérer les coordonnées d'un contact avec son nom.

La commande :

node caporalCli.js searchbp < chemin du fichier complet > < texte de la recherche > (le caractère / au lieu d'un espace)
**exemples : **
node caporalCli.js searchbp librairie/data/contact.txt Dupont
node caporalCli.js searchbp librairie/data/contact.txt Jean/Paul

Générer un fichier html depuis un fichier vCard

Elle permet d'avoir un rapport de l'ensemble des prospects, lisible avec un navigateur.

La commande :

node caporalCli.js classificationParDomaineVcf < chemin du fichier complet >
**exemple : **
node caporalCli.js classificationParDomaineVcf librairie/data/contact.vcf

Générer un fichier html depuis un fichier Bp

Elle permet d'avoir un rapport de l'ensemble des prospects, lisible avec un navigateur.

La commande :

node caporalCli.js classificationParDomaineBp < chemin du fichier complet >
**exemple : **
node caporalCli.js classificationParDomaineBp librairie/data/contact.txt

Convertir un fichier vCard en Bp

La commande :

node caporalCli.js convertVcf < chemin du fichier complet > < chemin du fichier de sortie >
(par défaut le fichier de sortie se situe dans le dossier librairie/data seul le nom du fichier doit être spécifié, l'extension est elle aussi mise par défaut)
**exemple : **
node caporalCli.js convertVcf librairie/data/contact.vcf nouveauFichierContact
Le traitement de doublon est effectué au moment de l'exécution de cette commande.

Convertir un Bp en fichier vCard

La commande :

node caporalCli.js convertbp < chemin du fichier complet > < chemin du fichier de sortie >
(par défaut le fichier de sortie se situe dans le dossier librairie/data seul le nom du fichier doit être spécifié, l'extension est elle aussi mise par défaut)
**exemple : **
node caporalCli.js convertbp librairie/data/contact.bp nouveauFichierContact
Le traitement de doublon est effectué au moment de l'exécution de cette commande.

Commande Aide

Commande aide pour avoir plus de détails sur les commandes.

La commande :

node caporalCli.js help
**exemple : **
node caporalCli.js help searchbp