Skip to content

Commit 9270263

Browse files
author
Development Team
committed
Merge branch 'fix/commands-documentation-20251104'
チャット内コマンドドキュメントの大規模修正(21コマンド、60%) 修正内容: - 優先度1(重大な誤り): 8コマンド - 優先度2(部分的な誤り): 13コマンド - 修正箇所: 42箇所(2ファイル) - 教訓ドキュメント: 問題12として記録 検証: 202511040932-all-commands-severity.md
2 parents 0e6a989 + 9d3765e commit 9270263

3 files changed

Lines changed: 220 additions & 76 deletions

File tree

‎docs/01_for-users/02_features/01_chat.md‎

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -117,37 +117,37 @@ alias qr='q chat --resume'
117117

118118
| コマンド | 詳細説明 | 使用シーン |
119119
|---------|---------|-----------|
120-
| `/help` | チャット内コマンドのヘルプを表示。利用可能なコマンド一覧と簡単な説明を確認できる | コマンドの使い方を忘れた時、利用可能なコマンドを確認したい時 |
120+
| `/help [コマンド名]` | チャット内コマンドのヘルプを表示。コマンド名を指定すると、そのコマンドの詳細ヘルプを表示 | コマンドの使い方を忘れた時、利用可能なコマンドを確認したい時、特定のコマンドの詳細を知りたい時 |
121121
| `/quit` | チャットセッションを終了してターミナルに戻る。会話履歴は保存される | 作業を終了する時、別のタスクに切り替える時 |
122-
| `/exit` | `/quit`と同じ。チャットセッションを終了する | 作業を終了する時(`/quit`の別名) |
122+
| `/exit` | チャットセッションを終了してターミナルに戻る(`/quit`と同じ) | 作業を終了する時、別のタスクに切り替える時 |
123123
| `/clear` | 現在の会話履歴をクリア。新しい話題を始める時に便利 | 会話が長くなりすぎた時、全く別の話題に切り替える時 |
124+
| `/paste` | クリップボードから画像を貼り付け | 画像をチャットに追加したい時、スクリーンショットを共有したい時 |
124125

125126
### 会話管理
126127

127128
| コマンド | 詳細説明 | 使用シーン |
128129
|---------|------|-----------|
129-
| `/save [ファイル名]` | 現在の会話をJSONファイルに保存。ファイル名省略時は自動生成される | 重要な会話を記録したい時、後で参照したい会話を保存する時 |
130-
| `/load [ファイル名]` | 保存した会話をファイルから読み込んで復元。過去の会話を継続できる | 以前の会話を再開したい時、別のセッションで保存した会話を引き継ぐ時 |
131-
| `/tangent` | Tangentモード(会話の分岐)に入る/戻る。キーボードショートカット: `Ctrl+T` | メインの会話を保持したまま、別の話題を試したい時 |
130+
| `/save <パス> [オプション]` | 現在の会話をJSONファイルに保存。`-f`オプションで既存ファイルを上書き可能 | 重要な会話を記録したい時、後で参照したい会話を保存する時 |
131+
| `/load <パス>` | 保存した会話をファイルから読み込んで復元。過去の会話を継続できる | 以前の会話を再開したい時、別のセッションで保存した会話を引き継ぐ時 |
132+
| `/tangent [サブコマンド]` | (Beta)Tangentモード(会話の分岐)に入る/戻る。`tail`サブコマンドで最後のエントリを保持して終了。要設定: `q settings chat.enableTangentMode true` | メインの会話を保持したまま、別の話題を試したい時 |
132133

133-
> **🧪 実験的機能**: Tangent Mode機能は開発中です。`q settings chat.enableTangentMode true`または`/experiment`で有効化してください。
134+
> **🧪 Beta機能**: Tangent Mode機能は開発中です。`q settings chat.enableTangentMode true`または`/experiment`で有効化してください。
134135
135136
### コンテキスト管理
136137

137138
| コマンド | 詳細説明 | 使用シーン |
138139
|---------|---------|-----------|
139-
| `/context` | 現在のコンテキスト情報を表示。使用中のトークン数、コンテキストウィンドウの使用率を確認できる | コンテキストの使用状況を確認したい時、トークン制限に近づいているか確認する時 |
140-
| `/compact` | 応答をコンパクトに表示するモードをオン/オフ切り替え。長い応答を簡潔に表示 | 応答が長すぎる時、要点だけを素早く確認したい時 |
140+
| `/context <サブコマンド>` | チャットセッションのコンテキストファイルを管理。現在のAgentから派生したコンテキストルールを表示・追加・削除できる。ファイル名やglobパターンで指定可能。変更はセッション間で保持されない | プロジェクトの特定ファイルをAIに認識させたい時、コンテキストルールを確認・変更したい時 |
141+
| `/compact [プロンプト] [オプション]` | 会話履歴を要約してコンテキストスペースを解放。重要な情報を保持しながら、長時間の会話でメモリ制約に達するのを防ぐ。コンテキストウィンドウがオーバーフローすると自動実行される | メモリ制約の警告が表示された時、会話が長時間続いている時、同じセッション内で新しい話題を始める前 |
141142

142143
### Knowledge管理
143144

144-
> **🧪 実験的機能**: Knowledge機能は開発中です。`q settings chat.enableKnowledge true`で有効化してください。
145+
> **🧪 Beta機能**: Knowledge機能は開発中です。`q settings chat.enableKnowledge true`で有効化してください。
145146
146147
| コマンド | 詳細説明 | 使用シーン |
147148
|---------|---------|-----------|
148149
| `/knowledge show` | 現在のKnowledge情報を表示。インデックス化されたファイル数、合計サイズ、最終更新日時を確認できる(v1.18.0+: statusと統合) | プロジェクトのどのファイルがAIの参照対象になっているか確認したい時 |
149-
| `/knowledge add <path>` | 指定したファイル/ディレクトリをKnowledgeに追加してインデックス化。`--include`オプションでパターン指定可能(例: `--include "*.md"`) | 新しいドキュメントフォルダをAIの参照対象に追加したい時 |
150-
| `/knowledge add -n <name> -p <path>` | 名前とパスを指定してKnowledgeに追加(v1.18.0+) | 複数のプロジェクトを管理する時、わかりやすい名前を付けたい時 |
150+
| `/knowledge add -n <名前> -p <パス> [オプション]` | 指定したファイル/ディレクトリをKnowledgeに追加してインデックス化。`--include`でパターン指定、`--exclude`で除外パターン指定、`--index-type`でインデックスタイプ指定が可能 | 新しいドキュメントフォルダをAIの参照対象に追加したい時 |
151151
| `/knowledge remove <path>` | 指定したパスのエントリをKnowledgeから削除。インデックスから除外される | 不要になった古いドキュメントをAIの参照対象から外したい時 |
152152
| `/knowledge update <path>` | 指定したエントリを再インデックス化。ファイル内容を更新した後に実行すると、最新の内容がAIに反映される | ドキュメントを編集した後、変更内容をAIに認識させたい時 |
153153
| `/knowledge clear` | すべてのKnowledgeエントリを削除してインデックスをリセット。プロジェクト切り替え時に便利 | 別のプロジェクトに切り替える時、前のプロジェクトの情報をクリアしたい時 |
@@ -179,17 +179,17 @@ Knowledge機能は以下のファイル形式をサポートしています:
179179

180180
### Checkpoint管理
181181

182-
> **🧪 実験的機能**: Checkpoint機能は開発中です。`q settings chat.enableCheckpoint true`で有効化してください。詳細は[Checkpoint機能ガイド](05_checkpoints.md)を参照してください。
182+
> **🧪 Beta・実験的機能**: Checkpoint機能は開発中です。ワークスペースのチェックポイントを管理します(会話のチェックポイントではありません)。機能は変更・削除される可能性があります。`q settings chat.enableCheckpoint true`で有効化してください。詳細は[Checkpoint機能ガイド](05_checkpoints.md)を参照してください。
183183
184184
| コマンド | 詳細説明 | 使用シーン |
185185
|---------|---------|-----------|
186-
| [`/checkpoint init`](05_checkpoints.md#使い方) | Checkpoint機能を初期化。会話の保存ポイントを作成できるようになる | 長い会話セッションを開始する前に、保存機能を有効化したい時 |
187-
| [`/checkpoint list`](05_checkpoints.md#checkpoint一覧) | 保存されているCheckpointの一覧を表示。`--limit`オプションで表示数を制限可能 | 過去のどの時点に戻れるか確認したい時 |
188-
| `/checkpoint expand <tag>` | 指定したタグのCheckpoint詳細を表示。会話内容のプレビューを確認できる | Checkpointの内容を確認してから復元するか判断したい時 |
189-
| `/checkpoint diff <tag1> [tag2]` | 2つのCheckpoint間の差分を表示。会話の変化を比較できる | どの時点でどんな変更があったか確認したい時 |
190-
| [`/checkpoint restore [<tag>]`](05_checkpoints.md#checkpoint復元) | 指定したCheckpointに会話を復元。タグ省略時は最新のCheckpointに戻る | 会話が脱線した時、以前の状態に戻りたい時 |
186+
| [`/checkpoint init`](05_checkpoints.md#使い方) | チェックポイントを手動で初期化 | チェックポイント機能を開始する時 |
187+
| [`/checkpoint list`](05_checkpoints.md#checkpoint一覧) | 全てのチェックポイントを一覧表示 | 利用可能なチェックポイントを確認したい時 |
188+
| [`/checkpoint restore [<tag>]`](05_checkpoints.md#checkpoint復元) | 指定したチェックポイントにワークスペースを復元 | 以前の状態に戻したい時 |
189+
| `/checkpoint expand <tag>` | 指定したチェックポイントの詳細を表示 | チェックポイントの内容を確認したい時 |
190+
| `/checkpoint diff <tag1> [tag2]` | 2つのチェックポイント間の差分を表示 | 変更内容を確認したい時 |
191191
| [`/checkpoint restore <tag> --hard`](05_checkpoints.md#復元モード) | Checkpointに完全復元。復元後の会話履歴は削除される | 完全に以前の状態からやり直したい時 |
192-
| `/checkpoint clean` | 古いCheckpointを削除してストレージを整理 | Checkpointが増えすぎた時、不要なものを削除したい時 |
192+
| `/checkpoint clean` | シャドウリポジトリを削除 | チェックポイントデータを完全に削除したい時 |
193193

194194
### TODO管理
195195

@@ -211,33 +211,32 @@ Knowledge機能は以下のファイル形式をサポートしています:
211211
| [`/agent switch <name>`](02_agents.md#agentの切り替え) | 指定したAgentに切り替え。プロジェクトや用途に応じてAgentを変更できる | 別のプロジェクトに切り替える時、専門的なAgentを使いたい時 |
212212
| `/model [モデル名]` | 使用するAIモデルを表示または切り替え。モデル名省略時は現在のモデルを表示 | より高性能なモデルに切り替えたい時、コスト削減のため軽量モデルに変更する時 |
213213
| [`/experiment`](07_experimental.md) | 実験的機能のON/OFF切り替え。Knowledge、Checkpoint、TODO等のベータ機能を有効化 | 新機能を試したい時、実験的機能を有効化/無効化する時 |
214-
| `/prompts` | カスタムプロンプトを管理。独自のプロンプトテンプレートを作成・編集できる | 頻繁に使う指示をテンプレート化したい時 |
214+
| `/prompts [サブコマンド]` | 再利用可能なプロンプトテンプレートを管理。MCPサーバーから提供されるプロンプトやローカルプロンプトを利用可能。`@<prompt name>`でプロンプトを直接取得できる | 頻繁に使う指示をテンプレート化したい時、MCPサーバーのプロンプトを利用したい時 |
215215

216216
### 開発者向けコマンド
217217

218218
| コマンド | 詳細説明 | 使用シーン |
219219
|---------|---------|-----------|
220-
| `/logdump` | サポート調査用のログファイルを収集してZIPアーカイブとして出力(v1.18.0+) | 問題発生時にログを収集してサポートチームに提出する時、デバッグ情報を効率的に収集する時 |
221-
| `/tools` | 利用可能なツール一覧を表示。ネイティブツールとMCPツールの両方を確認できる | どのツールが使えるか確認したい時、MCPサーバーが正しく読み込まれているか確認する時 |
220+
| `/logdump [オプション]` | サポート調査用のログファイルを収集してZIPアーカイブとして出力。`--mcp`でMCPログも含めることが可能(v1.18.0+) | 問題発生時にログを収集してサポートチームに提出する時、デバッグ情報を効率的に収集する時 |
221+
| `/tools [サブコマンド]` | ツールと権限を管理。利用可能なツール一覧の表示、ツールの信頼設定、権限のリセットが可能。デフォルトでは、特定のツール使用時に確認を求める | どのツールが使えるか確認したい時、ツールを自動承認したい時、権限をリセットしたい時 |
222222
| `/mcp` | MCPサーバーの状態を確認。接続状況、利用可能なツール、エラー情報を表示 | MCPサーバーが正常に動作しているか確認したい時、トラブルシューティングする時 |
223-
| `/hooks` | カスタムコマンドをAgent実行時に自動実行。起動時の初期化処理を設定できる | Agent起動時に毎回実行したいコマンドがある時、環境のセットアップを自動化したい時 |
224-
| `/editor [エディタコマンド]` | 外部エディタの設定を管理。長文入力時に使用するエディタを指定できる | 長いプロンプトを書く時、使い慣れたエディタで編集したい時 |
225-
| `/reply [オプション]` | AIの応答スタイルを設定。詳細度、フォーマット、言語などを調整できる | 応答の形式を変更したい時、より詳細な説明が欲しい時 |
223+
| `/hooks` | 設定されているコンテキストフックを表示 | 現在のフック設定を確認したい時、フックの動作を理解したい時 |
224+
| `/editor [初期テキスト]` | $EDITORでプロンプトを作成(デフォルト: vi) | 長いプロンプトを書く時、使い慣れたエディタで編集したい時 |
225+
| `/reply` | 最新のAI応答を引用して$EDITORで返信を作成 | 長文の返信を書きたい時、AI応答の特定部分にコメントしたい時 |
226226

227227
### 情報表示
228228

229229
| コマンド | 詳細説明 | 使用シーン |
230230
|---------|---------|-----------|
231231
| `/usage` | コンテキストウィンドウの使用状況を詳細表示([詳細](#usageコマンドの詳細)) | コンテキストの使用状況を詳しく確認したい時 |
232232
| `/changelog` | Q CLIの変更履歴を表示。バージョンごとの新機能、バグ修正、変更点を確認できる | 最近のアップデート内容を確認したい時、特定バージョンの変更を調べる時 |
233-
| `/whatsnew` | 最新バージョンの新機能を表示。アップデート後の新機能をハイライト表示 | アップデート後に何が変わったか確認したい時 |
234-
| `/subscribe [オプション]` | 情報の購読を管理。アップデート通知、ニュースレターの設定を変更できる | 通知設定を変更したい時、情報の受信を管理する時 |
233+
| `/subscribe [オプション]` | Q Developer Proサブスクリプションへのアップグレード。クエリ制限を増やすことができる | Proプランにアップグレードしたい時、クエリ制限を増やしたい時、既存のサブスクリプションを管理したい時(--manage) |
235234

236235
### 問題報告
237236

238237
| コマンド | 詳細説明 | 使用シーン |
239238
|---------|---------|-----------|
240-
| `/issue` | Q CLIの問題やフィードバックを報告。GitHubのissue作成画面を開き、バグ報告や機能要望を送信できる | バグを見つけた時、新機能を提案したい時、改善要望を伝えたい時 |
239+
| `/issue [説明] [オプション]` | Q CLIの問題やフィードバックを報告。GitHubのissue作成画面を開き、バグ報告や機能要望を送信できる。`-f`で強制作成 | バグを見つけた時、新機能を提案したい時、改善要望を伝えたい時 |
241240

242241
#### /usageコマンドの詳細
243242

0 commit comments

Comments
 (0)