Bimbus AI

Bimbus AI ist ein leistungsfähiges Kommandozeilen-Tool, das mit Node.js entwickelt wurde und die fortschrittlichen Sprachmodelle von OpenAI nutzt, um automatisch umfassende Dokumentationen für Code-Dateien zu generieren.

Übersicht

Bimbus AI ermöglicht es Entwicklern, ihre Code-Dateien schnell und einfach zu dokumentieren, ohne dass sie selbst umfangreiche Dokumentationen erstellen müssen. Das Tool unterstützt alle Dateitypen und Projekte und kann problemlos in bestehende Workflows integriert werden.

Systemanforderungen

Um Bimbus AI zu verwenden, benötigen Sie:

• Node.js (Version 16 oder höher)
• npm (Version 8 oder höher)

Installation

Die Installation von Bimbus AI erfolgt über den folgenden Befehl: $ git clone https://github.com/bitgangstudio/bimbus-cli.git $ cd bimbus-cli $ npm install $ npm run build

OpenAI API

Um Bimbus AI zu verwenden, benötigen Sie einen API-Schlüssel von OpenAI. Sie können einen API-Schlüssel erstellen, indem Sie sich auf der OpenAI-Website anmelden und die Anweisungen folgen.

Verwendung

Um Dokumentationen mit Bimbus AI zu generieren, führen Sie den folgenden Befehl aus: $ node dist/index.js -t <API-Token> -i <Eingabedatei> -m <Modell> Das Tool akzeptiert die folgenden Argumente:

• -t oder --token: Gibt den OpenAI-Zugriffsschlüssel an.
• -i oder --input: Gibt den Pfad zur Eingabedatei an, für die eine Dokumentation generiert werden soll.
• -m oder --model: Gibt das OpenAI-Modell an, das für die Dokumentation verwendet werden soll (Standard: gpt-3.5-turbo).
• -o oder --output (optional): Gibt den Ausgabepfad an, in dem die generierte Dokumentation gespeichert werden soll.
• -f oder --filetype (optional): Gibt den Dateityp der generierten Dokumentation an (Standard: markdown).
• -k oder --keep (optional): Gibt an, ob die Meta-/Verarbeitungsdateien, die während der Dokumentationserstellung verwendet werden, beibehalten werden sollen.
• -v oder --verbose (optional): Aktiviert die detaillierte Ausgabe.
• -h oder --help: Zeigt die Hilfe-Nachricht für Bimbus AI an.

Beispiele

Hier sind einige Beispiele für die Verwendung von Bimbus AI:

• Grundlegende Verwendung: $ node dist/index.js -t <API-Token> -i path/to/file.js
• Angabe eines Ausgabepfads: $ node dist/index.js -t <API-Token> -i path/to/file.py -o output/docs/
• Anpassen des Dateityps der generierten Dokumentation: $ node dist/index.js -t <API-Token> -i path/to/file.ts -f html
• Aktivieren der detaillierten Ausgabe: $ node dist/index.js -t <API-Token> -i path/to/file.py -v

Lizenz

Bimbus AI wird unter der MIT-Lizenz veröffentlicht.

Beitrag und Fehlermeldungen

Wir begrüßen Beiträge und Feedback! Wenn Sie Probleme oder Vorschläge für Verbesserungen haben, bitten wir Sie, diese im Issue-Tracker zu melden. Pull-Anfragen sind auch willkommen.

Mit Bimbus AI können Sie Ihre Code-Dokumentation schnell und einfach erstellen und Ihre Entwicklungseffizienz steigern.