Class HeadlessOptions

src/entrypoints/headless.py:72–105

Options accepted by :func:`run_headless`. Kept as a plain dataclass (no Click/argparse coupling) so the CLI layer and tests can construct it independently.

@dataclass
class HeadlessOptions:
    """Options accepted by :func:`run_headless`.

    Kept as a plain dataclass (no Click/argparse coupling) so the CLI layer
    and tests can construct it independently.
    """

    prompt: str | None = None
    output_format: str = "text"
    input_format: str = "text"
    provider_name: str | None = None
    model: str | None = None
    max_turns: int = 20
    # ``skip_permissions`` is a backward-compat alias for the boolean form
    # of ``--dangerously-skip-permissions``. ``permission_mode`` and
    # ``is_bypass_permissions_mode_available`` were added in round 5 to
    # mirror the TS reference's resolved state. When ``skip_permissions``
    # is True we treat it as ``permission_mode='bypassPermissions'`` and
    # ``is_bypass_permissions_mode_available=True``.
    skip_permissions: bool = False
    permission_mode: str = "default"
    is_bypass_permissions_mode_available: bool = False
    allowed_tools: tuple[str, ...] = ()
    disallowed_tools: tuple[str, ...] = ()
    include_partial_messages: bool = False
    verbose: bool = False

    # Mostly for tests: override streams so we can capture output.
    stdin: IO[str] | None = None
    stdout: IO[str] | None = None
    stderr: IO[str] | None = None

    # Workspace root override (default: cwd).
    workspace_root: Path | None = None


def run_headless(options: HeadlessOptions) -> int: