Beginner Cli

初心者向け CLI ツール

説明

Beginner CLI ツールは、初心者が Linux コマンドを対話的に学習および実行できるように設計された Python ベースのコマンドライン インターフェイスです。コマンドの説明やシナリオベースのコマンドの提案などの機能を提供します。

プロジェクトの構造

 .
├── 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. Gemini API キーを取得します。

   Gemini API にアクセスするには、API キーを取得する必要があります。 API キーを取得するには、次の手順に従います。

   1. Google AIスタジオに移動します。
   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 ファイルを参照してください。

このプロジェクトでは、GenAI が無料利用枠で提供する Gemini API を利用します。 GenAI のサービスの使用方法の詳細については、GenAI の利用規約を参照してください。