Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anki-code/xontrib-sh
Paste and run commands from bash, zsh, fish, tcsh in xonsh shell.
https://github.com/anki-code/xontrib-sh
bash dash fish sh shell tcsh xonsh xontrib zsh
Last synced: about 2 months ago
JSON representation
Paste and run commands from bash, zsh, fish, tcsh in xonsh shell.
- Host: GitHub
- URL: https://github.com/anki-code/xontrib-sh
- Owner: anki-code
- License: mit
- Created: 2020-10-09T20:17:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T09:20:40.000Z (8 months ago)
- Last Synced: 2024-05-21T06:56:02.675Z (7 months ago)
- Topics: bash, dash, fish, sh, shell, tcsh, xonsh, xontrib, zsh
- Language: Python
- Homepage:
- Size: 43.9 KB
- Stars: 51
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-xontribs - sh - Paste and run commands from bash, zsh, fish in xonsh shell. (Plugins / Prompt tweaks)
README
Paste and run commands from bash, fish, zsh, tcsh in xonsh shell.
If you like the idea click ⭐ on the repo and and tweet.
## Install
```bash
xpip install -U xontrib-sh
echo 'xontrib load sh' >> ~/.xonshrc
# Reload xonsh
```
## Usage
Start the line with `! ` (exclamation mark with space) then paste the sh-compatible commands after it and run.
The commands syntax will be tested in the shells from list (if installed) and the commands will be run in
the first matching shell. By default list of shells contains bash and sh.
The commands will be executed in the environment that will be inherited from current but if the commands modify
the environment there will no changes in source xonsh environment.
To set the list of shells use environment variable before loading the xontrib:
```python
$XONTRIB_SH_SHELLS = ['bash', 'sh'] # default
xontrib load sh
! echo hello
```
Also you can set the shell explicitly i.e. `!bash ` or `!b ` (the first letter of the shell).
## The main use case
The main use case of `xontrib-sh` is when you copy and paste the sh-commands from some article or instruction
and this commands are environment agnostic and you want to run it without rewriting it on xonsh or run sh-shell.
For example you've found snippet of bash commands that check existing of `curl`:
```bash
TMP=/tmp && cd $TMP && ( [[ -x $(command -v curl) ]] && echo "Yes" || echo "No" )
```
You hesitate [how xonsh will execute this](https://github.com/anki-code/xonsh-cheatsheet/blob/main/README.md#three-most-frequent-things-that-newcomers-overlook) and you're absolutely right there will be syntax error.
To run this just start with `! ` or `!b ` or `!bash ` and paste the commands. As result you'll see the right message.
## Examples
### Bash brace expansion
```bash
! echo 01.{05..10}
# Or explicitly:
!b echo 01.{05..10}
!bash echo 01.{05..10}
```
```
bash:
01.05 01.06 01.07 01.08 01.09 01.10
```
### Multiline loop
```bash
! for i in 1 2 3
do
echo $i
done
```
```
bash:
1
2
3
```
### Use environment variables to pass values from xonsh to sh
```python
$ENV = 'hello'
! echo $ENV!
```
```
bash:
hello!
```
## Known issues
#### Determining the shell on short command
In case of usage many different shells the detection of the shell works perfect when the commands contain shell-specific syntax.
But if you run the short command that could be valid in all shells the first matched shell will be chosen but it's could be wrong.
For example you have bash and fish in the list of shells. The short fish command may be determined as bash command.
As result the command will be failed:
```python
$XONTRIB_SH_SHELLS = ['bash', 'fish']
xontrib load sh
# Run fish command:
! set -U var1 value1
# bash: line 0: set: -U: invalid option
```
To avoid this use the explicit setting the shell i.e. `!fish set -U var1 value1`.
Also, since __pwsh__ and __cmd__ shells don't have an option to detect their own syntax, they can only be invoked:
- explicitly by their name, i.e. `!p ` or `!pwsh `
- implicitly via the `! ` prefix only when there is __one__ shell in `$XONTRIB_SH_SHELLS`
#### Why it's better than [xonsh subprocess macros](https://xon.sh/tutorial_macros.html#subprocess-macros)?
Xonsh subprocess macros is not supporting multiline commands and require more keystrokes.
## Additional options
* `$XONTRIB_SH_USEFULL` (default `True`) - enables to set the shell explicitly by the name of the shell i.e. `!bash `.
* `$XONTRIB_SH_USEFIRST` (default `True`) - enables to set the shell explicitly by the first letter i.e. `!b ` instead of `!bash `.
## Links
* This package is the part of [rc-awesome](https://github.com/anki-code/xontrib-rc-awesome) - awesome snippets of code for xonshrc in xonsh shell.
* This package is the part of [ergopack](https://github.com/anki-code/xontrib-ergopack) - the pack of ergonomic xontribs.
* This package was created with [xontrib cookiecutter template](https://github.com/xonsh/xontrib-cookiecutter).
* [How to create a xonsh alias that have a behavior like in xontrib-sh?](https://github.com/anki-code/xontrib-sh/issues/6#issuecomment-1045978621)