Documentação
Telemetria do CLI
O CLI do Rubrica manda, de forma anônima, as escolhas feitas nos comandos: qual layout, quais cores, quais plugins. É assim que dá para saber o que as pessoas mais usam e onde vale investir. Nada que identifique você ou o seu site sai do seu computador.
O que vai
Cada comando manda um evento quando termina bem. Se ele falha ou você cancela, nada vai.
Todo evento leva:
- um id aleatório do projeto, criado na primeira vez e guardado no
rubrica.json(ele serve para ligar os eventos do mesmo site: criou, configurou, publicou); - a versão do CLI e a versão do Rubrica do projeto;
- o sistema operacional (
linux,darwin,win32), a versão principal do Node e o gerenciador de pacotes (pnpmounpm).
E mais, conforme o comando:
| Comando | O que vai |
|---|---|
create |
Se veio do site ou foi pelas perguntas, modo rápido ou personalizado, layout, esquema de cores, modo claro/escuro, alternância, textura, fontes, pacote de plugins e os plugins escolhidos |
setup |
Se veio do create, se criou o admin e quais integrações foram ligadas (Telegram, OpenRouter, Asaas, Vercel), só sim ou não |
publicar |
Se foi a primeira publicação, uma republicação ou outro computador religando o site |
update |
De qual versão para qual, quantos arquivos mudaram e quantos ficaram em conflito |
config |
Quais partes mudaram (identidade, aparência, layout, plugins) e os valores novos de aparência, layout e plugins |
O que não vai
Nome, e-mail, endereço do site, nome da pasta, textos, posts, senhas, chaves e tokens das integrações, conteúdo do painel e endereço IP. Da identidade só vai que ela mudou, nunca o que você escreveu. O coletor guarda o dia em que o evento chegou, sem a hora.
Como desligar
| Jeito | Vale para |
|---|---|
npx create-rubrica telemetria desligar |
Este projeto, de vez (fica gravado no rubrica.json). Para religar: telemetria ligar |
npx create-rubrica@latest <pasta> --sem-telemetria |
O projeto novo já nasce com a telemetria desligada |
--sem-telemetria em qualquer outro comando |
Só aquela execução |
RUBRICA_TELEMETRIA=0 |
Qualquer comando, enquanto a variável existir |
DO_NOT_TRACK=1 |
O mesmo, seguindo o padrão Console Do Not Track |
Em CI (variável CI ligada) o CLI nunca manda nada. npx create-rubrica telemetria, sem mais nada, mostra se está ligada e por quê.
Na primeira vez em cada projeto, o CLI avisa que a telemetria existe e como desligar.
Como funciona
O envio dura no máximo 2 segundos. Sem internet, ou com o coletor fora do ar, o comando segue normal e nada aparece na tela. O código que monta e manda os eventos é aberto: cli/src/telemetry.ts.