Zev: una herramienta CLI para consultar rápidamente comandos de terminal en lenguaje natural

Introducción general

Zev es una herramienta de interfaz de línea de comandos (CLI) fácil de usar que ayuda a los usuarios a consultar y generar rápidamente comandos de terminal en lenguaje natural. En lugar de memorizar complejas sintaxis de comandos, Zev genera comandos de terminal describiendo los requisitos en lenguaje cotidiano. Basado en la API de OpenAI o en Ollama Zev soporta una gran variedad de escenarios operativos, como la gestión de archivos, la visualización de procesos, la inspección de redes y las operaciones Git. Zev está diseñado para reducir el umbral de uso de la línea de comandos, apto para desarrolladores y principiantes. Los usuarios necesitan configurar una clave API OpenAI o un entorno local Ollama para utilizarlo. El código de zev es de código abierto en GitHub, lo que permite a los usuarios contribuir libremente y personalizarlo.

Lista de funciones

• Generar comandos de terminal en lenguaje natural, por ejemplo, "mostrar el uso actual del disco del directorio".
• Admite diversos escenarios operativos, como la manipulación de archivos, la gestión de procesos, la inspección de redes y los comandos Git.
• Integración con la API OpenAI para proporcionar generación inteligente de comandos.
• Admite modelos nativos de Ollama y permite el funcionamiento sin conexión.
• Proporciona la función de gestión de claves API para que los usuarios actualicen la configuración.
• Código fuente abierto, apoyo a las contribuciones de la comunidad y ampliaciones de funciones.

Utilizar la ayuda

Proceso de instalación

Zev es una herramienta CLI desarrollada en Python con un sencillo proceso de instalación y configuración. Aquí están los pasos detallados:

1. almacén de clones
   Abre un terminal y ejecuta el siguiente comando para clonar el repositorio GitHub de Zev:

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

Una vez finalizada la clonación, vaya al directorio del proyecto:

cd zev

2. Instalación de dependencias
   Zev depende de un entorno Python 3.6+. Asegúrate de que Python está instalado y, a continuación, instala las dependencias necesarias:

   pip install -r requirements.txt
   

   Las dependencias incluyen las bibliotecas cliente Python de OpenAI, que pueden encontrarse en el directorio requirements.txt Ver en.

3. Configuración de las claves de la API de OpenAI
   La primera vez que ejecutes Zev, se te pedirá una clave de API de OpenAI. Los usuarios deben registrar una cuenta en el sitio web de OpenAI y crear una clave. Ejecute el siguiente comando para iniciar la configuración:

   python zev.py
   

   Introduzca la clave tal y como se le pide y la clave se guardará en el archivo de configuración local.
   Si necesita actualizar la clave, ejecute:

   zev --update-key
   

4. (Opcional) Configuración del modelo Ollama
   Si desea ejecutar Zev localmente, puede instalar Ollama y configurar un modelo local:
   • Visita la web de Ollama para descargar e instalar Ollama.
   • Inicie el servicio Ollama y seleccione el modelo, por ejemplo:

     ollama run llama3
     

   • Habilitar el modo Ollama en la configuración Zev, ejecutar:

     zev --use-ollama
     

   Esto permitirá a Zev utilizar un modelo local, adecuado para usuarios que no dispongan de un entorno de red o que estén preocupados por la privacidad.

5. Corre Zev
   Una vez finalizada la instalación y la configuración, ejecute el siguiente comando para iniciar Zev:

   python zev.py
   

Funciones principales

La función principal de Zev es generar comandos de terminal mediante lenguaje natural. Así es como funciona:

• Comandos del terminal de consulta
  En el terminal, escriba zev seguido de una descripción en lenguaje natural. Por ejemplo, para ver todos los procesos de Python en ejecución:

  zev 'show all running python processes'
  

  Zev devuelve algo como ps aux | grep python comandos. Los usuarios pueden copiarlos y ejecutarlos directamente.

• operación de archivo
  Buscar archivos modificados recientemente, por ejemplo:

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

  El comando de salida puede ser:

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

• Consulta de información sobre el sistema
  Ver el uso del disco:

  zev 'show disk usage for current directory'
  

  Comandos de salida como:

  du -sh .
  

• comprobación de red
  Pruebe la conectividad de la red, por ejemplo:

  zev 'check if google.com is reachable'
  

  El comando de salida puede ser:

  ping -c 4 google.com
  

• Operaciones Git
  Ver cambios no comprometidos en Git:

  zev 'show uncommitted changes in git'
  

  Comandos de salida como:

  git status
  

Función destacada Operación

• Apoyo local al modelo Ollama
  Ejecutar Zev con Ollama es completamente offline y protege la privacidad de los datos. Una vez configurado, Zev llama automáticamente al modelo local para generar comandos sin necesidad de conexión a Internet.
  Ejemplo:

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

  Comando de salida:

  ls -la
  

• Gestión de claves API
  Los usuarios pueden actualizar su clave OpenAI o cambiar de modelo en cualquier momento. Corre:

  zev --update-key
  

  Introduzca la nueva clave cuando se le solicite y la configuración surtirá efecto inmediatamente.

Precauciones de manipulación

• Asegúrese de que su red es estable para utilizar la API OpenAI. si utiliza Ollama, deberá iniciar el servicio de modelos con antelación.
• La descripción en lenguaje natural de la entrada es lo más clara y específica posible para evitar ambigüedades. Por ejemplo, "enumerar documentos" podría generar lsy "Listar todos los archivos ocultos" genera el ls -a.
• Los comandos generados por Zev son sólo de referencia, y se recomienda comprobar que los comandos cumplen las expectativas antes de ejecutarlos.

Uso avanzado

• Generación de comandos personalizados
  Los usuarios pueden bifurcar el repositorio GitHub de Zev para modificar el código y adaptarlo a situaciones específicas. Por ejemplo, para añadir plantillas de comandos personalizadas o dar soporte a otros modelos de IA.
• operación por lotes
  Zev no soporta actualmente la generación de comandos por lotes, pero los usuarios pueden invocar Zev a través de secuencias de comandos, por ejemplo, escribiendo una secuencia de comandos de shell para realizar un bucle a través de los archivos zev para gestionar múltiples tareas.

escenario de aplicación

1. Entorno de depuración para desarrolladores
   Para los desarrolladores que utilizan con frecuencia comandos de terminal al depurar código, como comprobar el estado de un proceso o un archivo, Zev ahorra tiempo al permitir generar rápidamente comandos en lenguaje natural. Por ejemplo, si escribes "buscar procesos en el puerto 8080", Zev genera el siguiente comando lsof -i :8080.
2. Aprendizaje de la línea de comandos para principiantes
   Los recién llegados a la línea de comandos a menudo se sienten frustrados por su incapacidad para recordar sintaxis compleja, por lo que Zev reduce las barreras para el aprendizaje a través de la entrada de lenguaje natural. Por ejemplo, escribe "mostrar todos los tamaños de archivo de la carpeta actual" y Zev generará ls -lhpara ayudar a los usuarios a ponerse al día rápidamente.
3. Mantenimiento diario para administradores de sistemas
   Para los administradores de sistemas que necesitan comprobar el estado de un servidor o realizar diagnósticos de red, Zev admite la generación rápida de comandos, como "comprobar espacio en disco" para generar un comando "comprobar espacio en disco". df -hpara mejorar la eficacia.

CONTROL DE CALIDAD

1. ¿Con qué sistemas operativos es compatible Zev?
   Zev es compatible con macOS, Linux y Windows (requiere entorno Python). Es posible que algunos comandos deban ajustarse manualmente debido a las diferencias entre sistemas.
2. ¿Tengo que utilizar la API de OpenAI?
   No es necesario.Zev admite modelos locales de Ollama para quienes los utilicen sin conexión o no quieran depender de los servicios en la nube.
3. ¿Cómo puedo contribuir con código?
   entrevistas https://github.com/dtnewman/zevPara obtener más información sobre cómo contribuir al repositorio, consulte la página del repositorio CONTRIBUTING.md.
4. ¿Son seguros los comandos generados por Zev?
   Los comandos generados por Zev se basan en la entrada del usuario y en el razonamiento del modelo. Se recomienda comprobar el contenido de los comandos antes de ejecutarlos para evitar posibles riesgos.