Skip to content

Add documentation for GOOSE_TERMINAL environment variable #4145

@blackgirlbytes

Description

@blackgirlbytes

Problem
The GOOSE_TERMINAL environment variable feature was added in PR #3911, but there's no documentation explaining how users can leverage this feature.

Solution
Add documentation that explains:

  • What the GOOSE_TERMINAL environment variable is
  • When it gets set (all command executions by Goose)
  • How users can use it to customize their shell environment
  • Practical examples of use cases

Suggested Documentation Locations

  • User guide/configuration section
  • Environment variables reference
  • Developer extension documentation

Example Use Cases to Document

  1. Custom aliases for Goose sessions:

    if [[ -n "$GOOSE_TERMINAL" ]]; then
      alias find="echo 'Use rg (ripgrep) instead of find for better performance'"
      alias ls="ls --color=auto"
    fi
  2. Goose-specific PATH modifications:

    if [[ -n "$GOOSE_TERMINAL" ]]; then
      export PATH="/usr/local/goose-tools:$PATH"
    fi
  3. Custom prompt indicators:

    if [[ -n "$GOOSE_TERMINAL" ]]; then
      export PS1="[GOOSE] $PS1"
    fi

Acceptance Criteria

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions