Visão Geral — CLI

Ferramenta oficial de linha de comando da Nucleo Pay para desenvolvimento, testes e automações.

A Nucleo Pay CLI permite interagir com a plataforma diretamente do terminal: criar cobranças PIX, consultar status, listar webhooks e validar assinaturas — tudo sem sair do shell.

Principais capacidades

Autenticação

Token via variável de ambiente ou flag --token.

Pagamentos PIX

Crie e consulte cobranças pelo terminal.

Webhooks

Liste, cadastre e dispare eventos de teste.

Automação

Output em JSON com --json para scripts e CI/CD.

Baixar documentação (sem clonar o repositório)

Qualquer pessoa pode baixar a API da Nucleo Pay para o computador e usar em agentes de IA — sem pasta deploy-backend.

Opção 1 — Um comando no terminal (Windows)

Abra o PowerShell fora do System32 — de preferência na pasta do seu projeto ou em Documentos:

cd $env:USERPROFILE\Documents
irm https://nucleopay.com.br/install.ps1 | iex

Cria NUCLEOPAY.md + arquivos em .nucleopay/. Se você rodar em C:\Windows\System32, o script salva automaticamente em Documents\NucleoPay.

Opção 2 — macOS / Linux

curl -fsSL https://nucleopay.com.br/install.sh | sh

Opção 3 — Só o arquivo para o agente (curl manual)

curl -o NUCLEOPAY.md https://nucleopay.com.br/api/integrations/mcp/guide

CLI Python (PIX, webhooks + init)

Com a CLI instalada, baixe tudo e gere contexto para IA:

python -m nucleopay_cli init
# ou só os arquivos:
python -m nucleopay_cli docs pull

Gera NUCLEOPAY.md, .nucleopay/llms.txt, manifesto e guia completo.

Instalação da CLI

Clone o repositório público e instale na sua máquina. Requisito: Python 3.10+.

git clone https://github.com/nucleocompany/Nucleo-pay-API-SERVERS.git
cd Nucleo-pay-API-SERVERS
python -m pip install -e .
# ou: python -m pip install -r requirements-mcp.txt

Repo: github.com/nucleocompany/Nucleo-pay-API-SERVERS

Verificar instalação:

python -m nucleopay_cli --version

Configuração

Defina suas credenciais como variáveis de ambiente:

# Windows PowerShell
$env:NUCLEOPAY_API_BASE_URL = "https://nucleopay.com.br"
$env:NUCLEOPAY_API_TOKEN = "seu_token_bearer"

# Linux / macOS
export NUCLEOPAY_API_BASE_URL=https://nucleopay.com.br
export NUCLEOPAY_API_TOKEN=seu_token_bearer

Primeiros passos

Configure o token
Exporte NUCLEOPAY_API_TOKEN com um token criado no painel.

Crie uma cobrança PIX

python -m nucleopay_cli pix create --value 10 --title "Teste CLI"

Consulte o status

python -m nucleopay_cli pix status --charge-id CHARGE_ID

Comandos disponíveis

Comando	Descrição
`nucleopay init`	Baixa docs + gera `NUCLEOPAY.md` para agentes de IA
`nucleopay docs pull`	Baixa llms.txt, manifesto e guia para `.nucleopay/`
`nucleopay pix create`	Cria cobrança PIX (`--value`, `--title`)
`nucleopay pix status`	Consulta status (`--charge-id`)
`nucleopay pix list`	Lista cobranças recentes (`--limit`)
`nucleopay webhooks list`	Lista webhooks cadastrados
`nucleopay webhooks create`	Cadastra webhook (`--url`, `--events`)
`nucleopay webhooks test`	Envia evento de teste (`--id`)
`nucleopay verify-signature`	Valida assinatura HMAC de um payload

Exemplo com JSON (scripts)

python -m nucleopay_cli pix create --value 49.9 --title "Produto" --json

Design e filosofia

A Nucleo Pay CLI foi projetada para ser:

Explícita — sem mágica escondida
Scriptável — output estruturado com --json
Compatível com CI/CD — flags não-interativas
Leve — depende apenas da stdlib Python + cliente HTTP interno

GitHub

Código da CLI, MCP e documentação Markdown.

SDKs

Clientes e bibliotecas para outras linguagens.

MCP Server

Integração com Cursor, Claude e Trae.