diff --git a/docs/docs/cloud/reference/cli.md b/docs/docs/cloud/reference/cli.md index e1ddec38f..d0bce410f 100644 --- a/docs/docs/cloud/reference/cli.md +++ b/docs/docs/cloud/reference/cli.md @@ -10,9 +10,6 @@ The LangGraph command line interface includes commands to build and run a LangGr === "Python" ```bash pip install langgraph-cli - - # Install via Homebrew - brew install langgraph-cli ``` === "JS" @@ -298,6 +295,11 @@ The LangGraph CLI requires a JSON configuration file that follows this [schema]( | `--no-reload` | | Disable auto-reload | | `--n-jobs-per-worker INTEGER` | | Number of jobs per worker. Default is 10 | | `--debug-port INTEGER` | | Port for debugger to listen on | + | `--wait-for-client` | `False` | Wait for a debugger client to connect to the debug port before starting the server | + | `--no-browser` | | Skip automatically opening the browser when the server starts | + | `--studio-url TEXT` | | URL of the LangGraph Studio instance to connect to. Defaults to https://smith.langchain.com | + | `--allow-blocking` | `False` | Do not raise errors for synchronous I/O blocking operations in your code (added in `0.2.6`) | + | `--tunnel` | `False` | Expose the local server via a public tunnel (Cloudflare) for remote frontend access. This avoids issues with browsers like Safari or networks blocking localhost connections | | `--help` | | Display command documentation | @@ -321,6 +323,11 @@ The LangGraph CLI requires a JSON configuration file that follows this [schema]( | `--no-reload` | | Disable auto-reload | | `--n-jobs-per-worker INTEGER` | | Number of jobs per worker. Default is 10 | | `--debug-port INTEGER` | | Port for debugger to listen on | + | `--wait-for-client` | `False` | Wait for a debugger client to connect to the debug port before starting the server | + | `--no-browser` | | Skip automatically opening the browser when the server starts | + | `--studio-url TEXT` | | URL of the LangGraph Studio instance to connect to. Defaults to https://smith.langchain.com | + | `--allow-blocking` | `False` | Do not raise errors for synchronous I/O blocking operations in your code | + | `--tunnel` | `False` | Expose the local server via a public tunnel (Cloudflare) for remote frontend access. This avoids issues with browsers or networks blocking localhost connections | | `--help` | | Display command documentation | ### `build` diff --git a/docs/docs/stylesheets/logos.css b/docs/docs/stylesheets/logos.css new file mode 100644 index 000000000..a78629ccf --- /dev/null +++ b/docs/docs/stylesheets/logos.css @@ -0,0 +1,3 @@ +.safari { + color: #0070C9; +} \ No newline at end of file diff --git a/docs/docs/troubleshooting/errors/index.md b/docs/docs/troubleshooting/errors/index.md index 1b2c5da43..bdabaa645 100644 --- a/docs/docs/troubleshooting/errors/index.md +++ b/docs/docs/troubleshooting/errors/index.md @@ -14,3 +14,4 @@ Errors referenced below will have an `lc_error_code` property corresponding to o These guides provide troubleshooting information for errors that are specific to the LangGraph Platform. - [INVALID_LICENSE](./INVALID_LICENSE.md) +- [Studio Errors](../studio.md) diff --git a/docs/docs/troubleshooting/studio.md b/docs/docs/troubleshooting/studio.md new file mode 100644 index 000000000..b88db0e3c --- /dev/null +++ b/docs/docs/troubleshooting/studio.md @@ -0,0 +1,45 @@ +# Troubleshooting LangGraph Studio + +## :fontawesome-brands-safari:{ .safari } Safari connection error with local dev server + +Safari blocks plain‑HTTP traffic on localhost. If you start Studio with a vanilla +`langgraph dev`, the page may report a "Failed to load assistants" error (or something similar) and the browser DevTools will show network errors. + +#### Quick fix — run Studio through a secure Cloudflare tunnel + +=== "Python" + + ```shell + pip install -U langgraph-cli>=0.2.6 # Python + langgraph dev --tunnel + ``` +=== "JS" + + ```shell + # Requires @langchain/langgraph-cli>=0.0.26 + npx @langchain/langgraph-cli dev + ``` + +The command prints a URL like: + +```shell +https://smith.langchain.com/studio/?baseUrl=https://hamilton-praise-heart-costumes.trycloudflare.com +``` +where +```shell +?baseUrl=https://hamilton-praise-heart-costumes.trycloudflare.com +``` +indicates the endpoint where your agent server is exposed. + +Open that URL in Safari and Studio should load immediately. + +#### Alternative — use a Chromium‑based browser + +Chrome, Edge, and Brave allow HTTP on localhost, so a plain `langgraph dev` should work without extra steps. + +#### If it’s still not loading + +1. Make sure the `baseUrl` query parameter in the studio URL points to the **tunnel URL** NOT to localhost. +2. Confirm your CLI version with `langgraph --version`. + +No other configuration, certificates, or CORS tweaks are required. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3bfd6b0fc..dda548ae2 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -400,6 +400,7 @@ nav: - troubleshooting/errors/MULTIPLE_SUBGRAPHS.md - troubleshooting/errors/INVALID_CHAT_HISTORY.md - troubleshooting/errors/INVALID_LICENSE.md + - troubleshooting/studio.md - LangGraph Academy Course: https://academy.langchain.com/courses/intro-to-langgraph - Agents: @@ -549,3 +550,4 @@ copyright: > Copyright © 2025 LangChain, Inc | Consent Preferences extra_css: - stylesheets/version_admonitions.css + - stylesheets/logos.css