Skip to content

Document Zoo Code terminal override and explicit PowerShell profile setup #4

Description

@edelauna

Context

Zoo Code PR Zoo-Code-Org/Zoo-Code#277 adds a Zoo Code terminal override setting for the VS Code integrated-terminal execution path.

The settings UI includes a Learn more link to the shell-integration documentation. Add a section explaining the behavior and limitations of this override.

Documentation needed

Add a VS Code terminal override section to the shell-integration page covering:

  • The recommended default is Use VS Code default profile.
  • Choose default profile in VS Code opens VS Code's native Terminal: Select Default Profile picker.
  • The Zoo Code override applies only when Use Inline Terminal is disabled and commands run in VS Code's integrated terminal.
  • The override dropdown lists only path-based profiles exposed by VS Code whose executable can be resolved on disk or through PATH.
  • Source-only and auto-detected entries may appear in VS Code's native picker but not in the Zoo Code override dropdown.
  • Inline/Execa execution is a separate path and is not affected by this setting.

Explicit PowerShell examples

Document that PowerShell can be added to the Zoo Code override dropdown by defining an explicit path-based profile in VS Code user settings.

Windows PowerShell:

{
  "terminal.integrated.profiles.windows": {
    "Windows PowerShell Explicit": {
      "path": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
    }
  }
}

PowerShell 7:

{
  "terminal.integrated.profiles.windows": {
    "PowerShell 7 Explicit": {
      "path": "C:\\Program Files\\PowerShell\\7\\pwsh.exe"
    }
  }
}

Explain that a source-only profile is intentionally excluded because Zoo Code cannot resolve it through the stable VS Code extension API:

{
  "terminal.integrated.profiles.windows": {
    "PowerShell": {
      "source": "PowerShell"
    }
  }
}

Link target

The extension currently links to the shell-integration docs page. Add a stable heading/anchor for this section so the extension link can point directly to it.

Explicit Git Bash example

Document that the Zoo Code override requires a user-level VS Code terminal profile with an explicit, resolvable path. A source-only Git Bash profile shown by VS Code is not sufficient for the Zoo Code dropdown.

{
  "terminal.integrated.profiles.windows": {
    "Git Bash Explicit": {
      "path": "C:\\Program Files\\Git\\bin\\bash.exe",
      "args": ["--login", "-i"]
    }
  }
}

Link the general setup guidance to the official VS Code terminal profiles documentation, but state the Zoo Code-specific supported subset clearly:

  • Define the profile in VS Code user settings, not workspace .vscode/settings.json.
  • Use an explicit path that resolves on disk or through PATH.
  • Source-only profiles are intentionally excluded because Zoo Code cannot resolve their executable through the stable VS Code extension API.
  • Workspace-defined profiles are intentionally ignored so opening a repository cannot select an executable for Zoo Code to launch.
  • Paths containing VS Code variables such as ${env:ProgramFiles} are not currently supported. Track variable expansion as follow-up compatibility work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions