Skip to content

orchestr8.shell

Shell (host-based)

Interface for running commands in host machine.

If host is windows, all commands are executed using PowerShell.

⚠️ WARNING: This class allows execution of system commands and should be used with EXTREME CAUTION.

  • Never run commands with user-supplied or untrusted input
  • Always validate and sanitize any command arguments
  • Be aware of potential security risks, especially with privilege escalation
# Initialize the shell
shell = Shell(workdir="/path/to/directory")

# Run command
print(shell.run("echo", "'Hello from shell!'"))

# Stream run command
for line in shell.stream("echo", "Hello from shell!"):
    print(line)
Source code in orchestr8/shell.py 
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class Shell(Logger):
    """
    Interface for running commands in host machine.

    If host is windows, all commands are executed using `PowerShell`.

    ⚠️ WARNING: This class allows execution of system commands and should be used with EXTREME CAUTION.

    - Never run commands with user-supplied or untrusted input
    - Always validate and sanitize any command arguments
    - Be aware of potential security risks, especially with privilege escalation

    ```python
    # Initialize the shell
    shell = Shell(workdir="/path/to/directory")

    # Run command
    print(shell.run("echo", "'Hello from shell!'"))

    # Stream run command
    for line in shell.stream("echo", "Hello from shell!"):
        print(line)
    ```
    """

    def __init__(
        self,
        *,
        workdir: str | Path | None = None,
        raise_on_non_zero: bool = False,
    ) -> None:
        """
        Initialize the CommandExecutor.

        Args:
            workdir: The working directory to execute commands in
            raise_on_non_zero: Whether to raise an exception if the command returns non-zero exit code
        """
        if workdir:
            w_dir = Path(workdir)
            if not w_dir.is_dir():
                raise NotADirectoryError(f"{str(w_dir)!r} is not a directory.")
            self.__workdir = PurePath(w_dir)
        else:
            self.__workdir = PurePath(Path.cwd())

        self.__raise_on_non_zero = raise_on_non_zero

    @staticmethod
    def __validate_cmd(cmd: Tuple[str, ...]) -> Tuple[str, ...]:
        if os.name == "nt" and "SHELL" not in os.environ:
            return ("powershell", "-NoProfile", "-NonInteractive", "-Command", *cmd)
        return cmd

    @property
    def workdir(self) -> PurePath:
        """The working directory."""
        return self.__workdir

    def __prepare_common_kwargs(self, env: Dict[str, str] | None = None) -> Dict[str, Any]:
        kwargs = {"cwd": self.__workdir, "text": True}
        if env:
            kwargs["env"] = {**os.environ, **env}
        return kwargs

    def run(self, *cmd: str, env: Dict[str, str] | None = None) -> str | None:
        """
        Run a command and return the output.

        Args:
            cmd: The arguments to pass as command
            env: Environment variables to set

        Returns:
            Output of the executed command

        Raises:
            ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
        """
        self.logger.info(format_log(cmd))
        process: subprocess.CompletedProcess[str] = subprocess.run(  # noqa: S603
            self.__validate_cmd(cmd), capture_output=True, **self.__prepare_common_kwargs(env)
        )
        if error := process.stderr.strip():
            if process.returncode != 0 and self.__raise_on_non_zero:
                raise_on_failure(cmd, error)
            return error

        return process.stdout.strip() or None

    def stream(self, *cmd: str, env: Dict[str, str] | None = None) -> Generator[str, Any, None]:
        """
        Run a command and stream the output.

        Args:
            cmd: The arguments to pass as command
            env: Environment variables to set

        Returns:
            Output stream of the executed command

        Raises:
            ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
        """
        self.logger.info(format_log(cmd))
        process = subprocess.Popen(  # noqa: S603
            self.__validate_cmd(cmd),
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            **self.__prepare_common_kwargs(env),
        )
        if error := process.stderr:
            if process.returncode != 0 and self.__raise_on_non_zero:
                raise_on_failure(cmd, "".join(error).strip())
            yield from error

        if output := process.stdout:
            yield from output

workdir: PurePath property

The working directory.

run

Run a command and return the output.

Parameters:

Name Type Description Default
cmd str

The arguments to pass as command

 ()
env Dict[str, str] | None

Environment variables to set

 None

Returns:

Type Description
str | None

Output of the executed command

Raises:

Type Description
ShellException

If the command returns non-zero exit code and raise_on_non_zero is False
Source code in orchestr8/shell.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def run(self, *cmd: str, env: Dict[str, str] | None = None) -> str | None:
    """
    Run a command and return the output.

    Args:
        cmd: The arguments to pass as command
        env: Environment variables to set

    Returns:
        Output of the executed command

    Raises:
        ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
    """
    self.logger.info(format_log(cmd))
    process: subprocess.CompletedProcess[str] = subprocess.run(  # noqa: S603
        self.__validate_cmd(cmd), capture_output=True, **self.__prepare_common_kwargs(env)
    )
    if error := process.stderr.strip():
        if process.returncode != 0 and self.__raise_on_non_zero:
            raise_on_failure(cmd, error)
        return error

    return process.stdout.strip() or None

stream

Run a command and stream the output.

Parameters:

Name Type Description Default
cmd str

The arguments to pass as command

 ()
env Dict[str, str] | None

Environment variables to set

 None

Returns:

Type Description
None

Output stream of the executed command

Raises:

Type Description
ShellException

If the command returns non-zero exit code and raise_on_non_zero is False
Source code in orchestr8/shell.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
def stream(self, *cmd: str, env: Dict[str, str] | None = None) -> Generator[str, Any, None]:
    """
    Run a command and stream the output.

    Args:
        cmd: The arguments to pass as command
        env: Environment variables to set

    Returns:
        Output stream of the executed command

    Raises:
        ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
    """
    self.logger.info(format_log(cmd))
    process = subprocess.Popen(  # noqa: S603
        self.__validate_cmd(cmd),
        stdout=subprocess.PIPE,
        stderr=subprocess.PIPE,
        **self.__prepare_common_kwargs(env),
    )
    if error := process.stderr:
        if process.returncode != 0 and self.__raise_on_non_zero:
            raise_on_failure(cmd, "".join(error).strip())
        yield from error

    if output := process.stdout:
        yield from output

IsolatedShell

Interface for running commands inside a detached container.

from orchestr8.sandbox_client import SandboxClient

# Create a detached container
client = SandboxClient()
container = client.run_container(
    "ubuntu:22.04", detach=True, remove=True
)

# Initialize the shell
shell = IsolatedShell(
    container=container, workdir="/path/to/directory"
)

# Run command
print(shell.run("echo", "Hello from shell!"))

# Stream run command
for line in shell.stream("ls", "-l"):
    print(line)
Source code in orchestr8/shell.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
class IsolatedShell(Logger):
    """
    Interface for running commands inside a detached container.

    ```python
    from orchestr8.sandbox_client import SandboxClient

    # Create a detached container
    client = SandboxClient()
    container = client.run_container(
        "ubuntu:22.04", detach=True, remove=True
    )

    # Initialize the shell
    shell = IsolatedShell(
        container=container, workdir="/path/to/directory"
    )

    # Run command
    print(shell.run("echo", "Hello from shell!"))

    # Stream run command
    for line in shell.stream("ls", "-l"):
        print(line)
    ```
    """

    def __init__(  # type: ignore[no-any-unimported]
        self,
        *,
        container: Container,
        workdir: str | Path | None = None,
        raise_on_non_zero: bool = False,
    ) -> None:
        """
        Args:
            container: The detached container to execute commands in
            workdir: The working directory to execute commands in
            raise_on_non_zero: Whether to raise an exception if the command returns non-zero exit co
        """
        container.reload()
        if container.status != "running":
            raise ShellException("Container is not running.")
        self.__container = container
        self.__w_dir_str = None
        self.__raise_on_non_zero = raise_on_non_zero
        if workdir:
            self.__workdir = PurePath(workdir)
        else:
            self.__workdir = PurePath(self.run("pwd").strip())  # type: ignore[union-attr]
        self.__w_dir_str = self.__workdir.as_posix()

    @property
    def container(self) -> Container:  # type: ignore[no-any-unimported]
        """The container."""
        return self.__container

    @property
    def workdir(self) -> PurePath:
        """The working directory."""
        return self.__workdir

    def __exec(self, *cmd: str, **kwargs: Any) -> Any:
        self.logger.info(format_log(cmd))
        code, ret = self.__container.exec_run(cmd, workdir=self.__w_dir_str, **kwargs)
        if code != 0 and self.__raise_on_non_zero:
            self._stop_container()  # Is it right to stop the container before raising exception?
            raise_on_failure(cmd, ret)
        return ret

    def run(self, *cmd: str, env: Dict[str, str] | None = None) -> str | None:
        """
        Run a command inside the container and return the output.

        Args:
            cmd: The arguments to pass as command
            env: Environment variables to set

        Returns:
            Output of the executed command

        Raises:
            ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
        """
        return self.__exec(*cmd, environment=env).decode() or None

    def stream(self, *cmd: str, env: Dict[str, str] | None = None) -> Generator[str, Any, None]:
        """
        Run a command in the container and stream the output.

        Args:
            cmd: The arguments to pass as command
            env: Environment variables to set

        Returns:
            Output stream of the executed command

        Raises:
            ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
        """
        for line in self.__exec(*cmd, stream=True, environment=env):
            yield line.decode()

    def _stop_container(self) -> None:
        """Stop the container."""
        if self.__container.status == "running":
            self.logger.info("Shutting down the container")
            self.__container.stop()

    def __del__(self) -> None:
        self._stop_container()

container: Container property

The container.

workdir: PurePath property

The working directory.

run

Run a command inside the container and return the output.

Parameters:

Name Type Description Default
cmd str

The arguments to pass as command

 ()
env Dict[str, str] | None

Environment variables to set

 None

Returns:

Type Description
str | None

Output of the executed command

Raises:

Type Description
ShellException

If the command returns non-zero exit code and raise_on_non_zero is False
Source code in orchestr8/shell.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
def run(self, *cmd: str, env: Dict[str, str] | None = None) -> str | None:
    """
    Run a command inside the container and return the output.

    Args:
        cmd: The arguments to pass as command
        env: Environment variables to set

    Returns:
        Output of the executed command

    Raises:
        ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
    """
    return self.__exec(*cmd, environment=env).decode() or None

stream

Run a command in the container and stream the output.

Parameters:

Name Type Description Default
cmd str

The arguments to pass as command

 ()
env Dict[str, str] | None

Environment variables to set

 None

Returns:

Type Description
None

Output stream of the executed command

Raises:

Type Description
ShellException

If the command returns non-zero exit code and raise_on_non_zero is False
Source code in orchestr8/shell.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
def stream(self, *cmd: str, env: Dict[str, str] | None = None) -> Generator[str, Any, None]:
    """
    Run a command in the container and stream the output.

    Args:
        cmd: The arguments to pass as command
        env: Environment variables to set

    Returns:
        Output stream of the executed command

    Raises:
        ShellException: If the command returns non-zero exit code and raise_on_non_zero is False
    """
    for line in self.__exec(*cmd, stream=True, environment=env):
        yield line.decode()