翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Amazon Q CLI コマンドリファレンス
このセクションでは、すべての Amazon Q Developer CLI コマンドとその引数の包括的なリファレンスを提供します。このリファレンスを使用して、各コマンドで使用できるオプションとその適切な構文を理解します。
コマンドに関するヘルプについては、 --help
フラグを使用できます。
q [COMMAND] --help
グローバル引数
次の引数は、任意の Amazon Q CLI コマンドで使用できます。
引数 | ショートフォーム | 説明 |
---|---|---|
--verbose
|
-v
|
ログ記録の詳細度を高めます。より詳細な出力のために繰り返すことができます: -v 、-vv 、-vvv 、 -vvvv |
--help
|
-h
|
コマンドのヘルプ情報を表示する |
--version
|
-V
|
バージョン情報を表示する |
--help-all
|
すべてのサブコマンドのヘルプを印刷する |
コマンド
以下のセクションでは、各 Amazon Q CLI コマンドとその使用可能な引数について説明します。
Q チャット
Amazon Q でインタラクティブチャットセッションを開始します。サブコマンドが指定されていない場合、 はq
デフォルトで になりますq chat
。
構文:
q chat [OPTIONS] [INPUT]
引数 | ショートフォーム | 説明 |
---|---|---|
--no-interactive
|
インタラクティブモードなしで STDOUT への最初のレスポンスを出力します。これは、 も使用されていない限り、プロンプトがツールを使用するアクセス許可をリクエストすると失敗--trust-all-tools します。 |
|
--resume
|
-r
|
このディレクトリから前の会話を再開する |
--profile
|
使用するコンテキストプロファイル | |
--trust-all-tools
|
確認を求めることなく、モデルが任意のツールを使用してコマンドを実行することを許可する | |
--trust-tools
|
指定されたツールセットのみを信頼します。ツール名のカンマ区切りリストを指定します。例えば、--trust-tools=fs_read,fs_write などです。ツールを信頼しない場合は、 を使用します。 --trust-tools= |
|
INPUT
|
最初の質問 (位置引数) |
例:
q chat q chat "How do I list files in Linux?" q chat --no-interactive --trust-all-tools "Show me the current directory" q chat --resume q chat --profile my-profile "Help me with AWS CLI"
Q 翻訳
AI を使用して自然言語の手順を実行可能シェルコマンドに変換します。
構文:
q translate [OPTIONS] [INPUT...]
引数 | ショートフォーム | 説明 |
---|---|---|
--n
|
-n
|
生成する完了の数 (≤5 である必要があります) |
INPUT
|
生成するコマンドの自然言語の説明 (位置引数) |
例:
q translate "list all files in the current directory" q translate "find all Python files modified in the last week" q translate "compress all log files older than 30 days"
Q ドクター
Amazon Q の一般的なインストールと設定の問題を修正して診断します。
構文:
q doctor [OPTIONS]
引数 | ショートフォーム | 説明 |
---|---|---|
--all
|
-a
|
修正なしですべての医師テストを実行する |
--strict
|
-s
|
警告のエラー |
例:
q doctor q doctor --all q doctor --strict
Q 更新
Amazon Q アプリケーションを最新バージョンに更新します。
構文:
q update [OPTIONS]
引数 | ショートフォーム | 説明 |
---|---|---|
--non-interactive
|
-y
|
確認を求めない |
--relaunch-dashboard
|
更新後にダッシュボードに再起動します。デフォルトは true | |
--rollout
|
ロールアウトを使用する |
例:
q update q update --non-interactive q update --rollout
Q テーマ
オートコンプリートドロップダウンメニューのビジュアルテーマを取得または設定します。これは、コマンドの完了を示すポップアップウィンドウの外観に影響します。
構文:
q theme [OPTIONS] [THEME]
引数 | 説明 |
---|---|
--list
|
使用可能なすべてのテーマを一覧表示する |
--folder
|
テーマディレクトリパスを表示する |
THEME
|
設定するテーマの名前。組み込みテーマにはdark 、、light 、 system (位置引数) が含まれます。 |
例:
q theme --list q theme --folder q theme dark q theme light q theme system
注: テーマの変更は、オートコンプリートポップアップウィンドウに影響します。視覚的な変更を確認するには、オートコンプリート提案をトリガーする必要がある場合があります。
Q 統合
Amazon Q のシステム統合を管理します。
構文:
q integrations [SUBCOMMAND] [OPTIONS]
Q 統合サブコマンド
サブコマンド | 説明 |
---|---|
install
|
統合をインストールします。--silent ( -s ) をサポートしてステータスメッセージを抑制 |
uninstall
|
統合をアンインストールします。--silent ( -s ) をサポートしてステータスメッセージを抑制 |
reinstall
|
統合を再インストールします。--silent ( -s ) をサポートしてステータスメッセージを抑制 |
status
|
統合のステータスを確認します。出力形式の --format (-f ) をサポート |
Q インライン
入力時にコマンドラインに直接表示されるインライン提案 (ゴーストテキスト) を管理します。詳細については、コマンドライン支援機能を参照してください。
構文:
q inline [SUBCOMMAND] [OPTIONS]
Q インラインサブコマンド
サブコマンド | 説明 |
---|---|
enable
|
入力時に表示されるインライン提案を有効にする |
disable
|
インライン提案を無効にする |
status
|
インライン提案が有効か無効かを表示する |
set-customization
|
使用するカスタマイズモデルを選択します。必要に応じて、カスタマイズの ARN を指定します。 |
show-customizations
|
使用可能なカスタマイズモデルを表示します。出力形式の --format (-f ) をサポート |
例:
q inline enable q inline disable q inline status q inline set-customization q inline set-customization arn:aws:codewhisperer:us-east-1:123456789012:customization/example q inline show-customizations q inline show-customizations --format json
Q ログイン
AWS Builder ID (無料) または IAM Identity Center (Pro) を使用して Amazon Q で認証します。
構文:
q login [OPTIONS]
引数 | 説明 |
---|---|
--license
|
ライセンスタイプ。オプション: free (ビルダー ID の場合)、 pro (アイデンティティセンターの場合) |
--identity-provider
|
ID プロバイダー URL (アイデンティティセンター用) |
--region
|
AWS リージョン (アイデンティティセンター用) |
--use-device-flow
|
認証には必ず OAuth デバイスフローを使用してください。ブラウザのリダイレクトを処理できない場合に便利です |
例:
q login q login --license free q login --license pro --identity-provider https://my-company.awsapps.com/start --region us-east-1 q login --use-device-flow
Q ログアウト
Amazon Q セッションからサインアウトします。
構文:
q logout
このコマンドは追加の引数を取りません。
Q whoami
現在のユーザーと認証ステータスに関する情報を表示します。
構文:
q whoami [OPTIONS]
引数 | ショートフォーム | 説明 |
---|---|---|
--format
|
-f
|
出力形式。オプション: plain (デフォルト)json 、、 json-pretty |
Q プロファイル
現在の IAM Identity Center ユーザーに関連付けられているプロファイルを表示します。このコマンドは Pro ユーザーのみが使用できます。
構文:
q profile
このコマンドは追加の引数を取りません。
Q 設定
Amazon Q の設定を管理します。設定管理の詳細については、Amazon Q の設定「」を参照してください。
構文:
q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
引数 | ショートフォーム | 説明 |
---|---|---|
--delete
|
-d
|
設定を削除する |
--format
|
-f
|
出力形式。オプション: plain (デフォルト)json 、、 json-pretty |
KEY
|
キーの設定 (位置引数) | |
VALUE
|
設定値 (位置引数) |
Q 設定サブコマンド
サブコマンド | 説明 |
---|---|
open
|
デフォルトのエディタで設定ファイルを開きます。 |
all
|
現在の設定をすべて一覧表示します。--format オプションをサポート |
Q 診断
診断テストを実行して、Amazon Q のインストールと設定の問題をトラブルシューティングします。
構文:
q diagnostic [OPTIONS]
引数 | ショートフォーム | 説明 |
---|---|---|
--format
|
-f
|
出力形式。オプション: plain (デフォルト)json 、、 json-pretty |
--force
|
強制制限された診断出力 |
Q 問題
Amazon Q フィードバックまたはバグレポート用に新しい GitHub 問題を作成します。
構文:
q issue [OPTIONS] [DESCRIPTION...]
引数 | ショートフォーム | 説明 |
---|---|---|
--force
|
-f
|
問題の強制作成 |
DESCRIPTION
|
問題の説明 (位置引数) |
Q バージョン
バージョン情報を表示し、オプションで変更ログを表示します。
構文:
q version [OPTIONS]
引数 | 説明 |
---|---|
--changelog[=VERSION]
|
changelog を表示します。現在のバージョン、--changelog=all すべてのバージョン、または特定のバージョン--changelog=x.x.x で --changelog を使用する |
Q MCP
モデルコンテキストプロトコル (MCP) サーバーを管理します。MCP の詳細については、Amazon Q Developer での MCP の使用「」を参照してください。
構文:
q mcp [SUBCOMMAND] [OPTIONS]
Q MCP 追加
設定された MCP サーバーを追加または置き換えます。
構文:
q mcp add [OPTIONS]
引数 | 説明 |
---|---|
--name
|
サーバーの名前 (必須) |
--command
|
サーバーを起動するために使用されるコマンド (必須) |
--scope
|
サーバーを追加する場所。オプション: workspace 、 global |
--env
|
サーバーを起動するときに使用する環境変数。形式: key1=value1,key2=value2 |
--timeout
|
ミリ秒単位のサーバー起動タイムアウト |
--force
|
既存のサーバーを同じ名前で上書きする |
Q mcp 削除
MCP 設定からサーバーを削除します。
構文:
q mcp remove [OPTIONS]
引数 | 説明 |
---|---|
--name
|
削除するサーバーの名前 (必須) |
--scope
|
削除するスコープ。オプション: workspace 、 global |
Q MCP リスト
設定済みの MCP サーバーを一覧表示します。
構文:
q mcp list [SCOPE]
引数 | 説明 |
---|---|
SCOPE
|
一覧表示するスコープ。オプション: workspace 、 global (位置引数) |
Q MCP インポート
別のファイルからサーバー設定をインポートします。
構文:
q mcp import [OPTIONS] [SCOPE]
引数 | 説明 |
---|---|
--file
|
サーバー設定をインポートするファイル (必須) |
--force
|
既存のサーバーを同じ名前で上書きする |
SCOPE
|
インポート先のスコープ。オプション: workspace 、 global (位置引数) |
Q MCP ステータス
設定された MCP サーバーのステータスを取得します。
構文:
q mcp status [OPTIONS]
引数 | 説明 |
---|---|
--name
|
ステータスを取得するサーバーの名前 (必須) |
ログファイル
Amazon Q Developer CLI は、トラブルシューティングに役立つログファイルを保持します。これらのログはマシンにローカルに保存され、AWS には送信されません。
ログファイルの場所:
-
macOS:
$TMPDIR/qlog/
-
Linux:
$XDG_RUNTIME_DIR
またはTMPDIR
または/tmp
ログレベルは、 Q_LOG_LEVEL
環境変数を設定することで制御できます。次の値を指定できます:
-
error
: エラーメッセージのみ (デフォルト) -
warn
: 警告とエラーメッセージ -
info
: 情報、警告、エラーメッセージ -
debug
: デバッグ、情報、警告、エラーメッセージ -
trace
: 詳細なトレース情報を含むすべてのメッセージ
警告
ログファイルには、ファイルパス、コードスニペット、コマンド出力など、Amazon Q との会話ややり取りからの機密情報が含まれている場合があります。これらのログはローカルマシンにのみ保存され、AWS に送信されませんが、ログファイルを他のユーザーと共有する場合は注意が必要です。
ログレベルの設定例 (デバッグ目的):
# For bash/zsh export Q_LOG_LEVEL=debug q chat # For fish set -x Q_LOG_LEVEL debug q chat