Referencia

precaución

La CLI de Debi está en beta. Esta página cubre los comandos de tooling. Los flags exactos pueden cambiar; usá debi <comando> --help.

Los comandos de recursos (debi customers list, debi payments create, …) se generan desde la spec OpenAPI. Acá documentamos lo que la spec no explica: auth, entornos, HTTP genérico, eventos y listen.

Flags globales

Disponibles en todos los comandos:

Flag	Uso
`--api-key`	Secret key para este comando
`--test` / `--live`	Sandbox (`api.debi-test.pro`) o producción (`api.debi.pro`)
`--profile`	Perfil de config
`--api-version`	Header `Api-Version`
`--json`	JSON crudo (útil para `jq`)
`--verbose`	Loguea requests a stderr (también `DEBI_DEBUG=1`)
`--no-color`	Sin color

Resolución de la key, en orden: --api-key → DEBI_API_KEY → keychain del perfil activo.

Auth y perfiles

debi login                         # guarda sk_test_... / sk_live_... en el keychain
debi login --api-key sk_test_...
debi logout                        # saca la key del perfil activo
debi config list
debi config use prod
debi --profile prod login
debi config set api_version 2025-10-02

HTTP genérico

debi get /v1/customers -d limit=5
debi get /v1/customers --auto-paginate
debi post /v1/customers -d name="Jane Doe" -d email=jane@example.com
debi put /v1/customers/CSxxxx -d email=new@example.com
debi delete /v1/links/LKxxxx

-d key=value manda un string; -d key:=json manda JSON crudo (números, booleanos, objetos). Las keys con punto arman objetos anidados:

debi post /v1/payments -d amount:=1600 -d currency=ARS -d metadata.order_id=123

Eventos y `listen`

Debi no pushea eventos al proceso CLI. El flujo local es poll + reenvío.

debi listen 4242 --webhook-secret whsec_...
debi events tail --type 'customer.*' --forward-to http://127.0.0.1:4242/ --webhook-secret whsec_...

debi events replay EVxxxx --forward-to http://127.0.0.1:3000/webhooks --webhook-secret whsec_...
debi events resend EVxxxx
debi events trigger customer.created
echo '{"id":"EV..."}' | debi events verify --webhook-secret whsec_... --signature 't=...,v1=...'

events replay reenvía el payload a localhost y no toca los webhooks registrados.
events resend pide a la API que reentregue a los endpoints reales (eventos de hasta 30 días).
events trigger corre un escenario de sandbox (customer.created, payment_method.updated) y crea objetos de verdad.

Spec

debi spec info      # fuente y versión activas
debi spec update    # baja la spec canónica y la cachea en local

La spec canónica es debipro/openapi. El binario trae un snapshot; spec update evita esperar un release cuando aparecen endpoints nuevos.

Completion

debi completion bash > /etc/bash_completion.d/debi

También hay scripts para zsh, fish y powershell.

Recursos (OpenAPI)

Un patrón, no el catálogo:

debi customers list --limit 10
debi customers create --name "Jane Doe" --email jane@example.com
debi customers retrieve CSxxxx
debi <recurso> --help

El resto de operaciones vive en la API y en debi --help.

Flags globales​

Auth y perfiles​

HTTP genérico​

Eventos y listen​

Spec​

Completion​

Recursos (OpenAPI)​