cli
API
Generated with
cli/scala.cli/scala.cli.commands/scala.cli.commands.pgp/PgpExternalCommand

PgpExternalCommand

scala.cli.commands.pgp.PgpExternalCommand
See thePgpExternalCommand companion object
abstract class PgpExternalCommand extends ExternalCommand

Attributes

Companion
object
Graph
Supertypes
class Command[DummyOptions]
class CaseApp[DummyOptions]
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Inherited classlikes

implicit class EitherBuildExceptionOps[E <: BuildException, T](either: Either[E, T])

Attributes

Inherited from:
CommandHelpers
Supertypes
class Object
trait Matchable
class Any

Value members

Abstract methods

def externalCommand: Seq[String]

Concrete methods

def output(cache: FileCache[Task], args: Seq[String], extraEnv: Map[String, String], logger: Logger, jvmOptions: SharedJvmOptions, coursierOptions: CoursierOptions, signingCliOptions: ScalaSigningCliOptions): Either[BuildException, String]
def progName: String
def run(args: Seq[String]): Unit
def tryRun(cache: FileCache[Task], args: Seq[String], extraEnv: Map[String, String], logger: Logger, allowExecve: Boolean, jvmOptions: SharedJvmOptions, coursierOptions: CoursierOptions, signingCliOptions: ScalaSigningCliOptions): Either[BuildException, Int]

Inherited methods

def actualHelp: Help[_]

Attributes

Inherited from:
ExternalCommand
def complete(args: Seq[String], index: Int): List[CompletionItem]

Attributes

Inherited from:
CaseApp
def completer: Completer[T]

Attributes

Inherited from:
CaseApp
def ensureNoDuplicates(): Unit

Attributes

Inherited from:
CaseApp
def error(message: Error): Nothing

Attributes

Inherited from:
CaseApp
def exit(code: Int): Nothing

Attributes

Inherited from:
CaseApp
def expandArgs(args: List[String]): List[String]

Arguments are expanded then parsed. By default, argument expansion is the identity function. Overriding this method allows plugging in an arbitrary argument expansion logic.

Arguments are expanded then parsed. By default, argument expansion is the identity function. Overriding this method allows plugging in an arbitrary argument expansion logic.

One such expansion logic involves replacing each argument of the form '@ ' with the contents of that file where each line in the file becomes a distinct argument. To enable this behavior, override this method as shown below.

Attributes

Example 
import caseapp.core.parser.PlatformArgsExpander
override def expandArgs(args: List[String]): List[String]
= PlatformArgsExpander.expand(args)
Inherited from:
CaseApp
def fullHelpAsked(progName: String): Nothing

Attributes

Inherited from:
CaseApp
def group: String

Attributes

Inherited from:
Command
def hasFullHelp: Boolean

Attributes

Inherited from:
CaseApp
override def hasHelp: Boolean

Attributes

Definition Classes
ExternalCommand -> CaseApp
Inherited from:
ExternalCommand
def helpAsked(progName: String, maybeOptions: Either[Error, DummyOptions]): Nothing

Attributes

Inherited from:
CaseApp
def helpFormat: HelpFormat

Attributes

Inherited from:
CaseApp
def hidden: Boolean

Attributes

Inherited from:
Command
def ignoreUnrecognized: Boolean

Whether to ignore unrecognized arguments.

Whether to ignore unrecognized arguments.

That is, if there are unrecognized arguments, the parsing still succeeds. The unparsed arguments are put in the args argument of run.

Attributes

Inherited from:
CaseApp
def main(progName: String, args: Array[String]): Unit

Attributes

Inherited from:
CaseApp
def main(args: Array[String]): Unit

Attributes

Inherited from:
CaseApp
def name: String

Attributes

Inherited from:
Command
def nameFormatter: Formatter[Name]

Attributes

Inherited from:
CaseApp
def names: List[List[String]]

Attributes

Inherited from:
Command
def parser: Parser[T]

Attributes

Inherited from:
CaseApp
final def printLine(line: String): Unit

Attributes

Inherited from:
CaseApp
def printLine(line: String, toStderr: Boolean): Unit

Attributes

Inherited from:
CaseApp
def run(options: DummyOptions, args: RemainingArgs): Unit

Attributes

Inherited from:
ExternalCommand
override def stopAtFirstUnrecognized: Boolean

Whether to stop parsing at the first unrecognized argument.

Whether to stop parsing at the first unrecognized argument.

That is, stop parsing at the first non option (not starting with "-"), or the first unrecognized option. The unparsed arguments are put in the args argument of run.

Attributes

Definition Classes
ExternalCommand -> CaseApp
Inherited from:
ExternalCommand
def usageAsked(progName: String, maybeOptions: Either[Error, DummyOptions]): Nothing

Attributes

Inherited from:
CaseApp

Inherited fields

lazy val finalHelp: Help[_]

Attributes

Inherited from:
CaseApp

Implicits

Inherited implicits

final implicit def EitherBuildExceptionOps[E <: BuildException, T](either: Either[E, T]): EitherBuildExceptionOps[E, T]

Attributes

Inherited from:
CommandHelpers
implicit val messages: Help[DummyOptions]

Attributes

Inherited from:
CaseApp
implicit val parser0: Parser[DummyOptions]

Attributes

Inherited from:
CaseApp
Generated with