WEBDIENSTE/langgraph
1
0
Fork 0
mirror of https://github.com/langchain-ai/langgraph.git synced 2026-09-02 14:28:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Various updates to LangGraph Cloud docs (#805)

Browse Source 
* Change LangGraph Deploy to LangGraph Cloud in CLI reference.

* Update main README to link to Cloud docs. Update How-to Guide link in Cloud index page.

* Create Environments Variable reference page.

* Add Authentication to Conceptual Guide.

* Update setup how-to to refer back to CompiledGraph variable name.

* Update how-to notebooks for double texting.

* Add warning about setting top-level variable for CompiledGraph.
This commit is contained in:
Andrew Nguonly
2024-06-25 10:52:23 -07:00
committed by GitHub
parent 7490b2b38b
commit 11bf3bde54
13 changed files with 59 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/cloud/reference/cli.md
+8 -8
View File
@@ -1,5 +1,5 @@
# LangGraph CLI
The LangGraph CLI includes commands to build and run a LangGraph Cloud server locally in [Docker](https://www.docker.com/). For development and testing, use the CLI to deploy a local API server.
The LangGraph CLI includes commands to build and run a LangGraph Cloud API server locally in [Docker](https://www.docker.com/). For development and testing, use the CLI to deploy a local API server.
## Installation
1. Ensure that Docker is installed (e.g. `docker --version`).
@@ -11,7 +11,7 @@ The LangGraph CLI requires a JSON configuration file with the following keys:
| Key | Description |
| --- | ----------- |
| `dependencies` | **Required**. Array of dependencies for LangGraph Deploy 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. |
| `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 is defined. Example: `./your_package/your_file.py:variable`, where `variable` is an instance of `langgraph.graph.graph.CompiledGraph`. |
| `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`. |
@@ -65,7 +65,7 @@ langgraph [OPTIONS] COMMAND [ARGS]
```
### `build`
Build LangGraph Deploy API server Docker image.
Build LangGraph Cloud API server Docker image.
**Usage**
```
@@ -78,12 +78,12 @@ langgraph build [OPTIONS]
| ------ | ------- | ----------- |
| `--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 Deploy API server with locally built images. |
| `--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. |
### `down`
Stop LangGraph Deploy API server.
Stop LangGraph Cloud API server.
**Usage**
```
@@ -102,7 +102,7 @@ langgraph down [OPTIONS]
| `--help` | | Display command documentation. |
### `logs`
Show LangGraph Deploy API server logs.
Show LangGraph Cloud API server logs.
**Usage**
```
@@ -119,7 +119,7 @@ langgraph logs [OPTIONS]
| `--help` | | Display command documentation. |
### `up`
Start LangGraph Deploy API server.
Start LangGraph Cloud API server.
**Usage**
```
@@ -137,6 +137,6 @@ langgraph up [OPTIONS]
| `-c, --config FILE` | `langgraph.json` | Path to configuration file declaring dependencies, graphs and environment variables. |
| `-d, --docker-compose FILE` | | Advanced. Path to `docker-compose.yml` file with additional services to launch. |
| `-p, --port INTEGER` | `8123` | Port to expose. Example: `langgraph up --port 8000` |
| `--pull / --no-pull` | `--pull` | Build with latest remote Docker image. Use `--no-pull` for running the LangGraph Deploy API server with locally built images. |
| `--pull / --no-pull` | `--pull` | Build with latest remote Docker image. Use `--no-pull` for running the LangGraph Cloud API server with locally built images. |
| `--recreate / --no-recreate` | `--no-recreate` | Recreate containers even if their configuration and image haven't changed. |
| `--help` | | Display command documentation. |