LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • LangGraph Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    ⌘I

    Chat LangChain

    What can I help with?

    Enter to send·Shift+Enter new line

    Menu

    LangGraph Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraph-clideploy
    Module●Since v0.4

    deploy

    Deploy command and subcommands for the LangGraph CLI.

    Attributes

    attribute
    DEFAULT_CONFIG: str
    attribute
    SourceName: Literal['internal_docker', 'internal_source', 'external_docker']
    attribute
    DIGEST_SEPARATOR: str
    attribute
    RESERVED_ENV_VARS
    attribute
    Resource: Mapping[str, object]
    attribute
    RowT
    attribute
    DEPLOYMENTS_TABLE
    attribute
    LISTENERS_TABLE
    attribute
    REVISIONS_TABLE
    attribute
    OPT_HOST_API_KEY
    attribute
    OPT_HOST_DEPLOYMENT_NAME
    attribute
    OPT_HOST_URL
    attribute
    OPT_AGENT_ID
    attribute
    OPT_AGENT_ENVIRONMENT
    attribute
    OPT_VERBOSE

    Functions

    function
    log_command
    function
    find_tracked_packages

    Return every tracked package found in deps as <name>:<version> entries.

    config is the absolute path to langgraph.json; dep paths in config_json["dependencies"] are resolved relative to its parent. Detection precedence per package: uv.lock resolved > pyproject.toml / requirements.txt specifier > bare reference > extras bracket (last two recorded as "unknown"). Output is ordered by TRACKED_PACKAGES.

    function
    compact_deployment_metrics

    Reshape UI charts without mutating the response; step is in seconds.

    function
    build_docker_image

    Build a Docker image from a LangGraph config.

    function
    can_build_locally

    Return 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)
    function
    Runner
    function
    subp_exec
    function
    warn_non_wolfi_distro

    Show 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 click.secho output.

    function
    deployment_selector
    function
    validate_deploy_commands

    Validate optional deploy commands for disallowed content.

    function
    find_deployment_by_name
    function
    normalize_name

    Sanitize an Agent Server/directory name into a valid Agent Server name.

    Agent Server names only allow lowercase alphanumeric characters and hyphens ([a-z0-9-]). Invalid characters are replaced with hyphens.

    function
    normalize_image_tag

    Validate and return a Docker image tag.

    Tags may only contain [A-Za-z0-9_.-]. Defaults to "latest" when empty.

    function
    format_timestamp

    Convert a timestamp (epoch ms or string) to a readable string.

    function
    format_log_entry

    Format a single log entry for display.

    function
    level_fg

    Return click color for a log level.

    function
    deploy
    function
    deploy_list
    function
    deploy_metrics
    function
    deploy_listeners
    function
    deploy_listeners_list
    function
    deploy_revisions
    function
    deploy_revisions_list
    function
    deploy_delete
    function
    deploy_logs

    Classes

    class
    Config

    Top-level config for langgraph-cli or similar deployment tooling.

    class
    CommandRunner
    class
    ControlPlaneEndpoints
    class
    HostBackendClient

    Minimal JSON HTTP client for the host backend deployment service.

    class
    HostBackendError

    Raised when the host backend returns an error response.

    class
    ImageReference
    class
    Progress
    class
    BuildResult

    Captures the outcome of a build stage so the shared wait tail can be parameterized identically for both local and remote builds.

    class
    ById
    class
    ByName
    class
    ByAgent
    class
    Listener
    class
    Unplaced
    class
    OnListener
    class
    RequestedPlacement
    class
    ExistingDeployment
    class
    Table
    class
    DeploymentRow
    class
    CreatedDeployment
    class
    BuildSpec
    class
    DockerBuildCommand
    class
    DeployContext
    class
    DeployOutcome
    class
    DeploymentSource
    class
    ListenerRequiredError
    class
    ManagedRegistrySource
    class
    RemoteBuildSource
    class
    BuildAndPush
    class
    PublishedImage
    class
    CreateOnlySettings

    Options for an external-image deployment that only apply when creating one, never when updating an existing deployment.

    class
    CustomerRegistrySource
    class
    NestedHelpGroup

    Click group that shows one level of nested subcommands in top-level help.

    class
    DeployGroup

    Group that treats leading '-' args as passthrough docker flags.

    Type Aliases

    typeAlias
    DeploymentSelector
    typeAlias
    Placement
    typeAlias
    ImageSource

    Modules

    module
    langgraph_cli
    View source on GitHub