Skip to content

快速入门

克隆仓库

bash
git clone -c core.longpaths=true git@github.com:oxc-project/oxc.git

项目设置

安装 Rust

如果尚未安装 Rust,请按照 官方说明 安装 Rust。

安装 Rust 后,进入项目根目录并运行以下命令:

bash
rustup show

rustup show 会读取 ./rust-toolchain.toml 文件,并为该项目安装正确的 Rust 工具链和组件。

cargo binstall

开发 OXC 需要一些 Cargo 工具,推荐使用 cargo binstall,它提供了一种低复杂度的方式来安装 Rust 二进制文件,比通过运行 cargo install 从源码构建更快。

bash
cargo install cargo-binstall

您也可以下载 预编译的二进制文件 并保存到 ~/.cargo/bin 目录中。

just

OXC 使用 just,这是一种便捷的方式来保存和运行项目特定的命令:

bash
cargo binstall just -y

安装 CMake

从官方 网站 下载并安装 CMake。

Homebrew 用户也可以通过以下命令安装:

bash
brew install cmake

安装 pnpm

按照官方 网站 的说明安装 pnpm(Node.js 的包管理器,类似于 npm)。

依赖项

在项目根目录的 justfile 中运行以下命令以安装依赖项:

bash
just init

运行 just 可查看可用命令列表。

您可以运行 just ready(或简写为 just r)以确保整个项目能够正确构建和运行。

macOS:加速编译

macOS 的 XProtect 安全功能会在首次运行可执行文件时扫描其是否含有恶意软件。这可能会显著减慢 Rust 构建过程,尤其是构建脚本和测试可执行文件。您可以通过在系统设置中将终端添加为“开发者工具”来加快编译速度:

  1. 打开 系统设置 > 隐私与安全性 > 开发者工具
  2. 添加您的终端应用程序(Terminal、iTerm 等)
  3. 重启终端应用程序

注意: 此操作会禁用操作系统的一项安全功能。仅当您愿意接受此权衡时才建议执行。

更多详情:https://nnethercote.github.io/2025/09/04/faster-rust-builds-on-mac.html