pixcli Documentation
CLI tool and Rust library for programmatic Pix payments in Brazil
Welcome to the pixcli documentation. pixcli is a fast, open-source command-line tool and Rust library for Brazilian Pix instant payments.
What is pixcli?
pixcli lets you interact with the Brazilian Pix payment system from your terminal. Built in Rust for speed and reliability, it supports:
- Creating charges — generate Pix cobranças with a single command
- QR code generation — static and dynamic QR codes rendered in the terminal or saved as PNG
- Balance queries — check your account balance instantly
- Transaction history — list and inspect received Pix payments
- Webhook management — register, monitor, and forward payment notifications
- MCP integration — use Pix operations from AI agents like Claude Code
Quick Links
- Installation — get pixcli installed in under a minute
- Configuration — set up your PSP credentials
- First QR Code — generate your first Pix QR code
- CLI Reference — complete command documentation
- API Reference — Rust library documentation
- MCP Server — AI agent integration
Architecture
pixcli is organized as a Rust workspace with several crates:
| Crate | Description |
|---|---|
pixcli | The CLI binary — the main entry point |
pix-core | Core Pix primitives: key validation, CRC16, BR Code encoding |
pix-efi | Efí (Gerencianet) API client with mTLS authentication |
pix-provider | Provider trait for PSP abstraction |
pix-brcode | EMV/BR Code encoder and decoder |
pix-mcp | MCP server for AI agent integration |
pix-webhook-server | Standalone webhook listener server |