LangGraph CLI¶

LangGraph 命令行界面包含用于在本地 Docker 中构建和运行 LangGraph 平台 API 服务器的命令。出于开发和测试目的，您可以使用 CLI 部署本地 API 服务器。

安装¶

1. 确保已安装 Docker（例如 docker --version）。

2. 安装 CLI 包

   PythonJS

   pip install langgraph-cli
   

   npx @langchain/langgraph-cli
   
   # Install globally, will be available as `langgraphjs`
   npm install -g @langchain/langgraph-cli
   

3. 运行命令 langgraph --help 或 npx @langchain/langgraph-cli --help 以确认 CLI 正常工作。

配置文件¶

LangGraph CLI 需要一个遵循此 schema 的 JSON 配置文件。它包含以下属性

示例¶

{
  "dependencies": ["."],
  "graphs": {
    "chat": "./chat/graph.py:graph"
  }
}

{
  "dependencies": ["."],
  "graphs": {
    "chat": "./chat/graph.py:graph"
  },
  "image_distro": "wolfi"
}

{
  "dependencies": ["."],
  "graphs": {
    "memory_agent": "./agent/graph.py:graph"
  },
  "store": {
    "index": {
      "embed": "openai:text-embedding-3-small",
      "dims": 1536,
      "fields": ["$"]
    }
  }
}

{
  "dependencies": ["."],
  "graphs": {
    "memory_agent": "./agent/graph.py:graph"
  },
  "store": {
    "index": {
      "embed": "./embeddings.py:embed_texts",
      "dims": 768,
      "fields": ["text", "summary"]
    }
  }
}

# embeddings.py
def embed_texts(texts: list[str]) -> list[list[float]]:
    """Custom embedding function for semantic search."""
    # Implementation using your preferred embedding model
    return [[0.1, 0.2, ...] for _ in texts]  # dims-dimensional vectors

{
  "dependencies": ["."],
  "graphs": {
    "chat": "./chat/graph.py:graph"
  },
  "auth": {
    "path": "./auth.py:auth",
    "openapi": {
      "securitySchemes": {
        "apiKeyAuth": {
          "type": "apiKey",
          "in": "header",
          "name": "X-API-Key"
        }
      },
      "security": [{ "apiKeyAuth": [] }]
    },
    "disable_studio_auth": false
  }
}

{
  "dependencies": ["."],
  "graphs": {
    "memory_agent": "./agent/graph.py:graph"
  },
  "store": {
    "ttl": {
      "refresh_on_read": true,
      "sweep_interval_minutes": 60,
      "default_ttl": 10080 
    }
  }
}

{
  "dependencies": ["."],
  "graphs": {
    "chat": "./chat/graph.py:graph"
  },
  "checkpointer": {
    "ttl": {
      "strategy": "delete",
      "sweep_interval_minutes": 10,
      "default_ttl": 43200
    }
  }
}

{
  "graphs": {
    "chat": "./src/graph.ts:graph"
  }
}

命令¶

用量

langgraph [OPTIONS] COMMAND [ARGS]

npx @langchain/langgraph-cli [OPTIONS] COMMAND [ARGS]

dev¶

pip install -U "langgraph-cli[inmem]"

langgraph dev [OPTIONS]

npx @langchain/langgraph-cli dev [OPTIONS]

build¶

langgraph build [OPTIONS]

npx @langchain/langgraph-cli build [OPTIONS]

up¶

langgraph up [OPTIONS]

| --base-image TEXT | langchain/langgraph-api | 用于 LangGraph API 服务器的基础镜像。使用版本标签锁定到特定版本。 | | --image TEXT | | 用于 langgraph-api 服务的 Docker 镜像。如果指定，则跳过构建并直接使用此镜像。 | | --postgres-uri TEXT | 本地数据库 | 用于数据库的 Postgres URI。 | | --watch | | 文件更改时重启 | | --debugger-base-url TEXT | http://127.0.0.1:[PORT] | 调试器用于访问 LangGraph API 的 URL。 | | --debugger-port INTEGER | | 在本地拉取调试器镜像并在指定端口上提供 UI | | --verbose | | 显示更多服务器日志输出。 | | -c, --config FILE | langgraph.json | 声明依赖项、图和环境变量的配置文件路径。 | | -d, --docker-compose FILE | | 包含要启动的其他服务的 docker-compose.yml 文件路径。 | | -p, --port INTEGER | 8123 | 要暴露的端口。示例：langgraph up --port 8000 | | --pull / --no-pull | pull | 拉取最新镜像。使用 --no-pull 运行使用本地构建的镜像的服务器。示例：langgraph up --no-pull | | --recreate / --no-recreate | no-recreate | 即使配置和镜像未更改也重新创建容器 | | --help | | 显示命令文档。 |

npx @langchain/langgraph-cli up [OPTIONS]

| --base-image TEXT | langchain/langgraph-api | 用于 LangGraph API 服务器的基础镜像。使用版本标签锁定到特定版本。 | | --image TEXT | | 用于 langgraph-api 服务的 Docker 镜像。如果指定，则跳过构建并直接使用此镜像。 | | --postgres-uri TEXT | 本地数据库 | 用于数据库的 Postgres URI。 | | --watch | | 文件更改时重启 | | --debugger-base-url TEXT | http://127.0.0.1:[PORT] | 调试器用于访问 LangGraph API 的 URL。 | | --debugger-port INTEGER | | 在本地拉取调试器镜像并在指定端口上提供 UI | | -c, --config FILE | langgraph.json | 声明依赖项、图和环境变量的配置文件路径。 | | -d, --docker-compose FILE | | 包含要启动的其他服务的 docker-compose.yml 文件路径。 | | -p, --port INTEGER | 8123 | 要暴露的端口。示例：langgraph up --port 8000 | | --no-pull | | 使用本地构建的镜像。默认为 false 以使用最新的远程 Docker 镜像构建。 | | --recreate | | 即使配置和镜像未更改也重新创建容器 | | --help | | 显示命令文档。 |

dockerfile¶

langgraph dockerfile [OPTIONS] SAVE_PATH

langgraph dockerfile -c langgraph.json Dockerfile

FROM langchain/langgraph-api:3.11

ADD ./pipconf.txt /pipconfig.txt

RUN PIP_CONFIG_FILE=/pipconfig.txt PYTHONDONTWRITEBYTECODE=1 pip install --no-cache-dir -c /api/constraints.txt langchain_community langchain_anthropic langchain_openai wikipedia scikit-learn

ADD ./graphs /deps/__outer_graphs/src
RUN set -ex && \
    for line in '[project]' \
                'name = "graphs"' \
                'version = "0.1"' \
                '[tool.setuptools.package-data]' \
                '"*" = ["**/*"]'; do \
        echo "$line" >> /deps/__outer_graphs/pyproject.toml; \
    done

RUN PIP_CONFIG_FILE=/pipconfig.txt PYTHONDONTWRITEBYTECODE=1 pip install --no-cache-dir -c /api/constraints.txt -e /deps/*

ENV LANGSERVE_GRAPHS='{"agent": "/deps/__outer_graphs/src/agent.py:graph", "storm": "/deps/__outer_graphs/src/storm.py:graph"}'

npx @langchain/langgraph-cli dockerfile [OPTIONS] SAVE_PATH

npx @langchain/langgraph-cli dockerfile -c langgraph.json Dockerfile

FROM langchain/langgraphjs-api:20

ADD . /deps/agent

RUN cd /deps/agent && yarn install

ENV LANGSERVE_GRAPHS='{"agent":"./src/react_agent/graph.ts:graph"}'

WORKDIR /deps/agent

RUN (test ! -f /api/langgraph_api/js/build.mts && echo "Prebuild script not found, skipping") || tsx /api/langgraph_api/js/build.mts