LocalShell class final

Minimal local shell backed by dart:io Process.

Executes commands via sh -c (POSIX) or cmd /c (Windows). Streaming callbacks receive output chunks as they arrive; timeout and cancellation kill the process. This is the v1 shell — pi's richer bash-discovery logic is deferred until a tool actually needs it.

Implemented types

Constructors

LocalShell()
Creates a LocalShell.
const

Properties

backgroundJobsSupported bool
Whether startShellJob actually works here. Decorators forward their delegate's answer, so wrapping an env never fakes the capability.
no setteroverride
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

exec(String command, {ShellExecOptions? options}) Future<Result<ShellExecResult, ExecutionError>>
Executes a shell command. Must never throw: all failures are encoded in the returned Result.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startShellJob(String command, {required String id, required String logPath, ShellExecOptions? options}) Future<Result<ShellJob, ExecutionError>>
Starts command detached: stdout/stderr append to logPath and the returned ShellJob keeps running until it exits or is stopped. ShellExecOptions.timeout and ShellExecOptions.cancelToken still apply (both stop the job).
override
toString() String
A string representation of this object.
inherited

Operators

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