PRE-COMMIT-TRY-REPO(1)

💅 pre-commit-try-repo — the manual, but make it make sense

okay bestie, welcome to pre-commit-try-repo(1), a User Commands page, and it's literally the move when you wanna try the hooks in a repository — super useful for developing new hooks. like, you're building a hook, you wanna test it against a real repo, boom, this is your girl. 🎀

✨ NAME ✨

pre-commit-try-repo – Try the hooks in a repository, useful for developing new hooks. no cap, that's the whole job description and she ate. 💖

🌸 SYNOPSIS 🌸

pre-commit try-repo [-h] [--color {auto,always,never}] [-c CONFIG]
[--ref REF] [--verbose] [--all-files | --files [FILES ...]]
[--show-diff-on-failure]
[--hook-stage {commit-msg,post-checkout,post-commit,post-merge,post-rewrite,pre-commit,pre-merge-commit,pre-push,pre-rebase,prepare-commit-msg,manual}]
[--remote-branch REMOTE_BRANCH] [--local-branch LOCAL_BRANCH]
[--from-ref FROM_REF] [--to-ref TO_REF]
[--pre-rebase-upstream PRE_REBASE_UPSTREAM]
[--pre-rebase-branch PRE_REBASE_BRANCH]
[--commit-msg-filename COMMIT_MSG_FILENAME]
[--prepare-commit-message-source PREPARE_COMMIT_MESSAGE_SOURCE]
[--commit-object-name COMMIT_OBJECT_NAME] [--remote-name REMOTE_NAME]
[--remote-url REMOTE_URL] [--checkout-type CHECKOUT_TYPE]
[--is-squash-merge IS_SQUASH_MERGE] [--rewrite-command REWRITE_COMMAND]
repo [hook]

👑 OPTIONS 👑

🫶 POSITIONAL ARGUMENTS

• repo — Repository to source hooks from. like, where the hooks live, babe.
• hook — A single hook-id to run. just the one. one hook. main character energy, singular. ⭐

💅 OPTIONAL ARGUMENTS

• -h, --help — Show a help message and exit. the classic. when in doubt, ask for help, it's giving self-care. 🙈
• --color {auto,always,never} — Whether to use color in output. Defaults to auto. aesthetic choices matter. ✨
• --ref, --rev REF — Manually select a rev to run against, otherwise the HEAD revision will be used. you pick the rev, or HEAD picks you. 💜
• -c, --config CONFIG — Path to alternate config file. for when your config is not like other configs. 🦋
• --verbose, -v — (the page gives this one no description at all, so it's just… sitting there, mysterious, iconic) 💀
• --all-files, -a — Run on all the files in the repo. all of them. every single one. no crumbs. 🔥
• --files [FILES ...] — Specific filenames to run hooks on. when you're being picky, as you should. 💅
• --show-diff-on-failure — When hooks fail, run git-diff(1) directly afterward. so you can see exactly what went wrong, in real time. 🍓
• --hook-stage {commit-msg,post-checkout,post-commit,post-merge,post-rewrite,pre-commit,pre-merge-commit,pre-push,pre-rebase,prepare-commit-msg,manual}] — The stage during which the hook is fired. One of commit-msg, post-checkout, post-commit, post-merge, post-rewrite, pre-commit, pre-merge-commit, pre-push, pre-rebase, prepare-commit-msg, manual. (and yes, the curly-brace list on the flag itself has that lil ] on the end — that's exactly how it's written here, we're not touching it, she's perfect as she is 💖)
• --remote-branch REMOTE_BRANCH — Remote branch ref used by git-push(1). 📡
• --local-branch LOCAL_BRANCH — Local branch ref used by git-push(1). 🏠
• --from-ref, --source, -s FROM_REF — (For usage with --to-ref) – this option represents the original ref in a from_ref...to_ref diff expression. For pre-push hooks, this represents the branch you are pushing to. For post-checkout hooks, this represents the branch that was previously checked out. the before girlie. 🦋
• --to-ref, --origin, -o TO_REF — (For usage with --from-ref) – this option represents the destination ref in a from_ref...to_ref diff expression. For pre-push hooks, this represents the branch being pushed. For post-checkout hooks, this represents the branch that is now checked out. the after girlie. ✨
• --pre-rebase-upstream PRE_REBASE_UPSTREAM — The upstream from which the series was forked. 🌱
• --pre-rebase-branch PRE_REBASE_BRANCH — The branch being rebased, and is not set when rebasing the current branch. so if you're rebasing the current branch, she's a no-show. 🎀
• --commit-msg-filename COMMIT_MSG_FILENAME — Filename to check when running during commit-msg. 📝
• --prepare-commit-message-source PREPARE_COMMIT_MESSAGE_SOURCE — Source of the commit message (typically the second argument to .git/hooks/prepare-commit-msg). 🔍
• --commit-object-name COMMIT_OBJECT_NAME — Commit object name (typically the third argument to .git/hooks/prepare-commit-msg). 🪩
• --remote-name REMOTE_NAME — Remote name used by git-push(1). 📛
• --remote-url REMOTE_URL — Remote url used by git-push(1). 🔗
• --checkout-type CHECKOUT_TYPE — Indicates whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). two flags, two vibes. 💫
• --is-squash-merge IS_SQUASH_MERGE — During a post-merge hook, indicates whether the merge was a squash merge. 🥒 (squash. get it. okay moving on)
• --rewrite-command REWRITE_COMMAND — During a post-rewrite hook, specifies the command that invoked the rewrite. 🛠️

💖 SEE ALSO 💖

go read these too, they're the whole friend group:

• pre-commit-autoupdate(1), pre-commit-clean(1), pre-commit-gc(1), pre-commit-init-templatedir(1), pre-commit-install(1), pre-commit-install-hooks(1), pre-commit-migrate-config(1), pre-commit-run(1), pre-commit-sample-config(1), pre-commit-uninstall(1), pre-commit-validate-config(1), pre-commit-validate-manifest(1), pre-commit-help(1)
• pre-commit(1)
• git-diff(1) git-push(1)

fr fr bestie, go test those hooks. your future self is obsessed with you. 🫶

mwah 💋 — this page is PRE-COMMIT-TRY-REPO(1) from February 2025, and that's the whole sign-off. periodt. 💅