Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
Accelerator
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Type
/
to search
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
base
/
docs
Public
Notifications
You must be signed in to change notification settings
Fork
743
Star
325
Code
Issues
392
Pull requests
581
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
1a93fb740961667aa100d5955e7675af8f343611
Breadcrumbs
docs
/
githooks
/
install.sh
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
executable file
·
29 lines (25 loc) · 1.23 KB
1a93fb7
Breadcrumbs
docs
/
githooks
/
install.sh
Copy path
Top
File metadata and controls
Code
Blame
executable file
·
29 lines (25 loc) · 1.23 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#!/bin/sh
# Local install for this repo's git hooks.
# Scope: this clone only — never touches global git config or your $HOME.
#
# Usage: ./githooks/install.sh
set -e
REPO_ROOT=$(git rev-parse --show-toplevel)
cd "$REPO_ROOT"
# --local is the default for `git config`, but pass it explicitly so it's
# obvious from a code-read that this does NOT modify --global or --system.
git config --local core.hooksPath githooks
chmod +x githooks/post-commit githooks/post-merge
if ! command -v jq >/dev/null 2>&1; then
echo "Note: 'jq' not installed — hooks will use built-in defaults instead of githooks/config.json."
echo " Install with: brew install jq (or: apt-get install jq)"
fi
echo "Installed hooks for this repo (scope: --local, this clone only):"
echo " core.hooksPath = $(git config --local --get core.hooksPath)"
echo
echo "Hooks:"
echo " post-commit → regenerates docs indexes after a commit (auto on docs/ A/D/R, opt-in via 'agents.md' / 'llms.txt' keyword)"
echo " post-merge → warns when a pull/merge brought changes that drift docs indexes"
echo
echo "Bypass once: SKIP_DOCS_HOOK=1 git commit ... (or include [skip-docs] in the message)"
echo "Verify scope: git config --global --get core.hooksPath → should print nothing"
You can’t perform that action at this time.