Premiers pas avec le CLI FlipLink

Si tu vis dans le terminal, cliquer dans un tableau de bord pour publier un flipbook ressemble à un détour. Le CLI FlipLink te permet de tout faire — créer, publier et partager — sans quitter ton shell. C'est un wrapper léger et scriptable au-dessus de l'API FlipLink : tout ce que tu peux faire avec une requête HTTP, tu peux le faire avec une seule commande.

Ce guide te mène de zéro à un flipbook publié et partageable en cinq minutes environ. À la fin, tu auras le CLI installé, authentifié et capable de produire une URL publique directement à partir d'un PDF.

Installer le CLI

Le CLI est distribué sous forme de paquet npm et nécessite Node.js 18 ou une version plus récente. Installe-le globalement pour que la commande fliplink soit disponible partout :

npm install -g fliplink-cli

Tu préfères ne rien installer de permanent ? Tu peux lancer n'importe quelle commande à la demande avec npx :

npx fliplink-cli whoami

Dans les deux cas, la même surface de commandes est disponible. La suite de ce guide suppose une installation globale.

Définir ta clé API

Chaque commande s'authentifie avec ta clé API FlipLink. Récupères-en une en te connectant sur https://go.fliplink.me et en ouvrant la page Abonnement.

Enregistre la clé une fois et le CLI la mémorise :

fliplink config set-key YOUR_API_KEY

Cette commande écrit la clé dans ~/.config/fliplink/config.json avec les permissions 600, afin que seul ton utilisateur puisse la lire. Pour les pipelines CI/CD ou les scripts où tu préfères ne pas écrire de fichier de configuration, définis plutôt une variable d'environnement :

export FLIPLINK_API_KEY=YOUR_API_KEY

Le CLI résout les identifiants dans cet ordre : d'abord la variable d'environnement FLIPLINK_API_KEY, puis le fichier de configuration. Traite la clé comme un mot de passe — ne la commite jamais dans un dépôt. Si tu veux comprendre en profondeur le fonctionnement de cette authentification basée sur un en-tête, l'entrée du glossaire sur l'API constitue une bonne introduction.

Vérifier que tu es connecté

Avant de faire quoi que ce soit d'autre, lance une vérification rapide. whoami appelle l'endpoint d'identité du compte et confirme que ta clé fonctionne :

fliplink whoami

Une réponse réussie affiche les détails de ton compte (ainsi que ta taille de téléversement maximale). Si tu vois une erreur d'authentification, ta clé est manquante ou incorrecte — relance config set-key et réessaie. C'est le même premier appel que nous recommandons pour l'API elle-même, c'est donc un test de bon fonctionnement fiable.

Créer un flipbook à partir d'un PDF

On passe maintenant à la partie la plus intéressante. Pointe le CLI vers un PDF local et donne-lui un titre :

fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3

--title est ce que voient les lecteurs, et --name est un libellé interne que tu utiliseras pour le retrouver plus tard. La commande téléverse le fichier, lance la conversion et renvoie l'ID du nouveau flipbook. Note cet ID — tu l'utiliseras pour les deux étapes suivantes.

Tu as déjà le PDF hébergé quelque part ? Saute le téléversement et crée le flipbook à partir d'une URL :

fliplink flipbook create-url https://example.com/deck.pdf --title "Q3 Report"

🚀

Essaie FlipLink gratuitement

Convertis ton PDF en quelques secondes. Sans inscription, sans carte bancaire — il suffit de téléverser.

Drop your PDF here or click to browse

Max 40 Mo

Les forfaits payants à partir de $39 font passer cette limite à 150 MB.

Publier et partager

Un flipbook tout juste créé n'est pas public tant que tu ne l'as pas publié. Voici la séquence complète — créer, publier, puis récupérer le lien de partage — en utilisant l'ID renvoyé à chaque étape :

# 1. Create from a PDF and note the returned ID
fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3

# 2. Publish it (use the ID from step 1)
fliplink flipbook publish 90001

# 3. Get the public share link
fliplink flipbook share-link 90001

publish met le flipbook en ligne ; share-link renvoie l'URL que tu transmets aux lecteurs. Tu as changé d'avis ? fliplink flipbook unpublish 90001 le remet hors ligne sans rien supprimer.

Sortie exploitable par une machine avec --json

Par défaut, le CLI affiche une sortie lisible par un humain. Ajoute --json à n'importe quelle commande pour obtenir la réponse JSON brute à la place — parfait pour la rediriger vers jq ou capturer une valeur dans un script :

fliplink flipbook create ./deck.pdf --title "Q3 Report" --json | jq -r '.ID'

Ce one-liner crée un flipbook et n'affiche rien d'autre que son ID, prêt à être transmis à la commande suivante. C'est le socle de toute automatisation que tu construiras — consulte Automatisation et intégrations pour voir où cela mène.

Codes de sortie pour le scripting

Le CLI utilise des codes de sortie prévisibles pour que tes scripts puissent bifurquer selon la réussite ou l'échec sans analyser la sortie :

Cette distinction compte : un 2 signifie que ta requête a atteint FlipLink mais a été rejetée pour une raison métier (entrée invalide, quota dépassé), tandis qu'un 1 signifie que la requête elle-même a échoué. Dans un script shell, tu peux réagir en conséquence :

fliplink flipbook publish 90001 || echo "Publish failed with exit code $?"

Où aller ensuite

Tu disposes maintenant de la boucle essentielle : installer, authentifier, créer, publier, partager. À partir de là, tu peux brancher le CLI sur tout ce qui exécute des commandes.

• Référence complète des commandes — chaque option et sous-commande se trouve dans la documentation du CLI.
• Automatise-le — lance la même séquence selon un calendrier ou à chaque commit. Notre guide pour automatiser la publication de flipbooks en CI/CD détaille un véritable pipeline.
• Besoin de toute la puissance de l'API ? — le CLI englobe la référence de l'API, et l'échappatoire fliplink api atteint n'importe quel endpoint que les commandes nommées ne couvrent pas encore.

Une fois que tu auras publié ton premier flipbook depuis le terminal, le tableau de bord commencera à paraître optionnel — ce qui est précisément le but.

Lectures complémentaires

• Documentation du CLI FlipLink — la référence complète des commandes
• CLI, API ou MCP : lequel devrais-tu utiliser ?
• Automatiser la publication de flipbooks en CI/CD
• Comment utiliser l'API FlipLink pour des intégrations personnalisées
• Automatisation et intégrations
• Qu'est-ce qu'une API ? (glossaire)