Skip to content

CredentialConfig

CredentialConfig = object

Defined in: src/core/types.ts:423

Credential configuration for Git authentication (§6.4)

Supports multiple authentication methods:

  1. Built-in helper (store, cache, manager-core)
  2. Custom helper binary
  3. Programmatic authentication (recommended)
  4. Static credentials (dev/test only)

Properties

fallback?

optional fallback: CredentialConfig

Defined in: src/core/types.ts:439

Fallback credential configuration


helper?

optional helper: "store" | "cache" | "manager-core" | string

Defined in: src/core/types.ts:425

Method 1: Built-in helper name


helperPath?

optional helperPath: string

Defined in: src/core/types.ts:428

Method 2: Custom helper binary path


onAuthFailure()?

optional onAuthFailure: (error, request) => void

Defined in: src/core/types.ts:442

Callback when authentication fails

Parameters

error

Error

request

CredentialRequest

Returns

void


password?

optional password: string

Defined in: src/core/types.ts:435


provider()?

optional provider: (request) => Promise<Credential>

Defined in: src/core/types.ts:431

Method 3: Programmatic authentication provider (recommended)

Parameters

request

CredentialRequest

Returns

Promise<Credential>


token?

optional token: string

Defined in: src/core/types.ts:436


username?

optional username: string

Defined in: src/core/types.ts:434

Method 4: Static credentials (dev/test only)