Mirrors/xxh
2
0
Fork 0
mirror of https://github.com/xxh/xxh synced 2024-11-23 20:33:08 +00:00
Code Issues Projects Releases Packages Wiki Activity
xxh/README.md
anki-code c17d0c30c6
Update README.md
2020-02-29 19:51:21 +03:00

6.2 KiB
Raw Blame History

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. We use Python-powered xonsh shell.

asciinema demo asciinema demo Chat on Gitter PyPI - License

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.

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

💡 Create xxh plugin

📌 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.

Install xontribs

To install xontribs in xxh session use xontrib-install:

xontrib-install xontrib-autojump
xontrib load autojump

Don't use pip or xpip to install xontribs! (details)

How it works?

When you run xxh <host> command:

  1. If it needed xxh will download portable xonsh shell and store locally to future use.

  2. If it needed xxh will upload the portable xonsh, init scripts and plugins to the host.

  3. 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

🛠️ 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.

Thanks