fx - Fuchsia 开发命令

fx 是一组子命令的入口点,这些子命令可让许多与 Fuchsia 开发相关的任务变得更轻松。

它包含大量子命令。运行 fx help 可查看所有可用的子命令。 如果您使用 bash 或 zsh 作为 shell,请运行 scripts/fx-env.sh
以获取一些自动补全功能。

另请参阅影响所有子命令的全局选项和标志。

fx 子命令

主要子命令

fx 工作流中的子命令。

命令 类别 说明
add-update-source 软件交付 将代码库软件包服务器注册为设备的更新来源
args build 手动修改当前 build 目录的 args.gn
atomic-commit 其他 创建一对将以原子方式提交的更改。它将修改
bazel build 为 Fuchsia 平台树运行实验性 Bazel build
bazel-tool build 在 Fuchsia Bazel 工作区中运行 bazel-tool 脚本。
bootfs-size-report 运行、检查和调试 根据 ZBI 生成未压缩大小报告
build build 运行 Ninja 以构建 Fuchsia
build-and-upload build 构建并上传到 GCS。
build-metrics 其他 管理构建指标配置
build-profile 其他 管理 build profile 配置
cipd 源代码树 运行 cipd 命令行工具
clean build 清理当前的 Fuchsia build 工件
clean-build build 清理 build 目录,然后执行完整 build
cleandead build 删除 build 输出目录中过时的生成文件。
cleandead-build build 删除过时的生成文件,然后执行完整 build。
cleanrepo build 移除 amber-files/ 中已发布的代码库。
cleanrepo-build build 移除 amber-files/ 中已发布的仓库,然后执行完整 build。
cmc build 组件清单编译器
cp 设备管理 将文件复制到目标设备/从目标设备复制文件
create-pb-zip 其他 根据 product_bundles.json 文件创建适合刷写的 pb.zip。
create 源代码树 搭建新项目基架
debug 运行、检查和调试 启动目标端 zxdb 调试会话
doc-checker 代码提交和审核 使用各种检查来检查 Markdown 文档。
emu 运行、检查和调试 模拟设备并与之交互(转发到 ffx emu)。
exec 其他 读取当前 build 配置,然后执行
fargo build Fargo 是一个围绕 Cargo 的 Fuchsia 专用封装容器原型
fetch-build-artifacts build TODO(https://fxbug.dev/42139110):正在开发中。
flash 设备管理 刷写已连接的设备
flash-remote 其他 远程构建 Fuchsia 映像,并将其提取和刷写到设备上,请参阅 https://fuchsia.dev/fuchsia-src/development/sdk/ffx/flash-a-device
format-code 源代码树 通过 SHAC 对修改后的文件运行源代码格式化工具
gen build 针对 Fuchsia build 目录运行 gn gen。
get-build-artifacts 内部 API 已弃用!已重命名为 list-build-artifacts
get-build-dir build 输出当前 Fuchsia build 目录
get-device 设备发现 输出当前所选设备的名称
get-device-addr 设备发现 输出当前所选设备的 Fuchsia 地址
get-flash-source 内部 API 构建并返回所需的一组 build 工件的列表
get-src-dir build 输出 Fuchsia 源目录(检出根目录,即“//”)
get-workspace-dir build 假设你有一个 Bazel 工作区 其中包含所有源代码
gn build 为 Ninja 生成 build 文件的元构建系统
go build 管理 Go 源代码
helpdoc 文档 为 fx 子命令创建 Markdown 文档
host-tool 运行、检查和调试 运行由 build 生成的主机工具
is-package-server-running 软件交付 检查软件包服务器是否正在运行
jiri 源代码树 多用途工具。
jq 其他 jq 是一个用于在命令行中操作 JSON 的实用程序。
jq5 build 将 jq 的功能扩展到 json5 对象。
klog 运行、检查和调试 监听内核日志
lint 源代码树 通过 SHAC 对修改后的文件运行静态分析检查
list-boards build 列出可用于构建的开发板
list-build-artifacts 内部 API 构建并返回所需的一组 build 工件的列表
list-devices 设备发现 列出附近的设备(不包括 zedboot 上的设备)
list-products build 列出可用于构建的产品
list-usb-disks 其他 列出已连接的 U 盘
local-publish-platform 其他 将平台工件发布到本地 CIPD 实例。
log 运行、检查和调试 显示目标设备中的日志。
mdlint 代码提交和审核 Markdown linter
merge-package-config 其他
metrics 其他 管理 fx 工具中的指标收集
mkzedboot 软件交付 制作 zedboot USB 密钥
mkzedboot-remote 软件交付 制作 zedboot USB 密钥
multi 其他 在多个 build 目录中运行 fx 命令。
netaddr 设备发现 获取正在运行的 Fuchsia 系统的地址
netls 设备发现 列出本地网络上正在运行的 Fuchsia 系统
ninja build 直接运行构建系统。请勿用于常规工作流。
ninjatrace2json build 收集 Ninja 跟踪记录信息,以便在 chrome://tracing 中进行分析
node-names 设备管理 查找同一节点的其他名称
ota 软件交付 在已连接的设备上执行系统 OTA
qemu 运行、检查和调试 使用 FVM 磁盘在 qemu 中启动 fuchsia
rbe build 检查远程 build 配置
reboot 设备管理 重新启动目标 Fuchsia 系统
repro build 在本地复制基础架构构建和测试的结果
resultstore build 管理构建 ResultStore 配置。ResultStore 是一项服务
rfc 源代码树 搭建新 RFC 的基架
run-host-tests 测试 已弃用!在主机上构建和运行测试
run-in-build-dir build 在当前 build 目录的根目录下运行给定命令
run-netboot 运行、检查和调试 通过 netboot 在 qemu 中启动 fuchsia
run-script 其他 运行自定义命令组合,能够利用 fx -i(迭代模式)
scp 设备管理 使用 build ssh 配置调用 scp
sdk-deps 其他 已弃用!列出目标的依赖项,以及依赖项是否在 SDK 中
自建 build 构建运行 fx 主工作流所需的最低主机依赖项
自测 测试 运行 fx 和子命令的测试
serial 设备管理 连接到串行控制台
serve 软件交付 启动更新服务器并连接到正在运行的 Fuchsia 设备
serve-remote 其他 从远程工作站提供服务
set build 设置 build 目录
set-build-dir build 设置其他 fx 命令使用的默认 build 目录
set-device 设备发现 设置默认互动设备
set-main-pb build 设置要在多产品环境中构建的产品包
setup-firewall 其他 设置 Linux 防火墙规则,以允许 Fuchsia 设备和模拟器流量。
setup-ufw 其他 设置 Linux 防火墙规则,以允许 Fuchsia 设备和模拟器流量。
sftp 设备管理 使用 build ssh 配置调用 sftp
shell 设备管理 在目标设备中启动远程交互式 shell
ssh 设备管理 使用 Fuchsia 设备的 SSH 密钥和配置调用 SSH。
状态 其他 输出有关开发者设置的相关信息
sync 源代码树 为 Fuchsia git 检出引导和同步本地依赖项
sync-to 源代码树 将本地 Fuchsia 源代码树同步到给定状态
syslog 运行、检查和调试 已弃用!fx log 的已弃用别名
test 测试 所有 Fuchsia 测试(主机、目标和端到端)的入口点
testgen 测试 组件集成测试自动生成器
unset-device 设备发现 取消设置要与之交互的默认设备
update 软件交付 已弃用!fx ota 的已弃用别名
update-if-in-base 软件交付 检查软件包是否在基础映像中,并根据需要更新设备
use build 重复使用由 fx set 设置的先前 build 目录
供应商 其他 将命令转发到 vendor/*/scripts/devshell
wait 设备管理 等待 shell 变为可用状态
worktree 源代码树 管理 Fuchsia 工作树

Contrib 子命令

由项目成员贡献的子命令,这些成员具有其他级别的支持和/或所有权。 contrib 目录中的 OWNERS 文件提供了指向支持每个脚本的成员的指针。

命令 类别 说明
add-host-test build 向 args.gn 添加 GN 标签并重新生成
add-test build 向 args.gn 添加 GN 标签并重新生成
代理 开发者工具 管理 AI 编码智能体配置、权限和开发者工作流。
arm-esr 其他 解码 ARM 异常综合征寄存器值
bazel2gn 源代码树 为同时在 BUILD.gn 和 BUILD.bazel 中构建的目标同步这两个文件。
bindc 运行、检查和调试 运行绑定程序编译器和调试程序
binutils 运行、检查和调试 提供预构建 LLVM binutils 工具的快捷方式
bisect-rustc 其他
blobstats 运行、检查和调试 根据 build 计算一些 blobfs 统计信息
bt-snoop-from-snapshot 运行、检查和调试 从快照中提取 snoop 日志作为 pcap 格式的数据
build-main-pb build 构建当前默认产品软件包
build-zbi 内核 发布要刷写到设备上以用于开发的产品 zbi。
check-deps build 检查依赖关系图
check-goldens 源代码树 检查 GN build 图中的所有黄金标准文件比较。
check-licenses 文档 分析给定软件包或目录的许可状态
cl 代码提交和审核 输出 Gerrit 审核网址,并尝试在用户的默认浏览器中打开该网址。
clang-tidy 源代码树 在指定文件上运行 clang-tidy
clippy 其他 在 fx 环境中运行 Rust 辅助脚本
clippy 诊断
compdb build 不推荐
core-tests 测试 运行 zircon 核心测试
覆盖率 测试 运行测试并导出覆盖率数据。
cpu-stats 运行、检查和调试 根据快照生成 CPU 统计信息报告
crosvm 运行、检查和调试 运行 crosvm
dis build 反汇编 build 中的给定二进制文件。
download-baseline 其他 查找给定构建器的最新成功示例构建,并下载其指标。
download-metrics 其他 从 CAS 下载指标工件。
download-toolchain 工具链 从 CI 下载预构建的工具链(clang、rust)
dtsfmt 源代码树 dtsfmt 是一个用于设置设备树源 (.dts) 文件格式的实用程序。
dupefinder 运行、检查和调试 报告堆转储中的重复分配。
enable-ffx-usb 其他 启用对 ffx 的 USB 协议的支持
exec-host-tests 测试
extract-metrics 其他 从 Fuchsia 性能结果中提取指标。
extract-pprof 运行、检查和调试 从 inspect.json 中提取 pprof 数据
extract-zbi 其他
fastboot 设备管理 通过 fastboot 协议直接与设备的引导加载程序交互
fetch-toolchain build 从 CAS 下载工具链并输出说明
ffx 其他 执行 ffx - 适用于 Fuchsia 设备的开发者工具。
fidlcat 运行、检查和调试 已弃用,请使用“ffx debug fidl”
fidldoc 文档 为 FIDL 生成文档
fidltags 其他 为 .fidl 文件生成标记
find-owner 其他
flash-kola 其他 将 Fuchsia 刷写到具有未修改引导加载程序的 Kola 开发板上。
force-ota-from-devhost 软件交付 已弃用!fx ota 的已弃用别名
fuzz 运行、检查和调试 已弃用!在目标设备上运行模糊测试
gc 软件交付 对目标上的软件包进行垃圾回收(重新启动!)
gen-cargo 其他 在 fx 环境中运行 Rust 辅助脚本
gen-cargo 源代码树 生成指向 Rust Cargo.toml 输出文件的符号链接
gen-watchman-config 开发者工具 生成一个 .watchmanconfig 文件,以便与 jj 搭配使用
gerrit-split-cl 代码提交和审核 将 CL 链提交到 Gerrit
gerrit-submit 代码提交和审核 将 CL 链提交到 Gerrit
get-main-pb-path build 获取所提供产品包的输出路径
gum 其他 gum 是一个用于为脚本添加互动性的实用程序
iquery 其他
list-owners 源代码树 查找与所提供路径对应的最近 OWNERS 文件,或
list-packages build 列出构建的软件包。
llvm 运行、检查和调试 提供预构建的 Clang/LLVM 工具的快捷方式
ls-buildid build 在构建目录、检出和 Google Cloud 中查找二进制文件
make-fuchsia-vol 其他 构建 Fuchsia 永久性磁盘
min-owners 源代码树 建议由最少数量的代码所有者来审核提交内容。
mkinstaller 软件交付 制作 Fuchsia 安装程序映像
mkinstaller-remote 软件交付 通过远程构建主机制作 Fuchsia 安装映像
move-docs 文档 用于将文档从一个位置批量移动到另一个位置的辅助工具
pending-commits 源代码树 查看尚未发布到全局集成的提交
perf-analyze 运行、检查和调试 独立性能分析工具
pprof 运行、检查和调试 pprof 封装容器,可用于访问 symbol-index 中的本地文件
publish 软件交付 发布一组软件包
qemu-cipd-ensure 其他 生成 CIPD 文件,以下载当前的 QEMU 软件包。
readme_fuchsia 文档 解析、设置和验证 README.fuchsia 文件
refresh-bazel-compdb 其他
remove-update-source 软件交付 取消将代码库软件包服务器注册为设备的更新来源
roll-compiler 其他
run-boot-test 运行、检查和调试 运行 ZBI 测试
run-boot-test.py 其他
run-e2e-tests 测试 运行端到端测试
run-in-build 运行、检查和调试 在 build 目录中运行命令
run-recovery 运行、检查和调试 在 qemu 中启动 Fuchsia 系统恢复
run-zbi-test-remote 运行、检查和调试 远程构建 ZBI 测试,提取并运行该测试
rust-3p-outdated 其他 在 fx 环境中运行 Rust 辅助脚本
rust-3p-outdated 诊断
rustdoc-link 其他 在 fx 环境中运行 Rust 辅助脚本
rustdoc-link 文档 为 Rust 代码生成文档链接。替换 fx rustdoc
set-petal 源代码树 配置 jiri 以管理特定 petal
set-relay 其他 通过向 |tty| 写入一个字节来驱动外部继电器的状态。
setup-go 其他 设置 Go 开发的检出。
setup-jj 开发者工具 设置 jj 工具(如果已安装),以便与 Fuchsia 搭配使用。
setup-usb-ethernet 其他 为 USB CDC 以太网设置 udev 规则
show-package 软件交付 列出软件包内容
shush 源代码树 使用 allow 或编译器建议的修复来忽略 Rust lint
size-check 其他 用于运行产品大小检查器的便捷封装容器。
smoke-test 其他 在 fx 环境中运行 Python 辅助脚本
smoke-test 测试 查找并运行受当前更改影响的测试。
快照 运行、检查和调试 从已连接的目标获取并解析快照。
sniff 运行、检查和调试 Fuchsia 数据包捕获和显示工具
sniff.py 其他
sync-from-stem 源代码树 将集成和依赖项同步到与 fuchsia.git 状态匹配的状态
system-status 设备管理 获取系统状态摘要
test-category 测试 查询和查看已配置的测试类别信息。
test-stats 测试 查询和计算测试统计信息。
test-stats.py 测试 查询和计算测试统计信息。
triage 运行、检查和调试 生成错误情况报告,其中包含 Google 专属规则。
update-3p-owners 源代码树 更新 third_party 依赖项的 OWNERS 文件
update-bazel-vendor-dir build 更新 Bazel 供应商目录,以包含所有必要的 Bazel 依赖项。
update-rustc-third-party 源代码树 更新 rustc_library 和 rustc_binary 第三方依赖项
zbi_json_to_d3js.py 其他
zedmon 其他 运行 zedmon 客户端
zxdb 运行、检查和调试 已弃用,请使用“ffx debug connect”