OpenProject par @altf1be
Gérez les lots de travaux, projets, groupes, actualités, utilisateurs, observateurs, relations, notifications, entrées de temps, commentaires, pièces jointes, pages wiki et transitions de workflow d'OpenProject via l'API v3. Fonctionne avec les instances cloud et auto-hébergées.
Configuration
- Connectez-vous à votre instance OpenProject
- Allez dans Mon Compte → Jetons d'accès → + Ajouter
- Créez un jeton API et copiez-le
- Définissez les variables d'environnement (ou créez un fichier
.envdans{baseDir}) :
OP_HOST=https://projects.xflowdata.com
OP_API_TOKEN=votre-jeton-api
OP_DEFAULT_PROJECT=mon-projet
- Installez les dépendances :
cd {baseDir} && npm install
Commandes
Lots de travaux
# Lister les lots de travaux (avec filtres optionnels)
node {baseDir}/scripts/openproject.mjs wp-list --project mon-projet --status ouvert --assignee moi
# Créer un lot de travaux
node {baseDir}/scripts/openproject.mjs wp-create --project mon-projet --type Tâche --subject "Corriger le bug de connexion" --description "Les utilisateurs ne peuvent pas se connecter"
# Lire les détails d'un lot de travaux
node {baseDir}/scripts/openproject.mjs wp-read --id 42
# Mettre à jour un lot de travaux
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --subject "Nouveau titre" --priority Haute
# Supprimer un lot de travaux (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs wp-delete --id 42 --confirm
Projets
# Lister tous les projets
node {baseDir}/scripts/openproject.mjs project-list
# Lire les détails d'un projet
node {baseDir}/scripts/openproject.mjs project-read --id mon-projet
# Créer un projet
node {baseDir}/scripts/openproject.mjs project-create --name "Mon Projet" --identifier mon-projet
Commentaires (Activités)
# Lister les commentaires sur un lot de travaux
node {baseDir}/scripts/openproject.mjs comment-list --wp-id 42
# Ajouter un commentaire
node {baseDir}/scripts/openproject.mjs comment-add --wp-id 42 --body "Prêt pour la revue"
Pièces jointes
# Lister les pièces jointes sur un lot de travaux
node {baseDir}/scripts/openproject.mjs attachment-list --wp-id 42
# Télécharger une pièce jointe
node {baseDir}/scripts/openproject.mjs attachment-add --wp-id 42 --file ./capture-ecran.png
# Supprimer une pièce jointe (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs attachment-delete --id 10 --confirm
Entrées de temps
# Lister les entrées de temps
node {baseDir}/scripts/openproject.mjs time-list --project mon-projet
# Saisir du temps
node {baseDir}/scripts/openproject.mjs time-create --wp-id 42 --hours 2.5 --comment "Revue de code" --activity-id 1
# Mettre à jour une entrée de temps
node {baseDir}/scripts/openproject.mjs time-update --id 5 --hours 3 --comment "Mis à jour"
# Supprimer une entrée de temps (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs time-delete --id 5 --confirm
Statuts et transitions
# Lister tous les statuts
node {baseDir}/scripts/openproject.mjs status-list
# Mettre à jour le statut d'un lot de travaux
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --status "En cours"
Utilisateurs
# Lister tous les utilisateurs (avec filtres optionnels)
node {baseDir}/scripts/openproject.mjs user-list
node {baseDir}/scripts/openproject.mjs user-list --status actif --name "Jean"
# Lire les détails d'un utilisateur
node {baseDir}/scripts/openproject.mjs user-read --id 5
# Afficher l'utilisateur actuellement authentifié
node {baseDir}/scripts/openproject.mjs user-me
Notifications
# Lister les notifications (toutes ou non lues uniquement)
node {baseDir}/scripts/openproject.mjs notification-list
node {baseDir}/scripts/openproject.mjs notification-list --unread
node {baseDir}/scripts/openproject.mjs notification-list --reason mentionne --project 5
# Lire les détails d'une notification
node {baseDir}/scripts/openproject.mjs notification-read --id 100
# Marquer comme lu (une seule ou toutes)
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
# Marquer comme non lu
node {baseDir}/scripts/openproject.mjs notification-mark-unread --id 100
node {baseDir}/scripts/openproject.mjs notification-mark-unread --all
Documents
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 "Titre mis à jour"
Révisions
node {baseDir}/scripts/openproject.mjs revision-read --id 10
node {baseDir}/scripts/openproject.mjs revision-list-by-wp --wp-id 42
Capacités et actions
node {baseDir}/scripts/openproject.mjs capability-list --principal moi
node {baseDir}/scripts/openproject.mjs capability-global
node {baseDir}/scripts/openproject.mjs action-list
node {baseDir}/scripts/openproject.mjs action-read --id lots_de_travaux/creer
Mes préférences
node {baseDir}/scripts/openproject.mjs my-preferences-read
node {baseDir}/scripts/openproject.mjs my-preferences-update --time-zone "Europe/Bruxelles" --comment-order desc
Rendu
node {baseDir}/scripts/openproject.mjs render-markdown --text "**gras** et _italique_"
node {baseDir}/scripts/openproject.mjs render-plain --text "texte brut"
Messages (Forum)
node {baseDir}/scripts/openproject.mjs post-read --id 5
node {baseDir}/scripts/openproject.mjs post-attachment-list --id 5
Rappels
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 "Vérifier le statut"
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
Statuts de projet
node {baseDir}/scripts/openproject.mjs project-status-read --id sur_la_bonne_voie
Phases de projet (Enterprise)
# Lister les définitions de phases de projet
node {baseDir}/scripts/openproject.mjs project-phase-definition-list
# Lire une définition de phase
node {baseDir}/scripts/openproject.mjs project-phase-definition-read --id 1
# Lire une phase de projet
node {baseDir}/scripts/openproject.mjs project-phase-read --id 5
Portefeuilles (Enterprise)
# Lister les portefeuilles
node {baseDir}/scripts/openproject.mjs portfolio-list
# Lire un portefeuille
node {baseDir}/scripts/openproject.mjs portfolio-read --id 1
# Mettre à jour un portefeuille
node {baseDir}/scripts/openproject.mjs portfolio-update --id 1 --name "Portefeuille Q1"
# Supprimer un portefeuille (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs portfolio-delete --id 1 --confirm
Programmes (Enterprise)
# Lister les programmes
node {baseDir}/scripts/openproject.mjs program-list
# Lire un programme
node {baseDir}/scripts/openproject.mjs program-read --id 1
# Mettre à jour un programme
node {baseDir}/scripts/openproject.mjs program-update --id 1 --name "Programme Plateforme"
# Supprimer un programme (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs program-delete --id 1 --confirm
Utilisateurs fictifs (Enterprise)
# Lister les utilisateurs fictifs
node {baseDir}/scripts/openproject.mjs placeholder-user-list
# Lire un utilisateur fictif
node {baseDir}/scripts/openproject.mjs placeholder-user-read --id 10
# Créer un utilisateur fictif
node {baseDir}/scripts/openproject.mjs placeholder-user-create --name "Futur Développeur"
# Mettre à jour un utilisateur fictif
node {baseDir}/scripts/openproject.mjs placeholder-user-update --id 10 --name "Développeur Senior"
# Supprimer un utilisateur fictif (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs placeholder-user-delete --id 10 --confirm
Budgets (Enterprise)
# Lister les budgets du projet
node {baseDir}/scripts/openproject.mjs budget-list --project mon-projet
# Lire les détails d'un budget
node {baseDir}/scripts/openproject.mjs budget-read --id 3
Réunions (Enterprise)
# Lire une réunion
node {baseDir}/scripts/openproject.mjs meeting-read --id 10
# Lister les pièces jointes d'une réunion
node {baseDir}/scripts/openproject.mjs meeting-attachment-list --id 10
# Télécharger une pièce jointe à une réunion
node {baseDir}/scripts/openproject.mjs meeting-attachment-add --id 10 --file ./ordre-du-jour.pdf
Jours (ouvrés / non ouvrés)
# Vérifier si une date est un jour ouvré
node {baseDir}/scripts/openproject.mjs day-read --date 2026-03-18
# Lister les jours dans une plage
node {baseDir}/scripts/openproject.mjs days-list --from 2026-03-01 --to 2026-03-31
# Lister tous les jours non ouvrés (vacances)
node {baseDir}/scripts/openproject.mjs non-working-days-list
# Voir un jour non ouvré
node {baseDir}/scripts/openproject.mjs non-working-day-read --date 2026-12-25
# Afficher le planning des jours de la semaine (quels jours sont ouvrés)
node {baseDir}/scripts/openproject.mjs week-days-list
# Voir un jour spécifique de la semaine
node {baseDir}/scripts/openproject.mjs week-day-read --day 6
Configuration
# Voir la configuration de l'instance
node {baseDir}/scripts/openproject.mjs config-read
# Voir la configuration spécifique au projet
node {baseDir}/scripts/openproject.mjs project-config-read --project mon-projet
OAuth
# Lire une application OAuth
node {baseDir}/scripts/openproject.mjs oauth-app-read --id 1
# Lire les identifiants client OAuth
node {baseDir}/scripts/openproject.mjs oauth-credentials-read --id 1
Textes d'aide
# Lister tous les textes d'aide des attributs
node {baseDir}/scripts/openproject.mjs help-text-list
# Lire un texte d'aide
node {baseDir}/scripts/openproject.mjs help-text-read --id 1
Champs personnalisés et options
# Lister les éléments d'un champ personnalisé hiérarchique
node {baseDir}/scripts/openproject.mjs custom-field-items --id 10
# Lire un élément de champ personnalisé
node {baseDir}/scripts/openproject.mjs custom-field-item-read --id 25
# Obtenir la branche d'un élément de champ personnalisé (ancêtres)
node {baseDir}/scripts/openproject.mjs custom-field-item-branch --id 25
# Lire une valeur d'option personnalisée
node {baseDir}/scripts/openproject.mjs custom-option-read --id 3
Actions personnalisées
# Lire une action personnalisée
node {baseDir}/scripts/openproject.mjs custom-action-read --id 1
# Exécuter une action personnalisée sur un lot de travaux
node {baseDir}/scripts/openproject.mjs custom-action-execute --id 1 --wp-id 42
Groupes
# Lister tous les groupes
node {baseDir}/scripts/openproject.mjs group-list
# Lire les détails d'un groupe avec ses membres
node {baseDir}/scripts/openproject.mjs group-read --id 3
# Créer un groupe avec des membres
node {baseDir}/scripts/openproject.mjs group-create --name "Équipe Dev" --members 5,6,7
# Mettre à jour un groupe (remplace la liste des membres)
node {baseDir}/scripts/openproject.mjs group-update --id 3 --name "Ingénierie" --members 5,6,7,8
# Supprimer un groupe (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs group-delete --id 3 --confirm
Actualités
# Lister toutes les actualités
node {baseDir}/scripts/openproject.mjs news-list
# Lire les détails d'une actualité
node {baseDir}/scripts/openproject.mjs news-read --id 5
# Créer une actualité
node {baseDir}/scripts/openproject.mjs news-create --project mon-projet --title "Sprint 12 publié" --summary "Corrections de bugs et performances" --description "Détails complets ici..."
# Mettre à jour une actualité
node {baseDir}/scripts/openproject.mjs news-update --id 5 --title "Titre mis à jour"
# Supprimer une actualité (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs news-delete --id 5 --confirm
Observateurs
# Lister les observateurs d'un lot de travaux
node {baseDir}/scripts/openproject.mjs watcher-list --wp-id 42
# Ajouter un observateur
node {baseDir}/scripts/openproject.mjs watcher-add --wp-id 42 --user-id 5
# Supprimer un observateur
node {baseDir}/scripts/openproject.mjs watcher-remove --wp-id 42 --user-id 5
# Lister les utilisateurs disponibles comme observateurs
node {baseDir}/scripts/openproject.mjs watcher-available --wp-id 42
Relations
# Lister toutes les relations (optionnellement filtrer par lot de travaux ou type)
node {baseDir}/scripts/openproject.mjs relation-list --wp-id 42
node {baseDir}/scripts/openproject.mjs relation-list --type bloque
# Lire les détails d'une relation
node {baseDir}/scripts/openproject.mjs relation-read --id 5
# Créer une relation (types : relie, duplique, bloque, précède, suit, inclut, faitpartie, nécessite)
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type bloque
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type précède --lag 2
# Mettre à jour une relation
node {baseDir}/scripts/openproject.mjs relation-update --id 5 --type suit --lag 1
# Supprimer une relation (nécessite --confirm)
node {baseDir}/scripts/openproject.mjs relation-delete --id 5 --confirm
Pages Wiki
# Lire une page wiki
node {baseDir}/scripts/openproject.mjs wiki-read --id 72
# Lister les pièces jointes d'une page wiki
node {baseDir}/scripts/openproject.mjs wiki-attachment-list --id 72
# Télécharger une pièce jointe sur une page wiki
node {baseDir}/scripts/openproject.mjs wiki-attachment-add --id 72 --file ./diagramme.png
Données de référence
# Lister les types de lots de travaux
node {baseDir}/scripts/openproject.mjs type-list
# Lister les priorités
node {baseDir}/scripts/openproject.mjs priority-list
# Lister les membres du projet
node {baseDir}/scripts/openproject.mjs member-list --project mon-projet
# Lister les versions / jalons
node {baseDir}/scripts/openproject.mjs version-list --project mon-projet
# Lister les catégories
node {baseDir}/scripts/openproject.mjs category-list --project mon-projet
Sécurité
- Authentification par jeton API (authentification de base avec
apikeycomme nom d'utilisateur) - Aucun secret ou jeton affiché sur la sortie standard
- Toutes les opérations de suppression nécessitent le drapeau explicite
--confirm - Prévention des traversées de chemin pour les téléchargements de fichiers
- Limitation de débit intégrée avec réessai exponentiel
- Validation paresseuse de la configuration (vérifiée uniquement lorsqu'une commande s'exécute)
Dépendances
commander— Framework CLIdotenv— Chargement des variables d'environnement- Fonction
fetchintégrée à Node.js (nécessite Node >= 18)
Auteur
Abdelkrim BOUJRAF — ALT-F1 SRL, Bruxelles 🇧🇪 🇲🇦 X : @altf1be