docs: clarify GOOSE_TERMINAL requires ~/.zshenv for zsh users #6297
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add caution callout explaining zsh users must use ~/.zshenv instead of ~/.zshrc since goose runs commands with 'zsh -c' (non-interactive shell) - Add practical example for blocking git commit when run by goose - Update file location guidance for zsh vs bash users
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a critical documentation issue where zsh users were incorrectly instructed to configure GOOSE_TERMINAL customizations in ~/.zshrc, which is not sourced by non-interactive shells. The documentation now correctly directs zsh users to use ~/.zshenv instead.
Key changes:
- Added a caution callout explaining the difference between zsh and bash shell configuration sourcing behavior
- Provided a practical example demonstrating how to block
git commitwhen run by goose - Updated file location guidance to distinguish between zsh (
~/.zshenv) and bash (~/.bashrc) users
Contributor
|
dianed-square
approved these changes
Dec 29, 2025
michaelneale
added a commit
that referenced
this pull request
Dec 30, 2025
* main: fix: adding more open models (#6300) docs: add goose for vs code extension (#6262) feat(code-mode): use server names for MCP extensions (#6284) docs: agent skills compatibility note (#6299) docs: clarify GOOSE_TERMINAL requires ~/.zshenv for zsh users (#6297) feat: add OpenAI Codex CLI provider (#6263) docs: fix Resources menu (#6292) Remove Advent of AI announcement banner (#6291) Add blog post: How We Use goose to Maintain goose (#6289)
cronus42
pushed a commit
to cronus42/goose
that referenced
this pull request
Jan 7, 2026
…6297) Signed-off-by: James Loope <cronus@stolenshoe.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes an issue where the
GOOSE_TERMINALdocumentation incorrectly advised zsh users to put customizations in~/.zshrc. Since goose runs commands usingzsh -c "command"(a non-interactive shell),~/.zshrcis never sourced.Changes
~/.zshenvinstead of~/.zshrcgit commitwhen run by gooseWhy this matters
Users following the existing docs would set up
GOOSE_TERMINALchecks in~/.zshrcand wonder why they don't work. This was discovered when testing the git commit blocking feature - it only worked after moving the function to~/.zshenv.Testing
Verified that:
GOOSE_TERMINAL=1is set when goose runs shell commands~/.zshenvsuccessfully blocksgit commit~/.zshrcdoes NOT work (because it's not sourced)