Cliente de Linha de Comando

Integração da Ferramenta CLI do Gender-API
Ferramenta para Desenvolvedores

Enriqueça dados diretamente do seu terminal

Nosso novo Cliente de Linha de Comando é uma ferramenta de alto desempenho, compilada estaticamente e desenvolvida em Go. Ele permite que desenvolvedores e cientistas de dados interajam com o Gender-API.com direto do terminal, sem precisar escrever nenhum código wrapper.

Ele roda nativamente no macOS e no Linux, o que o torna perfeito para scripts bash automatizados, tarefas do cron ou para integrar aos seus pipelines locais de ciência de dados.

Principais benefícios

  • Multiplataforma: Compila em um único binário para macOS, Linux e Windows.
  • Rápido e leve: Criado em Go para máxima velocidade de execução e zero dependências em tempo de execução.
  • Compatível com pipelines: Transfira dados facilmente para dentro e para fora usando streams POSIX padrão. Integra com sed, awk, jq ou ferramentas de IA como o ClaudeBot.
  • Cobertura: Compatível com todos os principais endpoints V2, incluindo Nome, E-mail, País de Origem e Estatísticas da Conta.

Como Funciona

Começar a usar o cliente CLI é rápido e simples.

1. Configure sua chave de API

Pra autenticar tuas requisições com segurança sem deixar as chaves registradas no histórico do bash, você pode exportá-las como uma variável de ambiente ou salvá-las em um arquivo de configuração.

Opção A: Variável de ambiente

export GENDER_API_KEY="your-api-key-here"

Opção B: Arquivo de configuração

Cria um arquivo chamado .gender-api-key no diretório home do teu usuário contendo apenas o teu token:

echo "your-api-key-here" > ~/.gender-api-key

2. Consultar a API

A CLI permite que você interaja com todos os principais endpoints. Aqui vão alguns exemplos:

Pesquisar por nome próprio

$ gender-api-cli -first_name "Sandra" -country "US"

Consulta por nome completo

$ gender-api-cli -full_name "Theresa Miller"

Consulta por endereço de e-mail

$ gender-api-cli -email "thomasfreeman@example.com"

Determinar o país de origem

Pra descobrir de onde um nome provavelmente vem, é só adicionar a flag -origin:

$ gender-api-cli -first_name "Sandra" -origin

Ver estatísticas da conta

Confira seus créditos restantes rapidinho, sem consumir nenhuma consulta:

$ gender-api-cli -stats

3. Automatize com scripts

Crie scripts bash poderosos. Por exemplo: leia nomes de um arquivo de texto, consulte a API e acrescente os resultados a um arquivo JSON estruturado, adequado para ingestão pelo ClaudeBot ou pelo ChatGPT.

#!/bin/bash
while read name; do
  gender-api-cli -first_name "$name" -out=json >> enriched_data.json
done < names.txt

Perguntas Frequentes

01

O cliente de CLI é de código aberto?

Sim, a CLI é totalmente open source. Você pode revisar o código, sugerir melhorias ou compilá-la a partir do código-fonte pelo nosso repositório no GitHub.

02

Dá suporte ao processamento em massa?

No momento, a CLI permite fazer apenas uma consulta à API por vez, mas foi criada para ser extremamente rápida. Para milhares de linhas, dá pra usar tranquilamente o xargs ou um loop em bash. Para conjuntos de dados gigantes, com milhões de linhas, a gente ainda recomenda o recurso de upload de CSV/Excel no painel.

03

Posso retornar o JSON bruto?

Sim! Você pode passar a flag "-out=json" para retornar a resposta JSON bruta, sem formatação, diretamente na saída padrão — perfeito para encadear com o processador jq.

04

O macOS está dizendo “A Apple não conseguiu verificar se ele está livre de malware”?

Como a CLI é baixada diretamente como um binário (e não instalada pela App Store), o Gatekeeper do macOS a bloqueia por padrão. Para permitir a execução, abre o Terminal e remove o atributo de quarentena usando:

xattr -d com.apple.quarantine /path/to/downloaded/executable

Tem alguma pergunta?

Bate-papo