本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
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 將自然語言指示轉換為可執行 shell 命令。
語法:
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 建置器 ID （免費） 或 IAM Identity Center (Pro) 向 Amazon Q 驗證。
語法:
q login [OPTIONS]
| 引數 | 描述 |
|---|---|
--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 登出
登出您的 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特定版本使用 |
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 MPC 移除
從 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
