langgraph/docs/docs/cloud/reference/cli.md

LangGraph CLI

The LangGraph CLI includes commands to build and run a LangGraph Cloud API server locally in Docker. For development and testing, use the CLI to deploy a local API server.

Installation

1. Ensure that Docker is installed (e.g. docker --version).
2. Install the langgraph-cli Python package (e.g. pip install langgraph-cli).
3. Run the command langgraph --help to confirm that the CLI is installed.

{#langgraph.json}

Configuration File

The LangGraph CLI requires a JSON configuration file with the following keys:

Key	Description
dependencies	Required. Array of dependencies for LangGraph Cloud API server. Dependencies can be one of the following: (1) ".", which will look for local Python packages, (2) pyproject.toml, setup.py or requirements.txt in the app directory "./local_package", or (3) a package name.
graphs	Required. Mapping from graph ID to path where the compiled graph or a function that makes a graph is defined. Example: ./your_package/your_file.py:variable, where variable is an instance of langgraph.graph.state.CompiledStateGraph ./your_package/your_file.py:make_graph, where make_graph is a function that takes a config dictionary (langchain_core.runnables.RunnableConfig) and creates an instance of langgraph.graph.state.StateGraph / langgraph.graph.state.CompiledStateGraph.
env	Path to .env file or a mapping from environment variable to its value.
python_version	3.11 or 3.12. Defaults to 3.11.
pip_config_file	Path to pip config file.
dockerfile_lines	Array of additional lines to add to Dockerfile following the import from parent image.

Note

The LangGraph CLI defaults to using the configuration file langgraph.json in the current directory.

Example:

{
    "dependencies": [
        "langchain_openai",
        "./your_package"
    ],
    "graphs": {
        "my_graph_id": "./your_package/your_file.py:variable"
    },
    "env": "./.env"
}

Example:

{
    "python_version": "3.11",
    "dependencies": [
        "langchain_openai",
        "."
    ],
    "graphs": {
        "my_graph_id": "./your_package/your_file.py:make_graph"
    },
    "env": {
        "OPENAI_API_KEY": "secret-key"
    }
}

Commands

The base command for the LangGraph CLI is langgraph.

Usage

langgraph [OPTIONS] COMMAND [ARGS]

build

Build LangGraph Cloud API server Docker image.

Usage

langgraph build [OPTIONS]

Options

Option	Default	Description
--platform TEXT		Target platform(s) to build the Docker image for. Example: langgraph build --platform linux/amd64,linux/arm64
-t, --tag TEXT		Required. Tag for the Docker image. Example: langgraph build -t my-image
--pull / --no-pull	--pull	Build with latest remote Docker image. Use --no-pull for running the LangGraph Cloud API server with locally built images.
-c, --config FILE	langgraph.json	Path to configuration file declaring dependencies, graphs and environment variables.
--help		Display command documentation.

up

Start langgraph API server. For local testing, requires a LangSmith API key with access to LangGraph Cloud closed beta. Requires a license key for production use.

Usage

langgraph up [OPTIONS]

Options

Option	Default	Description
--wait		Wait for services to start before returning. Implies --detach
--postgres-uri TEXT	Local database	Postgres URI to use for the database.
--watch		Restart on file changes
--debugger-base-url TEXT	http://127.0.0.1:[PORT]	URL used by the debugger to access LangGraph API.
--debugger-port INTEGER		Pull the debugger image locally and serve the UI on specified port
--verbose		Show more output from the server logs.
-c, --config FILE	langgraph.json	Path to configuration file declaring dependencies, graphs and environment variables.
-d, --docker-compose FILE		Path to docker-compose.yml file with additional services to launch.
-p, --port INTEGER	8123	Port to expose. Example: langgraph test --port 8000
--pull / --no-pull	pull	Pull latest images. Use --no-pull for running the server with locally-built images. Example: langgraph up --no-pull
--recreate / --no-recreate	no-recreate	Recreate containers even if their configuration and image haven't changed
--help		Display command documentation.

test

Test your LangGraph in the cloud. The only function you can call from the SDK after testing your graph is client.runs.stream(thread_id=None, ...)

Usage

langgraph test [OPTIONS]

Options

Option	Default	Description
--verbose		Show more output from the server logs.
-c, --config FILE	langgraph.json	Path to configuration file declaring dependencies, graphs and environment variables.
-p, --port INTEGER	8123	Port to expose. Example: langgraph test --port 8000
--pull / --no-pull	pull	Pull latest images. Use --no-pull for running the server with locally-built images. Example: langgraph up --no-pull
--help		Display command documentation.