Ir para o conteúdo
Promovaweb

Plugin GitHub Traffic Board no Omarchy

Em destaque

O que o Plugin GitHub Traffic Board faz no seu Omarchy

  1. Veja visitas, clones e origens de tráfego em 14 dias
  2. Atualize quando quiser, sem consulta em segundo plano
  3. Escolha quais repositórios entram no painel
  4. Consulte repositórios públicos de qualquer usuário sem token
  5. Exporte o relatório em HTML ou PNG
GitHub Traffic Boardio.github.hancore-linux.traffic-board
Tipo
Widget da barra
Categoria
Ferramentas de desenvolvimento
Mantenedor
HANCORE-linux
Licença
MIT
Versão
1.7.0
Compatibilidade
Omarchy 4 com shell Quickshell e python3, presente na instalação padrão. O modo Traffic exige um token fino do GitHub com permissão Administration somente leitura. O modo Light não usa token. ImageMagick é opcional e só afeta as miniaturas. Referência do portal: Omarchy 4.5.0-rc1.
Tags
#barra#quickshell#github
Painel do GitHub Traffic Board aberto pela barra do Omarchy, com o resumo de visitas, clones e origens de tráfego dos repositórios.
Repositório HANCORE-linux/GitHub-Traffic-Board (MIT)

Instalar e manter

  1. Instale o plugin

    O Omarchy clona o repositório do plugin e valida os arquivos no seu computador. Só depois ele instala e ativa o plugin.

    Instalar
    omarchy plugin add https://github.com/HANCORE-linux/GitHub-Traffic-Board.git --enable
  2. Atualize quando sair uma versão nova

    Rode este comando para trazer as mudanças publicadas no repositório do plugin.

    Atualizar
    omarchy plugin update io.github.hancore-linux.traffic-board
  3. Remova quando não precisar mais

    O comando retira o plugin do seu Omarchy. Use o mesmo identificador mostrado no cartão de detalhes.

    Remover
    omarchy plugin remove io.github.hancore-linux.traffic-board

O GitHub Traffic Board põe na barra do Omarchy os números que o GitHub mostra apenas na aba de tráfego de cada repositório. O painel reúne visitas, clones e origens de tráfego dos últimos 14 dias dos seus repositórios próprios, sem incluir forks.

Diferente de um monitor automático, nada é consultado em segundo plano. Os números são carregados quando você clica para atualizar, e o plugin avisa antes de uma consulta grande: cada repositório custa cerca de três requisições, e a partir de duzentas o painel exige confirmação.

Antes de instalar

O plugin exige Omarchy 4 com shell Quickshell e python3, que já acompanha a instalação. O token vem do próprio GitHub e precisa de permissão mínima: no token fino, basta Administration com acesso de leitura.

Evite token clássico, que exige o escopo repo inteiro. O modo Light dispensa token e mostra apenas informações públicas.

Crie o token

  1. Abra as configurações de tokens finos do GitHub e crie um token novo.
  2. Dê um nome, como gh-traffic, e escolha uma data de expiração.
  3. Em acesso a repositórios, libere todos ou apenas os que você quer acompanhar.
  4. Em permissões de repositório, marque Administration como leitura. Nada além disso.
  5. Copie o token e cole no painel do plugin.

O token fica em ~/.config/gh-traffic/token, com permissão 0600, e pode ser apagado nas opções do painel. Ele só é enviado para api.github.com e nunca entra no relatório ou na exportação.

Instale

Terminal
omarchy plugin add https://github.com/HANCORE-linux/GitHub-Traffic-Board.git --enable

O ícone entra na barra e abre o painel. A engrenagem concentra as opções de repositórios e de modo. Há dois modos: Traffic, para os seus repositórios, com token, e Light, para os repositórios públicos de qualquer usuário, sem token.

A lista mostra dezesseis repositórios, com botões para mais trinta e seis e depois para todos. A ordenação pode ser por visitas, clones, estrelas, forks, atualização ou nome, com opção de excluir forks.

Exporte o resultado

O painel exporta um relatório HTML, sem novas requisições, ou uma imagem PNG. Os arquivos ficam em ~/gh-traffic/exports/.

O relatório HTML é autocontido e abre sem conexão. Ele traz o gráfico acumulado de visitas e clones, um gráfico por repositório, a comparação entre a metade recente e a metade anterior do período, as origens de tráfego e um cartão por projeto com miniatura, estrelas, issues e a data da última atualização.

ImageMagick é opcional e serve para reduzir as miniaturas dos cartões. Sem ele, o relatório mostra um monograma no lugar da imagem.

Use a linha de comando

O mesmo script funciona fora do Omarchy, em um arquivo único sem dependências:

Terminal
mkdir -p ~/gh-traffic
curl -fsSL https://raw.githubusercontent.com/HANCORE-linux/GitHub-Traffic-Board/main/gh_traffic.py \
-o ~/gh-traffic/gh_traffic.py
python3 ~/gh-traffic/gh_traffic.py

A primeira execução pergunta entre o modo completo, com token, e o modo leve. As opções seguem o mesmo desenho do painel, com --public <usuario> para repositórios públicos, --out para escolher o arquivo, --repos para limitar a lista e --json para uso em scripts.

O relatório e o cache ficam em ~/gh-traffic/, e o cache de miniaturas é reaproveitado por ETag. Nada é gravado dentro do repositório clonado.

Atualize e remova

Terminal
omarchy plugin update io.github.hancore-linux.traffic-board
omarchy plugin remove io.github.hancore-linux.traffic-board

A remoção mantém seus arquivos em ~/gh-traffic/ e ~/.config/gh-traffic/. Apague essas pastas se quiser descartar o cache, o token salvo e os relatórios exportados.

O projeto parte do github_traffic_report.py de Roman Tsisyk, reescrito como um único arquivo com relatório offline, seis temas, análise de tendência e modo leve.