> ## Documentation Index
> Fetch the complete documentation index at: https://larkuprag.larkup.de/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Chat with Your Data

> Turn your documents into an AI-powered chatbot in minutes, via CLI or the Web UI.

LarkupRAG gives you two ways to chat with your knowledge base: a **CLI** for developers who prefer the terminal, and a full **Web UI** with a built-in chat interface. Both paths support multiple LLM providers out of the box.

## Supported Providers

LarkupRAG isn't locked to OpenAI. You can choose from any of the following embedding and LLM providers, all configurable from the UI or CLI:

* **Vercel AI Gateway** (Recommended): unified gateway with automatic routing
* **OpenAI**: GPT-4o, GPT-4o Mini, and embedding models
* **DeepSeek**: cost-effective alternative models
* **Google**: Gemini models
* **Anthropic / Cohere / Mistral / Voyage AI / Jina AI / Nomic**
* **Custom**: bring your own OpenAI-compatible endpoint

<Frame caption="Choose from 10+ embedding providers directly in the configuration UI">
  <img src="https://mintcdn.com/larkup-rag/tfaa78YtKcwiVAFS/images/configuration/llm-embedding-providers.png?fit=max&auto=format&n=tfaa78YtKcwiVAFS&q=85&s=b019f3730ffd303b5266a2ae07aa6428" alt="Supported LLM and embedding providers" width="3020" height="1316" data-path="images/configuration/llm-embedding-providers.png" />
</Frame>

***

## Getting Started

<Tabs>
  <Tab title="CLI">
    The CLI is the fastest way to go from documents to a working chatbot, no browser required.

    ### 1. Initialize your project

    Open your terminal and create a new chatbot workspace:

    ```bash theme={null}
    npx @larkup-rag/cli init my-first-chatbot
    ```

    ### 2. Configure your provider

    Set your embedding provider and API key:

    ```bash theme={null}
    npx @larkup-rag/cli config
    ```

    You'll be prompted to select a provider (OpenAI, Vercel AI Gateway, DeepSeek, etc.) and paste your API key.

    ### 3. Add your documents

    Feed documents into the pipeline: PDF, text, markdown, or URLs:

    ```bash theme={null}
    npx @larkup-rag/cli add-doc --file /path/to/your/document.pdf
    ```

    Run this command multiple times to add as many files as you need.

    ### 4. Index your data

    Process and embed your documents into the vector store:

    ```bash theme={null}
    npx @larkup-rag/cli index
    ```

    ### 5. Start chatting

    Launch the interactive chat directly in your terminal:

    ```bash theme={null}
    npx @larkup-rag/cli chat
    ```

    The AI pulls facts directly from your indexed documents to answer questions. Type `exit` to quit.
  </Tab>

  <Tab title="Web UI">
    The Web UI provides a visual, no-code experience for the entire RAG workflow, from configuration to chat.

    ### 1. Configure your pipeline

    Open the **Configure** tab to set your project name, embedding model, and vector store. Click the provider dropdown to choose from Vercel AI Gateway, OpenAI, DeepSeek, Google, and more.

    <Frame caption="Pipeline configuration: set your project, embedding model, and vector store">
      <img src="https://mintcdn.com/larkup-rag/R9FQSOVcQOv3DWx4/images/configuration-page.png?fit=max&auto=format&n=R9FQSOVcQOv3DWx4&q=85&s=ea0aadbe54d66f7fec0132b20aae9d69" alt="Configuration page" width="2996" height="1436" data-path="images/configuration-page.png" />
    </Frame>

    ### 2. Load your data

    Switch to the **Data** tab. You can web-scrape entire domains, paste raw text, or upload files (PDF, Word, JSON, CSV, and more). All ingestion jobs are tracked in the **ETL Jobs** tab.

    <Frame caption="Scrape websites, upload files, or paste text into your knowledge base">
      <img src="https://mintcdn.com/larkup-rag/APB5TzrzNm7Gz5bm/images/data/launch-firecrwal-server.png?fit=max&auto=format&n=APB5TzrzNm7Gz5bm&q=85&s=1eb6fcc67fee5965226a2943399550b0" alt="Add data interface" width="3020" height="1416" data-path="images/data/launch-firecrwal-server.png" />
    </Frame>

    <Frame caption="Your corpus, all ingested documents in one view">
      <img src="https://mintcdn.com/larkup-rag/tfaa78YtKcwiVAFS/images/data/corpus-table.png?fit=max&auto=format&n=tfaa78YtKcwiVAFS&q=85&s=1a243004eb71871850e7a23ecdf02ada" alt="Corpus table" width="1810" height="869" data-path="images/data/corpus-table.png" />
    </Frame>

    ### 3. Test your pipeline

    Use the **Demo** tab to send test queries against your indexed data. See matching documents, similarity scores, and response latency in real time.

    <Frame caption="Query your pipeline and inspect top-k results with similarity scores">
      <img src="https://mintcdn.com/larkup-rag/R9FQSOVcQOv3DWx4/images/demo-page.png?fit=max&auto=format&n=R9FQSOVcQOv3DWx4&q=85&s=fe526ae8f98e3922aabc1c3ac1900d21" alt="Demo query page" width="2996" height="1436" data-path="images/demo-page.png" />
    </Frame>

    ### 4. Chat with your knowledge base

    Open the **Chat** tab for a full conversational interface. Select your LLM model from the dropdown (e.g., GPT-4o Mini via Gateway) and start asking questions grounded in your documents.

    <Frame caption="Built-in chat: ask questions and get answers grounded in your indexed documents">
      <img src="https://mintcdn.com/larkup-rag/tfaa78YtKcwiVAFS/images/chat.png?fit=max&auto=format&n=tfaa78YtKcwiVAFS&q=85&s=19bf9f5a6af561615879bf369c451f2b" alt="Chat interface" width="3020" height="1316" data-path="images/chat.png" />
    </Frame>
  </Tab>
</Tabs>

***

## Vector Store Options

LarkupRAG supports multiple vector store backends. Choose the one that fits your deployment:

* **LanceDB**: embedded, file-based (great for local/offline use)
* **Pinecone**: fully-managed cloud vector database
* **Chroma**: open-source, developer-friendly
* **Weaviate / Qdrant / pgvector / Supabase**: coming soon

<Frame caption="Vector store selection, from embedded local DBs to managed cloud services">
  <img src="https://mintcdn.com/larkup-rag/tfaa78YtKcwiVAFS/images/configuration/vectorstores-providers.png?fit=max&auto=format&n=tfaa78YtKcwiVAFS&q=85&s=1f3dc4df23c30ad0890b8dcf67948617" alt="Vector store providers" width="3020" height="1316" data-path="images/configuration/vectorstores-providers.png" />
</Frame>
