[DOCS] Ambiguous apiKeyHelper execution environment instructions for Windows users
Documentation Type
Missing documentation (feature not documented)
Documentation Location
https://code.claude.com/docs/en/settings
Section/Topic
The "Available settings" table, specifically the apiKeyHelper row description.
Current Documentation
In the description column for apiKeyHelper:
"Custom script, to be executed in /bin/sh, to generate an auth value."
What's Wrong or Missing?
The documentation explicitly states the script is executed in /bin/sh. This absolute path does not exist natively on Windows operating systems.
While the Troubleshooting guide mentions that Claude Code on Windows requires Git Bash, this specific settings entry does not cross-reference that requirement or explain how the script is resolved on Windows. A Windows user might interpret this as an error, or attempt to point to a PowerShell/Batch script that fails because the environment is trying to invoke a sh-compatible shell.
Suggested Improvement
The description should be updated to be platform-inclusive or explicitly note the Windows requirement.
Current:
Custom script, to be executed in /bin/sh, to generate an auth value.
Suggested:
Custom script to generate an auth value. Executed via /bin/sh (on macOS/Linux) or the configured Git Bash environment (on Windows).
Impact
High - Prevents users from using a feature
Additional Context
- Related Documentation: The Troubleshooting page clarifies that "Claude Code on native Windows requires Git Bash," but users configuring
settings.jsonmay not have read the troubleshooting guide yet. - Impact: Users on Windows may encounter configuration errors when setting up dynamic authentication if they are unaware that the script must be bash-compatible.
This issue has 4 comments on GitHub. Read the full discussion on GitHub ↗