.github | ||
xonssh_xxh | ||
.gitignore | ||
__init__.py | ||
LICENSE | ||
README.md | ||
setup.py | ||
xxh |
You chosen a favorite command shell and spend hours to adjust it, to stuff it with aliases, shortcuts and colors. But when you move from local to remote host using ssh you lose it all. The mission of xxh is to allow you to use your favorite shell with your aliases, shortcuts and color theme wherever you go through the ssh.
Install or update
python3 -m pip install --upgrade xonssh-xxh
After install you can just using xxh
command as replace ssh
to connecting to the host because xxh
has seamless support of basic ssh
command arguments.
Usage
$ ./xxh -h
usage: xxh <host from ~/.ssh/config>
usage: xxh [ssh arguments] [user@]host[:port] [xxh arguments]
usage: xxh [-h] [-V] [-p SSH_PORT] [-l SSH_LOGIN] [-i SSH_PRIVATE_KEY] [-o SSH_OPTION -o ...]
[user@]host[:port]
[+i] [+if] [+P PASSWORD] [+PP]
[+lxh LOCAL_XXH_HOME] [+hxh HOST_XXH_HOME] [+he HOST_EXECUTE_FILE]
[+m METHOD] [+v] [+vv]
The xxh is for using the xonsh shell wherever you go through the ssh.
____ __________ @ @
______ / \ \__/
____ / ______ \ / \ contribution
_____ / / __ \ \ / _/ https://github.com/xxh/xxh
___ ( / / / \ \ /
\ \___/ / / / plugins
____\ /__/ / https://github.com/search?q=xxh-plugin
/ \________/ /
/____________________/
Supported shells
Currently supported Python-powered xonsh shell.
Experimental: to use another shell you can create your xxh-shell
entrypoint like in xxh-shell-xonsh-appimage and add +s
argument to your xxh
command.
Plugins
xxh plugin is the set of xsh scripts which will be run when you'll use xxh. You can create xxh plugin with your lovely aliases, tools or color theme and xxh will bring them to your ssh sessions.
🔎 Search xxh plugins on Github or Bitbucket or 💡 Create xxh plugin
Notes
How it works?
When you run xxh myhost
command xxh download portable xonsh and store locally to future use. Then if it needed xxh upload the portable xonsh, init scripts and plugins to the host. Finally xxh make ssh connection to the host and run portable xonsh shell without any system installs and affection on the target host.
Development
🛠️ In the xxh-dev repo there is full dockerised environment for development, testing and contribution. The process of testing and development is orchestrated by xde
tool and as easy as possible.
Spread the word
If you like the idea of xxh help spread the word about xxh! Click ⭐ on the repo and tweet the link!
Thanks
- @scopatz for https://github.com/xonsh/xonsh
- @probonopd for https://github.com/AppImage
- @niess for https://github.com/niess/linuxdeploy-plugin-python/
- @gforsyth for https://github.com/xonsh/xonsh/issues/3374