| LangChain Reference home page | https://reference.langchain.com/ |
| GitHub | https://github.com/langchain-ai |
| Main Docs | https://docs.langchain.com/oss/python/langgraph |
| 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 |
| Overview | https://reference.langchain.com/python/langgraph/overview |
| LangGraph Checkpoint | https://reference.langchain.com/python/langgraph.checkpoint |
| LangGraph Store | https://reference.langchain.com/python/langgraph.store |
| Checkpoint Postgres | https://reference.langchain.com/python/langgraph.checkpoint.postgres |
| Store Postgres | https://reference.langchain.com/python/langgraph.store.postgres |
| Checkpoint SQLite | https://reference.langchain.com/python/langgraph.checkpoint.sqlite |
| LangGraph Prebuilt | https://reference.langchain.com/python/langgraph.prebuilt |
| LangGraph CLI | https://reference.langchain.com/python/langgraph-cli |
| LangGraph SDK | https://reference.langchain.com/python/langgraph-sdk |
| LangGraph Supervisor | https://reference.langchain.com/python/langgraph-supervisor |
| LangGraph Swarm | https://reference.langchain.com/python/langgraph-swarm |
| https://chat.langchain.com/ |
| LangGraph Checkpoint | https://reference.langchain.com/python/langgraph.checkpoint |
| LangGraph Store | https://reference.langchain.com/python/langgraph.store |
| Checkpoint Postgres | https://reference.langchain.com/python/langgraph.checkpoint.postgres |
| Store Postgres | https://reference.langchain.com/python/langgraph.store.postgres |
| Checkpoint SQLite | https://reference.langchain.com/python/langgraph.checkpoint.sqlite |
| LangGraph Prebuilt | https://reference.langchain.com/python/langgraph.prebuilt |
| LangGraph CLI | https://reference.langchain.com/python/langgraph-cli |
| LangGraph SDK | https://reference.langchain.com/python/langgraph-sdk |
| LangGraph Supervisor | https://reference.langchain.com/python/langgraph-supervisor |
| LangGraph Swarm | https://reference.langchain.com/python/langgraph-swarm |
| https://pypi.org/project/langgraph-cli/#history |
| https://opensource.org/licenses/MIT |
| https://pypistats.org/packages/langgraph-cli |
| https://x.com/langchain_oss |
| LangSmith | https://www.langchain.com/langsmith |
| LangSmith | https://www.langchain.com/langsmith |
| LangGraph CLI reference | https://reference.langchain.com/python/langgraph-cli |
| LangGraph Docs | https://docs.langchain.com/oss/python/langgraph/overview |
| full documentation | https://reference.langchain.com/python/langgraph-cli |
| Releases | https://docs.langchain.com/oss/python/release-policy |
| Versioning | https://docs.langchain.com/oss/python/versioning |
| Contributing Guide | https://docs.langchain.com/oss/python/contributing/overview |
| ClassUvLockSourceEntry | https://reference.langchain.com/python/langgraph-cli/uv_lock/UvLockSourceEntry |
| ClassUvLockPackage | https://reference.langchain.com/python/langgraph-cli/uv_lock/UvLockPackage |
| ClassUvLockWorkspace | https://reference.langchain.com/python/langgraph-cli/uv_lock/UvLockWorkspace |
| ClassUvLockPlan | https://reference.langchain.com/python/langgraph-cli/uv_lock/UvLockPlan |
| ClassDockerBuildPlan | https://reference.langchain.com/python/langgraph-cli/uv_lock/DockerBuildPlan |
| ClassLocalDepsA container for referencing and managing local Python dependencies.
A "local dependency" is any entry in the config's dependencies list
that starts with "." (dot), denoting a relative path
to a loc | https://reference.langchain.com/python/langgraph-cli/config/LocalDeps |
| ClassNestedHelpGroupClick group that shows one level of nested subcommands in top-level help. | https://reference.langchain.com/python/langgraph-cli/cli/NestedHelpGroup |
| ClassVersion | https://reference.langchain.com/python/langgraph-cli/docker/Version |
| ClassDockerCapabilities | https://reference.langchain.com/python/langgraph-cli/docker/DockerCapabilities |
| ClassControlPlaneEndpoints | https://reference.langchain.com/python/langgraph-cli/host_backend/ControlPlaneEndpoints |
| ClassHostBackendErrorRaised when the host backend returns an error response. | https://reference.langchain.com/python/langgraph-cli/host_backend/HostBackendError |
| ClassHostBackendClientMinimal JSON HTTP client for the host backend deployment service. | https://reference.langchain.com/python/langgraph-cli/host_backend/HostBackendClient |
| ClassCommandRunner | https://reference.langchain.com/python/langgraph-cli/exec/CommandRunner |
| ClassTTLConfigConfiguration for TTL (time-to-live) behavior in the store. | https://reference.langchain.com/python/langgraph-cli/schemas/TTLConfig |
| ClassIndexConfigConfiguration for indexing documents for semantic search in the store.
This governs how text is converted into embeddings and stored for vector-based lookups. | https://reference.langchain.com/python/langgraph-cli/schemas/IndexConfig |
| ClassStoreConfigConfiguration for the built-in long-term memory store.
This store can optionally perform semantic search. If you omit index,
the store will just handle traditional (non-embedded) data without vecto | https://reference.langchain.com/python/langgraph-cli/schemas/StoreConfig |
| ClassThreadTTLConfigConfigure a default TTL for checkpointed data within threads. | https://reference.langchain.com/python/langgraph-cli/schemas/ThreadTTLConfig |
| ClassSerdeConfigConfiguration for the built-in serde, which handles checkpointing of state.
If omitted, no serde is set up (the object store will still be present, however). | https://reference.langchain.com/python/langgraph-cli/schemas/SerdeConfig |
| ClassCheckpointerConfigConfiguration for the built-in checkpointer, which handles checkpointing of state.
If omitted, no checkpointer is set up (the object store will still be present, however). | https://reference.langchain.com/python/langgraph-cli/schemas/CheckpointerConfig |
| ClassSecurityConfigConfiguration for OpenAPI security definitions and requirements.
Useful for specifying global or path-level authentication and authorization flows
(e.g., OAuth2, API key headers, etc.). | https://reference.langchain.com/python/langgraph-cli/schemas/SecurityConfig |
| ClassCacheConfig | https://reference.langchain.com/python/langgraph-cli/schemas/CacheConfig |
| ClassAuthConfigConfiguration for custom authentication logic and how it integrates into the OpenAPI spec. | https://reference.langchain.com/python/langgraph-cli/schemas/AuthConfig |
| ClassEncryptionConfigConfiguration for custom at-rest encryption logic.
Allows you to implement custom encryption for sensitive data stored in the database,
including metadata fields and checkpoint blobs. | https://reference.langchain.com/python/langgraph-cli/schemas/EncryptionConfig |
| ClassPriorityConfigConfiguration for custom run priority logic.
Allows you to decide each thread's priority settings with a Python function
that the server calls at the first run on a thread with no settings, which
can | https://reference.langchain.com/python/langgraph-cli/schemas/PriorityConfig |
| ClassCorsConfigSpecifies Cross-Origin Resource Sharing (CORS) rules for your server.
If omitted, defaults are typically very restrictive (often no cross-origin requests).
Configure carefully if you want to allow us | https://reference.langchain.com/python/langgraph-cli/schemas/CorsConfig |
| ClassConfigurableHeaderConfigCustomize which headers to include as configurable values in your runs.
By default, omits x-api-key, x-tenant-id, and x-service-key.
Exclusions (if provided) take precedence.
Each value can be a ra | https://reference.langchain.com/python/langgraph-cli/schemas/ConfigurableHeaderConfig |
| ClassHttpConfigConfiguration for the built-in HTTP server that powers your deployment's routes and endpoints. | https://reference.langchain.com/python/langgraph-cli/schemas/HttpConfig |
| ClassWebhookUrlPolicy | https://reference.langchain.com/python/langgraph-cli/schemas/WebhookUrlPolicy |
| ClassGraphDefDefinition of a graph with additional metadata. | https://reference.langchain.com/python/langgraph-cli/schemas/GraphDef |
| ClassWebhooksConfig | https://reference.langchain.com/python/langgraph-cli/schemas/WebhooksConfig |
| ClassUvSourceDeployment source rooted at a uv project or workspace. | https://reference.langchain.com/python/langgraph-cli/schemas/UvSource |
| ClassConfigTop-level config for langgraph-cli or similar deployment tooling. | https://reference.langchain.com/python/langgraph-cli/schemas/Config |
| ClassBuildResultCaptures the outcome of a build stage so the shared wait tail can be
parameterized identically for both local and remote builds. | https://reference.langchain.com/python/langgraph-cli/deploy/BuildResult |
| ClassById | https://reference.langchain.com/python/langgraph-cli/deploy/ById |
| ClassByName | https://reference.langchain.com/python/langgraph-cli/deploy/ByName |
| ClassByAgent | https://reference.langchain.com/python/langgraph-cli/deploy/ByAgent |
| ClassListener | https://reference.langchain.com/python/langgraph-cli/deploy/Listener |
| ClassUnplaced | https://reference.langchain.com/python/langgraph-cli/deploy/Unplaced |
| ClassOnListener | https://reference.langchain.com/python/langgraph-cli/deploy/OnListener |
| ClassRequestedPlacement | https://reference.langchain.com/python/langgraph-cli/deploy/RequestedPlacement |
| ClassExistingDeployment | https://reference.langchain.com/python/langgraph-cli/deploy/ExistingDeployment |
| ClassTable | https://reference.langchain.com/python/langgraph-cli/deploy/Table |
| ClassDeploymentRow | https://reference.langchain.com/python/langgraph-cli/deploy/DeploymentRow |
| ClassCreatedDeployment | https://reference.langchain.com/python/langgraph-cli/deploy/CreatedDeployment |
| ClassBuildSpec | https://reference.langchain.com/python/langgraph-cli/deploy/BuildSpec |
| ClassDockerBuildCommand | https://reference.langchain.com/python/langgraph-cli/deploy/DockerBuildCommand |
| ClassDeployContext | https://reference.langchain.com/python/langgraph-cli/deploy/DeployContext |
| ClassDeployOutcome | https://reference.langchain.com/python/langgraph-cli/deploy/DeployOutcome |
| ClassDeploymentSource | https://reference.langchain.com/python/langgraph-cli/deploy/DeploymentSource |
| ClassListenerRequiredError | https://reference.langchain.com/python/langgraph-cli/deploy/ListenerRequiredError |
| ClassManagedRegistrySource | https://reference.langchain.com/python/langgraph-cli/deploy/ManagedRegistrySource |
| ClassRemoteBuildSource | https://reference.langchain.com/python/langgraph-cli/deploy/RemoteBuildSource |
| ClassBuildAndPush | https://reference.langchain.com/python/langgraph-cli/deploy/BuildAndPush |
| ClassPublishedImage | https://reference.langchain.com/python/langgraph-cli/deploy/PublishedImage |
| ClassCreateOnlySettingsOptions for an external-image deployment that only apply when
creating one, never when updating an existing deployment. | https://reference.langchain.com/python/langgraph-cli/deploy/CreateOnlySettings |
| ClassCustomerRegistrySource | https://reference.langchain.com/python/langgraph-cli/deploy/CustomerRegistrySource |
| ClassNestedHelpGroupClick group that shows one level of nested subcommands in top-level help. | https://reference.langchain.com/python/langgraph-cli/deploy/NestedHelpGroup |
| ClassDeployGroupGroup that treats leading '-' args as passthrough docker flags. | https://reference.langchain.com/python/langgraph-cli/deploy/DeployGroup |
| ClassLogData | https://reference.langchain.com/python/langgraph-cli/analytics/LogData |
| ClassImageReference | https://reference.langchain.com/python/langgraph-cli/image_reference/ImageReference |
| ClassProgress | https://reference.langchain.com/python/langgraph-cli/progress/Progress |
| Functionpython_config_to_docker_uv_lock | https://reference.langchain.com/python/langgraph-cli/uv_lock/python_config_to_docker_uv_lock |
| Functionhas_disallowed_build_command_contentCheck if a command string contains disallowed characters or patterns. | https://reference.langchain.com/python/langgraph-cli/config/has_disallowed_build_command_content |
| Functionvalidate_configValidate a configuration dictionary. | https://reference.langchain.com/python/langgraph-cli/config/validate_config |
| Functionget_unknown_keysReturn warnings for unrecognized top-level keys (typos, etc.). | https://reference.langchain.com/python/langgraph-cli/config/get_unknown_keys |
| Functionvalidate_config_fileLoad and validate a configuration file. | https://reference.langchain.com/python/langgraph-cli/config/validate_config_file |
| Functionget_build_tools_to_uninstall | https://reference.langchain.com/python/langgraph-cli/config/get_build_tools_to_uninstall |
| Functionpython_config_to_dockerGenerate a Dockerfile from the configuration. | https://reference.langchain.com/python/langgraph-cli/config/python_config_to_docker |
| Functionnode_config_to_docker | https://reference.langchain.com/python/langgraph-cli/config/node_config_to_docker |
| Functiondefault_base_image | https://reference.langchain.com/python/langgraph-cli/config/default_base_image |
| Functiondocker_tag | https://reference.langchain.com/python/langgraph-cli/config/docker_tag |
| Functionconfig_to_docker | https://reference.langchain.com/python/langgraph-cli/config/config_to_docker |
| Functionconfig_to_compose | https://reference.langchain.com/python/langgraph-cli/config/config_to_compose |
| Functioncli | https://reference.langchain.com/python/langgraph-cli/cli/cli |
| Functionup | https://reference.langchain.com/python/langgraph-cli/cli/up |
| Functionbuild | https://reference.langchain.com/python/langgraph-cli/cli/build |
| Functiondockerfile | https://reference.langchain.com/python/langgraph-cli/cli/dockerfile |
| FunctiondevCLI entrypoint for running the LangGraph API server. | https://reference.langchain.com/python/langgraph-cli/cli/dev |
| Functionvalidate | https://reference.langchain.com/python/langgraph-cli/cli/validate |
| FunctionnewCreate a new LangGraph project from a template. | https://reference.langchain.com/python/langgraph-cli/cli/new |
| Functionprepare_args_and_stdin | https://reference.langchain.com/python/langgraph-cli/cli/prepare_args_and_stdin |
| FunctionpreparePrepare the arguments and stdin for running the LangGraph API server. | https://reference.langchain.com/python/langgraph-cli/cli/prepare |
| Functioncreate_archiveContext manager that creates a .tar.gz archive of the project source.
Uses _assemble_local_deps to discover local dependencies referenced in
langgraph.json, including those outside config.parent (mon | https://reference.langchain.com/python/langgraph-cli/archive/create_archive |
| Functioncan_build_locallyReturn whether local deployment builds can run on this machine.
Checks:
Docker binary is installed
Docker daemon is running
Buildx is available when cross-compilation is required (non-x86_64)
| https://reference.langchain.com/python/langgraph-cli/docker/can_build_locally |
| Functioncheck_capabilities | https://reference.langchain.com/python/langgraph-cli/docker/check_capabilities |
| Functiondebugger_compose | https://reference.langchain.com/python/langgraph-cli/docker/debugger_compose |
| Functiondict_to_yamlConvert a dictionary to a YAML string. | https://reference.langchain.com/python/langgraph-cli/docker/dict_to_yaml |
| Functioncompose_as_dictCreate a docker compose file as a dictionary in YML style. | https://reference.langchain.com/python/langgraph-cli/docker/compose_as_dict |
| FunctioncomposeCreate a docker compose file as a string. | https://reference.langchain.com/python/langgraph-cli/docker/compose |
| Functionbuild_docker_imageBuild a Docker image from a LangGraph config. | https://reference.langchain.com/python/langgraph-cli/docker/build_docker_image |
| FunctionRunner | https://reference.langchain.com/python/langgraph-cli/exec/Runner |
| Functionsubp_exec | https://reference.langchain.com/python/langgraph-cli/exec/subp_exec |
| Functionmonitor_stream | https://reference.langchain.com/python/langgraph-cli/exec/monitor_stream |
| Functionfind_tracked_packagesReturn every tracked package found in deps as : entries.
config is the absolute path to langgraph.json; dep paths in
config_json["dependencies"] are resolved relative to its pa | https://reference.langchain.com/python/langgraph-cli/dependency_tracking/find_tracked_packages |
| Functiondeployment_selector | https://reference.langchain.com/python/langgraph-cli/deploy/deployment_selector |
| Functionvalidate_deploy_commandsValidate optional deploy commands for disallowed content. | https://reference.langchain.com/python/langgraph-cli/deploy/validate_deploy_commands |
| Functionfind_deployment_by_name | https://reference.langchain.com/python/langgraph-cli/deploy/find_deployment_by_name |
| Functionnormalize_nameSanitize a deployment/directory name into a valid deployment name.
LangSmith Deployment names only allow lowercase
alphanumeric characters and hyphens ([a-z0-9-]).
Invalid characters are replaced wit | https://reference.langchain.com/python/langgraph-cli/deploy/normalize_name |
| Functionnormalize_image_tagValidate and return a Docker image tag.
Tags may only contain [A-Za-z0-9_.-]. Defaults to "latest" when empty. | https://reference.langchain.com/python/langgraph-cli/deploy/normalize_image_tag |
| Functionformat_timestampConvert a timestamp (epoch ms or string) to a readable string. | https://reference.langchain.com/python/langgraph-cli/deploy/format_timestamp |
| Functionformat_log_entryFormat a single log entry for display. | https://reference.langchain.com/python/langgraph-cli/deploy/format_log_entry |
| Functionlevel_fgReturn click color for a log level. | https://reference.langchain.com/python/langgraph-cli/deploy/level_fg |
| Functiondeploy | https://reference.langchain.com/python/langgraph-cli/deploy/deploy |
| Functiondeploy_list | https://reference.langchain.com/python/langgraph-cli/deploy/deploy_list |
| Functiondeploy_listeners | https://reference.langchain.com/python/langgraph-cli/deploy/deploy_listeners |
| Functiondeploy_listeners_list | https://reference.langchain.com/python/langgraph-cli/deploy/deploy_listeners_list |
| Functiondeploy_revisions | https://reference.langchain.com/python/langgraph-cli/deploy/deploy_revisions |
| Functiondeploy_revisions_list | https://reference.langchain.com/python/langgraph-cli/deploy/deploy_revisions_list |
| Functiondeploy_delete | https://reference.langchain.com/python/langgraph-cli/deploy/deploy_delete |
| Functiondeploy_logs | https://reference.langchain.com/python/langgraph-cli/deploy/deploy_logs |
| Functionget_anonymized_params | https://reference.langchain.com/python/langgraph-cli/analytics/get_anonymized_params |
| Functionlog_data | https://reference.langchain.com/python/langgraph-cli/analytics/log_data |
| Functionlog_command | https://reference.langchain.com/python/langgraph-cli/analytics/log_command |
| Functionclean_empty_lines | https://reference.langchain.com/python/langgraph-cli/util/clean_empty_lines |
| Functionwarn_non_wolfi_distroShow warning if image_distro is not set to 'wolfi'.
When emit is provided, each warning line is sent through it (used by
callers that need JSON-aware output). Otherwise falls back to colored
``cl | https://reference.langchain.com/python/langgraph-cli/util/warn_non_wolfi_distro |
| Functioncreate_newCreate a new LangGraph project at the specified PATH using the chosen TEMPLATE. | https://reference.langchain.com/python/langgraph-cli/templates/create_new |
| Modulelanggraph_cli | https://reference.langchain.com/python/langgraph-cli/langgraph_cli |
| Moduleuv_lock | https://reference.langchain.com/python/langgraph-cli/uv_lock |
| Moduleconfig | https://reference.langchain.com/python/langgraph-cli/config |
| ModulecliCLI entrypoint for LangGraph API server. | https://reference.langchain.com/python/langgraph-cli/cli |
| ModulearchiveCreate a tarball of project source for remote builds. | https://reference.langchain.com/python/langgraph-cli/archive |
| Moduleconstants | https://reference.langchain.com/python/langgraph-cli/constants |
| Moduledocker | https://reference.langchain.com/python/langgraph-cli/docker |
| Modulehost_backendHTTP client for LangGraph host backend deployments. | https://reference.langchain.com/python/langgraph-cli/host_backend |
| Moduleexec | https://reference.langchain.com/python/langgraph-cli/exec |
| Moduledependency_trackingDetection of tracked Python packages in a local LangGraph project.
Mirrors host-backend's host.models.dependency_tracking so that CLI-based
deploys report the same tracked_packages revision metad | https://reference.langchain.com/python/langgraph-cli/dependency_tracking |
| ModuleversionMain entrypoint into package. | https://reference.langchain.com/python/langgraph-cli/version |
| Moduleschemas | https://reference.langchain.com/python/langgraph-cli/schemas |
| ModuledeployDeploy command and subcommands for the LangGraph CLI. | https://reference.langchain.com/python/langgraph-cli/deploy |
| Moduleanalytics | https://reference.langchain.com/python/langgraph-cli/analytics |
| ModuleutilGeneral-purpose utilities shared across the LangGraph CLI. | https://reference.langchain.com/python/langgraph-cli/util |
| Moduleimage_reference | https://reference.langchain.com/python/langgraph-cli/image_reference |
| Moduleprogress | https://reference.langchain.com/python/langgraph-cli/progress |
| Moduletemplates | https://reference.langchain.com/python/langgraph-cli/templates |
| TypeDeploymentSelector | https://reference.langchain.com/python/langgraph-cli/deploy/DeploymentSelector |
| TypePlacement | https://reference.langchain.com/python/langgraph-cli/deploy/Placement |
| TypeImageSource | https://reference.langchain.com/python/langgraph-cli/deploy/ImageSource |