Beginner Cli

Инструмент CLI для начинающих

Описание

Инструмент CLI для начинающих — это интерфейс командной строки на основе Python, предназначенный для помощи новичкам в изучении и интерактивном выполнении команд Linux. Он предоставляет такие функции, как пояснения команд и предложения команд на основе сценариев.

Структура проекта

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

Установка

Чтобы установить инструмент CLI для начинающих, выполните следующие действия:

1. Клонируем репозиторий:

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

2. Перейдите в каталог проекта:

    cd Beginner-Cli

3. Запустите Setup.sh:

   chmod +x setup.sh
   ./setup.sh

4. Получите ключ API Gemini:

   Чтобы получить доступ к API Gemini, вам необходимо получить ключ API. Выполните следующие действия, чтобы получить ключ API:

   1. Перейдите в Google AI Studio.
   2. Получите ключ API. Обратите внимание, что уровень бесплатного пользования доступен с определенными ограничениями.
   3. Введите свой ключ API непосредственно в инструмент CLI, и он настроит его автоматически.

Использование

Чтобы использовать инструмент CLI для начинающих, у вас есть несколько вариантов:

1. Объяснение команд : предоставьте основную информацию и примеры конкретных команд Linux.

   begcli -i [COMMAND]

   Пример:

   begcli -i mkdir

   

2. Предложение команды на основе сценария : предлагает команды на основе пользовательского сценария.

   begcli -s [User Query]

   Пример:

   begcli -s " I want to rename a file " 

   

Содействие

Вклад в инструмент CLI для начинающих приветствуется! Если вы хотите внести свой вклад, выполните следующие действия:

1. Форкните репозиторий.
2. Создайте новую ветку ( git checkout -b feature/your_feature ).
3. Внесите свои изменения.
4. Зафиксируйте изменения ( git commit -am 'Add some feature' ).
5. Нажмите на ветку ( git push origin feature/your_feature ).
6. Создайте новый запрос на включение.

Лицензия

Этот проект лицензируется по лицензии MIT — подробности см. в файле LICENSE.md.

Проект использует API Gemini, предоставляемый GenAI в рамках уровня бесплатного пользования. Пожалуйста, обратитесь к Условиям обслуживания GenAI для получения дополнительной информации об использовании их услуг.