Skip to main content

gate-cache

Skip a command that already passed on the same code.

A lint or test command often runs many times on code that did not change. It runs when you finish the work, in a pre-commit hook, after a rebase that changed nothing, and in a pre-push hook. When an agent works in the repository, it runs the same command again. If the command takes minutes, the repeat runs take most of the time between finished code and a pushed branch.

gate-cache remembers which commands passed on which code. It wraps a command and gives it a name. When the command passes, gate-cache writes a marker for that name and for the exact content of the tracked files. The next time the same name runs on the same content, gate-cache finds the marker, skips the command, and exits 0 at once.

$ gate-cache --name pytest -- uv run pytest
============================= 412 passed in 94.20s =============================

$ gate-cache --name pytest -- uv run pytest
gate-cache: pytest already passed on tree aaff74984ccc, skipping

A change to a tracked file changes the content, so no marker matches and the command runs again. A CI runner that starts from a fresh clone has no markers, so it runs every command.

Install

gate-cache requires Python 3.11 or later, on macOS or Linux.

uv tool install gate-cache

The prek and pre-commit hooks install gate-cache themselves, so the hooks work without this step.

Run a command through gate-cache

The name goes after --name, and the command goes after --:

gate-cache --name pytest -- uv run pytest
gate-cache --name ruff -- uv run ruff check .

Each name has its own markers. A command run under one name never skips because of a marker for another name.

gate-cache exits with the exit code of the command, or with 0 when it skips the command. It writes a marker only when the command passes, so a command that failed runs again the next time.

When the working copy has uncommitted edits or files that git does not track, the content on disk is not a commit-ready snapshot. gate-cache then runs the command and writes no marker.

Run it as a hook

gate-cache works with prek and with pre-commit 3.2 or later. Each gate-cache hook takes the same arguments as the command line:

repos:
  - repo: https://github.com/natelandau/gate-cache
    rev: v0.1.0
    hooks:
      - id: gate-cache
        name: pytest
        args: [--name, pytest, --, uv, run, pytest]
        files: ^(src/|tests/)
      - id: gate-cache
        name: ruff
        args: [--name, ruff, --, uv, run, ruff, check, .]

The hook runs at commit time and at push time. At commit time, gate-cache matches the content that you commit.

The hook runs in its own virtual environment, and the wrapped command inherits that environment. A command started with uv run, or a project command such as just test, runs in the project environment. uv run prints a warning that VIRTUAL_ENV does not match the project. The warning has no effect on the run.

Hooks, agents, and your terminal all read and write the same markers. When one of them runs gate-cache --name pytest -- uv run pytest and it passes, the others skip that name on the same content.

Examples

These examples show gate-cache inside the task runner of a project. When a recipe holds the wrapped command, everything that runs the recipe uses the same name and the same markers.

justfile

test:
    gate-cache --name test -- uv run pytest

lint:
    gate-cache --name lint -- uv run ruff check .

After just test passes, the next just test on the same content skips pytest.

Recipes with arguments

gate-cache identifies a command by its name alone, not by its arguments. If just test -k unit and just test ran under the same name, a pass of the unit tests would also skip the full suite. Giving each set of arguments its own name, or caching only the bare form, keeps the two apart.

This recipe caches just test and runs just test -k unit without the cache:

test *args:
    #!/usr/bin/env bash
    set -euo pipefail
    if [[ -z "{{ args }}" ]]; then
        exec gate-cache --name test -- uv run pytest
    fi
    exec uv run pytest {{ args }}

Makefile

test:
	gate-cache --name test -- uv run pytest

lint:
	gate-cache --name lint -- uv run ruff check .

A hook that calls the recipe

A local hook can run the recipe instead of the gate-cache hook repository:

repos:
  - repo: local
    hooks:
      - id: test
        name: test
        entry: just test
        language: system
        pass_filenames: false
        stages: [pre-commit, pre-push]

With this hook, a commit, a push, an agent, and your terminal all run just test and share its markers. The recipe runs in the project environment, so uv run prints no VIRTUAL_ENV warning. This form needs gate-cache and just on the PATH.

CI

gate-cache turns off caching when the CI variable is on. A variable is on when its value is not empty, 0, or false. Case and spaces around the value do not matter. Many CI systems set CI=true in every job, for example GitHub Actions and GitLab CI/CD. Jenkins does not set CI.

When caching is off, gate-cache runs the command each time and writes no marker.

GATE_CACHE_DISABLE overrides CI. To keep caching on when CI is on, set GATE_CACHE_DISABLE to 0 or false:

GATE_CACHE_DISABLE=0 just test

To turn off caching when CI is not set, set GATE_CACHE_DISABLE to 1:

GATE_CACHE_DISABLE=1 just test

See what already passed

gate-cache status lists the names that passed on the current content, and the names that ran on it without a pass:

$ gate-cache status
  tree:   aaff74984cccd156a469afa7d9ab10e4777beb24
  passed: pytest
  missed: ruff (exit code 1)

A name is missed when its command failed, or when it exited 0 but changed the files. A later pass of the same name removes it from the missed line.

With --name, it reports on one name:

$ gate-cache status --name ruff
  name:     ruff
  tree:     aaff74984cccd156a469afa7d9ab10e4777beb24
  marker:   /path/to/repo/.git/gate-cache/7d94ca2f57ec0a77f60d328fb405d339fb0c2a645991b97c042ac54403104e9e
  result:   miss
  last run: exit code 1

The last run line shows only when the name ran on this content without a pass.

status runs nothing. With --name, it exits 0 when a marker matches and 1 when none does. Without --name, it exits 0 when at least one name passed. When gate-cache cannot match the content, for example because of uncommitted edits, the tree line gives the reason.

With --json, status writes one JSON object to stdout instead of text. The exit codes do not change:

$ gate-cache status --json
{
  "enabled": true,
  "tree": "aaff74984cccd156a469afa7d9ab10e4777beb24",
  "reason": null,
  "passed": ["pytest"],
  "missed": [
    {"name": "ruff", "exit_code": 1, "reason": "exit code 1", "timestamp": "2026-10-12T12:31:55Z"}
  ]
}

reason tells why gate-cache cannot match the content, and is null when it can. When caching is off, enabled is false and reason names the variable. With --name, the object has the name, marker, result, and last_run keys in place of passed and missed.

Start fresh

A marker records only the content of the tracked files. A new tool version, a changed environment variable, or a change to a service does not change that content, so the old markers still match.

gate-cache clear deletes every marker for the repository, and the records of missed runs:

$ gate-cache clear
gate-cache: removed 3 markers

GATE_CACHE_DISABLE=1 runs every command without the cache, for one command or for a whole session:

GATE_CACHE_DISABLE=1 git push

Settings

Three environment variables control gate-cache.

Variable Effect Default
GATE_CACHE_DISABLE If on, turns off caching. If 0 or false, keeps caching on when CI is on. not set
CI If on, turns off caching. A value in GATE_CACHE_DISABLE overrides it. not set
GATE_CACHE_MAX_AGE_DAYS gate-cache deletes markers older than this number of days. 30

A variable is on when its value is not empty, 0, or false. Case and spaces around the value do not matter.

Each marker is one small file in the .git directory of the repository, so all worktrees of the repository share the markers.

Learn more

  • How gate-cache works describes the exact rules for a skip, what a marker covers, and the marker format for tools that read markers directly.
  • gate-cache --help gives the full command reference.

Metadata

Release files for gate-cache 0.3.0

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

Source distribution (sdist)

Source distribution for gate-cache 0.3.0
File Size Uploaded
gate_cache-0.3.0.tar.gz 18.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gate-cache 0.3.0
File Interpreter ABI Platform
gate_cache-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 37.0 kB

Release files / gate_cache-0.3.0.tar.gz

Download URL gate_cache-0.3.0.tar.gz
Size 18.4 kB
Tags Source
SHA-256 checksum
How to use checksums
c7b1acc1be04b4cffde4591256b4b35cd80f4cd082ff118932735825c3cfbff2
BLAKE2b-256 checksum
How to use checksums
83bab48b84fda5ecaf94065f52f3bd214c69ed760f4fc5354eddbbd2dade4c92
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / gate_cache-0.3.0-py3-none-any.whl

Download URL gate_cache-0.3.0-py3-none-any.whl
Size 18.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0856f7269323a3ab709c87d0f509edc4b7408f8ff7233f83a02b2b18851a5e9b
BLAKE2b-256 checksum
How to use checksums
e136dbaa976102ca5481160f01e87dbe19111ffcf1952ea2e1cbf6b03681db20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.4.0

2 release files

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.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