GitHub

CommandOptions

API reference for CommandOptions.

How a command runs; see make for each option.

Attributes

AttributeTypeDescription
cwdstr | None = None
envMapping[str, str | Redacted[str] | None] | None = None
extend_envbool = False
shellbool | str = False
detachedbool | None = None
windows_hidebool | None = None
stdinStdinConfig = StdinConfig()
stdoutCommandOutput = 'pipe'
stderrCommandOutput = 'pipe'
additional_fdsMapping[int, AdditionalFd] = field(default_factory=_no_fds)
kill_signalsignal.Signals | None = None
force_kill_afterDuration | None = None

Functions

__init__

__init__(*, cwd=None, env=None, extend_env=False, shell=False, detached=None, windows_hide=None, stdin=StdinConfig(), stdout='pipe', stderr='pipe', additional_fds=_no_fds(), kill_signal=None, force_kill_after=None) -> None
ParameterTypeDescription
cwdstr | None = None
envMapping[str, str | Redacted[str] | None] | None = None
extend_envbool = False
shellbool | str = False
detachedbool | None = None
windows_hidebool | None = None
stdinStdinConfig = StdinConfig()
stdoutCommandOutput = 'pipe'
stderrCommandOutput = 'pipe'
additional_fdsMapping[int, AdditionalFd] = _no_fds()
kill_signalsignal.Signals | None = None
force_kill_afterDuration | None = None