# tmuxp.cli.utils.prompt_bool

- **Module:** tmuxp.cli.utils
- **Package:** tmuxp
- **Language:** Python
- **Kind:** function
- **Source:** https://github.com/tmux-python/tmuxp/blob/153acdf6ff1268b14d3d03ed488f545a7123c8f1/src/tmuxp/cli/utils.py#L105
- **Page:** https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-utils-prompt_bool/

```
tmuxp.cli.utils.prompt_bool(
    name: str,
    default: bool = False,
    yes_choices: Sequence[t.Any] | None = None,
    no_choices: Sequence[t.Any] | None = None,
    color_mode: ColorMode | None = None,
) -> bool
```

Return True / False by prompting user input from command line.

## Parameters

- `name` (`str`)
- `default` (`bool`)
- `yes_choices` (`Sequence[t.Any] | None`)
- `no_choices` (`Sequence[t.Any] | None`)
- `color_mode` (`ColorMode | None`)

## Returns

bool