CLI

Cet outil CLI est une excellente solution pour les développeurs qui souhaitent créer des templates PDFMonkey en utilisant leur propre éditeur de code et leur environnement de développement local.

Installation

Le CLI PDFMonkey peut être installé via npm.

npm install -g @pdfmonkey/cli

Une fois installé, la commande pdfmonkey sera disponible dans votre terminal.

Aide

Pour obtenir la liste des commandes disponibles et l’aide générale, exécutez la commande suivante :

pdfmonkey help

Authentification

Il existe deux façons de s’authentifier avec le CLI PDFMonkey :

1. Toutes les commandes acceptent l’option -k ou --api-key pour spécifier une clé API.
2. Vous pouvez également définir la variable d’environnement PDFMONKEY_API_KEY.

Init

Pour commencer à éditer un template PDFMonkey, exécutez la commande suivante :

pdfmonkey init <template-id>

Vous serez ensuite invité à choisir le répertoire de destination pour les fichiers du template. Vous pouvez également spécifier le dossier de destination comme second argument.

pdfmonkey init <template-id> <dossier-destination>

pdfmonkey init <template-id> -e

Watch

Pour surveiller un dossier de template et synchroniser les modifications vers PDFMonkey, exécutez la commande suivante :

pdfmonkey watch -t <template-id>

Cela commencera à surveiller les fichiers dans le dossier courant et synchronisera automatiquement.

Pour surveiller un dossier différent, passez simplement le chemin comme premier argument :

pdfmonkey watch <chemin> -t <template-id>

pwd
/Users/pdfmonkey/templates/B1001CF2-53FC-4DC6-B51D-36B358743752

pdfmonkey watch
# Surveille le dossier courant et synchronise le template correspondant

Aperçu

La commande watch démarrera un serveur local pour prévisualiser le template. L’aperçu se rafraîchira automatiquement lorsque les modifications seront synchronisées.

Vous pouvez ouvrir l’aperçu lorsque le serveur est en cours d’exécution en utilisant l’option -o ou --open-browser.

pdfmonkey watch -o

Par défaut, le serveur d’aperçu fonctionne sur le port 2081 et le serveur de rechargement automatique sur le port 2082. Vous pouvez spécifier des ports différents en utilisant les options -p/--port et -l/--livereload-port.

pdfmonkey watch -p 2083 -l 2084

Vous pouvez également définir les variables d’environnement PORT et LIVE_RELOAD_PORT pour personnaliser les ports.

PORT=2083 LIVE_RELOAD_PORT=2084 pdfmonkey watch

Aperçu de débogage

Parfois, il peut être plus facile de déboguer le HTML généré plutôt que le PDF. Vous pouvez le faire en utilisant l’option -D ou --debug.

pdfmonkey watch -D -o

Cela ouvrira l’aperçu de débogage dans votre navigateur par défaut.

Gestion des conflits

Au lancement de la commande watch, le CLI vérifiera s’il y a des conflits entre les fichiers locaux et les données du template. S’il y en a, vous serez invité à choisir entre :

1. Écraser les fichiers locaux avec les données du template.
2. Garder les fichiers locaux et remplacer les données du template lors de la prochaine synchronisation.
3. Voir un diff des modifications.

Par défaut, l’outil de diff utilisé est diff -u et le patch est affiché avec le pager less. Vous pouvez spécifier un outil de diff et un pager différents en utilisant les variables d’environnement DIFF et PAGER, respectivement.

DIFF=delta PAGER=delta pdfmonkey watch

Configuration

Voici un résumé des variables d’environnement qui peuvent être définies pour personnaliser le comportement du CLI :

• PDFMONKEY_API_KEY : La clé API à utiliser pour l’authentification.
• DIFF : L’outil de diff à utiliser.
• PAGER : Le pager à utiliser pour afficher les diffs.
• PORT : Le port sur lequel exécuter le serveur d’aperçu.
• LIVE_RELOAD_PORT : Le port sur lequel exécuter le serveur de rechargement automatique.