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

    LangChain Assistant

    Ask a question to get started

    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
    RESERVED_ENV_VARS
    attribute
    OPT_HOST_API_KEY
    attribute
    OPT_HOST_DEPLOYMENT_NAME
    attribute
    OPT_HOST_URL
    attribute
    OPT_VERBOSE

    Functions

    function
    log_command
    function
    build_docker_image
    function
    can_build_locally
    function
    Runner
    function
    subp_exec
    function
    warn_non_wolfi_distro
    function
    validate_deployment_selector
    function
    validate_deploy_commands
    function
    find_deployment_id_by_name
    function
    normalize_name
    function
    normalize_image_tag
    function
    format_deployments_table
    function
    format_revisions_table
    function
    format_timestamp
    function
    format_log_entry
    function
    level_fg
    function
    deploy
    function
    deploy_list
    function
    deploy_revisions
    function
    deploy_revisions_list
    function
    deploy_delete
    function
    deploy_logs

    Classes

    class
    HostBackendClient
    class
    HostBackendError
    class
    Progress
    class
    BuildResult
    class
    NestedHelpGroup
    class
    DeployGroup

    Modules

    View source on GitHub
    module
    langgraph_cli

    Build a Docker image from a LangGraph config.

    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)

    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.

    Ensure either deployment_id or name is provided.

    Validate optional deploy commands for disallowed content.

    Return deployment ID for an exact name match, or None if not found.

    Sanitize 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 with hyphens.

    Validate and return a Docker image tag.

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

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

    Format a single log entry for display.

    Return click color for a log level.

    Minimal JSON HTTP client for the host backend deployment service.

    Raised when the host backend returns an error response.

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

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

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