Mirrors/xxh
2
0
Fork 0
mirror of https://github.com/xxh/xxh synced 2025-02-17 04:48:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
anki-code 2020-02-29 22:20:22 +03:00 • committed by GitHub
parent 092433d189
commit f90ec9ccd5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -14,7 +14,7 @@ Help spread the word about xxh! Click ⭐ on the repo and <a href="https://twitt
```
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.
🧩 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
```
@ -91,31 +91,15 @@ xxh arguments:
### Using pip and python
The xxh xonsh will use pip and python from `xonsh.AppImage` by default. You can update pip and install packages ordinally:
```
$ pip install --upgrade pip
$ pip install --upgrade pandas
```
The packages will appear in `~/.xxh/pip` by default.
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.
### Install [xontribs](https://xon.sh/xontribs.html)
To install [xontribs](https://xon.sh/xontribs.html) in xxh session use `xontrib-install`:
```
xontrib-install xontrib-autojump
xontrib load autojump
```
Don't use `pip` or `xpip` to install xontribs! ([details](https://github.com/xonsh/xonsh/issues/3463))
To install [xontribs](https://xon.sh/xontribs.html) in xxh session use `xontrib-install <package>`. Never use `pip` or `xpip` to install xontribs! ([details](https://github.com/xonsh/xonsh/issues/3463))
### How it works?
When you run `xxh <host>` command:
1. If it needed xxh will download portable xonsh shell and store locally to future use.
2. If it needed xxh will upload the portable xonsh, init scripts and plugins to the host.
3. Finally xxh will make ssh connection to the server and run portable xonsh shell without any system installs and affection on the target host.
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](https://github.com/xonssh/xxh-dev) repo there is full [docker](https://www.docker.com/)ised environment for development, testing and contribution. The process of testing and development is orchestrated by `xde` tool and as easy as possible.