shell-rs README

The project's README from github.com/since2006/shell-rs. As one markdown file: README.md.

ShellRS

ShellRS

A high-performance, native, cross-platform SSH client written in Rust, with a GPU-rendered interface: Xshell-style host management, WinSCP-style SFTP and port forwarding, all in one window.

Release License: GPL-3.0 Platform: macOS | Windows | Linux Rust 1.98 LINUX DO

English | 简体中文

ShellRS main window: a grouped host tree on the left, htop running in a remote terminal on the right, connection latency in the tab bar

About

ShellRS brings Xshell-style host management and tabbed terminals, a WinSCP-style dual-pane SFTP browser and SSH port forwarding together in one cross-platform app, which bastion hosts such as JumpServer can launch the way they launch Xshell and WinSCP. It is written in Rust, and its UI is built on GPUI, the GPU-accelerated UI framework of the Zed editor (through gpui-kit). There is no Electron and no JVM.

Hosts, groups, credentials and forwarding rules live in a local SQLite database. Passwords and key passphrases go only into the system keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service); the database never holds a secret. ShellRS also ships a shellrs command that lets AI agents such as Claude Code or Codex run commands and transfer files on your saved hosts without ever seeing a password.

Features

Hosts

Terminal

Right sidebar tools

SFTP

Opening from a bastion host

Port forwarding

Credentials

A CLI for AI agents

Security and updates

Screenshots

A split view: a remote terminal on top and SFTP for the same host below
Dock splits: a remote terminal and SFTP stacked in one window

Five right sidebar tools side by side: Monitor, Processes, Services, Docker and Network
Right sidebar tools: Monitor, Processes, Services, Docker and Network

Dual-pane SFTP: three local items selected on the left, remote /etc on the right, and a transfer queue with one batch uploading and one waiting
WinSCP-style SFTP: highlight selection and a transfer queue with progress, speed and time left

Edit port forward dialog with the diagram and explanation of a local forward, and two running rules in the forward list
Port forwarding: the diagram shows where each connection goes

Download

Download from shellrs.com/download, which offers the package for your system, or from GitHub Releases. Betas are marked Pre-release there; to get new features early, switch the update channel to Beta in Settings › About.

System Package Notes
macOS 11+ (Apple Silicon) ShellRS-<version>-macos-aarch64.dmg Signed and notarized. Open the DMG and drag ShellRS into Applications
macOS 11+ (Intel) ShellRS-<version>-macos-x86_64.dmg Signed and notarized. Open the DMG and drag ShellRS into Applications
Windows x64 ShellRS-<version>-windows-x86_64-setup.exe Installs per user, no administrator rights needed. The installer is not signed yet; if SmartScreen stops it, choose "More info › Run anyway"
Linux x64 ShellRS-<version>-linux-x86_64.AppImage chmod +x and run. Needs glibc 2.35 or newer (Ubuntu 22.04, Debian 12 and later)

Every package comes with a minisign signature (.minisig), and each release has a SHA256SUMS file.

Once installed, ShellRS keeps itself up to date: it checks, downloads and verifies new versions in the background, then shows an icon in the top-right corner of the title bar; click it and choose "Restart to update", or just quit and the update is installed on the way out. Automatic updates are unavailable when ShellRS runs from inside the DMG or outside the Applications folder, or on Linux when it isn't run as the AppImage.

Getting started

  1. Click "New host…" in the title bar (⌘N, or Ctrl+N on Windows and Linux) and fill in the address, port and login. Passwords go into the system keychain.
  2. Double-click a host to open a terminal. On the first connection you're asked to confirm the host key.
  3. Right-click a host and choose "Open SFTP", or click "SFTP" at the right of the terminal's tab bar. Drag files between the two panes to transfer them.
  4. The three icons after "ShellRS" in the title bar switch the sidebar between hosts, port forwards and credentials.
  5. ⌘T (Ctrl+T) opens a local terminal. Drag a tab to the top, bottom, left or right edge of the tab area to split it.

For AI agents

In Settings › External CLI, turn on Enable external CLI, then install the shellrs command and the Agent Skills. Your agent can then use the hosts you have saved:

shellrs hosts list -q web                          # list hosts and their IDs
shellrs exec <ID> "uptime && df -h"                # run a command; the exit code is the remote one
shellrs upload <ID> ./dist/app.tar.gz /opt/app/    # upload
shellrs download <ID> /var/log/syslog ./logs/      # download
shellrs sync <ID> ./dist /opt/app --delete         # sync a folder, skipping unchanged files

The command hands each request to the running ShellRS, which logs in with the saved settings and keychain. An unknown host or a missing password fails right away with a stable error code instead of a prompt that would hang the agent. See the user manual for details.

Building from source

Install rustup. The repository's rust-toolchain.toml pins Rust 1.98.1, which rustup installs on the first build.

git clone https://github.com/since2006/shell-rs.git
cd shell-rs
cargo run

The first build compiles the whole GPUI stack and takes a while. See development notes (in Chinese) for the Linux system packages and how to run the tests.

Documentation

Apart from the user manual, the documentation is in Chinese for now:

Roadmap

Not implemented yet:

Contributing

Issues and pull requests are welcome on GitHub. Architecture notes and code conventions are in CLAUDE.md (in Chinese). Before sending a change, make sure these pass:

cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test

Acknowledgements

License

ShellRS is licensed under the GNU General Public License v3.0. You may use, modify and redistribute it, commercially or not, but any modified version you distribute must come with its complete source code under the GPL-3.0 as well.

shell-rs (since2006/shell-rs)

sftp
Searching Database…

What is this?ShellRS is a native, cross-platform SSH client that combines Xshell-style host management, tabbed terminals, a WinSCP-style dual-pane SFTP browser and SSH port forwarding in one window.
Is this built on Electron like most cross-platform desktop apps?No. It's written in Rust with GPUI, the GPU-accelerated UI framework from the Zed editor, instead of Electron or a JVM.
How do I get it running?Download the package for your OS from shellrs.com/download or GitHub Releases (DMG for macOS, EXE installer for Windows, AppImage for Linux), then click 'New host' to add a server and double-click it to connect.
Any rough edges I should expect right now?The Windows installer isn't code-signed yet, so SmartScreen may need 'More info > Run anyway'. The system monitor, processes, services and Docker sidebar tools only work against Linux hosts, and directory sync/search in SFTP is still on the roadmap.
Does it need Apple Silicon, or does it work on Intel Macs and Linux too?Both Mac architectures are covered with separate signed, notarized DMGs, plus a Windows x64 installer and a Linux x64 AppImage.
Where do my saved passwords and connection data actually go?Passwords and key passphrases are stored only in the OS keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service) and never in the local SQLite database. Anonymous usage stats (version, OS, CPU architecture, feature usage) go to Aptabase and can be turned off.
What does the GPL-3.0 license mean if I modify ShellRS?You can use and redistribute ShellRS freely, commercially or not, but any modified version you distribute must ship its complete source code under GPL-3.0 as well.
What does the shellrs CLI let AI agents like Claude Code do?It exposes hosts, credentials, exec, upload, download and sync commands; the running ShellRS app logs in on the agent's behalf, so the command itself never sees a password or private key.
Can SFTP transfers survive a dropped connection?Yes. Data is written to a .filepart first, drops are retried after 1, 3 and 10 seconds, and after a restart ShellRS offers to resume the same transfer.
How does port forwarding work here?It supports local (-L), remote (-R) and dynamic SOCKS (-D) forwards, each shown as a live diagram, with its own SSH connection that auto-reconnects up to three times if dropped.
Can ShellRS be launched from a bastion host like Xshell or WinSCP is?Yes, it understands Xshell's -url/-newtab flags and WinSCP's /sessionname= so a bastion such as JumpServer can open ShellRS directly, using an unsaved connection that stays out of the host list.
What are similar projects?omnyssh, WindTerm, pebrel, navop, Netcatty, AceShell, tailcat, herdr-gpui
Creator
since2006
Size
16.3 MB
Stars
331
Age
1mo
Commits · 90 Days