Skip to content

PromptScript API


Interface: GitRegistryOptions

Defined in: resolver/src/git-registry.ts:95

Options for GitRegistry.

Properties

auth?

optional auth?: GitAuthOptions

Defined in: resolver/src/git-registry.ts:111

Authentication options


cache?

optional cache?: object

Defined in: resolver/src/git-registry.ts:113

Cache configuration

enabled?

optional enabled?: boolean

Whether caching is enabled. Defaults to true

ttl?

optional ttl?: number

Cache TTL in milliseconds. Defaults to 1 hour


cacheDir?

optional cacheDir?: string

Defined in: resolver/src/git-registry.ts:109

Cache directory override


fallbackUrl?

optional fallbackUrl?: string

Defined in: resolver/src/git-registry.ts:103

Fallback Git URL to try when the primary url fails with an auth error. Useful when the registry references an HTTPS URL but the user authenticates via SSH (or vice versa).


path?

optional path?: string

Defined in: resolver/src/git-registry.ts:107

Subdirectory within the repository to use as registry root


ref?

optional ref?: string

Defined in: resolver/src/git-registry.ts:105

Git ref to checkout (branch/tag/commit). Defaults to 'main'


timeout?

optional timeout?: number

Defined in: resolver/src/git-registry.ts:120

Request timeout in milliseconds for Git operations. Defaults to 60000 (1 minute)


url

url: string

Defined in: resolver/src/git-registry.ts:97

Git repository URL