Pi CLI

pi-cli

Pi-CLI是一个命令行程序，用于直接从终端中的PI-HOLE实例查看数据。

特征

• 实时视图
  • 如上所示，PI-CLI可以生成您的PI-HOL数据的实时更新视图
  • 更新至至少1s，提供实质上的实时查询数据。将来可能会支持较小的间隔。
  • 更新参数，包括“最新查询”表中的已记录查询数量，并观看UI自动更新并为您提取正确的数据。使用箭头键滚动并导航表。
• 一个关闭命令
  • 不想现场视图？使用Pi-Cli的一个子命令之一，准确地告诉您您想要的数据，并将其提供给您。不需要花式UI。
• 数据库分析
  • Pi-CLI具有新添加的能力，能够分析pihole-FTL.db数据库使用长期数据存储用于PI孔。它可以提取和分析所有时间数据，包括客户端，查询和广告域数据。
• 快速配置并忘记
  • 运行一个设置命令，Pi-CLI将存储并记住您的所有详细信息。
• 轻的
  • 即使记录1000次DNS查询，内存和CPU的使用仍然很少。
• 安全的
  • Pi-CLI使用跨平台OS键环库来确保您的Pi-hole API密钥既可以牢固地存储又易于检索。除非您明确地告诉Pi-Cli不使用钥匙扣，否则您的API密钥永远不会以明文存储。

用法

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

为了帮助，运行~$ picli h

在命令帮助下，运行~$ 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命令

这些命令是针对Pi-hole的FTL数据库文件运行的，并提供了所有时间数据指标

   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的Web界面，然后设置设置。单击“ API/Web接口”选项卡，然后按“显示API令牌”。

• 预编译二进制文件？

  • 请参阅版本

• 我如何编译自己？

  • 用制作！ CMD/主目录中有一个Makefile ，可用于Windows，Mac和Linux上的编译。

  汇编目标是： win ， mac和linux

---

如果您发现Pi-CLI有用，请考虑向Pi-Hole项目捐款

或者，随时提交代码以使Pi-CLI更有用！