cli/foundry.cli

Package-level declarations

Types

AppleSiliconCompat

object AppleSiliconCompat

CommandFactory

interface CommandFactory

Marker interface for a CliktCommand that can be aggregated and loaded via service loader.

Toml

object Toml

Functions

cleanLineFormatting

fun List<String>.cleanLineFormatting(): List<String>

dryRunOption

fun CliktCommand.dryRunOption(vararg names: String = arrayOf("--dry-run"), help: String = "Runs this as a dry run, no modifications."): OptionWithValues<Boolean, Boolean, Boolean>

A dry run option for clikt commands.

filterByExtension

fun Sequence<File>.filterByExtension(extension: String): Sequence<File>

@JvmName(name = "filterByExtensionPath")

fun Sequence<Path>.filterByExtension(extension: String): Sequence<Path>

Filters by a specific extension.

filterByName

fun Sequence<File>.filterByName(name: String, withoutExtension: Boolean = true): Sequence<File>

@JvmName(name = "filterByNamePath")

fun Sequence<Path>.filterByName(name: String, withoutExtension: Boolean = true): Sequence<Path>

Filters by a specific name.

main

fun main()

multipleSet

fun <EachT, ValueT> NullableOption<EachT, ValueT>.multipleSet(default: Set<EachT> = emptySet(), required: Boolean = false): OptionWithValues<Set<EachT>, EachT, ValueT>

Make the option return a set of calls; each item in the set is the value of one call.

projectDirOption

fun CliktCommand.projectDirOption(vararg names: String = arrayOf("--project-dir"), help: String = "The project directory. Defaults to the current working directory."): OptionDelegate<Path>

A project dir option for clikt commands.

runCommand

fun runCommand(args: List<String>, exitOnError: Boolean = true)

Primary entry point to run any command registered via CommandFactory. First argument should be the command key and remaining arguments are passed to the created CLI.

skipBuildAndCacheDirs

fun FileTreeWalk.skipBuildAndCacheDirs(): FileTreeWalk

@ExperimentalPathApi

fun FileVisitorBuilder.skipBuildAndCacheDirs()

Skips build and cache directories (starting with ., like .gradle) in FileTreeWalks.

walkEachFile

fun Path.walkEachFile(maxDepth: Int = Int.MAX_VALUE, followLinks: Boolean = false, builderAction: FileVisitorBuilder.() -> Unit = {}): Sequence<Path>