Installation

Quick Install

Install Renamify on Linux or macOS:

curl -fsSL https://docspring.github.io/renamify/install.sh | bash

Alternative Install Options

# System-wide install
curl -fsSL https://docspring.github.io/renamify/install.sh | bash -s -- --system

# Custom directory
curl -fsSL https://docspring.github.io/renamify/install.sh | bash -s -- --prefix "$HOME/bin"

# Uninstall
curl -fsSL https://docspring.github.io/renamify/install.sh | bash -s -- --uninstall

The install script defaults to ~/.local/bin (no sudo required) and detects your OS and architecture automatically.

Download Binary

Linux

x86_64 / amd64

curl -L https://github.com/DocSpring/renamify/releases/latest/download/renamify-linux-amd64.tar.gz | tar xz
sudo mv renamify /usr/local/bin/renamify
sudo chmod 755 /usr/local/bin/renamify
renamify --version

arm64

curl -L https://github.com/DocSpring/renamify/releases/latest/download/renamify-linux-arm64.tar.gz | tar xz
sudo mv renamify /usr/local/bin/renamify
sudo chmod 755 /usr/local/bin/renamify
renamify --version

macOS

Intel (x86_64)

curl -L https://github.com/DocSpring/renamify/releases/latest/download/renamify-macos-amd64.tar.gz | tar xz
sudo mv renamify /usr/local/bin/renamify
sudo chmod 755 /usr/local/bin/renamify
renamify --version

Apple Silicon (arm64)

curl -L https://github.com/DocSpring/renamify/releases/latest/download/renamify-macos-arm64.tar.gz | tar xz
sudo mv renamify /usr/local/bin/renamify
sudo chmod 755 /usr/local/bin/renamify
renamify --version

Windows

x86_64 / amd64

# Download the latest release
Invoke-WebRequest -Uri "https://github.com/DocSpring/renamify/releases/latest/download/renamify-windows-amd64.zip" -OutFile "renamify.zip"

# Extract to Program Files
Expand-Archive -Path "renamify.zip" -DestinationPath "$env:ProgramFiles\renamify"

# Add to PATH (requires admin privileges)
[Environment]::SetEnvironmentVariable("Path", "$env:Path;$env:ProgramFiles\renamify", [EnvironmentVariableTarget]::Machine)

# Verify installation (open new terminal)
renamify --version

arm64

# Download the latest release
Invoke-WebRequest -Uri "https://github.com/DocSpring/renamify/releases/latest/download/renamify-windows-arm64.zip" -OutFile "renamify.zip"

# Extract to Program Files
Expand-Archive -Path "renamify.zip" -DestinationPath "$env:ProgramFiles\renamify"

# Add to PATH (requires admin privileges)
[Environment]::SetEnvironmentVariable("Path", "$env:Path;$env:ProgramFiles\renamify", [EnvironmentVariableTarget]::Machine)

# Verify installation (open new terminal)
renamify --version

Build from Source (Alternative)

# Install Rust for Windows from https://win.rustup.rs/
# Clone and build from source
git clone https://github.com/DocSpring/renamify.git
cd renamify
cargo build --release
# Copy target/release/renamify.exe to your PATH

Package Managers

Homebrew (macOS/Linux)

Homebrew formula will be available once Renamify reaches 75 GitHub stars (Homebrew requirement.)

Star Renamify on GitHub Help us reach 75 stars on GitHub

Other Package Managers

Help us get Renamify into: Cargo, Chocolatey, AUR, and other package managers.

Build from Source

For developers who want to build from source:

Prerequisites: Rust 1.89.0 or later

git clone https://github.com/DocSpring/renamify
cd renamify
cargo build --release
cp ./target/release/renamify /usr/local/bin/