Comandos
O Mercado Pago CLI disponibiliza comandos para operar nossos principais produtos integráveis diretamente pelo terminal. Confira os comandos disponíveis por produto, como utilizá-los e a referência completa de cada um.
Comandos por produto
| Comando | Disponibilidade por produto(s) |
mpcli payments, mpcli cards | Checkout API |
mpcli advanced-payments | Checkout API |
mpcli preferences | Checkout Pro |
mpcli orders | Checkout Pro Checkout API |
mpcli merchant-orders | Marketplace |
mpcli subscriptions, mpcli subscription-plans | Assinaturas |
mpcli pos, mpcli stores | Point código QR |
mpcli shipping | Envios |
mpcli chargebacks | Todos os produtos. |
mpcli reports releases, mpcli reports settlements | Todos os produtos. |
mpcli oauth | Todos os produtos. |
Como usar os comandos
Todos os comandos do CLI seguem o padrão mpcli [recurso] [ação] [flags]. Você pode consultar as opções disponíveis de qualquer comando utilizando a flag --help:
bash
mpcli --help mpcli payments --help
Formato de saída
Por padrão, todos os comandos retornam um JSON:
bash
mpcli payments list # { "status": "success", "data": { "results": [...] } }
Para uma saída tabular legível, utilize a flag --table. Confira um exemplo a seguir:
text
$ mpcli payments list --table ID STATUS AMOUNT METHOD DATE 12345678 approved $ 99.90 account_money 2025-01-01T...
Flags globais
Qualquer comando aceita as seguintes flags para controlar o formato de saída, autenticação ou determinado comportamento interativo. Consulte os detalhes de cada uma a seguir:
| Flag | Atalho | Descrição |
--table | — | Saída tabular formatada. |
--silent | -s | Suprimir spinners e cores ANSI. |
--verbose | -v | Exibir headers HTTP. |
--profile | -p | Perfil de credenciais a usar. |
--idempotency-key | — | Chave de idempotência para POST/PUT. |
--data | — | Corpo da requisição via arquivo JSON (@payload.json). |
--no-interactive | — | Desabilitar prompts (CI/CD). |
--no-color | — | Desabilitar saída colorida. |
Exit codes
Em scripts e pipelines, o Mercado Pago CLI retorna um código de saída ao final de cada execução. Use esses valores para tratar erros de forma programática:
| Código | Significado |
0 | Sucesso. |
1 | Erro geral. |
2 | Erro de autenticação. |
3 | Erro de validação. |
4 | Rate limit. |
mpcli docs [produto] — por exemplo, mpcli docs payments.