Configuração segura de API keys e accounts no ClickUpfy

Classificação

Crie a API key

Use uma API key pessoal criada nas configurações do ClickUp. O ClickUpfy valida a chave antes de salvar, consulta o usuário autenticado e lista os workspaces permitidos.

Não cole a chave em issue, comentário, arquivo .env versionado, .mcp.json ou comando compartilhado no histórico da equipe. Em um terminal interativo, prefira o setup com prompt oculto:

1
clickupfy setup

Escolha um nome local para o perfil e selecione o workspace. O nome vira um identificador normalizado, como promovaweb ou cliente-a.

Automatize o setup quando necessário

Em uma automação isolada, o setup aceita parâmetros:

1
clickupfy setup \
2
  --api-key "pk_..." \
3
  --name "Promovaweb" \
4
  --workspace "123456" \
5
  --non-interactive

Evite colocar a chave diretamente em um script. Leia o valor de um secret manager ou de uma variável protegida e apague o ambiente temporário depois da execução.

Entenda o arquivo local

Por padrão, a configuração fica em:

1
~/.promovaweb-clickupfy/config.json

O diretório recebe permissão 0700 e o arquivo 0600. A API key precisa estar no JSON porque o CLI autentica chamadas futuras. Essa proteção limita a leitura ao usuário local, mas não substitui os cuidados com backup, malware ou pastas sincronizadas.

O schema permite vários accounts:

1
{
2
  "version": 1,
3
  "activeAccount": "promovaweb",
4
  "accounts": {
5
    "promovaweb": {
6
      "name": "Promovaweb",
7
      "apiKey": "pk_...",
8
      "user": {
9
        "id": 123,
10
        "username": "Desenvolvedor"
11
      },
12
      "workspace": {
13
        "id": "456",
14
        "name": "Engenharia"
15
      },
16
      "createdAt": "2026-07-29T12:00:00.000Z",
17
      "updatedAt": "2026-07-29T12:00:00.000Z"
18
    }
19
  }
20
}

Gerencie accounts

Use comandos que mascaram a API key:

1
clickupfy account list
2
clickupfy account show
3
clickupfy status
4
clickupfy whoami

status mostra o caminho da configuração, o account resolvido e o workspace. whoami faz uma chamada autenticada e confirma se a chave ainda é válida.

Para trocar o perfil ativo:

1
clickupfy account use cliente-a

Para usar outro account em um único comando, sem alterar o ativo:

1
clickupfy --account cliente-a task get 86abc123

A variável PROMOVAWEB_CLICKUPFY_ACCOUNT oferece a mesma seleção em automações. A variável PROMOVAWEB_CLICKUPFY_CONFIG aponta para outro JSON e é útil em testes ou ambientes efêmeros.

Troque o workspace associado

Liste os workspaces autorizados e escolha um deles:

1
clickupfy workspace list
2
clickupfy workspace use 123456

Essa ação altera o workspace do account atual. Configurações de projeto que fixam --workspace precisam continuar correspondendo ao perfil.

Remova um perfil

1
clickupfy account remove cliente-antigo

O CLI pede confirmação. Em automação, --yes confirma sem prompt. A remoção apaga o perfil local, não revoga a API key no ClickUp. Revogue a chave no ClickUp quando ela não for mais necessária.

Com o perfil validado, prepare o primeiro projeto.