Beginner CLI Tool

Description

The Beginner CLI Tool is a Python-based command-line interface designed to assist newcomers in learning and executing Linux commands interactively. It provides features such as command explanations and scenario-based command suggestions.

Project Structure

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

To install the Beginner CLI Tool, follow these steps:

1. Clone the repository:

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

2. Navigate to the project directory:

   cd Beginner-Cli
   

3. Run the Setup.sh:

   chmod +x setup.sh
   ./setup.sh
   

4. Obtain Gemini API Key:

   To gain access to the Gemini API, you'll need to acquire an API key. Follow these steps to obtain your API key:

   1. Navigate to Google AI Studio.
   2. Obtain your API key. Please note that the free tier is available with specific limitations.
   3. Input your API key directly into the CLI tool, and it will configure it automatically.

Usage

To use the Beginner CLI Tool, you have several options:

1. Command Explainer: Provide basic information and examples of a specific Linux command.

   begcli -i [COMMAND]
   

   Example:

   begcli -i mkdir
   

   

2. Scenario-based Command Suggestion: Suggests commands based on a user scenario.

   begcli -s [User Query]
   

   Example:

   begcli -s "I want to rename a file"
   

   

Contributing

Contributions to the Beginner CLI Tool are welcomed! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your_feature).
3. Make your changes.
4. Commit your changes (git commit -am 'Add some feature').
5. Push to the branch (git push origin feature/your_feature).
6. Create a new Pull Request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

The project utilizes the Gemini API provided by GenAI under their free tier. Please refer to the GenAI Terms of Service for more information about the usage of their services.