Installation
There are a few ways to install Xvc. Downloading a prebuilt binary is the
quickest; installing with cargo or pip is convenient if you already use
those tools.
Prebuilt binaries
Prebuilt binaries for Linux, macOS, and Windows are attached to every release.
Download the archive for your platform from the releases page, extract it, and
copy the xvc executable to a directory in your $PATH.
With Cargo
If you have Rust installed, you can build and install Xvc from crates.io:
$ cargo install xvc
This compiles Xvc with all default features. To produce a smaller binary by disabling features you don't need, see Compile without default features.
With pip
If you want to use Xvc from the Python console or Jupyter notebooks, you can
install it with pip:
$ pip install xvc
Note that a pip installation does not make xvc available as a shell
command; it exposes the Python bindings instead. See xvc.py for details.
Platform notes
Linux
The prebuilt Linux binaries run on most distributions. If you build from source, a recent stable Rust toolchain is all you need.
macOS
Both Apple Silicon (aarch64) and Intel (x86_64) binaries are published on the
releases page. Because the binaries are not notarized, macOS may block the
first run; allow it under System Settings → Privacy & Security, or install
with cargo install xvc instead.
Windows
Download the Windows archive from the releases page and place xvc.exe
somewhere in your %PATH%. Xvc works from PowerShell, the Command Prompt, and
WSL.
Next steps
- Add shell completions so that
TABcompletes commands, paths, and pipeline names. - Read Get Started for a guided tour.