CliTool class abstract

Implementers

• ChmodCliTool
• DartCliTool
• DotNetCliTool
• ElixirCliTool
• ElixirMixCliTool
• FFMpegCliTool
• FFProbeCliTool
• FlutterCliTool
• FvmCliTool
• GitCliTool
• MariaDbCliTool
• MariaDbDumpCliTool
• NodeCliTool
• NpmCliTool
• NpxCliTool
• PandocCliTool
• PowershellCliTool

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.

late, final

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 setter, inherited

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 setter, inherited

website → Uri?

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

writeWindowsBatchScript({required File file, required String contents, bool changeCodePage = true}) → Future<void>

writeWindowsBatchScriptSync({required File file, required String contents, bool changeCodePage = true}) → void

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

defaultCliEncoding → const Utf8Codec