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.2.11.tar.gz (721.3 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.2.11-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for langgraph_cli-0.2.11.tar.gz
Algorithm Hash digest
SHA256 68ac6879382df860c67b747a689b1afb6475e64b62b8d50ede27654fa9a7d232
MD5 1c4d4a029bfd23d02391c8521d3daeef
BLAKE2b-256 08cba0ce30e24ea03eae969c384db42db9c27c9e5eb00356a9de93f45e412035

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for langgraph_cli-0.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 abbf5af548cdcef36dedb96cee0fdf6418ca5ae4fa1cab955e4f7fcedde5bf80
MD5 a9b6c81a4649eed71650e89a8898a811
BLAKE2b-256 9178340e9199714782dbde38e53a5053421e39f49fdb43c2466cd55bf84c879c

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