startFromArgs function

Progress startFromArgs(
  1. String command,
  2. List<String> args, {
  3. Progress? progress,
  4. bool runInShell = false,
  5. bool detached = false,
  6. bool terminal = false,
  7. bool privileged = false,
  8. bool nothrow = false,
  9. String? workingDirectory,
  10. bool extensionSearch = true,
  11. bool includeParentEnvironment = true,
  12. Encoding encoding = utf8,
})

Allows you to execute a command by passing a command and a list of args in args.

The startFromArgs method provides additional controls (compared to the run method) over how the commmand is executed.

DCli will do glob expansion (e.g. expand *.txt to a list of txt files) on each passed argument (for Linux and MacOS). You can stop glob expansion by adding a set of single or double quotes around each argument.

DCli will remove the extra quotes and NOT perform glob expansion.

e.g. '''"dontexpand.*"'''

results in dontexpand.*

By default startFromArgs will output both stdout and stderr to the console.

Pass in a progress to capture or suppress stdout and stderr. If you don't pass progress, the default Progress uses encoding. If you pass progress, encoding is ignored.

Use includeParentEnvironment to control whether the child process inherits the current process environment.

The privileged argument attempts to escalate the priviledge that the command is run with.

If the script is already running in a priviledge environment this switch will have no affect.

Running a command with the privileged switch may cause the OS to prompt the user for a password.

For Linux/MacOS passing the privileged argument will cause the command to be prefix vai the sudo command unless the script is already running as a privileged process.

Currently privileged is not supported under Windows see withPrivileged as an alternative.

If you pass detached = true then the process is spawned but we don't wait for it to complete nor is any io available.

Implementation

Progress startFromArgs(
  String command,
  List<String> args, {
  Progress? progress,
  bool runInShell = false,
  bool detached = false,
  bool terminal = false,
  bool privileged = false,
  bool nothrow = false,
  String? workingDirectory,
  bool extensionSearch = true,
  bool includeParentEnvironment = true,
  Encoding encoding = utf8,
}) {
  progress ??= Progress.print(encoding: encoding);
  workingDirectory ??= pwd;
  final runnable = RunnableProcess.fromCommandArgs(
    command,
    args,
    workingDirectory: workingDirectory,
  );

  return runnable.run(
    progress: progress,
    runInShell: runInShell,
    detached: detached,
    terminal: terminal,
    privileged: privileged,
    nothrow: nothrow,
    extensionSearch: extensionSearch,
    includeParentEnvironment: includeParentEnvironment,
  );
}