Mirrors/xxh
2
0
Fork 0
mirror of https://github.com/xxh/xxh synced 2024-11-23 12:23:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

README

Browse source
This commit is contained in:
anki-code 2020-04-22 09:57:40 +03:00
parent 1b41647232
commit 8d00fae59e
1 changed files with 5 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -6,6 +6,11 @@ If you like the idea of xxh click ⭐ on the repo and stay tuned.
<a href='https://github.com/xxh/xxh#installation-methods'><img alt='[xxh demo]' src='https://raw.githubusercontent.com/xxh/static/master/xxh-demo2.gif'></a>
| | | |
| --- | --- | --- |
| **Portable**. Preparing portable shells and plugins occurs locally and then xxh uploads the result to host. No installations or root access on the host required. The security and careful about environment on the host are behind it. | **Hermetic**. If you delete `~/.xxh` directory from the remote host then xxh has never been on the host. By default your home is `.xxh` directory and you can [choose the hermetic level of your xxh session](https://github.com/xxh/xxh/wiki#how-to-set-homeuser-as-home-on-host). | **Careful**. No blindfold copying config files from local to remote host. Following the privacy and repeatability reasons the better way is to fork the xxh plugin or shell example and pack your configs to it. |
| **Be open and fork-ready**. Every xxh repo could be forked, customized and reused without waiting for package management system, xxh releases or any third party. Currently supported five shells and the count could be increased by community. | **Do more**. The xxh packages are not only about shells. Any type of tool or code could be behind entrypoint. If you want to play Super Mario on the remote host just put it as entrypoint in xxh-shell. | **Chameleon**. Switching the shells as easy as possible and not really needed to use only one shell. Choose you current shell along with task you want to solve: `xxh myhost +s xonsh` for python environment, `osquery` for simple querying, `fish` for modern features or time-tasted `zsh` and `bash`. |
## Installation methods
#### [PyPi 3](https://pypi.org/project/xxh-xxh/)
```shell script
@ -86,22 +91,6 @@ xxh +I xxh-shell-example+git+https://github.com/xxh/xxh-shell-example/tree/mybra
xxh +I xxh-shell-example+path+/home/user/my-xxh-dev/xxh-shell-example # install from local path
```
## The ideas behind xxh
**Portable**. Preparing portable shells and plugins occurs locally and then xxh uploads the result to host.
No installations or root access on the host required. The security and careful about environment on the host are behind it.
**Careful**. No blindfold copying config files from local to remote host. Following the privacy and repeatability
reasons the better way is to fork the xxh plugin or shell example and pack your config to it.
**Hermetic**. If you delete `~/.xxh` directory from the remote host then xxh has never been on the host. By default your
home is `.xxh` directory and you can [choose the hermetic level of your xxh session](https://github.com/xxh/xxh/wiki#how-to-set-homeuser-as-home-on-host).
**Be open and fork-ready**. Every repo could be forked, customized and reused without waiting for package management system,
xxh releases or any third party. Currently supported five shells and the count could be grow by community.
**Do more**. The xxh packages are not only about shells. Any type of tool or code could be behind entrypoint.
If you want to play Super Mario on the remote host just put it as entrypoint.
## Examples of use cases
### Python with pip everywhere without installation
#### Way 1. Using xonsh