CLI Commands
CLI Overview
Complete reference for all pixcli commands and global options
Command Tree
pixcli
├── balance Show account balance
├── charge
│ ├── create Create a new Pix charge
│ ├── get <txid> Get charge details
│ └── list List recent charges
├── pix
│ ├── list List received Pix transactions
│ └── get <e2eid> Get transaction details
├── qr
│ ├── generate Generate a static Pix QR code
│ └── decode Decode a BR Code payload
├── webhook
│ ├── register Register a webhook URL
│ ├── get Get webhook for a key
│ ├── remove Remove a webhook
│ └── listen Start local webhook listener
└── config
├── init Interactive setup wizard
└── show Show current configurationGlobal Flags
These flags work with any command:
| Flag | Short | Default | Description |
|---|---|---|---|
--profile <name> | -p | From config | PSP profile to use |
--output <format> | -o | human | Output format |
--sandbox | — | false | Force sandbox environment |
--verbose | -v | false | Enable debug logging |
--quiet | -q | false | Suppress non-essential output |
Output Formats
pixcli supports three output formats:
Human (default)
Colored, formatted output for terminal use:
pixcli balance💰 Account Balance
Available: R$1,250.00JSON
Machine-readable JSON output, ideal for scripting:
pixcli balance --output json{
"available": "1250.00"
}Table
Structured table output for lists:
pixcli charge list --output table┌──────────────┬─────────┬────────┬─────────────────────┐
│ TxID │ Amount │ Status │ Created │
├──────────────┼─────────┼────────┼─────────────────────┤
│ abc123def456 │ R$25.00 │ ATIVA │ 2026-03-19T10:00:00 │
│ xyz789ghi012 │ R$50.00 │ PAGA │ 2026-03-18T15:30:00 │
└──────────────┴─────────┴────────┴─────────────────────┘Exit Codes
| Code | Meaning |
|---|---|
0 | Success |
1 | General error (invalid config, network failure, etc.) |
2 | Invalid arguments or usage error |