Installation

XPipe can be installed in many different ways on all operating systems. Which installation method you choose depends on your preferences and your requirements.

If you are looking to use a package manager or want to deploy XPipe in your organization and want to automate the installation and upgrade process across multiple systems, check out the managed installation docs instead.

Note that this is a desktop application that should be run on your local desktop workstation, not on any server or containers. You don't need to set up anything on any servers with XPipe. All commands you see here should be run on your local desktop system.

Windows

Installers are the easiest way to get started:

If you don't like installers, you can also use a portable version packaged as an archive:

Alternatively, you can also use the following package managers:

choco to install it with choco install xpipe.
winget to install it with winget install xpipe-io.xpipe --source winget.
scoop to install it with scoop install extras/xpipe.

See the managed installation docs for more advanced installation methods.

Linux

You can install XPipe the fastest by pasting the installation command into your terminal. This will perform the setup automatically. The script supports installation via apt, dnf, yum, zypper, rpm, and pacman on Linux:

bash <(curl -sL https://github.com/xpipe-io/xpipe/raw/master/get-xpipe.sh)

You can find the source of the script here.

Of course, there are also manual installation methods for each distro available.

Debian-based distros

The following debian installers are available:

You should use apt to install the package with sudo apt install xpipe-installer-linux-*.deb as other package managers, for example dpkg, are not able to resolve and install any dependency packages.

There also exists an apt repository that you can add as an additional source to apt. This will allow you to install and upgrade XPipe through apt itself without having to download any installer files. For instructions on how to use it, see the managed installation guide.

RHEL-based distros

The rpm releases are signed with the GPG key https://xpipe.io/signatures/crschnick.asc. You can import it via rpm --import https://xpipe.io/signatures/crschnick.asc to allow your rpm-based package manager to verify the release signature.

The following rpm installers are available:

There also exists an rpm repository that you can add as an additional source to yum/dnf/etc. This will allow you to install and upgrade XPipe through your package manager itself without having to download any installer files. For instructions on how to use it, see the managed installation guide.

Arch

There is an official AUR package available that you can either install manually with

git clone https://aur.archlinux.org/packages/xpipe
cd xpipe
makepkg -sirc

or via an AUR helper such as with yay with

yay -S xpipe

AppImage

Alternatively, there are also AppImages available. These can be useful if you are using an immutable distro.

This portable version assumes that you have some basic packages for graphical systems already installed as it is not a perfect standalone version. It should however run on most systems.

NixOS

There's an official xpipe nixpkg available that you can install with nix-env -iA nixos.xpipe. This one is usually not up-to-date.

There is also a custom repository that contains the latest up-to-date releases: https://github.com/xpipe-io/nixpkg. You can install XPipe by following the instructions in the linked repository.

Tarball

In case you prefer to use an archive that you can extract anywhere, you can use these:

This portable version assumes that you have some basic packages for graphical systems already installed as it is not a perfect standalone version. It should however run on most systems.

WSL

XPipe can also be run in the Windows Subsystem for Linux with graphics support. If you follow the instructions for WSL2g GUIs, installing XPipe on the WSL system via one of the available Linux installers will make XPipe run in your WSL environment.

Note that as WSL is only a minimal installation, it is strongly recommended to use an installer to also install any neither dependencies for XPipe. The portable versions don't declare dependencies and might not run properly if any dependency is missing.

Running XPipe in WSL can be useful to have full native access to your WSL connections, e.g. if you are normally using the WSL OpenSSH version for any kind of SSH related tasks instead of the native Windows OpenSSH port.

Android Linux Terminal

If you are running an up-to-date Android system with support for AVF, you can take a look at the new Android Linux Terminal app. This official app essentially runs a full debian VM on your phone and does not require any sideloading or jailbreaks. If you are running Android 16+ and your phone supports AVF (not all do, even newer ones), you can use it.

XPipe can be run on this debian system by just installing it as a normal application as you would do on a regular Linux system. See the debian install instruction for details.

You can make use of all features on this VM, assuming that you have installed the necessary tools. As the basic VM image is pretty basic, you will need to install a proper text editor, terminal, RDP client, etc. But once you do, you will have the full feature set that you also get on normal desktop systems.

macOS

Installers are the easiest way to get started:

If you don't like installers, you can also use a portable version packaged as an archive:

Alternatively, you can also use the official homebrew tap to install XPipe with brew install --cask xpipe-io/tap/xpipe.

On this page