Install pre-commit Hook for ESP-IDF Project
Python 3.7.* or above. This is our recommended python version for IDF developers.
If you still have python versions not compatible, update your python versions before installing the pre-commit hook.
pip install pre-commit
Install pre-commit hook
Go to the IDF Project Directory
pre-commit install --allow-missing-config. Install hook by this approach will let you commit successfully even in branches without the
pre-commit hook will run automatically when you’re running
For detailed usage, please refer to the documentation of pre-commit.
Common Problems For Windows Users
/usr/bin/env: python: Permission denied.
If you’re in Git Bash, please check the python executable location by run
If the executable is under
~/AppData/Local/Microsoft/WindowsApps/, then it’s a link to Windows AppStore, not a real one.
Please install python manually and update this in your
Your %USERPROFILE% contains non-ASCII characters
pre-commitmay fail when initializing an environment for a particular hook when the path of
pre-commit’s cache contains non-ASCII characters. The solution is to set
PRE_COMMIT_HOMEto a path containing only standard characters before running pre-commit.
$Env:PRE_COMMIT_HOME = "C:\somepath\pre-commit"