Skip to content

FetchOpts

FetchOpts = object

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

Options for git fetch

Properties

all?

optional all: boolean

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

Fetch from all remotes


append?

optional append: boolean

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

Append ref names and object names of fetched refs to .git/FETCH_HEAD


atomic?

optional atomic: boolean

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

Use atomic transaction to update refs


deepen?

optional deepen: number

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

Deepen a shallow repository by specified number of commits


depth?

optional depth: number

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

Limit fetching to the specified number of commits


dryRun?

optional dryRun: boolean

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

Dry run - show what would be done without making changes


filter?

optional filter: string

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

Partial clone filter specification


force?

optional force: boolean

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

Force update of local branches


ipv4?

optional ipv4: boolean

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

Use IPv4 addresses only


ipv6?

optional ipv6: boolean

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

Use IPv6 addresses only


jobs?

optional jobs: number

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

Number of parallel children for fetching submodules


keep?

optional keep: boolean

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

Keep downloaded pack


multiple?

optional multiple: boolean

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

Allow fetching from multiple remotes


noTags?

optional noTags: boolean

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

Do not fetch any tags


prefetch?

optional prefetch: boolean

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

Modify the configured refspec to place all refs into refs/prefetch/


prune?

optional prune: boolean

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

Remove remote-tracking refs that no longer exist on the remote


pruneTags?

optional pruneTags: boolean

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

Also prune tags that are no longer on the remote


quiet?

optional quiet: boolean

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

Operate quietly (suppress progress reporting)


recurseSubmodules?

optional recurseSubmodules: boolean | "yes" | "on-demand" | "no"

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

Fetch submodules recursively


refetch?

optional refetch: boolean

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

Re-fetch all objects even if we already have them


refmap?

optional refmap: string

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

Override the default refspec


refspec?

optional refspec: string | string[]

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

Refspec(s) to fetch


remote?

optional remote: string

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

Remote name to fetch from


setUpstream?

optional setUpstream: boolean

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

Set upstream tracking for the fetched branches


shallowExclude?

optional shallowExclude: string | string[]

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

Deepen a shallow repository excluding specified revision


shallowSince?

optional shallowSince: string | Date

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

Deepen a shallow repository by date


showForcedUpdates?

optional showForcedUpdates: boolean

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

Check for forced updates


tags?

optional tags: boolean

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

Fetch all tags from the remote


unshallow?

optional unshallow: boolean

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

Convert a shallow repository to a complete one


updateHeadOk?

optional updateHeadOk: boolean

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

Allow updating the current branch head


updateShallow?

optional updateShallow: boolean

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

Update shallow boundary if new refs need it


verbose?

optional verbose: boolean

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

Be more verbose


writeCommitGraph?

optional writeCommitGraph: boolean

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

Write commit graph after fetching


writeFetchHead?

optional writeFetchHead: boolean

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

Allow updating FETCH_HEAD