Metadata-Version: 2.4
Name: citereel
Version: 0.1.0
Summary: Cited RAG replay: record runs, map [n] citations to chunks, replay offline.
Author: Yinghuai Fu
License: MIT
Project-URL: Homepage, https://github.com/L00PLeGeNd/citereel
Project-URL: Repository, https://github.com/L00PLeGeNd/citereel
Project-URL: Issues, https://github.com/L00PLeGeNd/citereel/issues
Keywords: rag,citations,citation-verification,replay,observability,llm,grounding,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.12
Requires-Dist: rich>=13.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Provides-Extra: llm
Requires-Dist: openai>=1.40; extra == "llm"
Provides-Extra: embed
Requires-Dist: sentence-transformers>=3.0; extra == "embed"
Provides-Extra: pdf
Requires-Dist: pypdf>=4.0; extra == "pdf"
Provides-Extra: gui
Requires-Dist: pywebview>=5.0; extra == "gui"
Provides-Extra: all
Requires-Dist: openai>=1.40; extra == "all"
Requires-Dist: sentence-transformers>=3.0; extra == "all"
Requires-Dist: pypdf>=4.0; extra == "all"
Requires-Dist: pywebview>=5.0; extra == "all"
Dynamic: license-file

# citereel

Ask local docs, get answers with `[n]` citations, jump to the supporting chunk, replay the run later.

[![ci](https://github.com/L00PLeGeNd/citereel/actions/workflows/ci.yml/badge.svg)](https://github.com/L00PLeGeNd/citereel/actions/workflows/ci.yml)

## Install

```bash
pip install citereel
pip install "citereel[llm]"     # DeepSeek / OpenAI-compatible
pip install "citereel[gui]"     # desktop window shell
```

Or: `pipx install citereel` / `uv tool install citereel`.

## Usage

```bash
citereel g              # desktop GUI
citereel d              # terminal demo
citereel s 1            # show citation [1]
citereel a "…" -d ./docs -g openai -P deepseek -o run.json
citereel c run.json
```

Shortcuts: `g` gui · `a` ask · `s` show · `h` html · `d` demo · `c` check · `r` replay · `p` providers · `-h` help.

## License

MIT
