Zev: инструмент CLI для быстрого запроса команд терминала на естественном языке

Общее введение

Zev - это простой в использовании инструмент интерфейса командной строки (CLI), который помогает пользователям быстро запрашивать и генерировать команды терминала на естественном языке. Вместо того чтобы запоминать сложный синтаксис команд, Zev генерирует команды терминала, описывая требования на повседневном языке. На основе API OpenAI или родного Оллама Модель Zev поддерживает различные сценарии работы, такие как управление файлами, просмотр процессов, проверка сети и операции с Git. Zev разработан для снижения порога использования командной строки, подходит для разработчиков и новичков. Для его использования пользователям необходимо настроить ключ OpenAI API или локальное окружение Ollama. Код Zev находится в открытом доступе на GitHub, что позволяет пользователям свободно вносить свой вклад и настраивать его.

Список функций

• Генерируйте команды терминала на естественном языке, например "показать использование диска в текущем каталоге".
• Поддерживает различные операционные сценарии, включая работу с файлами, управление процессами, проверку сети и команды Git.
• Интеграция с API OpenAI для интеллектуальной генерации команд.
• Поддерживает собственные модели Ollama и позволяет работать в автономном режиме.
• Предоставляет функцию управления ключами API для обновления настроек пользователей.
• Открытый исходный код, поддержка вклада сообщества и расширения функций.

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

Процесс установки

Zev - это разработанный на Python инструмент CLI с простым процессом установки и настройки. Ниже приведены подробные шаги:

1. склад клонов
   Откройте терминал и выполните следующую команду, чтобы клонировать репозиторий Зева на GitHub:

   git clone https://github.com/dtnewman/zev.git

После завершения клонирования перейдите в каталог проекта:

cd zev

2. Установка зависимостей
   Zev зависит от среды Python 3.6+. Убедитесь, что Python установлен, затем установите необходимые зависимости:

   pip install -r requirements.txt
   

   Зависимости включают клиентские библиотеки OpenAI для Python и другие, которые можно найти в requirements.txt Смотреть в.

3. Настройка ключей API OpenAI
   При первом запуске Zev вам будет предложено ввести ключ API OpenAI. Пользователям необходимо зарегистрировать учетную запись на сайте OpenAI и создать ключ. Для запуска конфигурации выполните следующую команду:

   python zev.py
   

   Введите ключ при появлении запроса, и он будет сохранен в локальном файле конфигурации.
   Если вам нужно обновить ключ, выполните команду:

   zev --update-key
   

4. (Необязательно) Настройка модели Ollama
   Если вы хотите запускать Zev локально, вы можете установить Ollama и настроить локальную модель:
   • Посетите веб-сайт Ollama, чтобы загрузить и установить Ollama.
   • Запустите сервис Ollama и выберите модель, например:

     ollama run llama3
     

   • Включите режим Ollama в конфигурации Zev, запустите:

     zev --use-ollama
     

   Это позволит Зев использовать локальную модель, которая подходит для пользователей, не имеющих сетевого окружения, или для тех, кто заботится о конфиденциальности.

5. Беги Зев
   После завершения установки и настройки выполните следующую команду, чтобы запустить Zev:

   python zev.py
   

Основные функции

Основная функция Zev - генерировать команды терминала с помощью естественного языка. Вот как это работает:

• Команды терминала запросов
  В терминале введите zev за которым следует описание на естественном языке. Например, чтобы увидеть все запущенные процессы Python:

  zev 'show all running python processes'
  

  Зев возвращает что-то вроде ps aux | grep python Команды. Пользователь может копировать выполнение напрямую.

• работа с файлами
  Найдите недавно измененные файлы, например:

  zev 'find all .py files modified in the last 24 hours'
  

  Команда вывода может быть следующей:

  find . -type f -name "*.py" -mtime -1
  

• Запрос информации о системе
  Просмотр использования диска:

  zev 'show disk usage for current directory'
  

  Выведите такие команды, как:

  du -sh .
  

• проверка сети
  Протестируйте сетевое подключение. например:

  zev 'check if google.com is reachable'
  

  Команда вывода может быть следующей:

  ping -c 4 google.com
  

• Операции с Git
  Просмотр незафиксированных изменений в Git:

  zev 'show uncommitted changes in git'
  

  Выведите такие команды, как:

  git status
  

Функциональное управление

• Поддержка местных моделей Ollama
  Работа Zev с Ollama полностью автономна и обеспечивает конфиденциальность данных. После настройки Zev автоматически вызывает локальную модель для генерации команд без необходимости подключения к Интернету.
  Пример:

  zev --use-ollama 'list all files in current directory'
  

  Выходная команда:

  ls -la
  

• Управление ключами API
  Пользователи могут в любой момент обновить свой ключ OpenAI или сменить модель. Запуск:

  zev --update-key
  

  Введите новый ключ при появлении запроса, и конфигурация немедленно вступит в силу.

Меры предосторожности при обращении

• Убедитесь, что ваша сеть стабильна для использования OpenAI API. Если вы используете Ollama, вам необходимо заранее запустить сервис моделирования.
• Описание входных данных на естественном языке должно быть максимально четким и конкретным, чтобы избежать двусмысленности. Например, "список документов" может вызвать lsи "Список всех скрытых файлов" генерирует ls -a.
• Команды, созданные Zev, предназначены только для ознакомления, и перед их выполнением рекомендуется проверить, соответствуют ли они ожиданиям.

Расширенное использование

• Генерация пользовательских команд
  Пользователи могут форкнуть репозиторий Зева на GitHub, чтобы изменить код для поддержки конкретных сценариев. Например, для добавления пользовательских шаблонов команд или для поддержки других моделей ИИ.
• пакетная обработка
  В настоящее время Zev не поддерживает создание пакетных команд, но пользователи могут вызывать Zev с помощью скриптов, например, написав сценарий оболочки, который будет циклически выполнять команду zev команда для выполнения нескольких задач.

сценарий применения

1. Среда отладки для разработчиков
   Разработчикам, которые часто используют команды терминала при отладке кода, например, для проверки состояния процесса или файла, Zev помогает сэкономить время, позволяя быстро генерировать команды на естественном языке. Например, если вы введете "найти процессы на порту 8080", Zev сгенерирует следующую команду lsof -i :8080.
2. Изучение командной строки новичком
   Новичков в командной строке часто расстраивает неспособность запомнить сложный синтаксис, поэтому Zev снижает барьеры для обучения с помощью естественного языка ввода. Например, введите "показать все размеры файлов в текущей папке", и Zev выдаст ls -lhЭто помогает пользователям быстро освоиться.
3. Ежедневное обслуживание для системных администраторов
   Для системных администраторов, которым необходимо проверить состояние сервера или провести диагностику сети, Zev поддерживает быструю генерацию команд, например "check disk space" для генерации команды "check disk space". df -hи повысить эффективность.

QA

1. Какие операционные системы поддерживает Zev?
   Zev поддерживает macOS, Linux и Windows (требуется среда Python). Некоторые команды могут потребовать ручной настройки из-за различий в системе.
2. Обязательно ли использовать API OpenAI?
   Не требуется.Zev поддерживает локальные модели Ollama для тех, кто использует их в автономном режиме или не хочет полагаться на облачные сервисы.
3. Как внести свой код?
   интервью https://github.com/dtnewman/zevБолее подробную информацию о том, как внести свой вклад в репозиторий, вы найдете на странице репозитория CONTRIBUTING.md.
4. Безопасны ли команды, созданные Зевом?
   Команды, генерируемые Zev, основаны на пользовательском вводе и рассуждениях модели. Рекомендуется проверять содержание команд перед их выполнением, чтобы избежать потенциальных рисков.