LfsOperations

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

LFS operations

Wraps: git lfs subcommands

Methods

checkout()

checkout(patterns?, opts?): Promise<void>

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

Checkout LFS files (replace pointer files with actual content)

Wraps: git lfs checkout

Parameters

patterns?

string | string[]

opts?

LfsCheckoutOpts & ExecOpts

Returns

Promise<void>

---

env()

env(opts?): Promise<LfsEnvInfo>

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

Get LFS environment information

Wraps: git lfs env

Parameters

opts?

ExecOpts

Returns

Promise<LfsEnvInfo>

---

fetch()

fetch(opts?): Promise<void>

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

Fetch LFS objects from remote

Wraps: git lfs fetch

Parameters

opts?

LfsFetchOpts & ExecOpts

Returns

Promise<void>

---

install()

install(opts?): Promise<void>

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

Install Git LFS hooks for this repository

Wraps: git lfs install --local

Installs LFS hooks to the repository’s .git/config file. This ensures LFS configuration is scoped to this repository only.

Parameters

opts?

RepoLfsInstallOpts & ExecOpts

Returns

Promise<void>

Remarks

Internally always adds --local flag (or --worktree if specified). For global or system-wide installation, use git.lfs.install() instead.

Example

// Install LFS locally for this repository
await repo.lfs.install();

// Install for worktree only (Git 2.20.0+)
await repo.lfs.install({ worktree: true });

---

lock()

lock(path, opts?): Promise<LfsLockEntry>

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

Lock a file

Wraps: git lfs lock <path>

Parameters

path

string

opts?

LfsLockOpts & ExecOpts

Returns

Promise<LfsLockEntry>

---

locks()

locks(opts?): Promise<LfsLockEntry[]>

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

List locked files

Wraps: git lfs locks

Parameters

opts?

LfsLocksOpts & ExecOpts

Returns

Promise<LfsLockEntry[]>

---

lsFiles()

lsFiles(opts?): Promise<LfsFileEntry[]>

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

List LFS files in the repository

Wraps: git lfs ls-files

Parameters

opts?

LfsLsFilesOpts & ExecOpts

Returns

Promise<LfsFileEntry[]>

---

migrateExport()

migrateExport(opts?): Promise<void>

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

Export files from LFS

Wraps: git lfs migrate export

Parameters

opts?

LfsMigrateInfoOpts & object & ExecOpts

Returns

Promise<void>

---

migrateImport()

migrateImport(opts?): Promise<void>

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

Import files into LFS

Wraps: git lfs migrate import

Parameters

opts?

LfsMigrateInfoOpts & object & ExecOpts

Returns

Promise<void>

---

migrateInfo()

migrateInfo(opts?): Promise<string>

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

Show information about LFS files that would be migrated

Wraps: git lfs migrate info

Parameters

opts?

LfsMigrateInfoOpts & ExecOpts

Returns

Promise<string>

---

prune()

prune(opts?): Promise<void>

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

Prune old and unreferenced LFS objects from local storage

Wraps: git lfs prune

Parameters

opts?

LfsPruneOpts & ExecOpts

Returns

Promise<void>

---

pull()

pull(opts?): Promise<void>

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

Pull LFS objects

Wraps: git lfs pull

Parameters

opts?

LfsPullOpts & ExecOpts

Returns

Promise<void>

---

push()

push(opts?): Promise<void>

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

Push LFS objects

Wraps: git lfs push

Parameters

opts?

LfsPushOpts & ExecOpts

Returns

Promise<void>

---

status()

status(opts?): Promise<LfsStatus>

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

Get LFS status

Wraps: git lfs status

Parameters

opts?

LfsStatusOpts & ExecOpts

Returns

Promise<LfsStatus>

---

track()

track(patterns, opts?): Promise<void>

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

Track files with LFS

Wraps: git lfs track <pattern>...

Parameters

patterns

string | string[]

opts?

LfsTrackOpts & ExecOpts

Returns

Promise<void>

---

trackList()

trackList(opts?): Promise<LfsTrackEntry[]>

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

List tracked patterns

Wraps: git lfs track (without arguments)

Parameters

opts?

ExecOpts

Returns

Promise<LfsTrackEntry[]>

---

uninstall()

uninstall(opts?): Promise<void>

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

Uninstall Git LFS hooks from this repository

Wraps: git lfs uninstall --local

Removes LFS hooks from the repository’s .git/config file.

Parameters

opts?

RepoLfsUninstallOpts & ExecOpts

Returns

Promise<void>

Remarks

Internally always adds --local flag (or --worktree if specified). For global or system-wide uninstallation, use git.lfs.uninstall() instead.

Example

// Uninstall LFS from this repository
await repo.lfs.uninstall();

---

unlock()

unlock(pathOrId, opts?): Promise<void>

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

Unlock a file

Wraps: git lfs unlock <path>

Parameters

pathOrId

string

opts?

LfsUnlockOpts & ExecOpts

Returns

Promise<void>

---

untrack()

untrack(patterns, opts?): Promise<void>

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

Untrack files from LFS

Wraps: git lfs untrack <pattern>...

Parameters

patterns

string | string[]

opts?

ExecOpts

Returns

Promise<void>

---

version()

version(opts?): Promise<string>

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

Get Git LFS version

Wraps: git lfs version

Parameters

opts?

ExecOpts

Returns

Promise<string>