API reference
python:irx:irx.builder.base.run_command
function run_command
run_command(command: Sequence[str], *, capture_stderr: bool = True, raise_on_error: bool = True, debug: bool = False) -> CommandResult
Source: packages/irx/src/irx/builder/base.py:74
Run a shell command and return a structured CommandResult.
Parameters
-
command — Command.; Type: Sequence[str]
-
capture_stderr — Default: True; Whether to use capture stderr.; Type: bool
-
raise_on_error — Default: True; Whether to use raise on error.; Type: bool
-
debug — Default: False; Whether to use debug.; Type: bool
Returns
Result of this operation: run a shell command and return a structured CommandResult.; Type: CommandResult
Raises
- CommandError: "When the command exits non-zero and raise_on_error=True."