xxh/README.md
2020-02-14 00:05:13 +03:00

5.5 KiB


xxh is for using xonsh shell wherever you go through the ssh.


(in the demo is used xxh-plugin-theme-bar)


PyPI - License

Installation

pip install xonssh-xxh

Then try:

xxh <[user@]host[:port] or servername from ~/.ssh/config>

Usage

$ xxh --help                                                                                                                                            
usage: xxh [user@]host[:port]

usage: xxh [ssh arguments] destination [xxh arguments]

usage: xxh [-h] [-V] [-p SSH_PORT] [-l SSH_LOGIN] [-i SSH_IDENTITY_FILE] [-o SSH_OPTIONS] 
           [destination]
           [+i] [+if] [+lxh LOCAL_XXH_HOME] [+hxh HOST_XXH_HOME] [+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:
  destination           Destination may be specified as [user@]hostname[:port] or server name from ~/.ssh/config

common arguments:
  -h, --help            show this help message and exit
  -V, --version         Show xxh version

ssh arguments:
  -p SSH_PORT           Port to connect to on the remote host.
  -l SSH_LOGIN_NAME     Specifies the user to log in as on the remote machine.
  -i SSH_IDENTITY_FILE  Selects a file from which the identity (private key) for public key authentication is read.
  -o SSH_OPTIONS        Options in the ssh configuration format. See ssh man page. Example: xxh -o Port=22 -o User=snail host

xxh arguments:
  +i, ++install         Install xxh to destination host.
  +if, ++install-force  Delete remote xxh home and install xonsh to destination host.
  +lxh LOCAL_XXH_HOME, ++local-xxh-home LOCAL_XXH_HOME
                        Local xxh home path. Default: ~/.xxh
  +hxh HOST_XXH_HOME, ++host-xxh-home HOST_XXH_HOME
                        Host xxh home path. Default: ~/.xxh
  +m METHOD, ++method METHOD
                        Portable method: appimage
  +v, ++verbose         Verbose mode.
  +vv, ++vverbose       Super verbose mode.

Plugins

Search xxh plugins on Github or create plugin with your own lovely functions.

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 install pip packages ordinally with pip install. They will appear in $XXH_HOME/pip.

How it works?

When you run xxh <server> command:

  1. If it needed xxh script will download xonsh.AppImage. This is portable version of xonsh. URL you can find in xxh.xsh

  2. If it needed xxh script copies the portable xonsh on the host (~/.xxh by default) along with init scripts and plugins.

  3. Finally xxh makes ssh connection to server and running remote portable xonsh shell without any affection on the target system.

Development

Use xxh-tests environment for development and contribution.

What will make xxh more universal and stable in the future:

Known Issues

GLIBs versions

Current method to make xonsh portable is using an AppImage which was built on manylinux2010 (PEP 571). 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.

WSL1: ^Z

# xxh YT-1300
^Z
Unknown answer from server when checking direcotry /home/hansolo/.xxh:

This issue was addressed to Xonsh team in 3367. Just try to run command again.

WSL2 is not tested yet.

Thanks