# {py:mod}`simvx.core.shell_node`

```{py:module} simvx.core.shell_node
```

```{autodoc2-docstring} simvx.core.shell_node
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ShellNode <simvx.core.shell_node.ShellNode>`
  - ```{autodoc2-docstring} simvx.core.shell_node.ShellNode
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`log <simvx.core.shell_node.log>`
  - ```{autodoc2-docstring} simvx.core.shell_node.log
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.core.shell_node.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core.shell_node.log
```

````

`````{py:class} ShellNode(command: str = '', *, use_pty: bool = False, env: dict[str, str] | None = None, **kwargs)
:canonical: simvx.core.shell_node.ShellNode

Bases: {py:obj}`simvx.core.node.Node`

```{autodoc2-docstring} simvx.core.shell_node.ShellNode
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.__init__
```

````{py:attribute} auto_start
:canonical: simvx.core.shell_node.ShellNode.auto_start
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.auto_start
```

````

````{py:attribute} command
:canonical: simvx.core.shell_node.ShellNode.command
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.command
```

````

````{py:method} ready()
:canonical: simvx.core.shell_node.ShellNode.ready

````

````{py:method} start(command: str | None = None)
:canonical: simvx.core.shell_node.ShellNode.start

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.start
```

````

````{py:method} resize(cols: int, rows: int)
:canonical: simvx.core.shell_node.ShellNode.resize

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.resize
```

````

````{py:method} stop()
:canonical: simvx.core.shell_node.ShellNode.stop

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.stop
```

````

````{py:method} write(data: str)
:canonical: simvx.core.shell_node.ShellNode.write

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.write
```

````

````{py:method} process(dt: float)
:canonical: simvx.core.shell_node.ShellNode.process

````

````{py:method} exit_tree()
:canonical: simvx.core.shell_node.ShellNode.exit_tree

````

````{py:property} running
:canonical: simvx.core.shell_node.ShellNode.running
:type: bool

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.running
```

````

````{py:property} exit_code
:canonical: simvx.core.shell_node.ShellNode.exit_code
:type: int | None

```{autodoc2-docstring} simvx.core.shell_node.ShellNode.exit_code
```

````

````{py:attribute} strict_errors
:canonical: simvx.core.shell_node.ShellNode.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.shell_node.ShellNode.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.shell_node.ShellNode.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.shell_node.ShellNode.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.shell_node.ShellNode.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:property} visible
:canonical: simvx.core.shell_node.ShellNode.visible
:type: bool

````

````{py:method} reset_error() -> None
:canonical: simvx.core.shell_node.ShellNode.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.shell_node.ShellNode.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.shell_node.ShellNode.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.shell_node.ShellNode.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.shell_node.ShellNode.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.shell_node.ShellNode.find_child

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.shell_node.ShellNode.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.shell_node.ShellNode.find_all

````

````{py:method} walk(*, include_self: bool = True) -> collections.abc.Iterator[simvx.core.node.Node]
:canonical: simvx.core.shell_node.ShellNode.walk

````

````{py:property} path
:canonical: simvx.core.shell_node.ShellNode.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.shell_node.ShellNode.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.shell_node.ShellNode.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.shell_node.ShellNode.is_in_group

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.shell_node.ShellNode.enter_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.shell_node.ShellNode.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.shell_node.ShellNode.draw

````

````{py:method} picked(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.shell_node.ShellNode.picked

````

````{py:method} handle_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.shell_node.ShellNode.handle_input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.shell_node.ShellNode.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.shell_node.ShellNode.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.shell_node.ShellNode.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.shell_node.ShellNode.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.shell_node.ShellNode.destroy

````

````{py:property} app
:canonical: simvx.core.shell_node.ShellNode.app

````

````{py:property} tree
:canonical: simvx.core.shell_node.ShellNode.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.shell_node.ShellNode.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.shell_node.ShellNode.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.shell_node.ShellNode.__repr__

````

`````