Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: make the studio web UI docs more clear #2812

Merged
merged 3 commits into from
Dec 18, 2024
+25 −13
Merged

docs: make the studio web UI docs more clear #2812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
328b03e
docs: make the studio web UI docs more clear
vbarda Dec 18, 2024
cf11752
update
vbarda Dec 18, 2024
e9a657b
fix links
vbarda Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/docs/concepts/langgraph_studio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,28 @@ The key features of LangGraph Studio are:

## Types

### Desktop app
### Development server with web UI

LangGraph Studio is available as a [desktop app](https://studio.langchain.com/) for MacOS users.
You can [run a local in-memory development server](../tutorials/langgraph-platform/local-server.md) that can be used to connect a local LangGraph app with a web version of the studio.
For example, if you start the local server with `langgraph dev` (running at `http://127.0.0.1:2024` by default), you can connect to the studio by navigating to:

While in Beta, LangGraph Studio is available for free to all [LangSmith](https://smith.langchain.com/) users on any plan tier.
```
https://smith.langchain.com/studio/?baseUrl=http://127.0.0.1:2024
```

See [instructions here](../cloud/reference/cli.md#dev) for more information.

The web UI version of the studio will connect to your locally running server — your agent is still running locally and never leaves your device.

### Cloud studio

If you have deployed your LangGraph application on LangGraph Platform (Cloud), you can access the studio as part of that

### Development server
### Desktop app

LangGraph CLI also contains a command for running an in-memory development server that can be used to connect a local LangGraph app with the studio.
See [instructions here](../cloud/reference/cli.md#dev) for more information.
LangGraph Studio is available as a [desktop app](https://studio.langchain.com/) for MacOS users.

The way this works is that it runs inside your local environment.
It will spin up an in-memory, development server to deploy the graph.
You can then connect to the studio via the Cloud hosted version of LangGraph Platform.
To be clear, the web studio will connect to your locally running server - your agent is still running locally and never leaves your device.
While in Beta, LangGraph Studio is available for free to all [LangSmith](https://smith.langchain.com/) users on any plan tier.

## Studio FAQs

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/how-tos/local-studio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ This guide shows you how to connect your local agent to [LangGraph Studio](../co

There are two ways to connect your local agent to LangGraph Studio:

- [Development Server](../concepts/langgraph_studio.md#development-server-with-web-ui): Python package, all platforms, no Docker
- [LangGraph Desktop](../concepts/langgraph_studio.md#desktop-app): Application, Mac only, requires Docker
- [Development Server](../concepts/langgraph_studio.md#dev-server): Python package, all platforms, no Docker

In this guide we will cover how to use the development server as that is generally an easier and better experience.

Expand All @@ -23,7 +23,7 @@ You will need to install [`langgraph-cli`](../cloud/reference/cli.md#langgraph-c
You will need to make sure to install the `inmem` extras.

```shell
pip install "langgraph-cli[inmem]==0.1.55"
pip install -U "langgraph-cli[inmem]"
```

## Run the development server
Expand Down
11 changes: 10 additions & 1 deletion docs/docs/tutorials/langgraph-platform/local-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,19 @@ This will start up the LangGraph API server locally. If this runs successfully,

## LangGraph Studio Web UI

Test your graph in the LangGraph Studio Web UI by visiting the URL provided in the output of the `langgraph dev` command.
LangGraph Studio Web is a specialized UI that you can connect to LangGraph API server to enable visualization, interaction, and debugging of your application locally. Test your graph in the LangGraph Studio Web UI by visiting the URL provided in the output of the `langgraph dev` command.

> - LangGraph Studio Web UI: https://smith.langchain.com/studio/?baseUrl=http://127.0.0.1:2024

!!! info "Connecting to a server with a custom host/port"

If you are running the LangGraph API server with a custom host / port, you can point the Studio Web UI at it by changing the `baseUrl` URL param. For example, if you are running your server on port 8000, you can change the above URL to the following:

```
https://smith.langchain.com/studio/baseUrl=http://127.0.0.1:8000
```


!!! warning "Safari Compatibility"

Currently, LangGraph Studio Web does not support Safari when running a server locally.
Expand Down
Loading