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 將自然語言指示翻譯成可執行的 Shell 命令。

語法: 

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 執行所有 doctor 測試，但不修正
--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 建置器 ID （免費） 或 IAM Identity Center (Pro) 向 Amazon Q 驗證。

語法: 

q login [OPTIONS]
q login 引數
引數 說明
--license 授權類型。選項：free (適用於建構家 ID)、pro (適用於 Identity Center)
--identity-provider 身分提供者 URL (適用於 Identity Center)
--region AWS 區域 (適用於 Identity Center)
--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 Identity Center 使用者相關聯的設定檔。此命令僅適用於專業方案使用者。

語法: 

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 的詳細資訊，請參閱 使用 MCP 搭配 Amazon Q Developer。

語法: 

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