diff --git a/README.md b/README.md index a8676da6b..7aa3e8c90 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,16 @@ -
-

Langflow 1.0 is OUT! πŸŽ‰

-

Read all about it here!

-
- # [![Langflow](./docs/static/img/hero.png)](https://www.langflow.org) -

- A visual framework for building multi-agent and RAG applications -

- Open-source, Python-powered, fully customizable, LLM and vector store agnostic + Langflow is a low-code app builder for RAG (retrieval augmented generation) and multi-agent AI applications. It’s Python-based and agnostic to any model, API, data source or database.

Docs - + Free Cloud Service - Join our Discord - - Follow us on X - - Live demo -

- -

- - - - - - + Follow us on X

@@ -39,168 +22,41 @@

- Your GIF + +https://github.com/user-attachments/assets/a1a36011-6169-4804-87ad-cfd4c5a79872 +

-# πŸ“ Content +# Core features +1. Python-based and agnostic to models, APIs, data sources, or databases. +2. Visual IDE for drag-and-drop building and testing of workflows. +3. Playground to immediately test and iterate workflows with step-by-step control. +4. Multi-agent orchestration and conversation management and retrieval. +5. Free cloud service - get started in minutes with no setup. +6. Publish workflows as back-end APIs or export as a Python application. +7. Real time observability with LangSmith, LangFuse, or LangWatch integration. +8. Support enterprise security and scale with free DataStax Langflow cloud service. +9. Prebuilt ecosystem integrations to any model, API or database. -- [πŸ“ Content](#-content) -- [πŸ“¦ Get Started](#-get-started) -- [Running Langflow from a Cloned Repository](#running-langflow-from-a-cloned-repository) -- [🎨 Create Flows](#-create-flows) -- [Deploy](#deploy) - - [DataStax Langflow](#datastax-langflow) - - [Deploy Langflow on Hugging Face Spaces](#deploy-langflow-on-hugging-face-spaces) - - [Deploy Langflow on Google Cloud Platform](#deploy-langflow-on-google-cloud-platform) - - [Deploy on Railway](#deploy-on-railway) - - [Deploy on Render](#deploy-on-render) - - [Deploy on Kubernetes](#deploy-on-kubernetes) -- [πŸ–₯️ Command Line Interface (CLI)](#️-command-line-interface-cli) - - [Usage](#usage) - - [Environment Variables](#environment-variables) -- [πŸ‘‹ Contribute](#-contribute) -- [🌟 Contributors](#-contributors) -- [πŸ“„ License](#-license) -# πŸ“¦ Get Started +![Integrations](https://github.com/user-attachments/assets/df4a6714-60de-4a8b-aff0-982c5aa467e3) -You can install Langflow with pip: +# Stay up-to-date +Star Langflow on GitHub to be instantly notified of new releases. + +![Star Langflow](https://github.com/user-attachments/assets/03168b17-a11d-4b2a-b0f7-c1cce69e5a2c) + +# πŸ“¦ Quick Start + +- **Install Langflow with pip** (Python version 3.10 or greater): ```shell -# Make sure you have >=Python 3.10 installed on your system. python -m pip install langflow -U ``` -Then, run Langflow with: - -```shell -python -m langflow run -``` - -# Running Langflow from a Cloned Repository - -If you prefer to run Langflow from a cloned repository rather than installing it via pip, follow these steps: - -1. **Clone the Repository** - -First, clone the Langflow repository from GitHub: - -```shell -git clone https://github.com/langflow-ai/langflow.git -``` - -Navigate into the cloned directory: - -```shell -cd langflow -``` - -2. **Build and Install Dependencies** - -To build and install Langflow’s frontend and backend, use the following commands: - -```shell -make install_frontend && make build_frontend && make install_backend -``` - -3. **Run Langflow** - -Once the installation is complete, you can run Langflow with: - -```shell -poetry run python -m langflow run -``` - -# 🎨 Create Flows - -Creating flows with Langflow is easy. Simply drag components from the sidebar onto the workspace and connect them to start building your application. - -Explore by editing prompt parameters, grouping components into a single high-level component, and building your own Custom Components. - -Once you’re done, you can export your flow as a JSON file. - -Load the flow with: - -```python -from langflow.load import run_flow_from_json - -results = run_flow_from_json("path/to/flow.json", input_value="Hello, World!") -``` - -# Deploy - -## DataStax Langflow - -DataStax Langflow is a hosted version of Langflow integrated with [AstraDB](https://www.datastax.com/products/datastax-astra). Be up and running in minutes with no installation or setup required. [Sign up for free](https://langflow.datastax.com). - -## Deploy Langflow on Hugging Face Spaces - -You can also preview Langflow in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow). [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow?duplicate=true) to create your own Langflow workspace in minutes. - -## Deploy Langflow on Google Cloud Platform - -Follow our step-by-step guide to deploy Langflow on Google Cloud Platform (GCP) using Google Cloud Shell. The guide is available in the [**Langflow in Google Cloud Platform**](./docs/docs/Deployment/deployment-gcp.md) document. - -Alternatively, click the **"Open in Cloud Shell"** button below to launch Google Cloud Shell, clone the Langflow repository, and start an **interactive tutorial** that will guide you through the process of setting up the necessary resources and deploying Langflow on your GCP project. - -[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/langflow-ai/langflow&working_dir=scripts/gcp&shellonly=true&tutorial=walkthroughtutorial_spot.md) - -## Deploy on Railway - -Use this template to deploy Langflow 1.0 on Railway: - -[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/JMXEWp?referralCode=MnPSdg) - -## Deploy on Render - - -Deploy to Render - - -## Deploy on Kubernetes - -Follow our step-by-step guide to deploy [Langflow on Kubernetes](./docs/docs/Deployment/deployment-kubernetes.md). - -# πŸ–₯️ Command Line Interface (CLI) - -Langflow provides a command-line interface (CLI) for easy management and configuration. - -## Usage - -You can run the Langflow using the following command: - -```shell -langflow run [OPTIONS] -``` - -Each option is detailed below: - -- `--help`: Displays all available options. -- `--host`: Defines the host to bind the server to. Can be set using the `LANGFLOW_HOST` environment variable. The default is `127.0.0.1`. -- `--workers`: Sets the number of worker processes. Can be set using the `LANGFLOW_WORKERS` environment variable. The default is `1`. -- `--timeout`: Sets the worker timeout in seconds. The default is `60`. -- `--port`: Sets the port to listen on. Can be set using the `LANGFLOW_PORT` environment variable. The default is `7860`. -- `--env-file`: Specifies the path to the .env file containing environment variables. The default is `.env`. -- `--log-level`: Defines the logging level. Can be set using the `LANGFLOW_LOG_LEVEL` environment variable. The default is `critical`. -- `--components-path`: Specifies the path to the directory containing custom components. Can be set using the `LANGFLOW_COMPONENTS_PATH` environment variable. The default is `langflow/components`. -- `--log-file`: Specifies the path to the log file. Can be set using the `LANGFLOW_LOG_FILE` environment variable. The default is `logs/langflow.log`. -- `--cache`: Selects the type of cache to use. Options are `InMemoryCache` and `SQLiteCache`. Can be set using the `LANGFLOW_LANGCHAIN_CACHE` environment variable. The default is `SQLiteCache`. -- `--dev/--no-dev`: Toggles the development mode. The default is `no-dev`. -- `--path`: Specifies the path to the frontend directory containing build files. This option is for development purposes only. Can be set using the `LANGFLOW_FRONTEND_PATH` environment variable. -- `--open-browser/--no-open-browser`: Toggles the option to open the browser after starting the server. Can be set using the `LANGFLOW_OPEN_BROWSER` environment variable. The default is `open-browser`. -- `--remove-api-keys/--no-remove-api-keys`: Toggles the option to remove API keys from the projects saved in the database. Can be set using the `LANGFLOW_REMOVE_API_KEYS` environment variable. The default is `no-remove-api-keys`. -- `--install-completion [bash|zsh|fish|powershell|pwsh]`: Installs completion for the specified shell. -- `--show-completion [bash|zsh|fish|powershell|pwsh]`: Shows completion for the specified shell, allowing you to copy it or customize the installation. -- `--backend-only`: This parameter, with a default value of `False`, allows running only the backend server without the frontend. It can also be set using the `LANGFLOW_BACKEND_ONLY` environment variable. -- `--store`: This parameter, with a default value of `True`, enables the store features, use `--no-store` to deactivate it. It can be configured using the `LANGFLOW_STORE` environment variable. - -These parameters are important for users who need to customize the behavior of Langflow, especially in development or specialized deployment scenarios. - -### Environment Variables - -You can configure many of the CLI options using environment variables. These can be exported in your operating system or added to a `.env` file and loaded using the `--env-file` option. - -A sample `.env` file named `.env.example` is included with the project. Copy this file to a new file named `.env` and replace the example values with your actual settings. If you're setting values in both your OS and the `.env` file, the `.env` settings will take precedence. +- **Cloud:** DataStax Langflow is a hosted environment with zero setup. [Sign up for a free account.](http://langflow.datastax.com) +- **Self-managed:** Run Langflow in your environment. [Install Langflow](https://docs.langflow.org/getting-started-installation) to run a local Langflow server, and then use the [Quickstart](https://docs.langflow.org/getting-started-quickstart) guide to create and execute a flow. +- **Hugging Face:** [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow?duplicate=true) to create a Langflow workspace. # πŸ‘‹ Contribute diff --git a/docs/static/img/hero.png b/docs/static/img/hero.png index 85bc2731d..5eff7db0d 100644 Binary files a/docs/static/img/hero.png and b/docs/static/img/hero.png differ