2019-11-03 14:58:29 +00:00
< p align = "center" >
< p align = "center" >
2020-02-17 11:50:27 +00:00
< b > xxh< / b > is for using Python-powered < a href = "https://xon.sh/" > xonsh shell< / a > wherever you go through the ssh.
2019-11-03 14:58:29 +00:00
< / p >
< / p >
2020-02-08 23:03:26 +00:00
< p align = "center" >
< a href = "https://pypi.org/project/xonssh-xxh/" target = "_blank" alt = "PyPI Latest Release" > < img src = "https://img.shields.io/pypi/v/xonssh-xxh.svg" > < / a >
2020-02-17 12:02:25 +00:00
< a href = "https://asciinema.org/a/osSEzqnmH9pMYEZibNe2K7ZL7" target = "_blank" > < img alt = "asciinema demo" src = "https://img.shields.io/badge/demo-asciinema-grass" > < / a >
2020-02-21 22:45:29 +00:00
< a href = "https://gitter.im/xonssh-xxh/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge" target = "_blank" > < img alt = "Chat on Gitter" src = "https://badges.gitter.im/xonssh-xxh/community.svg" > < / a >
2020-02-17 12:02:25 +00:00
< img alt = "PyPI - License" src = "https://img.shields.io/pypi/l/xonssh-xxh" >
2020-02-08 23:03:26 +00:00
< / p >
2020-02-19 15:33:33 +00:00
< p align = "center" >
2020-02-22 11:33:15 +00:00
Help spread the word about xxh! Click ⭐ on the repo and < a href = "https://twitter.com/intent/tweet?text=Python-powered%20shell%20wherever%20you%20go%20through%20the%20ssh&url=https%3A%2F%2Fgithub.com%2Fxonssh%2Fxxh&related=" target = "_blank" > tweet the link< / a > !
2020-02-19 15:33:03 +00:00
< / p >
2019-11-03 15:13:42 +00:00
2019-11-03 14:34:38 +00:00
## Installation
```
2020-02-19 15:02:30 +00:00
python3 -m pip install --upgrade xonssh-xxh
2019-11-04 08:58:11 +00:00
```
2020-02-21 22:23:09 +00:00
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.
2019-11-03 14:34:38 +00:00
## Usage
```
2020-02-21 20:00:00 +00:00
$ xxh --help
usage: xxh [config name from ssh config]
2020-02-13 22:28:27 +00:00
usage: xxh [ssh arguments] [user@]host[:port] [xxh arguments]
2020-02-11 19:27:54 +00:00
2020-02-13 22:28:27 +00:00
usage: xxh [-h] [-V] [-p SSH_PORT] [-l SSH_LOGIN] [-i SSH_PRIVATE_KEY] [-o SSH_OPTION -o ...]
[user@]host[:port]
2020-02-14 21:35:48 +00:00
[+i] [+if] [+lxh LOCAL_XXH_HOME] [+hxh HOST_XXH_HOME] [+he HOST_EXECUTE_FILE]
[+m METHOD] [+v] [+vv]
2020-02-08 22:01:50 +00:00
The xxh is for using the xonsh shell wherever you go through the ssh.
2020-02-13 21:16:31 +00:00
____ __________ @ @
______ / \ \__/
____ / ______ \ / \ contribution
_____ / / __ \ \ / _/ https://github.com/xonssh/xxh
___ ( / / / \ \ /
2020-02-11 19:27:54 +00:00
\ \___/ / / / plugins
2020-02-13 22:28:27 +00:00
___\ /__ / / https://github.com/search?q=xxh-plugin
/ \________/ /
/___________________/
2019-11-03 14:34:38 +00:00
2020-02-11 19:27:54 +00:00
required arguments:
2020-02-13 22:28:27 +00:00
[user@]host[:port] Destination may be specified as [user@]host[:port] or server name from ~/.ssh/config
2019-11-03 14:34:38 +00:00
2020-02-11 19:27:54 +00:00
common arguments:
2019-11-03 14:34:38 +00:00
-h, --help show this help message and exit
2020-02-13 22:28:27 +00:00
--version, -V show program's version number and exit
2020-02-11 19:27:54 +00:00
ssh arguments:
-p SSH_PORT Port to connect to on the remote host.
2020-02-13 21:16:31 +00:00
-l SSH_LOGIN Specifies the user to log in as on the remote machine.
2020-02-13 22:28:27 +00:00
-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
2020-02-11 19:27:54 +00:00
xxh arguments:
2020-02-11 20:34:48 +00:00
+i, ++install Install xxh to destination host.
2020-02-14 21:35:48 +00:00
+if, ++install-force Removing the host xxh home and install xxh again.
+lh LOCAL_XXH_HOME, ++local-xxh-home LOCAL_XXH_HOME
2020-02-08 23:41:53 +00:00
Local xxh home path. Default: ~/.xxh
2020-02-14 21:35:48 +00:00
+hh HOST_XXH_HOME, ++host-xxh-home HOST_XXH_HOME
2020-02-13 20:19:48 +00:00
Host xxh home path. Default: ~/.xxh
2020-02-14 21:35:48 +00:00
+he HOST_EXECUTE_FILE, ++host-execute-file HOST_EXECUTE_FILE
Execute script file placed on host and exit
2020-02-11 19:27:54 +00:00
+m METHOD, ++method METHOD
2020-02-13 20:19:48 +00:00
Portable method: appimage
2020-02-11 19:27:54 +00:00
+v, ++verbose Verbose mode.
2020-02-13 20:19:48 +00:00
+vv, ++vverbose Super verbose mode.
2019-11-03 14:34:38 +00:00
```
## Plugins
2020-02-16 17:42:27 +00:00
**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.
2020-02-16 17:17:07 +00:00
🔎 [Search xxh plugins on Github ](https://github.com/search?q=xxh-plugin&type=Repositories )
2020-02-17 12:07:16 +00:00
💡 [Create xxh plugin ](https://github.com/xonssh/xxh-plugin-sample )
2019-11-03 14:34:38 +00:00
2020-02-16 17:42:27 +00:00
📌 Pinned plugins:
2020-02-08 23:32:13 +00:00
* [Pipe Liner ](https://github.com/xonssh/xxh-plugin-pipe-liner ) — processing the lines easy with python and classic shell pipes
* [Bar Theme ](https://github.com/xonssh/xxh-plugin-theme-bar ) — theme to stay focused
* [Autojump ](https://github.com/xonssh/xxh-plugin-autojump ) — save time on moving thru directories
2019-11-03 14:34:38 +00:00
## Notes
### Using pip and python
2020-02-22 07:41:49 +00:00
The xxh xonsh will use pip and python from `xonsh.AppImage` by default. You can update pip and install packages ordinally:
```
2020-02-22 16:37:31 +00:00
$ python3 -m pip install --upgrade pip # or: xpip install --upgrade pip
$ python3 -m pip install --upgrade pandas # or: xpip install --upgrade pandas
2020-02-22 07:41:49 +00:00
```
The packages will appear in `$XXH_HOME/pip` (`~/.xxh/pip` by default).
2019-11-03 14:34:38 +00:00
2020-02-16 21:05:39 +00:00
### How it works?
2019-11-03 14:34:38 +00:00
2020-02-17 09:23:42 +00:00
When you run `xxh <host>` command:
2019-11-03 14:34:38 +00:00
2020-02-17 09:23:42 +00:00
1. If it needed xxh will download portable xonsh shell and store locally to future use.
2019-11-03 14:34:38 +00:00
2020-02-17 09:23:42 +00:00
2. If it needed xxh upload the portable xonsh to the host (`~/.xxh` by default) along with init scripts and plugins.
2019-11-03 14:34:38 +00:00
2020-02-21 22:23:09 +00:00
3. Finally xxh will make ssh connection to the server and run portable xonsh shell without any addition installs and affection on the target host.
2019-11-03 15:22:54 +00:00
2020-02-12 14:08:21 +00:00
## Development
2020-02-22 18:59:21 +00:00
🛠️ Use [xxh-dev ](https://github.com/xonssh/xxh-dev ) environment for development, testing and contribution.
2020-02-13 10:22:57 +00:00
2020-02-16 21:05:39 +00:00
### Known Issues
2019-11-04 09:05:04 +00:00
2020-02-22 10:22:38 +00:00
##### Sometimes xontribs or pip packages not found after install sometimes
2020-02-22 10:21:53 +00:00
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'])` .
2020-02-22 10:22:38 +00:00
##### GLIBs versions
2019-11-04 09:05:04 +00:00
Current method to make xonsh portable is using an [AppImage ](https://appimage.org/ ) which was built on [manylinux2010 (PEP 571) ](https://github.com/niess/linuxdeploy-plugin-python/issues/12 ). In case you see the error like ``/xonsh-x86_64.AppImage: /lib/x86_64-linux-gnu/libc.so.6: version GLIBC_2.25 not found (required by /ppp/xonsh-x86_64.AppImage)`` this means you should rebuild the AppImage for older version of linux distributive. Try [linuxdeploy-plugin-python ](https://github.com/niess/linuxdeploy-plugin-python/ ).
2020-02-22 10:22:38 +00:00
##### Related issues
2020-02-13 21:30:03 +00:00
What will make xxh more universal and stable in the future:
* [AppImages run on Alpine ](https://github.com/AppImage/AppImageKit/issues/1015 )
* [Fix xonsh for WSL1 ](https://github.com/xonsh/xonsh/issues/3367 )
2020-02-22 16:37:31 +00:00
* [Captured subprocess attributes not queryable until result is evaluated ](https://github.com/xonsh/xonsh/issues/3394 )
2020-02-13 21:30:03 +00:00
2020-02-09 09:10:08 +00:00
## 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
