CloneOpts

CloneOpts = object

Defined in: src/core/git.ts:19

Options for git clone

Properties

alsoFilterSubmodules?

optional alsoFilterSubmodules: boolean

Defined in: src/core/git.ts:78

Also apply the partial clone filter to submodules

---

bare?

optional bare: boolean

Defined in: src/core/git.ts:21

---

branch?

optional branch: string

Defined in: src/core/git.ts:23

---

cleanupOnAbort?

optional cleanupOnAbort: boolean

Defined in: src/core/git.ts:34

Whether to clean up the target directory if the operation is aborted.

Default

true

---

config?

optional config: Record<string, string>

Defined in: src/core/git.ts:70

Set config options for the new repository

---

depth?

optional depth: number

Defined in: src/core/git.ts:22

---

dissociate?

optional dissociate: boolean

Defined in: src/core/git.ts:58

Disconnect from reference repository after clone

---

filter?

optional filter: string

Defined in: src/core/git.ts:76

A partial clone filter specification (e.g., ‘blob:none’)

---

ipv4?

optional ipv4: boolean

Defined in: src/core/git.ts:72

Use IPv4 addresses only

---

ipv6?

optional ipv6: boolean

Defined in: src/core/git.ts:74

Use IPv6 addresses only

---

jobs?

optional jobs: number

Defined in: src/core/git.ts:50

Number of submodules to clone in parallel

---

local?

optional local: boolean

Defined in: src/core/git.ts:44

Clone from a local repository (use hard links)

---

mirror?

optional mirror: boolean

Defined in: src/core/git.ts:25

---

noCheckout?

optional noCheckout: boolean

Defined in: src/core/git.ts:26

---

noHardlinks?

optional noHardlinks: boolean

Defined in: src/core/git.ts:46

Don’t use hard links for local clone

---

noTags?

optional noTags: boolean

Defined in: src/core/git.ts:66

Don’t clone any tags, and make later fetches not follow them

---

origin?

optional origin: string

Defined in: src/core/git.ts:60

Name of the remote (default: origin)

---

quiet?

optional quiet: boolean

Defined in: src/core/git.ts:40

Operate quietly (suppress progress reporting)

---

recurseSubmodules?

optional recurseSubmodules: boolean

Defined in: src/core/git.ts:27

---

reference?

optional reference: string

Defined in: src/core/git.ts:54

Reference repository for object sharing

---

referenceIfAble?

optional referenceIfAble: string

Defined in: src/core/git.ts:56

Reference repository if available (no error if not)

---

rejectShallow?

optional rejectShallow: boolean

Defined in: src/core/git.ts:42

Reject cloning a shallow repository

---

remoteSubmodules?

optional remoteSubmodules: boolean

Defined in: src/core/git.ts:80

Clone submodules from their remote tracking branch

---

separateGitDir?

optional separateGitDir: string

Defined in: src/core/git.ts:29

Store .git directory at specified path instead of inside the repository

---

shallowExclude?

optional shallowExclude: string | string[]

Defined in: src/core/git.ts:64

Create a shallow clone excluding commits reachable from specified revision

---

shallowSince?

optional shallowSince: string | Date

Defined in: src/core/git.ts:62

Create a shallow clone with commits since the specified date

---

shallowSubmodules?

optional shallowSubmodules: boolean

Defined in: src/core/git.ts:68

Also clone submodules shallowly

---

shared?

optional shared: boolean

Defined in: src/core/git.ts:48

Share objects with a reference repository

---

singleBranch?

optional singleBranch: boolean

Defined in: src/core/git.ts:24

---

sparse?

optional sparse: boolean

Defined in: src/core/git.ts:82

Initialize sparse-checkout (clone only root files initially)

---

template?

optional template: string

Defined in: src/core/git.ts:52

Directory with templates for the new repository

---

verbose?

optional verbose: boolean

Defined in: src/core/git.ts:38

Be more verbose