6.7 KiB
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! What a hell! 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. We started from Python-powered xonsh shell.
Help spread the word about xxh! Click ⭐ on the repo and tweet the link!
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.
🗝️ The best if you're using ssh config with private keys to authorization. In case of using password to avoid password typing many times use +PP or +P pwd options.
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/xonssh/xxh
___ ( / / / \ \ /
\ \___/ / / / plugins
____\ /__/ / https://github.com/search?q=xxh-plugin
/ \________/ /
/____________________/
required arguments:
[user@]host[:port] Destination may be specified as [user@]host[:port] or host from ~/.ssh/config
common arguments:
-h, --help show this help message and exit
--version, -V show program's version number and exit
ssh arguments:
-p SSH_PORT Port to connect to on the remote host.
-l SSH_LOGIN Specifies the user to log in as on the remote machine.
-i SSH_PRIVATE_KEY File from which the identity (private key) for public key authentication is read.
-o SSH_OPTION -o ... SSH options are described in ssh man page. Example: -o Port=22 -o User=snail
xxh arguments:
+i, ++install Install xxh to destination host.
+if, ++install-force Removing the host xxh home and install xxh again.
+P PASSWORD, ++password PASSWORD
Password for ssh auth.
+PP, ++password-prompt
Enter password manually using prompt.
+lh LOCAL_XXH_HOME, ++local-xxh-home LOCAL_XXH_HOME
Local xxh home path. Default: ~/.xxh
+hh HOST_XXH_HOME, ++host-xxh-home HOST_XXH_HOME
Host xxh home path. Default: ~/.xxh
+he HOST_EXECUTE_FILE, ++host-execute-file HOST_EXECUTE_FILE
Execute script file placed on host and exit.
+m METHOD, ++method METHOD
Portable method: appimage
+v, ++verbose Verbose mode.
+vv, ++vverbose Super verbose mode.
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
📌 Pinned plugins:
- Pipe Liner — processing the lines easy with python and classic shell pipes
- Bar Theme — theme to stay focused
- Autojump — save time on moving thru directories
Notes
Using pip and python
The xxh xonsh will use pip and python from xonsh.AppImage by default. You can update pip and install packages ordinally:
$ pip install --upgrade pip
$ pip install --upgrade pandas
The packages will appear in ~/.xxh/pip by default.
How it works?
When you run xxh <host> command:
-
If it needed xxh will download portable xonsh shell and store locally to future use.
-
If it needed xxh will upload the portable xonsh, init scripts and plugins to the host.
-
Finally xxh will make ssh connection to the server and run portable xonsh shell without any system installs and affection on the target host.
Development
🛠️ Use xxh-dev environment for development, testing and contribution.
Known Issues
Sometimes xontribs or pip packages not found after install
If an xontrib or pip package is not found immediately after install you can do reconnect. Xontribs could be reloaded manually without reconnect by executing import importlib; importlib.reload(sys.modules['xontrib']).
Related issues
What will make xxh more universal and stable in the future:
- AppImages run on Alpine
- Fix xonsh for WSL1
- Captured subprocess attributes not queryable until result is evaluated
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