由 @altf1be 提供的 OpenProject
通过 API v3 管理 OpenProject 工作包、项目、群组、新闻、用户、关注者、关联关系、通知、时间记录、评论、附件、Wiki 页面和工作流转换。适用于云托管和自托管实例。
设置
- 登录您的 OpenProject 实例
- 转到 我的账户 → 访问令牌 → + 添加
- 创建一个 API 令牌并复制它
- 设置环境变量(或在
{baseDir}中创建.env文件):
OP_HOST=https://projects.xflowdata.com
OP_API_TOKEN=your-api-token
OP_DEFAULT_PROJECT=my-project
- 安装依赖项:
cd {baseDir} && npm install
命令
工作包
# 列出工作包(可带可选过滤器)
node {baseDir}/scripts/openproject.mjs wp-list --project my-project --status open --assignee me
# 创建工作包
node {baseDir}/scripts/openproject.mjs wp-create --project my-project --type Task --subject "修复登录错误" --description "用户无法登录"
# 读取工作包详情
node {baseDir}/scripts/openproject.mjs wp-read --id 42
# 更新工作包
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --subject "新标题" --priority High
# 删除工作包(需要 --confirm)
node {baseDir}/scripts/openproject.mjs wp-delete --id 42 --confirm
项目
# 列出所有项目
node {baseDir}/scripts/openproject.mjs project-list
# 读取项目详情
node {baseDir}/scripts/openproject.mjs project-read --id my-project
# 创建项目
node {baseDir}/scripts/openproject.mjs project-create --name "我的项目" --identifier my-project
评论(活动)
# 列出工作包上的评论
node {baseDir}/scripts/openproject.mjs comment-list --wp-id 42
# 添加评论
node {baseDir}/scripts/openproject.mjs comment-add --wp-id 42 --body "准备评审"
附件
# 列出工作包上的附件
node {baseDir}/scripts/openproject.mjs attachment-list --wp-id 42
# 上传附件
node {baseDir}/scripts/openproject.mjs attachment-add --wp-id 42 --file ./screenshot.png
# 删除附件(需要 --confirm)
node {baseDir}/scripts/openproject.mjs attachment-delete --id 10 --confirm
时间记录
# 列出时间记录
node {baseDir}/scripts/openproject.mjs time-list --project my-project
# 记录时间
node {baseDir}/scripts/openproject.mjs time-create --wp-id 42 --hours 2.5 --comment "代码评审" --activity-id 1
# 更新时间记录
node {baseDir}/scripts/openproject.mjs time-update --id 5 --hours 3 --comment "已更新"
# 删除时间记录(需要 --confirm)
node {baseDir}/scripts/openproject.mjs time-delete --id 5 --confirm
状态与转换
# 列出所有状态
node {baseDir}/scripts/openproject.mjs status-list
# 更新工作包状态
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --status "进行中"
用户
# 列出所有用户(可带可选过滤器)
node {baseDir}/scripts/openproject.mjs user-list
node {baseDir}/scripts/openproject.mjs user-list --status active --name "张三"
# 读取用户详情
node {baseDir}/scripts/openproject.mjs user-read --id 5
# 显示当前认证用户
node {baseDir}/scripts/openproject.mjs user-me
通知
# 列出通知(所有或仅未读)
node {baseDir}/scripts/openproject.mjs notification-list
node {baseDir}/scripts/openproject.mjs notification-list --unread
node {baseDir}/scripts/openproject.mjs notification-list --reason mentioned --project 5
# 读取通知详情
node {baseDir}/scripts/openproject.mjs notification-read --id 100
# 标记为已读(单个或全部)
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
# 标记为未读
node {baseDir}/scripts/openproject.mjs notification-mark-unread --id 100
node {baseDir}/scripts/openproject.mjs notification-mark-unread --all
文档
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 "更新后标题"
修订
node {baseDir}/scripts/openproject.mjs revision-read --id 10
node {baseDir}/scripts/openproject.mjs revision-list-by-wp --wp-id 42
能力与操作
node {baseDir}/scripts/openproject.mjs capability-list --principal me
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
我的偏好
node {baseDir}/scripts/openproject.mjs my-preferences-read
node {baseDir}/scripts/openproject.mjs my-preferences-update --time-zone "Europe/Brussels" --comment-order desc
渲染
node {baseDir}/scripts/openproject.mjs render-markdown --text "**粗体** 和 _斜体_"
node {baseDir}/scripts/openproject.mjs render-plain --text "纯文本"
论坛帖子
node {baseDir}/scripts/openproject.mjs post-read --id 5
node {baseDir}/scripts/openproject.mjs post-attachment-list --id 5
提醒
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 "检查状态"
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
项目状态
node {baseDir}/scripts/openproject.mjs project-status-read --id on_track
项目阶段(企业版)
# 列出项目阶段定义
node {baseDir}/scripts/openproject.mjs project-phase-definition-list
# 读取阶段定义
node {baseDir}/scripts/openproject.mjs project-phase-definition-read --id 1
# 读取项目阶段
node {baseDir}/scripts/openproject.mjs project-phase-read --id 5
投资组合(企业版)
# 列出投资组合
node {baseDir}/scripts/openproject.mjs portfolio-list
# 读取投资组合
node {baseDir}/scripts/openproject.mjs portfolio-read --id 1
# 更新投资组合
node {baseDir}/scripts/openproject.mjs portfolio-update --id 1 --name "第一季度投资组合"
# 删除投资组合(需要 --confirm)
node {baseDir}/scripts/openproject.mjs portfolio-delete --id 1 --confirm
项目集(企业版)
# 列出项目集
node {baseDir}/scripts/openproject.mjs program-list
# 读取项目集
node {baseDir}/scripts/openproject.mjs program-read --id 1
# 更新项目集
node {baseDir}/scripts/openproject.mjs program-update --id 1 --name "平台项目集"
# 删除项目集(需要 --confirm)
node {baseDir}/scripts/openproject.mjs program-delete --id 1 --confirm
占位用户(企业版)
# 列出占位用户
node {baseDir}/scripts/openproject.mjs placeholder-user-list
# 读取占位用户
node {baseDir}/scripts/openproject.mjs placeholder-user-read --id 10
# 创建占位用户
node {baseDir}/scripts/openproject.mjs placeholder-user-create --name "未来开发者"
# 更新占位用户
node {baseDir}/scripts/openproject.mjs placeholder-user-update --id 10 --name "高级开发者"
# 删除占位用户(需要 --confirm)
node {baseDir}/scripts/openproject.mjs placeholder-user-delete --id 10 --confirm
预算(企业版)
# 列出项目预算
node {baseDir}/scripts/openproject.mjs budget-list --project my-project
# 读取预算详情
node {baseDir}/scripts/openproject.mjs budget-read --id 3
会议(企业版)
# 读取会议
node {baseDir}/scripts/openproject.mjs meeting-read --id 10
# 列出会议附件
node {baseDir}/scripts/openproject.mjs meeting-attachment-list --id 10
# 向会议上传附件
node {baseDir}/scripts/openproject.mjs meeting-attachment-add --id 10 --file ./agenda.pdf
工作日(工作日/非工作日)
# 检查某日期是否为工作日
node {baseDir}/scripts/openproject.mjs day-read --date 2026-03-18
# 列出某个日期范围内的天数
node {baseDir}/scripts/openproject.mjs days-list --from 2026-03-01 --to 2026-03-31
# 列出所有非工作日(节假日)
node {baseDir}/scripts/openproject.mjs non-working-days-list
# 查看某个非工作日
node {baseDir}/scripts/openproject.mjs non-working-day-read --date 2026-12-25
# 显示每周工作计划(哪些天是工作日)
node {baseDir}/scripts/openproject.mjs week-days-list
# 查看某个特定工作日
node {baseDir}/scripts/openproject.mjs week-day-read --day 6
配置
# 查看实例配置
node {baseDir}/scripts/openproject.mjs config-read
# 查看项目特定配置
node {baseDir}/scripts/openproject.mjs project-config-read --project my-project
OAuth
# 读取 OAuth 应用
node {baseDir}/scripts/openproject.mjs oauth-app-read --id 1
# 读取 OAuth 客户端凭据
node {baseDir}/scripts/openproject.mjs oauth-credentials-read --id 1
帮助文本
# 列出所有属性帮助文本
node {baseDir}/scripts/openproject.mjs help-text-list
# 读取帮助文本
node {baseDir}/scripts/openproject.mjs help-text-read --id 1
自定义字段与选项
# 列出层级自定义字段的项目
node {baseDir}/scripts/openproject.mjs custom-field-items --id 10
# 读取自定义字段项目
node {baseDir}/scripts/openproject.mjs custom-field-item-read --id 25
# 获取自定义字段项目的分支(祖先)
node {baseDir}/scripts/openproject.mjs custom-field-item-branch --id 25
# 读取自定义选项值
node {baseDir}/scripts/openproject.mjs custom-option-read --id 3
自定义操作
# 读取自定义操作
node {baseDir}/scripts/openproject.mjs custom-action-read --id 1
# 在工作包上执行自定义操作
node {baseDir}/scripts/openproject.mjs custom-action-execute --id 1 --wp-id 42
群组
# 列出所有群组
node {baseDir}/scripts/openproject.mjs group-list
# 读取群组详情及成员
node {baseDir}/scripts/openproject.mjs group-read --id 3
# 创建群组并添加成员
node {baseDir}/scripts/openproject.mjs group-create --name "开发团队" --members 5,6,7
# 更新群组(替换成员列表)
node {baseDir}/scripts/openproject.mjs group-update --id 3 --name "工程部" --members 5,6,7,8
# 删除群组(需要 --confirm)
node {baseDir}/scripts/openproject.mjs group-delete --id 3 --confirm
新闻
# 列出所有新闻
node {baseDir}/scripts/openproject.mjs news-list
# 读取新闻详情
node {baseDir}/scripts/openproject.mjs news-read --id 5
# 创建新闻项目
node {baseDir}/scripts/openproject.mjs news-create --project my-project --title "Sprint 12 发布" --summary "错误修复与性能改进" --description "完整详情请点击..."
# 更新新闻项目
node {baseDir}/scripts/openproject.mjs news-update --id 5 --title "更新后的标题"
# 删除新闻项目(需要 --confirm)
node {baseDir}/scripts/openproject.mjs news-delete --id 5 --confirm
关注者
# 列出工作包上的关注者
node {baseDir}/scripts/openproject.mjs watcher-list --wp-id 42
# 添加关注者
node {baseDir}/scripts/openproject.mjs watcher-add --wp-id 42 --user-id 5
# 移除关注者
node {baseDir}/scripts/openproject.mjs watcher-remove --wp-id 42 --user-id 5
# 列出可作为关注者的用户
node {baseDir}/scripts/openproject.mjs watcher-available --wp-id 42
关联关系
# 列出所有关联关系(可选按工作包或类型过滤)
node {baseDir}/scripts/openproject.mjs relation-list --wp-id 42
node {baseDir}/scripts/openproject.mjs relation-list --type blocks
# 读取关联关系详情
node {baseDir}/scripts/openproject.mjs relation-read --id 5
# 创建关联关系(类型: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
# 更新关联关系
node {baseDir}/scripts/openproject.mjs relation-update --id 5 --type follows --lag 1
# 删除关联关系(需要 --confirm)
node {baseDir}/scripts/openproject.mjs relation-delete --id 5 --confirm
Wiki 页面
# 读取 Wiki 页面
node {baseDir}/scripts/openproject.mjs wiki-read --id 72
# 列出 Wiki 页面上的附件
node {baseDir}/scripts/openproject.mjs wiki-attachment-list --id 72
# 向 Wiki 页面上传附件
node {baseDir}/scripts/openproject.mjs wiki-attachment-add --id 72 --file ./diagram.png
参考数据
# 列出工作包类型
node {baseDir}/scripts/openproject.mjs type-list
# 列出优先级
node {baseDir}/scripts/openproject.mjs priority-list
# 列出项目成员
node {baseDir}/scripts/openproject.mjs member-list --project my-project
# 列出版本/里程碑
node {baseDir}/scripts/openproject.mjs version-list --project my-project
# 列出类别
node {baseDir}/scripts/openproject.mjs category-list --project my-project
安全性
- API 令牌认证(基本认证,用户名为
apikey) - 不会将秘密或令牌输出到标准输出
- 所有删除操作都需要显式的
--confirm标志 - 文件上传的路径遍历防护
- 内置速率限制,带指数退避重试
- 惰性配置验证(仅在命令运行时检查)
依赖项
commander— CLI 框架dotenv— 环境变量加载- Node.js 内置
fetch(需要 Node >= 18)
作者
Abdelkrim BOUJRAF — ALT-F1 SRL,布鲁塞尔 🇧🇪 🇲🇦 X:@altf1be