ai shell

Eine CLI, die natürliche Sprache in Shell-Befehle umwandelt.

Inspiriert von der GitHub Copilot X CLI, aber Open Source für alle.

KI-Shell

Aufstellen

Die unterstützte Mindestversion von Node.js ist v14

1. Installieren Sie die Ai-Shell :

   npm install -g @builder.io/ai-shell

2. Rufen Sie Ihren API-Schlüssel von OpenAI ab

   Hinweis: Falls noch nicht geschehen, müssen Sie ein Konto erstellen und die Abrechnung einrichten.

3. Legen Sie den Schlüssel fest, damit Ai-Shell ihn verwenden kann:

   ai config set OPENAI_KEY= < your token >

   Dadurch wird eine .ai-shell Datei in Ihrem Home-Verzeichnis erstellt.

Verwendung

ai < prompt >

Zum Beispiel:

ai list all log files

Dann erhalten Sie eine Ausgabe wie diese, in der Sie wählen können, ob Sie den vorgeschlagenen Befehl ausführen, den Befehl über eine Eingabeaufforderung überarbeiten oder abbrechen möchten:

◇  Your script:
│
│  find . -name " *.log "
│
◇  Explanation:
│
│  1. Searches for all files with the extension " .log " in the current directory and any subdirectories.
│
◆  Run this script ?
│  ● ✅ Yes (Lets go ! )
│  ○  Revise
│  ○  Cancel
└

Sonderzeichen

Beachten Sie, dass einige Shells bestimmte Zeichen wie das ? verarbeiten. oder * oder Dinge, die speziell wie Dateipfade aussehen. Wenn Sie seltsame Verhaltensweisen feststellen, können Sie die Eingabeaufforderung wie folgt in Anführungszeichen setzen, um Probleme zu vermeiden:

ai ' what is my ip address '

Chat-Modus

ai chat

In diesem Modus können Sie ein Gespräch mit der KI führen und hilfreiche Antworten auf natürliche, gesprächige Weise direkt über die CLI erhalten:

┌  Starting new conversation
│
◇  You:
│  how do I serve a redirect in express
│
◇  AI Shell:

In Express, you can use the `redirect () ` method to serve a redirect. The ` redirect() ` method takes one argument, which is the URL that you want to redirect to.

Here ' s an example:

```js
app.get( ' /oldurl ' , (req, res) => {
  res.redirect( ' /newurl ' );
});
```

Stiller Modus (Erklärungen überspringen)

Sie können den Erklärungsabschnitt deaktivieren und überspringen, indem Sie das Flag -s oder --silent verwenden

ai -s list all log files

oder speichern Sie die Option mit diesem Befehl als Präferenz:

ai config set SILENT_MODE=true

Benutzerdefinierter API-Endpunkt

Sie können den OpenAI-API-Endpunkt anpassen, um OPENAI_API_ENDPOINT festzulegen (Standard: https://api.openai.com/v1 ).

ai config set OPENAI_API_ENDPOINT= < your proxy endpoint >

Sprache einstellen

Die Standardsprache der AI Shell ist Englisch, Sie können jedoch ganz einfach zu Ihrer bevorzugten Sprache wechseln, indem Sie die entsprechenden Sprachtasten verwenden, wie unten gezeigt:

Sprache	Schlüssel
Englisch	de
Vereinfachtes Chinesisch	zh-Hans
Traditionelles Chinesisch	zh-Hant
Spanisch	es
japanisch	jp
Koreanisch	ko
Französisch	fr
Deutsch	de
Russisch	ru
ukrainisch	Vereinigtes Königreich
Vietnamesisch	vi
Arabisch	ar
Portugiesisch	pt
Türkisch	tr

Wenn Sie beispielsweise zu vereinfachtem Chinesisch wechseln möchten, können Sie dies tun, indem Sie den LANGUAGE-Wert auf zh-Hans setzen:

ai config set LANGUAGE=zh-Hans

Dadurch wird Ihre Sprache auf vereinfachtes Chinesisch eingestellt.

Benutzeroberfläche konfigurieren

Um eine visuellere Oberfläche zum Anzeigen und Festlegen von Konfigurationsoptionen zu verwenden, können Sie Folgendes eingeben:

ai config

So erhalten Sie eine interaktive Benutzeroberfläche wie unten:

◆  Set config:
│  ○ OpenAI Key
│  ○ OpenAI API Endpoint
│  ○ Silent Mode
│  ● Model (gpt-4o-mini)
│  ○ Language
│  ○ Cancel
└

Upgrade

Überprüfen Sie die installierte Version mit:

ai --version

Wenn es nicht die neueste Version ist, führen Sie Folgendes aus:

npm update -g @builder.io/ai-shell

Oder verwenden Sie einfach die AI-Shell:

ai update

Häufige Probleme

429 Fehler

Einige Benutzer melden einen 429 von OpenAI. Dies ist auf eine falsche Abrechnungseinrichtung oder eine übermäßige Kontingentnutzung zurückzuführen. Bitte befolgen Sie diese Anleitung, um das Problem zu beheben.

Unter diesem Link können Sie die Abrechnung aktivieren. Stellen Sie sicher, dass Sie eine Zahlungsmethode hinzufügen, wenn kein aktiver Zuschuss von OpenAI besteht.

Motivation

Ich bin kein Bash-Zauberer und sehnte mich nach Zugriff auf die Copilot-CLI und wurde ungeduldig.

Mitwirken

Wenn Sie helfen möchten, einen Fehler zu beheben oder eine Funktion in Issues zu implementieren (Tipp: Achten Sie auf die Kennzeichnung help wanted ), schauen Sie sich den Beitragsleitfaden an, um zu erfahren, wie Sie das Projekt einrichten.

Kredit

• Vielen Dank an GitHub Copilot für die tollen Tools und die Idee dazu.
• Vielen Dank an Hassan und seine Arbeit an aicommits, die den Workflow und einige Teile des Codes und der Abläufe inspiriert haben