# OpenRAG

OpenRAG is a comprehensive Retrieval-Augmented Generation platform that enables intelligent document search and AI-powered conversations. Users can upload, process, and query documents through a chat interface backed by large language models and semantic search capabilities. The system utilizes Langflow for document ingestion, retrieval workflows, and intelligent nudges, providing a seamless RAG experience. Built with [Starlette](https://github.com/Kludex/starlette) and [Next.js](https://github.com/vercel/next.js). Powered by [OpenSearch](https://github.com/opensearch-project/OpenSearch), [Langflow](https://github.com/langflow-ai/langflow), and [Docling](https://github.com/docling-project/docling).

Quickstart | TUI Interface | Docker Deployment | Development | Troubleshooting

## Quickstart To quickly run OpenRAG without creating or modifying any project files, use `uvx`: ```bash uvx openrag ``` This runs OpenRAG without installing it to your project or globally. To run a specific version of OpenRAG, add the version to the command, such as: `uvx --from openrag==0.1.25 openrag`. ## Install Python package To first set up a project and then install the OpenRAG Python package, do the following: 1. Create a new project with a virtual environment using `uv init`. ```bash uv init YOUR_PROJECT_NAME cd YOUR_PROJECT_NAME ``` The `(venv)` prompt doesn't change, but `uv` commands will automatically use the project's virtual environment. For more information on virtual environments, see the [uv documentation](https://docs.astral.sh/uv/pip/environments). 2. Add OpenRAG to your project. ```bash uv add openrag ``` To add a specific version of OpenRAG: ```bash uv add openrag==0.1.25 ``` 3. Start the OpenRAG TUI. ```bash uv run openrag ``` 4. Continue with the [Quickstart](https://docs.openr.ag/quickstart). For the full TUI installation guide, see [TUI](https://docs.openr.ag/install). ## Docker or Podman installation For more information, see [Install OpenRAG containers](https://docs.openr.ag/docker). ## Troubleshooting For common issues and fixes, see [Troubleshoot](https://docs.openr.ag/support/troubleshoot). ## Development For developers wanting to contribute to OpenRAG or set up a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md).