IShell class abstract

A marker interface representing a basic Shell to run and evaluate commands

since 0.0.1

Implementers
Available Extensions

Constructors

IShell()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

cmd(String command) IShellCommandBuilder
Prepares a command to be run within an IShell environment.
copyWith({bool? verbose, bool? color, String? workingDirectory, bool? throwOnError, Map<String, String>? environment}) IShell
Clones the current IShell instance, overriding properties as specified
environment() Map<String, String>
Returns the current environment
hasCommand(String command) bool
Returns true if the external command exists
isVerbose() bool
Returns true if the current instance is verbose
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
requireCommand(String command) → void
Throws CommandNotFoundException if the provided command is not present in the $PATH
run(String command, {Map<String, String>? environment, Stream<List<int>>? stdin, StreamSink<List<int>>? stdout, List<String>? args}) Future<ProcessResult>
Runs a command within a IShell environment. Returning the commands result. May throw CommandExceptions.
supportsColorOutput() bool
True if the shell implementation supports color output
throwsOnError() bool
True if the shell implementation throws an exception on error
toString() String
A string representation of this object.
inherited
which(String command) String?
Returns the full path location (and name) for a supplied command. Null if the command was not found.
workingDirectory() String
Returns the current working directory

Operators

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