Pi CLI

pi-cli

Pi-cli เป็นโปรแกรมบรรทัดคำสั่งที่ใช้ในการดูข้อมูลจากอินสแตนซ์ Pi-Hole โดยตรงในเทอร์มินัลของคุณ

คุณสมบัติ

• มุมมองสด
  • ดังที่แสดงไว้ด้านบน Pi-cli สามารถสร้างมุมมองการอัปเดตสดของข้อมูล Pi-Hole ของคุณ
  • อัปเดตลงไปอย่างน้อย 1s โดยให้ข้อมูลการสืบค้นสดเป็นหลัก การสนับสนุนสำหรับช่วงเวลาที่เล็กกว่าอาจเกิดขึ้นในอนาคต
  • อัปเดตพารามิเตอร์รวมถึงจำนวนการสืบค้นที่บันทึกไว้ในตาราง 'คิวรีล่าสุด' และดู UI อัปเดตและดึงข้อมูลที่ถูกต้องโดยอัตโนมัติสำหรับคุณ ใช้ปุ่มลูกศรของคุณเพื่อเลื่อนและนำทางตาราง
• หนึ่งคำสั่งปิด
  • ไม่ต้องการวิวสด? ใช้หนึ่งในคำสั่งย่อยของ pi-cli เพื่อบอกว่าข้อมูลที่คุณต้องการและมันจะมอบให้คุณ ไม่จำเป็นต้องใช้ UI แฟนซี
• การวิเคราะห์ฐานข้อมูล
  • Pi-cli มีความสามารถที่เพิ่มขึ้นใหม่เพื่อให้สามารถวิเคราะห์ฐานข้อมูล pihole-FTL.db ใช้ที่เก็บข้อมูลระยะยาวสำหรับ pi-hole มันสามารถแยกและวิเคราะห์ข้อมูลตลอดเวลารวมถึงไคลเอนต์แบบสอบถามและข้อมูลโดเมนโฆษณา
• กำหนดค่าและลืมอย่างรวดเร็ว
  • เรียกใช้คำสั่งการตั้งค่าหนึ่งคำสั่งและ Pi-Cli จะจัดเก็บและจดจำรายละเอียดทั้งหมดของคุณในครั้งต่อไป
• มีน้ำหนักเบา
  • แม้ว่าการลงชื่อเข้าใช้การสืบค้น DNS 1,000 ครั้งการใช้งานหน่วยความจำและการใช้งาน CPU ยังคงน้อยที่สุด
• ปลอดภัย
  • Pi-Cli ใช้ไลบรารี OS แบบข้ามแพลตฟอร์มเพื่อให้แน่ใจว่าคีย์ API Pi-Hole ของคุณถูกเก็บไว้อย่างปลอดภัยและง่ายต่อการดึงข้อมูลในอนาคต คีย์ API ของคุณจะไม่ถูกเก็บไว้ใน PlainText เว้นแต่คุณจะบอก Pi-Cli อย่างชัดเจนว่าไม่ใช้พวงกุญแจของคุณ

การใช้งาน

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

สำหรับความช่วยเหลือ Run ~$ picli h

สำหรับความช่วยเหลือคำสั่ง run ~$ picli <command> h

สำหรับความช่วยเหลือจากคำสั่งย่อยให้เรียกใช้ ~$ picli <command> -h

คำสั่ง

   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

คำสั่ง config

จัดการข้อมูลการกำหนดค่าที่เก็บไว้

   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

คำสั่ง run

เรียกใช้คำสั่งเดียวโดยไม่ต้องดูสด

   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

คำสั่ง database

คำสั่งเหล่านี้เรียกใช้กับไฟล์ฐานข้อมูล FTL ของ Pi-Hole และให้ข้อมูลตัวชี้วัดข้อมูล ตลอดเวลา

   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

คำถามที่พบบ่อย

• ฉันจะได้รับคีย์ API ของฉันที่ไหน

  • นำทางไปยังเว็บอินเตอร์เฟสของ Pi-Hole จากนั้นตั้งค่า คลิกที่แท็บ API/เว็บอินเตอร์เฟสแล้วกด 'แสดงโทเค็น API'

• ไบนารีคอมไพล์ล่วงหน้า?

  • ดูรุ่น

• ฉันจะรวบรวมตัวเองได้อย่างไร?

  • ด้วย Make! มี Makefile ในไดเรกทอรี CMD/Main ที่สามารถใช้สำหรับการรวบรวมบน Windows, Mac และ Linux

  เป้าหมายการรวบรวมคือ: win , mac และ linux

---

หากคุณพบว่ามีประโยชน์ pi-cli โปรดพิจารณาบริจาคให้กับโครงการ Pi-Hole

หรืออย่าลังเลที่จะส่งรหัสเพื่อให้ pi-cli มีประโยชน์มากยิ่งขึ้น!