OpenProject by @altf1be
OpenProjectのワークパッケージ、プロジェクト、グループ、ニュース、ユーザー、ウォッチャー、リレーション、通知、時間エントリー、コメント、添付ファイル、Wikiページ、ワークフロートランジションをAPI v3で管理します。クラウド版とセルフホスト版の両方で動作します。
セットアップ
- 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 "Fix login bug" --description "Users can't log in"
# ワークパッケージの詳細を読み取り
node {baseDir}/scripts/openproject.mjs wp-read --id 42
# ワークパッケージを更新
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --subject "New title" --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 "My Project" --identifier my-project
コメント(アクティビティ)
# ワークパッケージのコメントを一覧表示
node {baseDir}/scripts/openproject.mjs comment-list --wp-id 42
# コメントを追加
node {baseDir}/scripts/openproject.mjs comment-add --wp-id 42 --body "Ready for review"
添付ファイル
# ワークパッケージの添付ファイルを一覧表示
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 "Code review" --activity-id 1
# 時間エントリーを更新
node {baseDir}/scripts/openproject.mjs time-update --id 5 --hours 3 --comment "Updated"
# 時間エントリーを削除(--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 "In progress"
ユーザー
# すべてのユーザーを一覧表示(オプションのフィルターあり)
node {baseDir}/scripts/openproject.mjs user-list
node {baseDir}/scripts/openproject.mjs user-list --status active --name "John"
# ユーザーの詳細を読み取り
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 "Updated 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 "**bold** and _italic_"
node {baseDir}/scripts/openproject.mjs render-plain --text "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 "Check status"
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 "Q1 Portfolio"
# ポートフォリオを削除(--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 "Platform Program"
# プログラムを削除(--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 "Future Developer"
# プレースホルダーユーザーを更新
node {baseDir}/scripts/openproject.mjs placeholder-user-update --id 10 --name "Senior Developer"
# プレースホルダーユーザーを削除(--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 "Dev Team" --members 5,6,7
# グループを更新(メンバーリストを置き換える)
node {baseDir}/scripts/openproject.mjs group-update --id 3 --name "Engineering" --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 Released" --summary "Bug fixes and performance" --description "Full details here..."
# ニュース項目を更新
node {baseDir}/scripts/openproject.mjs news-update --id 5 --title "Updated headline"
# ニュース項目を削除(--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を使用したBasic認証) - シークレットやトークンは標準出力に出力されません
- すべての削除操作には明示的な
--confirmフラグが必要です - ファイルアップロード時のパストラバーサル防止
- 指数バックオフリトライによる組み込みのレート制限
- 遅延設定検証(コマンド実行時にのみチェック)
依存関係
commander— CLIフレームワークdotenv— 環境変数の読み込み- Node.js組み込みの
fetch(Node >= 18 が必要)
作成者
Abdelkrim BOUJRAF — ALT-F1 SRL、ブリュッセル 🇧🇪 🇲🇦 X: @altf1be