xxh/README.plugins.md

30 lines
984 B
Markdown
Raw Normal View History

2019-11-04 12:01:16 +03:00
**xxh plugin** — is the set of files which will be run when xonsh will be installed or started though xxh.
2019-11-03 16:06:26 +03:00
2019-11-04 13:48:32 +03:00
## xxh plugins list
2020-02-09 02:11:23 +03:00
[Search xxh plugins on Github](https://github.com/search?q=xxh-plugin&type=Repositories)
2020-02-09 00:57:47 +03:00
Pinned plugins:
2019-11-04 13:48:32 +03:00
* [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)
2019-11-03 16:06:26 +03:00
## Install xxh plugin
2020-02-09 02:11:58 +03:00
To install xxh plugin just place the plugin directory to the `plugins` in xxh home path. Example:
2019-11-04 12:00:55 +03:00
```
2019-11-03 16:06:26 +03:00
cd ~/.xxh/plugins/
git clone --depth 1 https://github.com/xonssh/xxh-plugin-theme-bar
2019-11-04 12:11:05 +03:00
```
Then run:
```
xxh <server>
2019-11-03 16:06:26 +03:00
```
2019-11-03 18:06:16 +03:00
## Create xxh plugin
2020-02-09 02:13:03 +03:00
To create xxh plugin you can create `your_plugin` directory in `~/.xxh/plugins/your_plugin` (by default) on your home host with files:
2019-11-03 18:06:16 +03:00
* `install.xsh` will be executed once after xxh installation on the host
2019-11-03 19:38:42 +03:00
* `xonshrc.xsh` will be executed every time you'll be connect via xxh to the host