CliTool class abstract

Implementers

Constructors

CliTool.new({required String executable, int? windowsCodePage = WindowsCodePage.utf8})

Properties

executable String
The executable that is used whenever this CliTool starts a io.Process.
latefinal
extraEnvironment Map<String, String>?
Some extra environment variables that will used whenever a process is started by this CliTool.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
originalExecutable String
This is the original executable that was passed to the constructor of this CliTool.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
website Uri?
A link to the official website of this tool.
no setter
windowsCodePage int?
The code page that should be used when executing this CliTool on windows.
final

Methods

checkExistsSync() → void
Check if executable exists, as per existsSync.
consumeProcess(List<String> args, {String? workingDirectory, CliStreamConsumer consumer = const CliStreamConsumer(), Map<String, String>? environment, bool includeParentEnvironment = true, bool includeExtraEnvironment = true}) Future<int>
Start a new process and consume it using consumer.
evaluateProcess(List<String> args, {String? workingDirectory, CliStreamConsumer consumer = const CliStreamConsumer(), Map<String, String>? environment, bool includeParentEnvironment = true, bool includeExtraEnvironment = true, int expectedCode = 0}) Future<bool>
Start a process in workingDirectory.
existsSync() bool
Synchronously check if executable can be found and executed without any errors.
getVersionSync() Version
Returns the version of executable.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
runAsync(List<String> args, {String? workingDirectory, Encoding encoding = defaultCliEncoding, Map<String, String>? environment, bool includeParentEnvironment = true, bool includeExtraEnvironment = true}) Future<ProcessResult>
runSync(List<String> args, {String? workingDirectory, Encoding encoding = defaultCliEncoding, Map<String, String>? environment, bool includeParentEnvironment = true, bool includeExtraEnvironment = true}) ProcessResult
startProcess(List<String> args, {String? workingDirectory, ProcessStartMode mode = io.ProcessStartMode.normal, Map<String, String>? environment, bool includeParentEnvironment = true, bool includeExtraEnvironment = true}) Future<Process>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

createPlatformScript({required String unixContents, required String windowsContents, String? scriptPrefix, String? unixScriptInterpreter = "/bin/sh", bool setUnixPermissions = true, int? windowsCodePage = WindowsCodePage.utf8, WindowsScriptType windowsScriptType = WindowsScriptType.batch}) File
createWindowsScript({required String contents, File? file, WindowsScriptType type = WindowsScriptType.batch, int? windowsCodePage = WindowsCodePage.utf8, bool echoOff = true}) File

Constants

defaultCliEncoding → const Utf8Codec