ai shell

自然言語をシェルコマンドに変換する CLI。

GitHub Copilot X CLI からインスピレーションを受けていますが、誰でも利用できるオープンソースです。

AIシェル

設定

Node.js のサポートされる最小バージョンは v14 です

1. ai シェルをインストールします。

   npm install -g @builder.io/ai-shell

2. OpenAI から API キーを取得します

   注: まだアカウントを作成していない場合は、アカウントを作成して請求を設定する必要があります。

3. ai-shell が使用できるようにキーを設定します。

   ai config set OPENAI_KEY= < your token >

   これにより、ホーム ディレクトリに.ai-shellファイルが作成されます。

使用法

ai < prompt >

例えば：

ai list all log files

次に、次のような出力が表示され、提案されたコマンドを実行するか、プロンプトでコマンドを修正するか、キャンセルするかを選択できます。

◇  Your script:
│
│  find . -name " *.log "
│
◇  Explanation:
│
│  1. Searches for all files with the extension " .log " in the current directory and any subdirectories.
│
◆  Run this script ?
│  ● ✅ Yes (Lets go ! )
│  ○  Revise
│  ○  Cancel
└

特殊文字

一部のシェルは、 ?などの特定の文字を処理することに注意してください。または*または特にファイルパスのように見えるもの。奇妙な動作が発生する場合は、以下のようにプロンプ​​トを引用符で囲んで問題を回避できます。

ai ' what is my ip address '

チャットモード

ai chat

このモードを使用すると、AI と会話し、CLI を介して直接自然な会話形式で役立つ応答を受け取ることができます。

┌  Starting new conversation
│
◇  You:
│  how do I serve a redirect in express
│
◇  AI Shell:

In Express, you can use the `redirect () ` method to serve a redirect. The ` redirect() ` method takes one argument, which is the URL that you want to redirect to.

Here ' s an example:

```js
app.get( ' /oldurl ' , (req, res) => {
  res.redirect( ' /newurl ' );
});
```

サイレントモード（説明スキップ）

-sまたは--silentフラグを使用すると、説明セクションを無効にしてスキップできます。

ai -s list all log files

または、次のコマンドを使用してオプションを設定として保存します。

ai config set SILENT_MODE=true

カスタム API エンドポイント

OpenAI API エンドポイントをカスタムして OPENAI_API_ENDPOINT を設定できます（デフォルト: https://api.openai.com/v1 ）

ai config set OPENAI_API_ENDPOINT= < your proxy endpoint >

言語を設定する

AI シェルのデフォルト言語は英語ですが、以下に示すように、対応する言語キーを使用して好みの言語に簡単に切り替えることができます。

言語	鍵
英語	jp
簡体字中国語	zh-ハンス
繁体字中国語	ジ・ハント
スペイン語	エス
日本語	jp
韓国人	こ
フランス語	フランス
ドイツ語	デ
ロシア	る
ウクライナ語	英国
ベトナム語	ヴィ
アラビア語	あーる
ポルトガル語	ポイント
トルコ語	tr

たとえば、簡体字中国語に切り替えたい場合は、LANGUAGE 値を zh-Hans に設定することで切り替えることができます。

ai config set LANGUAGE=zh-Hans

これにより、言語が簡体字中国語に設定されます。

設定UI

より視覚的なインターフェイスを使用して構成オプションを表示および設定するには、次のように入力します。

ai config

以下のようなインタラクティブな UI を取得するには:

◆  Set config:
│  ○ OpenAI Key
│  ○ OpenAI API Endpoint
│  ○ Silent Mode
│  ● Model (gpt-4o-mini)
│  ○ Language
│  ○ Cancel
└

アップグレード中

インストールされているバージョンを次のように確認します。

ai --version

最新バージョンではない場合は、次を実行します。

npm update -g @builder.io/ai-shell

または、単に AI シェルを使用します。

ai update

よくある問題

429エラー

一部のユーザーは OpenAI から 429 を報告しています。これは、不適切な請求設定または過剰なクォータの使用が原因です。このガイドに従って修正してください。

このリンクから請求を有効にすることができます。 OpenAI からの有効な許可を受けていない場合は、必ず支払い方法を追加してください。

モチベーション

私は bash ウィザードではないので、どうしても copilot CLI にアクセスしたくて焦りました。

貢献する

バグの修正を手伝ったり、問題の機能を実装したりする場合 (ヒント: help wantedラベルに注目してください)、プロジェクトのセットアップ方法については、コントリビューション ガイドを参照してください。

クレジット

• 素晴らしいツールとこのアイデアを提供してくれた GitHub Copilot に感謝します。
• Hassan と、ワークフローとコードとフローの一部にインスピレーションを与えた aiccommit に関する彼の取り組みに感謝します。