Wie verwendet man die Papermark CLI?

Die Papermark CLI ist eine einzelne Binärdatei, die alle API-Operationen aus deinem Terminal ausführt. Nutze sie, um dich einmalig anzumelden, ganze Ordner in einen Datenraum hochzuladen, Links per Skript zu erstellen oder Papermark in eine CI-Pipeline zu integrieren. Jeder Befehl unterstützt die --json-Ausgabe für eine saubere maschinelle Verarbeitung.

Die Papermark CLI ist ab dem Business-Plan verfügbar. Selbst gehostete Papermark-Instanzen können die CLI mit jedem Plan nutzen.

Schritt 1: CLI installieren

Die CLI wird über npm veröffentlicht. Du benötigst Node.js 18 oder neuer.

npm install -g papermark

Installation überprüfen:

papermark --version

Schritt 2: Anmelden

Die CLI unterstützt zwei Anmeldemethoden.

OAuth 2.1 Device-Flow (empfohlen)

papermark login

Die CLI gibt eine URL und einen kurzen Code aus. Öffne die URL, gib den Code ein und bestätige die Anmeldung im Browser. Das Token wird unter ~/.config/papermark/auth.json gespeichert.

Langlebiges Token

Wenn du Papermark in einer CI-Umgebung skriptest oder ein langlebiges Zugangsdaten benötigst, generiere ein Token unter Einstellungen, API-Tokens und übergib es direkt:

papermark login --token pm_live_AbCdEfGhIjKlMnOpQrStUvWxYz

Oder lege es als Umgebungsvariable fest:

export PAPERMARK_TOKEN=pm_live_...

Angemeldeten Benutzer prüfen

papermark whoami

Gibt deine E-Mail-Adresse, dein Team und die aktiven Token-Berechtigungen zurück.

Häufige Befehle

Datenräume und Dokumente auflisten

papermark datarooms list --json
papermark documents list --json
papermark documents list --dataroom dr_3qpL

Eine einzelne Datei hochladen

papermark documents upload ./pitch.pdf

Ausgabe:

▸ uploading pitch.pdf (2.1 MB) ok
✓ doc_pitch_v5 created

Einen ganzen Ordner in einen Datenraum hochladen

papermark documents upload ./diligence/ \
  --dataroom dr_3qpL --recursive

Die CLI durchsucht den Ordner, stellt alle unterstützten Dateitypen in die Warteschlange und zeigt den Fortschritt pro Datei an. Die Ordnerhierarchie wird im Datenraum beibehalten.

Einen Datenraum erstellen

papermark datarooms create --name "Series B" --json

Einen passwortgeschützten Link erstellen

papermark links create --dataroom dr_8K2m \
  --password series-b-2026 \
  --expires-at 2026-06-10T00:00:00Z \
  --json

Aufrufsanalysen abrufen

papermark views list --link lk_8K2m --json
papermark views get vw_3m9k --json

JSON-Ausgabe für Pipelines

Jeder Befehl unterstützt --json. Zur weiteren Verarbeitung an jq weiterleiten:

papermark documents list --json | jq '.[] | select(.name | test("Pitch"))'

Oder die Ausgabe in ein anderes Skript einlesen:

DR_ID=$(papermark datarooms create --name "Q4 Update" --json | jq -r '.id')
papermark documents upload ./reports/q4/ --dataroom $DR_ID --recursive
papermark links create --dataroom $DR_ID --json | jq -r '.url'

CI-freundlich by Design

Die CLI:

• Gibt bei Fehlern einen Exit-Code ungleich null zurück
• Gibt maschinenlesbare Fehlercodes im JSON-Modus aus
• Verwendet PAPERMARK_TOKEN aus der Umgebung, sodass du das Token in deinem CI-Secrets-Manager speichern kannst
• Streamt den Fortschritt nach stderr und JSON-Ergebnisse nach stdout, sodass du Ergebnisse erfassen kannst, ohne Logs zu verlieren

Beispiel-Schritt für GitHub Actions

- name: Upload board pack to Papermark
  env:
    PAPERMARK_TOKEN: ${{ secrets.PAPERMARK_TOKEN }}
  run: |
    papermark documents upload ./board-pack/ \
      --dataroom ${{ vars.BOARD_DATAROOM_ID }} \
      --recursive --json

Anwendungsfälle

• Board-Pack-Veröffentlichung: Ein CI-Job lädt jeden Montag morgen einen Ordner in einen Board-Datenraum hoch.
• Investorenansprache: Ein Skript durchläuft eine Liste von Investoren, erstellt pro Investor einen Link und schreibt die URLs in eine CSV-Datei.
• Lokale Backups: Ein nächtlicher Cron-Job ruft eine Liste von Dokumenten und Aufrufanalysen in dein Data Warehouse ab.
• Datenraum-Bereitstellung: Richte mit einem einzigen Befehl einen vorlagenbasierten Datenraum für jeden neuen Deal ein.

Häufig gestellte Fragen

Verwandte Anleitungen

• So verwendest du die Papermark REST API
• So verwendest du den Papermark MCP-Server
• So erstellst du Webhooks in Papermark

Brauchst du Hilfe? Kontaktiere support@papermark.com oder nutze den In-App-Chat.