Pi CLI

Pi-cli

PI-CLI ist ein Befehlszeilenprogramm, mit dem Daten aus einer PI-LOLE-Instanz direkt in Ihrem Terminal angezeigt werden.

Merkmale

• Live View
  • Wie oben gezeigt, kann PI-CLI eine Live-Aktualisierungsansicht Ihrer PI-Loch-Daten generieren
  • Aktualisierungen bis mindestens 1s und liefern im Wesentlichen Live -Abfragedaten. Die Unterstützung für kleinere Intervalle kann in Zukunft kommen.
  • Aktualisieren Sie Parameter einschließlich der Anzahl der protokollierten Abfragen in der Tabelle "Neueste Abfragen" und sehen Sie die Benutzeroberfläche automatisch aktualisiert und geben Sie die richtigen Daten für Sie an. Verwenden Sie Ihre Pfeiltasten, um durch die Tabelle zu scrollen und zu navigieren.
• Ein Off -Off -Befehle
  • Willst du keine Live -Ansicht? Verwenden Sie einen der Unterbefehle von PI-CLI, um genau zu sagen, welche Daten Sie möchten, und es gibt es Ihnen. Keine ausgefallene UI brauchte.
• Datenbankanalyse
  • PI-CLI hat die neu hinzugefügte Fähigkeit, die pihole-FTL.db Datenbank analysieren zu können, die ein Langzeitdatenspeicher für ein PI-Loch verwendet hat. Es kann alle Zeitdaten extrahieren und analysieren, einschließlich Client-, Abfrage- und AD -Domänendaten.
• Schnell konfigurieren und vergessen
  • Führen Sie einen Setup-Befehl aus, und PI-CLI wird alle Ihre Details zum nächsten Mal speichern und sich daran erinnern.
• Leicht
  • Selbst wenn die 1000 DNS -Abfragen protokolliert, bleibt Speicher und CPU -Verwendung minimal.
• Sicher
  • PI-CLI verwendet plattformübergreifende OS-Schlüsselringbibliotheken, um sicherzustellen, dass Ihr Pi-Hole-API-Schlüssel in Zukunft sowohl sicher als auch leicht abgerufen wird. Ihr API-Schlüssel wird niemals im Klartext gespeichert, es sei denn, Sie sagen PI-CLI, dass Sie Ihren Schlüsselring nicht verwenden sollen.

Verwendung

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

Für Hilfe rennen Sie ~$ picli h

Für die Befehlshilfe führen Sie ~$ picli <command> h

Führen Sie für die Hilfe von Unterbewohnern ~$ picli <command> -h Führen Sie aus

Befehle

   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

Der Befehl config

Verwalten Sie gespeicherte Konfigurationsdaten

   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

Der Befehl run

Führen Sie einen einzelnen Befehl ohne Live -Ansicht aus

   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

Der database

Diese Befehle werden gegen die FTL-Datenbankdatei eines Pi-Hole durchgeführt und bieten alle Zeitdatenmetriken an

   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

FAQ

• Woher bekomme ich meinen API -Schlüssel?

  • Navigieren Sie zur Weboberfläche Ihres Pi-Hole und dann zu Einstellungen. Klicken Sie auf die Registerkarte API/Web Interface und drücken Sie 'API -Token anzeigen'.

• Binärdateien vor dem Kompilieren?

  • Siehe Veröffentlichungen

• Wie kompiliere ich mich?

  • Mit machen! Das CMD/Hauptverzeichnis gibt es ein Makefile , das für die Zusammenstellung unter Windows, Mac und Linux verwendet werden kann.

  Kompilierungsziele sind: win , mac und linux

---

Wenn Sie PI-CLI nützlich finden, sollten Sie an das PI-Hole-Projekt spenden

Oder zögern Sie nicht, Code einzureichen, um PI-CLI noch nützlicher zu machen!