Skip to main content

git-a-grip

Two things, from one package:

  1. A set of pre-commit hooks you point your .pre-commit-config.yaml at.
  2. gag, a CLI for managing pre-commit across all your repos — see what every project pins, and pin them all to the same rev.

1. The hooks

default_install_hook_types: [pre-commit, pre-push]  # protect-branch, pytest, vitest run at pre-push

repos:
  - repo: https://github.com/dannybrown37/git-a-grip
    rev: v0.16.1
    hooks:
      - id: commitizen-early
      - id: protect-branch
      - id: ruff-check
      - id: ruff-format
      - id: mypy
      - id: embed-tree
      - id: embed-command
        args: ['--marker=help', '--command=mytool --help']
      - id: regen-file
        args: ['--command=python scripts/build_docs.py', '--file=docs/api.md']
      - id: biome
      - id: pytest
        args: [tests/, -q]
      - id: vitest
      - id: block-private-terms
      - id: zizmor
      - id: shellcheck
      - id: shfmt

Nothing to install. Your project needs no ruff, cz or uv on PATH — pre-commit builds the env. (pytest, mypy, biome, eslint, tsc and vitest are the exceptions: they must run inside your project's environment, so they shell out to uv run / your package manager.)

Hook What it does for you
commitizen-early Rejects a bad commit message in ~0.3s, instead of after the whole hook suite has run. Pair with the upstream commitizen hook for the cases it can't see (editor, merge, rebase).
protect-branch Refuses a push straight onto the default branch — whatever origin/HEAD names, else main/master; --branch=NAME to choose. The branch protection a private repo on GitHub's free plan can't have, moved to your machine: it stops accidents, not --no-verify. Checks the branch pushed to, so git push origin feature:main is caught and a local commit on main isn't. Runs on push, like pytest — same pre-push install requirement. gag remote shows it as pre-commit where GitHub won't say what guards the branch.
ruff-check ruff check --fix, with fixes re-staged — no dirty tree to git add and amend.
ruff-format ruff format, likewise re-staged.
mypy Type-checks the project, in your project's env so mypy can import your dependencies instead of reporting on the imports — and installs mypy itself via uv run --with, so there's no dependency group to declare or keep in step. Names no files, so what it checks is what your mypy config says — not whichever files you happened to touch. --runner=uv run ty check swaps the engine.
pytest Your test suite, from the repo root, in your project's env. Runs on push, not commit — needs pre-push in default_install_hook_types (or pre-commit install -t pre-push), else it silently never runs. args: ['--runner=uv run --extra api pytest', ...] to change the runner.
embed-tree Keeps a file tree in your README true. Drop <!-- tree:start --> / <!-- tree:end --> in, and it regenerates and re-stages on every commit. Contents come from git ls-files, so it's exactly what's committed. (Was readme-tree; the old id still works.)
embed-command Keeps a command's output — mytool --help, make help — true in your README. Name the command in args; nothing is discovered and run on its own.
regen-file Replaces bash -c 'run-the-script && git add the-file'. Runs the generator you name and re-stages the files you name — only the ones whose contents actually moved, and it fails the commit if the script quietly stopped writing one. Use embed-command instead when the script owns only a marked block.
biome biome check --write — lint + format in one Rust binary, ~100x faster than eslint. Fixes are re-staged. --dir=web for a monorepo. Default types_or covers JS, TS, JSON, CSS; add files: for Svelte/Astro/Vue.
eslint eslint --fix, re-staged, --max-warnings=0 by default so warnings can't pile up forever. --dir=web for a monorepo.
tsc Type-checks the project, never bare filenames — given filenames, tsc silently ignores your tsconfig.json. --dir=web for a monorepo.
block-private-terms Blocks a commit that adds a line containing one of your own private terms — an employer, a client, an internal hostname. A secret scanner can't find these; they're ordinary words, sensitive only because of who typed them. The terms live outside the tree (see gag privacy), so nothing sensitive is committed to configure it. Unconfigured, it warns and passes.
zizmor Audits your GitHub Actions workflows with zizmor — the pull_request_target that checks out the PR head, the ${{ github.event.* }} interpolated straight into a run: block. Checks the workflows the commit touched, and brings its own zizmor. args: [--fix] if you want it to rewrite, and the rewrite is re-staged like every other fix here.
shellcheck Lints shell scripts with ShellCheck — the unquoted $var that splits on a path with a space, the cd with no || exit. Finds extensionless scripts by their shebang — once they're executable, since that's the only time pre-commit reads one — and brings its own shellcheck. Reports only, never rewrites: its fixes can change what a script does.
shfmt Formats shell scripts with shfmt, re-staged like ruff-format. No style flags means it follows your .editorconfig; or say it in args: [-i, '2', -ci]. Fails only on a script it can't parse. Pairs with shellcheck: one fixes layout, the other reports bugs.
vitest vitest run, never the watch mode a bare vitest starts — that hangs the commit with no clue why. Sets CI=true, so a missing snapshot fails instead of being written and committed. Runs on push, like pytest — same pre-push install requirement.

Anything in args is passed through to the underlying tool. Pin your own tool version with additional_dependencies: [ruff==0.16.1].

biome, eslint, tsc and vitest run from the repo root unless you pass --dir=. If your JS lives in a subdirectory, its biome.json, eslint.config.mjs, tsconfig.json and node_modules resolve from there, so name it — and scope the hooks to match, since files outside that subdirectory are skipped anyway:

      - id: biome
        args: [--dir=web]
        files: ^web/
      - id: tsc
        args: [--dir=web]
        files: ^web/
      - id: vitest
        args: [--dir=web]
        files: ^web/

--runner= means different things either side of that list. For biome, eslint and tsc it names only the package manager the tool is run through; for vitest, pytest and mypy it replaces the command outright, because npm test chooses its own test tool and appending vitest run to it would be wrong — write --runner=npm test -- --run in full.

The embed-* hooks and regen-file are the exception: their args configure the hook itself (--marker=, --command=, --file=, --depth=, --exit=). One entry per block, each with its own --marker; regen-file takes --file= once per file its script writes. In all three the command is only ever the one you wrote down — nothing is discovered and run on its own, and there is no shell, so && is an argument rather than a second command. Scope them with files: so a block that changes twice a year isn't regenerated on every commit.

Full details on any hook, including the paste-ready config block:

gag hooks           # one line per hook
gag hooks pytest    # that one, in full
gag hooks --all

2. The gag CLI

uv tool install git-a-grip    # `gag` on PATH
uvx --from git-a-grip gag …   # or one-off

gag --help lists everything; gag <command> --help its options.

gag audit — what does every repo pin?

Walks your project directories, stops at each git working tree, and reports which hooks each one uses and at what rev — labelled (behind), (ahead), (unpinned) against the version you have installed. Third-party hooks and repo: local one-offs are listed too.

gag audit
gag audit ~/projects ~/work
gag audit --json | jq '.repos[] | select(.hooks == [])'

gag sync — pin them all to one rev

The other half. Dry run by default, one line per repo (old -> new).

gag sync                    # dry run against the installed version
gag sync --write            # apply it
gag sync --to v0.5.0
gag sync --latest --write
gag sync --repo https://github.com/gitleaks/gitleaks --latest

The rewrite is textual and touches only the rev: line, so your comments and formatting survive. Nothing is committed — changes land in each repo's working tree for you to review.

Without --to or --latest the target is the version you have installed, which is only a stand-in for the current release. So that run also asks the source for its newest tag and warns on stderr when your install is behind it:

sync: installed v0.7.0, but v0.8.0 is the newest tag at <repo>.
      Re-run with --latest to pin v0.8.0 instead, or upgrade git-a-grip.

The plan is still printed — the warning says the target may not be the one you want, not that the answer is useless. An unreachable remote skips the check silently, so gag sync still works offline.

gag remote — what does GitHub say about every repo?

The same repos gag audit finds, seen from GitHub: one line each with the default branch, whether it is protected (classic, ruleset, or none), the CI outcome, when CI last ran and when anything was last pushed, open PRs and issues, and which security features are on.

Only repos with a commit in the last 90 days are checked; --all-repos includes the rest. Blank means nothing to report — zero, no CI, or GitHub declining to say (protection on a private repo on a free plan). Unprotected is spelled out as none, in red on a terminal, with failing CI; NO_COLOR turns colour off.

Where GitHub won't say, the repo's own config answers instead: a protect-branch (or upstream no-commit-to-branch) hook shows as pre-commit, or uninstalled if the git hook for its stage was never installed. Amber, not green — --no-verify and other machines walk past it.

Repos that will never need attention — a vendored fork, an archive — can be named in ~/.config/git-a-grip/remote-skip (honours XDG_CONFIG_HOME), one directory name per line, # for comments. They are dropped before any gh call, even with --all-repos, and the report counts them.

gag remote
gag remote --all-repos ~/projects ~/work
echo old-thing >> ~/.config/git-a-grip/remote-skip
gag remote --json | jq '.repos[] | select(.status.protection == "none")'

CI is the worst of each workflow's newest run on the default branch, so a fixed failure doesn't linger and a green release job can't mask a red test job. Everything goes through gh api — install gh and gh auth login first; there is no token handling in gag. Clones without a GitHub remote are listed as such.

gag privacy — the terms the block-private-terms hook blocks on

A secret scanner finds credentials. It cannot find the strings that are only sensitive because of who typed them — an employer, a client, an internal hostname, a relative's name. Those are yours, so they never live in the repo:

gag privacy                         # status, then pick an action
gag privacy add                     # prompts, echoing, so typos show
gag privacy add "acme corp"         # or as an argument, for scripts
gag privacy list                    # masked: `da******wn`
gag privacy list --reveal           # in full, when you mean it
gag privacy path                    # the file in use, for `$EDITOR "$(...)"`
gag privacy check some_file.py      # what the hook would flag, no commit
gag privacy check                   # or pick the file from the repo
gag privacy remove                  # pick from the terms you have
gag privacy remove "acme corp"

Anything it needs and wasn't given, it asks for — fzf when you have it, a numbered list when you don't (GAG_NO_FZF=1 forces the list). Every prompt has a flag that skips it, and an interactive run finishes by printing the one-liner you could have typed:

$ gag privacy remove
  1) acme corp
  2) dannybrown
remove: (numbers, comma-separated, blank to cancel) 1
Removed 1 from /home/you/.config/git-a-grip/privacy-terms

Next time, in one line:
  gag privacy remove 'acme corp'

Off a terminal nothing prompts: it names the argument that was missing and exits 2, so a CI job fails in a line instead of hanging until its timeout.

Terms are read from the first of these that exists: --terms-file=, $GAG_PRIVACY_TERMS_FILE, $XDG_CONFIG_HOME/git-a-grip/privacy-terms, then <repo>/.git/privacy-terms. The third is the one to use — one file, every repo on the machine covered. --repo writes to the fourth instead, for a term that belongs to one project and shouldn't follow you around; note that deleting that clone deletes the terms with it.

The file is line-delimited text, # comments allowed, and it is read literally — never sourced. gag privacy creates it 0600 in a 0700 directory and refuses to read one the rest of the machine can read: a terms file at 0644 leaves you believing you're covered while the terms sit in the open. A symlinked file is followed and judged at the far end, so keeping the real file in your dotfiles works.

Nothing here prints a term in full unless you ask. add reports a count, list masks, and the hook names the file and line but never the match — this output goes to scrollback and into CI logs.

gag hooks — the hook reference

The table above, in full, from your installed version. Colorized for the terminal, plain when piped. The block below is this repo's own embed-command hook keeping gag hooks output honest:

git-a-grip -- pre-commit hooks

Turn one on in .pre-commit-config.yaml:

repos:
  - repo: https://github.com/dannybrown37/git-a-grip
    rev: v0.16.1
    hooks:
      - id: <one of the below>
      - id: <...any number of others>

  biome                Lint and format with project's own Biome, re-staging fixes.
  block-private-terms  Block a commit adding one of your own private terms.
  commitizen-early     Reject a bad commit message before the slow hooks run.
  embed-command        Keep a command's output (`--help`) true in the README.
  embed-tree           Regenerate the README file tree, and re-stage it.
  eslint               Lint with the project's own eslint, re-staging fixes.
  mypy                 Type-check the project in its own environment.
  protect-branch       Refuse a push straight onto the default branch.
  pytest               Run the repo's tests through its own environment.
  regen-file           Run a generator script, and re-stage what it rewrote.
  ruff-check           Lint with `ruff check --fix`, re-staging what it fixed.
  ruff-format          Format with `ruff format`, re-staging what it rewrote.
  shellcheck           Lint shell scripts with shellcheck.
  shfmt                Format shell scripts with shfmt, re-staging what it rewrote.
  tsc                  Type-check the project with the project's own tsc.
  vitest               Run the project's vitest suite once, never in watch mode.
  zizmor               Audit GitHub Actions workflows for the mistakes that leak.

gag hooks <id> for one in full, gag hooks --all for all of them.

Running a hook by hand

The hooks aren't scripts on your PATH — gag is the only thing this package installs. To run one outside pre-commit (debugging):

uv tool install 'git-a-grip[hooks]'
python -m git_a_grip.hooks ruff-check path/to/file.py

Development

uv sync
uv run pytest

Releases are cut by CI: merge to main, and if lint, tests and the install proofs pass, cz bump tags it and publish.yml uploads to PyPI. Nothing is tagged before the checks pass.

This repo eats its own dog food — its hooks run on itself, and the tree below is maintained by embed-tree.

git-a-grip/
|-- .github/
|   |-- workflows/
|   |   |-- ci.yml
|   |   `-- publish.yml
|   `-- zizmor.yml
|-- src/
|   `-- git_a_grip/
|       |-- __init__.py
|       |-- audit.py
|       |-- cli.py
|       |-- commitizen_early.py
|       |-- cz.py
|       |-- doc_block.py
|       |-- embed_command.py
|       |-- embed_tree.py
|       |-- hook_docs.py
|       |-- hooks.py
|       |-- mypy_hook.py
|       |-- node_hooks.py
|       |-- pick.py
|       |-- privacy.py
|       |-- privacy_hook.py
|       |-- privacy_terms.py
|       |-- project_env.py
|       |-- protect_branch.py
|       |-- pytest_hook.py
|       |-- regen_file.py
|       |-- remote.py
|       |-- restage.py
|       |-- ruff_hooks.py
|       |-- shellcheck_hook.py
|       |-- shfmt_hook.py
|       |-- sync.py
|       |-- version.py
|       `-- zizmor_hook.py
|-- tests/
|   |-- test_audit.py
|   |-- test_cli.py
|   |-- test_commitizen_early.py
|   |-- test_doc_block.py
|   |-- test_embed_command.py
|   |-- test_embed_tree.py
|   |-- test_hook_docs.py
|   |-- test_hooks.py
|   |-- test_mypy_hook.py
|   |-- test_node_hooks.py
|   |-- test_packaging.py
|   |-- test_pick.py
|   |-- test_privacy.py
|   |-- test_privacy_hook.py
|   |-- test_privacy_terms.py
|   |-- test_project_env.py
|   |-- test_protect_branch.py
|   |-- test_pytest_hook.py
|   |-- test_regen_file.py
|   |-- test_remote.py
|   |-- test_restage.py
|   |-- test_ruff_hooks.py
|   |-- test_shellcheck_hook.py
|   |-- test_shfmt_hook.py
|   |-- test_sync.py
|   |-- test_version.py
|   `-- test_zizmor_hook.py
|-- .gitignore
|-- .pre-commit-config.yaml
|-- .pre-commit-hooks.yaml
|-- .ruff.toml
|-- CHANGELOG.md
|-- CLAUDE.md
|-- LICENSE
|-- pyproject.toml
|-- README.md
`-- uv.lock

Metadata

Release files for git-a-grip 0.16.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for git-a-grip 0.16.1
File Size Uploaded
git_a_grip-0.16.1.tar.gz 145.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for git-a-grip 0.16.1
File Interpreter ABI Platform
git_a_grip-0.16.1-py3-none-any.whl Python 3 none any Details

Total release size: 223.5 kB

Release files / git_a_grip-0.16.1.tar.gz

Download URL git_a_grip-0.16.1.tar.gz
Size 145.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6046e4f72187d74984b8d8616234ef2ca38068eb3b744d0ee597f09c85b966d1
BLAKE2b-256 checksum
How to use checksums
495c0e49ec0df9ab2bed474f88ee874e62826d3218e4b70785fec76cdf9ec2c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.

Transparency log

Release files / git_a_grip-0.16.1-py3-none-any.whl

Download URL git_a_grip-0.16.1-py3-none-any.whl
Size 78.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
37c7e264d08f70003bc19b335daadf904917db3f45dab22ae78f35f45d78abe5
BLAKE2b-256 checksum
How to use checksums
4f23d85eb06483dcc6ec1993df56608c07208a52de32c6e2ff046f69c45a4641
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.16.1 This release

2 release files

0.16.0

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.14.1

2 release files

0.14.0

2 release files

0.13.0

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.11.1

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page