Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edc/bass
Make Bash utilities usable in Fish shell
https://github.com/edc/bass
Last synced: 5 days ago
JSON representation
Make Bash utilities usable in Fish shell
- Host: GitHub
- URL: https://github.com/edc/bass
- Owner: edc
- License: mit
- Created: 2015-03-16T06:14:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-16T23:50:52.000Z (12 months ago)
- Last Synced: 2024-11-21T03:33:40.024Z (21 days ago)
- Language: Python
- Size: 70.3 KB
- Stars: 2,228
- Watchers: 21
- Forks: 71
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - edc/bass - Make Bash utilities usable in Fish shell (others)
README
# Bass
Bass makes it easy to use utilities written for Bash in [fish shell](https://github.com/fish-shell/fish-shell/).
Regular bash scripts can be used in fish shell just as scripts written in any language with proper shebang or explicitly using the interpreter (i.e. using `bash script.sh`). However, many utilities, such as virtualenv, modify the shell environment and need to be sourced, and therefore cannot be used in fish. Sometimes, counterparts (such as the excellent [virtualfish](http://virtualfish.readthedocs.org/en/latest/)) are created, but that's often not the case.
Bass is created to make it possible to use bash utilities in fish shell without any modification. It works by capturing what environment variables are modified by the utility of interest, and replay the changes in fish.
You might not need Bass for simple use cases. A great simple alternative (suggested by @jorgebucaran) is to just use `exec bash -c "source some-bash-setup.sh; exec fish"`.
# Installation
Bass is compatible with fish versions 2.6.0 and later.
## Manually
Use the Makefile.
`make install` will copy two files to `~/.config/fish/functions/`.
`make uninstall` will remove those two files.
Relaunch the shell for the change to take effect.
## With [Oh My Fish](https://github.com/oh-my-fish/oh-my-fish)
```console
omf install bass
```
## With [Fisher](https://github.com/jorgebucaran/fisher)
```console
fisher install edc/bass
```
## With [Fundle](https://github.com/tuvistavie/fundle)
Add
```console
fundle plugin 'edc/bass'
```
to your fish config, relaunch the shell and run `fundle install`.
# Example
Bass is simple to use. Just prefix your bash utility command with `bass`:
```
> bass export X=3
> echo $X
3
```
Notice that `export X=3` is bash syntax. Bass "transported" the new bash
environment variable back to fish.
Bass has a debug option so you can see what happened:
```
> bass -d export X=4
# updating X=3 -> 4
set -g -x X 4
```
## nvm
Here is a more realistic example, using the excellent
[nvm](https://github.com/creationix/nvm):
```
> bass source ~/.nvm/nvm.sh --no-use ';' nvm use iojs
Now using io.js v1.1.0
```
Note that semicolon is quoted to avoid being consumed by fish.
This example takes advantage of the nvm bash utility to switch to iojs.
After the command, iojs is accessible:
```
> which iojs
/Users/edc/.nvm/versions/io.js/v1.1.0/bin/iojs
```
You can then very easily pack the command as a function and feel more at home:
```
> funced nvm
nvm> function nvm
bass source ~/.nvm/nvm.sh --no-use ';' nvm $argv
end
> nvm list
-> iojs-v1.1.0
system
> nvm ls-remote
v0.1.14
v0.1.15
> funcsave nvm
...
```
(`--no-use` is an important option to `nvm.sh`. See [#13](https://github.com/edc/bass/issues/13) for background.)