CLI のインストールと使い方

このガイドでは、macOS への Remy CLI のインストール、サインイン、ローカルプロジェクトでのタスク実行、チャットの再開、CLI の更新、フィードバックの送信を説明します。

flowchart LR
    A["Node.js と npm を準備"] --> B["Remy CLI をインストール"]
    B --> C["サインイン"]
    C --> D["プロジェクトへ移動"]
    D --> E["タスクを開始"]
    E --> F["確認して続行"]

1. 始める前に

1.1 システムと実行環境の要件

CLI には Node.js と npm が必要です。 Remy CLI の標準の npm インストールでは、別途 Python や Rust をインストールする必要はありません。プロジェクトとテストには、それぞれの環境と依存関係が必要です。

ターミナルで設定を確認します。

node --version
npm --version

どちらのコマンドもバージョン番号を表示する必要があります。見つからない場合は、Node.js のウェブサイトから Mac に合ったインストーラーを入手し、インストール後に新しいターミナルを開いてください。Remy のインストール前に、現在の LTS リリースを選んでください。

1.2 モデルへのアクセス

Remy アカウントでサインインすると、そのアカウントで利用可能なモデルを使えます。標準のワークフローでは、モデルプロバイダーの別アカウントや API キーは不要です。

デスクトップアプリと CLI には別々にサインインしてください。 Remy Desktop にサインイン済みでも、CLI を初めて使うときはサインインが必要です。

2. CLI のインストールと確認

2.1 Remy CLI をインストールする

ターミナルで次を実行します。

npm install -g @corepassinc/remy

インストールの完了を待ちます。インストーラーが OS と Node.js 実行環境のアーキテクチャに合うコンポーネントを選択します。Apple silicon 用や Intel 用の CLI パッケージを別途選ぶ必要はありません。

2.2 コマンドを利用できるか確認する

インストール後、次を実行します。

remy --version
remy --help

ターミナルが remy を見つけられない場合は、新しいターミナルを開き、第 7 節のインストールとコマンドパスの説明を確認してください。

3. サインインとアカウントの確認

3.1 サインイン

ターミナルで次を実行します。

remy login

1. 開いたブラウザーでサインインを完了します。
2. ターミナルに戻り、結果を待ちます。
3. Signed in as … と表示されたら、次の手順へ進みます。

サインインが失敗したら、ターミナルのメッセージに従って接続を確認するか、サインインをやり直してください。

3.2 現在のアカウントを確認する

remy whoami

このコマンドで、サインイン中のアカウント、現在のアカウントスコープ、作業ディレクトリを確認します。チームアカウントを使う場合は、意図したチームが選択されているか確認してください。

3.3 実行環境を確認する

remy doctor

結果を基に、対処が必要な項目を判断します。

実行環境のチェックに合格しても、タスク全体の検証にはなりません。実際のタスクで、モデルへのアクセス、プロジェクトへのアクセス、結果が期待どおりに機能するか確認してください。

CLI からサインアウトするには、次を実行します。

remy logout

4. プロジェクトで対話型タスクを開始する

4.1 プロジェクトフォルダーへ移動する

ターミナルで作業したいプロジェクトへ移動し、Remy を開始します。

cd "/path/to/project"
remy

/path/to/project を、実際のローカルプロジェクトのパスに置き換えてください。

Remy の起動時にプロジェクトフォルダーを指定することもできます。

remy --workspace "/path/to/project"

開始前にフォルダーを確認してください。 CLI は現在の作業ディレクトリを基準に動作します。別のプロジェクトで作業するには、対話セッションを終了し、別のフォルダーへ移動するか、--workspace で Remy を起動します。

4.2 モデルを選んでタスクを送信する

Remy の対話画面で操作します。

1. F2 または /model で利用可能なモデルを表示します。
2. モデルを選びます。推論設定があるモデルでは Ctrl+U で調整します。
3. 入力欄にタスクを説明し、Enter で送信します。

macOS のターミナルでは Option+Enter で改行できます。Ctrl+G でキーボードショートカットと利用可能なオプションを確認できます。

タスク開始前にモデルを選択してください。CLI に表示される一覧は、現在のアカウントで利用できるモデルを示します。

4.3 小さな変更を加える

既存のプロジェクトの実際の問題を選びます。以下は注文一覧のフィルタリングとページネーションの例です。機能と動作はご自身のプロジェクトに合わせてください。

まず関連するコードを理解します。

このプロジェクトのドキュメントと関連する指示を読んでください。
注文一覧のファイル、フィルタリングのロジック、ページネーションのロジック、テストを特定してください。

分析だけを行ってください。ファイルの編集、依存関係のインストール、コミット、プッシュは行わないでください。

Remy がタスクを理解しているか確認したら、同じチャットで続けます。

注文一覧の 3 ページ目でステータスフィルターを変えると、一覧が空に見えます。
1 ページ目に戻ると結果が表示されます。

問題を特定して修正し、フィルター変更時にページ番号がリセットされるようにしてください。
関連するロジックだけを変更し、関連するテストを追加して実行してください。
完了したら、変更ファイル、チェック結果、完了できなかったチェックをまとめてください。

まだコードのコミットやプッシュは行わないでください。

Remy が追加情報や確認を求めたら、内容を読んでから応答してください。/permissions で現在のチャットの操作権限を確認し、画面の案内に従って設定を選びます。

4.4 結果を確認して続ける

Git を使うプロジェクトでは、同じプロジェクトで別のターミナルを開き、未コミットの変更を確認します。

git status --short
git diff

既定では、git diff は追跡済みファイルの未ステージの変更を表示します。新規ファイルの内容やステージ済みの変更は表示しません。ステージ済みの変更は git diff --cached、新規ファイルは直接開いて確認してください。表示される変更には、タスク開始前からの作業も含まれる場合があります。

結果を改善するには、元のチャットで起きたこと、期待したこと、変えるべきことを説明します。

ページ番号はリセットされるようになりましたが、一覧が更新されません。
フィルター変更時に、すぐに新しいデータをリクエストする必要があります。

この問題だけを修正し、関連するテストを追加して実行し、
変更とチェック結果をまとめてください。まだコードのコミットやプッシュは行わないでください。

4.5 よく使うキーボードショートカット

5. コマンドとチャットの継続

5.1 コマンドの入力場所を知る

npm install などのインストールコマンドは、タスクのプロンプトとして Remy に送るのではなく、システムターミナルで実行してください。

5.2 よく使う対話コマンド

新しいチャットを始めたり既存のものを再開したりする前に、現在のタスクを完了し、プロジェクトの実際のファイルを確認してください。

5.3 過去のチャットを一覧表示する

システムターミナルで次を実行します。

remy history list

現在のアカウントスコープ内で、現在のプロジェクトのチャットを一覧表示します。対話画面では /resume または Ctrl+R でチャットを選んで続けます。

表示できるチャットは、サインイン中のアカウント、チームスコープ、プロジェクトフォルダーによって異なります。ローカル履歴にアクセスできても、すべての端末が自動同期されるわけではありません。

5.4 単発のタスクを実行する

継続的な会話が不要な明確なタスクには、次を使います。

remy exec "このプロジェクトの README を読み、プロジェクトとテストの実行方法を要約してください。分析だけを行い、ファイルは編集しないでください。"

コマンドがそのタスクを実行し、結果を出力します。追加の指示が必要な作業では、remy で対話モードを開始してください。

ローカルの参考資料を提供するには、ファイルを添付します。

remy exec --attach "./requirements.md" "この要件を読み、このプロジェクトで影響を受けるモジュールと実装手順を特定してください。まだファイルは編集しないでください。"

ファイルパスをパソコン上に存在するファイルに置き換えます。ほかのオプションは次で確認します。

remy exec --help

6. Remy CLI を更新する

6.1 バージョンを確認する

remy --version

6.2 標準リリースを更新する

現在のタスクを完了して Remy の対話画面を終了し、次を実行します。

npm install -g @corepassinc/remy

インストールが完了したら、再度確認します。

remy --version
remy --help

古いバージョンのままなら、ターミナルがどのコマンドを見つけているか確認します。

command -v remy
npm prefix -g

Node.js のバージョン管理ツールを使っている場合、Node.js 環境ごとにグローバルのインストール先が異なる場合があります。環境を切り替えたら、現在の環境での Remy のインストールとコマンドパスを確認してください。

7. トラブルシューティングと既知の制限

7.1 インストールと実行環境の問題

7.2 対象範囲と制限

• このガイドは Apple silicon と Intel の macOS を対象とします。
• ローカルタスクはパソコン、ターミナルセッション、プロジェクト環境に依存します。必要な環境を利用可能な状態に保ってください。
• ツールへのアクセスはクライアント間で異なります。CLI の任意のツールは、診断結果と実際の設定に依存します。
• 現在、CLI は個々の回答への高評価・低評価に対応していません。製品の問題には、次節のフィードバックコマンドを使ってください。
• チャットを再開してもファイルは元に戻りません。続行前に現在のファイルの状態を確認してください。

8. ヘルプとフィードバックの送信

8.1 コマンドのヘルプを見る

remy --help
remy doctor --help
remy feedback send --help

Remy 内では、/help でコマンド、Ctrl+G でショートカットを確認できます。

8.2 問題を説明する

問題の説明を feedback.txt などの UTF-8 テキストファイルに保存します。再現手順、期待したこと、起きたこと、エラーメッセージ、バージョン情報を含めてください。

8.3 プレビューと送信

まず報告をプレビューします。

remy feedback send --type bug --impact moderate --description-file "./feedback.txt" --dry-run

--dry-run は報告を送信せず、プレビューだけを表示します。説明とフィードバックのオプションを確認したら、このフラグを外して再実行します。

remy feedback send --type bug --impact moderate --description-file "./feedback.txt"

CLI がプレビューを表示し、確認のため send の入力を求めます。それ以外を入力するとキャンセルします。

問題に合う種類と影響度を選んでください。例の bug と moderate は、あくまで例です。

コマンドが明確に成功を確認し、フィードバック ID を返した場合だけ、送信済みと判断してください。Result unknown は、CLI が確実な送信結果を受け取れなかったことを意味します。重複報告を避けるため、再送前にサポートに確認してください。

CLI の起動、サインイン、フィードバックコマンドの利用ができない場合は、support@corepass.com までお問い合わせください。

8.4 関連ガイド