Zev: Ein CLI-Tool zur schnellen Abfrage von Terminal-Befehlen in natürlicher Sprache

Allgemeine Einführung

Zev ist ein benutzerfreundliches Tool für die Befehlszeilenschnittstelle (CLI), mit dem Benutzer schnell Terminalbefehle in natürlicher Sprache abfragen und generieren können. Anstatt sich eine komplexe Befehlssyntax zu merken, generiert Zev Terminalbefehle, indem es die Anforderungen in Alltagssprache beschreibt. Basierend auf OpenAI API oder nativen Ollama Modell unterstützt Zev eine Vielzahl von Betriebsszenarien, wie Dateiverwaltung, Prozessbetrachtung, Netzwerkinspektion und Git-Operationen. Zev wurde entwickelt, um die Schwelle für die Verwendung der Befehlszeile zu senken, und eignet sich für Entwickler und Anfänger. Benutzer müssen einen OpenAI-API-Schlüssel oder eine lokale Ollama-Umgebung konfigurieren, um Zev zu nutzen. Der Code von Zev ist auf GitHub als Open Source verfügbar, so dass Benutzer frei dazu beitragen und ihn anpassen können.

Funktionsliste

• Generierung von Terminalbefehlen in natürlicher Sprache, z. B. "show current directory disk usage".
• Unterstützt eine Vielzahl von Einsatzszenarien, einschließlich Dateimanipulation, Prozessmanagement, Netzwerkinspektion und Git-Befehle.
• Integration mit OpenAI API, um eine intelligente Befehlsgenerierung zu ermöglichen.
• Unterstützt native Ollama-Modelle und ermöglicht den Offline-Betrieb.
• Bietet eine API-Schlüsselverwaltungsfunktion für Benutzer zur Aktualisierung von Einstellungen.
• Offener Quellcode, Unterstützung für Beiträge der Gemeinschaft und Funktionserweiterungen.

Hilfe verwenden

Einbauverfahren

Zev ist ein in Python entwickeltes CLI-Tool mit einem einfachen Installations- und Konfigurationsprozess. Hier sind die detaillierten Schritte:

1. Klon-Lager
   Öffnen Sie ein Terminal und führen Sie den folgenden Befehl aus, um das GitHub-Repository von Zev zu klonen:

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

Sobald das Klonen abgeschlossen ist, wechseln Sie in das Projektverzeichnis:

cd zev

2. Installation von Abhängigkeiten
   Zev hängt von einer Python 3.6+ Umgebung ab. Stellen Sie sicher, dass Python installiert ist, und installieren Sie dann die erforderlichen Abhängigkeiten:

   pip install -r requirements.txt
   

   Zu den Abhängigkeiten gehören unter anderem die Python-Client-Bibliotheken von OpenAI, die Sie in der requirements.txt Ansicht in.

3. OpenAI-API-Schlüssel konfigurieren
   Wenn Sie Zev zum ersten Mal ausführen, werden Sie zur Eingabe eines OpenAI-API-Schlüssels aufgefordert. Benutzer müssen ein Konto auf der OpenAI-Website registrieren und einen Schlüssel erstellen. Führen Sie den folgenden Befehl aus, um die Konfiguration zu starten:

   python zev.py
   

   Geben Sie den Schlüssel nach Aufforderung ein, und der Schlüssel wird in der lokalen Konfigurationsdatei gespeichert.
   Wenn Sie den Schlüssel aktualisieren müssen, führen Sie aus:

   zev --update-key
   

4. (Optional) Konfigurieren des Ollama-Modells
   Wenn Sie Zev lokal ausführen möchten, können Sie Ollama installieren und ein lokales Modell konfigurieren:
   • Besuchen Sie die Ollama-Website, um Ollama herunterzuladen und zu installieren.
   • Starten Sie den Ollama-Dienst und wählen Sie z.B. das Modell aus:

     ollama run llama3
     

   • Aktivieren Sie den Ollama-Modus in der Zev-Konfiguration und führen Sie ihn aus:

     zev --use-ollama
     

   Dadurch kann Zev ein lokales Modell verwenden, das sich für Nutzer eignet, die keine vernetzte Umgebung haben oder die auf ihre Privatsphäre achten.

5. Lauf Zev
   Führen Sie nach Abschluss der Installation und Konfiguration den folgenden Befehl aus, um Zev zu starten:

   python zev.py
   

Hauptfunktionen

Die Hauptfunktion von Zev besteht darin, Terminalbefehle in natürlicher Sprache zu erzeugen. So funktioniert es:

• Abfrageterminal-Befehle
  Geben Sie in das Terminal zev gefolgt von einer Beschreibung in natürlicher Sprache. Zum Beispiel, um alle laufenden Python-Prozesse zu sehen:

  zev 'show all running python processes'
  

  Zev gibt etwas zurück wie ps aux | grep python Befehle. Die Benutzer können sie direkt zur Ausführung kopieren.

• Dateioperation
  Finden Sie z. B. kürzlich geänderte Dateien:

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

  Der Ausgabebefehl kann lauten:

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

• Abfrage von Systeminformationen
  Zeigen Sie die Verwendung der Disc an:

  zev 'show disk usage for current directory'
  

  Ausgabebefehle wie z.B.:

  du -sh .
  

• Netzwerk-Check
  Testen Sie die Netzwerkkonnektivität, zum Beispiel:

  zev 'check if google.com is reachable'
  

  Der Ausgabebefehl kann lauten:

  ping -c 4 google.com
  

• Git-Vorgänge
  Anzeigen von nicht übertragenen Änderungen in Git:

  zev 'show uncommitted changes in git'
  

  Ausgabebefehle wie z.B.:

  git status
  

Featured Function Bedienung

• Unterstützung des Ollama-Modells vor Ort
  Die Ausführung von Zev mit Ollama ist vollständig offline und schützt den Datenschutz. Einmal konfiguriert, ruft Zev automatisch das lokale Modell auf, um Befehle zu generieren, ohne dass eine Internetverbindung erforderlich ist.
  Beispiel:

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

  Befehl ausgeben:

  ls -la
  

• API-Schlüsselverwaltung
  Benutzer können ihren OpenAI-Schlüssel jederzeit aktualisieren oder das Modell wechseln. Ausführen:

  zev --update-key
  

  Geben Sie den neuen Schlüssel nach Aufforderung ein, und die Konfiguration wird sofort wirksam.

Vorsichtsmaßnahmen bei der Handhabung

• Stellen Sie sicher, dass Ihr Netzwerk stabil ist, um die OpenAI-API zu nutzen. Wenn Sie Ollama verwenden, müssen Sie den Modelldienst im Voraus starten.
• Die natürlichsprachliche Beschreibung der Eingabe ist so klar und spezifisch wie möglich, um Mehrdeutigkeit zu vermeiden. Zum Beispiel könnte "Dokumente auflisten" Folgendes ergeben lsund "Alle versteckten Dateien auflisten" erzeugt die ls -a.
• Die von Zev generierten Befehle dienen nur als Referenz, und es wird empfohlen, vor der Ausführung zu prüfen, ob die Befehle den Erwartungen entsprechen.

Erweiterte Nutzung

• Benutzerdefinierte Befehlserstellung
  Benutzer können Zevs GitHub-Repository forken, um den Code zu ändern und bestimmte Szenarien zu unterstützen. Zum Beispiel, um benutzerdefinierte Befehlsvorlagen hinzuzufügen oder um andere KI-Modelle zu unterstützen.
• Batchbetrieb
  Zev unterstützt derzeit nicht die Erzeugung von Batch-Befehlen, aber Benutzer können Zev über Skripte aufrufen, indem sie zum Beispiel ein Shell-Skript schreiben, das eine Schleife durch die zev Befehl, um mehrere Aufgaben zu erledigen.

Anwendungsszenario

1. Debugging-Umgebung für Entwickler
   Für Entwickler, die beim Debuggen von Code häufig Terminalbefehle verwenden, z. B. um den Status eines Prozesses oder einer Datei zu überprüfen, spart Zev Zeit, da Befehle schnell in natürlicher Sprache generiert werden können. Wenn Sie zum Beispiel "find processes on port 8080" eingeben, generiert Zev den folgenden Befehl lsof -i :8080.
2. Die Kommandozeile als Anfänger lernen
   Neulinge in der Befehlszeile sind oft frustriert, weil sie sich die komplexe Syntax nicht merken können. Deshalb senkt Zev die Hürden für das Lernen durch die Eingabe in natürlicher Sprache. Geben Sie zum Beispiel "Zeige alle Dateigrößen im aktuellen Ordner" ein, und Zev generiert ls -lhund hilft den Nutzern, sich schnell zurechtzufinden.
3. Tägliche Wartung für Systemadministratoren
   Für Systemadministratoren, die den Status eines Servers überprüfen oder eine Netzwerkdiagnose durchführen müssen, unterstützt Zev die schnelle Generierung von Befehlen wie "check disk space", um einen "check disk space"-Befehl zu erzeugen. df -hzur Verbesserung der Effizienz.

QA

1. Welche Betriebssysteme werden von Zev unterstützt?
   Zev unterstützt macOS, Linux und Windows (Python-Umgebung erforderlich). Einige Befehle müssen aufgrund von Systemunterschieden möglicherweise manuell angepasst werden.
2. Muss ich die OpenAI API verwenden?
   Zev unterstützt lokale Ollama-Modelle für diejenigen, die sie offline nutzen oder sich nicht auf Cloud-Dienste verlassen wollen.
3. Wie kann ich Code beisteuern?
   Interviews https://github.com/dtnewman/zevWeitere Informationen zum Beitrag zum Repository finden Sie auf der Seite des Repositorys CONTRIBUTING.md.
4. Sind die von Zev generierten Befehle sicher?
   Die von Zev generierten Befehle beruhen auf Benutzereingaben und Modellüberlegungen. Es wird empfohlen, den Inhalt der Befehle vor der Ausführung zu überprüfen, um potenzielle Risiken zu vermeiden.