Wie installiere ich die FlipLink CLI?

Führe npm install -g fliplink-cli aus (erfordert Node.js 18+) oder nutze sie ohne Installation über npx fliplink-cli whoami.

Wie authentifiziere ich mich in CI?

Übergib deinen Schlüssel als Umgebungsvariable FLIPLINK_API_KEY – zum Beispiel FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Er wird niemals auf die Festplatte geschrieben. Lokal kannst du ihn einmalig mit fliplink config set-key speichern.

Was ist die API-Notlösung (escape hatch)?

Jeder Endpunkt, der noch nicht in einen praktischen Befehl gekapselt ist, lässt sich direkt mit fliplink api erreichen, sodass die CLI vom ersten Tag an die gesamte REST API abdeckt.

Kann ich die CLI skripten?

Ja. Jeder Befehl gibt standardmäßig eine Tabelle aus und mit --json rohes JSON (das du an jq weiterleiten kannst). Die Exit-Codes sind skriptbar: 0 Erfolg, 1 Anfrage-/HTTP-Fehler, 2 Anwendungsfehler (Result: ERROR).

Wie viele Befehle gibt es?

87 Befehle in 9 Gruppen (flipbook, profile, account, folder, cname, team, leads, sales, lookup), generiert aus derselben API-Spezifikation wie die REST API, sodass die CLI nicht von den dokumentierten Endpunkten abweichen kann.

Befehlszeile

FlipLink CLI

Erstelle, konfiguriere, veröffentliche und verwalte deine Flipbooks aus dem Terminal oder CI — ein schlanker, skriptfähiger Wrapper über die FlipLink REST-API.

Jetzt starten REST-API ansehen

Installation über npm · 87 Befehle · JSON-Ausgabe zum Skripten

Installation

Terminal

npm install -g fliplink-cli
# or run without installing:
npx fliplink-cli whoami

Benötigt Node.js 18 oder neuer.

Authentifizieren

Hol dir einen API-Schlüssel aus deinem FlipLink-Dashboard → Abo und speichere ihn dann:

Einrichtung

fliplink config set-key YOUR_API_KEY
fliplink whoami

Oder übergib ihn pro Aufruf (praktisch in CI — wird nie auf die Festplatte geschrieben):

FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook list

Auflösungsreihenfolge für jede Einstellung: Umgebungsvariable → Konfigurationsdatei → eingebauter Standard. Der gespeicherte Schlüssel liegt in ~/.config/fliplink/config.json mit chmod 600-Berechtigungen.

Häufige Befehle

Terminal

fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3
fliplink flipbook create-url https://example.com/deck.pdf --title "Q3 Report"
fliplink flipbook list --search report --page-size 25 --sort-by CreatedOn
fliplink flipbook get <flipbookId>
fliplink flipbook publish <flipbookId>
fliplink flipbook unpublish <flipbookId>
fliplink flipbook set-expiry <flipbookId> --days 30
fliplink flipbook share-link <flipbookId>
fliplink flipbook delete <flipbookId>
fliplink leads list --item <flipbookId> --download true

Führe fliplink <command> --help aus, um die Flags eines beliebigen Befehls zu sehen.

Alle Befehlsgruppen

Jeder Endpunkt ist als benannter Befehl erreichbar. Führe fliplink <group> --help aus, um die Befehle einer Gruppe aufzulisten.

Gruppe	Deckt ab
flipbook	erstellen / lesen / ändern / löschen + alle Einstellungen pro Flipbook (Skin, CTAs, Lead-Erfassung, Zugriff, Teilen, Verkauf, Tracking, …)
profile	get, set
account	Abo, Zahlungen
folder	list
cname	add, list, delete (eigene Domains)
team	list, get, set, set-active, delete
leads	list, delete, delete-bulk
sales	list
lookup	Vorlagen, Skins, Währungen, Hintergrundmusik

Google-Sheets-Endpunkte nutzen eine andere Basis-URL und sind nur über die api-Schnittstelle erreichbar.

Skripten

Jeder Befehl gibt standardmäßig eine menschenlesbare Tabelle aus und mit --json reines JSON:

Terminal

fliplink flipbook list --json | jq '.[].ID'

Exit-Codes: 0 Erfolg · 1 Anfrage-/HTTP-Fehler · 2 Anwendungsfehler (Result: ERROR).

Shell-Vervollständigung

Generiere ein Vervollständigungs-Skript für deine Shell:

Terminal

source <(fliplink completion zsh)    # add to ~/.zshrc
source <(fliplink completion bash)   # add to ~/.bashrc

Schnittstelle — jeder Endpunkt, sofort

Jeder Endpunkt, der noch nicht in einen freundlichen Befehl verpackt ist, ist direkt erreichbar:

Terminal

fliplink api GET  /api/list-folders
fliplink api PUT  /api/set-skin/<flipbookId> --data '{"SkinName":"Modern"}'
fliplink api POST /api/create-by-file --file File=./deck.pdf -q Name=deck

Durchsuche alle Endpoints, ihre Parameter und Antworten in der vollständigen REST-API-Referenz.

So funktioniert's

Die Befehlsoberfläche wird aus der API-Spezifikation generiert — derselben endpoints.json, die auch die REST-API-Doku speist — sodass die CLI nicht von der dokumentierten API abweichen kann. Lieber natürliche Sprache? Dieselbe API ist auch als MCP-Server für KI-Assistenten verfügbar.

Häufige Fragen

Wie installiere ich die FlipLink CLI?: Führe npm install -g fliplink-cli aus (erfordert Node.js 18+) oder nutze sie ohne Installation über npx fliplink-cli whoami.
Wie authentifiziere ich mich in CI?: Übergib deinen Schlüssel als Umgebungsvariable FLIPLINK_API_KEY – zum Beispiel FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Er wird niemals auf die Festplatte geschrieben. Lokal kannst du ihn einmalig mit fliplink config set-key speichern.
Was ist die API-Notlösung (escape hatch)?: Jeder Endpunkt, der noch nicht in einen praktischen Befehl gekapselt ist, lässt sich direkt mit fliplink api <METHOD> <path> erreichen, sodass die CLI vom ersten Tag an die gesamte REST API abdeckt.
Kann ich die CLI skripten?: Ja. Jeder Befehl gibt standardmäßig eine Tabelle aus und mit --json rohes JSON (das du an jq weiterleiten kannst). Die Exit-Codes sind skriptbar: 0 Erfolg, 1 Anfrage-/HTTP-Fehler, 2 Anwendungsfehler (Result: ERROR).
Wie viele Befehle gibt es?: 87 Befehle in 9 Gruppen (flipbook, profile, account, folder, cname, team, leads, sales, lookup), generiert aus derselben API-Spezifikation wie die REST API, sodass die CLI nicht von den dokumentierten Endpunkten abweichen kann.

Weiterbauen

REST-API-ReferenzDie vollständige Endpunkt-Referenz, die die CLI kapselt.MCP-ServerSteuere FlipLink über einen KI-Assistenten in natürlicher Sprache.Automatisierung & IntegrationenVerbinde FlipLink mit deinem Stack – Webhooks, Zapier, Sheets.Erste Schritte mit der CLIInstalliere die CLI, melde dich an und veröffentliche dein erstes Flipbook direkt im Terminal.