Skip to content

relizy / AIConfig

Interface: AIConfig

Defined in: src/types.ts:780

Properties

extraGuidelines?

optional extraGuidelines?: string

Defined in: src/types.ts:808

Extra directives appended to every built-in system prompt.

Example

ts
'Always use emojis in the changelog'

fallback?

optional fallback?: "raw" | "fail"

Defined in: src/types.ts:803

Behavior when the provider call fails.

  • raw: fall back to the unmodified changelog body.
  • fail: re-throw the error.

Default

ts
'raw'

language?

optional language?: string

Defined in: src/types.ts:796

Output language (ISO 639-1 code or plain English name).

Default

ts
'en'

provider?

optional provider?: "claude-code"

Defined in: src/types.ts:785

AI provider name

Default

ts
'claude-code'

providerRelease?

optional providerRelease?: AITargetConfig

Defined in: src/types.ts:817

Enable AI rewriting for GitHub/GitLab release notes.


providers?

optional providers?: object

Defined in: src/types.ts:789

Provider-specific options, keyed by provider name.

claude-code?

optional claude-code?: ClaudeCodeProviderOptions


social?

optional social?: AISocialConfig

Defined in: src/types.ts:821

Enable AI rewriting for social media posts.


systemPromptOverrides?

optional systemPromptOverrides?: Partial<Record<AIPromptTarget, string>>

Defined in: src/types.ts:813

Full replacement of the built-in system prompts. When set, the extraGuidelines and base prompts are ignored for that target.

Released under the MIT License.