docs/Troubleshooting.md
Use this checklist before creating a Homebrew issue.
brew update.brew update again so the first update cannot leave the failing command on an older Homebrew version.brew doctor and read every warning.Do not apply destructive Git, ownership or permission changes from an old issue report without understanding which files they affect. See Common Issues for current recovery guidance.
Search the tracker responsible for the failing component:
Homebrew/homebrew-core issues for formulaeHomebrew/homebrew-cask issues for casksHomebrew/brew issues for the brew commandAlso search Homebrew Discussions for support and related reports. The Discourse archive is read-only historical material and will contain outdated instructions.
For a formula installation or build failure, upload its logs:
brew gist-logs FORMULA
For other failures, collect:
brew config
brew doctor
Remove credentials, private repository URLs and other secrets before publishing terminal output. Do not omit warnings merely because they appear unrelated.
If the problem is neither resolved nor already reported, use the issue template in the appropriate repository:
Homebrew/homebrew-core issue chooserHomebrew/homebrew-cask issue chooserHomebrew/brew issue chooserInclude the command, complete error, relevant brew config and brew doctor output and the brew gist-logs URL when available.
Use a descriptive title that identifies the package, failure and operating system.
See Creating a Homebrew Issue for reporting expectations.