diff --git a/docs/docs/getting-started/cli.mdx b/docs/docs/getting-started/cli.mdx index 9edfca120..050c4ab50 100644 --- a/docs/docs/getting-started/cli.mdx +++ b/docs/docs/getting-started/cli.mdx @@ -1,4 +1,4 @@ -# Command Line Interface (CLI) +# 🖥️ Command Line Interface (CLI) ## Overview diff --git a/docs/docs/getting-started/first-steps.mdx b/docs/docs/getting-started/first-steps.mdx index 054784038..a348b6e13 100644 --- a/docs/docs/getting-started/first-steps.mdx +++ b/docs/docs/getting-started/first-steps.mdx @@ -1,6 +1,6 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; -# First steps +# 🚀 First steps ## Installation diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx index 840f10f10..6d5155f9c 100644 --- a/docs/docs/index.mdx +++ b/docs/docs/index.mdx @@ -1,6 +1,6 @@ # 👋 Welcome to Langflow -Langflow is an easy way to create flows. The drag-and-drop feature allows quick and effortless experimentation, while the built-in chat interface facilitates real-time interaction. It provides options to edit prompt parameters, create chains and agents, track thought processes, and export flows. +Langflow is an easy way to build from simple to complex AI applications. It is a low-code platform that allows you to integrate AI into everything you do. import ThemedImage from "@theme/ThemedImage"; import useBaseUrl from "@docusaurus/useBaseUrl"; @@ -16,3 +16,81 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; }} style={{ width: "100%" }} /> + +import ZoomableImage from "/src/theme/ZoomableImage.js"; + +## 🚀 First steps + +## Installation + +Make sure you have **Python 3.10** installed on your system. + +You can install **Langflow** with [pipx](https://pipx.pypa.io/stable/installation/) or with pip. + +Pipx can fetch the missing Python version for you, but you can also install it manually. + +```bash +pipx install langflow --python python3.10 --fetch-missing-python +# or +pip install langflow -U +``` + +Or you can install a pre-release version using: + +```bash +pipx install langflow --python python3.10 --fetch-missing-python --pip-args="--pre" +# or +pip install langflow --pre -U +``` + +### ⛓️ Running Langflow + +Langflow can be run in a variety of ways, including using the command-line interface (CLI) or HuggingFace Spaces. + +```bash +langflow run # or langflow --help +``` + +#### 🤗 HuggingFace Spaces + +Hugging Face provides a great alternative for running Langflow in their Spaces environment. This means you can run Langflow without any local installation required. + +The first step is to go to the [Langflow Space](https://huggingface.co/spaces/Logspace/Langflow?duplicate=true). + +Remember to use a Chromium-based browser for the best experience. You'll be presented with the following screen: + + + +From here, just name your Space, define the visibility (Public or Private), and click on `Duplicate Space` to start the installation process. When that is done, you'll be redirected to the Space's main page to start using Langflow right away! + +Once you get Langflow running, click on New Project in the top right corner of the screen. Langflow provides a range of example flows to help you get started. + +To quickly try one of them, open a starter example, set up your API keys and click ⚡ Run, on the bottom right corner of the canvas. This will open up Langflow's Interaction Panel with the chat console, text inputs, and outputs. + + +### 🖥️ 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: + +```bash +langflow run [OPTIONS] +``` + +Find more information about the available options by running: + +```bash +langflow --help +``` + +Or you can visit the [Langflow CLI documentation](./cli) for more information.