Getting Started

F2 is distributed as a standalone binary, making it easy to install and use without requiring any external dependencies or special permissions. Once downloaded, simply place the binary in your $PATH, and you're ready to start renaming files efficiently.

However, in addition to downloading the binary directly, several other installation methods are provided to simplify the process, such as managing updates, installing the companion man page, or setting up shell completion files. You can even choose to build the program from the source if you prefer.

Install with Go

If you have Go installed, you can easily install F2 using the go install command (requires v1.23 or later):

go install github.com/ayoisaiah/f2/v2/cmd/f2@latest

Install via NPM

If you have Node.js installed, the F2 package can be installed through npm:

npm i @ayoisaiah/f2 -g

Note that other package managers are not guaranteed to work.

Install on Linux

Binary Downloads

You can download the binary directly from the F2 releases page. Simply download the archive that matches your system's architecture, extract it, and move it to your $PATH to make it accessible from the command line.

# Download the archive
curl -LO https://github.com/ayoisaiah/f2/releases/download/v2.0.1/f2_2.0.1_linux_amd64.tar.gz

# Extract the contents
tar -xvzf f2_2.0.1_linux_amd64.tar.gz

# Make the binary executable
chmod +x f2

# Move the binary to a directory in your $PATH
sudo mv f2 /usr/local/bin

Arch Linux

For Arch Linux users, F2 is available via the Arch User Repository (AUR). Use the following command to install F2 via yay or similar tools:

yay -S f2-bin

Debian / Ubuntu (and derivatives)

Debian and Ubuntu users can download and install the .deb package for their system directly from the releases page:

# Download the deb package
curl -LO https://github.com/ayoisaiah/f2/releases/download/v2.0.1/f2_2.0.1_linux_amd64.deb

# Install the package
sudo dpkg -i f2_2.0.1_linux_amd64.deb

Fedora / CentOS

For Fedora or CentOS users, you can install F2 using the .rpm package from the releases page:

# Download the rpm package
curl -LO https://github.com/ayoisaiah/f2/releases/download/v2.0.1/f2_2.0.1_linux_amd64.rpm

# Install the package
sudo rpm -i f2_2.0.1_linux_amd64.rpm

Install on macOS

Binary Downloads

macOS users can also download F2 from the releases page. After downloading the correct binary for your architecture, follow these steps:

# Download the archive
curl -LO https://github.com/ayoisaiah/f2/releases/download/v2.0.1/f2_2.0.1_darwin_amd64.tar.gz

# Extract the contents
tar -xvzf f2_2.0.1_darwin_amd64.tar.gz

# Make the binary executable
chmod +x f2

# Move the binary to your PATH
sudo mv f2 /usr/local/bin

Install on Windows

Binary Downloads

You can download the appropriate F2 binary for Windows from the releases page, extract it, and add it to your system's PATH to use it from the command line:

# Download the archive
curl.exe -LO https://github.com/ayoisaiah/f2/releases/download/v2.0.1/f2_2.0.1_windows_amd64.tar.gz

# Extract the contents
tar -xvzf f2_2.0.1_windows_amd64.tar.gz

# Move the binary to a directory in your PATH
move f2.exe C:\Users\<user>\.bin

Winget

The native Windows Package Manager can be used to install F2 directly:

winget install ayoisaiah.f2

Scoop

You can also install F2 using Scoop, a popular package manager for Windows:

scoop bucket add ayoisaiah-scoop-bucket https://github.com/ayoisaiah/scoop-bucket

scoop install f2

Chocolatey

To install F2 with Chocolatey, run the following command from the command line or PowerShell:

choco install f2

Development Build

If you prefer to be on the bleeding edge, F2 provides a development build that allows you to use the latest features and bug fixes directly from the master branch.