Add cookbook chapter on how to read env vars from foreign shell scripts #1292
Conversation
| @@ -137,6 +137,7 @@ export const sidebarEn: SidebarConfig = { | |||
| 'help', | |||
| 'system', | |||
| 'parsing', | |||
| 'foreign_shell_scripts', | |||
There was a problem hiding this comment.
Note: I placed this here because it seemed like a good follower to the system and parsing documents, but I'm totally fine with it being moved to the bottom or somewhere else.
cookbook/foreign_shell_scripts.md
Outdated
| that the path to the `brew` binary depends on the OS and installation. | ||
|
|
||
| ``` | ||
| load-env (^/opt/homebrew/bin/brew shellenv | capture-foreign-env) |
There was a problem hiding this comment.
This is perhaps the most important part of the page: A quick example of how to use the capture command. Ideally, it should be something more widely understandable. People not using Homebrew don't know what brew shellenv is. I think even load-env ('script.sh' | capture-foreign-env) would do. It is not immediately clear the $in should be a script filename, some people might try to do open script.sh | capture-foreign-env or similar to pipe in the script contents.
There was a problem hiding this comment.
(By "people" I mean "me" as these things came to mind when reading it.)
There was a problem hiding this comment.
Yeah, that makes a lot of sense! I'll create a simpler, highlighted example tomorrow and fix a few leftover typos.
There was a problem hiding this comment.
@kubouch Actually, after rereading your comment: I didn't plan for you to be able to specify a script name, and I don't think it works, unless I missed something about eval.
So, open or open --raw would be the way to go, when having an existing script file. I liked having only one input method and thought it's important to allow the piping-in of the contents because tools generating env-var-scripts often pipe the script to stdout. Like brew in this case.
But I'm up for suggestions!
For now I'd add the example with open
There was a problem hiding this comment.
OK, then I misunderstood. It's not clear whether $in should be a script name or a source string, I didn't read the script source that thoroughly. Then the example could be load-env (open script.nu | capture foreign-env) or similar.
Side note: You can check bass if you didn't know it. A similar idea but for running bash scripts in fish, written in Python.
There was a problem hiding this comment.
Oh I see, no worries!
I updated the PR and tried to be a little more clear about this.
|
oooh, nice work! |
|
Perfect, thanks! |
This originated from a conversation in the Nushell Discord, where I showed a less sophisticated version of this script in the #cool-scripts channel, and was asked to contribute it to the Cookbook.
Next to reviewing the code, please give your honest opinions on the text, and if you want me to change anything, I appreciate the feedback 🙂
You may of course also just edit anything yourself if that is preferred.
I hope this is helpful to people!