Quick Start

Installation

Linux — script (any distro):

curl -fsSL https://orbitbits.com/tildr/linux.sh | sh

macOS — script:

curl -fsSL https://orbitbits.com/tildr/macos.sh | sh

Debian / Ubuntu / Mint — apt repository:

# Import GPG key
curl -fsSL https://deb.orbitbits.com/tildr-deb-pub.gpg \
  | sudo gpg --dearmor -o /usr/share/keyrings/tildr.gpg

# Add repository
echo "deb [signed-by=/usr/share/keyrings/tildr.gpg] https://deb.orbitbits.com/ stable main" \
  | sudo tee /etc/apt/sources.list.d/tildr.list

# Install
sudo apt update && sudo apt install tildr

Fedora / RHEL — RPM repository:

# Import GPG key
sudo rpm --import https://rpm.orbitbits.com/tildr-rpm-pub.gpg

# Add repository
sudo dnf config-manager addrepo \
  --from-repofile=https://rpm.orbitbits.com/tildr.repo

# Install
sudo dnf install tildr

First setup

# Initialize the Tildr repository
tildr init

# Add a file to manage
tildr add .bashrc

# Add a directory (traversed recursively)
tildr add .config/nvim

# Check the state of managed files
tildr status

# See what is in the repository
tildr list

# Verify the setup
tildr doctor

Everyday workflow

# Apply repository state to $HOME (repairs symlinks)
tildr apply

# Check for drift
tildr status

# See Git changes inside the repository
tildr git status

# Sync with a remote (bidirectional pull/push)
tildr sync

That is all you need to get started. See the Command Reference for detailed usage of each command.