ragstash 0.1.0

CLI tool to help retrieve RAG context from a corpus of documents.

RAG Stash

Perform RAG flexibly and easily with an LLM of your choice

About

Ragstash is a CLI utility to help retrieve RAG (Retrieval Augmented Generation) context from your documents which can then be fed into an LLM of your choice.

Installation

recommended:

pipx install ragstash or uv tool install ragstash

You should then have ragstash command available.

Usage

First, cd into your documents folder, then:

1. Use ragstash init . to initialize (processes documents, generates embeddings, and saves vector db)
2. Use ragstash serve . to start the server used for querying
3. (In a separate terminal) Use ragstash get YOUR_QUERY to print out the RAG context. This output can be piped (|) into an LLM or saved in a file.

Example Usage

Simple:

> cd path/to/your/documents
> ragstash init .
> ragstash serve .

# In another terminal
> ragstash get "What do the leaked files say about the doings of Celebrity Celebface?" | claude

Advanced:

> cd path/to/your/documents
> ragstash init . \
  --sentence-transformer "sentence-transformers/all-MiniLM-L6-v2" \
  --chunk-size 1000 \
  --name "LargeChunks"
> ragstash serve . --name "LargeChunks"

# In another terminal
> ragstash get "What do the leaked files say about the doings of Celebrity Celebface?" \
  --retrieval-query "Things Celebrity Celebface has done" \
  --chunks 10 \
  --message "Here is " \
  | claude

Options

> init PTH
    --sentence-transformer  # model to use for embedding of chunks
    --chunk-size            # size of chunks (chars)
    --chunk-overlap         # 
    --redo                  # overwrite existing vault
    --name                  # name to give initialization (appended to folder name: ".rag_{NAME}")

> serve PTH
    --name                  # which initialization to use
    --unload-timeout        # time after which sentence transformer mode unloads (0 means never unloads)
    --port

> get YOUR_QUERY
    --chunks                # number of chunks to fetch
    --retrieval-query       # query to use when doing "dumb" retrieval of data (given to sentence transformer)
    --message               # message to give LLM
    --port                  # port to fetch 
    --ip_addr               # default `localhost`
    --chunks-as-json        # instead of getting RAG formatted message, get retireved chunks as json
    --file                  # file where to save retrieved context

> update PTH
    --name                  # name of vault