Installation
Install Script
The recommended way to install Oxidoc is the install script, which detects your platform and downloads the correct binary.
curl -fsSL https://oxidoc.dev/install.sh | sh
irm https://oxidoc.dev/install.ps1 | iex
The script detects your platform, downloads the correct binary, and adds it to your PATH.
Custom Install Directory
Set OXIDOC_INSTALL_DIR to change the install location:
OXIDOC_INSTALL_DIR=/usr/local/bin \
curl -fsSL https://oxidoc.dev/install.sh | sh
GitHub Releases
Download a pre-built binary directly from GitHub Releases.
| Platform | Architecture | Binary |
| Linux | x86_64 | oxidoc-x86_64-unknown-linux-gnu |
| Linux | aarch64 | oxidoc-aarch64-unknown-linux-gnu |
| macOS | x86_64 | oxidoc-x86_64-apple-darwin |
| macOS | Apple Silicon | oxidoc-aarch64-apple-darwin |
| Windows | x86_64 | oxidoc-x86_64-pc-windows-msvc.exe |
Verify Installation
oxidoc --version
Update
Update to the latest stable release:
oxidoc update
Install the latest prerelease:
oxidoc update --pre
Switch Versions
Pin a specific version:
oxidoc set-version v0.1.0
This downloads and installs that exact version, useful for locking CI to a known-good release.
Uninstall
Remove the binary and its directory:
rm -rf ~/.oxidoc
Remove the PATH entry from your shell config (~/.bashrc, ~/.zshrc, etc.) if it was added.