Practical overview
When it fits
Use Nanosage when a research question benefits from exploring related subtopics across local files and web results, and you want the search structure reflected in a generated report.
Who it is for
- Researchers who want to investigate a topic across a local document collection and web sources.
- Python users seeking a command-line workflow that records search branches and produces Markdown reports.
Documented uses
- Search a local corpus or combine it with web retrieval for a research question.
- Expand a query into relevant subqueries and track the exploration in a table of contents.
- Generate a synthesized Markdown report from retrieved material.
Requirements & limits
The project is distributed as a public GitHub repository and identified as open source under the Apache-2.0 license. Its documented interface is a Python CLI for local/self-hosted use.
- Web search uses Tavily and requires an API key; local-documents-only operation is also documented.
- Retrieval models serve different inputs: SigLIP and CLIP support vision and text, ColPali is listed for documents, and all-MiniLM for text-focused retrieval.
- The
--max_depthoption controls subquery recursion and is documented with a default of one. - Python 3.8 or later and Ollama with Gemma 2B are included in the quick-start prerequisites.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up Nanosage for local-model research
Prepare the documented Python, Ollama/Gemma and Tavily configuration before running a research query.
Before you start
- Python 3.8 or later
- Project requirements file
- Ollama and the Gemma 2B model
- Tavily API key for web retrieval
Steps
Install the project dependencies with the command below.
pip install -r requirements.txtInstall Ollama and pull the
gemma2:2bmodel.Copy
env.exampleto.envand add the Tavily API key.Optionally copy
config.example.yamltoconfig.yamlfor runtime defaults.
Expected outcome
The documented dependencies and configuration are prepared for a subsequent Nanosage run.
Guide limitations
- This guide covers setup only; it does not verify that the installation succeeds.
- The Tavily key is needed for web retrieval; the README also documents local-documents-only runs.
Run a query against local documents and web sources
Use the documented CLI pattern to search a local corpus alongside web results.
Before you start
- Nanosage dependencies and runtime configuration
- A local document directory
- A Tavily API key for web retrieval
Steps
Choose a natural-language research query and a directory containing supported documents.
Run the command below.
python main.py --query "quantum computing" --corpus_dir ./my_documents --retrieval_model siglip --web_searchReview the Markdown report in the query-specific directory under
results/.
Expected outcome
The documented workflow combines local and web retrieval and writes a detailed Markdown report.
Guide limitations
- Web retrieval requires Tavily configuration.
- The listed corpus formats are
.txt,.md,.py,.json,.yaml,.csv, PDF and common image formats. - The CLI documents a default recursion depth of one.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 12 October 2026
- Original website title
- masterFoad/NanoSage · Official homepage title · retained in its source language

