Getting Started

Clone Repository

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

Set Up Project

Install Rust

If you have not yet installed Rust, follow the official instruction and install Rust.

After installing Rust, run the following command on the project root:

rustup show

rustup show reads the ./rust-toolchain.toml file and installs the correct Rust toolchain and components for this project.

cargo binstall

Some Cargo tools are required to develop OXC, and it is recommended to use cargo binstall, which provides a low-complexity mechanism to install rust binaries and is faster way than building them from source by running cargo install.

cargo install cargo-binstall

You can also download the pre-compiled binary and save it in ~/.cargo/bin.

just

OXC utilizes just, which is a handy way to save and run project-specific commands:

cargo binstall just -y

Install CMake

Install CMake by downloading from the official website.

Homebrew users can alternatively install with:

brew install cmake

Dependencies

Run the following command in justfile at the project root to install dependencies:

just init

You can see the list of available commands by running just.

You can run just ready (or, just r in short) to make sure the whole project builds and runs correctly.