# should_run_onboarding

> **Function** in `deepagents_code`

📖 [View in docs](https://reference.langchain.com/python/deepagents-code/onboarding/should_run_onboarding)

Return whether onboarding should open at interactive startup.

## Signature

```python
should_run_onboarding(
    state_dir: Path | None = None,
) -> bool
```

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `state_dir` | `Path \| None` | No | Optional state directory override for tests. (default: `None`) |

## Returns

`bool`

`True` when the debug override is enabled or no completion marker exists.

---

[View source on GitHub](https://github.com/langchain-ai/deepagents/blob/a98f0dfa8d534d8a1885b524632400e52db22ac6/libs/code/deepagents_code/onboarding.py#L212)