xpipe-mirror/README.md

69 lines
3.3 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-04-16 23:06:59 +00:00
### A flexible connection manager and remote file explorer
2023-04-17 11:15:43 +00:00
X-Pipe is a brand-new type of connection manager and remote file explorer that works by only interacting with command-line
2023-04-16 23:06:59 +00:00
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.
It currently supports:
- Containers located on any host, e.g. [docker](https://www.docker.com/) or [LXD](https://linuxcontainers.org/lxd/introduction/) container instances
- [SSH](https://www.ssh.com/academy/ssh/protocol) connections
- [Windows Subsystem for Linux](https://ubuntu.com/wsl) instances located on any host
- [Powershell Remote Sessions](https://learn.microsoft.com/en-us/powershell/scripting/learn/remoting/running-remote-commands?view=powershell-7.3)
- Any other custom remote connection methods that works through the command-line
- Arbitrary types of proxies to establish connections
Furthermore, X-Pipe integrates with your existing tools and workflows
by outsourcing as many tasks as possible to your favourite
2023-02-10 17:40:03 +00:00
text/code editors, terminals, shells, command-line tools and more.
2023-04-10 15:47:17 +00:00
The platform is designed to be extensible, allowing anyone
to implement custom functionality through extensions.
2023-01-27 02:34:46 +00:00
2023-03-28 11:43:55 +00:00
## Getting Started
2023-03-31 13:43:13 +00:00
Head over to the [releases page](https://github.com/xpipe-io/xpipe/releases/latest) and try it out.
2023-03-28 11:43:55 +00:00
## Features
2023-03-28 11:56:11 +00:00
### Remote file explorer
2023-01-27 02:34:46 +00:00
2023-04-16 23:06:59 +00:00
- Access the file system of any remote system
2023-03-28 11:56:11 +00:00
- Quickly open a terminal into any directory
- Run commands from the explorer interface
- 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-04-16 23:06:59 +00:00
### Connection manager
2023-01-27 02:34:46 +00:00
2023-02-03 11:10:08 +00:00
- Easily create and manage all kinds of remote connections at one location
2023-04-16 23:06:59 +00:00
- Securely stores all information exclusively on your computer and encrypts all secret information. See
the [security page](/SECURITY.md) for more info
2023-04-10 15:47:17 +00:00
- Create desktop shortcuts to automatically open your 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-04-16 23:06:59 +00:00
- Works for all kinds of shells. This includes command shells (e.g. bash, PowerShell, cmd, etc.) and database shells (
e.g. PostgreSQL Shell)
2023-03-28 11:56:11 +00:00
- Comes with integrations for all commonly used terminals for all operating systems
- Allows you to customize the launched shell's init environment
2023-04-10 15:47:17 +00:00
- 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-04-16 23:06:59 +00:00
In case you're interested in development, check out the [development page](/DEVELOPMENT.md).
2022-06-17 22:29:41 +00:00
2023-04-16 23:06:59 +00:00
For information about the security model of X-Pipe, see the [security page](/SECURITY.md).
2022-06-17 22:29:41 +00:00
2023-04-21 13:04:19 +00:00
For information about the privacy policy of X-Pipe, see the [privacy page](/PRIVACY.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-04-16 23:06:59 +00:00
- The [X-Pipe Discord Server](https://discord.gg/8y89vS8cRb)
- The [X-Pipe Slack Server](https://join.slack.com/t/x-pipe/shared_invite/zt-1awjq0t5j-5i4UjNJfNe1VN4b_auu6Cg)