-
Notifications
You must be signed in to change notification settings - Fork 6k
docs: document auto-injected GOOSE_SHELL flags #10759
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -312,6 +312,15 @@ REM Windows: use a POSIX-like shell instead of cmd.exe | |
| set GOOSE_SHELL=C:\cygwin64\bin\bash.exe | ||
| ``` | ||
|
|
||
| :::note | ||
| You only ever set `GOOSE_SHELL` to a shell executable path or name. goose injects the command-line flags automatically based on the shell, so there is no need to add them yourself: | ||
|
|
||
| - **PowerShell** (`pwsh`, `powershell`) → `-NoProfile -NonInteractive -Command` | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
When a Unix user sets Useful? React with 👍 / 👎. |
||
| - **cmd** → `/C` | ||
| - **POSIX shells** (bash, zsh, … on Windows via Cygwin/MSYS2) → `-c` | ||
| - On Unix the default shell (`bash`, falling back to `sh`) is invoked as `<shell> -c` | ||
| ::: | ||
|
|
||
| ## Security and Privacy | ||
|
|
||
| These variables control security features, credential storage, and anonymous usage data collection. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Saying there is no need to add them yourself seems odd when we document how to do so multiple times in this doc seems a bit odd to me...
We should take a stance on whether we document how to use this env var or keep it internal to goose and remove all mentions in docs.
Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point — the note is awkwardly worded. It's telling users not to do something the examples never suggested, so I'll rephrase it to state the behavior factually instead.
On the broader question: I'd keep
GOOSE_SHELLdocumented. It's a real config knob (force zsh, Cygwin bash on Windows, custompwsh), and hiding it would hurt discoverability. The flag-mapping detail is better served by thebuild_shell_commandrustdoc this PR already adds, so I'll trim the user-facing note to a one-liner and avoid duplicating the verbose list in both places.