xxh/README.plugins.md
2020-02-09 02:13:03 +03:00

29 lines
984 B
Markdown

**xxh plugin** — is the set of files which will be run when xonsh will be installed or started though xxh.
## xxh plugins list
[Search xxh plugins on Github](https://github.com/search?q=xxh-plugin&type=Repositories)
Pinned plugins:
* [Pipe Liner](https://github.com/xonssh/xxh-plugin-pipe-liner)
* [Bar Theme](https://github.com/xonssh/xxh-plugin-theme-bar)
* [Autojump](https://github.com/xonssh/xxh-plugin-autojump)
## Install xxh plugin
To install xxh plugin just place the plugin directory to the `plugins` in xxh home path. Example:
```
cd ~/.xxh/plugins/
git clone --depth 1 https://github.com/xonssh/xxh-plugin-theme-bar
```
Then run:
```
xxh <server>
```
## Create xxh plugin
To create xxh plugin you can create `your_plugin` directory in `~/.xxh/plugins/your_plugin` (by default) on your home host with files:
* `install.xsh` will be executed once after xxh installation on the host
* `xonshrc.xsh` will be executed every time you'll be connect via xxh to the host