lee/xpipe
1
0
Fork 0
mirror of https://github.com/xpipe-io/xpipe.git synced 2026-09-22 16:35:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Experiment with icons

Browse Source
This commit is contained in:
crschnick
2026-01-06 14:32:50 +00:00
parent f82e4e5f2e
commit f7f270bd3f
1 changed files with 50 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+50 -34
View File
@@ -8,75 +8,82 @@
## About
XPipe is a new type of shell connection hub and remote file manager that allows you to access your entire server infrastructure from your local machine. It works on top of your installed command-line programs and does not require any setup on your remote systems. So if you normally use CLI tools like `ssh`, `docker`, `kubectl`, etc. to connect to your servers, you can just use XPipe on top of that.
XPipe fully integrates with your tools such as your favourite text/code editors, terminals, shells, command-line tools and more. The platform is designed to be extensible, allowing anyone to add easily support for more tools or to implement custom functionality through a modular extension system.
XPipe is a connection hub that allows you to access your entire server infrastructure from your local desktop. It works on top of your installed command-line programs like SSH, docker, or others, and does not require any setup on your remote systems. It integrates with your favourite text editors, terminals, shells, VNC/RDP clients, password managers, and command-line tools. The platform is designed to be extensible, allowing anyone to add easily support for more tools or to implement custom functionality through a modular extension system.
It currently supports:
- [SSH](https://docs.xpipe.io/guide/ssh) connections, config files, and tunnels
- [Docker](https://docs.xpipe.io/guide/docker), [Podman](https://docs.xpipe.io/guide/podman), [LXD](https://docs.xpipe.io/guide/lxc), and [incus](https://docs.xpipe.io/guide/lxc) containers
- [Proxmox PVE](https://docs.xpipe.io/guide/proxmox), [Hyper-V](https://docs.xpipe.io/guide/hyperv), [KVM](https://docs.xpipe.io/guide/kvm), [VMware Player/Workstation/Fusion](https://docs.xpipe.io/guide/vmware) virtual machines
- [Docker](https://docs.xpipe.io/guide/docker) + compose, [Podman](https://docs.xpipe.io/guide/podman), [LXD](https://docs.xpipe.io/guide/lxc), and [incus](https://docs.xpipe.io/guide/lxc) containers
- [Proxmox PVE](https://docs.xpipe.io/guide/proxmox), [Hyper-V](https://docs.xpipe.io/guide/hyperv), [KVM](https://docs.xpipe.io/guide/kvm), and [VMware Player/Workstation/Fusion](https://docs.xpipe.io/guide/vmware) virtual machines
- [Tailscale](https://docs.xpipe.io/guide/tailscale), [Netbird](https://docs.xpipe.io/guide/netbird), and [Teleport](https://docs.xpipe.io/guide/teleport) connections
- [AWS](https://docs.xpipe.io/guide/aws) and [Hetzner Cloud](https://docs.xpipe.io/guide/hcloud) servers
- Windows Subsystem for Linux, Cygwin, and MSYS2 environments
- [Powershell Remote Sessions](https://docs.xpipe.io/guide/pssession)
- [RDP](https://docs.xpipe.io/guide/rdp) and [VNC](https://docs.xpipe.io/guide/vnc) connections
- Windows Subsystem for Linux, Cygwin, and MSYS2 environments
- [Kubernetes](https://docs.xpipe.io/guide/kubernetes) clusters, pods, and containers
- [Powershell Remote Sessions](https://docs.xpipe.io/guide/pssession)
## Connection hub
## Connection hub ([Docs](https://docs.xpipe.io/guide/hub))
- Easily connect to and access all kinds of remote connections in one place
- Organize all your connections in hierarchical categories so you can keep an overview hundreds of connections
- Create specific login environments on any system to instantly jump into a properly set up environment for every use case
- Quickly perform various commonly used actions like starting/stopping containers, establishing tunnels, and more
- Create desktop shortcuts that automatically open remote connections in your terminal without having to open any GUI
- Easily establish and manage connections to remote systems from a central hub interface
- Organize all your connections in hierarchical categories to maintain an overview over hundreds of connections.
- Create custom shell login environments to instantly jump into a properly set up shell for every use case
- Quickly perform various commonly used actions like starting/stopping systems, establishing tunnels, and more
- Create desktop shortcuts and macros that automatically open remote connections in your terminal without having to open any GUI
![Connections](https://github.com/xpipe-io/.github/raw/main/img/hub_shadow.png)
![Connection hub](https://github.com/xpipe-io/.github/raw/main/img/hub_shadow.png)
## Powerful file management
## File browser ([Docs](https://docs.xpipe.io/guide/file-browser))
- Interact with the file system of any remote system using a workflow optimized for professionals
- Quickly open a terminal session into any directory in your favourite terminal emulator
- Utilize your entire arsenal of locally installed programs to open and edit remote files
- Dynamically elevate sessions with sudo when required without having to restart the session
- Seamlessly transfer files from and to your system desktop environment
- Work and perform transfers on multiple systems at the same time with the built-in tabbed multitasking
- Quickly open a terminal session into any directory in your favourite terminal emulator
- Customize every action through the scripting system
![Browser](https://github.com/xpipe-io/.github/raw/main/img/browser_shadow.png)
## Terminal launcher
## Terminal launcher ([Docs](https://docs.xpipe.io/guide/terminals))
- Boots you into a shell session in your favourite terminal with one click. Automatically fills password prompts and more
- Launches you into a shell session in your favourite terminal with one click. Automatically fills password prompts and more
- Comes with support for all commonly used terminal emulators across all operating systems
- Supports opening custom terminal emulators as well via a custom command-line spec
- Works with all command shells such as bash, zsh, cmd, PowerShell, and more, locally and remote
- Works with all command shells such as bash, zsh, fish, cmd, PowerShell, and more, locally and remote
- Integrates with multiplexers like tmux and zellij, plus prompts like starship and oh-my-zsh
- Supports opening multiple sessions in split terminal pane views
- Connects to a system while the terminal is still starting up, allowing for faster connections than otherwise possible
![Terminal](https://github.com/xpipe-io/.github/raw/main/img/terminal_shadow.png)
<br>
<p align="center">
<img src="https://github.com/xpipe-io/.github/raw/main/img/terminal.gif" alt="Terminal launcher"/>
</p>
<br>
## Versatile scripting system
## Versatile scripting system ([Docs](https://docs.xpipe.io/guide/scripting))
- Create reusable simple shell scripts, templates, and groups to run on connected remote systems
- Automatically make your scripts available in the PATH on any remote system without any setup
- Setup shell init environments for connections to fully customize your work environment for every purpose
- Open custom shells and custom remote connections by providing your own commands
- Use custom scripts in the file browser
![scripts](https://github.com/xpipe-io/.github/raw/main/img/scripts_shadow.png)
## Secure vault
## Sync via git ([Docs](https://docs.xpipe.io/guide/sync))
- All data is stored exclusively on your local system in a cryptographically secure vault. You can also choose to increase security by using a custom master passphrase for further encryption
- XPipe is able to retrieve secrets automatically from your password manager via it's command-line interface.
- There are no servers involved, all your information stays on your systems. The XPipe application does not send any personal or sensitive information to outside services.
- Vault changes can be pushed and pulled from your own remote git repository by multiple team members across many systems
## Integrations
<div>
<a href="https://xpipe.io" target="_blank" rel="noopener">
<img src="https://xpipe.io/assets/images/HomePage/ssh_icon.svg" alt="XPipe Banner" />
</a>
<a href="https://xpipe.io" target="_blank" rel="noopener">
<img src="https://xpipe.io/assets/images/HomePage/docker_icon.svg" alt="XPipe Banner" />
</a>
</div>
# Downloads
Note that this is a desktop application that should be run on your local desktop workstation, not on any server or containers. It will be able to connect to your server infrastructure from there.
@@ -96,6 +103,7 @@ If you don't like installers, you can also use a portable version that is packag
Alternatively, you can also use the following package managers:
- [choco](https://community.chocolatey.org/packages/xpipe) to install it with `choco install xpipe`.
- [winget](https://github.com/microsoft/winget-cli) to install it with `winget install xpipe-io.xpipe --source winget`.
- [scoop](https://github.com/microsoft/winget-cli) to install it with `scoop install extras/xpipe`.
## macOS
@@ -146,25 +154,27 @@ The following rpm installers are available:
There is an official [AUR package](https://aur.archlinux.org/packages/xpipe) available that you can either install manually or via an AUR helper such as with `yay -S xpipe`.
### AppImages
Alternatively, there are also AppImages available. These can be useful if you are using an immutable distro.
- [Linux .AppImage Portable (x86-64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-linux-x86_64.AppImage)
- [Linux .AppImage Portable (ARM 64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-linux-arm64.AppImage)
### NixOS
There's an official [xpipe nixpkg](https://search.nixos.org/packages?channel=unstable&show=xpipe&from=0&size=50&sort=relevance&type=packages&query=xpipe) available that you can install with `nix-env -iA nixos.xpipe` on x86_64 Linux systems. This package is however usually not up to date.
There is also a custom repository that contains the latest up-to-date release flakes for Linux and macOS systems: https://github.com/xpipe-io/nixpkg.
### Portable
### Tarball
In case you prefer to use an archive version that you can extract anywhere, you can use these:
- [Linux .tar.gz Portable (x86-64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-linux-x86_64.tar.gz)
- [Linux .tar.gz Portable (ARM 64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-linux-arm64.tar.gz)
Alternatively, there are also AppImages available:
- [Linux .AppImage Portable (x86-64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-linux-x86_64.AppImage)
- [Linux .AppImage Portable (ARM 64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-linux-arm64.AppImage)
## Docker container
### Docker container
XPipe is a desktop application first and foremost. It requires a full desktop environment to function with various installed applications such as terminals, editors, shells, CLI tools, and more. So there is no true web-based interface for XPipe.
@@ -172,6 +182,12 @@ Since it might make sense however to access your XPipe environment from the web,
# Further information
## Contributing
See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
<img src="https://contrib.rocks/image?repo=xpipe-io/xpipe" alt="contrib.rocks image" />
## Open source model
XPipe follows an open core model, which essentially means that the main application is open source while certain other components are not. This mainly concerns the features only available in the homelab/professional plan and the shell handling library implementation. Furthermore, some CI pipelines and tests that run on private servers are also not included in the open repository.