Pi CLI

Пи-Кли

PI-CLI-это программа командной строки, используемая для просмотра данных из экземпляра PI-HOLE непосредственно в вашем терминале.

Функции

• Живой вид
  • Как показано выше, PI-CLI может генерировать живое представление об обновлении ваших данных PI-отверстия
  • Обновления до минимум 1 с, предоставляя по существу живые данные запросов. Поддержка небольших интервалов может прийти в будущее.
  • Обновите параметры, включая количество зарегистрированных запросов в таблице «Последние запросы», и посмотрите, как пользовательский интерфейс автоматически обновляет и втягивает правильные данные для вас. Используйте свои клавиши со стрелками, чтобы прокрутить и ориентироваться в таблице.
• Одна команда
  • Не хотите живого взгляда? Используйте одну из подкомандов PI-CLI, чтобы точно сказать, какие данные вы хотите, и это даст вам. Никакого модного пользовательского интерфейса не нужно.
• Анализ базы данных
  • PI-CLI обладает вновь добавленной способностью иметь возможность анализировать базу данных pihole-FTL.db использовавшего долгосрочное хранилище данных для PI-отверстия. Он может извлекать и анализировать все данные времени, включая данные о клиенте, запросе и AD.
• Быстро настроить и забыть
  • Запустите одну команду настройки, и Pi-Cli хранит и запомните все ваши данные на следующий раз.
• Легкий вес
  • Даже при регистрации 1000 запросов DNS, память и использование процессора остаются минимальными.
• Безопасный
  • Pi-Cli использует библиотеки кроссплатформенных библиотеков OS Keyring, чтобы убедиться, что ваш ключ API Pi-Hole надежно хранится и легко извлечь в будущем. Ваш ключ API никогда не хранится в открытом виде, если вы явно не говорите PI-CLI не использовать свой Keyring.

Использование

~$ 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 и предоставляют все временные показатели данных

   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».

• Предварительно скомпилированные двоичные файлы?

  • Смотрите релизы

• Как мне скомпилировать себя?

  • Сделай! В CMD/основном каталоге есть Makefile , который можно использовать для компиляции в Windows, Mac и Linux.

  Цели компиляции: win , mac и linux

---

Если вы найдете Pi-Cli полезным, пожалуйста, рассмотрите возможность пожертвования в проект Pi-Hole

Или не стесняйтесь отправлять код, чтобы сделать Pi-Cli еще более полезным!