---
url: https://relizy.dev/typedoc.md
---
# relizy

## Classes

* [RelizyCancelError](classes/RelizyCancelError.md)

## Interfaces

* [AIConfig](interfaces/AIConfig.md)
* [AIExtraGuidelines](interfaces/AIExtraGuidelines.md)
* [AiSdkProviderOptions](interfaces/AiSdkProviderOptions.md)
* [AISocialConfig](interfaces/AISocialConfig.md)
* [AITargetConfig](interfaces/AITargetConfig.md)
* [BumpConfig](interfaces/BumpConfig.md)
* [BumpOptions](interfaces/BumpOptions.md)
* [BumpResultFalsy](interfaces/BumpResultFalsy.md)
* [BumpResultTruthy](interfaces/BumpResultTruthy.md)
* [ChangelogConfig](interfaces/ChangelogConfig.md)
* [ChangelogOptions](interfaces/ChangelogOptions.md)
* [ClaudeCodeProviderOptions](interfaces/ClaudeCodeProviderOptions.md)
* [CommitlintBuiltInRules](interfaces/CommitlintBuiltInRules.md)
* [CommitlintCommit](interfaces/CommitlintCommit.md)
* [CommitlintConfig](interfaces/CommitlintConfig.md)
* [CommitlintCustomRuleContext](interfaces/CommitlintCustomRuleContext.md)
* [CommitlintOptions](interfaces/CommitlintOptions.md)
* [CommitlintProblem](interfaces/CommitlintProblem.md)
* [CommitlintReport](interfaces/CommitlintReport.md)
* [CommitlintResult](interfaces/CommitlintResult.md)
* [CommitlintRunResult](interfaces/CommitlintRunResult.md)
* [CommitlintSuggestion](interfaces/CommitlintSuggestion.md)
* [CommitlintSummary](interfaces/CommitlintSummary.md)
* [GitCommit](interfaces/GitCommit.md)
* [GitCommitAuthor](interfaces/GitCommitAuthor.md)
* [GroupBumpResult](interfaces/GroupBumpResult.md)
* [HookContext](interfaces/HookContext.md)
* [InstalledHook](interfaces/InstalledHook.md)
* [LintCommitMessageOptions](interfaces/LintCommitMessageOptions.md)
* [LoadRelizyConfigOptions](interfaces/LoadRelizyConfigOptions.md)
* [MonorepoConfig](interfaces/MonorepoConfig.md)
* [PackageBase](interfaces/PackageBase.md)
* [PostedRelease](interfaces/PostedRelease.md)
* [PrCommentConfig](interfaces/PrCommentConfig.md)
* [PrCommentOptions](interfaces/PrCommentOptions.md)
* [ProviderReleaseOptions](interfaces/ProviderReleaseOptions.md)
* [ProviderReleaseResult](interfaces/ProviderReleaseResult.md)
* [PublishConfig](interfaces/PublishConfig.md)
* [PublishOptions](interfaces/PublishOptions.md)
* [PublishResponse](interfaces/PublishResponse.md)
* [RawGitCommit](interfaces/RawGitCommit.md)
* [ReadPackage](interfaces/ReadPackage.md)
* [Reference](interfaces/Reference.md)
* [RegistryTarget](interfaces/RegistryTarget.md)
* [ReleaseAI](interfaces/ReleaseAI.md)
* [ReleaseConfig](interfaces/ReleaseConfig.md)
* [ReleaseContent](interfaces/ReleaseContent.md)
* [ReleaseContext](interfaces/ReleaseContext.md)
* [ReleaseGit](interfaces/ReleaseGit.md)
* [ReleaseLine](interfaces/ReleaseLine.md)
* [ReleaseOptions](interfaces/ReleaseOptions.md)
* [ReleaseOverview](interfaces/ReleaseOverview.md)
* [ReleaseOverviewGroup](interfaces/ReleaseOverviewGroup.md)
* [ReleaseOverviewPackage](interfaces/ReleaseOverviewPackage.md)
* [ReleasePublish](interfaces/ReleasePublish.md)
* [ReleaseReport](interfaces/ReleaseReport.md)
* [ReleaseReportConfig](interfaces/ReleaseReportConfig.md)
* [ReleaseStepReport](interfaces/ReleaseStepReport.md)
* [RelizyConfig](interfaces/RelizyConfig.md)
* [RepoConfig](interfaces/RepoConfig.md)
* [ReportEntry](interfaces/ReportEntry.md)
* [RootPackage](interfaces/RootPackage.md)
* [SlackCredentials](interfaces/SlackCredentials.md)
* [SlackOptions](interfaces/SlackOptions.md)
* [SlackPackageEntry](interfaces/SlackPackageEntry.md)
* [SlackReleaseSection](interfaces/SlackReleaseSection.md)
* [SlackSocialConfig](interfaces/SlackSocialConfig.md)
* [SocialAnnouncementContent](interfaces/SocialAnnouncementContent.md)
* [SocialAnnouncementVariables](interfaces/SocialAnnouncementVariables.md)
* [SocialConfig](interfaces/SocialConfig.md)
* [SocialExclude](interfaces/SocialExclude.md)
* [SocialLink](interfaces/SocialLink.md)
* [SocialNetworkResult](interfaces/SocialNetworkResult.md)
* [SocialOptions](interfaces/SocialOptions.md)
* [SocialResult](interfaces/SocialResult.md)
* [SocialTemplateVariables](interfaces/SocialTemplateVariables.md)
* [TeamsSocialConfig](interfaces/TeamsSocialConfig.md)
* [TemplatesConfig](interfaces/TemplatesConfig.md)
* [TokensConfig](interfaces/TokensConfig.md)
* [TweetSection](interfaces/TweetSection.md)
* [TwitterCredentials](interfaces/TwitterCredentials.md)
* [TwitterOptions](interfaces/TwitterOptions.md)
* [TwitterSocialConfig](interfaces/TwitterSocialConfig.md)
* [VersionGroup](interfaces/VersionGroup.md)
* [WorkspacePackage](interfaces/WorkspacePackage.md)

## Type Aliases

* [AIPromptTarget](type-aliases/AIPromptTarget.md)
* [AIProviderName](type-aliases/AIProviderName.md)
* [AISystemPromptOverrides](type-aliases/AISystemPromptOverrides.md)
* [BumpReleaseType](type-aliases/BumpReleaseType.md)
* [BumpResult](type-aliases/BumpResult.md)
* [CommitlintChangelogLinter](type-aliases/CommitlintChangelogLinter.md)
* [CommitlintCustomRule](type-aliases/CommitlintCustomRule.md)
* [CommitlintCustomRuleOutcome](type-aliases/CommitlintCustomRuleOutcome.md)
* [CommitlintRuleConfig](type-aliases/CommitlintRuleConfig.md)
* [CommitlintRuleLevel](type-aliases/CommitlintRuleLevel.md)
* [CommitlintRuleName](type-aliases/CommitlintRuleName.md)
* [CommitlintRulesConfig](type-aliases/CommitlintRulesConfig.md)
* [ConfigType](type-aliases/ConfigType.md)
* [GitProvider](type-aliases/GitProvider.md)
* [HookConfig](type-aliases/HookConfig.md)
* [HookStep](type-aliases/HookStep.md)
* [HookType](type-aliases/HookType.md)
* [OnRewrittenTag](type-aliases/OnRewrittenTag.md)
* [PackageManager](type-aliases/PackageManager.md)
* [PrCommentMode](type-aliases/PrCommentMode.md)
* [PrCommentStatus](type-aliases/PrCommentStatus.md)
* [PrivatePackages](type-aliases/PrivatePackages.md)
* [ReleaseStepName](type-aliases/ReleaseStepName.md)
* [RelizyConfigOverrides](type-aliases/RelizyConfigOverrides.md)
* [RelizyLogLevel](type-aliases/RelizyLogLevel.md)
* [ResolvedConfig](type-aliases/ResolvedConfig.md)
* [ResolvedRelizyConfig](type-aliases/ResolvedRelizyConfig.md)
* [SemverBumpType](type-aliases/SemverBumpType.md)
* [SlackChangelogFormat](type-aliases/SlackChangelogFormat.md)
* [SocialAnnouncement](type-aliases/SocialAnnouncement.md)
* [SocialChangelog](type-aliases/SocialChangelog.md)
* [TeamsCardsMode](type-aliases/TeamsCardsMode.md)
* [VersionMode](type-aliases/VersionMode.md)

## Functions

* [bump](functions/bump.md)
* [changelog](functions/changelog.md)
* [commitlint](functions/commitlint.md)
* [defineConfig](functions/defineConfig.md)
* [isRelizyCancelError](functions/isRelizyCancelError.md)
* [lintCommitMessage](functions/lintCommitMessage.md)
* [loadRelizyConfig](functions/loadRelizyConfig.md)
* [prComment](functions/prComment.md)
* [providerRelease](functions/providerRelease.md)
* [publish](functions/publish.md)
* [release](functions/release.md)
* [social](functions/social.md)