雲端CLI參考

引數

command_name

命令名稱

選項

如需全域選項，請參閱全域選項。

--format

輸出格式（txt、json或md）

--raw

輸出原始指令說明

list

列出命令

引數

command

要執行的命令

namespace

名稱空間名稱

選項

如需全域選項，請參閱全域選項。

--raw

輸出原始命令清單

--format

輸出格式（txt、xml、json或md）

--all

顯示所有命令，包括隱藏的命令

multi

在多個專案上執行命令

引數

cmd

要執行的命令

選項

如需全域選項，請參閱全域選項。

--projects，-p

專案ID清單，以逗號和/或空格分隔

--continue

即使發生例外狀況，仍繼續執行命令

--sort

用來排序專案選項清單的屬性

--reverse

反轉專案選項的順序

web

在Web UI中開啟專案

選項

如需全域選項，請參閱全域選項。

--browser

用來開啟URL的瀏覽器。 將0設為無。

--pipe

將URL輸出到stdout。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

activity:cancel

取消活動

引數

id

活動ID。 預設為最近的可取消活動。

選項

如需全域選項，請參閱全域選項。

--type，-t

依型別篩選（選取預設活動時）。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 %或*字元可作為此型別的萬用字元，例如'%var%'以選取變數相關的活動。

--exclude-type，-x

依型別排除（選取預設活動時）。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 %或*字元可作為萬用字元來排除型別。

--all，-a

檢查所有環境上最近的活動（當選取預設活動時）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

activity:get

檢視單一活動的詳細資訊

引數

id

活動ID。 預設為最近的活動。

選項

如需全域選項，請參閱全域選項。

--property，-P

要檢視的屬性

--type，-t

依型別篩選（選取預設活動時）。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 %或*字元可作為此型別的萬用字元，例如'%var%'以選取變數相關的活動。

--exclude-type，-x

依型別排除（選取預設活動時）。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 %或*字元可作為萬用字元來排除型別。

--state

依狀態篩選（選取預設活動時）： in_progress、pending、complete或canceled。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--result

依結果篩選（選取預設活動時）：成功或失敗

--incomplete，-i

僅包含未完成的活動（選取預設活動時）。 這是 — state=in_progress，pending的簡稱

--all，-a

檢查所有環境上最近的活動（當選取預設活動時）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

activity:list

取得環境或專案的活動清單

選項

如需全域選項，請參閱全域選項。

--type，-t

依型別篩選活動值可能會以逗號（例如"a，b，c"）和/或空白字元分割。 活動名稱的第一部分可以省略，例如，「cron」可以選擇「environment.cron」活動。 %或*字元可作為萬用字元使用，例如'%var%'以選取與變數相關的活動。

--exclude-type，-x

依型別排除活動。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 活動名稱的第一部分可以省略，例如，「cron」可以排除「environment.cron」活動。 %或*字元可作為萬用字元來排除型別。

--limit

限制顯示的結果數

--start

只會列出在此日期之前建立的活動

--state

依狀態篩選活動： in_progress、pending、complete或canceled。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--result

依結果篩選活動：成功或失敗

--incomplete，-i

僅列出未完成的活動

--all，-a

列出所有環境上的活動

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用欄： id*、created*、description*、progress*、state*、result*、completed、environments、type （* =預設欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

activity:log

顯示活動的記錄

引數

id

活動ID。 預設為最近的活動。

選項

如需全域選項，請參閱全域選項。

--refresh

活動重新整理間隔（秒）。 設為0可停用重新整理。

--timestamps，-t

在每個訊息旁邊顯示時間戳記

--type

依型別篩選（選取預設活動時）。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 %或*字元可作為此型別的萬用字元，例如'%var%'以選取變數相關的活動。

--exclude-type，-x

依型別排除（選取預設活動時）。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 %或*字元可作為萬用字元來排除型別。

--state

依狀態篩選（選取預設活動時）： in_progress、pending、complete或canceled。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--result

依結果篩選（選取預設活動時）：成功或失敗

--incomplete，-i

僅包含未完成的活動（選取預設活動時）。 這是 — state=in_progress，pending的簡稱

--all，-a

檢查所有環境上最近的活動（當選取預設活動時）

--date-fmt

日期格式（作為PHP日期格式字串）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

app:config-get

檢視應用程式的設定

選項

如需全域選項，請參閱全域選項。

--property，-P

要檢視的設定屬性

--refresh

是否要重新整理快取

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--identity-file，-i

[已棄用的選項，不再使用]

app:list

列出專案中的應用程式

選項

如需全域選項，請參閱全域選項。

--refresh

是否要重新整理快取

--pipe

僅輸出應用程式名稱清單

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄： name*、type*、disk、path、size （* =預設欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

auth:api-token-login

使用API權杖登入Magento Cloud

選項

如需全域選項，請參閱全域選項。

auth:browser-login

透過瀏覽器登入Magento Cloud

選項

如需全域選項，請參閱全域選項。

--force，-f

再次登入，即使已登入

--browser

用來開啟URL的瀏覽器。 將0設為無。

--pipe

將URL輸出到stdout。

auth:info

顯示您的帳戶資訊

引數

property

要檢視的帳戶屬性

選項

如需全域選項，請參閱全域選項。

--no-auto-login

略過自動登入。 若未登入，將不會輸出任何內容，且退出代碼將為0 （假設沒有其他錯誤）。

--property，-P

要檢視的帳戶屬性（替代語法）

--refresh

是否要重新整理快取

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

auth:logout

登出Magento Cloud

選項

如需全域選項，請參閱全域選項。

--all，-a

從所有本機工作階段登出

--other

從其他本機工作階段登出

blackfire:setup

設定專案的Blackfire.io整合

選項

如需全域選項，請參閱全域選項。

--server_id

伺服器ID

--server_token

伺服器權杖

--project，-p

專案ID或URL

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

certificate:add

將SSL憑證新增至專案

選項

如需全域選項，請參閱全域選項。

--cert

憑證檔案的路徑

--key

憑證私密金鑰檔案的路徑

--chain

憑證鏈結檔案的路徑

--project，-p

專案ID或URL

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

certificate:delete

從專案刪除憑證

引數

id

憑證ID （或其開頭）

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

certificate:get

檢視憑證

引數

id

憑證ID （或其開頭）

選項

如需全域選項，請參閱全域選項。

--property，-P

要檢視的憑證屬性

--date-fmt

日期格式（作為PHP日期格式字串）

--project，-p

專案ID或URL

certificate:list

列出專案憑證

選項

如需全域選項，請參閱全域選項。

--domain

依網域名稱篩選（不區分大小寫搜尋）

--exclude-domain

排除憑證，依網域名稱比對（搜尋不區分大小寫）

--issuer

依簽發者篩選

--only-auto

僅顯示自動提供的憑證

--no-auto

僅顯示手動新增的憑證

--ignore-expiry

顯示過期和未過期的憑證

--only-expired

僅顯示過期的憑證

--no-expired

僅顯示未過期的憑證（預設）

--pipe-domains

僅傳回憑證涵蓋的網域名稱清單

--date-fmt

日期格式（作為PHP日期格式字串）

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄：已建立、網域、過期、ID、簽發者。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--project，-p

專案ID或URL

commit:get

顯示認可詳細資料

引數

commit

認可SHA。 這也可以接受父項認可的「HEAD」，以及插入符號(^)或波狀符號(~)尾碼。

選項

如需全域選項，請參閱全域選項。

--property，-P

要顯示的認可屬性。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--date-fmt

日期格式（作為PHP日期格式字串）

commit:list

清單認可

引數

commit

起始Git認可SHA。 這也可以接受父項認可的「HEAD」，以及插入符號(^)或波狀符號(~)尾碼。

選項

如需全域選項，請參閱全域選項。

--limit

要顯示的認可數目。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用欄：作者、日期、sha、摘要。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

db:dump

建立遠端資料庫的本機傾印

選項

如需全域選項，請參閱全域選項。

--schema

要傾印的結構描述。 省略以使用預設架構（通常為「主要」）。

--file，-f

傾印的自訂檔案名稱

--directory，-d

傾印的自訂目錄

--gzip，-z

使用gzip壓縮傾印

--timestamp，-t

將時間戳記新增到傾印檔案名稱

--stdout，-o

輸出到STDOUT而非檔案

--table

要包含的表格

--exclude-table

要排除的表格

--schema-only

僅傾印結構描述，無資料

--charset

傾印的字元集編碼

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--relationship，-r

要使用的服務關係

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

db:size

預估資料庫的磁碟使用量

選項

如需全域選項，請參閱全域選項。

--bytes，-B

以位元組為單位顯示大小。

--cleanup，-C

檢查是否可以清除資料表並顯示建議（僅限InnoDb）。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--relationship，-r

要使用的服務關係

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用欄：max、percent_used、used。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

db:sql

在遠端資料庫上執行SQL

引數

query

要執行的SQL敘述句

選項

如需全域選項，請參閱全域選項。

--raw

產生原始、非表格式輸出

--schema

要使用的結構描述。 省略以使用預設架構（通常為「主要」）。 傳遞空字串以不使用任何結構描述。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--relationship，-r

要使用的服務關係

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

domain:add

將新網域新增至專案

引數

name

網域名稱

選項

如需全域選項，請參閱全域選項。

--cert

此網域的憑證檔案路徑

--key

所提供憑證之私密金鑰檔案的路徑。

--chain

提供的憑證的憑證鏈結檔案的路徑

--attach

此將在環境的路由中取代的生產網域。 非生產環境網域需要。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

domain:delete

從專案刪除網域

引數

name

網域名稱

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

domain:get

顯示網域的詳細資訊

引數

name

網域名稱

選項

如需全域選項，請參閱全域選項。

--property，-P

要檢視的網域屬性

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

domain:list

取得所有網域的清單

選項

如需全域選項，請參閱全域選項。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的資料欄： name*、ssl*、created_at*、registered_name、replacement_for、type、updated_at （* =預設資料欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

domain:update

更新網域

引數

name

網域名稱

選項

如需全域選項，請參閱全域選項。

--cert

此網域的憑證檔案路徑

--key

所提供憑證之私密金鑰檔案的路徑。

--chain

提供的憑證的憑證鏈結檔案的路徑

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:activate

啟用環境

引數

environment

要啟用的環境

選項

如需全域選項，請參閱全域選項。

--parent

在啟用之前設定新的環境父項

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:branch

分支環境

引數

id

新環境的ID （分支名稱）

parent

新環境的父級

選項

如需全域選項，請參閱全域選項。

--title

新環境的標題

--type

新環境的型別

--no-clone-parent

不要複製父環境的資料

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:checkout

檢視環境

引數

id

要簽出之環境的ID。 例如：「sprint2」

選項

如需全域選項，請參閱全域選項。

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

environment:delete

刪除一或多個環境

引數

environment

要刪除的環境。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

選項

如需全域選項，請參閱全域選項。

--delete-branch

刪除非使用中環境的Git分支，無需確認

--no-delete-branch

請勿刪除任何Git分支（非使用中環境）

--type

刪除某型別的所有環境（新增至其他任何選取的專案）值可能會以逗號（例如"a，b，c"）和/或空白字元分割。

--only-type，-t

只有特定型別的刪除環境值才可以分割為逗號（例如"a，b，c"）和/或空格。

--exclude

不要刪除的環境。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--exclude-type

不得刪除的環境型別值可能會以逗號（例如"a，b，c"）和/或空白字元分割。

--inactive

刪除所有非使用中的環境（新增到其他所選環境）

--merged

刪除所有合併的環境（新增至其他所選環境）

--allow-delete-parent

允許刪除具有子項的環境

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:http-access

更新環境的HTTP存取設定

選項

如需全域選項，請參閱全域選項。

--access

存取限制，格式為「permission：address」。 使用0以清除所有地址。

--auth

HTTP基本驗證認證，格式為「使用者名稱：密碼」。 使用0可清除所有認證。

--enabled

存取控制是否應該啟用：1代表啟用，0代表停用

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:info

讀取或設定環境的屬性

引數

property

屬性的名稱

value

設定屬性的新值

選項

如需全域選項，請參閱全域選項。

--refresh

是否要重新整理快取

--date-fmt

日期格式（作為PHP日期格式字串）

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:init

從公共Git存放庫初始化環境

引數

url

Git存放庫的URL

選項

如需全域選項，請參閱全域選項。

--profile

設定檔的名稱

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:list

取得環境清單

選項

如需全域選項，請參閱全域選項。

--no-inactive，-I

不要顯示非使用中的環境

--pipe

輸出環境ID的簡單清單。

--refresh

是否要重新整理清單。

--sort

排序依據的屬性

--reverse

以反向（遞減）順序排序

--type

依環境型別篩選清單。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄： id*、title*、status*、type*、created、machine_name、updated （* =預設欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--project，-p

專案ID或URL

environment:logs

讀取環境的記錄

引數

type

紀錄型別，例如「存取」或「錯誤」

選項

如需全域選項，請參閱全域選項。

--lines

要顯示的行數

--tail

持續追蹤記錄

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

environment:merge

合併環境

引數

environment

要合併的環境

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:pause

暫停環境

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:push

將程式碼推送至環境

引數

source

來源參考：分支名稱或認可雜湊

選項

如需全域選項，請參閱全域選項。

--target

目標分支名稱。 預設為目前的分支。

--force，-f

允許非快轉更新

--force-with-lease

如果遠端追蹤分支為最新狀態，則允許非快轉更新

--set-upstream，-u

將目標環境設定為來源分支的上游。 這也會將目標專案設定為本機存放庫的遠端。

--activate

在推播之前啟動環境

--parent

設定新環境父項（僅用於 — activate）

--type

設定環境型別（僅用於 — activate ）

--no-clone-parent

請勿原地複製父分支的資料（僅用於 — activate）

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

environment:redeploy

重新部署環境

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:relationships

顯示環境的關係

引數

environment

環境

選項

如需全域選項，請參閱全域選項。

--property，-P

要檢視的關係屬性

--refresh

是否要重新整理關係

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

environment:resume

繼續暫停的環境

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:scp

使用scp將檔案複製到環境或從環境複製檔案

引數

files

要複製的檔案。 使用remote：前置詞來定義遠端位置。

選項

如需全域選項，請參閱全域選項。

--recursive，-r

遞回複製整個目錄

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

environment:ssh

SSH連線至目前的環境

引數

cmd

要在環境中執行的命令。

選項

如需全域選項，請參閱全域選項。

--pipe

僅輸出SSH URL。

--all

輸出所有SSH URL （適用於每個應用程式）。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

environment:synchronize

同步環境的程式碼和/或其父系資料

引數

synchronize

要同步的專案：「代碼」、「資料」或兩者

選項

如需全域選項，請參閱全域選項。

--rebase

透過重新基底而不是合併來同步程式碼

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

environment:url

取得環境的公用URL

選項

如需全域選項，請參閱全域選項。

--primary，-1

只傳回主要路由的URL

--browser

用來開啟URL的瀏覽器。 將0設為無。

--pipe

將URL輸出到stdout。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

environment:xdebug

開啟環境上的Xdebug通道

選項

如需全域選項，請參閱全域選項。

--port

本機連線埠

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

integration:activity:get

檢視單一整合活動的詳細資訊

引數

integration

整合ID。 保留空白以從清單中選擇。

activity

活動ID。 預設為最近的整合活動。

選項

如需全域選項，請參閱全域選項。

--property，-P

要檢視的屬性

--project，-p

專案ID或URL

--environment，-e

[已棄用的選項，未使用]

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

integration:activity:list

取得整合的活動清單

引數

id

整合ID。 保留空白以從清單中選擇。

選項

如需全域選項，請參閱全域選項。

--type

依型別篩選活動。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--exclude-type，-x

依型別排除活動。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。 %或*字元可作為萬用字元來排除型別。

--limit

限制顯示的結果數

--start

只會列出在此日期之前建立的活動

--state

依狀態篩選活動。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--result

依結果篩選活動

--incomplete，-i

僅列出未完成的活動

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄： id*、created*、description*、type*、state*、result*、completed （* =預設欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

--project，-p

專案ID或URL

--environment，-e

[已棄用的選項，未使用]

integration:activity:log

顯示整合活動的記錄

引數

integration

整合ID。 保留空白以從清單中選擇。

activity

活動ID。 預設為最近的整合活動。

選項

如需全域選項，請參閱全域選項。

--timestamps，-t

在每個訊息旁邊顯示時間戳記

--date-fmt

日期格式（作為PHP日期格式字串）

--project，-p

專案ID或URL

--environment，-e

[已棄用的選項，未使用]

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

integration:delete

從專案刪除整合

引數

id

整合ID。 保留空白以從清單中選擇。

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

integration:get

檢視整合的詳細資訊

引數

id

整合ID。 保留空白以從清單中選擇。

選項

如需全域選項，請參閱全域選項。

--property，-P

要檢視的整合屬性

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--project，-p

專案ID或URL

integration:list

檢視專案整合的清單

選項

如需全域選項，請參閱全域選項。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄：id、摘要、型別。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--project，-p

專案ID或URL

integration:update

更新整合

--no-wait，-W

請勿等待作業完成

--wait

等候作業完成（預設）

integration:validate

驗證現有的整合

引數

id

整合ID。 保留空白以從清單中選擇。

選項

如需全域選項，請參閱全域選項。

--project，-p

專案ID或URL

local:build

在本機建置目前的專案

引數

app

指定要建置的應用程式

選項

如需全域選項，請參閱全域選項。

--abslinks，-a

使用絕對連結

--source，-s

來源目錄。 預設為目前的專案根目錄。

--destination，-d

每個應用程式的Web根目錄將與其符號連結的目的地。 預設： _www

--copy，-c

複製到組建目錄，而非從來源同步連結

--clone

使用Git將目前的HEAD複製至組建目錄

--run-deploy-hooks

執行部署和/或post_deploy鉤點

--no-clean

不要移除舊的組建

--no-archive

請勿建立或使用組建封存

--no-backup

不要備份先前的組建

--no-cache

停用快取

--no-build-hooks

請勿執行建置後鉤點

--no-deps

請勿在本機安裝組建相依性

--working-copy

Drush：使用Git來複製每個Drupal模組的存放庫，而不只是下載版本

--concurrency

Drush：設定將同時處理的並行專案數目

--lock

Drush：建立或更新鎖定檔案（僅適用於Drush 7+版）

local:dir

尋找本機專案根目錄

引數

subdir

要尋找的子目錄（'local'、'web'或'shared'）

選項

如需全域選項，請參閱全域選項。

metrics:all

Beta顯示環境的CPU、磁碟和記憶體量度

選項

如需全域選項，請參閱全域選項。

--bytes，-B

以位元組為單位顯示大小

--range，-r

時間範圍。 此期間將載入量度，直到結束時間(—to)為止。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少5分鐘，最多8小時或更多（視專案而定），預設為10分鐘。

--interval，-i

時間間隔。 預設為範圍的除法。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少1分鐘。

--to

結束時間。 預設為現在。

--latest，-1

僅顯示最新的單一資料點

--service，-s

依服務或應用程式名稱篩選%或*字元可當作萬用字元。

--type

依服務型別篩選（如果未提供 — 服務）。 不需要版本。 %或*字元可作為萬用字元使用。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的資料欄：timestamp*、service*、cpu_percent*、mem_percent*、disk_percent*、tmp_disk_percent*、cpu_limit、cpu_used、disk_limit、disk_used、inodes_limit、inodes_percent、inodes_used、mem_limit、mem_used、tmp_disk_used、tmp_inodes_limit、tmp_inodes_percent、tmp_inodes_used、型別（* =預設資料欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

metrics:cpu

Beta顯示環境的CPU使用情形

選項

如需全域選項，請參閱全域選項。

--range，-r

時間範圍。 此期間將載入量度，直到結束時間(—to)為止。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少5分鐘，最多8小時或更多（視專案而定），預設為10分鐘。

--interval，-i

時間間隔。 預設為範圍的除法。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少1分鐘。

--to

結束時間。 預設為現在。

--latest，-1

僅顯示最新的單一資料點

--service，-s

依服務或應用程式名稱篩選%或*字元可當作萬用字元。

--type

依服務型別篩選（如果未提供 — 服務）。 不需要版本。 %或*字元可作為萬用字元使用。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄： timestamp*、service*、used*、limit*、%、type （ =預設欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

metrics:disk-usage

顯示環境的磁碟使用情況

選項

如需全域選項，請參閱全域選項。

--bytes，-B

以位元組為單位顯示大小

--range，-r

時間範圍。 此期間將載入量度，直到結束時間(—to)為止。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少5分鐘，最多8小時或更多（視專案而定），預設為10分鐘。

--interval，-i

時間間隔。 預設為範圍的除法。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少1分鐘。

--to

結束時間。 預設為現在。

--latest，-1

僅顯示最新的單一資料點

--service，-s

依服務或應用程式名稱篩選%或*字元可當作萬用字元。

--type

依服務型別篩選（如果未提供 — 服務）。 不需要版本。 %或*字元可作為萬用字元使用。

--tmp

報告暫存磁碟使用狀況（顯示資料欄：timestamp、service、tmp_used、tmp_limit、tmp_percent、tmp_ipercent）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄：timestamp*、service*、used*、limit*、percent*、tmp_percent*、ilimit、iused、tmp_ilimit、tmp_ipercent、tmp_iused、tmp_limit、tmp_used、type （* =預設欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

metrics:memory

Beta顯示環境的記憶體使用情況

選項

如需全域選項，請參閱全域選項。

--bytes，-B

以位元組為單位顯示大小

--range，-r

時間範圍。 此期間將載入量度，直到結束時間(—to)為止。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少5分鐘，最多8小時或更多（視專案而定），預設為10分鐘。

--interval，-i

時間間隔。 預設為範圍的除法。 您可以指定單位：小時(h)、分鐘(m)或秒(s)。 最少1分鐘。

--to

結束時間。 預設為現在。

--latest，-1

僅顯示最新的單一資料點

--service，-s

依服務或應用程式名稱篩選%或*字元可當作萬用字元。

--type

依服務型別篩選（如果未提供 — 服務）。 不需要版本。 %或*字元可作為萬用字元使用。

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄： timestamp*、service*、used*、limit*、%、type （ =預設欄）。 字元「+」可作為預設欄的預留位置。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--date-fmt

日期格式（作為PHP日期格式字串）

mount:download

使用rsync從掛載下載檔案

選項

如需全域選項，請參閱全域選項。

--all，-a

從所有掛載下載

--mount，-m

掛載（作為應用程式相對路徑）

--target

檔案將下載到的目錄。 如果 — all已使用，則會附加掛載路徑

--source-path

使用 — all時，請使用掛載的來源路徑（而非掛載路徑）作為目標的子目錄

--delete

是否要刪除目標目錄中的無關檔案

--exclude

要從下載排除的檔案（模式）

--include

不排除的檔案（模式）

--refresh

是否要重新整理快取

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

mount:list

取得掛載清單

選項

如需全域選項，請參閱全域選項。

--paths

僅輸出掛載路徑（每行一個）

--refresh

是否要重新整理快取

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用的欄：定義、路徑。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

mount:size

檢查掛載的磁碟使用量

選項

如需全域選項，請參閱全域選項。

--bytes，-B

以位元組為單位顯示大小

--refresh

重新整理快取

--format

輸出格式：table、csv、tsv或plain

--columns，-c

要顯示的欄。 可用欄： available、max、mounts、percent_used、sizes、used。 %或*字元可作為萬用字元使用。 值可能會以逗號（例如「a，b，c」）和/或空白字元分割。

--no-header

不要輸出表格標頭

--identity-file，-i

要使用的SSH身分識別（私密金鑰）

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

mount:upload

使用rsync將檔案上傳到掛載

選項

如需全域選項，請參閱全域選項。

--source

包含要上傳之檔案的目錄

--mount，-m

掛載（作為應用程式相對路徑）

--delete

是否要刪除掛載中的無關檔案

--exclude

要從上傳排除的檔案（模式）

--include

不排除的檔案（模式）

--refresh

是否要重新整理快取

--project，-p

專案ID或URL

--environment，-e

環境識別碼。 使用「。」 以選取專案的預設環境。

--app，-A

遠端應用程式名稱

--worker

背景工作名稱

--instance，-I

例項ID

--identity-file，-i

要使用的SSH身分識別（私密金鑰）