Saltar para o conteúdo principal

Ainda tem dúvidas sobre o que a Badgie faz pelo seu clube? Vemo-nos numa demo.

Badgie

Badgie CLI: gira o seu clube a partir do terminal

A ferramenta oficial de linha de comandos do Badgie: instalação com npm, início de sessão, chat com o agente do clube, comandos /, modo comando com --json para scripts e agentes, e atualização.

6 min de leituraAvançadoAtualizado em 2 de outubro de 2026

Badgie CLI: gira o seu clube a partir do terminal

Resposta rápida

O Badgie CLI (@badgie/cli) é a ferramenta oficial de linha de comandos do Badgie: «o desporto, no seu terminal». Instala-se com npm i -g @badgie/cli (ou experimenta-se com npx @badgie/cli), autoriza-se com badgie login e permite falar com o agente do seu clube ou executar ferramentas no terminal, sempre com o seu papel. Todos os comandos aceitam --json para scripts e agentes de IA. Requer Node.js 20 ou superior.

Neste guia
  1. Onde está
  2. Comandos
  3. Passo a passo
  4. Dentro do chat
  5. Para scripts e agentes de IA
  6. Exemplos por papel
  7. Perguntas frequentes

Onde está

  • Pacote npm: @badgie/cli (versão 1.5.5 em outubro de 2026). Comando: badgie.
  • Funciona em qualquer sistema com Node.js 20 ou superior (macOS, Linux e Windows).
  • É um cliente do servidor MCP do Badgie: as mesmas ferramentas, o mesmo início de sessão com a sua conta e a mesma Delegação.
  • As mensagens do CLI estão em espanhol.

Comandos

  • badgie ou badgie chat: fale com o agente do seu clube.
  • badgie login: inicie sessão com a sua conta Badgie (abre-se o navegador).
  • badgie logout: termina a sessão e apaga os tokens locais.
  • badgie whoami [--json]: mostra o seu papel e a sua escola.
  • badgie tools [filtro] [--json]: lista o que pode fazer (as ferramentas do seu papel).
  • badgie run <ferramenta> [chave=valor…] [--args '<json>'] [--json]: executa uma ferramenta. As leituras devolvem dados; as escritas seguem a Delegação do clube.
  • badgie update [--check] [--json] [--channel <dist-tag>]: atualiza o CLI para a última versão publicada.
  • badgie repl: o REPL clássico de ferramentas, sem agente.
Saída real do comando npx @badgie/cli --help
Saída real de `npx @badgie/cli --help` (versão 1.5.5).

Passo a passo

  1. Instale o CLI: npm i -g @badgie/cli (ou use npx @badgie/cli sem instalar).
  2. Inicie sessão: badgie login. Abre-se o navegador, entra com a sua conta Badgie e aprova o acesso.
  3. Confirme quem é: badgie whoami.
  4. Veja o que pode fazer: badgie tools. O catálogo depende do seu papel.
  5. Execute uma ferramenta, por exemplo badgie run get_top_debtors limit=10. Para argumentos aninhados use notação com ponto (payload.student_id=…) ou passe o JSON completo com --args.
  6. Ou escreva simplesmente badgie e converse com o agente do seu clube.

Sem sessão, os comandos que precisam da sua conta avisam: «No has iniciado sesión. Ejecuta badgie login.»

Saída real de npx @badgie/cli tools sem sessão e de badgie run --help
Sem sessão, `tools` pede `badgie login`. `run --help` mostra os argumentos chave=valor e as opções `--json` e `--args`.

Dentro do chat

Escreva / e carregue em Tab ou → para completar. Cada papel vê os seus.

  • Clube: /hoy (aulas, chamadas por fazer, avisos), /semana, /pendientes (propostas à espera do seu OK), /deudores, /alumno <nome>, /insignias, /asistencia [grupo], /leads, /mensaje <a quem> <o quê> (redige e propõe um envio), /cantera (equipas, jogos e resultados), /swing [aluno], /informe <tema>, /recuerda <facto> e /memoria.
  • Sessão: /model [nível] (rápido, equilibrado ou máximo), /bien e /mal [o que falhou] para avaliar a última resposta, /nuevo, /creditos, /whoami, /tools [filtro], /run <tool> k=v… (sem o agente), /limpiar, /ayuda, /logout e /salir.

É o mesmo agente que tem no painel e na app, com os mesmos créditos do clube.

Lista real de comandos do chat do Badgie CLI
Comandos do chat segundo a ajuda real do CLI.

Para scripts e agentes de IA

  • Junte --json a whoami, tools, run ou update para obter saída JSON pensada para agentes e scripts.
  • Para manter o CLI atualizado sem intervenção: badgie update --check --json | jq -e '.updateAvailable' >/dev/null && badgie update --json.
  • Variáveis de ambiente: BADGIE_NO_UPDATE_NOTIFIER=1 (silencia o aviso de nova versão), BADGIE_DISABLE_UPDATES=1 (impede a atualização), BADGIE_UPDATE_CHANNEL (canal, latest por omissão) e BADGIE_REGISTRY (registo npm alternativo).
  • badgie update usa o gestor com que o instalou.

Exemplos por papel

O papel não se escolhe: vem da sua conta Badgie.

  • Conta de escola: badgie run get_top_debtors, badgie run list_action_catalog (ações que pode propor) e badgie run list_my_proposals (estado das suas propostas).
  • Professor: badgie run my_classes_today, badgie run my_students, award_badge para atribuir insígnias e record_attendance para fazer a chamada.
  • Aluno ou família: badgie run my_badges, badgie run my_schedule, badgie run my_payments e badgie run my_golf_stats.

Perguntas frequentes

É seguro?

Sim. Autoriza com a sua conta no navegador (OAuth 2.1) e o CLI nunca vê a sua palavra-passe. Atua com o seu papel, nunca vê dados de outra escola e o que se envia às famílias ou se publica espera a sua aprovação. badgie logout apaga os tokens locais.

Serve para agentes de IA e scripts?

Sim. --json dá uma saída estável para agentes como OpenClaw ou Claude Code, pipelines de CI e tarefas agendadas.

Preciso de saber programar?

Não para o chat: basta escrever badgie e conversar. run e --json são para quem quer automatizar.

Há uma API REST pública em vez do CLI?

Não. O Badgie não oferece uma API REST pública com chaves nem webhooks de saída. O caminho para programadores é o servidor MCP e o Badgie CLI.

Gasta créditos?

O chat com o agente consome créditos do clube, tal como no painel (/creditos mostra o saldo). run e repl executam ferramentas sem passar pelo agente.