Skip to main content
Dotset CLI API Documentation / index / MantleConfig

Interface: MantleConfig

Defined in: src/mantle/config.ts:169 Mantle configuration

Properties

allowlist?

optional allowlist: AllowlistConfig[];
Defined in: src/mantle/config.ts:215 Values to allow (not flag as secrets)

ci?

optional ci: CIConfig;
Defined in: src/mantle/config.ts:245 CI/CD integration configuration

cloudProjectId?

optional cloudProjectId: string;
Defined in: src/mantle/config.ts:177 Cloud project ID (set after linking)

defaultScope

defaultScope: Scope;
Defined in: src/mantle/config.ts:186 Default scope for providers

detection?

optional detection: DetectionConfig;
Defined in: src/mantle/config.ts:231 Detection configuration

disabledPatterns?

optional disabledPatterns: string[];
Defined in: src/mantle/config.ts:208 Patterns to disable entirely (by name)

envPrefixes?

optional envPrefixes: string[];
Defined in: src/mantle/config.ts:282 Environment variable prefixes to track

exclude?

optional exclude: ExcludeConfig;
Defined in: src/mantle/config.ts:224 Unified exclusion configuration

excludeExtensions?

optional excludeExtensions: string[];
Defined in: src/mantle/config.ts:221 File extensions to exclude

excludePaths?

optional excludePaths: PathExclusion[];
Defined in: src/mantle/config.ts:218 Paths to exclude from scanning

failFast

failFast: boolean;
Defined in: src/mantle/config.ts:195 Whether to fail fast on CI errors

mode

mode: ProtectionMode;
Defined in: src/mantle/config.ts:180 Default protection mode

notifications?

optional notifications: {
  defaultTriggers?: string[];
  enabled?: boolean;
  webhooks?: {
     headers?: Record<string, string>;
     includeDetails?: boolean;
     maxFindings?: number;
     on?: string[];
     type?: string;
     url: string;
  }[];
};
Defined in: src/mantle/config.ts:252 Webhook notification configuration

defaultTriggers?

optional defaultTriggers: string[];
Default triggers if not specified per webhook

enabled?

optional enabled: boolean;
Enable notifications

webhooks?

optional webhooks: {
  headers?: Record<string, string>;
  includeDetails?: boolean;
  maxFindings?: number;
  on?: string[];
  type?: string;
  url: string;
}[];
Webhook configurations

output?

optional output: OutputConfig;
Defined in: src/mantle/config.ts:238 Output configuration

patternOverrides?

optional patternOverrides: PatternOverride[];
Defined in: src/mantle/config.ts:205 Built-in pattern overrides

patterns?

optional patterns: CustomPattern[];
Defined in: src/mantle/config.ts:202 Custom patterns to add

projectName?

optional projectName: string;
Defined in: src/mantle/config.ts:174 Project name

providers?

optional providers: ("auto" | "dotenv" | "environment" | "aws-sm")[];
Defined in: src/mantle/config.ts:279 Default providers to use

redactText

redactText: string;
Defined in: src/mantle/config.ts:183 Text to use when redacting secrets

shell

shell: string;
Defined in: src/mantle/config.ts:189 Shell to use for CI commands

stepTimeout

stepTimeout: number;
Defined in: src/mantle/config.ts:192 Step timeout in milliseconds

version

version: string;
Defined in: src/mantle/config.ts:171 Manifest format version