You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8558481
Browse filesBrowse the repository at this point in the historyBrowse files
Aligns the repository's package READMEs around a shared documentation
shape so users see consistent install, positioning, docs, release, and
contribution guidance across LangGraph packages.
This directory is retained purely for archival purposes and is no longer updated. The examples previously found here have been moved to the newly [consolidated LangChain documentation](https://docs.langchain.com/oss/python/langgraph/overview). Please refer to the LangChain docs for the most up-to-date examples and usage guidelines for LangGraph.
3
+
This directory is retained purely for archival purposes and is no longer updated.
4
+
5
+
## π€ What is this?
6
+
7
+
The examples previously found here have been moved to the consolidated LangChain documentation. This directory remains available for historical reference, but new examples and usage guidance are published in the docs.
8
+
9
+
## π Documentation
10
+
11
+
For up-to-date LangGraph examples, tutorials, and guides, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview). Get started with the [LangGraph Quickstart](https://docs.langchain.com/oss/python/langgraph/quickstart).
Copy file name to clipboardExpand all lines: libs/checkpoint-conformance/README.md
+27-5Lines changed: 27 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,27 @@
1
-
# langgraph-checkpoint-conformance
1
+
# LangGraph Checkpoint Conformance
2
2
3
-
Conformance test suite for [LangGraph](https://github.com/langchain-ai/langgraph) checkpointer implementations.
Validates that a `BaseCheckpointSaver` subclass correctly implements the checkpoint storage contract β blob round-trips, metadata preservation, namespace isolation, incremental channel updates, and more.
8
+
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9
+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
6
10
7
-
## Installation
11
+
## Quick Install
8
12
9
13
```bash
10
-
pip install langgraph-checkpoint-conformance
14
+
uv add langgraph-checkpoint-conformance
11
15
```
12
16
17
+
## π€ What is this?
18
+
19
+
This library provides a conformance test suite for [LangGraph](https://github.com/langchain-ai/langgraph) checkpointer implementations. It validates that a `BaseCheckpointSaver` subclass correctly implements the checkpoint storage contract β blob round-trips, metadata preservation, namespace isolation, incremental channel updates, and more.
20
+
21
+
## π Documentation
22
+
23
+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph/). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
24
+
13
25
## Quick start
14
26
15
27
Register your checkpointer with `@checkpointer_test` and run `validate()`:
@@ -110,3 +122,13 @@ async def pg_checkpointer():
110
122
asyncwith PostgresSaver.from_conn_string(CONN_STRING) as saver:
111
123
yield saver
112
124
```
125
+
126
+
## π Releases & Versioning
127
+
128
+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
129
+
130
+
## π Contributing
131
+
132
+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
133
+
134
+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9
+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
6
10
7
-
By default `langgraph-checkpoint-postgres` installs `psycopg` (Psycopg 3) without any extras. However, you can choose a specific installation that best suits your needs [here](https://www.psycopg.org/psycopg3/docs/basic/install.html) (for example, `psycopg[binary]`).
11
+
## Quick Install
12
+
13
+
```bash
14
+
uv add langgraph-checkpoint-postgres
15
+
```
16
+
17
+
## π€ What is this?
18
+
19
+
This library provides a Postgres implementation of LangGraph's checkpoint saver. Use it when you want LangGraph state persistence backed by Postgres for durable, long-running workflows and agents.
20
+
21
+
By default, `langgraph-checkpoint-postgres` installs `psycopg` (Psycopg 3) without any extras. You can choose a specific installation that best suits your needs in the [Psycopg installation docs](https://www.psycopg.org/psycopg3/docs/basic/install.html), for example `psycopg[binary]`.
22
+
23
+
## π Documentation
24
+
25
+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph.checkpoint.postgres). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
> When manually creating Postgres connections and passing them to `PostgresSaver` or `AsyncPostgresSaver`, make sure to include `autocommit=True` and `row_factory=dict_row` (`from psycopg.rows import dict_row`). See a full example in this [how-to guide](https://langchain-ai.github.io/langgraph/how-tos/persistence_postgres/).
21
39
>
22
40
> **Why these parameters are required:**
41
+
>
23
42
> -`autocommit=True`: Required for the `.setup()` method to properly commit the checkpoint tables to the database. Without this, table creation may not be persisted.
24
43
> -`row_factory=dict_row`: Required because the PostgresSaver implementation accesses database rows using dictionary-style syntax (e.g., `row["column_name"]`). The default `tuple_row` factory returns tuples that only support index-based access (e.g., `row[0]`), which will cause `TypeError` exceptions when the checkpointer tries to access columns by name.
25
44
>
26
45
> **Example of incorrect usage:**
46
+
>
27
47
> ```python
28
48
># β This will fail with TypeError during checkpointer operations
29
49
>with psycopg.connect(DB_URI) as conn: # Missing autocommit=True and row_factory=dict_row
@@ -118,3 +138,13 @@ async with AsyncPostgresSaver.from_conn_string(DB_URI) as checkpointer:
118
138
# list checkpoints
119
139
[c asyncfor c in checkpointer.alist(read_config)]
120
140
```
141
+
142
+
## π Releases & Versioning
143
+
144
+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
145
+
146
+
## π Contributing
147
+
148
+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
149
+
150
+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9
+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
10
+
11
+
## Quick Install
12
+
13
+
```bash
14
+
uv add langgraph-checkpoint-sqlite
15
+
```
16
+
17
+
## π€ What is this?
18
+
19
+
This library provides a SQLite implementation of LangGraph's checkpoint saver, with both sync and async support via `aiosqlite`. Use it when you want LangGraph state persistence backed by SQLite for local development, testing, or lightweight deployments.
20
+
21
+
## π Documentation
22
+
23
+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph.checkpoint.sqlite). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
4
24
5
25
## Security
6
26
@@ -91,3 +111,13 @@ async with AsyncSqliteSaver.from_conn_string(":memory:") as checkpointer:
91
111
# list checkpoints
92
112
[c asyncfor c in checkpointer.alist(read_config)]
93
113
```
114
+
115
+
## π Releases & Versioning
116
+
117
+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
118
+
119
+
## π Contributing
120
+
121
+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
122
+
123
+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
Copy file name to clipboardExpand all lines: libs/checkpoint/README.md
+32-2Lines changed: 32 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,26 @@
1
1
# LangGraph Checkpoint
2
2
3
-
This library defines the base interface for LangGraph checkpointers. Checkpointers provide a persistence layer for LangGraph. They allow you to interact with and manage the graph's state. When you use a graph with a checkpointer, the checkpointer saves a _checkpoint_ of the graph state at every superstep, enabling several powerful capabilities like human-in-the-loop, "memory" between interactions and more.
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9
+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
10
+
11
+
## Quick Install
12
+
13
+
```bash
14
+
uv add langgraph-checkpoint
15
+
```
16
+
17
+
## π€ What is this?
18
+
19
+
This library defines the base interface for LangGraph checkpointers. Checkpointers provide a persistence layer for LangGraph: they save graph state at every superstep, enabling human-in-the-loop, memory between interactions, durable execution, and more.
20
+
21
+
## π Documentation
22
+
23
+
For full documentation, see the [API reference](https://reference.langchain.com/python/langgraph.checkpoint). For conceptual guides on persistence and memory, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
4
24
5
25
## Key concepts
6
26
@@ -24,7 +44,7 @@ You must pass these when invoking the graph as part of the configurable part of
24
44
25
45
### Serde
26
46
27
-
`langgraph_checkpoint` also defines protocol for serialization/deserialization (serde) and provides an default implementation (`langgraph.checkpoint.serde.jsonplus.JsonPlusSerializer`) that handles a wide variety of types, including LangChain and LangGraph primitives, datetimes, enums and more.
47
+
`langgraph-checkpoint` also defines protocol for serialization/deserialization (serde) and provides a default implementation (`langgraph.checkpoint.serde.jsonplus.JsonPlusSerializer`) that handles a wide variety of types, including LangChain and LangGraph primitives, datetimes, enums and more.
28
48
29
49
> [!IMPORTANT]
30
50
> **Checkpoint deserialization security:** By default the serializer allows any Python type found in checkpoint data. New applications should set the environment variable `LANGGRAPH_STRICT_MSGPACK=true` or pass an explicit `allowed_msgpack_modules` list to `JsonPlusSerializer` to restrict deserialization to known-safe types.
@@ -89,3 +109,13 @@ checkpointer.get(read_config)
89
109
# list checkpoints
90
110
list(checkpointer.list(read_config))
91
111
```
112
+
113
+
## π Releases & Versioning
114
+
115
+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
116
+
117
+
## π Contributing
118
+
119
+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
120
+
121
+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
To help you ship LangGraph apps to production faster, check out [LangSmith](https://www.langchain.com/langsmith).
9
+
[LangSmith](https://www.langchain.com/langsmith) is a unified developer platform for building, testing, and monitoring LLM applications.
10
+
11
+
## Quick Install
6
12
7
-
Install via pip:
8
13
```bash
9
-
pip install langgraph-cli
14
+
uv add langgraph-cli
10
15
```
11
16
17
+
## π€ What is this?
18
+
19
+
The LangGraph CLI is the official command-line interface for LangGraph. It provides tools to create, develop, build, and run LangGraph applications locally or in Docker.
20
+
21
+
## π Documentation
22
+
23
+
For full documentation, see the [LangGraph CLI reference](https://reference.langchain.com/python/langgraph-cli). For conceptual guides and tutorials, see the [LangGraph Docs](https://docs.langchain.com/oss/python/langgraph/overview).
24
+
12
25
For development mode with hot reloading:
26
+
13
27
```bash
14
-
pip install"langgraph-cli[inmem]"
28
+
uv add"langgraph-cli[inmem]"
15
29
```
16
30
17
31
## Commands
18
32
19
33
### `langgraph new` π±
20
-
Create a new LangGraph project from a template
34
+
35
+
Create a new LangGraph project from a template.
36
+
21
37
```bash
22
38
langgraph new [PATH] --template TEMPLATE_NAME
23
39
```
24
40
25
41
### `langgraph dev` πββοΈ
26
-
Run LangGraph API server in development mode with hot reloading
42
+
43
+
Run LangGraph API server in development mode with hot reloading.
44
+
27
45
```bash
28
46
langgraph dev [OPTIONS]
29
47
--host TEXT Host to bind to (default: 127.0.0.1)
@@ -35,7 +53,9 @@ langgraph dev [OPTIONS]
35
53
```
36
54
37
55
### `langgraph up` π
38
-
Launch LangGraph API server in Docker
56
+
57
+
Launch LangGraph API server in Docker.
58
+
39
59
```bash
40
60
langgraph up [OPTIONS]
41
61
-p, --port INTEGER Port to expose (default: 8123)
@@ -47,7 +67,9 @@ langgraph up [OPTIONS]
47
67
```
48
68
49
69
### `langgraph build`
50
-
Build a Docker image for your LangGraph application
70
+
71
+
Build a Docker image for your LangGraph application.
72
+
51
73
```bash
52
74
langgraph build -t IMAGE_TAG [OPTIONS]
53
75
--platform TEXT Target platforms (e.g., linux/amd64,linux/arm64)
See the [full documentation](https://langchain-ai.github.io/langgraph/cloud/reference/cli/) for detailed configuration options.
106
+
See the [full documentation](https://reference.langchain.com/python/langgraph-cli) for detailed configuration options.
83
107
84
108
## Development
85
109
86
110
To develop the CLI itself:
87
111
88
112
1. Clone the repository
89
113
2. Navigate to the CLI directory: `cd libs/cli`
90
-
3. Install development dependencies: `uv pip install`
114
+
3. Install development dependencies: `uv sync`
91
115
4. Make your changes to the CLI code
92
116
5. Test your changes:
93
-
```bash
94
-
# Run CLI commands directly
95
-
uv run langgraph --help
96
-
97
-
# Or use the examples
98
-
cd examples
99
-
uv pip install
100
-
uv run langgraph dev # or other commands
101
-
```
102
-
103
-
## License
104
-
105
-
This project is licensed under the terms specified in the repository's LICENSE file.
117
+
118
+
```bash
119
+
# Run CLI commands directly
120
+
uv run langgraph --help
121
+
122
+
# Or use the examples
123
+
cd examples
124
+
uv sync
125
+
uv run langgraph dev # or other commands
126
+
```
127
+
128
+
## π Releases & Versioning
129
+
130
+
See our [Releases](https://docs.langchain.com/oss/python/release-policy) and [Versioning](https://docs.langchain.com/oss/python/versioning) policies.
131
+
132
+
## π Contributing
133
+
134
+
As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
135
+
136
+
For detailed information on how to contribute, see the [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview).
Copy file name to clipboardExpand all lines: libs/cli/js-examples/README.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ This template demonstrates a simple chatbot implemented using [LangGraph.js](htt
10
10
11
11
The core logic, defined in `src/agent/graph.ts`, showcases a straightforward chatbot that responds to user queries while maintaining context from previous messages.
12
12
13
-
## What it does
13
+
## π€ What is this?
14
14
15
15
The simple chatbot:
16
16
@@ -20,6 +20,10 @@ The simple chatbot:
20
20
21
21
This template provides a foundation that can be easily customized and extended to create more complex conversational agents.
22
22
23
+
## π Documentation
24
+
25
+
For JavaScript and TypeScript documentation, see the [LangGraph.js docs](https://docs.langchain.com/oss/javascript/langgraph/overview). LangGraph Studio also integrates with [LangSmith](https://smith.langchain.com/) for tracing and collaboration with teammates.
26
+
23
27
## Getting Started
24
28
25
29
Assuming you have already [installed LangGraph Studio](https://github.com/langchain-ai/langgraph-studio?tab=readme-ov-file#download), to set up:
0 commit comments