Erste Schritte mit der FlipLink CLI

Wenn du im Terminal zu Hause bist, fühlt sich das Klicken durch ein Dashboard zum Veröffentlichen eines Flipbooks wie ein Umweg an. Mit der FlipLink CLI erledigst du das Ganze — erstellen, veröffentlichen und teilen — ohne deine Shell zu verlassen. Sie ist ein schlanker, skriptfähiger Wrapper über die FlipLink API: Alles, was du mit einer HTTP-Anfrage tun kannst, geht auch mit einem einzigen Befehl.

Diese Anleitung bringt dich in etwa fünf Minuten von null zu einem veröffentlichten, teilbaren Flipbook. Am Ende hast du die CLI installiert, dich authentifiziert und erzeugst direkt aus einem PDF eine öffentliche URL.

Die CLI installieren

Die CLI wird als npm-Paket ausgeliefert und benötigt Node.js 18 oder neuer. Installiere sie global, damit der Befehl fliplink überall verfügbar ist:

npm install -g fliplink-cli

Lieber nichts dauerhaft installieren? Du kannst jeden Befehl bei Bedarf mit npx ausführen:

npx fliplink-cli whoami

So oder so steht dir derselbe Befehlsumfang zur Verfügung. Der Rest dieser Anleitung geht von einer globalen Installation aus.

Deinen API-Schlüssel setzen

Jeder Befehl authentifiziert sich mit deinem FlipLink-API-Schlüssel. Du bekommst einen, indem du dich unter https://go.fliplink.me anmeldest und die Seite Abonnement öffnest.

Speichere den Schlüssel einmal, und die CLI merkt ihn sich:

fliplink config set-key YOUR_API_KEY

Das schreibt den Schlüssel mit 600-Berechtigungen nach ~/.config/fliplink/config.json, sodass nur dein Benutzer ihn lesen kann. Für CI/CD oder Skripte, bei denen du lieber keine Konfigurationsdatei schreibst, setzt du stattdessen eine Umgebungsvariable:

export FLIPLINK_API_KEY=YOUR_API_KEY

Die CLI löst die Anmeldedaten in dieser Reihenfolge auf: zuerst die Umgebungsvariable FLIPLINK_API_KEY, dann die Konfigurationsdatei. Behandle den Schlüssel wie ein Passwort — committe ihn niemals in ein Repository. Wenn du den tieferen Hintergrund zu dieser Header-basierten Authentifizierung verstehen möchtest, ist der API-Glossareintrag eine gute Einführung.

Bestätigen, dass du verbunden bist

Führe als Erstes einen schnellen Health-Check durch. whoami ruft den Endpunkt zur Konto-Identität auf und bestätigt, dass dein Schlüssel funktioniert:

fliplink whoami

Eine erfolgreiche Antwort gibt deine Kontodetails aus (und deine maximale Upload-Größe). Wenn du einen Authentifizierungsfehler siehst, fehlt dein Schlüssel oder ist falsch — führe config set-key erneut aus und versuche es noch einmal. Das ist derselbe erste Aufruf, den wir für die API selbst empfehlen, also ist es ein zuverlässiger Smoke-Test.

Ein Flipbook aus einem PDF erstellen

Jetzt der spannende Teil. Richte die CLI auf ein lokales PDF und gib ihm einen Titel:

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

--title ist das, was die Leser sehen, und --name ist eine interne Bezeichnung, mit der du es später wiederfindest. Der Befehl lädt die Datei hoch, startet die Konvertierung und gibt die ID des neuen Flipbooks zurück. Merke dir diese ID — du brauchst sie für die nächsten beiden Schritte.

Hast du das PDF schon irgendwo gehostet? Überspringe den Upload und erstelle stattdessen aus einer URL:

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

🚀

FlipLink kostenlos testen

Wandle dein PDF in Sekunden um. Keine Anmeldung, keine Kreditkarte — einfach hochladen und loslegen.

Drop your PDF here or click to browse

Max. 40 MB

Bezahlte Tarife ab $39 erhöhen das auf 150 MB.

Veröffentlichen und teilen

Ein frisch erstelltes Flipbook ist erst öffentlich, wenn du es veröffentlichst. Hier ist die vollständige Abfolge — erstellen, veröffentlichen und dann den Teilen-Link abrufen — unter Verwendung der bei jedem Schritt zurückgegebenen ID:

# 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 schaltet das Flipbook live; share-link gibt die URL zurück, die du an die Leser weitergibst. Anders überlegt? fliplink flipbook unpublish 90001 nimmt es wieder offline, ohne etwas zu löschen.

Maschinenlesbare Ausgabe mit --json

Standardmäßig gibt die CLI eine benutzerfreundliche Ausgabe aus. Füge --json zu einem beliebigen Befehl hinzu, um stattdessen die rohe JSON-Antwort zu erhalten — perfekt, um sie in jq zu pipen oder in einem Skript einen Wert zu erfassen:

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

Dieser Einzeiler erstellt ein Flipbook und gibt nichts als seine ID aus, bereit zur Weitergabe an den nächsten Befehl. Das ist die Grundlage jeder Automatisierung, die du aufbaust — siehe Automatisierung und Integrationen für das, wohin es führt.

Exit-Codes für Skripte

Die CLI verwendet vorhersehbare Exit-Codes, damit deine Skripte bei Erfolg oder Fehler verzweigen können, ohne die Ausgabe zu parsen:

Diese Trennung ist wichtig: Eine 2 bedeutet, dass deine Anfrage FlipLink erreicht hat, aber aus einem fachlichen Grund abgelehnt wurde (ungültige Eingabe, Kontingent überschritten), während eine 1 bedeutet, dass die Anfrage selbst fehlgeschlagen ist. In einem Shell-Skript kannst du entsprechend reagieren:

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

Wie es weitergeht

Du hast jetzt die Kernschleife: installieren, authentifizieren, erstellen, veröffentlichen, teilen. Von hier aus kannst du die CLI in alles einbinden, was Befehle ausführt.

• Vollständige Befehlsreferenz — jedes Flag und jeder Unterbefehl steht in den CLI-Docs.
• Automatisiere es — führe dieselbe Abfolge nach einem Zeitplan oder pro Commit aus. Unsere Anleitung zum Automatisieren der Flipbook-Veröffentlichung in CI/CD zeigt eine echte Pipeline.
• Brauchst du rohe API-Power? — die CLI umhüllt die API-Referenz, und der Befehl fliplink api als Notausgang erreicht jeden Endpunkt, den die benannten Befehle noch nicht abdecken.

Sobald du dein erstes Flipbook aus dem Terminal veröffentlicht hast, fühlt sich das Dashboard optional an — und genau das ist der Sinn.

Weiterführende Lektüre

• FlipLink CLI-Dokumentation — die vollständige Befehlsreferenz
• CLI vs. API vs. MCP: Welche solltest du verwenden?
• Flipbook-Veröffentlichung in CI/CD automatisieren
• So nutzt du die FlipLink API für individuelle Integrationen
• Automatisierung und Integrationen
• Was ist eine API? (Glossar)