¿Cómo usar el CLI de Papermark?

El CLI de Papermark es un único binario que ejecuta todas las operaciones de la API desde tu terminal. Úsalo para iniciar sesión una sola vez, subir carpetas completas a una sala de datos, generar enlaces desde un script o integrar Papermark en un pipeline de CI. Cada comando admite la salida --json para un procesamiento limpio por máquinas.

El CLI de Papermark está disponible en el plan Business y superiores. Las instancias de Papermark autoalojadas pueden usar el CLI en cualquier plan.

Paso 1: Instalar el CLI

El CLI está publicado en npm. Necesitas Node.js 18 o una versión más reciente.

npm install -g papermark

Verifica la instalación:

papermark --version

Paso 2: Iniciar sesión

El CLI admite dos flujos de inicio de sesión.

Flujo de dispositivo OAuth 2.1 (recomendado)

papermark login

El CLI muestra una URL y un código corto. Abre la URL, pega el código y aprueba el inicio de sesión en el navegador. El token se almacena en ~/.config/papermark/auth.json.

Token de larga duración

Si estás ejecutando scripts de Papermark en CI o deseas una credencial de larga duración, genera un token en Configuración, Tokens de API y pásalo directamente:

papermark login --token pm_live_AbCdEfGhIjKlMnOpQrStUvWxYz

O configúralo como variable de entorno:

export PAPERMARK_TOKEN=pm_live_...

Verificar con qué cuenta has iniciado sesión

papermark whoami

Devuelve tu correo electrónico, equipo y los permisos activos del token.

Comandos habituales

Listar data rooms y documentos

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

Subir un único archivo

papermark documents upload ./pitch.pdf

Salida:

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

Subir una carpeta completa a una data room

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

El CLI analiza la carpeta, pone en cola cada tipo de archivo compatible y muestra el progreso por archivo. La jerarquía de carpetas se conserva dentro de la data room.

Crear una data room

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

Generar un enlace protegido con contraseña

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

Consultar analíticas de visualización

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

Salida JSON para pipelines

Cada comando admite --json. Redirige a jq para un procesamiento adicional:

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

O pasa la salida a otro 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'

Diseñado para entornos CI

El CLI:

• Devuelve códigos de salida distintos de cero en caso de error
• Emite códigos de error legibles por máquina en modo JSON
• Funciona con PAPERMARK_TOKEN desde el entorno, para que puedas almacenar el token en el gestor de secretos de tu CI
• Transmite el progreso a stderr y los resultados JSON a stdout, para que puedas capturar los resultados sin perder los registros

Ejemplo de paso en 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

Casos de uso

• Publicación de informes para el consejo: un job de CI sube una carpeta a una sala de datos del consejo cada lunes por la mañana.
• Captación de inversores: un script recorre una lista de inversores, crea un enlace por inversor y escribe las URLs en un CSV.
• Copias de seguridad locales: un cron nocturno extrae una lista de documentos y analíticas de visualización hacia tu almacén de datos.
• Aprovisionamiento de salas de datos: crea una sala de datos con plantilla para cada nuevo acuerdo con un solo comando.

Preguntas frecuentes

Guías relacionadas

• Cómo usar la API REST de Papermark
• Cómo usar el servidor MCP de Papermark
• Cómo crear webhooks en Papermark

¿Necesitas ayuda? Contacta con support@papermark.com o usa el chat en la aplicación.