xpipe-mirror/README.md

88 lines
5 KiB
Markdown
Raw Normal View History

2023-04-11 21:20:09 +00:00
<img src="https://user-images.githubusercontent.com/72509152/213873342-7638e830-8a95-4b5d-ad3e-5a9a0b4bf538.png" alt="drawing" width="250"/>
2022-08-13 07:29:26 +00:00
2023-06-02 08:42:34 +00:00
### The remote file browser for professionals
2023-04-16 23:06:59 +00:00
2023-06-02 08:42:34 +00:00
XPipe is a brand-new type of remote file browser that works by only interacting with your installed command-line tools on local and remote shell connections. This approach makes it much more flexible as it doesn't have to deal with file system APIs or remote file handling protocols at all.
2023-04-16 23:06:59 +00:00
It currently supports:
2023-06-02 08:42:34 +00:00
- Containers located on any host such as [docker](https://www.docker.com/) or [LXD](https://linuxcontainers.org/lxd/introduction/) container instances
2023-04-16 23:06:59 +00:00
- [SSH](https://www.ssh.com/academy/ssh/protocol) connections
2023-06-02 08:42:34 +00:00
- [Windows Subsystem for Linux](https://ubuntu.com/wsl) instances
2023-04-16 23:06:59 +00:00
- [Powershell Remote Sessions](https://learn.microsoft.com/en-us/powershell/scripting/learn/remoting/running-remote-commands?view=powershell-7.3)
2023-06-02 08:42:34 +00:00
- [Kubernetes](https://kubernetes.io/) clusters and their contained pods and containers
2023-04-16 23:06:59 +00:00
- Any other custom remote connection methods that works through the command-line
- Arbitrary types of proxies to establish connections
2023-06-02 08:42:34 +00:00
Furthermore, XPipe integrates with your existing tools and workflows by delegating all tasks to your favourite text/code editors, terminals, shells, command-line tools and more. The platform is designed to be extensible, allowing anyone to implement custom functionality through extensions.
2023-01-27 02:34:46 +00:00
2023-05-01 07:06:35 +00:00
You have more questions? Then check out the new [FAQ](/FAQ.md).
2023-06-02 16:44:41 +00:00
## Downloads
2023-03-28 11:43:55 +00:00
2023-06-02 16:44:41 +00:00
### Installers
Installers are the easiest way to get started and come with an automatic updater functionality. The following installers are available:
- [Windows .msi Installer (x86_64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-installer-windows-x86_64.msi)
- [Linux .deb Installer (x86_64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-installer-linux-x86_64.deb)
- [Linux .rpm Installer (x86_64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-installer-linux-x86_64.rpm)
- [MacOS .pkg Installer (x86_64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-installer-macos-x86_64.pkg)
- [MacOS .pkg Installer (arm64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-installer-macos-arm64.pkg)
### Portable
If you don't like installers, you can also use portable versions that are packaged as an archive. The following portable versions are available:
- [Windows .zip Portable (x86_64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-windows-x86_64.zip)
- [Linux .tar.gz Portable (x86_64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-linux-x86_64.tar.gz)
- [MacOS .dmg Portable (x86_64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-macos-x86_64.dmg)
- [MacOS .dmg Portable (arm64)](https://github.com/xpipe-io/xpipe/releases/latest/download/xpipe-portable-macos-arm64.dmg)
### Bash Script (Linux / MacOS)
You can also install XPipe by pasting the installation command into your terminal. This will perform the full setup automatically.
```
bash <(curl -sL https://raw.githubusercontent.com/xpipe-io/xpipe/master/get-xpipe.sh)
```
2023-03-28 11:43:55 +00:00
## Features
2023-06-02 08:42:34 +00:00
### Flexible remote file browser
2023-01-27 02:34:46 +00:00
2023-06-02 08:42:34 +00:00
- Interact with the file system of any remote system using a workflow optimized for professionals
2023-03-28 11:56:11 +00:00
- Quickly open a terminal into any directory
- Utilize your favourite local programs to open and edit remote files
2023-01-27 02:34:46 +00:00
2023-04-16 23:10:59 +00:00
![Remote file explorer](https://user-images.githubusercontent.com/72509152/230100929-4476f76c-ea81-43d9-ac4a-b3b02df2334e.png)
2023-04-10 15:47:17 +00:00
2023-06-02 08:42:34 +00:00
### Simple connection management
2023-01-27 02:34:46 +00:00
2023-06-02 08:42:34 +00:00
- Easily create and manage all kinds of remote connections
2023-04-16 23:06:59 +00:00
- Securely stores all information exclusively on your computer and encrypts all secret information. See
2023-06-02 08:42:34 +00:00
the [security page](/SECURITY.md) for more information
- Create custom desktop shortcuts to automatically open specific remote connections in your terminal
2023-01-27 02:34:46 +00:00
2023-04-16 23:14:20 +00:00
![Connection manager](https://user-images.githubusercontent.com/72509152/230098966-000596ca-8167-4cb8-8ada-f6b3a7d482e2.png)
2023-01-27 02:34:46 +00:00
2023-03-28 11:56:11 +00:00
### Instant launch for remote shells and commands
- Automatically login into a shell in your favourite terminal with one click (no need to fill password prompts, etc.)
2023-06-02 08:42:34 +00:00
- Works for all kinds of shells. This includes command shells (e.g. bash, PowerShell, cmd, etc.) and some database shells (e.g. PostgreSQL Shell)
- Comes with support for all commonly used terminals across all operating systems
2023-03-28 11:56:11 +00:00
- Allows you to customize the launched shell's init environment
2023-06-02 08:42:34 +00:00
- Supports launches from the GUI or command-line
2023-02-27 05:38:36 +00:00
2023-04-16 23:06:59 +00:00
## Further information
2023-02-08 21:34:19 +00:00
2023-05-20 14:23:36 +00:00
For information about the security model of XPipe, see the [security page](/SECURITY.md).
2022-06-17 22:29:41 +00:00
2023-05-20 14:23:36 +00:00
For information about the privacy policy of XPipe, see the [privacy page](/PRIVACY.md).
2023-04-21 13:04:19 +00:00
2023-06-02 08:42:34 +00:00
In case you're interested in development, check out the [development page](/DEVELOPMENT.md).
2023-04-16 23:06:59 +00:00
If you want to talk you can also join:
2022-06-17 22:29:41 +00:00
2023-05-20 14:23:36 +00:00
- The [XPipe Discord Server](https://discord.gg/8y89vS8cRb)
- The [XPipe Slack Server](https://join.slack.com/t/XPipe/shared_invite/zt-1awjq0t5j-5i4UjNJfNe1VN4b_auu6Cg)