OpenProject von @altf1be
Verwalte OpenProject-Arbeitspakete, Projekte, Gruppen, News, Benutzer, Beobachter, Beziehungen, Benachrichtigungen, Zeiteinträge, Kommentare, Anhänge, Wiki-Seiten und Workflow-Übergänge über die API v3. Funktioniert sowohl mit Cloud- als auch mit selbst gehosteten Instanzen.
Einrichtung
- Melde dich bei deiner OpenProject-Instanz an
- Gehe zu Mein Konto → Zugriffstoken → + Hinzufügen
- Erstelle ein API-Token und kopiere es
- Setze die Umgebungsvariablen (oder erstelle
.envin{baseDir}):
OP_HOST=https://projects.xflowdata.com
OP_API_TOKEN=dein-api-token
OP_DEFAULT_PROJECT=mein-projekt
- Installiere die Abhängigkeiten:
cd {baseDir} && npm install
Befehle
Arbeitspakete
# Arbeitspakete auflisten (mit optionalen Filtern)
node {baseDir}/scripts/openproject.mjs wp-list --project mein-projekt --status offen --assignee ich
# Ein Arbeitspaket erstellen
node {baseDir}/scripts/openproject.mjs wp-create --project mein-projekt --type Aufgabe --betreff "Login-Fehler beheben" --beschreibung "Benutzer können sich nicht anmelden"
# Arbeitspaket-Details lesen
node {baseDir}/scripts/openproject.mjs wp-read --id 42
# Ein Arbeitspaket aktualisieren
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --betreff "Neuer Titel" --priorität Hoch
# Ein Arbeitspaket löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs wp-delete --id 42 --confirm
Projekte
# Alle Projekte auflisten
node {baseDir}/scripts/openproject.mjs project-list
# Projekt-Details lesen
node {baseDir}/scripts/openproject.mjs project-read --id mein-projekt
# Ein Projekt erstellen
node {baseDir}/scripts/openproject.mjs project-create --name "Mein Projekt" --identifier mein-projekt
Kommentare (Aktivitäten)
# Kommentare zu einem Arbeitspaket auflisten
node {baseDir}/scripts/openproject.mjs comment-list --wp-id 42
# Einen Kommentar hinzufügen
node {baseDir}/scripts/openproject.mjs comment-add --wp-id 42 --body "Bereit zur Überprüfung"
Anhänge
# Anhänge eines Arbeitspakets auflisten
node {baseDir}/scripts/openproject.mjs attachment-list --wp-id 42
# Einen Anhang hochladen
node {baseDir}/scripts/openproject.mjs attachment-add --wp-id 42 --file ./screenshot.png
# Einen Anhang löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs attachment-delete --id 10 --confirm
Zeiteinträge
# Zeiteinträge auflisten
node {baseDir}/scripts/openproject.mjs time-list --project mein-projekt
# Zeit erfassen
node {baseDir}/scripts/openproject.mjs time-create --wp-id 42 --hours 2.5 --comment "Code-Review" --activity-id 1
# Zeiteintrag aktualisieren
node {baseDir}/scripts/openproject.mjs time-update --id 5 --hours 3 --comment "Aktualisiert"
# Zeiteintrag löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs time-delete --id 5 --confirm
Status & Übergänge
# Alle Status auflisten
node {baseDir}/scripts/openproject.mjs status-list
# Arbeitspaket-Status aktualisieren
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --status "In Bearbeitung"
Benutzer
# Alle Benutzer auflisten (mit optionalen Filtern)
node {baseDir}/scripts/openproject.mjs user-list
node {baseDir}/scripts/openproject.mjs user-list --status aktiv --name "Hans"
# Benutzer-Details lesen
node {baseDir}/scripts/openproject.mjs user-read --id 5
# Aktuell authentifizierten Benutzer anzeigen
node {baseDir}/scripts/openproject.mjs user-me
Benachrichtigungen
# Benachrichtigungen auflisten (alle oder nur ungelesene)
node {baseDir}/scripts/openproject.mjs notification-list
node {baseDir}/scripts/openproject.mjs notification-list --unread
node {baseDir}/scripts/openproject.mjs notification-list --reason erwähnt --project 5
# Benachrichtigungs-Details lesen
node {baseDir}/scripts/openproject.mjs notification-read --id 100
# Als gelesen markieren (einzeln oder alle)
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
# Als ungelesen markieren
node {baseDir}/scripts/openproject.mjs notification-mark-unread --id 100
node {baseDir}/scripts/openproject.mjs notification-mark-unread --all
Dokumente
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 "Aktualisierter Titel"
Revisionen
node {baseDir}/scripts/openproject.mjs revision-read --id 10
node {baseDir}/scripts/openproject.mjs revision-list-by-wp --wp-id 42
Fähigkeiten & Aktionen
node {baseDir}/scripts/openproject.mjs capability-list --principal ich
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
Meine Einstellungen
node {baseDir}/scripts/openproject.mjs my-preferences-read
node {baseDir}/scripts/openproject.mjs my-preferences-update --time-zone "Europe/Berlin" --comment-order desc
Rendern
node {baseDir}/scripts/openproject.mjs render-markdown --text "**fett** und _kursiv_"
node {baseDir}/scripts/openproject.mjs render-plain --text "Klartext"
Beiträge (Forum)
node {baseDir}/scripts/openproject.mjs post-read --id 5
node {baseDir}/scripts/openproject.mjs post-attachment-list --id 5
Erinnerungen
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 "Status prüfen"
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
Projekt-Status
node {baseDir}/scripts/openproject.mjs project-status-read --id on_track
Projekt-Phasen (Enterprise)
# Projektphasen-Definitionen auflisten
node {baseDir}/scripts/openproject.mjs project-phase-definition-list
# Eine Phasen-Definition lesen
node {baseDir}/scripts/openproject.mjs project-phase-definition-read --id 1
# Eine Projektphase lesen
node {baseDir}/scripts/openproject.mjs project-phase-read --id 5
Portfolios (Enterprise)
# Portfolios auflisten
node {baseDir}/scripts/openproject.mjs portfolio-list
# Ein Portfolio lesen
node {baseDir}/scripts/openproject.mjs portfolio-read --id 1
# Ein Portfolio aktualisieren
node {baseDir}/scripts/openproject.mjs portfolio-update --id 1 --name "Q1-Portfolio"
# Ein Portfolio löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs portfolio-delete --id 1 --confirm
Programme (Enterprise)
# Programme auflisten
node {baseDir}/scripts/openproject.mjs program-list
# Ein Programm lesen
node {baseDir}/scripts/openproject.mjs program-read --id 1
# Ein Programm aktualisieren
node {baseDir}/scripts/openproject.mjs program-update --id 1 --name "Plattform-Programm"
# Ein Programm löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs program-delete --id 1 --confirm
Platzhalter-Benutzer (Enterprise)
# Platzhalter-Benutzer auflisten
node {baseDir}/scripts/openproject.mjs placeholder-user-list
# Einen Platzhalter-Benutzer lesen
node {baseDir}/scripts/openproject.mjs placeholder-user-read --id 10
# Einen Platzhalter-Benutzer erstellen
node {baseDir}/scripts/openproject.mjs placeholder-user-create --name "Zukünftiger Entwickler"
# Einen Platzhalter-Benutzer aktualisieren
node {baseDir}/scripts/openproject.mjs placeholder-user-update --id 10 --name "Senior-Entwickler"
# Einen Platzhalter-Benutzer löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs placeholder-user-delete --id 10 --confirm
Budgets (Enterprise)
# Projektbudgets auflisten
node {baseDir}/scripts/openproject.mjs budget-list --project mein-projekt
# Budget-Details lesen
node {baseDir}/scripts/openproject.mjs budget-read --id 3
Meetings (Enterprise)
# Ein Meeting lesen
node {baseDir}/scripts/openproject.mjs meeting-read --id 10
# Meeting-Anhänge auflisten
node {baseDir}/scripts/openproject.mjs meeting-attachment-list --id 10
# Anhang zu einem Meeting hochladen
node {baseDir}/scripts/openproject.mjs meeting-attachment-add --id 10 --file ./agenda.pdf
Tage (Arbeits-/Nichtarbeitstage)
# Prüfen, ob ein Datum ein Arbeitstag ist
node {baseDir}/scripts/openproject.mjs day-read --date 2026-03-18
# Tage in einem Bereich auflisten
node {baseDir}/scripts/openproject.mjs days-list --from 2026-03-01 --to 2026-03-31
# Alle Nichtarbeitstage (Feiertage) auflisten
node {baseDir}/scripts/openproject.mjs non-working-days-list
# Einen Nichtarbeitstag anzeigen
node {baseDir}/scripts/openproject.mjs non-working-day-read --date 2026-12-25
# Wochenplan anzeigen (welche Tage Arbeitstage sind)
node {baseDir}/scripts/openproject.mjs week-days-list
# Einen bestimmten Wochentag anzeigen
node {baseDir}/scripts/openproject.mjs week-day-read --day 6
Konfiguration
# Instanzkonfiguration anzeigen
node {baseDir}/scripts/openproject.mjs config-read
# Projektspezifische Konfiguration anzeigen
node {baseDir}/scripts/openproject.mjs project-config-read --project mein-projekt
OAuth
# Eine OAuth-Anwendung lesen
node {baseDir}/scripts/openproject.mjs oauth-app-read --id 1
# OAuth-Client-Anmeldedaten lesen
node {baseDir}/scripts/openproject.mjs oauth-credentials-read --id 1
Hilfetexte
# Alle Attribut-Hilfetexte auflisten
node {baseDir}/scripts/openproject.mjs help-text-list
# Einen Hilfetext lesen
node {baseDir}/scripts/openproject.mjs help-text-read --id 1
Benutzerdefinierte Felder & Optionen
# Elemente für ein hierarchisches benutzerdefiniertes Feld auflisten
node {baseDir}/scripts/openproject.mjs custom-field-items --id 10
# Ein Element eines benutzerdefinierten Feldes lesen
node {baseDir}/scripts/openproject.mjs custom-field-item-read --id 25
# Den Zweig (Vorfahren) eines benutzerdefinierten Feldelements abrufen
node {baseDir}/scripts/openproject.mjs custom-field-item-branch --id 25
# Einen benutzerdefinierten Optionswert lesen
node {baseDir}/scripts/openproject.mjs custom-option-read --id 3
Benutzerdefinierte Aktionen
# Eine benutzerdefinierte Aktion lesen
node {baseDir}/scripts/openproject.mjs custom-action-read --id 1
# Eine benutzerdefinierte Aktion auf einem Arbeitspaket ausführen
node {baseDir}/scripts/openproject.mjs custom-action-execute --id 1 --wp-id 42
Gruppen
# Alle Gruppen auflisten
node {baseDir}/scripts/openproject.mjs group-list
# Gruppendetails mit Mitgliedern lesen
node {baseDir}/scripts/openproject.mjs group-read --id 3
# Eine Gruppe mit Mitgliedern erstellen
node {baseDir}/scripts/openproject.mjs group-create --name "Entwicklungsteam" --members 5,6,7
# Eine Gruppe aktualisieren (ersetzt die Mitgliederliste)
node {baseDir}/scripts/openproject.mjs group-update --id 3 --name "Engineering" --members 5,6,7,8
# Eine Gruppe löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs group-delete --id 3 --confirm
News
# Alle News auflisten
node {baseDir}/scripts/openproject.mjs news-list
# News-Details lesen
node {baseDir}/scripts/openproject.mjs news-read --id 5
# Einen News-Eintrag erstellen
node {baseDir}/scripts/openproject.mjs news-create --project mein-projekt --title "Sprint 12 veröffentlicht" --summary "Fehlerbehebungen und Leistungsverbesserungen" --description "Vollständige Details hier..."
# Einen News-Eintrag aktualisieren
node {baseDir}/scripts/openproject.mjs news-update --id 5 --title "Aktualisierte Schlagzeile"
# Einen News-Eintrag löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs news-delete --id 5 --confirm
Beobachter
# Beobachter eines Arbeitspakets auflisten
node {baseDir}/scripts/openproject.mjs watcher-list --wp-id 42
# Einen Beobachter hinzufügen
node {baseDir}/scripts/openproject.mjs watcher-add --wp-id 42 --user-id 5
# Einen Beobachter entfernen
node {baseDir}/scripts/openproject.mjs watcher-remove --wp-id 42 --user-id 5
# Verfügbare Beobachter auflisten
node {baseDir}/scripts/openproject.mjs watcher-available --wp-id 42
Beziehungen
# Alle Beziehungen auflisten (optional nach Arbeitspaket oder Typ filtern)
node {baseDir}/scripts/openproject.mjs relation-list --wp-id 42
node {baseDir}/scripts/openproject.mjs relation-list --type blocks
# Beziehungsdetails lesen
node {baseDir}/scripts/openproject.mjs relation-read --id 5
# Eine Beziehung erstellen (Typen: relates, duplicates, blocks, precedes, follows, includes, partof, requires)
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type blocks
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type precedes --lag 2
# Eine Beziehung aktualisieren
node {baseDir}/scripts/openproject.mjs relation-update --id 5 --type follows --lag 1
# Eine Beziehung löschen (erfordert --confirm)
node {baseDir}/scripts/openproject.mjs relation-delete --id 5 --confirm
Wiki-Seiten
# Eine Wiki-Seite lesen
node {baseDir}/scripts/openproject.mjs wiki-read --id 72
# Anhänge einer Wiki-Seite auflisten
node {baseDir}/scripts/openproject.mjs wiki-attachment-list --id 72
# Einen Anhang zu einer Wiki-Seite hochladen
node {baseDir}/scripts/openproject.mjs wiki-attachment-add --id 72 --file ./diagramm.png
Referenzdaten
# Arbeitspaket-Typen auflisten
node {baseDir}/scripts/openproject.mjs type-list
# Prioritäten auflisten
node {baseDir}/scripts/openproject.mjs priority-list
# Projektmitglieder auflisten
node {baseDir}/scripts/openproject.mjs member-list --project mein-projekt
# Versionen/Meilensteine auflisten
node {baseDir}/scripts/openproject.mjs version-list --project mein-projekt
# Kategorien auflisten
node {baseDir}/scripts/openproject.mjs category-list --project mein-projekt
Sicherheit
- API-Token-Authentifizierung (Basic Auth mit
apikeyals Benutzername) - Keine Geheimnisse oder Token werden auf der Standardausgabe ausgegeben
- Alle Löschoperationen erfordern das explizite
--confirm-Flag - Schutz vor Pfad-Traversal bei Datei-Uploads
- Integriertes Rate-Limiting mit exponentiellem Backoff-Retry
- Lazy-Konfigurationsvalidierung (wird nur geprüft, wenn ein Befehl ausgeführt wird)
Abhängigkeiten
commander— CLI-Frameworkdotenv— Laden von Umgebungsvariablen- Node.js integriertes
fetch(erfordert Node >= 18)
Autor
Abdelkrim BOUJRAF — ALT-F1 SRL, Brüssel 🇧🇪 🇲🇦 X: @altf1be