Acapadev CLI

Ferramenta de Linha de Comandos

A Acapadev CLI é a ferramenta oficial de linha de comandos para developers que gerem Aplicações OAuth conectadas ao Single Sign-On (SSO) do Acapadev ID. Cria, lista e gere as tuas apps — incluindo Client Secrets e Webhooks — sem saíres do terminal.

Instalação

A CLI está publicada no NPM como @devkussema/acapadev-cli e requer o Node.js instalado na tua máquina. Instala-a globalmente com:

npm install -g @devkussema/acapadev-cli

Depois de instalada, o comando acapadev fica disponível globalmente no teu terminal.

Autenticação

A CLI comunica com a API do Acapadev usando um Personal Access Token (PAT), gerado no teu painel do SSO Acapadev (Secção Tokens de API). Para autenticar:

acapadev auth:login

É-te pedido que coles o token (a introdução fica oculta no terminal). A CLI valida o token contra a API imediatamente; se for válido, fica guardado localmente para todos os comandos seguintes.

Onde fica guardado o token?

A CLI usa o pacote conf para persistir a configuração local (token, nome do utilizador autenticado e ambiente selecionado) em ~/.acapadev/config.json. Este ficheiro nunca é enviado para lado nenhum além da API do Acapadev — mantém-no privado, já que o token concede acesso direto à tua conta.

Comandos Disponíveis

Comando	Descrição
`auth:login`	Autentica com o Personal Access Token (PAT).
`apps:list`	Lista todas as tuas Aplicações OAuth.
`apps:create`	Cria uma nova Aplicação OAuth.
`apps:show <id>`	Mostra os detalhes de uma Aplicação específica.
`apps:rotate-secret <id>`	Gera um novo Client Secret para a Aplicação.
`apps:webhooks <id>`	Configura o Webhook URL da Aplicação.
`apps:webhooks:rotate-secret <id>`	Gera um novo Webhook Secret para a Aplicação.
`env`	Alterna entre o ambiente local e produção.
`ping`	Testa a ligação ao servidor da API.

auth:login

Inicia o fluxo de autenticação interativo. É-te pedido para colares o teu Personal Access Token (introdução oculta). A CLI testa a ligação chamando GET /user; se o token for válido, guarda o token e o nome do utilizador autenticado na configuração local e confirma o login. Se falhar, o token não fica guardado.

acapadev auth:login

apps:list

Lista, numa tabela, todas as Aplicações OAuth que já criaste — ID, Nome e Client ID. Se ainda não tiveres nenhuma app, sugere que corras apps:create.

acapadev apps:list

apps:create

Cria uma nova Aplicação OAuth de forma interativa. Pede o Nome da Aplicação e o Callback URL (Redirect URI) — que tem de começar por http ou https. No final, mostra o ID, Nome, Client ID e Redirect URI numa tabela, e o Client Secret numa caixa de destaque.

acapadev apps:create

Guarda o Client Secret imediatamente

O Client Secret só é mostrado uma vez, no momento da criação. Se o perderes, tens de usar apps:rotate-secret para gerar um novo.

apps:show <id>

Mostra os detalhes completos de uma Aplicação a partir do seu id: Nome, Client ID, Redirect URI, Webhook URL (ou "Não configurado") e a data de criação.

acapadev apps:show <ID_DA_APP>

apps:rotate-secret <id>

Gera um novo Client Secret para a Aplicação indicada. Pede confirmação antes de prosseguir, já que o Secret anterior deixa de funcionar imediatamente. O novo Secret é apresentado numa caixa de destaque.

acapadev apps:rotate-secret <ID_DA_APP>

apps:webhooks <id>

Configura o Webhook URL de destino da Aplicação, de forma interativa. Deixar o campo em branco desativa o webhook. No final, confirma o URL atualizado.

acapadev apps:webhooks <ID_DA_APP>

apps:webhooks:rotate-secret <id>

Gera um novo Webhook Secret para a Aplicação. Pede confirmação antes de prosseguir — as assinaturas geradas com o Webhook Secret anterior deixam de ser válidas. O novo segredo é apresentado numa caixa de destaque para usares na verificação da assinatura dos teus payloads.

acapadev apps:webhooks:rotate-secret <ID_DA_APP>

env

Alterna entre o ambiente local e produção. Mostra o ambiente atualmente configurado (por omissão, production) e pede que escolhas um novo entre production e local. A escolha fica guardada na configuração local e é usada por comandos como o ping.

acapadev env

ping

Testa a ligação ao servidor da API (https://api.acapadev.com). Útil para diagnosticar rapidamente problemas de rede ou de disponibilidade do servidor.

acapadev ping

Exemplo de Utilização Básica

# 1. Instalar a CLI globalmente
npm install -g @devkussema/acapadev-cli

# 2. Autenticar com o teu Personal Access Token
acapadev auth:login

# 3. Listar as tuas Aplicações OAuth
acapadev apps:list

# 4. Criar uma nova Aplicação
acapadev apps:create

# 5. Testar a ligação à API
acapadev ping

← Acapadev SDK Acapadev MCP →