Skip to main content

CLI for interacting with LangGraph API

Project description

LangGraph CLI

The official command-line interface for LangGraph, providing tools to create, develop, and deploy LangGraph applications.

Installation

Install via pip:

pip install langgraph-cli

For development mode with hot reloading:

pip install "langgraph-cli[inmem]"

Commands

langgraph new 🌱

Create a new LangGraph project from a template

langgraph new [PATH] --template TEMPLATE_NAME

langgraph dev 🏃‍♀️

Run LangGraph API server in development mode with hot reloading

langgraph dev [OPTIONS]
  --host TEXT                 Host to bind to (default: 127.0.0.1)
  --port INTEGER             Port to bind to (default: 2024)
  --no-reload               Disable auto-reload
  --debug-port INTEGER      Enable remote debugging
  --no-browser             Skip opening browser window
  -c, --config FILE        Config file path (default: langgraph.json)

langgraph up 🚀

Launch LangGraph API server in Docker

langgraph up [OPTIONS]
  -p, --port INTEGER        Port to expose (default: 8123)
  --wait                   Wait for services to start
  --watch                  Restart on file changes
  --verbose               Show detailed logs
  -c, --config FILE       Config file path
  -d, --docker-compose    Additional services file

langgraph build

Build a Docker image for your LangGraph application

langgraph build -t IMAGE_TAG [OPTIONS]
  --platform TEXT          Target platforms (e.g., linux/amd64,linux/arm64)
  --pull / --no-pull      Use latest/local base image
  -c, --config FILE       Config file path

langgraph dockerfile

Generate a Dockerfile for custom deployments

langgraph dockerfile SAVE_PATH [OPTIONS]
  -c, --config FILE       Config file path

Configuration

The CLI uses a langgraph.json configuration file with these key settings:

{
  "dependencies": ["langchain_openai", "./your_package"],  // Required: Package dependencies
  "graphs": {
    "my_graph": "./your_package/file.py:graph"            // Required: Graph definitions
  },
  "env": "./.env",                                        // Optional: Environment variables
  "python_version": "3.11",                               // Optional: Python version (3.11/3.12)
  "pip_config_file": "./pip.conf",                        // Optional: pip configuration
  "dockerfile_lines": []                                  // Optional: Additional Dockerfile commands
}

See the full documentation for detailed configuration options.

Development

To develop the CLI itself:

  1. Clone the repository
  2. Navigate to the CLI directory: cd libs/cli
  3. Install development dependencies: uv pip install
  4. Make your changes to the CLI code
  5. Test your changes:
    # Run CLI commands directly
    uv run langgraph --help
    
    # Or use the examples
    cd examples
    uv pip install
    uv run langgraph dev  # or other commands
    

License

This project is licensed under the terms specified in the repository's LICENSE file.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langgraph_cli-0.4.18.tar.gz (876.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langgraph_cli-0.4.18-py3-none-any.whl (55.6 kB view details)

Uploaded Python 3

File details

Details for the file langgraph_cli-0.4.18.tar.gz.

File metadata

  • Download URL: langgraph_cli-0.4.18.tar.gz
  • Upload date:
  • Size: 876.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for langgraph_cli-0.4.18.tar.gz
Algorithm Hash digest
SHA256 843f5990c18e425924b7fe34a164a13fb902d29ac92ceda9d21aa4b56057a91e
MD5 a2dff90c97b4fb30ca9ff9a79c128ca5
BLAKE2b-256 aed943f4c5083a9be70edf2add6d46c20bf8f6b69fca55d9e61a42ccd846886d

See more details on using hashes here.

File details

Details for the file langgraph_cli-0.4.18-py3-none-any.whl.

File metadata

  • Download URL: langgraph_cli-0.4.18-py3-none-any.whl
  • Upload date:
  • Size: 55.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for langgraph_cli-0.4.18-py3-none-any.whl
Algorithm Hash digest
SHA256 2327eb2b8859d5fd2c44bfc4f73def78b78c0d0bc4593de3b8cf37353d001f9d
MD5 a1fe24ad69d0e053cc56a11d5ac00c21
BLAKE2b-256 22040e7be7b6a4bcfe5f939495e7f0de2f8d911d481bf75848feb3aff3ac7c83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page