Getting Started

Installation

Dits can be installed on macOS, Linux, and Windows. Choose the installation method that works best for your workflow.

Quick Install

The fastest way to install Dits is via npm, which works on all platforms and automatically downloads the correct binary for your system.

Important

Use npm. The published package is @byronwade/dits (currently v0.1.5). The Homebrew tap and cargo install dits options are not yet published — the byronwade/dits tap and the dits crate do not exist yet. Use the npm install below.

npm / bun / pnpmRecommended

Works on all platforms. No Rust toolchain required.

# npm
npm install -g @byronwade/dits

# bun
bun install -g @byronwade/dits

# pnpm
pnpm install -g @byronwade/dits

System Requirements

Operating System	Architectures	Minimum Version	Notes
macOS	Apple Silicon (M1/M2/M3) Intel x64	macOS 11 (Big Sur)	macFUSE required for VFS features
Linux	x64 (glibc) ARM64 (glibc) x64 (musl) ARM64 (musl)	glibc 2.17+ or musl	FUSE3 required for VFS features
Windows	x64 ARM64	Windows 10	Dokany required for VFS features

Verify Installation

After installation, verify that Dits is working correctly:

$ dits --version
dits 0.1.5

$ dits --help
Dits - Distributed version control for video and large files

Usage: dits <COMMAND>

Commands:
  init      Create a new repository
  clone     Clone a repository
  status    Show repository status
  add       Add files to staging
  commit    Create a commit
  ...

Installing FUSE (Optional)

FUSE is only required if you want to use the Virtual Filesystem feature, which allows you to mount repositories as drives without downloading all files.

macFUSE

brew install macfuse

System Extension Required

macFUSE requires enabling a system extension. Follow the prompts after installation and restart your Mac.

Troubleshooting

Command not found

If you get a "command not found" error after installation, ensure that the installation directory is in your PATH:

# For npm global installs, add to your shell profile:
export PATH="$PATH:$(npm config get prefix)/bin"

# For cargo installs:
export PATH="$PATH:$HOME/.cargo/bin"

Permission denied

On macOS or Linux, if you get permission errors with the curl installer:

# Install to a local directory
curl -fsSL https://raw.githubusercontent.com/byronwade/dits/main/install.sh | sh -s -- --prefix=$HOME/.local

SSL/TLS errors

If you encounter SSL certificate errors, ensure your system's CA certificates are up to date:

# macOS
brew install ca-certificates

# Ubuntu/Debian
sudo apt update && sudo apt install ca-certificates

Next Steps

Follow the Quick Start Guide to create your first repository
Learn about Core Concepts
Explore the CLI Reference