LfsMode

LfsMode = "enabled" | "disabled" | { skipDownload?: boolean; skipSmudge?: boolean; }

Defined in: src/core/types.ts:314

LFS mode configuration.

• 'enabled' (default): LFS behaves normally.
• 'disabled': the repo.lfs.* / repo.lfsExtra.* helpers become no-ops.
• object form: working-tree-populating operations (checkout, switch, reset, merge, pull, rebase, restore) run with GIT_LFS_SKIP_SMUDGE=1 so Git leaves LFS pointer files in place instead of downloading their contents. The objects can be materialized later via the explicit repo.lfs.pull() / repo.lfs.checkout() helpers.

Type Declaration

"enabled"

"disabled"

{ skipDownload?: boolean; skipSmudge?: boolean; }

skipDownload?

optional skipDownload: boolean

Skip download, keeping pointer files (also implies skip-smudge).

skipSmudge?

optional skipSmudge: boolean

Skip smudge filter (don’t download LFS files on checkout).