xplr/docs/en/src/install.md

Install

You can install xplr using one of the following ways. Each has their own advantages and limitations.

For example, the Direct Download, From crates.io, and Build From Source methods allow the users to install the latest possible version of xplr, but they have one common drawback - the user will need to keep an eye on the releases, and manually upgrade xplr when a new version is available.

One way to keep an eye on the releases is to watch the repository.

Community Maintained Repositories

xplr can be installed from one of the following community maintained repositories:

Arch Linux

Official Community Repo

sudo pacman -S xplr

AUR

Binary version:

paru -S xplr-bin

Git version:

paru -S xplr-git

Void Linux

void-templates by shubham

Nix(OS)

Nixpkgs

nix-env -f https://github.com/NixOS/nixpkgs/tarball/master -iA xplr

macOS

MacPorts

sudo port selfupdate
sudo port install xplr

Homebrew

Stable branch:

brew install xplr

HEAD branch:

brew install --head xplr

FreeBSD

ports

pkg install xplr

Or

cd /usr/ports/misc/xplr
make install clean

NetBSD

pkgsrc

pkgin install xplr

Or

cd /usr/pkgsrc/sysutils/xplr
make install

Direct Download

One can directly download the standalone binary from the releases.

Currently, the following options are available for direct download:

• Linux
• macOS

Command-line instructions:

platform="linux"  # or "macos"

# Download
wget https://github.com/sayanarijit/xplr/releases/latest/download/xplr-$platform.tar.gz

# Extract
tar xzvf xplr-$platform.tar.gz

# Place in $PATH
sudo mv xplr /usr/local/bin/

From crates.io

Prerequisites:

• Rust toolchain,
• gcc
• make

Command-line instructions:

cargo install --locked --force xplr

Build From Source

Prerequisites:

• git
• Rust toolchain
• gcc
• make

Command-line instructions:

# Clone the repository
git clone https://github.com/sayanarijit/xplr.git
cd xplr

# Build
cargo build --locked --release --bin xplr

# Place in $PATH
sudo cp target/release/xplr /usr/local/bin/

Android

Termux

Please note that xplr isn't heavily tested on Termux, hence things might need a little tweaking and fixing for a smooth usage experience.

• Install build dependencies

  pkg install rustc cargo make
  

• Install xplr

  cargo install --locked --force xplr
  

• Setup storage

  termux-setup-storage
  

• Setup config and runtime dir

  export XDG_CONFIG_HOME="$PWD/storage/.config"
  export XDG_RUNTIME_DIR="$PWD/storage/run"
  
  mkdir -p "$XDG_CONFIG_HOME" "$XDG_RUNTIME_DIR"
  

• Run

  ~/.cargo/bin/xplr