Skip to content

About

OpenClaw skill for OpenProject — CRUD work packages, projects, time entries, comments, attachments via API v3. Cloud + self-hosted. By Abdelkrim BOUJRAF / ALT-F1 SRL, Brussels.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

openclaw-skill-openproject

License: MIT Node.js OpenProject OpenClaw Skill ClawHub GitHub last commit GitHub issues GitHub stars

OpenClaw skill for OpenProject — CRUD work packages, projects, users, relations, time entries, comments, attachments, wiki pages, and more via OpenProject API v3. Supports both cloud and self-hosted instances.

By Abdelkrim BOUJRAF / ALT-F1 SRL, Brussels 🇧🇪 🇲🇦

Table of Contents

Features

  • Work Packages — CRUD, name/ID filters, assignment, parents, categories, target versions, scheduling, project moves and progress
  • Projects — List, read, create, update, delete, and set/remove parents
  • Users — List, search, read, invite/create, update, delete, lock/unlock and self password changes
  • Documents — List, read, update documents
  • Revisions — Read revisions, list by work package
  • Capabilities & Actions — Permission introspection, list available actions
  • My Preferences — Read and update personal preferences
  • Render — Render markdown/plain text to HTML
  • Posts — Read forum posts and attachments
  • Reminders — CRUD for work package reminders
  • Project Statuses — Read project health statuses
  • Project Phases — List definitions, read phases (Enterprise)
  • Portfolios — List, read, update, delete portfolios (Enterprise)
  • Programs — List, read, update, delete programs (Enterprise)
  • Placeholder Users — Full CRUD for virtual resource planning users (Enterprise)
  • Budgets — List and read project budgets (Enterprise)
  • Meetings — List, create, read, update, delete meetings and list/upload attachments
  • Days — Working/non-working days, week schedule, holiday calendar
  • Configuration — View instance and project configuration
  • OAuth — Read OAuth applications and client credentials
  • Help Texts — List and read attribute help texts
  • Custom Fields & Options — Browse hierarchical custom field items and option values
  • Custom Actions — Read and execute workflow automation actions on work packages
  • Groups — Full CRUD for user groups with member management
  • News — Full CRUD for project news/announcements
  • Watchers — List, add, remove watchers on work packages
  • Relations — Create, read, update, delete relations between work packages (blocks, follows, precedes, etc.)
  • Notifications — List, read, mark read/unread with filters (reason, project, work package)
  • Comments — List, add, read and edit comments
  • Attachments — List, upload, and delete
  • Time Entries — CRUD time tracking with hours, dates, and activity types
  • Statuses & Transitions — List statuses, update work package status
  • Memberships & Versions — Create, read, update, delete, and project-scoped listings
  • Reference Data — Types, priorities and categories
  • Sprints — Browse visible or project-shared sprints and read sprint details
  • Wiki Pages — Read wiki pages, list and upload attachments
  • Security — --confirm required for deletes, no secrets to stdout, rate-limit retry with backoff
  • Auth — API token (works with cloud and self-hosted)

Quick Start

# 1. Clone
git clone https://github.com/ALT-F1-OpenClaw/openclaw-skill-openproject.git
cd openclaw-skill-openproject

# 2. Install
npm install

# 3. Configure
cp .env.example .env
# Edit .env with your OpenProject URL and API token

# 4. Use
node scripts/openproject.mjs project-list
node scripts/openproject.mjs wp-list --project my-project
node scripts/openproject.mjs wp-create --project my-project --subject "My first task"

Setup

  1. Log in to your OpenProject instance
  2. Go to My Account → Access Tokens → + Add
  3. Create an API token and copy it
  4. Copy .env.example to .env and fill in:
    • OP_HOST — your OpenProject URL (e.g. https://projects.alt-f1.be)
    • OP_API_TOKEN — the API token you just created
    • OP_DEFAULT_PROJECT — (optional) default project identifier

Commands

See SKILL.md for full command reference. See API-COVERAGE.md for implemented operations and remaining gaps, and CHANGELOG.md for unreleased changes.

166 commands across 40 command groups:

Entity Commands
Work Packages wp-list, wp-create, wp-read, wp-update, wp-delete, wp-assignees, wp-projects, wp-relation-candidates
Projects project-list, project-read, project-create, project-update, project-delete, project-assignees, project-parent-candidates
Users user-list, user-read, user-me, user-create, user-update, user-delete, user-lock, user-unlock
Roles role-list, role-read
Principals principal-list
Sprints sprint-list, sprint-read
Documents document-list, document-read, document-update
Revisions revision-read, revision-list-by-wp
Capabilities capability-list, capability-global, action-list, action-read
My Preferences my-preferences-read, my-preferences-update
Render render-markdown, render-plain
Posts post-read, post-attachment-list
Reminders reminder-list, reminder-create, reminder-update, reminder-delete
Project Statuses project-status-read
Project Phases 🏢 project-phase-definition-list, project-phase-definition-read, project-phase-read
Portfolios 🏢 portfolio-list, portfolio-read, portfolio-update, portfolio-delete
Programs 🏢 program-list, program-read, program-update, program-delete
Placeholder Users 🏢 placeholder-user-list, placeholder-user-read, placeholder-user-create, placeholder-user-update, placeholder-user-delete
Budgets 🏢 budget-list, budget-read
Meetings meeting-list, meeting-create, meeting-read, meeting-update, meeting-delete, meeting-attachment-list, meeting-attachment-add
Meeting Agenda Items meeting-agenda-item-list, meeting-agenda-item-read, meeting-agenda-item-create, meeting-agenda-item-update, meeting-agenda-item-delete
Meeting Outcomes meeting-outcome-list, meeting-outcome-read, meeting-outcome-create, meeting-outcome-update, meeting-outcome-delete
Meeting Sections meeting-section-list, meeting-section-read, meeting-section-create, meeting-section-update, meeting-section-delete
Days day-read, days-list, non-working-days-list, non-working-day-read, week-days-list, week-day-read
Configuration config-read, project-config-read
OAuth oauth-app-read, oauth-credentials-read
Help Texts help-text-list, help-text-read
Custom Fields custom-field-read, custom-field-items, custom-field-item-read, custom-field-item-branch, custom-option-read
Custom Actions custom-action-read, custom-action-execute
Groups group-list, group-read, group-create, group-update, group-delete
News news-list, news-read, news-create, news-update, news-delete
Watchers watcher-list, watcher-add, watcher-remove, watcher-available
Relations relation-list, relation-read, relation-create, relation-update, relation-delete
Notifications notification-list, notification-read, notification-mark-read, notification-mark-unread
Comments comment-list, comment-add, comment-read, comment-update
Attachments attachment-list, attachment-read, attachment-add, attachment-delete
Time Entries time-list, time-read, time-create, time-update, time-delete, time-activity-read, time-projects
Wiki Pages wiki-read, wiki-attachment-list, wiki-attachment-add
Statuses/Transitions status-list, status-read + wp-update --status
Reference Data type-list, type-read, priority-list, priority-read, member-list, member-read, member-create, member-update, member-delete, version-list, version-read, version-create, version-update, version-delete, category-list, category-read

Security

  • API token auth (Basic auth with apikey as username)
  • No secrets or tokens printed to stdout
  • All delete operations require explicit --confirm flag
  • Path traversal prevention for file uploads
  • Built-in rate limiting with exponential backoff retry
  • Lazy config validation (only checked when a command runs)

ClawHub

Published as: openproject-by-altf1be

clawhub install openproject-by-altf1be

License

MIT — see LICENSE

Author

Abdelkrim BOUJRAF — ALT-F1 SRL, Brussels 🇧🇪 🇲🇦

Contributing

Contributions welcome! Please open an issue or PR.

Run the CLI regression checks with npm test after installing dependencies. The checks mock every API request and do not require an OpenProject instance or token. GitHub Actions runs syntax and regression checks on Node 18, 20, 22 and 24.

About

OpenClaw skill for OpenProject — CRUD work packages, projects, time entries, comments, attachments via API v3. Cloud + self-hosted. By Abdelkrim BOUJRAF / ALT-F1 SRL, Brussels.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages