From 6b32aea2c12238587ea27cf0f80b7d8f5cc274e4 Mon Sep 17 00:00:00 2001 From: Jim Tittsler Date: Wed, 22 Feb 2023 14:26:01 +0900 Subject: [PATCH] Fix typos Grammatical suggestions --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 78417e0..f92bbf3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -

You stuffed command shell with aliases, tools and colors but you lose it all when using ssh. The mission of xxh is to bring your favorite shell wherever you go through ssh without root access and system installations.

+

You stuffed your command shell with aliases, tools, and colors but you lose it all when using ssh. The mission of xxh is to bring your favorite shell wherever you go through ssh without root access or system installations.

-If you like the idea of xxh click ⭐ on the repo and tweet. +If you like the idea of xxh click ⭐ on the repo and tweet about it.

[xxh demo] @@ -12,14 +12,14 @@ If you like the idea of xxh click ⭐ on the repo and -Portable. Preparing portable shells and plugins occurs locally and then xxh uploads the result to the host. No installations or root access on the host required. Security and host environment a prime focus. -Hermetic. Deleting ~/.xxh directory from the remote host will make the remote environment function as if xxh was never there. By default your home is the .xxh directory and you can choose the hermetic level of your xxh session. -Careful. No blindfold copying config files from local to remote host. Following privacy and repeatability practices the best way is to fork the xxh plugin or shell example and pack your configs into it. +Portable. Preparing portable shells and plugins occurs locally, and then xxh uploads the result to the host. No installations or root access on the host required. Security and host environment are a prime focus. +Hermetic. Deleting the ~/.xxh directory from the remote host will make the remote environment function as if xxh was never there. By default your home is the .xxh directory and you can choose the hermetic level of your xxh session. +Careful. No blindfolded copying config files from local to remote host. Following privacy and repeatability practices, the best way is to fork the xxh plugin or shell example and pack your configs into it. -Be open and fork-ready. Every xxh repo could be forked, customized and reused without waiting for a package management system, xxh release or any third party packages. Five shells are currently supported and more could be added by the community. +Be open and fork-ready. Every xxh repo could be forked, customized, and reused without waiting for a package management system, xxh release, or any third party packages. Five shells are currently supported and more could be added by the community. Do more. The xxh packages are not only about shells. Any type of tool or code could be behind an entrypoint. If you want to run browsh on the remote host, just put its portable version as an entrypoint in the xxh-shell. -Chameleon. Switching the shells is as easy as possible and you don't have to be locked in to one shell. Choose your current shell based on the task you want to solve: xxh anyhost +s xonsh for a python environment, osquery for simple querying, fish for modern features or time-tested zsh and bash for speed. +Chameleon. Switching shells is as easy as possible and you don't have to be locked in to one shell. Choose your current shell based on the task you want to solve: xxh anyhost +s xonsh for a Python environment, osquery for simple querying, fish for modern features or time-tested zsh and bash for speed. @@ -69,7 +69,7 @@ To run AppImage on Alpine Linux [install](https://github.com/sgerrand/alpine-pkg ## Shells -Currently supported OS for target host is Linux on x86_64. +Currently supported OS for the target host is Linux on x86_64. | xxh-shell | status | [xxh-plugins](https://github.com/xxh/xxh/wiki#plugins) | [seamless](https://github.com/xxh/xxh/wiki#seamless-mode) | demo | |-----------------------------------------------------------------------|------------|-------------|---------|------| @@ -84,9 +84,9 @@ Currently supported OS for target host is Linux on x86_64. [Search xxh shell on Github](https://github.com/search?q=xxh-shell&type=Repositories) or [Bitbucket](https://bitbucket.org/repo/all?name=xxh-shell) or [create your shell entrypoint](https://github.com/xxh/xxh-shell-example) to use another portable shell. ### Prerun plugins -[Prerun plugins](https://github.com/xxh/xxh/wiki#plugins) allow you to bring any portable tools, dotfiles or aliases to xxh session before running shell. +[Prerun plugins](https://github.com/xxh/xxh/wiki#plugins) allow you to bring any portable tools, dotfiles, or aliases to your xxh session before running the shell. -Pinned plugins: **[core](https://github.com/xxh/xxh-plugin-prerun-core)** (xxh-sudo, xxh-screen, xxh-tmux), **[dotfiles](https://github.com/xxh/xxh-plugin-prerun-dotfiles)**, **[docker](https://github.com/xxh/xxh-plugin-prerun-docker)**, **[python](https://github.com/xxh/xxh-plugin-prerun-python)**, **[xxh](https://github.com/xxh/xxh-plugin-prerun-xxh)**, **[vim](https://github.com/xxh/xxh-plugin-prerun-vim)**, **[zoxide](https://github.com/xxh/xxh-plugin-prerun-zoxide)**, **[starship](https://github.com/izissise/xxh-plugin-prerun-starship)**. There is [cookiecutter template to create prerun plugin](https://github.com/xxh/cookiecutter-xxh-plugin-prerun). +Pinned plugins: **[core](https://github.com/xxh/xxh-plugin-prerun-core)** (xxh-sudo, xxh-screen, xxh-tmux), **[dotfiles](https://github.com/xxh/xxh-plugin-prerun-dotfiles)**, **[docker](https://github.com/xxh/xxh-plugin-prerun-docker)**, **[python](https://github.com/xxh/xxh-plugin-prerun-python)**, **[xxh](https://github.com/xxh/xxh-plugin-prerun-xxh)**, **[vim](https://github.com/xxh/xxh-plugin-prerun-vim)**, **[zoxide](https://github.com/xxh/xxh-plugin-prerun-zoxide)**, **[starship](https://github.com/izissise/xxh-plugin-prerun-starship)**. There is [cookiecutter template to create a prerun plugin](https://github.com/xxh/cookiecutter-xxh-plugin-prerun). ## Usage Use `xxh` instead of `ssh` when connecting to Linux hosts without changing ssh arguments: @@ -109,9 +109,9 @@ xxh anyhost +hh /tmp/xxh +hhr # Upload xxh to /tmp/xxh and r source xxh.zsh anyhost +I xxh-plugin-zsh-ohmyzsh # Connect in seamless mode with ohmyzsh plugin xxh local +s xonsh # Experimental: build xxh environment inplace and without ssh ``` -For reusing arguments and simplifying xxh usage (like shortening to `xxh anyhost`) there is a [config file](https://github.com/xxh/xxh/wiki#config-file). +For reusing arguments and simplifying xxh usage (like shortening to `xxh anyhost`), there is a [config file](https://github.com/xxh/xxh/wiki#config-file). -**Why the plus sign for the xxh arguments?** The xxh is using the plus sign for the xxh arguments to save the ability to use the minus sign for the original ssh arguments. This allows just replace the first two letters in the `ssh` command to convert it to the `xxh` command. Also see the [discussion](https://github.com/xxh/xxh/issues/129). +**Why the plus sign for the xxh arguments?** The xxh is using the plus sign for xxh arguments to preserve the ability to use the minus sign for the original ssh arguments. This allows just replacing the first two letters in the `ssh` command to convert it to the `xxh` command. Also see the [discussion](https://github.com/xxh/xxh/issues/129). ### Installing xxh packages ```bash @@ -133,7 +133,7 @@ xxh +I xxh-shell-example+path+/home/user/my-xxh-dev/xxh-shell-example This is experimental magic. Please read the text below twice. If you have shell access on the host or you're in a docker container and you can't ssh to it -then you can download and build hermetic xxh environment inplace. The `xxh local` command works +then you can download and build a hermetic xxh environment inplace. The `xxh local` command works exactly like `xxh remote_host` and creates a hermetic environment in `~/.xxh` by default. At this time we don't have portable build tools like `git`, `wget`, `curl`, `tar` and others which @@ -147,7 +147,7 @@ XH=~/.xxh \ && ( [[ -x $(command -v curl) ]] && curl -L $XD || wget -O- $XD ) | tar zxf - xxh \ && echo 'Usage: ./xxh local [+s xonsh/zsh/fish/osquery/bash]' ``` -Next time you're on host just run `~/.xxh/xxh local` and you will enter your xxh environment. +Next time you're on the host just run `~/.xxh/xxh local` and you will enter your xxh environment. ## Examples of use cases ### Python with pip everywhere without installation @@ -159,7 +159,7 @@ anyhost> python --version Python 3.8.2 ``` You'll get python-powered [xonsh](https://xon.sh) shell with portable python and pip on the host without any system installations on the host. -You can install PyPi packages manually or bring them with you automatically by using [xxh-plugin-prerun-dotfiles](https://github.com/xxh/xxh-plugin-prerun-dotfiles). Also don't forget about xxh-plugins like [zoxide](https://github.com/xxh/xxh-plugin-prerun-zoxide). +You can install PyPi packages manually or bring them with you automatically by using [xxh-plugin-prerun-dotfiles](https://github.com/xxh/xxh-plugin-prerun-dotfiles). Also, don't forget about xxh-plugins like [zoxide](https://github.com/xxh/xxh-plugin-prerun-zoxide). #### Way 2. Using portable python on any xxh shell ``` @@ -211,8 +211,8 @@ osquery> SELECT * FROM users WHERE username='news'; +-----+-----+----------+-------------+-----------------+-------------------+ ``` -### All in one portable home -xxh is very agile. You can create your own `xxh-shell` (the shell part means it has an entrypoint) which can have any portable tools +### All-in-one portable home +xxh is very agile. You can create your own `xxh-shell` (the shell part means it has an entrypoint), which can have any portable tools that could help you on the host. [Bash](https://github.com/xxh/xxh-shell-bash) xxh-shell is one of these platforms that could be forked and stuffed. @@ -244,8 +244,8 @@ platforms that could be forked and stuffed. ### xxh Development Environment -In the [xxh development environment](https://github.com/xxh/xxh/tree/master/xde) there is full [dockerised](https://www.docker.com/) environment -for development, testing and contribution. The process of testing and development is orchestrated by `xde` tool and is as +In the [xxh development environment](https://github.com/xxh/xxh/tree/master/xde) there is a full [dockerised](https://www.docker.com/) environment +for development, testing, and contribution. The process of testing and development is orchestrated by `xde` tool and is as easy as possible. ### Vagrant based Plugin Development @@ -258,7 +258,7 @@ See [the Plugin Development folder](./plugin-development) for more details If you're in a team it does not mean you have an obligation to do something. The main goal of teams is to create groups of passionate people who could help or support solving complex problems. Some people could be an expert in one shell and a -newbie in another shell and mutual assistance is the key to xxh evolution. [Ask join.](https://github.com/xxh/xxh/issues/50) +newbie in another shell and mutual assistance is the key to xxh evolution. [Ask to join.](https://github.com/xxh/xxh/issues/50) ## Thanks * **niess** for great [python-appimage](https://github.com/niess/python-appimage)