Skip to main content

ragmir

Cited local retrieval for Python agents and RAG apps. Ragmir indexes a project's code, PDFs, Office files, mail, and design files on your machine, and returns passages cited to lines, pages, slides, cells, or objects. A question the documents cannot answer returns nothing, so your application can say so instead of guessing.

pip install ragmir

Ragmir runs through Node.js 22.12 or later, or Docker. The client uses the project's own npm install of @jcode.labs/ragmir when there is one, else a global rgr, else the matching npm release through npx, else the ghcr.io/jcode-works/ragmir image. Set RAGMIR_COMMAND to choose another command.

Index a project and search it

from ragmir import Ragmir, add_sources, init_project

init_project("my-project")
add_sources("my-project", ["docs/**/*.md", "contracts/**/*.pdf"])

with Ragmir("my-project") as rag:
    rag.ingest()  # incremental: only new and changed files are read again
    for passage in rag.search("termination notice period", top_k=3):
        print(passage.citation, passage.weak_evidence)
        print(passage.text)

Ragmir keeps one MCP server running for the project and reuses it for every call. It works from any thread, a notebook, or a web framework, and each method has an async twin (asearch, aexpand, asources, astatus, aingest). Asyncio services can use AsyncRagmir directly.

  • search(query, top_k=, include_paths=, exclude_paths=, scope=) returns Passage objects with citation, path, text, line or page ranges, weak_evidence, and source_status. Path filters take folders, files, or globs such as "**/*.pdf".
  • search_many(queries) answers up to five related questions in one call.
  • expand(citation, context_radius=1) returns the passage with its neighbours; expand next_citation to read a long document through.
  • sources(paths=["contracts/**"]) lists the indexed documents; status() and audit() report readiness and coverage.
  • run_cli(project, "doctor") runs any rgr command, for example an ingest with local OCR, which Ragmir leaves to an explicit operator command.

LangChain and LlamaIndex

Read the Python guide. Ragmir is open source under AGPL-3.0-only, with a commercial license available from JCode Works.

Metadata

Release files for ragmir 6.15.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ragmir 6.15.2
File Size Uploaded Provenance Actions
ragmir-6.15.2.tar.gz 27.5 kB Without provenance Details for ragmir-6.15.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ragmir 6.15.2
File Interpreter ABI Platform Actions
ragmir-6.15.2-py3-none-any.whl Python 3 none any Details for ragmir-6.15.2-py3-none-any.whl

Total release size: 55.5 kB

Release files / ragmir-6.15.2.tar.gz

Download URL ragmir-6.15.2.tar.gz
Size 27.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f62173e878756dbb357ec3b949fe7ffe71666e0bd27abbd1495f98759b3498a4
BLAKE2b-256 checksum
How to use checksums
3c580dfcae4480aad7f55043b9f5a818f136b5818305b432ee2c6396e20c2cec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / ragmir-6.15.2-py3-none-any.whl

Download URL ragmir-6.15.2-py3-none-any.whl
Size 28.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
449f489d721dd8a81ce3cbd893327fd3b9fed87238ad4d502d8a98fa007c500b
BLAKE2b-256 checksum
How to use checksums
959d2e37e0a48f6dfc900bf814ae1c32ec35b4f96756ddec50e867d13e1a8407
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for ragmir 6.15.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page