Beginner Cli

CLI-Tool für Einsteiger

Beschreibung

Das Beginner CLI Tool ist eine Python-basierte Befehlszeilenschnittstelle, die Neulinge beim interaktiven Erlernen und Ausführen von Linux-Befehlen unterstützen soll. Es bietet Funktionen wie Befehlserklärungen und szenariobasierte Befehlsvorschläge.

Projektstruktur

 .
├── beg_cli
│   ├── argsparser.py        # Main script for command-line parsing
│   ├── config.ini           # Configuration file
│   ├── demo.py              # Demo script or additional functionality
│   ├── __init__.py          # Initialization file for the CLI package
│   └── __pycache__          # Cache directory (automatically generated)
│       └── argsparser.cpython-311.pyc
├── LICENSE.md               # License file
├── poetry.lock              # Poetry lock file (dependency lock)
├── pyproject.toml           # Poetry project configuration
├── README.md                # Project README file (you are here!)
└── tests
    └── __init__.py          # Initialization file for tests (if any)

Installation

Um das Beginner CLI Tool zu installieren, führen Sie die folgenden Schritte aus:

1. Klonen Sie das Repository:

   git clone https://github.com/Mindslayer001/Beginner-Cli.git

2. Navigieren Sie zum Projektverzeichnis:

    cd Beginner-Cli

3. Führen Sie Setup.sh aus:

   chmod +x setup.sh
   ./setup.sh

4. Erhalten Sie den Gemini-API-Schlüssel:

   Um Zugriff auf die Gemini-API zu erhalten, müssen Sie einen API-Schlüssel erwerben. Befolgen Sie diese Schritte, um Ihren API-Schlüssel zu erhalten:

   1. Navigieren Sie zu Google AI Studio.
   2. Besorgen Sie sich Ihren API-Schlüssel. Bitte beachten Sie, dass die kostenlose Stufe mit bestimmten Einschränkungen verfügbar ist.
   3. Geben Sie Ihren API-Schlüssel direkt in das CLI-Tool ein und es wird automatisch konfiguriert.

Verwendung

Um das Beginner CLI Tool zu verwenden, haben Sie mehrere Möglichkeiten:

1. Befehlserklärung : Stellen Sie grundlegende Informationen und Beispiele zu einem bestimmten Linux-Befehl bereit.

   begcli -i [COMMAND]

   Beispiel:

   begcli -i mkdir

   

2. Szenariobasierter Befehlsvorschlag : Schlägt Befehle basierend auf einem Benutzerszenario vor.

   begcli -s [User Query]

   Beispiel:

   begcli -s " I want to rename a file " 

   

Mitwirken

Beiträge zum CLI-Tool für Anfänger sind willkommen! Wenn Sie einen Beitrag leisten möchten, befolgen Sie bitte diese Schritte:

1. Forken Sie das Repository.
2. Erstellen Sie einen neuen Zweig ( git checkout -b feature/your_feature ).
3. Nehmen Sie Ihre Änderungen vor.
4. Übernehmen Sie Ihre Änderungen ( git commit -am 'Add some feature' ).
5. Zum Zweig pushen ( git push origin feature/your_feature ).
6. Erstellen Sie eine neue Pull-Anfrage.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei LICENSE.md.

Das Projekt nutzt die von GenAI im Rahmen ihres kostenlosen Kontingents bereitgestellte Gemini-API. Weitere Informationen zur Nutzung ihrer Dienste finden Sie in den Nutzungsbedingungen von GenAI.