Shell-AI: LLM に基づく自然言語理解のための CLI ツール

I.はじめに

AI技術の普及に伴い、一部の技術分野の敷居は徐々に低くなり、例えば、院生や非技術系専攻、さらにはその技術分野に足を踏み入れたことのない人にとっては、サーバーの導入や運用保守が全く分からないこともあります。 AI の大規模モデルを利用して非常に簡単に習得できるようになり、関連テクノロジーを使用していくつかの実際的な問題を解決できるようになりました。

たとえば、異なるオペレーティングシステムでは、CLI コマンドラインインターフェイスに接続して使用する必要が避けられず、多くのタスクをコマンドラインインターフェイスを使用して操作する必要があります。非技術者にとっては、Linuxやシェルスクリプトコマンドを全く学ばないと非常に難しいかもしれませんし、基礎がないまま学習しても多くの問題に遭遇して止まってしまいます。この問題を解決するために、今日はShell-AI と呼ばれる小さなツールを紹介します。これは、コマンドラインに自然言語理解の力をもたらす軽量の CLI ユーティリティです。

Shell-AI は単純な自然言語入力のみを必要とし、1 行のコマンド提案を提供して意図を実現するのに役立ちます。プロジェクトコード全体は200行未満で、特に非技術専門家にとって非常に使いやすく、多くの Linux またはシェルスクリプトコマンドを学習する必要がなく、自然言語を直接使用して操作することができ、専門的な技術または運用を行うことができます。メンテナンス担当者にとっても日常業務の効率が大幅に向上します。この記事では、Shell-AI ツールの使用方法を紹介し、日常業務におけるその必要性について説明します。

2. Shell-AI の概要

Shell-AI ( shai) は、コマンドラインに自然言語の理解をもたらす CLI ユーティリティです。実行したいことを自然言語で入力するだけで、shaiその意図を達成するための 1 行のコマンドが提案されます。Shell-AI は舞台裏で LLM の使用に LangChain を活用し、優れた InquirerPy の上にインタラクティブな CLI を構築します。

Shell-AIには次のような特徴があります。

自然言語入力: やりたいことを平易な英語 (またはサポートされている別の言語) で説明します。
コマンドの提案: 要件を達成する 1 行コマンドの提案を取得します。
クロスプラットフォーム: Linux、macOS、Windows で利用可能。
Azure の互換性: Shell-AI は Azure OpenAI デプロイメントをサポートするようになりました。

3. Shell-AIのインストール

まず、Python 環境が正常にインストールされていることを確認する必要があります。依存関係の競合を避けるために、Shell-AI をインストールするための仮想環境を作成することをお勧めします。具体的なインストール方法は、前の記事で何度も紹介しています。次に、 pip を直接使用して PyPI から Shell-AI をインストールします。

pip install shell-ai

4. Shell-AIの活用

4.1.環境変数

OPENAI_API_KEY : 必須。この環境変数を OpenAI API キーに設定します。OpenAI の公式 Web サイトで見つけることができます。

4.2. オプションの変数

OPENAI_MODEL: デフォルトはですgpt-3.5-turbo。必要に応じて、別の OpenAI モデルに設定できます。
SHAI_SUGGESTION_COUNT: デフォルトは 3 です。これを設定して、生成する候補の数を指定できます。
OPENAI_API_BASE: デフォルトはですhttps://api.openai.com/v1。プロキシまたはサービスエミュレータを指定するように設定できます。
OPENAI_ORGANIZATION: OpenAI組織ID
OPENAI_PROXY: OpenAIエージェント
OPENAI_API_TYPE: Azure デプロイメントを使用している場合は、「azure」に設定します。
AZURE_DEPLOYMENT_NAME: Azure デプロイ名 (Azure を使用する場合は必須)。
AZURE_API_BASE: Azure API ライブラリ (Azure を使用する場合に必要)。

4.3. 設定ファイル

これらの変数を JSON 構成ファイルに保存することもできます。

Linux/macOS の場合:~/.config/shell-ai/以下のconfig.json、chmod 600 ~/.config/shell-ai/config.jsonで保護します。
%APPDATA%\shell-ai\Windows の場合:以下の名前のconfig.jsonファイルを作成します。

例config.json:

{
  "OPENAI_API_KEY": "your_openai_api_key_here",
  "OPENAI_MODEL": "gpt-3.5-turbo-0613",
  "SHAI_SUGGESTION_COUNT": "3",
  "OPENAI_API_BASE":"your_open_ai_proxy_url"
}

アプリケーションはこのファイルが存在する場合はそこから読み取り、既存の環境変数を上書きします。

これらの構成を設定した後、アプリケーションを実行します。

4.5. ケーススタディ

インストールしたら、shaiコマンドを使用してユーティリティを呼び出すことができます。

V. まとめ

この記事では、自然言語理解の力をコマンドラインにもたらす軽量の CLI ユーティリティである Shell-AI と呼ばれる小さなツールを紹介します。Shell-AI は単純な自然言語入力のみを必要とし、1 行のコマンド提案を提供して意図を実現するのに役立ちます。プロジェクトコード全体は 200 行未満で、特に非技術専門家にとって非常に使いやすく、多くの Linux またはシェルスクリプトコマンドを学習する必要がなく、自然言語を直接使用して操作できます。同時に、専門的な技術者や運用保守担当者にとっても、日常業務の効率が大幅に向上します。

6. 参考文献

https://github.com/ricklamers/shell-ai