Title: onboarding | deepagents_code | LangChain Reference
Open Graph Title: onboarding | deepagents_code
X Title: onboarding | deepagents_code
Description: Python API reference for onboarding in deepagents_code. Part of the LangChain ecosystem.
Open Graph Description: Python API reference for onboarding in deepagents_code. Part of the LangChain ecosystem.
X Description: Python API reference for onboarding in deepagents_code. Part of the LangChain ecosystem.
Opengraph URL: https://reference.langchain.com/python/deepagents-code/onboarding
Domain: reference.langchain.com
| og:image | https://reference.langchain.com/og/python/deepagents-code/onboarding |
| og:image:width | 1200 |
| og:image:height | 630 |
| og:image:alt | onboarding | deepagents_code |
| og:type | article |
| twitter:card | summary_large_image |
| twitter:image | https://reference.langchain.com/og/python/deepagents-code/onboarding |
Links:
| LangChain Reference home page | https://reference.langchain.com/ |
| GitHub | https://github.com/langchain-ai |
| Main Docs | https://docs.langchain.com/oss/python/deepagents |
| Deep Agents | https://reference.langchain.com/python/deepagents |
| LangChain | https://reference.langchain.com/python/langchain/overview |
| LangGraph | https://reference.langchain.com/python/langgraph/overview |
| Integrations | https://reference.langchain.com/python/integrations/overview |
| LangSmith | https://reference.langchain.com/python/langsmith |
| Deep Agents Code | https://reference.langchain.com/python/deepagents-code |
| Deep Agents Code | https://reference.langchain.com/python/deepagents-code |
| deepagents-code | https://reference.langchain.com/python/deepagents-code |
| attributeDEBUG_ONBOARDING: strForce the onboarding flow to open on every interactive startup. Parsed by is_env_truthy: accepts 1, true, yes, on as enabled. | https://reference.langchain.com/python/deepagents-code/_env_vars/DEBUG_ONBOARDING |
| attributeDEFAULT_STATE_DIRDirectory for app-managed internal state (~/.deepagents/.state). Holds files the app writes for its own bookkeeping — OAuth tokens, the sessions database, version-check caches, input history. Kept separate from top-level user-facing config and agent directories so listing/iterating ~/.deepagents doesn't conflate state with agents. | https://reference.langchain.com/python/deepagents-code/model_config/DEFAULT_STATE_DIR |
| attributelogger | https://reference.langchain.com/python/deepagents-code/onboarding/logger |
| attributeONBOARDING_MARKER_FILENAME: strMarker filename under ~/.deepagents/.state after onboarding has completed. | https://reference.langchain.com/python/deepagents-code/onboarding/ONBOARDING_MARKER_FILENAME |
| attributeONBOARDING_NAME_MEMORY_START: strStart marker for the managed onboarding name memory block. | https://reference.langchain.com/python/deepagents-code/onboarding/ONBOARDING_NAME_MEMORY_START |
| attributeONBOARDING_NAME_MEMORY_END: strEnd marker for the managed onboarding name memory block. | https://reference.langchain.com/python/deepagents-code/onboarding/ONBOARDING_NAME_MEMORY_END |
| functionis_env_truthyReturn whether env var name is set to a recognizably truthy value. Unlike bool(os.environ.get(name)), this does not treat "0" or "false" as enabled. Use this for on/off flags where the user would reasonably expect VAR=0 to mean "disabled". | https://reference.langchain.com/python/deepagents-code/_env_vars/is_env_truthy |
| functiononboarding_marker_pathReturn the first-run onboarding marker path. | https://reference.langchain.com/python/deepagents-code/onboarding/onboarding_marker_path |
| functionhas_completed_onboardingReturn whether the user has completed onboarding. | https://reference.langchain.com/python/deepagents-code/onboarding/has_completed_onboarding |
| functionmark_onboarding_completePersist that onboarding has completed. | https://reference.langchain.com/python/deepagents-code/onboarding/mark_onboarding_complete |
| functionwrite_onboarding_name_memoryPersist the optional onboarding name into user agent memory. Empty or whitespace-only names are skipped (no file is written). | https://reference.langchain.com/python/deepagents-code/onboarding/write_onboarding_name_memory |
| functionextract_onboarding_name_blockReturn the managed onboarding name block (markers included) if present. | https://reference.langchain.com/python/deepagents-code/onboarding/extract_onboarding_name_block |
| functionstrip_onboarding_name_markersRemove every onboarding-name marker occurrence from text. A partial edit can leave a lone start or end marker behind. Stripping all marker strings before re-inserting the managed block keeps re-insertion from producing orphaned markers that would confuse extract_onboarding_name_block. | https://reference.langchain.com/python/deepagents-code/onboarding/strip_onboarding_name_markers |
| functionshould_run_onboardingReturn whether onboarding should open at interactive startup. | https://reference.langchain.com/python/deepagents-code/onboarding/should_run_onboarding |
| View source on GitHub | https://github.com/langchain-ai/deepagents/blob/bd9bafaad3f51d426563aa24658bbb3a089d4825/libs/code/deepagents_code/onboarding.py |
Viewport: width=device-width, initial-scale=1