RepoLfsInstallOpts

RepoLfsInstallOpts = object

Defined in: src/core/repo.ts:1754

Options for repository-level LFS install

Used with repo.lfs.install() for repository-local LFS configuration.

Remarks

Internally runs git lfs install --local by default, which writes to the repository’s .git/config file. This ensures LFS configuration is scoped to the current repository only.

For global (user-level) or system-wide installation, use git.lfs.install() instead.

Properties

force?

optional force: boolean

Defined in: src/core/repo.ts:1756

Overwrite existing hooks

---

skipSmudge?

optional skipSmudge: boolean

Defined in: src/core/repo.ts:1766

Skip smudge filter (don’t download during checkout)

---

worktree?

optional worktree: boolean

Defined in: src/core/repo.ts:1764

Install for worktree only (instead of repository)

Remarks

Internally uses --worktree flag instead of --local. Requires Git 2.20.0+ with worktreeConfig extension enabled.