How to Compile Xvc

Why would you compile?

  • You want to use Xvc on a platform that we don't distribute the binary.
  • You want a smaller binary size by removing features that you don't use.
  • You like your software compiled.
  • It's easier to use cargo than other means to install for you.
  • Fix a bug for yourself.
  • Contribute!

Install Rust

You must have Rust installed on your system.

If you have a sensible terminal on your system:

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Otherwise refer to other installation methods page.

Clone the repository

Clone the repository from Emre's Github repository.

$ git clone https://github.com/iesahin/xvc -b latest

The latest tag refers to the latest stable release. If you're willing to fight with compilation errors, you can also use the main branch directly.

Build

Build a release binary with:

$ cargo build --release

The compiled binary is placed at target/release/xvc. Copy it to a directory in your $PATH, or install it into Cargo's bin directory with:

$ cargo install --path lib

Compile without default features

By default, Xvc is built with every cloud-storage backend enabled. You can turn these off to get a smaller binary or to work around a platform that doesn't support a particular dependency (for example, reflink). See Compile without default features for the full list of feature flags and example commands.