hal2023 cli

OpenaiのChatGptとチャットする簡単なスクリプト

索引

• 導入
• はじめる
• スクリーンショットとデモ
• 要件
• インストール
• 使用法
• プロジェクト構造
• ドキュメント
• Openaiのデータポリシー
• クレジット

導入

カルトクラシック「2001：A Space Odyssey」の悪名高いHAL9000に触発されたこのシンプルなCLIは、OpenaiのChatGPTと対話して画像を生成することができます。

はじめる

このCLIを使用するには、OpenAIのAPIキーが必要です。このリンクを開き、自分用にAPIキーを生成します。インストールすると、このCLIは、 Homeディレクトリに.chat-api-keyというファイルに個人的なAPIキーを保存します。

このCLIは、デフォルトでgpt-3.5-turboモデルを使用しています。詳細については、こちらをご覧ください。

text-davinci-003モデルと対話するには、 -davinciでクエリを開始し、その後スペースと残りのクエリを開始します。

gpt-4モデルも利用できます。 -gpt4でプロンプトを開始し、その後にクエリの残りの部分を使用します。

スクリーンショット

要件

• カール
• JQ
• wget

オプション

• Glowは、出力のフォーマットの改善に役立ちます。

インストール

curl -sS https://github.com/Brutuski/hal2023-cli/blob/main/build.sh | sudo -E bash

手動インストール

• ここから最新リリースをダウンロードしてください。
• それを解凍して、 hal2023 /usr/local/binにコピーします。
• 選択した任意のディレクトリにコピーできますが、 $PATHにパスを追加することを忘れないでください。
• openai APIキーをホームディレクトリに保存します〜 ~/.chat-gpt-api 。スペースやニューラインのないファイルにAPIキーのみを貼り付けます。

使用法

• コマンドhal2023を実行します

• 終了するには、 exitまたはquit入力するだけで、 :q

• マルチラインプロンプトはとしてサポートされています。 enter 1回押して、新しいラインでプロンプトを続けます。 enter 2回押してプロンプトを送信します。

• デフォルトモデルはgpt-3.5-turboです。 text-davinci-003モデルと対話したい場合は、 -davinciでプロンプトを開始するだけです

• gpt-4モデルと対話するには、 -gpt4でプロンプトを開始し、その後クエリが続きます。

• 画像生成が追加されました。 -imageを使用して入力を簡単に開始し、その後に画像プロンプトが続きます。生成された画像URLは、tny.im apiを使用して短縮され、表示されます。

• -emailまたは--eを入力し、Enterを押して、クイックメール生成プロセスを行います。

• タイプ-articleまたは--aを入力し、Enterを押して、迅速な記事生成プロセスを行います。

• タイプ-cmdに続いてクエリが続き、HE端末で実行できるシングルラインシェルコマンドを生成します。

• その他のオプション：

  make check
  make about
  make help

• v1.4.1の時点で履歴機能が追加されています。履歴ファイルは~/.hal2023_history.txtに作成および維持されます。

プロジェクト構造

 ├── hal2023                     # Main script
├── README.md                   # Documentation file
├── CONTRIBUTING.md             # Contributing document
├── CODE_OF_CONDUCT.md          # Code of Conduct document
├── build.sh                    # To install, check requirements and take API key input
├── image-assets                # Directory for all documentation related image assets
├── .gitignore                  # File to primarily exclude .idea and .DS_Store
├── .github                  
  ├── CHANGELOG.md              # Changelog
  ├── ISSUES_TEMPLATE.md        # Issues reporting template
  └── PULL_REQUEST_TEMPLATE.md  # Pull request submission template
└── LICENSE                     # MIT License file

ドキュメント

問題のテンプレート。問題や機能のリクエストはこちらで報告してください。

変更を変更することで変更できます

貢献するには、貢献をチェックしてリクエストテンプレートをプルしてください

行動規範

Openaiのデータポリシー

Openaiのデータ使用ポリシーを参照して、クエリとプロンプトがどのように処理されているかについて情報を提供し続けてください。

クレジット

インストールスクリプトは、Bash-Script-Templateに触発されました。以前に使用されたMakefileの方法と別のcheck_requirements.shスクリプトを置き換えました。