Amazon Q CLI コマンドリファレンス - Amazon Q Developer
グローバル引数コマンドログファイル

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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 chat

Amazon Q でインタラクティブチャットセッションを開始します。サブコマンドが指定されていない場合、q はデフォルトで q chat になります。

構文: 

q chat [OPTIONS] [INPUT]
q chat の引数
引数 ショートフォーム 説明
--no-interactive インタラクティブモードを使用せずに STDOUT への最初の応答を出力します。--trust-all-tools も使用されていない限り、これは、プロンプトがツールを使用するためのアクセス許可をリクエストしても失敗します。
--resume -r このディレクトリから以前の会話を再開する
--agent 使用するエージェント
--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 --agent my-agent "Help me with AWS CLI"

q translate

AI を使用して自然言語の手順を実行可能なシェルコマンドに変換します。

構文: 

q translate [OPTIONS] [INPUT...]
q translate の引数
引数 ショートフォーム 説明
--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 doctor

Amazon Q の一般的なインストールと設定の問題を修正して診断します。

構文: 

q doctor [OPTIONS]
q doctor の引数
引数 ショートフォーム 説明
--all -a すべてのドクターテストを実行し、修正はしない
--strict -s 警告時のエラー

例: 

q doctor
q doctor --all
q doctor --strict

q update

Amazon Q アプリケーションを最新バージョンに更新します。

構文: 

q update [OPTIONS]
q update の引数
引数 ショートフォーム 説明
--non-interactive -y 確認のプロンプトを表示しない
--relaunch-dashboard 更新後にダッシュボードを再起動します。デフォルトは true
--rollout ロールアウトを使用する

例: 

q update
q update --non-interactive
q update --rollout

q theme

オートコンプリートドロップダウンメニューのビジュアルテーマを取得または設定します。これは、コマンドの完了を示すポップアップウィンドウの外観に影響します。

構文: 

q theme [OPTIONS] [THEME]
q theme の引数
引数 説明
--list 使用可能なすべてのテーマを一覧表示する
--folder テーマディレクトリパスを表示する
THEME 設定するテーマの名前。組み込みテーマには dark、light、system (位置引数) が含まれる

例: 

q theme --list
q theme --folder
q theme dark
q theme light
q theme system

注意: テーマの変更は、オートコンプリートポップアップウィンドウに影響します。視覚的な変更を確認するには、オートコンプリート候補をトリガーする必要がある場合があります。

q integrations

Amazon Q のシステム統合を管理します。

構文: 

q integrations [SUBCOMMAND] [OPTIONS]

q integrations のサブコマンド

q integrations のサブコマンド
サブコマンド 説明
install 統合をインストールします。ステータスメッセージを抑制するために --silent ( -s) をサポート
uninstall 統合をアンインストールします。ステータスメッセージを抑制するために --silent ( -s) をサポート
reinstall 統合を再インストールします。ステータスメッセージを抑制するために --silent ( -s) をサポート
status 統合のステータスを確認します。出力形式のための --format ( -f) をサポート

q inline

入力時にコマンドラインに直接表示されるインライン提案 (ゴーストテキスト) を管理します。詳細については、「コマンドライン支援機能」を参照してください。

構文: 

q inline [SUBCOMMAND] [OPTIONS]

q inline のサブコマンド

q inline のサブコマンド
サブコマンド 説明
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 login

AWS Builder ID (無料) または IAM Identity Center (Pro) を使用して Amazon Q で認証します。

構文: 

q login [OPTIONS]
q login の引数
引数 説明
--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 logout

Amazon Q セッションからサインアウトします。

構文: 

q logout

このコマンドは追加の引数を使用しません。

q whoami

現在のユーザーと認証ステータスに関する情報を表示します。

構文: 

q whoami [OPTIONS]
q whoami の引数
引数 ショートフォーム 説明
--format -f 出力形式。オプション: plain (デフォルト)、json、json-pretty

q profile

現在の IAM アイデンティティセンターユーザーに関連付けられているプロファイルを表示します。このコマンドは Pro ユーザーのみが使用できます。

構文: 

q profile

このコマンドは追加の引数を使用しません。

q settings

Amazon Q の構成設定を管理します。設定の管理の詳細については、「Amazon Q 設定を構成する」を参照してください。

構文: 

q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]
q settings の引数
引数 ショートフォーム 説明
--delete -d 設定を削除する
--format -f 出力形式。オプション: plain (デフォルト)、json、json-pretty
KEY 設定キー (位置引数)
VALUE 設定値 (位置引数)

q settings のサブコマンド

q settings のサブコマンド
サブコマンド 説明
open デフォルトのエディタで設定ファイルを開く
list 設定済み設定を一覧表示します。を使用して--all、使用可能なすべての設定と説明を表示します。--format オプションをサポート
all (廃止) 現在の設定をすべて一覧表示します。代わりに list を使用します。--format オプションをサポート

/ プロンプト

チャットインタラクションの再利用可能なプロンプトテンプレートを管理します。プロンプト管理と引数に関する包括的な情報については、「」を参照してくださいプロンプトの管理。

構文: 

/prompts [SUBCOMMAND] [OPTIONS] [NAME] [ARGUMENTS...]
/prompts 引数
引数 説明
NAME プロンプト名 (詳細については、コマンドの作成、編集、削除)
ARGUMENTS... get コマンドの使用時にプロンプトに渡す引数

/prompts サブコマンド

/prompts サブコマンド
サブコマンド 説明
list [search-word] 使用可能なプロンプトを一覧表示し、オプションで検索語でフィルタリングする
details <name> 引数、使用状況、例など、プロンプトに関する詳細情報を表示する
get <name> [args...] オプションの引数を使用してプロンプトを取得して実行する
create --name <name> [--content text] [--global] 新しいプロンプトを作成します。コンテンツが指定されていない場合にエディタを開きます
edit <name> [--global] デフォルトのエディタで既存のプロンプトを編集する
remove <name> [--global] 既存のプロンプトを削除する (確認が必要)

チャットでのプロンプトの使用

プロンプトは、@ プレフィックスを使用してチャットで直接呼び出すことができます。

@<prompt-name> [arguments...]

例:

# Simple prompt without arguments
@code-review

# Prompt with single argument
@debug-help "connection timeout error"

# Prompt with multiple arguments
@aws-deploy "my-service" "production" "us-west-2"

# Server-specific prompt (when ambiguous)
@dev-tools/analyze "performance issue"

プロンプト引数

プロンプトは引数を受け入れて動作をカスタマイズできます。

  • 必要な引数: 次のように表示されます。 <arg>

  • オプションの引数: 省略でき、次のように表示されます [arg]

  • 引用引数: スペースを含む引数に引用符を使用する

を使用して/prompts details <name>、プロンプトが受け入れる引数を確認します。

q diagnostic

診断テストを実行して、Amazon Q のインストールと設定の問題をトラブルシューティングします。

構文: 

q diagnostic [OPTIONS]
q diagnostic の引数
引数 ショートフォーム 説明
--format -f 出力形式。オプション: plain (デフォルト)、json、json-pretty
--force 診断出力の制限を適用する

q issue

Amazon Q フィードバックまたはバグレポート用の新しい GitHub 問題を作成します。

構文: 

q issue [OPTIONS] [DESCRIPTION...]
q issue 引数
引数 ショートフォーム 説明
--force -f 問題の作成を適用する
DESCRIPTION 問題の説明 (位置引数)

q version

バージョン情報を表示し、オプションで変更ログを表示します。

構文: 

q version [OPTIONS]
q version の引数
引数 説明
--changelog[=VERSION] 変更ログを表示します。現在のバージョンには --changelog、すべてのバージョンには --changelog=all、特定のバージョンには --changelog=x.x.x を使用します。

q mcp

モデルコンテキストプロトコル (MCP) サーバーを管理します。MCP の詳細については、「Amazon Q Developer での MCP の使用」を参照してください。

構文: 

q mcp [SUBCOMMAND] [OPTIONS]

q mcp add

設定された MCP サーバーを追加または置き換えます。

構文: 

q mcp add [OPTIONS]
q mcp add の引数
引数 説明
--name サーバーの名前 (必須)
--command サーバーを起動するために使用するコマンド (必須)
--scope サーバーを追加する場所。オプション: workspace、global
--env サーバーを起動するときに使用する環境変数。形式: key1=value1,key2=value2
--timeout ミリ秒単位のサーバー起動タイムアウト
--force 既存のサーバーを同じ名前で上書きする

q mcp remove

MCP 設定からサーバーを削除します。

構文: 

q mcp remove [OPTIONS]
q mcp remove の引数
引数 説明
--name 削除するサーバーの名前 (必須)
--scope 削除するスコープ。オプション: workspace、global

q mcp list

設定済みの MCP サーバーを一覧表示します。

構文: 

q mcp list [SCOPE]
q mcp list の引数
引数 説明
SCOPE 一覧表示するスコープ。オプション: workspace、global (位置引数)

q mcp import

別のファイルからサーバー設定をインポートします。

構文: 

q mcp import [OPTIONS] [SCOPE]
q mcp import の引数
引数 説明
--file サーバー設定をインポートするファイル (必須)
--force 既存のサーバーを同じ名前で上書きする
SCOPE インポート先のスコープ。オプション: workspace、global (位置引数)

q mcp status

設定された MCP サーバーのステータスを取得します。

構文: 

q mcp status [OPTIONS]
q mcp status の引数
引数 説明
--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