Pi CLI

Pi-cli

O PI-CLI é um programa de linha de comando usado para visualizar dados de uma instância de orifício PI diretamente no seu terminal.

Características

• Vista ao vivo
  • Como mostrado acima, o Pi-Cli pode gerar uma visão de atualização ao vivo dos seus dados de buracos PI
  • Atualizações até um mínimo de 1s, fornecendo dados essencialmente de consulta ao vivo. O suporte a intervalos menores pode vir no futuro.
  • Atualize os parâmetros, incluindo o número de consultas registradas na tabela 'mais recentes consultas' e assista à interface do usuário atualizada e puxe automaticamente os dados corretos para você. Use suas teclas de seta para rolar e navegar na tabela.
• Um comandos off off
  • Não quer uma vista ao vivo? Use um dos subcomandos do PI-Cli para dizer exatamente quais dados você deseja, e eles lhe darão. Nenhuma interface do usuário sofisticada precisa.
• Análise de banco de dados
  • O PI-CLI tem a capacidade recém-adicionada de poder analisar o banco de dados pihole-FTL.db usou um armazenamento de dados de longo prazo para um buraco PI. Ele pode extrair e analisar os dados de todos os tempos, incluindo dados do cliente, consulta e domínio de anúncios.
• Configure e esqueça rapidamente
  • Execute um comando de configuração e o Pi-Cli armazenará e lembre-se de todos os seus detalhes para a próxima vez.
• Leve
  • Mesmo quando o registro de 1000 de consultas DNS, a memória e o uso da CPU permanecem mínimos.
• Seguro
  • O PI-CLI usa bibliotecas de keyring do OS de plataforma cruzada para garantir que sua tecla API PI-HOLE seja armazenada com segurança e fácil de recuperar no futuro. Sua chave de API nunca é armazenada no texto sem formatação, a menos que você diga explicitamente a PI-cli para não usar seu chaveiro.

Uso

~$ picli [global options] command [command options] [arguments...]

Para obter ajuda, execute ~$ picli h

Para ajuda de comando, execute ~$ picli <command> h

Para ajuda do subcomando, execute ~$ picli <command> -h

Comandos

   setup, s     Configure Pi-CLI
   config, c    Interact with stored configuration settings
   run, r       Run a one off command without booting the live view
   database, d  Analytics options to run on a Pi-Hole's FTL database
   help, h      Shows a list of commands or help for one command

O comando config

Gerenciar dados de configuração armazenados

   delete, d  Delete stored config data (config file and API key)
   view, v    View config stored config data (config file and API key)
   help, h    Shows a list of commands or help for one command

O comando run

Execute um único comando sem a vista ao vivo

   summary, s          Extract a basic summary of data from the Pi-Hole
   top-forwarded, tf   Extract the current top 10 forwarded DNS queries
   top-blocked, tb     Extract the current top 10 blocked DNS queries
   latest-queries, lq  Extract the latest queries
   enable, e           Enable the Pi-Hole
   disable, d          Disable the Pi-Hole
   help, h             Shows a list of commands or help for one command

O comando database

Esses comandos são executados contra o arquivo de banco de dados FTL de um buraco PI e fornecem todas as métricas de dados de tempo

   client-summary, cs  Summary of all Pi-Hole clients
   top-queries, tq     Returns the top (all time) queries
   help, h             Shows a list of commands or help for one command

Perguntas frequentes

• Onde faço minha chave de API?

  • Navegue até a interface da web do seu Pi-Hole e as configurações. Clique na guia API/Interface da Web e pressione 'Mostrar token da API'.

• Binários pré-compilados?

  • Veja lançamentos

• Como faço para me compilar?

  • Com make! Há um Makefile no diretório CMD/principal que pode ser usado para compilação no Windows, Mac e Linux.

  Os alvos de compilação são: win , mac e linux

---

Se você achar útil o Pi-cli, considere doar para o projeto Pi-Hole

Ou sinta-se à vontade para enviar o código para tornar o Pi-Cli ainda mais útil!