CLI
config_set(key=typer.Argument(..., help='A chave de configuração (ex: name, city, key).'), value=typer.Argument(..., help='O valor a ser salvo.'))
Define e salva um par chave/valor na configuração padrão da aplicação.
Use este comando para salvar valores que você usa com frequência, como seu nome, cidade ou chave PIX principal. Uma vez salvas, essas configurações serão usadas como padrão em outros comandos, evitando que você precise digitá-las toda vez.
As chaves de configuração válidas são: 'name', 'city' e 'key'.
Exemplos de uso:
-
Salvar seu nome padrão: $ pixcore config set name "Meu Nome Completo"
-
Salvar sua chave PIX principal: $ pixcore config set key "minha-chave-aleatoria"
Source code in src\pixcore\cli.py
config_show()
Exibe as configurações atuais salvas em uma tabela.
Este comando lê o arquivo de configuração e mostra os valores padrão que estão sendo utilizados pela aplicação. É útil para verificar quais dados estão configurados antes de gerar novos códigos PIX.
Exemplo de uso:
- Ver as configurações salvas: $ pixcore config show
Source code in src\pixcore\cli.py
decode(payload=typer.Argument(..., help='A string do payload BR Code a ser decodificada.'))
Decodifica um payload PIX ('Copia e Cola') e exibe seus dados de forma legível.
Este comando é útil para verificar a integridade e o conteúdo de um código PIX. Ele recebe a string do payload, valida seu código de verificação (CRC16) e, se válido, extrai e exibe todas as informações em uma tabela organizada, como nome do recebedor, valor, chave e cidade.
Exemplo de uso:
- Decodificar um payload recebido: $ pixcore decode "00020126580014br.gov.bcb.pix0136..."
Source code in src\pixcore\cli.py
help_callback(value)
Exibe a tela de ajuda customizada e encerra.
Source code in src\pixcore\cli.py
lote(arquivo_csv=typer.Argument(..., help='Caminho para o arquivo CSV com os dados.'), diretorio_saida=typer.Argument(..., help='Diretório onde os QR Codes serão salvos.'), key=typer.Option(None, '--key', '-k', help='Chave PIX padrão (usada se não especificada no CSV).'), name=typer.Option(None, '--name', '-n', help='Nome do beneficiário padrão (usado se não especificado no CSV).'), city=typer.Option(None, '--city', '-c', help='Cidade padrão do beneficiário (usada se não especificada no CSV).'))
Processa um arquivo CSV para gerar múltiplos QR Codes PIX de uma só vez.
Este comando é ideal para casos de uso que exigem a geração de cobranças em massa. Ele lê um arquivo CSV, onde cada linha representa um PIX a ser gerado, e salva os QR Codes resultantes em um diretório de saída.
O arquivo CSV deve conter, no mínimo, as colunas: valor e txid.
Outras colunas como chave, nome, cidade, info_adicional, cep e mcc
podem ser incluídas para sobrescrever os valores padrão. Se chave, nome ou cidade
não estiverem no CSV, serão usados os valores passados como opção ou do arquivo de configuração.
Os arquivos de imagem gerados serão nomeados com o valor da coluna 'txid' de cada linha
(ex: [txid].png).
Exemplo de uso:
- Gerar QR Codes a partir de 'cobrancas.csv' e salvar na pasta 'qrcodes/': $ pixcore lote "cobrancas.csv" "qrcodes/" --name "Minha Empresa" --city "RIO DE JANEIRO" --key "meu-cnpj"
Source code in src\pixcore\cli.py
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 | |
panel(titulo, mensagem, color='red')
Cria um painel formatado para exibição de mensagens.
Source code in src\pixcore\cli.py
payload(key=typer.Option(None, '--key', '-k', help='Chave PIX (CPF/CNPJ, e-mail, celular ou aleatória).'), name=typer.Option(None, '--name', '-n', help='Nome do beneficiário.'), city=typer.Option(None, '--city', '-c', help='Cidade do beneficiário (maiúsculas, sem acentos).'), amount=typer.Option(None, '--amount', '-a', help='Valor da transação. Ex: 10.50'), txid=typer.Option('***', '--txid', '-t', help='ID da transação (Transaction ID).'), info=typer.Option(None, '--info', '-i', help='Informações adicionais para o pagador.'), cep=typer.Option(None, '--cep', help='CEP do beneficiário (formato XXXXXXXX).'), mcc=typer.Option('0000', '--mcc', help='Merchant Category Code (Código da Categoria do Comerciante).'), initiation_method=typer.Option(None, '--initiation-method', help="Método de iniciação (ex: '11' para estático, '12' para dinâmico)."), language=typer.Option(None, '--lang', help='Idioma de preferência para dados alternativos (ex: pt_BR, en_US).'), alt_name=typer.Option(None, '--alt-name', help='Nome alternativo do beneficiário (em outro idioma).'), alt_city=typer.Option(None, '--alt-city', help='Cidade alternativa do beneficiário (em outro idioma).'))
Gera e exibe o payload PIX no formato 'Copia e Cola' (BR Code TLV).
Este comando monta a string de pagamento completa, que pode ser copiada e colada em um aplicativo de banco para efetuar o pagamento. É a base para a geração do QR Code.
Se os dados essenciais (chave, nome, cidade) não forem fornecidos através das opções ou de um arquivo de configuração, o comando solicitará interativamente que sejam digitados.
Exemplos de uso:
-
Gerar um payload com valor definido: $ pixcore payload --key "seu-email@exemplo.com" --name "Nome Completo" --city "SAO PAULO" --amount 19.99
-
Gerar um payload com valor aberto (a ser digitado pelo pagador): $ pixcore payload -k "12345678900" -n "Nome Completo" -c "SAO PAULO" --txid "PEDIDO123"
Source code in src\pixcore\cli.py
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | |
qrcode(output=typer.Option(None, '--output', '-o', help="Caminho e nome do arquivo de saída (ex: 'output/pix.png')."), key=typer.Option(None, '--key', '-k', help='Chave PIX (CPF/CNPJ, e-mail, celular ou aleatória).'), name=typer.Option(None, '--name', '-n', help='Nome do beneficiário.'), city=typer.Option(None, '--city', '-c', help='Cidade do beneficiário (maiúsculas, sem acentos).'), amount=typer.Option(None, '--amount', '-a', help='Valor da transação. Ex: 10.50'), txid=typer.Option('***', '--txid', '-t', help='ID da transação (Transaction ID).'), info=typer.Option(None, '--info', '-i', help='Informações adicionais para o pagador.'), cep=typer.Option(None, '--cep', help='CEP do beneficiário (formato XXXXXXXX).'), mcc=typer.Option('0000', '--mcc', help='Merchant Category Code (Código da Categoria do Comerciante).'), initiation_method=typer.Option(None, '--initiation-method', help="Método de iniciação (ex: '11' para estático, '12' para dinâmico)."), language=typer.Option(None, '--lang', help='Idioma de preferência para dados alternativos (ex: pt_BR, en_US).'), alt_name=typer.Option(None, '--alt-name', help='Nome alternativo do beneficiário (em outro idioma).'), alt_city=typer.Option(None, '--alt-city', help='Cidade alternativa do beneficiário (em outro idioma).'), caminho_logo=typer.Option(None, '--logo', '-l', help='Caminho para um arquivo de imagem (ex: pasta/logo.png)'))
Gera um QR Code PIX, salvando em arquivo ou exibindo na tela.
Este comando cria a imagem do QR Code a partir dos dados fornecidos. Possui dois modos de operação:
-
Padrão: Se a opção '--output' não for usada, a imagem do QR Code será aberta no visualizador de imagens padrão do seu sistema operacional.
-
Salvar em arquivo: Ao usar a opção '--output', a imagem é salva no caminho especificado. O formato é inferido pela extensão do arquivo (ex: .png).
É possível customizar o QR Code, por exemplo, adicionando um logo no centro.
Exemplos de uso:
-
Gerar e exibir um QR Code simples na tela: $ pixcore qrcode -k "chave-pix" -n "Nome" -c "CIDADE" -a 50.00
-
Salvar um QR Code com logo em um arquivo específico: $ pixcore qrcode -k "chave-pix" -n "Nome" -c "CIDADE" -a 123.45 --logo "logo.png" --output "pix_pagamento.png"
Source code in src\pixcore\cli.py
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 | |