Skip to content

PullOpts

PullOpts = object

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

Options for git pull

Properties

all?

optional all: boolean

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

Fetch from all remotes


allowUnrelatedHistories?

optional allowUnrelatedHistories: boolean

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

Allow merging histories that do not share a common ancestor


append?

optional append: boolean

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

Append ref names and object names to FETCH_HEAD


autostash?

optional autostash: boolean

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

Automatically stash before pull and unstash after


branch?

optional branch: string

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

Branch to pull


cleanup?

optional cleanup: string

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

How to clean up the commit message


commit?

optional commit: boolean

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

Perform merge and commit (or not)


compactSummary?

optional compactSummary: boolean

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

Show compact summary of changed files


deepen?

optional deepen: number

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

Deepen shallow clone by specified commits


depth?

optional depth: number

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

Limit fetching depth


dryRun?

optional dryRun: boolean

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

Dry run


ff?

optional ff: "only" | "no" | boolean

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

Fast-forward behavior


force?

optional force: boolean

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

Force update of local branches


gpgSign?

optional gpgSign: boolean | string

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

GPG-sign the merge commit (optionally with key id)


ipv4?

optional ipv4: boolean

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

Use IPv4 addresses only


ipv6?

optional ipv6: boolean

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

Use IPv6 addresses only


jobs?

optional jobs: number

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

Number of parallel children for fetching submodules


keep?

optional keep: boolean

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

Keep downloaded pack


log?

optional log: boolean | number

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

Add log of commits being merged (optionally with count)


noStat?

optional noStat: boolean

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

Do not show diffstat at end of merge


onProgress()?

optional onProgress: (progress) => void

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

Progress callback

Parameters

progress

GitProgress

Returns

void


prune?

optional prune: boolean

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

Prune remote-tracking refs


quiet?

optional quiet: boolean

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

Be quiet


rebase?

optional rebase: boolean | "merges" | "interactive"

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

Rebase instead of merge


recurseSubmodules?

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

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

Fetch submodules recursively


remote?

optional remote: string

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

Remote name


setUpstream?

optional setUpstream: boolean

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

Set upstream tracking for the current branch


shallowExclude?

optional shallowExclude: string | string[]

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

Deepen shallow clone excluding revision


shallowSince?

optional shallowSince: string | Date

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

Deepen shallow clone since date


signoff?

optional signoff: boolean

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

Add Signed-off-by trailer


squash?

optional squash: boolean

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

Squash merge


stat?

optional stat: boolean

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

Show diffstat at end of merge


strategy?

optional strategy: string

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

Merge strategy to use


strategyOption?

optional strategyOption: string | string[]

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

Strategy options


tags?

optional tags: boolean

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

Fetch tags


unshallow?

optional unshallow: boolean

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

Convert shallow repository to complete one


updateShallow?

optional updateShallow: boolean

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

Update shallow boundary if new refs need it


verbose?

optional verbose: boolean

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

Be verbose


verify?

optional verify: boolean

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

Run hooks or not


verifySignatures?

optional verifySignatures: boolean

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

Verify that commit is signed with a valid key