Skip to content

Commit 11305b3

Browse files
committed
Update reference content
1 parent 2ba6aa4 commit 11305b3

23 files changed

+130
-109
lines changed

src/docs.json

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1019,15 +1019,14 @@
10191019
]
10201020
},
10211021
"langsmith/cli",
1022-
"langsmith/env-var",
1023-
"langsmith/langgraph-cli"
1022+
"langsmith/env-var"
10241023
]
10251024
},
10261025
{
10271026
"group": "Scalability & resilience",
10281027
"pages": [
1029-
"langsmith/cloud-architecture-and-scalability",
1030-
"langsmith/scalability-and-resilience"
1028+
"langsmith/scalability-and-resilience",
1029+
"langsmith/cloud-architecture-and-scalability"
10311030
]
10321031
},
10331032
{
@@ -2075,15 +2074,14 @@
20752074
]
20762075
},
20772076
"langsmith/cli",
2078-
"langsmith/env-var",
2079-
"langsmith/langgraph-cli"
2077+
"langsmith/env-var"
20802078
]
20812079
},
20822080
{
20832081
"group": "Scalability & resilience",
20842082
"pages": [
2085-
"langsmith/cloud-architecture-and-scalability",
2086-
"langsmith/scalability-and-resilience"
2083+
"langsmith/scalability-and-resilience",
2084+
"langsmith/cloud-architecture-and-scalability"
20872085
]
20882086
},
20892087
{

src/langsmith/application-structure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The `langgraph.json` file is a JSON file that specifies the dependencies, graphs
8383
See the [LangGraph configuration file reference](/langsmith/cli#configuration-file) for details on all supported keys in the JSON file.
8484

8585
<Tip>
86-
The [LangGraph CLI](/langsmith/langgraph-cli) defaults to using the configuration file `langgraph.json` in the current directory.
86+
The [LangGraph CLI](/langsmith/cli) defaults to using the configuration file `langgraph.json` in the current directory.
8787
</Tip>
8888

8989
### Examples

src/langsmith/authentication-methods.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Enterprise customers can configure [SAML SSO](/langsmith/user-management) and [S
2121

2222
## Self-Hosted
2323

24-
Self-hosted customers have more control over how their users can login to LangSmith. For more in-depth coverage of configuration options, see [the self-hosting docs](/langsmith/architectural-overview) and [Helm chart](https://github.com/langchain-ai/helm/tree/main/charts/langsmith).
24+
Self-hosted customers have more control over how their users can login to LangSmith. For more in-depth coverage of configuration options, see [the self-hosting docs](/langsmith/self-hosted) and [Helm chart](https://github.com/langchain-ai/helm/tree/main/charts/langsmith).
2525

2626
### SSO with OAuth 2.0 and OIDC
2727

src/langsmith/cli.mdx

Lines changed: 43 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,52 @@ title: LangGraph CLI
33
sidebarTitle: CLI
44
---
55

6-
The LangGraph command line interface includes commands to build and run a LangSmith Platform API server locally in [Docker](https://www.docker.com/). For development and testing, you can use the CLI to deploy a local API server.
6+
**LangGraph CLI** is a command-line tool for building and running the [LangGraph API server](/langsmith/langgraph-server) locally. The resulting server exposes all API endpoints for runs, threads, assistants, etc., and includes supporting services such as a managed database for checkpointing and storage.
77

88
## Installation
99

10-
1. Ensure that Docker is installed (e.g. `docker --version`).
11-
2. Install the CLI package:
12-
<Tabs>
13-
<Tab title="Python">
14-
```bash
15-
pip install langgraph-cli
16-
```
17-
</Tab>
18-
<Tab title="JS">
19-
```bash
20-
npx @langchain/langgraph-cli
21-
22-
# Install globally, will be available as `langgraphjs`
23-
npm install -g @langchain/langgraph-cli
24-
```
25-
</Tab>
26-
</Tabs>
27-
3. Run the command `langgraph --help` or `npx @langchain/langgraph-cli --help` to confirm that the CLI is working correctly.
28-
29-
<a id="configuration-file"></a>
30-
## Configuration File
10+
1. Ensure Docker is installed (e.g., `docker --version`).
11+
1. Install the CLI:
12+
13+
<CodeGroup>
14+
```bash [Python (pip)]
15+
pip install langgraph-cli
16+
```
17+
```bash Homebrew
18+
brew install langgraph-cli
19+
```
20+
```bash JavaScript
21+
# Use latest on demand
22+
npx @langchain/langgraph-cli
23+
24+
# Or install globally (available as `langgraphjs`)
25+
npm install -g @langchain/langgraph-cli
26+
```
27+
</CodeGroup>
28+
29+
1. Verify the install
30+
31+
<CodeGroup>
32+
```bash [Python (pip)]
33+
langgraph --help
34+
```
35+
```bash JavaScript
36+
npx @langchain/langgraph-cli --help
37+
```
38+
</CodeGroup>
39+
40+
### Quick commands
41+
42+
| Command | What it does |
43+
| --- | --- |
44+
| [`langgraph dev`](#dev) | Starts a lightweight local dev server (no Docker required), ideal for rapid testing. |
45+
| [`langgraph build`](#build) | Builds a Docker image of your LangGraph API server for deployment. |
46+
| [`langgraph dockerfile`](#dockerfile) | Emits a Dockerfile derived from your config for custom builds. |
47+
| [`langgraph up`](#up) | Starts the LangGraph API server locally in Docker. Requires Docker running; LangSmith API key for local dev; license for production. |
48+
49+
For JS, use `npx @langchain/langgraph-cli <command>` (or `langgraphjs` if installed globally).
50+
51+
## Configuration file
3152

3253
The LangGraph CLI requires a JSON configuration file that follows this [schema](https://raw.githubusercontent.com/langchain-ai/langgraph/refs/heads/main/libs/cli/schemas/schema.json). It contains the following properties:
3354

src/langsmith/cloud-architecture-and-scalability.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebarTitle: Cloud architecture and scalability
66
<Note>
77
This section is only relevant for the cloud-managed LangSmith services available at [https://smith.langchain.com](https://smith.langchain.com) and [https://eu.smith.langchain.com](https://eu.smith.langchain.com).
88

9-
For information on the self-hosted LangSmith solution, please refer to the [self-hosted documentation](/langsmith/architectural-overview).
9+
For information on the self-hosted LangSmith solution, please refer to the [self-hosted documentation](/langsmith/self-hosted).
1010
</Note>
1111

1212
LangSmith is deployed on Google Cloud Platform (GCP) and is designed to be highly scalable. Many customers run production workloads on LangSmith for both LLM application observability and evaluation.

src/langsmith/components.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebarTitle: Deployment components
66
When running the self-hosted [LangSmith Platform with agent deployment](/langsmith/deploy-self-hosted-full-platform), your installation includes several key components. Together these tools and services provide a complete solution for building, deploying, and managing graphs (including agentic applications) in your own infrastructure:
77

88
- [LangGraph Server](/langsmith/langgraph-server): Defines an opinionated API and runtime for deploying graphs and agents. Handles execution, state management, and persistence so you can focus on building logic rather than server infrastructure.
9-
- [LangGraph CLI](/langsmith/langgraph-cli): A command-line interface to build, package, and interact with graphs locally and prepare them for deployment.
9+
- [LangGraph CLI](/langsmith/cli): A command-line interface to build, package, and interact with graphs locally and prepare them for deployment.
1010
- [Studio](/langsmith/langgraph-studio): A specialized IDE for visualization, interaction, and debugging. Connects to a local LangGraph Server for developing and testing your graph.
1111
- [Python/JS SDK](/langsmith/sdk): The Python/JS SDK provides a programmatic way to interact with deployed graphs and agents from your applications.
1212
- [Remote Graph](/langsmith/use-remote-graph): Allows you to interact with a deployed graph as though it were running locally.

src/langsmith/data-storage-and-privacy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document describes how data is processed in the LangGraph CLI and the LangG
66

77
## CLI
88

9-
LangGraph **CLI** is the command-line interface for building and running LangGraph applications; see the [CLI guide](/langsmith/langgraph-cli) to learn more.
9+
LangGraph **CLI** is the command-line interface for building and running LangGraph applications; see the [CLI guide](/langsmith/cli) to learn more.
1010

1111
By default, calls to most CLI commands log a single analytics event upon invocation. This helps us better prioritize improvements to the CLI experience. Each telemetry event contains the calling process's OS, OS version, Python version, the CLI version, the command name (`dev`, `up`, `run`, etc.), and booleans representing whether a flag was passed to the command. You can see the full analytics logic [here](https://github.com/langchain-ai/langgraph/blob/main/libs/cli/langgraph-cli/analytics.py).
1212

src/langsmith/deploy-hybrid.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ The Hybrid deployment option requires an [Enterprise](/langsmith/plans) plan.
1313

1414
## Prerequisites
1515

16-
1. Use the [LangGraph CLI](/langsmith/langgraph-cli) to [test your application locally](/langsmith/local-server).
17-
2. Use the [LangGraph CLI](/langsmith/langgraph-cli) to build a Docker image (i.e. `langgraph build`) and push it to a registry your Kubernetes cluster or Amazon ECS cluster has access to.
16+
1. Use the [LangGraph CLI](/langsmith/cli) to [test your application locally](/langsmith/local-server).
17+
2. Use the [LangGraph CLI](/langsmith/cli) to build a Docker image (i.e. `langgraph build`) and push it to a registry your Kubernetes cluster or Amazon ECS cluster has access to.
1818

1919
## Kubernetes
2020

src/langsmith/deploy-self-hosted-full-platform.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Self-hosting LangSmith Platform with agent deployment requires an [Enterprise](/
1515

1616
1. You are using Kubernetes.
1717
2. You have an instance of [self-hosted LangSmith Platform](/langsmith/kubernetes) running.
18-
3. Use the [LangGraph CLI](/langsmith/langgraph-cli) to [test your application locally](/langsmith/local-server).
19-
4. Use the [LangGraph CLI](/langsmith/langgraph-cli) to build a Docker image (i.e. `langgraph build`) and push it to a registry your Kubernetes cluster has access to.
18+
3. Use the [LangGraph CLI](/langsmith/cli) to [test your application locally](/langsmith/local-server).
19+
4. Use the [LangGraph CLI](/langsmith/cli) to build a Docker image (i.e. `langgraph build`) and push it to a registry your Kubernetes cluster has access to.
2020
5. `KEDA` is installed on your cluster.
2121
```bash
2222
helm repo add kedacore https://kedacore.github.io/charts

src/langsmith/deploy-standalone-server.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Before setting up standalone servers, review the [self-hosting overview page](/l
88

99
## Prerequisites
1010

11-
1. Use the [LangGraph CLI](/langsmith/langgraph-cli) to [test your application locally](/langsmith/local-server).
12-
2. Use the [LangGraph CLI](/langsmith/langgraph-cli) to build a Docker image (i.e. `langgraph build`).
11+
1. Use the [LangGraph CLI](/langsmith/cli) to [test your application locally](/langsmith/local-server).
12+
2. Use the [LangGraph CLI](/langsmith/cli) to build a Docker image (i.e. `langgraph build`).
1313
3. The following environment variables are needed for a data plane deployment.
1414
1. `REDIS_URI`: Connection details to a Redis instance. Redis will be used as a pub-sub broker to enable streaming real time output from background runs. The value of `REDIS_URI` must be a valid [Redis connection URI](https://redis-py.readthedocs.io/en/stable/connections.html#redis.Redis.from_url).
1515
<Note>
@@ -27,7 +27,7 @@ Before setting up standalone servers, review the [self-hosting overview page](/l
2727
</Note>
2828
3. `LANGSMITH_API_KEY`: LangSmith API key.
2929
4. `LANGGRAPH_CLOUD_LICENSE_KEY`: LangSmith Platform license key. This will be used to authenticate ONCE at server start up.
30-
5. `LANGSMITH_ENDPOINT`: To send traces to a [self-hosted LangSmith](/langsmith/architectural-overview) instance, set `LANGSMITH_ENDPOINT` to the hostname of the self-hosted LangSmith instance.
30+
5. `LANGSMITH_ENDPOINT`: To send traces to a [self-hosted LangSmith](/langsmith/self-hosted) instance, set `LANGSMITH_ENDPOINT` to the hostname of the self-hosted LangSmith instance.
3131
4. Egress to `https://beacon.langchain.com` from your network. This is required for license verification and usage reporting if not running in air-gapped mode. See the [Egress documentation](/langsmith/egress-metrics-metadata) for more details.
3232

3333
<a id="helm"></a>

0 commit comments

Comments
 (0)