CliCommand

class Object
trait Matchable
class Any

Value members

Abstract methods

The name of the command

The name of the command

def helpMsg(using settings: ConcreteSettings)(using SettingsState, Context): String
def isHelpFlag(using settings: ConcreteSettings)(using SettingsState): Boolean

Concrete methods

protected
def availableOptionsMsg(cond: Setting[_] => Boolean)(using settings: ConcreteSettings)(using SettingsState): String

Creates a help message for a subset of options based on cond

Creates a help message for a subset of options based on cond

def checkUsage(summary: ArgsSummary, sourcesRequired: Boolean)(using settings: ConcreteSettings)(using SettingsState, Context): Option[List[String]]

Provide usage feedback on argument summary, assuming that all settings are already applied in context.

Provide usage feedback on argument summary, assuming that all settings are already applied in context.

Returns

Either Some list of files passed as arguments or None if further processing should be interrupted.

protected
def createUsageMsg(label: String, shouldExplain: Boolean, cond: Setting[_] => Boolean)(using settings: ConcreteSettings)(using SettingsState): String

Distill arguments into summary detailing settings, errors and files to main

Distill arguments into summary detailing settings, errors and files to main

protected
def isAdvanced(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
protected
def isHelping(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
protected
def isPrivate(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
protected
def isStandard(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
protected
def isVerbose(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
protected
def isWarning(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
protected
protected
def shortHelp(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): String
protected
protected
def usageMessage(using settings: ConcreteSettings)(using SettingsState): String

Messages explaining usage and options

Messages explaining usage and options

protected
def vusageMessage(using settings: ConcreteSettings)(using SettingsState): String
protected
def wusageMessage(using settings: ConcreteSettings)(using SettingsState): String
protected
def xusageMessage(using settings: ConcreteSettings)(using SettingsState): String
protected
def yusageMessage(using settings: ConcreteSettings)(using SettingsState): String

Extensions

Extensions

extension [T](setting: Setting[T])
protected
def value(using ss: SettingsState): T