Classificação
| Campo | Valor |
|---|---|
| Natureza | normativo |
| Escopo | instalação do CLI para uso e desenvolvimento |
| Autoridade | package.json, launcher npm e pipeline de executáveis |
Requisitos
Para instalar pelo npm ou desenvolver, use Node.js 22.12.0 ou superior. Para
usar um executável standalone, o Node.js não é necessário porque o runtime já
está incorporado.
Você também precisa de uma API key pessoal do ClickUp com acesso a pelo menos um workspace. A chave só será usada na etapa de configuração.
Instale pelo npm
O pacote oficial instala o comando global:
npm install --global @promovaweb/clickupfyclickupfy --versionclickupfy --helpO launcher seleciona o executável compilado em Linux x64, macOS Intel e macOS Apple Silicon. Em outras plataformas, inclusive Windows, usa o build JavaScript incluído no pacote.
Uma versão válida na primeira linha confirma que o pacote e o launcher foram
encontrados. Se o terminal não localizar clickupfy, confira o diretório
global do npm:
npm prefix --globalnpm bin --globalO segundo comando pode não existir em versões novas do npm. Nesse caso, o
diretório de executáveis costuma ser bin dentro do prefixo em Linux e macOS.
Instale um executável standalone
Cada GitHub Release distribui archives para Linux x64, macOS Intel, macOS
Apple Silicon e Windows x64. Baixe o archive da plataforma, extraia
clickupfy ou clickupfy.exe e mova o arquivo para uma pasta presente no
PATH.
No Linux ou macOS:
chmod +x clickupfy./clickupfy --versionAntes de usar um binário baixado, confira o arquivo SHA256SUMS da mesma
release. O nome e a versão do archive precisam corresponder à plataforma
escolhida.
No macOS, o Gatekeeper pode impedir a abertura de um executável sem notarização. Confirme a origem no repositório oficial e siga a política de segurança da máquina. Não desative proteções globais para contornar o aviso.
Instale para desenvolvimento
Clone o repositório independente do ClickUpfy e execute:
npm installnpm run buildnpm linkclickupfy --versionnpm link aponta o comando global para o checkout atual. Use esse modo apenas
quando precisar desenvolver ou validar uma mudança local. Para voltar ao pacote
publicado, remova o link e reinstale a versão do npm.
Confirme a instalação
Execute três leituras sem credenciais:
clickupfy --versionclickupfy --helpclickupfy agent skill listO catálogo deve listar clickupfy-dev, clickup-issue-create,
clickup-issue-implement e clickupfy-release. A presença das skills confirma
que os assets foram empacotados junto ao CLI.
Ainda não execute comandos remotos. Primeiro configure um perfil.