グロック CLIは、xAIのGrok-3モデルに基づいて開発されたオープンソースの端末AIアシスタントです。自然言語との対話を通じて、コマンドラインからファイル操作、コード編集、タスク自動化を行うことができます。ユーザーは複雑なコマンドを入力する必要はなく、日常的な言葉で必要なことを説明するだけで、Grok CLIはインテリジェントにツールを選択し、タスクを実行することができます。このプロジェクトはsuperagent-aiチームによってメンテナンスされ、GitHubでホストされており、開発者、運用スタッフ、効率的なターミナルを必要とするユーザーのためのグローバルインストールとカスタム設定をサポートしています。コードはMITライセンスに従い、コミュニティによって自由に貢献されている。
機能一覧
- 自然言語対話: 日常的な対話を通じて端末と対話することで、Grok CLIはユーザーの意図を理解し、それに応じてアクションを実行します。
- インテリジェントなファイル操作:自動的にファイルを表示、作成、編集し、バッチ処理や複雑なファイル操作をサポートします。
- Bashコマンドの統合:ダイアログ内でシェルコマンドを直接実行することで、ターミナル操作を簡素化。
- 自動ツール選択:ユーザーのニーズに応じて、AIがタスクを完了するために適切なツールをインテリジェントに選択します。
- インタラクティブなインターフェイス:Inkをベースに美しい端末インターフェイスを構築し、ユーザーエクスペリエンスを向上。
- カスタマイズされたコンフィギュレーション
.grok/GROK.md
このファイルは、プロジェクト固有の動作ルールを設定する。 - コード生成と編集:コードファイル(TypeScriptなど)を自動生成し、プロジェクトのコードスタイルに従います。
- プロジェクト管理:ディレクトリ構造の表示、テストの実行、lintの実行、その他の開発タスクのサポート。
ヘルプの使用
設置プロセス
Grok CLIはインストールが簡単で、npmを使ったグローバルインストールにも対応しています。詳しい手順は以下の通りです:
- 環境の確保
Node.js(推奨バージョン16以上)とnpmがシステムにインストールされていることを確認する。これは以下のコマンドで確認できる:node -v npm -v
- Grok CLIをグローバルにインストールする
ターミナルを開き、以下のコマンドを実行する:npm i -g @vibe-kit/grok-cli
一度インストールすれば、Grok CLIはどのディレクトリでも使用できるようになります。
- インストールの確認
以下のコマンドを入力し、インストールが成功したかどうかを確認する:grok --version
バージョン番号が返された場合、インストールは成功したことになる。
- APIキーの設定(オプション)
機能によってはxAIのAPIキーが必要な場合があります。キーを取得したら実行してください:grok config set api-key <你的密钥>
キーは、Grok CLI が Grok-3 モデルを呼び出すためにローカルに保存される。
使用方法
Grok CLIの中核は、自然言語を通じてターミナルと対話することだ。一度起動すれば、日常会話に似たコマンドを直接入力でき、AIがそれを解析して実行する。以下は、主な機能の詳細なフローである:
1.自然言語による対話
Grok CLI を起動して実行します:
grok
対話モードに入ったら、要件を直接入力します。例
- "Show contents of package.json "と入力すると、Grok CLI は以下のようになります。
cat package.json
コマンドを実行し、その結果を返す。 - hello.jsファイルを作成し、console.log('Hello World')に書き込む」と入力すると、Grok CLIが自動的にファイルを作成し、コードを書き込みます。
2.インテリジェントなファイル操作
Grok CLI は、プロジェクト・ファイルの迅速な管理に適した様々なファイル操作をサポートしています。例えば
- ドキュメントを見る: "View contents of src/index.ts" と入力すると、Grok CLI がファイルの内容を表示します。
- ドキュメントの作成例えば、"create a new utils.ts file containing an addition function "と入力すると、Grok CLIがファイルを生成してコードを書いてくれます:
/** Add two numbers */ export function add(a: number, b: number): number { return a + b; }
- バッチ交換: "Replace oldFunction with newFunction in all JS files" と入力すると、Grok CLI がディレクトリを巡回して置換を完了します。
3.Bashコマンドの統合
Grok CLI はシェルコマンドの直接実行をサポートしています。例えば
- run npm install "と入力すると、Grok CLI は以下のコマンドを実行します。
npm install
そして結果を表示する。 - show current directory structure "と入力すると、Grok CLIは以下のように実行される。
tree
もしかしたらls -R
コマンドはディレクトリツリーを返す。
4.自動ツール選択
Grok CLIは、タスクに基づいてインテリジェントにツールを選択します。例えば、"run tests and show results" と入力すると、プロジェクト内のテストフレームワーク (Jest や Mocha など) を自動的に認識して実行します! npm test
.
5.カスタム設定
Grok CLI は、プロジェクト・レベルでのカスタム・ルールをサポートしています。カスタムルールの作成 .grok/GROK.md
ファイルへの書き込み指示などである:
# Custom Instructions for Grok CLI
- Always use TypeScript for new code files.
- Use functional components with hooks for React.
- Add JSDoc comments for public functions.
Grok CLIは、これらのルールをプロジェクトディレクトリに自動的にロードします。例えば、Reactコンポーネントを生成する場合、クラスコンポーネントよりも関数コンポーネントが優先して使用されます。
6.ミッション・サポートの開発
Grok CLIは、開発者が一般的なタスクを実行するのに適しています。例えば
- ラン・リンター: "run lint check "と入力すると、Grok CLIは、以下のコマンドを実行します。
npm run lint
. - タイプチェックTypeScript typeをチェック」と入力すると、Grok CLIが実行されます。
npm run typecheck
. - プロジェクト建設ビルド・プロジェクト」と入力すると、Grok CLI が
npm run build
.
ほら
- ネットワーク要件Grok-3モデルを呼び出すためにネットワークが必要な機能があります。
- 能力の問題ファイルやディレクトリの読み取り権限と書き込み権限があることを確認してください。
- デバッグ・ログ問題が発生した場合は
grok --debug
詳細なログを見る
上記のようにすることで、ユーザーはGrok CLIをすぐに使い始めることができ、自然言語を使用して効率的に端末のタスクを完了することができます。[](https://github.com/superagent-ai/grok-cli)
アプリケーションシナリオ
- 開発者のための日々のコーディング
開発者はターミナルから自然言語でコードファイルの作成や編集、テストの実行、プロジェクトのビルドを素早く行うことができます。例えば、Reactプロジェクトを開発する場合、「Create a new React component in TypeScript」と入力すると、Grok CLIがプロジェクトのルールに準拠したコードファイルを生成します。 - O&Mタスクの自動化
システム管理者は、Grok CLIを使用して、ファイルの一括操作やシェルスクリプトの実行を行うことができます。例えば、「すべてのログファイルを検索し、30日以上古いファイルを削除する」と入力すると、Grok CLIが適切なコマンドを自動的に生成して実行します。 - 学習と実験
初心者はGrok CLIを使ってターミナルコマンドを学ぶことができます。例えば、"Explain the ls command "と入力すると、Grok CLIはコマンドの説明を返し、使い方を教えてくれます。 - オープンソースプロジェクトへの貢献
貢献者はGrok CLIを使って、オープンソースプロジェクトのコードを素早くナビゲートし、修正することができます。例えば、"find all TODO comments "と入力すると、Grok CLIはコードをスキャンし、関連する場所をリストアップします。
品質保証
- Grok CLIにはxAI APIキーが必要ですか?
一部の機能はGrok-3モデルを呼び出すためにAPIキーが必要ですが、基本機能はローカルで実行できます。キーの取得と設定はxAIのウェブサイトから行うことができる。 - プロジェクトでGrok CLIの動作をカスタマイズする方法を教えてください。
プロジェクトのルート・ディレクトリに.grok/GROK.md
ファイルを作成し、「常にTypeScriptを使用する」などのルールを記述すると、Grok CLIによって自動的に読み込まれます。 - Grok CLIはどのオペレーティング・システムをサポートしていますか?
Grok CLIは、Windows、macOS、Linuxでサポートされており、Node.jsをインストールしてすぐに実行できます。 - Grok CLIをオフラインで使用することはできますか?
一部の機能(ファイル操作やローカルコマンドなど)はオフラインでサポートされるが、AIを駆使した機能にはインターネット接続が必要だ。