depanalyzer/com.depanalyzer.cli

Package-level declarations

Types

class Analyze(analyzeExecutor: (AnalyzeExecutionRequest) -> DependencyReport = ::defaultAnalyzeExecutor, jsonOutputPathProvider: (Path) -> Path = ::defaultJsonOutputPathProvider, terminalCapabilitiesDetector: TerminalCapabilitiesDetector = TerminalCapabilitiesDetector(), tuiRunner: (TuiLaunchConfig, TerminalCapabilities) -> DependencyReport? = ::defaultTuiRunner) : BaseAnalyzeCommand

AnalyzeExecutionRequest

data class AnalyzeExecutionRequest(val projectPath: Path, val includeChains: Boolean, val disableMaven: Boolean, val disableGradle: Boolean, val verbose: Boolean, val treeMaxDepth: Int?, val treeExpandMode: TreeExpandMode, val timeoutSeconds: Long, val vulnerabilitySourceMode: VulnerabilitySourceMode, val showCommandOutput: Boolean = false, val ossIndexToken: String?, val nvdApiKey: String?, val onPartialReport: (DependencyReport) -> Unit? = null)

BaseAnalyzeCommand

abstract class BaseAnalyzeCommand(commandName: String, forceTui: Boolean, analyzeExecutor: (AnalyzeExecutionRequest) -> DependencyReport, jsonOutputPathProvider: (Path) -> Path, terminalCapabilitiesDetector: TerminalCapabilitiesDetector, tuiRunner: (TuiLaunchConfig, TerminalCapabilities) -> DependencyReport?) : CliktCommand

Capabilities

class Capabilities : CliktCommand

CapabilityDocument

data class CapabilityDocument(val cliVersion: String = BuildInfo.VERSION, val reportSchemas: List<String> = listOf("1.0", "1.1", "1.2", "1.3"), val features: Map<String, Boolean> = linkedMapOf( "analyze.outputFile" to true, "analyze.stdout" to true, "analyze.progressJson" to true, "report.dependencyTree" to true, "report.vulnerabilityChains" to true, "update.plan" to true, "update.applyById" to true, "update.reportFile" to true, "update.planFile" to true, "update.applyResultJson" to true, "update.progressJson" to true, "update.lockfileSync" to true ))

Depanalyzer

class Depanalyzer : CliktCommand

ProgressEvent

data class ProgressEvent(val type: String, val message: String, val phase: String? = null, val current: Int? = null, val total: Int? = null, val timestamp: Instant = Instant.now())

ProgressTracker

object ProgressTracker

Tui

class Tui(analyzeExecutor: (AnalyzeExecutionRequest) -> DependencyReport = ::defaultAnalyzeExecutor, jsonOutputPathProvider: (Path) -> Path = ::defaultJsonOutputPathProvider, terminalCapabilitiesDetector: TerminalCapabilitiesDetector = TerminalCapabilitiesDetector(), tuiRunner: (TuiLaunchConfig, TerminalCapabilities) -> DependencyReport? = ::defaultTuiRunner) : BaseAnalyzeCommand

TuiLaunchConfig

data class TuiLaunchConfig(val initialStatus: String, val progressHint: String? = null, val scanProvider: ((DependencyReport) -> Unit) -> DependencyReport, val initialReport: DependencyReport? = null, val applyUpdates: (List<UpdateSuggestion>) -> List<UpdateResult>? = null)

Update

class Update(plannerFactory: (String?) -> UpdatePlanner = { token -> AnalyzerUpdatePlanner( analyzer = ProjectAnalyzer(ossIndexClient = OssIndexClient(token = token)) ) }, updaterFactory: (ProjectType) -> BuildFileUpdater = { type -> when (type) { ProjectType.MAVEN -> PomBuildFileUpdater() ProjectType.GRADLE_GROOVY -> GradleGroovyBuildFileUpdater() ProjectType.GRADLE_KOTLIN -> GradleKotlinBuildFileUpdater() ProjectType.NPM -> NpmPackageJsonBuildFileUpdater() ProjectType.PYTHON_POETRY -> PyprojectBuildFileUpdater() ProjectType.PYTHON_REQUIREMENTS -> RequirementsBuildFileUpdater() } }, selectionProvider: (Terminal, List<UpdateSuggestion>) -> Set<UpdateSuggestion> = ::defaultSelectionProvider) : CliktCommand

VulnerabilitySourceMode

enum VulnerabilitySourceMode : Enum<VulnerabilitySourceMode>

Functions

main

fun main(args: Array<String>)