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
Browse filesBrowse the repository at this point in the historyBrowse files
authored
docs: Improve README Quickstart section and add dark mode logo (#10358)
* Improve README Quickstart section and reorganize installation options
- Add prominent Desktop download section before Quickstart
- Remove $ symbols from shell commands to fix copy button functionality
- Add clear 'Run from source' option with make run_cli for developers
- Improve Docker installation instructions with usage details
- Move security warnings to after installation options for better flow
- Remove redundant star/issues badges
These changes address common user confusion when trying to run Langflow,
especially for developers who clone the repo first and then struggle with
the package installation instructions.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
* Add dark mode logo support
- Added picture element for automatic dark/light mode logo switching
- Dark mode shows blue background logo, light mode shows black logo
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
* Final README improvements
- Made 'Other install options' a proper section with emoji
- Updated deployment section with rocket emoji
- Fixed single-line formatting for subsections
- Added new star animation gif
- Changed 'tool' to 'platform' in description
* Improve Desktop download section messaging
- Made text more concise and action-oriented
- Changed download emoji from arrow to inbox
- Removed redundant 'built-in' and bold formatting
- Cleaner parenthetical for OS availability
* Revise README for Langflow Desktop and deployment info
Updated sections for clarity and added details about Langflow Desktop and deployment options.
* Revert star gif to GitHub attachment URL
Testing if local file path issue or markdown previewer issue
* Apply suggestion from @mendonk
* Apply suggestion from @mendonk
* Apply suggestion from @mendonk
* Apply suggestion from @mendonk
* readme-changes
* Apply suggestion from @mendonk
---------
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Co-authored-by: Gabriel Luiz Freitas Almeida <gabriel@langflow.org>
> - Langflow versions 1.6.0 through 1.6.3 have a critical bug where `.env` files are not read, potentially causing security vulnerabilities. **DO NOT** upgrade to these versions if you use `.env` files for configuration. Instead, upgrade to 1.6.4, which includes a fix for this bug.
17
-
> - Windows users of Langflow Desktop should **not** use the in-app update feature to upgrade to Langflow version 1.6.0. For upgrade instructions, see [Windows Desktop update issue](https://docs.langflow.org/release-notes#windows-desktop-update-issue).
18
-
> - Users must update to Langflow >= 1.3 to protect against [CVE-2025-3248](https://nvd.nist.gov/vuln/detail/CVE-2025-3248)
19
-
> - Users must update to Langflow >= 1.5.1 to protect against [CVE-2025-57760](https://github.com/langflow-ai/langflow/security/advisories/GHSA-4gv9-mp8m-592r)
20
-
>
21
-
> For security information, see our [Security Policy](./SECURITY.md) and [Security Advisories](https://github.com/langflow-ai/langflow/security/advisories).
22
-
23
-
[Langflow](https://langflow.org) is a powerful tool for building and deploying AI-powered agents and workflows. It provides developers with both a visual authoring experience and built-in API and MCP servers that turn every workflow into a tool that can be integrated into applications built on any framework or stack. Langflow comes with batteries included and supports all major LLMs, vector databases and a growing library of AI tools.
16
+
[Langflow](https://langflow.org) is a powerful platform for building and deploying AI-powered agents and workflows. It provides developers with both a visual authoring experience and built-in API and MCP servers that turn every workflow into a tool that can be integrated into applications built on any framework or stack. Langflow comes with batteries included and supports all major LLMs, vector databases and a growing library of AI tools.
24
17
25
18
## ✨ Highlight features
26
19
@@ -33,6 +26,13 @@
33
26
-**Observability** with LangSmith, LangFuse and other integrations.
34
27
-**Enterprise-ready** security and scalability.
35
28
29
+
## 🖥️ Langflow Desktop
30
+
31
+
Langflow Desktop is the easiest way to get started. It includes dependency management and automatic updates.
@@ -41,34 +41,53 @@ Requires Python 3.10–3.13 and [uv](https://docs.astral.sh/uv/getting-started/i
41
41
42
42
#### Install
43
43
44
+
From a fresh directory, run:
44
45
```shell
45
46
uv pip install langflow -U
46
47
```
47
48
48
-
Installs the latest Langflow package.
49
+
The latest Langflow package is installed.
50
+
For more information, see [Install and run the Langflow OSS Python package](https://docs.langflow.org/get-started-installation#install-and-run-the-langflow-oss-python-package).
49
51
50
52
#### Run
51
53
54
+
To start Langflow, run:
52
55
```shell
53
56
uv run langflow run
54
57
```
55
58
56
-
Starts the Langflow server at http://127.0.0.1:7860.
If you've cloned this repository and want to contribute, run this command from the repository root:
67
+
```shell
68
+
make run_cli
69
+
```
70
+
For more information, see [DEVELOPMENT.md](./DEVELOPMENT.md).
64
71
65
-
### Install from repo
72
+
### Docker
73
+
Start a Langflow container with default settings:
74
+
```shell
75
+
docker run -p 7860:7860 langflowai/langflow:latest
76
+
```
77
+
Langflow is available at http://localhost:7860/.
78
+
For configuration options, see the [Docker deployment guide](https://docs.langflow.org/deployment-docker).
66
79
67
-
If you're contributing or running from source, see [DEVELOPMENT.md](./DEVELOPMENT.md) for setup instructions.
80
+
> [!CAUTION]
81
+
> - Langflow versions 1.6.0 through 1.6.3 have a critical bug where `.env` files are not read, potentially causing security vulnerabilities. **DO NOT** upgrade to these versions if you use `.env` files for configuration. Instead, upgrade to 1.6.4, which includes a fix for this bug.
82
+
> - Windows users of Langflow Desktop should **not** use the in-app update feature to upgrade to Langflow version 1.6.0. For upgrade instructions, see [Windows Desktop update issue](https://docs.langflow.org/release-notes#windows-desktop-update-issue).
83
+
> - Users must update to Langflow >= 1.3 to protect against [CVE-2025-3248](https://nvd.nist.gov/vuln/detail/CVE-2025-3248)
84
+
> - Users must update to Langflow >= 1.5.1 to protect against [CVE-2025-57760](https://github.com/langflow-ai/langflow/security/advisories/GHSA-4gv9-mp8m-592r)
85
+
>
86
+
> For security information, see our [Security Policy](./SECURITY.md) and [Security Advisories](https://github.com/langflow-ai/langflow/security/advisories).
68
87
69
-
## 📦 Deployment
88
+
## 🚀 Deployment
70
89
71
-
Langflow is completely open source, and you can deploy it to all major clouds. To learn how to use Docker to deploy Langflow, see the [Docker deployment guide](https://docs.langflow.org/deployment-docker).
90
+
Langflow is completely open source and you can deploy it to all major deployment clouds. To learn how to deploy Langflow, see our [Langflow deployment guides](https://docs.langflow.org/deployment-overview).
0 commit comments