Skip to content

BlackRoad-OS/openrag

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3,227 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

OpenRAG

Intelligent Agent-powered document search

Langflow OpenSearch Docling

YouTube Channel GitHub stars GitHub forks

Documentation Ask DeepWiki


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.

Check out the documentation or get started with the quickstart.

Built with FastAPI and Next.js. Powered by OpenSearch, Langflow, and Docling.


OpenRAG Demo

✨ Highlight Features

  • Pre-packaged & ready to run - All core tools are hooked up and ready to go, just install and run
  • Agentic RAG workflows - Advanced orchestration with re-ranking and multi-agent coordination
  • Document ingestion - Handles messy, real-world data with intelligent parsing
  • Drag-and-drop workflow builder - Visual interface powered by Langflow for rapid iteration
  • Modular enterprise add-ons - Extend functionality when you need it
  • Enterprise search at any scale - Powered by OpenSearch for production-grade performance

πŸ”„ How OpenRAG Works

OpenRAG follows a streamlined workflow to transform your documents into intelligent, searchable knowledge:

OpenRAG Workflow Diagram

πŸš€ Install OpenRAG

To get started with OpenRAG, see the installation guides in the OpenRAG documentation:

✨ Quick Start Workflow

Use uv run openrag to start

1. Launch OpenRAG

↓

Add files or folders as knowledge

2. Add Knowledge

↓

Start Chatting with your knowledge

3. Start Chatting

πŸ“¦ SDKs

Integrate OpenRAG into your applications with our official SDKs:

Python SDK

pip install openrag-sdk

Quick Example:

import asyncio
from openrag_sdk import OpenRAGClient


async def main():
    async with OpenRAGClient() as client:
        response = await client.chat.create(message="What is RAG?")
        print(response.response)


if __name__ == "__main__":
    asyncio.run(main())

πŸ“– Full Python SDK Documentation

TypeScript/JavaScript SDK

npm install openrag-sdk

Quick Example:

import { OpenRAGClient } from "openrag-sdk";

const client = new OpenRAGClient();
const response = await client.chat.create({ message: "What is RAG?" });
console.log(response.response);

πŸ“– Full TypeScript/JavaScript SDK Documentation

πŸ”Œ Model Context Protocol (MCP)

Connect AI assistants like Cursor and Claude Desktop to your OpenRAG knowledge base:

pip install openrag-mcp

Quick Example (Cursor/Claude Desktop config):

{
  "mcpServers": {
    "openrag": {
      "command": "uvx",
      "args": ["openrag-mcp"],
      "env": {
        "OPENRAG_URL": "http://localhost:3000",
        "OPENRAG_API_KEY": "your_api_key_here"
      }
    }
  }
}

The MCP server provides tools for RAG-enhanced chat, semantic search, and settings management.

πŸ“– Full MCP Documentation

πŸ› οΈ Development

For developers who want to contribute to OpenRAG or set up a development environment, see CONTRIBUTING.md.

πŸ›Ÿ Troubleshooting

For assistance with OpenRAG, see Troubleshoot OpenRAG and visit the Discussions page.

To report a bug or submit a feature request, visit the Issues page.


Proprietary Software β€” BlackRoad OS, Inc.

This software is proprietary to BlackRoad OS, Inc. Source code is publicly visible for transparency and collaboration. Commercial use, forking, and redistribution are prohibited without written authorization.

BlackRoad OS β€” Pave Tomorrow.

Copyright 2024-2026 BlackRoad OS, Inc. All Rights Reserved.

About

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch. (BlackRoad integration)

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 62.0%
  • TypeScript 34.8%
  • Makefile 1.8%
  • Shell 0.5%
  • CSS 0.4%
  • Dockerfile 0.3%
  • Other 0.2%