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 c1d3e3a203 rename plugin repos
2020-03-04 17:21:02 +03:00

4.7 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

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/xxh/xxh   
   ___ (    / /  /   \  \   /          
        \   \___/    /  /  /                plugins            
     ____\          /__/  /   https://github.com/search?q=xxh-plugin
    /     \________/     /                           
   /____________________/

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

💡 Create xxh plugin

📌 xxh-plugin-xonsh-pipe-liner — processing the lines easy with python and classic shell pipes

📌 xxh-plugin-xonsh-theme-bar — theme to stay focused

📌 xxh-plugin-xonsh-autojump — save time on moving thru directories

Notes

Using python, pip and xontribs

The xxh is using pip and python from xonsh.AppImage by default. You can update pip (pip install --upgrade pip) and install packages ordinally: pip install --upgrade pandas. The packages will appear in host xxh home ~/.xxh/pip by default.

To install xontribs in xxh session use xpip install <package>. Never use pip to install xontribs (details).

How it works?

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

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