fx
是一組子指令的進入點,可簡化許多與 Fuchsia 開發相關的工作。
這個檔案包含大量的子指令。執行 fx help
即可查看所有可用的子指令。
如果使用 bash 或 zsh 做為殼層,來源 scripts/fx-env.sh
,取得一些自動完成建議
另請參閱會影響所有子指令的全域選項和旗標。
fx 子指令
主要子指令
fx 工作流程中的子指令。
指令 | 類別 | 說明 |
---|---|---|
add-update-source | 軟體推送 | 將開發主機註冊為目標的更新來源 |
引數 | 版本 | 手動編輯目前建構目錄的 args.gn |
bazel | 版本 | 執行 Fuchsia 平台樹狀結構的實驗性 Bazel 建構作業 |
bazel-tool | 版本 | 在 Fuchsia Bazel 工作區中執行 bazel-tool 指令碼。 |
bootfs-size-report | 執行、檢查及偵錯 | 從 ZBI 產生未壓縮的大小報告 |
版本 | 版本 | 執行「忍者」來建造富希西亞人 |
建構指標 | 其他 | 管理建構指標設定 |
降水 | 來源樹狀結構 | 執行 cipd 指令列工具 |
乾淨 | 版本 | 清理目前的 Fuchsia 版本構件 |
clean-build | 版本 | 清理建構目錄,然後執行完整建構作業 |
清潔職棒 | 版本 | 刪除建構輸出目錄中過時產生的檔案。 |
cleandead-build | 版本 | 刪除過時產生的檔案,然後執行完整建構作業。 |
cmc | 版本 | 元件資訊清單編譯器 |
cp | 裝置管理 | 將檔案複製到目標裝置,或從目標裝置複製檔案 |
create-pb-zip | 其他 | 根據 product_bundles.json 檔案建立適合刷新的 pb.zip 檔案。 |
建立 | 來源樹狀結構 | Scaffold 新專案 |
文件檢查工具 | 提交及審查程式碼 | 使用各種檢查方式查看 Markdown 說明文件。 |
執行 | 其他 | 讀取目前的建構設定,然後執行 exec |
fargo | 版本 | Fargo 是 Cargo 周圍的 Fuchsia 專用原型包裝函式 |
擷取建構成果 | 版本 | TODO(https://fxbug.dev/42139110):建構中。 |
Flash | 裝置管理 | 視需要將已連結的裝置刷新 |
Flash-remote | 其他 | 從遠端建構、擷取 Fuchsia 映像檔並刷新到裝置上,請參閱 https://fuchsia.dev/fuchsia-src/development/sdk/ffx/flash-a-device。 |
格式代碼 | 來源樹狀結構 | 對修改的檔案執行來源格式設定工具 |
生成式 | 版本 | 對 Fuchsia 建構目錄執行 gn gen 。 |
get-build-artifacts | 內部 API | 已淘汰!已重新命名為「list-build-artifacts 」 |
get-build-dir | 版本 | 列印目前的 Fuchsia 建構目錄 |
get-device | 探索裝置 | 列印目前選取的裝置名稱 |
get-device-addr | 探索裝置 | 列印目前所選裝置的 Fuchsia 位址 |
get-flash-source | 內部 API | 建構並傳回所需的一組建構構件清單 |
get-src-dir | 版本 | 列印 Fuchsia 來源目錄 (結帳根目錄,又稱「//」) |
get-workspace-dir | 版本 | 輸出 Bazel 工作區目錄 |
gn | 版本 | 可為 Ninja 產生建構檔案的中繼建構系統 |
前往 | 版本 | 管理 Go 原始碼 |
說明文章 | 說明文件 | 建立 fx 子指令的 Markdown 文件 |
host-tool | 執行、檢查及偵錯 | 執行建構作業產生的主機工具 |
is-套件-server-running | 軟體推送 | 檢查套件伺服器是否正在執行 |
吉里 | 來源樹狀結構 | 適用於多存放區開發的多功能工具 |
jq | 其他 | jq 是用於在指令列中操作 JSON 的公用程式。 |
jq5 | 版本 | 將 jq 的功能擴充為 json5 物件。 |
Klog | 執行、檢查及偵錯 | 監聽核心記錄檔 |
list-boards | 版本 | 可用於建構的清單板 |
list-build-artifacts | 內部 API | 建構並傳回所需的一組建構構件清單 |
list-devices | 探索裝置 | 列出所有鄰近裝置 (不包括 zedboot) 的裝置 |
list-products | 版本 | 列出可建構的產品 |
list-usb-disks | 其他 | 列出已連接的 usb 磁碟 |
記錄檔 | 執行、檢查及偵錯 | 顯示目標裝置的記錄。 |
mdlint | 提交及審查程式碼 | Markdown Linter |
merge-套件-config | 其他 | |
metrics | 其他 | 管理 FX 工具中的指標集合 |
mkzedboot | 軟體推送 | 建立 Zedboot USB 金鑰 |
mkzedboot-remote | 軟體推送 | 建立 Zedboot USB 金鑰 |
多個 | 其他 | 在多個建構目錄中執行 fx 指令。 |
netaddr | 探索裝置 | 取得運作中的紫紅色系統位址 |
網路啟動 | 軟體推送 | 執行啟動伺服器以進行網路啟動 |
netboot-remote | 其他 | 遠端建構、擷取和網路啟動 |
網路 | 探索裝置 | 列出在本機網路上運作的冰雪系統 |
忍者 | 版本 | 來直接執行建構系統請勿使用一般工作流程。 |
ninjatrace2json | 版本 | 透過 chrome://tracing 收集 Ninja 追蹤記錄資訊進行分析 |
node-names | 裝置管理 | 尋找同一節點的其他名稱 |
北美地區 | 軟體推送 | 在已連結的裝置上執行系統 OTA |
鋪面 | 軟體推送 | 執行開機伺服器以便貼上 |
對講機 | 其他 | 遠端建構、擷取和鋪面 |
pave-zedboot | 軟體推送 | 執行用來貼上 Zedboot 的開機伺服器 |
pave-zedboot-remote | 其他 | 遠端建構、擷取及為 zedboot |
qemu | 執行、檢查及偵錯 | 使用 FVM 磁碟在 qemu 中啟動 Fuchsia |
重新啟動 | 裝置管理 | 重啟目標 Fuchsia 系統 |
重現 | 版本 | 在本機複製基礎架構建構和測試的結果 |
rfc | 來源樹狀結構 | Scaffold 新版 RFC |
run-host-tests | 測試 | 已淘汰!在主機上建構及執行測試 |
run-in-build-dir | 版本 | 在目前建構目錄的根目錄中執行指定的指令 |
run-netboot | 執行、檢查及偵錯 | 透過網路啟動模式在七種中啟動紫紅色 |
run-script | 其他 | 執行能利用 fx -i (疊代模式) 的自訂指令組合 |
單次收視出價 | 裝置管理 | 使用建構 SSH 設定叫用 VM |
sdk-deps | 其他 | 列出目標的依附元件,以及依附元件是否在 SDK 中 |
自行建構 | 版本 | 建立最少的主機依附元件來執行 fx 主要工作流程 |
自我測試 | 測試 | 執行 fx 和子指令測試 |
serial | 裝置管理 | 附加至序列控制台 |
服務 | 軟體推送 | 啟動更新伺服器,並連接至執行中的 fuchsia 裝置 |
serve-remote | 其他 | 來自遠端工作站 |
設定 | 版本 | 設定建構目錄 |
set-build-dir | 版本 | 設定其他 fx 指令使用的預設建構目錄 |
set-device | 探索裝置 | 設定與預設裝置互動的裝置 |
設定 macOS | 其他 | 在 MacOS 應用程式防火牆註冊主機工具 |
setup-ufw | 其他 | 設定 Linux 防火牆規則,允許 Fuchsia 裝置和模擬器流量。 |
sftp | 裝置管理 | 使用建構 SSH 設定叫用 SFTP |
保護殼 | 裝置管理 | 在目標裝置上啟動遠端互動式殼層 |
ssh | 裝置管理 | 使用 Fuchsia 裝置的 SSH 金鑰和設定來叫用 SSH。 |
狀態 | 其他 | 列印開發人員設定相關資訊 |
符號化 | 執行、檢查及偵錯 | 已淘汰,請使用「ffx 偵錯符號化」 |
同步 | 來源樹狀結構 | 將本機 Fuchsia 來源樹狀結構同步至指定狀態 |
syslog | 執行、檢查及偵錯 | 已淘汰!fx 記錄檔的已淘汰別名 |
測試 | 測試 | Fuchsia 測試的進入點 (主機、目標和端對端) |
testgen | 測試 | 元件整合測試自動產生器 |
取消設定裝置 | 探索裝置 | 取消設定與預設裝置互動 |
更新 | 軟體推送 | 已淘汰!FX ota 別名已淘汰 |
update-if-in-base | 軟體推送 | 檢查包裹是否位於基地,並視需要更新裝置 |
用途 | 版本 | 重複使用 fx set 設定的先前的建構目錄 |
供應商 | 其他 | 將指令轉送至供應商/*/指令碼/devshell |
等待 | 裝置管理 | 等待殼層可供使用 |
Contrib 子指令
具備其他支援層級和/或擁有權的專案成員提供的子指令。 OWNERS 檔案 Contrib 目錄提供指標,指向支援每個指令碼的成員。
指令 | 類別 | 說明 |
---|---|---|
add-test | 版本 | 為 args.gn 和 regen 新增 GN 標籤 |
Arm-esr | 其他 | 解碼 ARM 例外狀況 Syndrome Register 值 |
bindc | 執行、檢查及偵錯 | 執行繫結程式編譯器和偵錯工具 |
binutils | 執行、檢查及偵錯 | 提供預先建構 LLVM binutils 工具的捷徑 |
bisect-rustc | 其他 | |
blobstats | 執行、檢查及偵錯 | 從 |
bt-snoop-from-snapshot | 執行、檢查及偵錯 | 從快照中擷取窺探記錄,做為 pcap 格式資料 |
check-deps | 版本 | 檢查特定區域的依附元件圖表 |
檢查黃金 | 來源樹狀結構 | 檢查 GN 建構圖中的所有黃金檔案比較。 |
檢查授權 | 說明文件 | 分析指定套件或目錄的授權狀態 |
心肺負荷 | 提交及審查程式碼 | 在新視窗中開啟評論網址。 |
clang-tidy | 來源樹狀結構 | 在指定檔案上執行 clang-tidy |
夾扣 | 其他 | 這個外掛程式能在鎖定的 fx 環境中執行 Rust 輔助指令碼 |
夾扣 | 診斷 | |
compdb | 版本 | 不再使用 |
core-tests | 測試 | 執行 Zircon 核心測試 |
封面 | 測試 | 執行測試及匯出涵蓋範圍資料。 |
CPU 統計資料 | 執行、檢查及偵錯 | 從快照產生 CPU 統計資料報告 |
dis | 診斷 | 從版本傾印針對二進位檔進行反組譯。 |
exec-host-tests | 測試 | |
extract-pprof | 執行、檢查及偵錯 | 從 inspect.json 中擷取 pprof 資料 |
extract-zbi | 其他 | |
Fastboot | 裝置管理 | 透過 Quickboot 通訊協定直接與裝置的系統啟動載入程式互動 |
ffx | 其他 | 執行 ffx - 未來 fx |
fidlcat | 執行、檢查及偵錯 | 已淘汰,請使用「ffx 偵錯 fidl」 |
Fidldoc | 說明文件 | 產生 FIDL 的說明文件 |
fidltag | 其他 | 產生 .fidl 檔案的標記 |
尋找擁有者 | 其他 | |
force-ota-from-devhost | 軟體推送 | 從開發主機強制執行 Over The Air 系統更新 (重新啟動!) |
模糊 | 執行、檢查及偵錯 | 已淘汰!在目標裝置上執行模糊測試 |
gc | 軟體推送 | 對目標進行垃圾收集套件(重新啟動!) |
gce | 其他 | Google Compute Engine 指令 |
gdb | 執行、檢查及偵錯 | 執行 GDB (GNU DeBugger)。 |
Gen-cargo | 其他 | 這個外掛程式能在 fx 環境中執行 Rust 輔助指令碼 |
Gen-cargo | 來源樹狀結構 | 產生 Rust Cargo.toml 輸出檔案的符號連結 |
gerrit-split-cl | 提交及審查程式碼 | 將 CL 鏈結提交至 Gerrit |
提交狀態 | 提交及審查程式碼 | 將 CL 鏈結提交至 Gerrit |
小金 | 執行、檢查及偵錯 | 提供預先建構的 GNU 診斷工具捷徑 |
grep | 來源樹狀結構 | 列印 Fuchsia 來源中符合指定模式的線條 |
init-partition-Table | 其他 | 執行開機伺服器以初始化分區資料表 |
i 查詢 | 其他 | |
Lint | 來源樹狀結構 | 對已修改的檔案執行原始碼 Linter |
list-owners | 來源樹狀結構 | 找出與提供路徑對應的最接近 OWNERS 檔案,或 |
list-packages | 版本 | 列出建構的套件。 |
ls-buildid | 版本 | 尋找建構目錄、結帳和雲端儲存空間中的二進位檔 |
make-fuchsia-vol | 其他 | 建立 Scuchsia 永久磁碟 |
mkinstaller | 軟體推送 | 製作 Fuchsia 安裝程式圖片 |
mkinstaller-remote | 軟體推送 | 從遠端建構主機製作 Fuchsia 安裝程式映像檔 |
遷移文件 | 說明文件 | 這項輔助工具可批次將文件移到另一個位置 |
待處理承諾 | 來源樹狀結構 | 查看尚未發布至全域整合的修訂版本 |
功率摘要 | 執行、檢查及偵錯 | 總結檢查 Power Broker 的電源事件 |
功率化 | 執行、檢查及偵錯 | 總結檢查 Power Broker 的電源事件 |
pprof | 執行、檢查及偵錯 | 此 pprof 包裝函式可讓使用者在符號索引中存取本機檔案 |
發布 | 軟體推送 | 發布一組套件 |
qemu-cipd-ensure | 其他 | 產生 CIPD 檔案以下載目前的 QEMU 套件。 |
refresh-bazel-compdb | 其他 | |
refresh-bazel-compdb-bin.py | 其他 | |
remove-update-source | 軟體推送 | 將開發主機取消註冊為目標的更新來源 |
滾動式編譯器 | 其他 | |
run-boot-test | 執行、檢查及偵錯 | 執行 ZBI 測試 |
run-boot-test.py | 其他 | |
run-e2e-tests | 測試 | 執行 e2e 測試 |
Run-in-build | 執行、檢查及偵錯 | 在建構目錄中執行指令 |
執行/復原 | 執行、檢查及偵錯 | 在 qemu 中啟動 Fuchsia System Recovery |
run-zbi-test-remote | 執行、檢查及偵錯 | 從遠端建構、擷取及執行 ZBI 測試 |
rust-3p 過時 | 其他 | 這個外掛程式能在鎖定的 fx 環境中執行 Rust 輔助指令碼 |
rust-3p 過時 | 診斷 | |
rustdoc | 其他 | 這個外掛程式能在 fx 環境中執行 Rust 輔助指令碼 |
rustdoc-link | 其他 | 這個外掛程式能在 fx 環境中執行 Rust 輔助指令碼 |
rustdoc-link | 說明文件 | 透過連結產生的 Rust 程式碼說明文件。取代 fx rustdoc |
rustdoc | 說明文件 | 產生 Rust 程式碼的說明文件 |
rustfmt | 其他 | 這個外掛程式能在 fx 環境中執行 Rust 輔助指令碼 |
rustfmt | 來源樹狀結構 | Rust 程式碼格式 |
機台式 | 來源樹狀結構 | 設定 Jiri 管理特定寵物 |
其他 | 將單一位元組寫入 |tty|,以啟用外部轉發狀態。 | |
setup-go | 其他 | 設定 Go 開發項目的結帳功能。 |
setup-usb-ethernet | 其他 | 設定 USB CDC 乙太網路的 udev 規則 |
節目套件 | 軟體推送 | 列出套件內容 |
靜音 | 來源樹狀結構 | 以 allow 或編譯器建議的修正方式來靜音 Rust Lint |
大小檢查 | 其他 | 用於執行產品尺寸檢查工具的便利包裝函式。 |
煙霧測試 | 其他 | 在 fx 環境中執行 Python 輔助指令碼 |
煙霧測試 | 測試 | 找出並執行受目前變更影響的測試。 |
快照 | 執行、檢查及偵錯 | 從連結的目標取得並剖析快照。 |
史尼夫 | 執行、檢查及偵錯 | Fuchsia 封包擷取和顯示工具 |
sniff.py | 其他 | |
符號索引 | 版本 | (已淘汰) 操縱符號索引檔案 |
sync-from-stem | 來源樹狀結構 | 將整合與依附元件串連成符合 fuchsia.git 狀態的狀態 |
system-status | 裝置管理 | 取得系統狀態摘要 |
test-rustdoc | 測試 | 執行「fx rustdoc」所有信任目標 |
test-stats | 測試 | 查詢並計算測試統計資料。 |
test-stats.py | 測試 | 查詢並計算測試統計資料。 |
traceutil | 執行、檢查及偵錯 | Fuchsia 追蹤公用程式 |
分類 | 執行、檢查及偵錯 | 產生錯誤狀況報表 |
unarchive-package | 軟體推送 | 以 FAR 格式取消封存 Fuchsia 套件封存檔 |
update-3p-owners | 來源樹狀結構 | 更新第三方依附元件的 OWNERS 檔案 |
update-rust-3p-outdated | 來源樹狀結構 | 使用 crates.io 的最新內容更新外部 Rust 依附元件 |
update-rustc-third-party | 來源樹狀結構 | 更新 rustc_library 和 rustc_binary third_party 依附元件 |
validate-sdk | 版本 | 嘗試以核心 SDK 為基礎,建構幾個以 SDK 為基礎的 OOT 存放區 |
wipe-partition-tables | 其他 | 執行啟動伺服器來清除分區資料表 |
zbi_json_to_d3js.py | 其他 | |
zedmon | 其他 | 執行 Zedmon 用戶端 |
zxdb | 執行、檢查及偵錯 | 已淘汰,請使用「ffx debug connect」 |