OpenProject por @altf1be
Gestiona paquetes de trabajo, proyectos, grupos, noticias, usuarios, observadores, relaciones, notificaciones, entradas de tiempo, comentarios, adjuntos, páginas wiki y transiciones de flujo de trabajo de OpenProject a través de la API v3. Funciona tanto con instancias en la nube como autoalojadas.
Configuración
- Inicia sesión en tu instancia de OpenProject
- Ve a Mi Cuenta → Tokens de Acceso → + Añadir
- Crea un token API y cópialo
- Define las variables de entorno (o crea un archivo
.enven{baseDir}):
OP_HOST=https://projects.xflowdata.com
OP_API_TOKEN=tu-token-api
OP_DEFAULT_PROJECT=mi-proyecto
- Instala las dependencias:
cd {baseDir} && npm install
Comandos
Paquetes de Trabajo
# Listar paquetes de trabajo (con filtros opcionales)
node {baseDir}/scripts/openproject.mjs wp-list --project mi-proyecto --status abierto --assignee yo
# Crear un paquete de trabajo
node {baseDir}/scripts/openproject.mjs wp-create --project mi-proyecto --type Tarea --subject "Corregir bug de inicio de sesión" --description "Los usuarios no pueden iniciar sesión"
# Leer detalles de un paquete de trabajo
node {baseDir}/scripts/openproject.mjs wp-read --id 42
# Actualizar un paquete de trabajo
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --subject "Nuevo título" --priority Alta
# Eliminar un paquete de trabajo (requiere --confirm)
node {baseDir}/scripts/openproject.mjs wp-delete --id 42 --confirm
Proyectos
# Listar todos los proyectos
node {baseDir}/scripts/openproject.mjs project-list
# Leer detalles de un proyecto
node {baseDir}/scripts/openproject.mjs project-read --id mi-proyecto
# Crear un proyecto
node {baseDir}/scripts/openproject.mjs project-create --name "Mi Proyecto" --identifier mi-proyecto
Comentarios (Actividades)
# Listar comentarios de un paquete de trabajo
node {baseDir}/scripts/openproject.mjs comment-list --wp-id 42
# Añadir un comentario
node {baseDir}/scripts/openproject.mjs comment-add --wp-id 42 --body "Listo para revisión"
Adjuntos
# Listar adjuntos de un paquete de trabajo
node {baseDir}/scripts/openproject.mjs attachment-list --wp-id 42
# Subir un adjunto
node {baseDir}/scripts/openproject.mjs attachment-add --wp-id 42 --file ./captura.png
# Eliminar un adjunto (requiere --confirm)
node {baseDir}/scripts/openproject.mjs attachment-delete --id 10 --confirm
Entradas de Tiempo
# Listar entradas de tiempo
node {baseDir}/scripts/openproject.mjs time-list --project mi-proyecto
# Registrar tiempo
node {baseDir}/scripts/openproject.mjs time-create --wp-id 42 --hours 2.5 --comment "Revisión de código" --activity-id 1
# Actualizar entrada de tiempo
node {baseDir}/scripts/openproject.mjs time-update --id 5 --hours 3 --comment "Actualizado"
# Eliminar entrada de tiempo (requiere --confirm)
node {baseDir}/scripts/openproject.mjs time-delete --id 5 --confirm
Estados y Transiciones
# Listar todos los estados
node {baseDir}/scripts/openproject.mjs status-list
# Actualizar el estado de un paquete de trabajo
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --status "En progreso"
Usuarios
# Listar todos los usuarios (con filtros opcionales)
node {baseDir}/scripts/openproject.mjs user-list
node {baseDir}/scripts/openproject.mjs user-list --status activo --name "Juan"
# Leer detalles de un usuario
node {baseDir}/scripts/openproject.mjs user-read --id 5
# Mostrar el usuario autenticado actual
node {baseDir}/scripts/openproject.mjs user-me
Notificaciones
# Listar notificaciones (todas o solo no leídas)
node {baseDir}/scripts/openproject.mjs notification-list
node {baseDir}/scripts/openproject.mjs notification-list --unread
node {baseDir}/scripts/openproject.mjs notification-list --reason mencionado --project 5
# Leer detalles de una notificación
node {baseDir}/scripts/openproject.mjs notification-read --id 100
# Marcar como leída (una o todas)
node {baseDir}/scripts/openproject.mjs notification-mark-read --id 100
node {baseDir}/scripts/openproject.mjs notification-mark-read --all
node {baseDir}/scripts/openproject.mjs notification-mark-read --all --project 5
# Marcar como no leída
node {baseDir}/scripts/openproject.mjs notification-mark-unread --id 100
node {baseDir}/scripts/openproject.mjs notification-mark-unread --all
Documentos
node {baseDir}/scripts/openproject.mjs document-list
node {baseDir}/scripts/openproject.mjs document-read --id 5
node {baseDir}/scripts/openproject.mjs document-update --id 5 --title "Título actualizado"
Revisiones
node {baseDir}/scripts/openproject.mjs revision-read --id 10
node {baseDir}/scripts/openproject.mjs revision-list-by-wp --wp-id 42
Capacidades y Acciones
node {baseDir}/scripts/openproject.mjs capability-list --principal yo
node {baseDir}/scripts/openproject.mjs capability-global
node {baseDir}/scripts/openproject.mjs action-list
node {baseDir}/scripts/openproject.mjs action-read --id work_packages/create
Mis Preferencias
node {baseDir}/scripts/openproject.mjs my-preferences-read
node {baseDir}/scripts/openproject.mjs my-preferences-update --time-zone "Europe/Brussels" --comment-order desc
Renderizado
node {baseDir}/scripts/openproject.mjs render-markdown --text "**negrita** y _cursiva_"
node {baseDir}/scripts/openproject.mjs render-plain --text "texto plano"
Publicaciones (Foro)
node {baseDir}/scripts/openproject.mjs post-read --id 5
node {baseDir}/scripts/openproject.mjs post-attachment-list --id 5
Recordatorios
node {baseDir}/scripts/openproject.mjs reminder-list
node {baseDir}/scripts/openproject.mjs reminder-create --wp-id 42 --remind-at "2026-03-20T09:00:00Z" --note "Verificar estado"
node {baseDir}/scripts/openproject.mjs reminder-update --id 3 --remind-at "2026-03-21T09:00:00Z"
node {baseDir}/scripts/openproject.mjs reminder-delete --id 3 --confirm
Estados de Proyecto
node {baseDir}/scripts/openproject.mjs project-status-read --id on_track
Fases de Proyecto (Enterprise)
# Listar definiciones de fases de proyecto
node {baseDir}/scripts/openproject.mjs project-phase-definition-list
# Leer una definición de fase
node {baseDir}/scripts/openproject.mjs project-phase-definition-read --id 1
# Leer una fase de proyecto
node {baseDir}/scripts/openproject.mjs project-phase-read --id 5
Portafolios (Enterprise)
# Listar portafolios
node {baseDir}/scripts/openproject.mjs portfolio-list
# Leer un portafolio
node {baseDir}/scripts/openproject.mjs portfolio-read --id 1
# Actualizar un portafolio
node {baseDir}/scripts/openproject.mjs portfolio-update --id 1 --name "Portafolio Q1"
# Eliminar un portafolio (requiere --confirm)
node {baseDir}/scripts/openproject.mjs portfolio-delete --id 1 --confirm
Programas (Enterprise)
# Listar programas
node {baseDir}/scripts/openproject.mjs program-list
# Leer un programa
node {baseDir}/scripts/openproject.mjs program-read --id 1
# Actualizar un programa
node {baseDir}/scripts/openproject.mjs program-update --id 1 --name "Programa Plataforma"
# Eliminar un programa (requiere --confirm)
node {baseDir}/scripts/openproject.mjs program-delete --id 1 --confirm
Usuarios Placeholder (Enterprise)
# Listar usuarios placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-list
# Leer un usuario placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-read --id 10
# Crear un usuario placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-create --name "Futuro Desarrollador"
# Actualizar un usuario placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-update --id 10 --name "Desarrollador Senior"
# Eliminar un usuario placeholder (requiere --confirm)
node {baseDir}/scripts/openproject.mjs placeholder-user-delete --id 10 --confirm
Presupuestos (Enterprise)
# Listar presupuestos de proyecto
node {baseDir}/scripts/openproject.mjs budget-list --project mi-proyecto
# Leer detalles de un presupuesto
node {baseDir}/scripts/openproject.mjs budget-read --id 3
Reuniones (Enterprise)
# Leer una reunión
node {baseDir}/scripts/openproject.mjs meeting-read --id 10
# Listar adjuntos de una reunión
node {baseDir}/scripts/openproject.mjs meeting-attachment-list --id 10
# Subir adjunto a una reunión
node {baseDir}/scripts/openproject.mjs meeting-attachment-add --id 10 --file ./agenda.pdf
Días (Laborables/No Laborables)
# Verificar si una fecha es día laborable
node {baseDir}/scripts/openproject.mjs day-read --date 2026-03-18
# Listar días en un rango
node {baseDir}/scripts/openproject.mjs days-list --from 2026-03-01 --to 2026-03-31
# Listar todos los días no laborables (festivos)
node {baseDir}/scripts/openproject.mjs non-working-days-list
# Ver un día no laborable
node {baseDir}/scripts/openproject.mjs non-working-day-read --date 2026-12-25
# Mostrar horario semanal (qué días son laborables)
node {baseDir}/scripts/openproject.mjs week-days-list
# Ver un día específico de la semana
node {baseDir}/scripts/openproject.mjs week-day-read --day 6
Configuración
# Ver configuración de la instancia
node {baseDir}/scripts/openproject.mjs config-read
# Ver configuración específica de un proyecto
node {baseDir}/scripts/openproject.mjs project-config-read --project mi-proyecto
OAuth
# Leer una aplicación OAuth
node {baseDir}/scripts/openproject.mjs oauth-app-read --id 1
# Leer credenciales de cliente OAuth
node {baseDir}/scripts/openproject.mjs oauth-credentials-read --id 1
Textos de Ayuda
# Listar todos los textos de ayuda de atributos
node {baseDir}/scripts/openproject.mjs help-text-list
# Leer un texto de ayuda
node {baseDir}/scripts/openproject.mjs help-text-read --id 1
Campos Personalizados y Opciones
# Listar elementos de un campo personalizado jerárquico
node {baseDir}/scripts/openproject.mjs custom-field-items --id 10
# Leer un elemento de campo personalizado
node {baseDir}/scripts/openproject.mjs custom-field-item-read --id 25
# Obtener la rama (ancestros) de un elemento de campo personalizado
node {baseDir}/scripts/openproject.mjs custom-field-item-branch --id 25
# Leer un valor de opción personalizada
node {baseDir}/scripts/openproject.mjs custom-option-read --id 3
Acciones Personalizadas
# Leer una acción personalizada
node {baseDir}/scripts/openproject.mjs custom-action-read --id 1
# Ejecutar una acción personalizada en un paquete de trabajo
node {baseDir}/scripts/openproject.mjs custom-action-execute --id 1 --wp-id 42
Grupos
# Listar todos los grupos
node {baseDir}/scripts/openproject.mjs group-list
# Leer detalles de un grupo con miembros
node {baseDir}/scripts/openproject.mjs group-read --id 3
# Crear un grupo con miembros
node {baseDir}/scripts/openproject.mjs group-create --name "Equipo Dev" --members 5,6,7
# Actualizar un grupo (reemplaza la lista de miembros)
node {baseDir}/scripts/openproject.mjs group-update --id 3 --name "Ingeniería" --members 5,6,7,8
# Eliminar un grupo (requiere --confirm)
node {baseDir}/scripts/openproject.mjs group-delete --id 3 --confirm
Noticias
# Listar todas las noticias
node {baseDir}/scripts/openproject.mjs news-list
# Leer detalles de una noticia
node {baseDir}/scripts/openproject.mjs news-read --id 5
# Crear una noticia
node {baseDir}/scripts/openproject.mjs news-create --project mi-proyecto --title "Sprint 12 Publicado" --summary "Correcciones de errores y rendimiento" --description "Detalles completos aquí..."
# Actualizar una noticia
node {baseDir}/scripts/openproject.mjs news-update --id 5 --title "Titular actualizado"
# Eliminar una noticia (requiere --confirm)
node {baseDir}/scripts/openproject.mjs news-delete --id 5 --confirm
Observadores
# Listar observadores de un paquete de trabajo
node {baseDir}/scripts/openproject.mjs watcher-list --wp-id 42
# Añadir un observador
node {baseDir}/scripts/openproject.mjs watcher-add --wp-id 42 --user-id 5
# Eliminar un observador
node {baseDir}/scripts/openproject.mjs watcher-remove --wp-id 42 --user-id 5
# Listar usuarios disponibles como observadores
node {baseDir}/scripts/openproject.mjs watcher-available --wp-id 42
Relaciones
# Listar todas las relaciones (opcionalmente filtrar por paquete de trabajo o tipo)
node {baseDir}/scripts/openproject.mjs relation-list --wp-id 42
node {baseDir}/scripts/openproject.mjs relation-list --type bloquea
# Leer detalles de una relación
node {baseDir}/scripts/openproject.mjs relation-read --id 5
# Crear una relación (tipos: relaciona, duplica, bloquea, precede, sigue, incluye, partedel, requiere)
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type bloquea
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type precede --lag 2
# Actualizar una relación
node {baseDir}/scripts/openproject.mjs relation-update --id 5 --type sigue --lag 1
# Eliminar una relación (requiere --confirm)
node {baseDir}/scripts/openproject.mjs relation-delete --id 5 --confirm
Páginas Wiki
# Leer una página wiki
node {baseDir}/scripts/openproject.mjs wiki-read --id 72
# Listar adjuntos de una página wiki
node {baseDir}/scripts/openproject.mjs wiki-attachment-list --id 72
# Subir un adjunto a una página wiki
node {baseDir}/scripts/openproject.mjs wiki-attachment-add --id 72 --file ./diagrama.png
Datos de Referencia
# Listar tipos de paquete de trabajo
node {baseDir}/scripts/openproject.mjs type-list
# Listar prioridades
node {baseDir}/scripts/openproject.mjs priority-list
# Listar miembros del proyecto
node {baseDir}/scripts/openproject.mjs member-list --project mi-proyecto
# Listar versiones/hitos
node {baseDir}/scripts/openproject.mjs version-list --project mi-proyecto
# Listar categorías
node {baseDir}/scripts/openproject.mjs category-list --project mi-proyecto
Seguridad
- Autenticación mediante token API (Basic auth con
apikeycomo nombre de usuario) - No se imprimen secretos ni tokens en la salida estándar
- Todas las operaciones de eliminación requieren el flag explícito
--confirm - Prevención de path traversal para subidas de archivos
- Limitación de tasa integrada con reintento de backoff exponencial
- Validación de configuración diferida (solo se verifica cuando se ejecuta un comando)
Dependencias
commander— framework CLIdotenv— carga de variables de entornofetchnativo de Node.js (requiere Node >= 18)
Autor
Abdelkrim BOUJRAF — ALT-F1 SRL, Bruselas 🇧🇪 🇲🇦 X: @altf1be