Referencia de la CLI Uproc

Descripción general

La CLI uproc es el cliente oficial para los endpoints /api/v1/external/*.

Instalación

macOS/Linux (Homebrew)

Instalar:

brew tap uproc-io/uproc
brew trust uproc-io/uproc   # requerido en Homebrew 5.5+
brew install uproc

Actualizar:

brew update
brew upgrade uproc

Windows (Scoop)

Instalar:

scoop bucket add uproc https://github.com/uproc-io/scoop-bucket.git
scoop install uproc

Actualizar:

scoop update
scoop update uproc

Linux/macOS (script de instalación)

curl -fsSL "https://api.uproc.io/api/v1/install/cli.sh" | bash
uproc --help

Instalar una versión fija:

curl -fsSL "https://api.uproc.io/api/v1/install/cli.sh?version=v0.1.0" | bash

Credenciales

Valores requeridos:

UPROC_PROCESSES_API_URL: VALUE
USER_API_KEY: VALUE

Guardar credenciales de forma interactiva:

uproc applications login

Formato de salida

La salida de la CLI se muestra como tablas/listas legibles (nunca como JSON raw).

Uso

uproc <comando> [subcomando] [args...]

1. Comandos de aplicaciones

install

Obtén el plan de instalación con una user API key.

uproc applications install <USER_API_KEY> --dry-run

El comando llama a /api/v1/external/install e imprime las versiones del release, los servicios requeridos y los pasos de instalación ordenados. En modo --dry-run no se aplica ningún cambio en el servidor.

Requisitos mínimos por defecto que se muestran en la salida del plan:

4 vCPU
16 GB RAM
200 GB NVMe disk

Recomendación de monitorización incluida en los pasos del plan:

Instalar el agente Beszel (recomendado)

Guarda las credenciales para comandos posteriores.

uproc applications login

processes request

Ejecuta una petición raw contra /api/v1/external/*.

uproc applications request <METHOD> <PATH> [JSON_BODY]

Ejemplo:

uproc applications request GET /api/v1/external/modules

processes interactive

Abre el modo interactivo de la CLI.

uproc applications interactive

Sesión de ejemplo:

uproc> module list
uproc> module get order-track
uproc> request GET /api/v1/external/modules
uproc> help
uproc> exit

processes update check

Valida la preparación para la actualización solo con comprobaciones dry-run.

uproc applications update check <USER_API_KEY>

El comando llama a /api/v1/external/install?dry_run=true y además ejecuta comprobaciones locales de solo lectura (docker, dokploy, servicios requeridos, variables de entorno requeridas y endpoints de salud).

2. Comandos de módulos de aplicación

module list

Lista los módulos disponibles.

uproc applications module list

module get

Obtiene los detalles de un módulo por slug.

uproc applications module get <module_slug>

Ejemplo:

uproc applications module get order-track

module overview

Obtiene la visión general de un módulo y, opcionalmente, filtra secciones (kpis, charts, tables).

uproc applications module overview <module_slug> [kpis|charts|tables]

Ejemplo:

uproc applications module overview purchase-invoices kpis

module collections

Obtiene las colecciones disponibles de un módulo.

uproc applications module collections <module_slug>

Ejemplo:

uproc applications module collections purchase-invoices

module collection

Obtiene las filas de una colección con paginación.

uproc applications module collection <module_slug> <collection_name> [--page 1 --sort-field key --sort-order asc --filter-field key --filter-value val]

Ejemplo:

uproc applications module collection purchase-invoices invoices --page 1 --sort-field created_at --sort-order desc

module data

Obtiene los datos de un módulo usando el endpoint /data.

uproc applications module data <module_slug> <collection_name> [--page 1 --sort-field key --sort-order asc --filter-field key --filter-value val]

module settings-tabs

Lista las pestañas de settings para un módulo (solo lectura).

uproc applications module settings-tabs <module_slug>

Ejemplo:

uproc applications module settings-tabs data-management

module settings-tab

Obtiene los valores de una pestaña de settings (solo lectura).

uproc applications module settings-tab <module_slug> <tab_key>

Ejemplo:

uproc applications module settings-tab data-management mailboxes

Ejemplo:

uproc applications module data order-track orders --page 1

module upload

Sube un archivo a una colección de un módulo.

uproc applications module upload <module_slug> <collection_name> <file_path>

Ejemplo:

uproc applications module upload document-ingest folders ./document.pdf

module webhook

Envía un payload de webhook a una colección de un módulo.

uproc applications module webhook <module_slug> <collection_name> <payload_json>

Ejemplo:

uproc applications module webhook order-track orders '{"name":"Sync order","message":"Order #12345"}'

forms submit-public

Envía el payload de un formulario público de Form Generator (form-generator).

uproc applications forms submit-public <customer_domain> <form_slug> <payload_json>

Ejemplo:

uproc applications forms submit-public demo contact-form '{"email":"[email protected]","country":"ES"}'

Este comando llama a:

POST /api/v1/external/public/modules/form-generator/forms/{customer_domain}/{form_slug}/submit

Cuerpo de la peticion enviado por la CLI:

{
  "payload": {
    "email": "[email protected]",
    "country": "ES"
  }
}

Alias de compatibilidad deprecated:

uproc applications module submit-public-form <customer_domain> <form_slug> <payload_json>

forms publish

Publica un formulario de form-generator.

uproc applications forms publish <form_id>

Este comando llama a:

POST /api/v1/external/modules/form-generator/actions/publish

Cuerpo de la peticion enviado por la CLI:

{
  "form_id": 12
}

forms archive

Archiva un formulario de form-generator.

uproc applications forms archive <form_id>

Este comando llama a:

POST /api/v1/external/modules/form-generator/actions/archive

Cuerpo de la peticion enviado por la CLI:

{
  "form_id": 12
}

forms restore

Restaura un formulario archivado de form-generator.

uproc applications forms restore <form_id>

Este comando llama a:

POST /api/v1/external/modules/form-generator/actions/restore

Cuerpo de la peticion enviado por la CLI:

{
  "form_id": 12
}

forms mark-submission-processed

Marca como procesado un envío de form-generator.

uproc applications forms mark-submission-processed <submission_id>

Este comando llama a:

POST /api/v1/external/modules/form-generator/actions/mark_submission_processed

Cuerpo de la peticion enviado por la CLI:

{
  "submission_id": 44
}

forms archive-submission

Archiva un envío de form-generator.

uproc applications forms archive-submission <submission_id>

Este comando llama a:

POST /api/v1/external/modules/form-generator/actions/archive_submission

Cuerpo de la petición enviado por la CLI:

{
  "submission_id": 44
}

candidate create-profile

Crea un perfil de candidate-evaluation.

uproc applications candidate create-profile <item_json>

Este comando llama a:

POST /api/v1/external/modules/candidate-evaluation/actions/create_profile

Cuerpo de la petición enviado por la CLI:

{
  "item": {
    "full_name": "Eva Ruiz",
    "email": "[email protected]"
  }
}

candidate create-job-opening

Crea una oferta de empleo de candidate-evaluation.

uproc applications candidate create-job-opening <item_json>

Este comando llama a:

POST /api/v1/external/modules/candidate-evaluation/actions/create_job_opening

candidate create-application

Crea una solicitud de candidate-evaluation.

uproc applications candidate create-application <item_json>

Este comando llama a:

POST /api/v1/external/modules/candidate-evaluation/actions/create_application

candidate move-stage

Mueve una solicitud de candidato a una nueva etapa.

uproc applications candidate move-stage <application_id> <stage>

Este comando llama a:

POST /api/v1/external/modules/candidate-evaluation/actions/move_application_stage

candidate update-status

Actualiza el estado de una solicitud de candidato.

uproc applications candidate update-status <application_id> <status>

Este comando llama a:

POST /api/v1/external/modules/candidate-evaluation/actions/update_application_status

candidate create-evaluation

Crea una evaluación de candidate-evaluation.

uproc applications candidate create-evaluation <item_json>

Este comando llama a:

POST /api/v1/external/modules/candidate-evaluation/actions/create_evaluation

support create-ticket

Crea un ticket de customer-care.

uproc applications support create-ticket <item_json>

Este comando llama a:

POST /api/v1/external/modules/customer-care/actions/create_ticket

support assign-ticket

Asigna un ticket de customer-care.

uproc applications support assign-ticket <ticket_id> <assignee>

Este comando llama a:

POST /api/v1/external/modules/customer-care/actions/assign_ticket

support reply-ticket

Responde a un ticket de customer-care.

uproc applications support reply-ticket <ticket_id> <message>

Este comando llama a:

POST /api/v1/external/modules/customer-care/actions/reply_to_ticket

support mark-resolved

Marca un ticket de customer-care como resuelto.

uproc applications support mark-resolved <ticket_id>

Este comando llama a:

POST /api/v1/external/modules/customer-care/actions/mark_resolved

support close-ticket

Cierra un ticket de customer-care.

uproc applications support close-ticket <ticket_id>

Este comando llama a:

POST /api/v1/external/modules/customer-care/actions/close_ticket

support reopen-ticket

Reabre un ticket de customer-care.

uproc applications support reopen-ticket <ticket_id>

Este comando llama a:

POST /api/v1/external/modules/customer-care/actions/reopen_ticket

approval approve

Aprueba una solicitud de approval-management.

uproc applications approval approve <request_id>

Este comando llama a:

POST /api/v1/external/modules/approval-management/actions/approve_request

approval reject

Rechaza una solicitud de approval-management.

uproc applications approval reject <request_id>

Este comando llama a:

POST /api/v1/external/modules/approval-management/actions/reject_request

approval reassign

Reasigna una solicitud de approval-management.

uproc applications approval reassign <request_id> <approver> [note]

Este comando llama a:

POST /api/v1/external/modules/approval-management/actions/reassign_request

approval cancel

Cancela una solicitud de approval-management.

uproc applications approval cancel <request_id>

Este comando llama a:

POST /api/v1/external/modules/approval-management/actions/cancel_request

campaign preview-audience

Previsualiza una audiencia de campaign-automation.

uproc applications campaign preview-audience <campaign_id> [limit]

Este comando llama a:

POST /api/v1/external/modules/campaign-automation/actions/preview_audience

campaign add-audience

Añade una definición de audiencia a un flujo de campaign-automation.

uproc applications campaign add-audience <campaign_id> [mode]

Este comando llama a:

POST /api/v1/external/modules/campaign-automation/actions/add_audience

campaign pause

Pausa un flujo de campaign-automation.

uproc applications campaign pause <campaign_id>

Este comando llama a:

POST /api/v1/external/modules/campaign-automation/actions/pause

campaign activate

Activa un flujo de campaign-automation.

uproc applications campaign activate <campaign_id>

Este comando llama a:

POST /api/v1/external/modules/campaign-automation/actions/activate

campaign sync-audience

Sincroniza una audiencia de campaign-automation con las plataformas externas configuradas (p. ej., Sendy) como suscriptores.

uproc applications campaign sync-audience <campaign_id> <audience_id>

Este comando llama a:

POST /api/v1/external/modules/campaign-automation/actions/sync_audience

campaign launch-platforms

Crea y lanza una campaña de campaign-automation en sus plataformas externas configuradas (p. ej., Sendy).

uproc applications campaign launch-platforms <campaign_id>

Este comando llama a:

POST /api/v1/external/modules/campaign-automation/actions/launch_platforms

contract renew

Renueva un contrato de contract-lifecycle.

uproc applications contract renew <contract_id>

Este comando llama a:

POST /api/v1/external/modules/contract-lifecycle/actions/renew

contract terminate

Termina un contrato de contract-lifecycle.

uproc applications contract terminate <contract_id>

Este comando llama a:

POST /api/v1/external/modules/contract-lifecycle/actions/terminate

contract update

Actualiza un contrato existente de contract-lifecycle.

uproc applications contract update <contract_id> <data_json>

Este comando llama a:

POST /api/v1/external/modules/contract-lifecycle/actions/update_contract

order mark-received

Marca un pedido de order-track como recibido.

uproc applications order mark-received <order_id>

Este comando llama a:

POST /api/v1/external/modules/order-track/actions/mark_received

order cancel

Cancela un pedido de order-track.

uproc applications order cancel <order_id>

Este comando llama a:

POST /api/v1/external/modules/order-track/actions/cancel_order

order send-reminder

Marca un pedido de order-track para seguimiento con recordatorio.

uproc applications order send-reminder <order_id>

Este comando llama a:

POST /api/v1/external/modules/order-track/actions/send_reminder

email mark-processed

Marca un email de email-assistant como procesado.

uproc applications email mark-processed <email_id>

Este comando llama a:

POST /api/v1/external/modules/email-assistant/actions/mark_processed

Cuerpo de la petición enviado por la CLI:

{
  "email_id": 5
}

email archive

Archiva un email de email-assistant.

uproc applications email archive <email_id>

Este comando llama a:

POST /api/v1/external/modules/email-assistant/actions/archive_email

Cuerpo de la petición enviado por la CLI:

{
  "email_id": 5
}

process retry-step

Reintenta el paso actual de un proceso de process-visibility.

uproc applications process retry-step <process_id>

Este comando llama a:

POST /api/v1/external/modules/process-visibility/actions/retry_step

Cuerpo de la petición enviado por la CLI:

{
  "process_id": 77
}

process reassign-owner

Reasigna un proceso de process-visibility al flujo alternativo de propietario.

uproc applications process reassign-owner <process_id>

Este comando llama a:

POST /api/v1/external/modules/process-visibility/actions/reassign_owner

Cuerpo de la petición enviado por la CLI:

{
  "process_id": 77
}

process cancel

Cancela un proceso de process-visibility.

uproc applications process cancel <process_id>

Este comando llama a:

POST /api/v1/external/modules/process-visibility/actions/cancel_process

Cuerpo de la petición enviado por la CLI:

{
  "process_id": 77
}

signals approve

Aprueba una señal de market-signals.

uproc applications signals approve <signal_id>

Este comando llama a:

POST /api/v1/external/modules/market-signals/actions/approve_signal

Cuerpo de la petición enviado por la CLI:

{
  "signal_id": 19
}

signals discard

Descarta una señal de market-signals.

uproc applications signals discard <signal_id>

Este comando llama a:

POST /api/v1/external/modules/market-signals/actions/discard_signal

Cuerpo de la petición enviado por la CLI:

{
  "signal_id": 19
}

signals mark-pending-review

Devuelve una señal de market-signals a revisión pendiente.

uproc applications signals mark-pending-review <signal_id>

Este comando llama a:

POST /api/v1/external/modules/market-signals/actions/mark_pending_review

Cuerpo de la petición enviado por la CLI:

{
  "signal_id": 19
}

signals activate

Activa una señal revisada de market-signals.

uproc applications signals activate <signal_id>

Este comando llama a:

POST /api/v1/external/modules/market-signals/actions/activate_signal

Cuerpo de la petición enviado por la CLI:

{
  "signal_id": 19
}

signals close

Cierra una señal de market-signals.

uproc applications signals close <signal_id>

Este comando llama a:

POST /api/v1/external/modules/market-signals/actions/close_signal

Cuerpo de la petición enviado por la CLI:

{
  "signal_id": 19
}

editorial generate-proposal

Genera una propuesta de editorial-engine.

uproc applications editorial generate-proposal <opportunity_id>

Este comando llama a:

POST /api/v1/external/modules/editorial-engine/actions/generate_proposal

Cuerpo de la petición enviado por la CLI:

{
  "opportunity_id": 31
}

editorial generate-article

Genera un borrador de artículo de editorial-engine.

uproc applications editorial generate-article <opportunity_id>

Este comando llama a:

POST /api/v1/external/modules/editorial-engine/actions/generate_article

Cuerpo de la petición enviado por la CLI:

{
  "opportunity_id": 31
}

editorial publish

Publica una oportunidad de editorial-engine.

uproc applications editorial publish <opportunity_id>

Este comando llama a:

POST /api/v1/external/modules/editorial-engine/actions/publish

Cuerpo de la petición enviado por la CLI:

{
  "opportunity_id": 31
}

editorial schedule

Programa una oportunidad de editorial-engine.

uproc applications editorial schedule <opportunity_id>

Este comando llama a:

POST /api/v1/external/modules/editorial-engine/actions/schedule

Cuerpo de la petición enviado por la CLI:

{
  "opportunity_id": 31
}

editorial discard

Descarta una oportunidad de editorial-engine.

uproc applications editorial discard <opportunity_id>

Este comando llama a:

POST /api/v1/external/modules/editorial-engine/actions/discard

Cuerpo de la petición enviado por la CLI:

{
  "opportunity_id": 31
}

signing cancel

Cancela una solicitud de document-signing.

uproc applications signing cancel <request_id>

Este comando llama a:

POST /api/v1/external/modules/document-signing/actions/cancel_request

Cuerpo de la petición enviado por la CLI:

{
  "request_id": 52
}

signing reopen

Reabre una solicitud de document-signing.

uproc applications signing reopen <request_id>

Este comando llama a:

POST /api/v1/external/modules/document-signing/actions/reopen_request

Cuerpo de la petición enviado por la CLI:

{
  "request_id": 52
}

signing send-reminder

Envía un recordatorio para una solicitud de document-signing.

uproc applications signing send-reminder <request_id>

Este comando llama a:

POST /api/v1/external/modules/document-signing/actions/send_reminder

Cuerpo de la petición enviado por la CLI:

{
  "request_id": 52
}

signing sync-status

Sincroniza el estado de una solicitud de document-signing.

uproc applications signing sync-status <request_id>

Este comando llama a:

POST /api/v1/external/modules/document-signing/actions/sync_status

Cuerpo de la petición enviado por la CLI:

{
  "request_id": 52
}

tax generate

Genera un borrador de informe de tax-compliance.

uproc applications tax generate <report_id>

Este comando llama a:

POST /api/v1/external/modules/tax-compliance/actions/generate_report

Cuerpo de la petición enviado por la CLI:

{
  "report_id": 18
}

tax recalculate

Recalcula un informe de tax-compliance.

uproc applications tax recalculate <report_id>

Este comando llama a:

POST /api/v1/external/modules/tax-compliance/actions/recalculate_report

Cuerpo de la petición enviado por la CLI:

{
  "report_id": 18
}

tax validate

Valida un informe de tax-compliance.

uproc applications tax validate <report_id>

Este comando llama a:

POST /api/v1/external/modules/tax-compliance/actions/validate_report

Cuerpo de la petición enviado por la CLI:

{
  "report_id": 18
}

tax export

Marca un informe de tax-compliance como exportado.

uproc applications tax export <report_id>

Este comando llama a:

POST /api/v1/external/modules/tax-compliance/actions/export_report

Cuerpo de la petición enviado por la CLI:

{
  "report_id": 18
}

documents mark-ready

Marca un documento de document-generator como listo.

uproc applications documents mark-ready <document_id>

Este comando llama a:

POST /api/v1/external/modules/document-generator/actions/mark_ready

Cuerpo de la petición enviado por la CLI:

{
  "document_id": 61
}

documents mark-review

Devuelve un documento de document-generator a revisión.

uproc applications documents mark-review <document_id>

Este comando llama a:

POST /api/v1/external/modules/document-generator/actions/mark_review

Cuerpo de la petición enviado por la CLI:

{
  "document_id": 61
}

documents archive

Archiva un documento de document-generator.

uproc applications documents archive <document_id>

Este comando llama a:

POST /api/v1/external/modules/document-generator/actions/archive_document

Cuerpo de la petición enviado por la CLI:

{
  "document_id": 61
}

documents restore

Restaura un documento archivado de document-generator.

uproc applications documents restore <document_id>

Este comando llama a:

POST /api/v1/external/modules/document-generator/actions/restore_document

Cuerpo de la petición enviado por la CLI:

{
  "document_id": 61
}

documents regenerate

Regenera un documento de document-generator.

uproc applications documents regenerate <document_id>

Este comando llama a:

POST /api/v1/external/modules/document-generator/actions/regenerate_document

Cuerpo de la petición enviado por la CLI:

{
  "document_id": 61
}

inventory mark-received

Marca un pedido de inventory-planning como recibido.

uproc applications inventory mark-received <order_id>

Este comando llama a:

POST /api/v1/external/modules/inventory-planning/actions/mark_received

Cuerpo de la petición enviado por la CLI:

{
  "order_id": 12
}

inventory cancel

Cancela un pedido de inventory-planning.

uproc applications inventory cancel <order_id>

Este comando llama a:

POST /api/v1/external/modules/inventory-planning/actions/cancel_order

Cuerpo de la petición enviado por la CLI:

{
  "order_id": 12
}

inventory send-reminder

Marca un pedido de inventory-planning para seguimiento con recordatorio.

uproc applications inventory send-reminder <order_id>

Este comando llama a:

POST /api/v1/external/modules/inventory-planning/actions/send_reminder

Cuerpo de la petición enviado por la CLI:

{
  "order_id": 12
}

orders-ingest reprocess

Reprocesa un pedido de order-ingest.

uproc applications orders-ingest reprocess <order_id>

Este comando llama a:

POST /api/v1/external/modules/order-ingest/actions/reprocess_order

Cuerpo de la petición enviado por la CLI:

{
  "order_id": 12
}

orders-ingest validate

Valida un pedido de order-ingest.

uproc applications orders-ingest validate <order_id>

Este comando llama a:

POST /api/v1/external/modules/order-ingest/actions/validate_order

Cuerpo de la petición enviado por la CLI:

{
  "order_id": 12
}

orders-ingest send-to-erp

Envía un pedido de order-ingest al ERP.

uproc applications orders-ingest send-to-erp <order_id>

Este comando llama a:

POST /api/v1/external/modules/order-ingest/actions/send_order_to_erp

Cuerpo de la petición enviado por la CLI:

{
  "order_id": 12
}

cases add-note

Añade una nota interna a un caso de case-lifecycle.

uproc applications cases add-note <case_id> <content> [created_by]

Este comando llama a:

POST /api/v1/external/modules/case-lifecycle/actions/create_case_note

Cuerpo de la petición enviado por la CLI:

{
  "case_id": 9,
  "content": "El cliente volvio a llamar"
}

cases close

Cierra un caso de case-lifecycle.

uproc applications cases close <case_id>

Este comando llama a:

POST /api/v1/external/modules/case-lifecycle/actions/close_case

Cuerpo de la petición enviado por la CLI:

{
  "case_id": 9
}

cases reopen

Reabre un caso de case-lifecycle.

uproc applications cases reopen <case_id>

Este comando llama a:

POST /api/v1/external/modules/case-lifecycle/actions/reopen_case

Cuerpo de la petición enviado por la CLI:

{
  "case_id": 9
}

invoice issue

Emite una factura existente de sales-invoices.

uproc applications invoice issue <invoice_id>

Este comando llama a:

POST /api/v1/external/modules/sales-invoices/actions/issue_invoice

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 27
}

invoice rectify

Crea una factura rectificativa de sales-invoices.

uproc applications invoice rectify <invoice_id> [reason]

Este comando llama a:

POST /api/v1/external/modules/sales-invoices/actions/rectify_invoice

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 27,
  "reason": "El cliente solicito una correccion"
}

invoice send

Envía una factura existente de sales-invoices.

uproc applications invoice send <invoice_id> [email] [subject] [message]

Este comando llama a:

POST /api/v1/external/modules/sales-invoices/actions/send_invoice

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 27,
  "email": "[email protected]"
}

invoice get-pdf

Obtiene la URL de previsualización del PDF de una factura existente de sales-invoices.

uproc applications invoice get-pdf <invoice_id>

Este comando llama a:

POST /api/v1/external/modules/sales-invoices/actions/get_invoice_pdf

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 27
}

invoice-lines add

Añade una línea a una factura existente de sales-invoices.

uproc applications invoice-lines add <invoice_id> <concept> [quantity] [unit_price] [tax_rate] [sort_order]

Este comando llama a:

POST /api/v1/external/modules/sales-invoices/actions/add_invoice_line

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 27,
  "concept": "Consulting hours",
  "quantity": 2,
  "unit_price": 120
}

invoice-lines update

Actualiza una línea de una factura existente de sales-invoices.

uproc applications invoice-lines update <invoice_id> <line_id> [concept] [quantity] [unit_price] [tax_rate] [sort_order]

Este comando llama a:

POST /api/v1/external/modules/sales-invoices/actions/update_invoice_line

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 27,
  "line_id": 3,
  "unit_price": 150
}

invoice-lines delete

Elimina una línea de una factura existente de sales-invoices.

uproc applications invoice-lines delete <invoice_id> <line_id>

Este comando llama a:

POST /api/v1/external/modules/sales-invoices/actions/delete_invoice_line

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 27,
  "line_id": 3
}

sync run

Ejecuta un flujo de data-sync.

uproc applications sync run <workflow_id>

Este comando llama a:

POST /api/v1/external/modules/data-sync/actions/run_workflow

Cuerpo de la petición enviado por la CLI:

{
  "workflow_id": 14
}

sync preview

Previsualiza un flujo de data-sync.

uproc applications sync preview <workflow_id> [limit]

Este comando llama a:

POST /api/v1/external/modules/data-sync/actions/preview_workflow

Cuerpo de la petición enviado por la CLI:

{
  "workflow_id": 14,
  "limit": 10
}

sync dry-run

Ejecuta una simulacion de un flujo de data-sync.

uproc applications sync dry-run <workflow_id> [limit]

Este comando llama a:

POST /api/v1/external/modules/data-sync/actions/dry_run_workflow

Cuerpo de la petición enviado por la CLI:

{
  "workflow_id": 14,
  "limit": 100
}

sync push-to-erp

Escribe un registro en un ERP (Holded / Factura Directa / Invoice Ninja) usando una credencial ERP almacenada.

uproc applications sync push-to-erp --credential <id> --resource invoices --operation create --json '{"number":"H-1","total":121}'

Llama a POST /api/v1/external/modules/data-sync/actions/push_to_erp.

sales-invoices verifactu

Helpers de registro VeriFactu (España).

uproc applications sales-invoices verifactu resubmit <invoice_id>
uproc applications sales-invoices verifactu run
uproc applications sales-invoices verifactu backfill
uproc applications sales-invoices verifactu xml <invoice_id>

resubmit reintenta el registro VeriFactu de una factura (reenvía el XML AEAT SF v1.1 almacenado). Llama a POST /api/v1/external/modules/sales-invoices/actions/resubmit_verifactu.
backfill registra facturas ya emitidas en la cadena VeriFactu (backlog F2). Llama a POST /api/v1/external/modules/sales-invoices/actions/backfill_verifactu.
run ejecuta ahora el workflow VeriFactu AEAT (envía registros pendientes a AEAT).
xml descarga el XML generado. Llama a GET /api/v1/external/modules/sales-invoices/data/invoices/<id>/verifactu_xml.

data-chatbot sessions

Lista las sesiones de data-chatbot del usuario conectado, opcionalmente filtradas por origen y canal.

uproc applications data-chatbot sessions [--source web|cli|mcp] [--channel <canal>]

Llama a GET /api/v1/external/modules/data-chatbot/sessions.

file-sync

Copia ficheros entre proveedores de almacenamiento (SFTP / S3 / Dropbox / Google Drive).

uproc applications file-sync list-transfers [--page 1]
uproc applications file-sync list-runs [--page 1]
uproc applications file-sync run <transfer_id>

run ejecuta una transferencia ahora (copia ficheros con sobrescritura). Llama a POST /api/v1/external/modules/file-sync/actions/run_transfer.

leads generate-proposal

Genera una propuesta comercial para un lead de lead-management.

uproc applications leads generate-proposal <lead_id> [template_id] [title] [description] [output_format]

Este comando llama a:

POST /api/v1/external/modules/lead-management/actions/generate_lead_proposal

Cuerpo de la peticion enviado por la CLI:

{
  "lead_id": 22,
  "output_format": "pdf"
}

leads list

Lista los leads de lead-management.

uproc applications leads list [--page 1 --sort-field created_at --sort-order desc --filter-field status --filter-value qualified]

Este comando llama a:

GET /api/v1/external/modules/lead-management/collections/leads?page=1&sort_field=created_at&sort_order=desc&filter_field=status&filter_value=qualified

leads send-proposal

Envía una propuesta generada por correo a un lead de lead-management.

uproc applications leads send-proposal <lead_id> <mailbox_id> <to_email> <subject> <body> [proposal_url]

Este comando llama a:

POST /api/v1/external/modules/lead-management/actions/send_lead_proposal

Cuerpo de la petición enviado por la CLI:

{
  "lead_id": 22,
  "mailbox_id": 4,
  "to_email": "[email protected]",
  "subject": "Proposal",
  "body": "Please review the attached proposal"
}

leads rerun-intelligence

Vuelve a ejecutar la inteligencia para un lead de lead-management.

uproc applications leads rerun-intelligence <lead_id>

Este comando llama a:

POST /api/v1/external/modules/lead-management/actions/rerun_lead_intelligence

Cuerpo de la peticion enviado por la CLI:

{
  "lead_id": 22
}

leads upload-proposal

Sube el PDF de una propuesta a un lead y crea una versión de propuesta. NO envía ningún email.

uproc applications leads upload-proposal 66 ./proposal.pdf

Este comando llama a:

POST /api/v1/external/modules/lead-management/actions/upload_proposal

Cuerpo de la petición enviado por la CLI:

{
  "lead_id": 66,
  "pdf_content": "<base64 PDF content>",
  "file_name": "./proposal.pdf",
  "proposal_key": "F0"
}

Flags opcionales:

--proposal-key (string): Clave para agrupar versiones de la misma propuesta (por defecto: nombre del archivo)

leads send-proposal-version

Envía una versión de propuesta existente al cliente por email con enlace de seguimiento.

uproc applications leads send-proposal-version 42 --subject "Proposal" --body "Please review"

Este comando llama a:

POST /api/v1/external/modules/lead-management/actions/send_proposal_version

Cuerpo de la petición enviado por la CLI:

{
  "version_id": 42,
  "to_email": "",
  "subject": "Proposal",
  "body": "Please review"
}

Flags opcionales:

--to-email (string): Email del destinatario (por defecto: el campo de email del lead)
--subject (string): Asunto del email
--body (string): Cuerpo del email

prospecting run-discovery

Ejecuta el descubrimiento para una estrategia de lead-prospecting.

uproc applications prospecting run-discovery <strategy_id> [company] [domain]

Este comando llama a:

POST /api/v1/external/modules/lead-prospecting/actions/run_discovery

Cuerpo de la peticion enviado por la CLI:

{
  "strategy_id": 7,
  "company": "ACME"
}

prospecting send-to-leads

Envia una oportunidad de lead-prospecting a lead management.

uproc applications prospecting send-to-leads <opportunity_id>

Este comando llama a:

POST /api/v1/external/modules/lead-prospecting/actions/send_opportunity_to_leads

Cuerpo de la peticion enviado por la CLI:

{
  "opportunity_id": 33
}

reconciliation reconcile

Ejecuta financial-reconciliation.

uproc applications reconciliation reconcile [process_id]

Este comando llama a:

POST /api/v1/external/modules/financial-reconciliation/actions/reconcile

Cuerpo de la peticion enviado por la CLI:

{
  "process_id": 41
}

chat ask

Envía una consulta en lenguaje natural a data-chatbot.

uproc applications chat ask <domain> <question> [context] [channel] [sender_id] [origin_session_id]

Este comando llama a:

POST /api/v1/external/modules/data-chatbot/actions/send_chat_query

Cuerpo de la petición enviado por la CLI:

{
  "domain": "sales",
  "question": "Which leads are closest to conversion?"
}

data-chatbot domains

Lista los dominios (canales) disponibles del data-chatbot y sus preguntas de ejemplo.

uproc applications data-chatbot domains

Este comando llama a:

GET /api/v1/external/modules/data-chatbot/data_domains

data-chatbot follow-up

Continúa una conversación (sesión) existente del data-chatbot con una nueva pregunta. El canal, dominio y contexto se toman de la última consulta de la sesión si no se indican.

uproc applications data-chatbot follow-up <origin_session_id> <question> [channel] [domain] [origin_user_id]

Este comando llama a:

POST /api/v1/external/modules/data-chatbot/actions/follow_up

data-chatbot interactive

Flujo guiado: elige un dominio, selecciona o edita una de las preguntas disponibles, envíala y continúa con follow-ups (o cambia de canal/dominio).

uproc applications data-chatbot interactive

purchase-invoices validate

Marca una factura de purchase-invoices como validada.

uproc applications purchase-invoices validate <id> [reason]

Este comando llama a:

PUT /api/v1/external/modules/purchase-invoices/data/purchase_invoices/{id}/status

Cuerpo de la petición enviado por la CLI:

{
  "status": "validated",
  "reason": ""
}

purchase-invoices pay

Marca una factura de purchase-invoices como pagada.

uproc applications purchase-invoices pay <id> [reason]

Este comando llama a:

PUT /api/v1/external/modules/purchase-invoices/data/purchase_invoices/{id}/status

Cuerpo de la petición enviado por la CLI:

{
  "status": "paid",
  "reason": ""
}

purchase-invoices assign-from-ingest

Asigna una factura de compra parseada de purchase-invoices a purchase-invoices.

uproc applications purchase-invoices assign-from-ingest <invoice_id> [payload_json]

Este comando llama a:

POST /api/v1/external/modules/purchase-invoices/actions/assign_from_ingest

Cuerpo de la petición enviado por la CLI:

{
  "invoice_id": 42
}

Comandos list con verbos de negocio

Los grupos curados de verbos de negocio ahora exponen subcomandos de lectura/listado que envuelven la misma familia de endpoints de colecciones que uproc applications module collection.

Flags comunes disponibles en todos los comandos list:

--page 1 --sort-field created_at --sort-order desc --filter-field status --filter-value qualified

Ejemplos:

uproc applications forms list [--page 1]
uproc applications forms list-fields [--page 1]
uproc applications forms list-submissions [--page 1]
uproc applications candidate list-profiles [--page 1]
uproc applications candidate list-job-openings [--page 1]
uproc applications candidate list-applications [--page 1]
uproc applications candidate list-evaluations [--page 1]
uproc applications candidate list-stage-events [--page 1]
uproc applications support list [--page 1]
uproc applications approval list [--page 1]
uproc applications campaign list [--page 1]
uproc applications campaign list-audiences [--page 1]
uproc applications contract list [--page 1]
uproc applications contract list-expiring [--page 1]
uproc applications contract list-by-counterparty [--page 1]
uproc applications order list [--page 1]
uproc applications email list [--page 1]
uproc applications process list [--page 1]
uproc applications signals list [--page 1]
uproc applications signals list-executions [--page 1]
uproc applications signals list-activations [--page 1]
uproc applications editorial list-opportunities [--page 1]
uproc applications editorial list-projects [--page 1]
uproc applications editorial list-articles [--page 1]
uproc applications editorial list-combined [--page 1]
uproc applications signing list [--page 1]
uproc applications tax list [--page 1]
uproc applications documents list [--page 1]
uproc applications inventory list [--page 1]
uproc applications orders-ingest list [--page 1]
uproc applications orders-ingest list-emails [--page 1]
uproc applications cases list [--page 1]
uproc applications cases list-by-status [--page 1]
uproc applications cases list-by-type [--page 1]
uproc applications invoice list [--page 1]
uproc applications invoice-lines list [--page 1]
uproc applications sync list-workflows [--page 1]
uproc applications sync list-runs [--page 1]
uproc applications sync list-records [--page 1]
uproc applications leads list [--page 1]
uproc applications prospecting list-strategies [--page 1]
uproc applications prospecting list-opportunities [--page 1]
uproc applications prospecting list-prospects [--page 1]
uproc applications prospecting list-executions [--page 1]
uproc applications reconciliation list-entries [--page 1]
uproc applications reconciliation list-extracts [--page 1]
uproc applications reconciliation list-exports [--page 1]
uproc applications reconciliation list-matches [--page 1]
uproc applications chat list [--page 1]
uproc applications data-chatbot list [--page 1]
uproc applications purchase-invoices list [--page 1]
uproc applications purchase-invoices list-lines [--page 1]
uproc applications purchase-invoices list-payments [--page 1]

Todos estos comandos llaman a:

GET /api/v1/external/modules/{module_slug}/collections/{collection_name}

4. Comandos de perfil

profile list

Lista perfiles con su URL API y si tienen una user API key configurada. Nunca muestra las claves.

uproc profile list

profile add

Pide de forma interactiva URL API y user API key, guarda el perfil y lo activa.

uproc profile add <profile_name>

profile show

Muestra la URL API y el estado de user API key del perfil activo sin imprimir la clave.

uproc profile show

profile use

Establece el perfil activo.

uproc profile use <profile_name>

4.5 Comandos de data-process y de perfil de usuario conectado

uproc applications data-process search [query]
uproc applications data-process tool <key>
uproc applications data-process execute <tool> [params_json]
uproc applications data-process batch <tool> <source_entity_id> [column_mapping_json] [fixed_values_json] [output_name]
uproc applications data-process runs
uproc me get
uproc me update first_name=Jane language=es default_app=data-process

data-process search busca tools por clave, nombre o descripción; data-process tool <key> muestra la especificación completa (params, valores aceptados, formato, coste) para saber exactamente cómo llamar a execute; execute ejecuta una tool en línea (sin límite diario de llamadas en línea; se aplican el saldo y el presupuesto diario); batch encola una ejecución en segundo plano sobre una entidad de data-management; me lee/actualiza el perfil del usuario de la API key bearer.


`data-process execute` ejecuta una tool en línea (sin límite diario de llamadas en línea; se aplican el saldo y el presupuesto diario). `data-process batch` encola una ejecución en segundo plano sobre una entidad de data-management. `me` lee/actualiza el perfil del usuario de la API key bearer.

Las tools de data-process migradas son servidas por la implementación nativa en Python; las tools aún no migradas recurren automáticamente a la plataforma legacy (`DATA_PROCESS_TOOLS_MODE=auto`). Una tool nativa que dependa de un proveedor externo se usa solo cuando su variable de entorno de credencial `TOOL_*` está configurada; en caso contrario, recurre a la versión legacy. Las respuestas de catálogo y de ejecución incluyen `execution_mode` (`native` o `legacy_bypass`).

## 5. Cabeceras de autenticación

- `Authorization: Bearer <USER_API_KEY>`

Referencia de la CLI

Referencia de la CLI Uproc

Descripción general

Instalación

macOS/Linux (Homebrew)

Windows (Scoop)

Linux/macOS (script de instalación)

Credenciales

Formato de salida

Uso

Índice

1. Comandos de aplicaciones

install

processes login

processes request

processes interactive

processes update check

2. Comandos de módulos de aplicación

module list

module get

module overview

module collections

module collection

module data

module settings-tabs

module settings-tab

module upload

module webhook

forms submit-public

forms publish

forms archive

forms restore

forms mark-submission-processed

forms archive-submission

candidate create-profile

candidate create-job-opening

candidate create-application

candidate move-stage

candidate update-status

candidate create-evaluation

support create-ticket

support assign-ticket

support reply-ticket

support mark-resolved

support close-ticket

support reopen-ticket

approval approve

approval reject

approval reassign

approval cancel

campaign preview-audience

campaign add-audience

campaign pause

campaign activate

campaign sync-audience

campaign launch-platforms

contract renew

contract terminate

contract update

order mark-received

order cancel

order send-reminder

email mark-processed

email archive

process retry-step

process reassign-owner

process cancel

signals approve

signals discard

signals mark-pending-review

signals activate

signals close

editorial generate-proposal

editorial generate-article

editorial publish

editorial schedule

editorial discard

signing cancel

signing reopen

signing send-reminder