Comment utiliser le CLI Papermark ?

Le CLI Papermark est un binaire unique qui exécute toutes les opérations de l'API depuis votre terminal. Utilisez-le pour vous connecter une seule fois, importer des dossiers entiers dans une data room, générer des liens depuis un script, ou intégrer Papermark dans un pipeline CI. Chaque commande prend en charge la sortie --json pour un parsing machine simplifié.

Le CLI Papermark est disponible à partir du plan Business. Les instances Papermark auto-hébergées peuvent utiliser le CLI avec n'importe quel plan.

Étape 1 : Installer le CLI

Le CLI est publié sur npm. Node.js 18 ou une version plus récente est requis.

npm install -g papermark

Vérifiez l'installation :

papermark --version

Étape 2 : Se connecter

Le CLI propose deux méthodes de connexion.

Flux device OAuth 2.1 (recommandé)

papermark login

Le CLI affiche une URL et un code court. Ouvrez l'URL, saisissez le code et approuvez la connexion dans le navigateur. Le token est stocké à l'emplacement ~/.config/papermark/auth.json.

Token longue durée

Si vous utilisez Papermark dans un pipeline CI ou souhaitez des identifiants durables, générez un token dans Paramètres, Tokens API et transmettez-le directement :

papermark login --token pm_live_AbCdEfGhIjKlMnOpQrStUvWxYz

Ou définissez-le comme variable d'environnement :

export PAPERMARK_TOKEN=pm_live_...

Vérifier le compte connecté

papermark whoami

Retourne votre adresse e-mail, votre équipe et les périmètres du token actif.

Commandes courantes

Lister les data rooms et les documents

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

Téléverser un seul fichier

papermark documents upload ./pitch.pdf

Résultat :

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

Téléverser un dossier entier dans une data room

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

Le CLI analyse le dossier, met en file d'attente chaque type de fichier pris en charge et affiche la progression par fichier. La hiérarchie des dossiers est conservée dans la data room.

Créer une data room

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

Générer un lien protégé par mot de passe

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

Consulter les analyses de visualisation

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

Sortie JSON pour les pipelines

Chaque commande prend en charge --json. Redirigez vers jq pour un traitement ultérieur :

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

Ou injectez le résultat dans un autre script :

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'

Conçu pour les environnements CI

Le CLI :

• Retourne des codes de sortie non nuls en cas d'échec
• Émet des codes d'erreur lisibles par les machines en mode JSON
• Fonctionne avec PAPERMARK_TOKEN depuis l'environnement, ce qui vous permet de stocker le token dans votre gestionnaire de secrets CI
• Envoie la progression vers stderr et les résultats JSON vers stdout, afin que vous puissiez capturer les résultats sans perdre les logs

Exemple d'étape 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

Cas d'utilisation

• Publication de packs pour le conseil d'administration : un job CI charge un dossier dans une data room réservée au conseil chaque lundi matin.
• Démarchage d'investisseurs : un script parcourt une liste d'investisseurs, crée un lien par investisseur et enregistre les URLs dans un fichier CSV.
• Sauvegardes locales : un cron nocturne récupère une liste de documents et les données d'analyse des consultations dans votre entrepôt de données.
• Provisionnement de data rooms : déployez une data room basée sur un modèle pour chaque nouvelle opération en une seule commande.

Foire aux questions

Guides associés

• Comment utiliser l'API REST Papermark
• Comment utiliser le serveur MCP Papermark
• Comment créer des webhooks dans Papermark

Besoin d'aide ? Contactez support@papermark.com ou utilisez le chat intégré à l'application.