Pi CLI

Pi-cli

PI-CLI es un programa de línea de comandos utilizado para ver los datos desde una instancia de Pi-Hole directamente en su terminal.

Características

• Vista en vivo
  • Como se muestra arriba, PI-CLI puede generar una vista de actualización en vivo de sus datos PI-Hole
  • Las actualizaciones hasta un mínimo de 1s, proporcionando datos de consultas esencialmente en vivo. El apoyo para intervalos más pequeños puede venir en el futuro.
  • Actualice los parámetros, incluido el número de consultas registradas en la tabla 'consultas Últimas' y vea la interfaz de usuario automáticamente actualizar y extraer los datos correctos para usted. Use sus llaves de flecha para desplazarse y navegar por la mesa.
• Uno de los comandos fuera
  • ¿No quieres una vista en vivo? Use uno de los subcomandos de Pi-cli para decirle exactamente qué datos desea, y se lo dará. No se necesita UI elegante.
• Análisis de bases de datos
  • PI-CLI tiene la capacidad recientemente agregada para poder analizar la base de datos pihole-FTL.db utilizó un almacén de datos a largo plazo para un agujero PI. Puede extraer y analizar los datos de todos los tiempos, incluidos los datos del cliente, consulta y del dominio AD.
• Configurar y olvidar rápidamente
  • Ejecute un comando de configuración, y Pi-cli almacenará y recordará todos sus datos para la próxima vez.
• Ligero
  • Incluso cuando registra 1000 de consultas DNS, la memoria y el uso de la CPU sigue siendo mínimo.
• Seguro
  • PI-CLI utiliza bibliotecas de llavero del sistema operativo multiplataforma para asegurarse de que su tecla API PI-Hole esté almacenada de forma segura y fácil de recuperar en el futuro. Su clave API nunca se almacena en texto sin formato a menos que le indique explícitamente a PI-CLI que no use su llavero.

Uso

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

Para recibir ayuda, ejecutar ~$ picli h

Para la ayuda del comando, ejecutar ~$ picli <command> h

Para la ayuda de subcomand, ejecutar ~$ 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

El comando config

Administrar datos de configuración almacenados

   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

El comando run

Ejecute un solo comando sin la vista en 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

El comando database

Estos comandos se ejecutan contra un archivo de base de datos FTL de Pi-Hole y proporcionan métricas de datos de tiempo

   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

Preguntas frecuentes

• ¿De dónde saco mi llave API?

  • Navegue a la interfaz web de su Pi-Hole, luego a Configuración. Haga clic en la pestaña API/interfaz web y presione 'Show API Token'.

• ¿Binarios precompilados?

  • Ver lanzamientos

• ¿Cómo me compilo?

  • ¡Con la marca! Hay un Makefile en el directorio CMD/principal que se puede utilizar para la compilación en Windows, Mac y Linux.

  Los objetivos de compilación son: win , mac y linux

---

Si encuentra útil PI-cli, considere donar al proyecto Pi-Hole

¡O no dude en enviar código para hacer que PI-cli sea aún más útil!