Communitygithub.com

OpenProject CRUD (por @altf1be)

Habilidade CRUD para OpenProject — gerencie pacotes de trabalho, projetos, grupos, notícias, usuários, observadores, relações, notificações, horas lançadas, comentários, anexos, páginas wiki, status e muito mais via API v3 com autenticação por token. Suporta instâncias cloud e auto-hospedadas.

O que é OpenProject CRUD (por @altf1be)?

Esta habilidade permite que agentes de IA (como Claude Code, Cursor, Codex) executem operações CRUD completas no OpenProject através de sua API v3. Ela cobre desde pacotes de trabalho e projetos até recursos empresariais como portfólios, programas, orçamentos, reuniões e fases de projeto. A autenticação é baseada em token API (Basic auth com `apikey` como usuário) e suporta tanto instâncias OpenProject cloud quanto auto-hospedadas. A habilidade inclui proteções de segurança como confirmação obrigatória para operações de exclusão, prevenção de path traversal em uploads e limitação de taxa com retry exponencial. É implementada em Node.js com as dependências `commander` e `dotenv`, necessitando Node >= 18. Ideal para automatizar fluxos de trabalho de gerenciamento de projetos, integração com CI/CD ou assistência contextual em tarefas do dia a dia.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add ALT-F1-OpenClaw/openclaw-skill-openproject

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

OpenProject por @altf1be

Gerencie pacotes de trabalho, projetos, grupos, notícias, usuários, observadores, relações, notificações, horas lançadas, comentários, anexos, páginas wiki e transições de workflow no OpenProject através da API v3. Funciona tanto com instâncias cloud quanto auto-hospedadas.

Configuração

  1. Faça login na sua instância OpenProject
  2. Vá para Minha Conta → Tokens de Acesso → + Adicionar
  3. Crie um token API e copie-o
  4. Defina as variáveis de ambiente (ou crie um arquivo .env em {baseDir}):
OP_HOST=https://projects.xflowdata.com
OP_API_TOKEN=seu-token-api
OP_DEFAULT_PROJECT=meu-projeto
  1. Instale as dependências: cd {baseDir} && npm install

Comandos

Pacotes de Trabalho

# Listar pacotes de trabalho (com filtros opcionais)
node {baseDir}/scripts/openproject.mjs wp-list --project meu-projeto --status aberto --assignee eu

# Criar um pacote de trabalho
node {baseDir}/scripts/openproject.mjs wp-create --project meu-projeto --type Tarefa --subject "Corrigir bug de login" --description "Usuários não conseguem fazer login"

# Ler detalhes de um pacote de trabalho
node {baseDir}/scripts/openproject.mjs wp-read --id 42

# Atualizar um pacote de trabalho
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --subject "Novo título" --priority Alta

# Excluir um pacote de trabalho (requer --confirm)
node {baseDir}/scripts/openproject.mjs wp-delete --id 42 --confirm

Projetos

# Listar todos os projetos
node {baseDir}/scripts/openproject.mjs project-list

# Ler detalhes de um projeto
node {baseDir}/scripts/openproject.mjs project-read --id meu-projeto

# Criar um projeto
node {baseDir}/scripts/openproject.mjs project-create --name "Meu Projeto" --identifier meu-projeto

Comentários (Atividades)

# Listar comentários em um pacote de trabalho
node {baseDir}/scripts/openproject.mjs comment-list --wp-id 42

# Adicionar um comentário
node {baseDir}/scripts/openproject.mjs comment-add --wp-id 42 --body "Pronto para revisão"

Anexos

# Listar anexos em um pacote de trabalho
node {baseDir}/scripts/openproject.mjs attachment-list --wp-id 42

# Enviar um anexo
node {baseDir}/scripts/openproject.mjs attachment-add --wp-id 42 --file ./screenshot.png

# Excluir um anexo (requer --confirm)
node {baseDir}/scripts/openproject.mjs attachment-delete --id 10 --confirm

Horas Lançadas

# Listar horas lançadas
node {baseDir}/scripts/openproject.mjs time-list --project meu-projeto

# Lançar horas
node {baseDir}/scripts/openproject.mjs time-create --wp-id 42 --hours 2.5 --comment "Revisão de código" --activity-id 1

# Atualizar horas lançadas
node {baseDir}/scripts/openproject.mjs time-update --id 5 --hours 3 --comment "Atualizado"

# Excluir horas lançadas (requer --confirm)
node {baseDir}/scripts/openproject.mjs time-delete --id 5 --confirm

Status e Transições

# Listar todos os status
node {baseDir}/scripts/openproject.mjs status-list

# Atualizar status de um pacote de trabalho
node {baseDir}/scripts/openproject.mjs wp-update --id 42 --status "Em andamento"

Usuários

# Listar todos os usuários (com filtros opcionais)
node {baseDir}/scripts/openproject.mjs user-list
node {baseDir}/scripts/openproject.mjs user-list --status ativo --name "João"

# Ler detalhes de um usuário
node {baseDir}/scripts/openproject.mjs user-read --id 5

# Mostrar o usuário autenticado atual
node {baseDir}/scripts/openproject.mjs user-me

Notificações

# Listar notificações (todas ou apenas não lidas)
node {baseDir}/scripts/openproject.mjs notification-list
node {baseDir}/scripts/openproject.mjs notification-list --unread
node {baseDir}/scripts/openproject.mjs notification-list --reason mencionado --project 5

# Ler detalhes de uma notificação
node {baseDir}/scripts/openproject.mjs notification-read --id 100

# Marcar como lida (individual ou todas)
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

# Marcar como não lida
node {baseDir}/scripts/openproject.mjs notification-mark-unread --id 100
node {baseDir}/scripts/openproject.mjs notification-mark-unread --all

Documentos

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 "Título atualizado"

Revisões

node {baseDir}/scripts/openproject.mjs revision-read --id 10
node {baseDir}/scripts/openproject.mjs revision-list-by-wp --wp-id 42

Capacidades e Ações

node {baseDir}/scripts/openproject.mjs capability-list --principal eu
node {baseDir}/scripts/openproject.mjs capability-global
node {baseDir}/scripts/openproject.mjs action-list
node {baseDir}/scripts/openproject.mjs action-read --id work_packages/criar

Minhas Preferências

node {baseDir}/scripts/openproject.mjs my-preferences-read
node {baseDir}/scripts/openproject.mjs my-preferences-update --time-zone "Europe/Brussels" --comment-order desc

Renderizar

node {baseDir}/scripts/openproject.mjs render-markdown --text "**negrito** e _itálico_"
node {baseDir}/scripts/openproject.mjs render-plain --text "texto simples"

Postagens (Fórum)

node {baseDir}/scripts/openproject.mjs post-read --id 5
node {baseDir}/scripts/openproject.mjs post-attachment-list --id 5

Lembretes

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 "Verificar 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

Status de Projetos

node {baseDir}/scripts/openproject.mjs project-status-read --id no_caminho_certo

Fases de Projeto (Enterprise)

# Listar definições de fase de projeto
node {baseDir}/scripts/openproject.mjs project-phase-definition-list

# Ler uma definição de fase
node {baseDir}/scripts/openproject.mjs project-phase-definition-read --id 1

# Ler uma fase de projeto
node {baseDir}/scripts/openproject.mjs project-phase-read --id 5

Portfólios (Enterprise)

# Listar portfólios
node {baseDir}/scripts/openproject.mjs portfolio-list

# Ler um portfólio
node {baseDir}/scripts/openproject.mjs portfolio-read --id 1

# Atualizar um portfólio
node {baseDir}/scripts/openproject.mjs portfolio-update --id 1 --name "Portfólio Q1"

# Excluir um portfólio (requer --confirm)
node {baseDir}/scripts/openproject.mjs portfolio-delete --id 1 --confirm

Programas (Enterprise)

# Listar programas
node {baseDir}/scripts/openproject.mjs program-list

# Ler um programa
node {baseDir}/scripts/openproject.mjs program-read --id 1

# Atualizar um programa
node {baseDir}/scripts/openproject.mjs program-update --id 1 --name "Programa Plataforma"

# Excluir um programa (requer --confirm)
node {baseDir}/scripts/openproject.mjs program-delete --id 1 --confirm

Usuários Placeholder (Enterprise)

# Listar usuários placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-list

# Ler um usuário placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-read --id 10

# Criar um usuário placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-create --name "Futuro Desenvolvedor"

# Atualizar um usuário placeholder
node {baseDir}/scripts/openproject.mjs placeholder-user-update --id 10 --name "Desenvolvedor Sênior"

# Excluir um usuário placeholder (requer --confirm)
node {baseDir}/scripts/openproject.mjs placeholder-user-delete --id 10 --confirm

Orçamentos (Enterprise)

# Listar orçamentos de projeto
node {baseDir}/scripts/openproject.mjs budget-list --project meu-projeto

# Ler detalhes de um orçamento
node {baseDir}/scripts/openproject.mjs budget-read --id 3

Reuniões (Enterprise)

# Ler uma reunião
node {baseDir}/scripts/openproject.mjs meeting-read --id 10

# Listar anexos de uma reunião
node {baseDir}/scripts/openproject.mjs meeting-attachment-list --id 10

# Enviar anexo para uma reunião
node {baseDir}/scripts/openproject.mjs meeting-attachment-add --id 10 --file ./agenda.pdf

Dias (Úteis/Não Úteis)

# Verificar se uma data é dia útil
node {baseDir}/scripts/openproject.mjs day-read --date 2026-03-18

# Listar dias em um intervalo
node {baseDir}/scripts/openproject.mjs days-list --from 2026-03-01 --to 2026-03-31

# Listar todos os dias não úteis (feriados)
node {baseDir}/scripts/openproject.mjs non-working-days-list

# Visualizar um dia não útil
node {baseDir}/scripts/openproject.mjs non-working-day-read --date 2026-12-25

# Mostrar horário semanal (quais dias são úteis)
node {baseDir}/scripts/openproject.mjs week-days-list

# Visualizar um dia específico da semana
node {baseDir}/scripts/openproject.mjs week-day-read --day 6

Configuração

# Visualizar configuração da instância
node {baseDir}/scripts/openproject.mjs config-read

# Visualizar configuração específica de um projeto
node {baseDir}/scripts/openproject.mjs project-config-read --project meu-projeto

OAuth

# Ler uma aplicação OAuth
node {baseDir}/scripts/openproject.mjs oauth-app-read --id 1

# Ler credenciais de cliente OAuth
node {baseDir}/scripts/openproject.mjs oauth-credentials-read --id 1

Textos de Ajuda

# Listar todos os textos de ajuda de atributos
node {baseDir}/scripts/openproject.mjs help-text-list

# Ler um texto de ajuda
node {baseDir}/scripts/openproject.mjs help-text-read --id 1

Campos Personalizados e Opções

# Listar itens de um campo personalizado hierárquico
node {baseDir}/scripts/openproject.mjs custom-field-items --id 10

# Ler um item de campo personalizado
node {baseDir}/scripts/openproject.mjs custom-field-item-read --id 25

# Obter o ramo (ancestrais) de um item de campo personalizado
node {baseDir}/scripts/openproject.mjs custom-field-item-branch --id 25

# Ler um valor de opção personalizada
node {baseDir}/scripts/openproject.mjs custom-option-read --id 3

Ações Personalizadas

# Ler uma ação personalizada
node {baseDir}/scripts/openproject.mjs custom-action-read --id 1

# Executar uma ação personalizada em um pacote de trabalho
node {baseDir}/scripts/openproject.mjs custom-action-execute --id 1 --wp-id 42

Grupos

# Listar todos os grupos
node {baseDir}/scripts/openproject.mjs group-list

# Ler detalhes de um grupo com membros
node {baseDir}/scripts/openproject.mjs group-read --id 3

# Criar um grupo com membros
node {baseDir}/scripts/openproject.mjs group-create --name "Time de Dev" --members 5,6,7

# Atualizar um grupo (substitui a lista de membros)
node {baseDir}/scripts/openproject.mjs group-update --id 3 --name "Engenharia" --members 5,6,7,8

# Excluir um grupo (requer --confirm)
node {baseDir}/scripts/openproject.mjs group-delete --id 3 --confirm

Notícias

# Listar todas as notícias
node {baseDir}/scripts/openproject.mjs news-list

# Ler detalhes de uma notícia
node {baseDir}/scripts/openproject.mjs news-read --id 5

# Criar uma notícia
node {baseDir}/scripts/openproject.mjs news-create --project meu-projeto --title "Sprint 12 Lançada" --summary "Correções de bugs e desempenho" --description "Detalhes completos aqui..."

# Atualizar uma notícia
node {baseDir}/scripts/openproject.mjs news-update --id 5 --title "Manchete atualizada"

# Excluir uma notícia (requer --confirm)
node {baseDir}/scripts/openproject.mjs news-delete --id 5 --confirm

Observadores

# Listar observadores em um pacote de trabalho
node {baseDir}/scripts/openproject.mjs watcher-list --wp-id 42

# Adicionar um observador
node {baseDir}/scripts/openproject.mjs watcher-add --wp-id 42 --user-id 5

# Remover um observador
node {baseDir}/scripts/openproject.mjs watcher-remove --wp-id 42 --user-id 5

# Listar usuários disponíveis como observadores
node {baseDir}/scripts/openproject.mjs watcher-available --wp-id 42

Relações

# Listar todas as relações (opcionalmente filtrar por pacote de trabalho ou tipo)
node {baseDir}/scripts/openproject.mjs relation-list --wp-id 42
node {baseDir}/scripts/openproject.mjs relation-list --type bloqueia

# Ler detalhes de uma relação
node {baseDir}/scripts/openproject.mjs relation-read --id 5

# Criar uma relação (tipos: relaciona, duplica, bloqueia, precede, segue, inclui, parte_de, requer)
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type bloqueia
node {baseDir}/scripts/openproject.mjs relation-create --wp-id 42 --to-wp-id 43 --type precede --lag 2

# Atualizar uma relação
node {baseDir}/scripts/openproject.mjs relation-update --id 5 --type segue --lag 1

# Excluir uma relação (requer --confirm)
node {baseDir}/scripts/openproject.mjs relation-delete --id 5 --confirm

Páginas Wiki

# Ler uma página wiki
node {baseDir}/scripts/openproject.mjs wiki-read --id 72

# Listar anexos em uma página wiki
node {baseDir}/scripts/openproject.mjs wiki-attachment-list --id 72

# Enviar um anexo para uma página wiki
node {baseDir}/scripts/openproject.mjs wiki-attachment-add --id 72 --file ./diagrama.png

Dados de Referência

# Listar tipos de pacote de trabalho
node {baseDir}/scripts/openproject.mjs type-list

# Listar prioridades
node {baseDir}/scripts/openproject.mjs priority-list

# Listar membros do projeto
node {baseDir}/scripts/openproject.mjs member-list --project meu-projeto

# Listar versões/marcos
node {baseDir}/scripts/openproject.mjs version-list --project meu-projeto

# Listar categorias
node {baseDir}/scripts/openproject.mjs category-list --project meu-projeto

Segurança

  • Autenticação por token API (Basic auth com apikey como nome de usuário)
  • Nenhum segredo ou token é exibido na saída padrão
  • Todas as operações de exclusão exigem a flag explícita --confirm
  • Prevenção de path traversal para uploads de arquivos
  • Limitação de taxa integrada com retry de backoff exponencial
  • Validação de configuração preguiçosa (verificada apenas quando um comando é executado)

Dependências

  • commander — framework CLI
  • dotenv — carregamento de variáveis de ambiente
  • fetch nativo do Node.js (requer Node >= 18)

Autor

Abdelkrim BOUJRAF — ALT-F1 SRL, Bruxelas 🇧🇪 🇲🇦 X: @altf1be

Habilidades Relacionadas