OpenProject by @altf1be
OpenProject 작업 패키지, 프로젝트, 그룹, 뉴스, 사용자, 와처, 관계, 알림, 시간 항목, 댓글, 첨부 파일, 위키 페이지 및 워크플로 전환을 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
위키 페이지
# 위키 페이지 읽기
node {baseDir}/scripts/openproject.mjs wiki-read --id 72
# 위키 페이지의 첨부 파일 목록
node {baseDir}/scripts/openproject.mjs wiki-attachment-list --id 72
# 위키 페이지에 첨부 파일 업로드
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를 사용자 이름으로 하는 기본 인증) - 비밀 또는 토큰이 stdout에 출력되지 않음
- 모든 삭제 작업에는 명시적
--confirm플래그 필요 - 파일 업로드 시 경로 탐색 방지
- 지수 백오프 재시도가 있는 내장 속도 제한
- 지연 구성 유효성 검사 (명령이 실행될 때만 확인)
종속성
commander— CLI 프레임워크dotenv— 환경 변수 로딩- Node.js 내장
fetch(Node >= 18 필요)
작성자
Abdelkrim BOUJRAF — ALT-F1 SRL, 브뤼셀 🇧🇪 🇲🇦 X: @altf1be