Open-source project
xxh/xxh avatar
xxh/xxh

xxh uploads a prepared shell instead of installing one

🚀 Bring your favorite shell wherever you go through the ssh. Xonsh shell, fish, zsh, osquery and so on.

6,131 stars125 forksPythonBSD-2-Clause

At a glance

What is it?
xxh is a Python launcher that carries a portable shell over ssh: the shell and its plugins are built on your own machine, uploaded to a Linux x86_64 host, and confined to a single ~/.xxh directory that can be deleted afterwards.
Who is it for?
xxh earns its place when you open many ssh sessions and want the same aliases, plugins and prompt on each one without touching the host. It is the wrong tool for a macOS or Windows target, for ARM hardware you cannot build yourself, or for a fish user who needs the seamless entrypoint, since that file is still an open todo.
Can I use it commercially?
Yes. BSD-2-Clause is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 166 days ago.
What is it written in?
Mainly Python, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • xxh/xxh6,131 ★ · +33
Star history
Repository2026-09-232026-11-15
xxh/xxh6.1k6.1k

33 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The remote home is one directory you can delete

Everything on the far side of an xxh session lives inside a single directory. Preparation happens on your own machine: you assemble the portable shell and its plugins locally, and xxh uploads the finished result to the target host. Nothing is installed there and no root access is asked for, which is the reason the project treats the host environment and your privacy as the design constraint instead of a side concern. By default the home of the session is the `.xxh` directory on the host. Delete that directory and the remote environment behaves as though xxh had never been there. A wiki page covers how to point the home at your own user directory, which is how you pick a different hermetic level for a session. That choice also draws the boundary: anything xxh needs at run time has to travel inside the uploaded tree, because once you remove the directory nothing remains to fall back on.

Linux on x86_64 is the only target host named as supported

One platform line constrains everything else: the target host is Linux on x86_64. ARM support is mentioned, but the pointer leads to a community issue rather than to first party builds, so an ARM machine depends on work that lives outside the core repository. The AppImage route adds its own requirement, since on Alpine Linux the image needs alpine-pkg-glibc installed together with localedef before it runs at all. Neither macOS nor Windows appears anywhere in the shell table, so a session on those systems is outside what xxh packages here deliver.

Four stable shells, one beta and two alpha in the table

The shell table is where the project's own status vocabulary lives. xonsh, zsh, fish and bash are each marked stable. osquery is marked beta, and it is the odd row in the table because its plugin and seamless columns are empty: no prerun plugin list and no entrypoint file are named for it. fish-appimage and elvish are marked alpha, and elvish is maintained in a separate community repository rather than under the xxh organisation. Plugin coverage is uneven for the same reason. zsh has ohmyzsh and p10k, fish has ohmyfish, fisher and userconfig, bash has ohmybash, and xonsh has autojump. Counting the rows, only four of the seven entries carry a stability label you would want to build a daily workflow on.

fish has no seamless entrypoint and the launcher ships only three of them

Seamless mode decides how a shell is launched, and the table names a file for it in most rows: `xxh.xsh` for xonsh, `xxh.zsh` for zsh, `xxh.bash` for bash. The fish row does not have a file name. Its cell points at a todo item in issue 74, which is how the project records that fish still has no seamless entrypoint. The two alpha rows, fish-appimage and elvish, have empty seamless cells as well. The packaging metadata matches that table exactly, because pyproject.toml installs the launcher together with `xxh.zsh`, `xxh.xsh` and `xxh.bash` as script files. So a fish user gets the shell and its plugin ecosystem, and not the entrypoint file that the other three stable shells ship with.

Eight ways to install, each with a different cost

The distribution is published under two names depending on the channel. PyPI, pipx and conda-forge carry `xxh-xxh`, while Homebrew and Macports install a package called `xxh`, and the conda route asks you to add the conda-forge channel first. If you already live inside a xonsh session, `xpip` is the shortest path. Macports is the only method that needs elevated rights on your own machine, through `sudo port`. The two download methods need no package manager at all, but they pin a specific release in the URL rather than tracking the newest one. The Python package needs Python 3.6 or newer and pulls in pexpect and pyyaml.

```shell script pip install xxh-xxh pipx install xxh-xxh xpip install xxh-xxh brew install xxh sudo port install xxh ```

The published download commands still point at 0.8.12

Both no-package-manager commands in the docs embed the release number in the URL, and both use 0.8.12, which is well behind the tags the repository has published since. The release list runs 0.8.16 and 0.8.15, both dated 2026-04-06, with 0.8.14 from 2024-04-06 before them. Copying the tarball command as written therefore installs an older build than the newest one available, and the AppImage command has the same property. The last push to the default branch, master, is dated 2026-06-02, and the repository is not archived, so the work has not stopped; the gap is between the docs and the tags rather than between the tags and the code. Editing the version segment in the URL is the only way to get the newer build from these two commands.

```shell script mkdir ~/xxh && cd ~/xxh wget https://github.com/xxh/xxh/releases/download/0.8.12/xxh-portable-musl-alpine-Linux-x86_64.tar.gz tar -xzf xxh-portable-musl-alpine-Linux-x86_64.tar.gz ./xxh ```

Any portable tool can sit behind an entrypoint

The shell packages are only the first use of the entrypoint idea. The same mechanism accepts any tool or code that can run portably, and the project names browsh and browsr as examples of things people put behind an entrypoint inside an xxh shell. Pinned prerun plugins take this further by running before the shell starts: the core plugin carries xxh-sudo, xxh-screen and xxh-tmux, and a dotfiles plugin sits beside it, both described as the way to bring portable tools, dotfiles or aliases into a session. The deliberate refusal is on the configuration side. xxh does not copy config files blindly from a local machine to the host. You get repeatability by forking a plugin or the shell example and packing your own configuration into that fork.

Switching shells is a flag, and it starts from the host name

Choosing a shell at session time is the shortest command in the project. You name the host and add the shell with `+s`, which is how the same launcher serves a Python environment through xonsh, plain querying through osquery, and fish, zsh or bash depending on the task in front of you. Below the launcher sit two dependencies, pexpect and pyyaml. That short dependency list is also the honest limit of the design, since the transport assumptions are tied to the ssh session it opens and to the shell it hands control to.

Editorial conclusion

xxh earns its place when you open many ssh sessions and want the same aliases, plugins and prompt on each one without touching the host. It is the wrong tool for a macOS or Windows target, for ARM hardware you cannot build yourself, or for a fish user who needs the seamless entrypoint, since that file is still an open todo. Before adopting it, check the shell table for your shell's status, confirm your host is Linux on x86_64, and read the version pinned into any download command you copy, because the two published commands still point at 0.8.12 while 0.8.16 is the newest release.

Frequently asked questions

Is xxs the same as xxh?

There is no component named xxs in the xxh repository. The distribution is published as xxh-xxh on PyPI, pipx and conda-forge, and as xxh on Homebrew and Macports, while the shell packages live in separate xxh-shell repositories.

How does XXH work?

You build the portable shell and its plugins on your own machine, then xxh uploads the result to the target host, where nothing is installed and no root access is needed. The session home is the .xxh directory by default, and deleting it leaves the host as if xxh had never run.

What is Xxh?

xxh is a Python program that carries your shell across an ssh session to a Linux x86_64 host. xonsh, zsh, fish and bash are marked stable, osquery is beta, and fish-appimage and elvish are alpha. The newest release listed is 0.8.16 from 2026-04-06.

Official sources

  1. Issues
  2. License: BSD-2-Clause
  3. README
  4. Releases
  5. xxh/xxh on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/xxh-xxh.svg)](https://hysenlabs.com/projects/xxh-xxh)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/xxh-xxh.svg)](https://hysenlabs.com/projects/xxh-xxh)

Was this useful?