Beginner Cli

Outil CLI pour débutants

Description

L'outil CLI pour débutant est une interface de ligne de commande basée sur Python conçue pour aider les nouveaux arrivants à apprendre et à exécuter des commandes Linux de manière interactive. Il fournit des fonctionnalités telles que des explications de commandes et des suggestions de commandes basées sur des scénarios.

Structure du projet

 .
├── 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

Pour installer l'outil CLI pour débutants, procédez comme suit :

1. Clonez le dépôt :

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

2. Accédez au répertoire du projet :

    cd Beginner-Cli

3. Exécutez le fichier Setup.sh :

   chmod +x setup.sh
   ./setup.sh

4. Obtenez la clé API Gemini :

   Pour accéder à l'API Gemini, vous devrez acquérir une clé API. Suivez ces étapes pour obtenir votre clé API :

   1. Accédez à Google AI Studio.
   2. Obtenez votre clé API. Veuillez noter que le niveau gratuit est disponible avec des limitations spécifiques.
   3. Saisissez votre clé API directement dans l'outil CLI et il la configurera automatiquement.

Usage

Pour utiliser l'outil CLI pour débutants, vous disposez de plusieurs options :

1. Explication de commande : fournissez des informations de base et des exemples d'une commande Linux spécifique.

   begcli -i [COMMAND]

   Exemple:

   begcli -i mkdir

   

2. Suggestion de commandes basées sur un scénario : suggère des commandes basées sur un scénario utilisateur.

   begcli -s [User Query]

   Exemple:

   begcli -s " I want to rename a file " 

   

Contribuer

Les contributions à l’outil CLI pour débutants sont les bienvenues ! Si vous souhaitez contribuer, veuillez suivre ces étapes :

1. Forkez le référentiel.
2. Créez une nouvelle branche ( git checkout -b feature/your_feature ).
3. Apportez vos modifications.
4. Validez vos modifications ( git commit -am 'Add some feature' ).
5. Poussez vers la branche ( git push origin feature/your_feature ).
6. Créez une nouvelle Pull Request.

Licence

Ce projet est sous licence MIT - voir le fichier LICENSE.md pour plus de détails.

Le projet utilise l'API Gemini fournie par GenAI dans le cadre de son niveau gratuit. Veuillez vous référer aux conditions d'utilisation de GenAI pour plus d'informations sur l'utilisation de leurs services.