Git Product home page Git Product logo

muellermh / doku-creator Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 22 KB

Dieses Go-Programm ermöglicht es Benutzern, den Inhalt von Dateien in einem Ordner rekursiv zu durchsuchen und automatisch eine Markdown-Dokumentation für jede Datei zu erstellen. Die Dokumentation wird mithilfe der OpenAI API generiert und enthält eine Zusammenfassung des Codes sowie mögliche nächste Schritte.

Go 100.00%

doku-creator's Introduction

Doku Creator zur automatisierten Dokumentation

Dieses Go-Programm ermöglicht es Benutzern, den Inhalt von Dateien in einem Ordner rekursiv zu durchsuchen und automatisch eine Markdown-Dokumentation für jede Datei zu erstellen. Die Dokumentation wird mithilfe der OpenAI API generiert und enthält eine Zusammenfassung des Codes sowie mögliche nächste Schritte.

Verwendung

  • Laden Sie das Programm herunter und speichern Sie es auf Ihrem Computer.
  • Expose das ENV: OPEN_AI_API_TOKEN mit deinem Open.ai API Token
  • Öffnen Sie eine Befehlszeile oder ein Terminal und navigieren Sie zum Speicherort der heruntergeladenen Datei.
  • Geben Sie den Befehl "go run main.go " ein und drücken Sie die Eingabetaste.
  • Der Befehl führt das Programm aus und generiert automatisch eine Markdown-Datei für jede Go-Datei im angegebenen Repository.

Enviorment Variablen

Expose das ENV: OPEN_AI_API_TOKEN mit deinem Open.ai API Token

Parameter

<Dateiendung> (erforderlich): Die Dateiendung der zu durchsuchenden Dateien. Zum Beispiel "go" für Go-Dateien. <Repository-URL> (erforderlich): Die URL des Repositories, das durchsucht werden soll.

Beispiel

go run main.go go https://github.com/mein-benutzername/mein-repo.git

Dieser Befehl durchsucht das Repository "mein-repo" nach allen Go-Dateien und generiert automatisch eine Markdown-Datei für jede gefundene Datei.

Funktionen

  • Durchsucht rekursiv alle Dateien im angegebenen Repository.
  • Generiert automatisch eine Markdown-Datei für jede gefundene Go-Datei.
  • Verwendet die OpenAI API, um eine Zusammenfassung des Codes und mögliche nächste Schritte zu generieren.
  • Erstellt automatisch ein Verzeichnis für die Dokumentation, falls nicht vorhanden.

Anforderungen

Um dieses Programm ausführen zu können, benötigen Sie eine funktionierende Go-Installation sowie einen API-Schlüssel für die OpenAI API. Der API-Schlüssel muss als ENV-Variable OPEN_AI_API_TOKEN vorliegen. Außerdem muss das Git-Tool installiert sein, um das Repository zu klonen.

Autor

Dieses Programm wurde von Manuel Engelhardt entwickelt, einem erfahrenen Softwareentwickler und Gründer der Firma ITDevOps.de.

ITDevOps.de ist ein Unternehmen, das sich auf die Entwicklung von Softwarelösungen und die Bereitstellung von IT-Beratungsdiensten spezialisiert hat. Mit einem Team von erfahrenen Entwicklern und Beratern bietet ITDevOps.de seinen Kunden eine breite Palette von Dienstleistungen an, darunter Softwareentwicklung, Systemadministration, DevOps-Implementierung, Cloud-Beratung und mehr.

Manuel Engelhardt ist ein erfahrener Entwickler, der über umfangreiche Kenntnisse in den Bereichen Softwareentwicklung, Systemadministration, Cloud-Computing und DevOps verfügt. In seiner Freizeit trägt Manuel Engelhardt zur Open-Source-Community bei und teilt sein Wissen durch Konferenzvorträge und Schulungen.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.