Mirrors/xxh
2
0
Fork 0
mirror of https://github.com/xxh/xxh synced 2024-12-17 23:33:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
xxh/README.md
anki-code 5423c24d51
Update README.md
2020-03-07 11:14:28 +03:00

4.4 KiB
Raw Blame History

You chosen a favorite command shell and spent hours to adjust it, to stuffed 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 bring your favorite shell with your aliases, shortcuts and color theme wherever you go through the ssh.

[release] [asciinema demo] [plugins] [gitter chat] [BSD license]

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] [+iff] [+xc XXH_CONFIG] [+P PASSWORD] [+PP] [+lh LOCAL_XXH_HOME] 
           [+hh HOST_XXH_HOME] [+he HOST_EXECUTE_FILE] [+s SHELL] [+v] [+vv]

Your favorite shell wherever you go through the ssh. 

     ____  __________     @    @    
  ______  /          \     \__/     
   ____  /    ______  \   /   \           contribution
 _____  /    / __   \  \ /   _/   https://github.com/xxh/xxh   
   ___ (    / /  /   \  \   /          
        \   \___/    /  /  /                plugins            
     ____\          /__/  /   https://github.com/search?q=xxh-plugin
    /     \________/     /                           
   /____________________/

Supported shells

🐚 Xonsh shell — used by default.

🐟 Fish shell — in testing, help wanted.

💤 Zsh shell — waiting portable build, help wanted.

🔎 Search xxh shell on Github or Bitbucket.

💡 Create your shell entrypoint to use another portable shell. You can also just create portable entrypoint for bash shell with your lovely aliases, shortcuts and themes.

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 shell and store locally to future use. Then if it needed xxh upload the portable shell, init scripts and plugins to the host. Finally xxh make ssh connection to the host and run portable 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