Mantle API Reference
Secret detection and log sanitization for CI/CD pipelines.Classes
- AggregateMantleError
- ArtifactManager
- BatchProfiler
- CircuitBreaker
- CircuitOpenError
- ConfigurationError
- ErrorCollector
- LRUCache
- PatternCompilationError
- Profiler
- ProviderError
- RateLimiter
- Redactor
- SecretResolver
- MantleError
- TieredCache
- TimeoutError
- Timer
- UnsafePatternError
Interfaces
- AllowlistConfig
- AllowlistEntry
- ArtifactInfo
- ArtifactOptions
- AuditEntry
- AwsSecretsManagerOptions
- Baseline
- BaselineDiff
- BaselineFinding
- BaselineVersion
- BatchMetrics
- CacheMetrics
- CIConfig
- CIDefaultConfig
- CIEnvironment
- CircuitBreakerOptions
- CircuitBreakerStats
- CustomPattern
- DetectionConfig
- DotenvProviderOptions
- EnvironmentConfig
- EnvironmentProviderOptions
- ErrorContext
- ExcludeConfig
- ExitCodeConfig
- Finding
- FormatterOptions
- JobResult
- LRUCacheOptions
- MemoizeOptions
- MemorySnapshot
- OperationStats
- OutputConfig
- PathExclusion
- PatternOverride
- PipelineContext
- ProfileReport
- ProfilerOptions
- ProfileSummary
- RedactorOptions
- ResilientOptions
- ResolvedSecrets
- ResolverConfig
- RetryOptions
- RetryResult
- ScanMetadata
- ScanResult
- ScanSummary
- SecretMatch
- SecretMetadata
- SerializedError
- MantleConfig
- StepResult
- ThrottleOptions
- TimingMetrics
Functions
- addToBaseline
- applyEnvironmentDefaults
- calculateThroughput
- clearPatternCache
- compareBaselines
- completePipeline
- createDefaultConfig
- createEmptyBaseline
- createGitHubAnnotation
- createPipelineContext
- detectCIEnvironment
- detectEnvironment
- determineExitCode
- disableProfiling
- enableProfiling
- format
- formatBytes
- formatCSV
- formatDuration
- formatGitHub
- formatGitLab
- formatJSON
- formatJUnit
- formatMarkdown
- formatSARIF
- formatText
- formatXML
- generateDiffReport
- generateFindingHash
- generateHtmlReport
- generatePipelineSummary
- getAllCircuitBreakerStats
- getBaselineStats
- getCIDefaults
- getCircuitBreaker
- getEffectiveAllowlist
- getEffectiveExclusions
- getEffectivePatterns
- getEnvironmentDescription
- getEnvironmentMetadata
- getExcludedPatternNames
- getExclusionGlobs
- getExitCodeConfig
- getExitCodeDescription
- getFindingHistory
- getFormatDescription
- getGlobalProfiler
- getPatternCache
- getPatternCacheMetrics
- getRecommendedOutputFormats
- getRetryDelay
- getSupportedFormats
- gitLabSection
- hrTimeMs
- ignoreFinding
- isInBaseline
- isInitialized
- isProfilingEnabled
- isRetryableError
- isMantleError
- jobResultToScanResult
- loadBaseline
- loadConfig
- markFalsePositive
- memoize
- memoizeAsync
- patternCacheKey
- profiled
- pruneBaseline
- resetAllCircuitBreakers
- resolveFinding
- saveBaseline
- saveConfig
- setGitHubEnv
- setGitHubOutput
- shouldExcludeFinding
- shouldIgnoreFinding
- supportsFeature
- syncBaseline
- throttle
- timeAsync
- timeSync
- updateFindingStatus
- validateConfig
- withResilience
- withRetry
- withTimeout
- wrapError
- writeGitHubSummary
- writeGitLabCodeQuality
Type Aliases
- CIProvider
- CircuitState
- ConfigOutputFormat
- DetectionSignal
- ErrorCode
- ExitCode
- FindingSeverity
- FindingStatus
- OutputFormat
- ProtectionMode
- ProviderSource
- Scope
- Severity