Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tesujimath/nu_plugin_bash_env
A Bash environment plugin for Nushell
https://github.com/tesujimath/nu_plugin_bash_env
Last synced: 4 months ago
JSON representation
A Bash environment plugin for Nushell
- Host: GitHub
- URL: https://github.com/tesujimath/nu_plugin_bash_env
- Owner: tesujimath
- License: mit
- Created: 2023-12-04T22:29:01.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-01-30T03:59:27.000Z (5 months ago)
- Last Synced: 2024-01-31T04:33:43.359Z (5 months ago)
- Language: Shell
- Size: 29.3 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-nu - nu_plugin_bash_env
README
# nu_plugin_bash_env
A Bash environment plugin for Nushell.
For instructions on how to use this plugin, see the [Nushell book](https://www.nushell.sh/book/plugins.html).
In summary, save the `nu_plugin_bash_env` script in your Nu plugins directory (for example) and ensure it is executable.
For users of Nix, this is now installable as a flake (see below).
Then in Nu:
```
> register nu_plugin_bash_env
```
The plugin reads the specified environment file (if any) and evaluates variables from `stdin` (if any) and returns any new or changed environment variables as a record, suitable for passing to Nu's `load-env`.
## Dependencies
The script uses `jq` for heavy lifting.
## Examples
### Simple Usage
```
> bash-env examples/simple.env
╭───┬───╮
│ B │ b │
│ A │ a │
╰───┴───╯
> echo $env.A
Error: nu::shell::name_not_found
× Name not found
> bash-env examples/simple.env | load-env
> echo $env.A
a
> echo $env.B
b
> bash-env examples/simple.env
╭──────────────╮
│ empty record │
╰──────────────╯
# no new or changed environment variables, so nothing returned
> ssh-agent | bash-env
Agent pid 98985
╭───────────────┬───────────────────────────────────╮
│ SSH_AUTH_SOCK │ /tmp/ssh-XXXXXXFIMT9y/agent.98982 │
│ SSH_AGENT_PID │ 98985 │
╰───────────────┴───────────────────────────────────╯
```
### Escaping Special Characters
Care has been taken to escape any special characters.
```
> bash-env `examples/Ming's "menu" of (merciless) monstrosities.env`
╭───────────┬──────────────────────────────────────────────────────╮
│ QUOTE │ "Well done!" is better than "Well said!" │
│ SPACEMAN │ One small step for a man ... │
│ MIXED_BAG │ Did the sixth sheik's sixth sheep say "baa", or not? │
╰───────────┴──────────────────────────────────────────────────────╯
> bash-env `examples/Ming's "menu" of (merciless) monstrosities.env` | load-env
> echo $env.QUOTE
"Well done!" is better than "Well said!"
```
## API Generator
Because this plugin is written in Bash, the API signatures must be written by hand. The [api-support](api-support) sub-directory contains a Rust program to produce what is required, using the official Nu plugin library.
## Nix flake
The plugin is installable from its flake using Nix Home Manager.
See my own [Home Manager flake](https://github.com/tesujimath/home.nix/blob/main/flake.nix#L12) and [nushell module](https://github.com/tesujimath/home.nix/blob/main/modules/nushell/default.nix) for hints how to achieve this. Note in particular the requirement for [each-time plugin registration](https://github.com/tesujimath/home.nix/blob/main/modules/nushell/config.nu#L761).
## Notes
All local variables in the script are prefixed with underscore, in an attempt to mitigate Bash's inability to distinguish variables local to the shell and environment variables, but this is by no means bulletproof.
## Future work
- unsetting an environment variable ought to be possible