axon-rag 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. axon_rag-0.1.0/LICENSE +21 -0
  2. axon_rag-0.1.0/PKG-INFO +300 -0
  3. axon_rag-0.1.0/README.md +201 -0
  4. axon_rag-0.1.0/pyproject.toml +271 -0
  5. axon_rag-0.1.0/setup.cfg +4 -0
  6. axon_rag-0.1.0/src/axon/__init__.py +36 -0
  7. axon_rag-0.1.0/src/axon/access.py +64 -0
  8. axon_rag-0.1.0/src/axon/api.py +380 -0
  9. axon_rag-0.1.0/src/axon/api_routes/__init__.py +22 -0
  10. axon_rag-0.1.0/src/axon/api_routes/config_routes.py +262 -0
  11. axon_rag-0.1.0/src/axon/api_routes/governance.py +330 -0
  12. axon_rag-0.1.0/src/axon/api_routes/graph.py +317 -0
  13. axon_rag-0.1.0/src/axon/api_routes/ingest.py +541 -0
  14. axon_rag-0.1.0/src/axon/api_routes/maintenance.py +163 -0
  15. axon_rag-0.1.0/src/axon/api_routes/projects.py +393 -0
  16. axon_rag-0.1.0/src/axon/api_routes/query.py +244 -0
  17. axon_rag-0.1.0/src/axon/api_routes/registry.py +16 -0
  18. axon_rag-0.1.0/src/axon/api_routes/shares.py +344 -0
  19. axon_rag-0.1.0/src/axon/api_schemas.py +436 -0
  20. axon_rag-0.1.0/src/axon/cli.py +1617 -0
  21. axon_rag-0.1.0/src/axon/code_graph.py +164 -0
  22. axon_rag-0.1.0/src/axon/code_retrieval.py +737 -0
  23. axon_rag-0.1.0/src/axon/collection_ops.py +92 -0
  24. axon_rag-0.1.0/src/axon/compression.py +302 -0
  25. axon_rag-0.1.0/src/axon/config.py +1870 -0
  26. axon_rag-0.1.0/src/axon/config_wizard.py +1314 -0
  27. axon_rag-0.1.0/src/axon/crag.py +270 -0
  28. axon_rag-0.1.0/src/axon/embeddings.py +150 -0
  29. axon_rag-0.1.0/src/axon/ext_install.py +79 -0
  30. axon_rag-0.1.0/src/axon/extensions/__init__.py +3 -0
  31. axon_rag-0.1.0/src/axon/extensions/axon-copilot-0.1.0.vsix +0 -0
  32. axon_rag-0.1.0/src/axon/governance.py +482 -0
  33. axon_rag-0.1.0/src/axon/graph_rag.py +2339 -0
  34. axon_rag-0.1.0/src/axon/graph_render.py +976 -0
  35. axon_rag-0.1.0/src/axon/llm.py +890 -0
  36. axon_rag-0.1.0/src/axon/loaders.py +1370 -0
  37. axon_rag-0.1.0/src/axon/main.py +3527 -0
  38. axon_rag-0.1.0/src/axon/maintenance.py +67 -0
  39. axon_rag-0.1.0/src/axon/mcp_server.py +779 -0
  40. axon_rag-0.1.0/src/axon/mounts.py +186 -0
  41. axon_rag-0.1.0/src/axon/projects.py +1042 -0
  42. axon_rag-0.1.0/src/axon/query_router.py +1462 -0
  43. axon_rag-0.1.0/src/axon/repl.py +4074 -0
  44. axon_rag-0.1.0/src/axon/rerank.py +94 -0
  45. axon_rag-0.1.0/src/axon/retrievers.py +278 -0
  46. axon_rag-0.1.0/src/axon/runtime.py +293 -0
  47. axon_rag-0.1.0/src/axon/sentence_window.py +407 -0
  48. axon_rag-0.1.0/src/axon/sessions.py +102 -0
  49. axon_rag-0.1.0/src/axon/shares.py +395 -0
  50. axon_rag-0.1.0/src/axon/sparse_retrieval.py +269 -0
  51. axon_rag-0.1.0/src/axon/splitters.py +934 -0
  52. axon_rag-0.1.0/src/axon/surface_contract.py +514 -0
  53. axon_rag-0.1.0/src/axon/tools.py +245 -0
  54. axon_rag-0.1.0/src/axon/vector_store.py +975 -0
  55. axon_rag-0.1.0/src/axon/webapp.py +1349 -0
  56. axon_rag-0.1.0/src/axon_rag.egg-info/PKG-INFO +300 -0
  57. axon_rag-0.1.0/src/axon_rag.egg-info/SOURCES.txt +119 -0
  58. axon_rag-0.1.0/src/axon_rag.egg-info/dependency_links.txt +1 -0
  59. axon_rag-0.1.0/src/axon_rag.egg-info/entry_points.txt +6 -0
  60. axon_rag-0.1.0/src/axon_rag.egg-info/requires.txt +85 -0
  61. axon_rag-0.1.0/src/axon_rag.egg-info/top_level.txt +1 -0
  62. axon_rag-0.1.0/tests/test_access.py +171 -0
  63. axon_rag-0.1.0/tests/test_api.py +4028 -0
  64. axon_rag-0.1.0/tests/test_api_config.py +59 -0
  65. axon_rag-0.1.0/tests/test_api_e2e.py +52 -0
  66. axon_rag-0.1.0/tests/test_brain_lifecycle.py +113 -0
  67. axon_rag-0.1.0/tests/test_cli_extra.py +1144 -0
  68. axon_rag-0.1.0/tests/test_code_graph.py +477 -0
  69. axon_rag-0.1.0/tests/test_code_retrieval.py +745 -0
  70. axon_rag-0.1.0/tests/test_compression.py +429 -0
  71. axon_rag-0.1.0/tests/test_config.py +1519 -0
  72. axon_rag-0.1.0/tests/test_cost_control.py +444 -0
  73. axon_rag-0.1.0/tests/test_crag.py +316 -0
  74. axon_rag-0.1.0/tests/test_crag_eval.py +138 -0
  75. axon_rag-0.1.0/tests/test_deepeval_integration.py +452 -0
  76. axon_rag-0.1.0/tests/test_demo.py +541 -0
  77. axon_rag-0.1.0/tests/test_doc_mismatch.py +59 -0
  78. axon_rag-0.1.0/tests/test_embeddings_providers.py +375 -0
  79. axon_rag-0.1.0/tests/test_eval_smoke.py +352 -0
  80. axon_rag-0.1.0/tests/test_governance.py +590 -0
  81. axon_rag-0.1.0/tests/test_governance_routes.py +489 -0
  82. axon_rag-0.1.0/tests/test_graph_rag.py +3654 -0
  83. axon_rag-0.1.0/tests/test_graph_rag_integrity.py +108 -0
  84. axon_rag-0.1.0/tests/test_graphrag_backend_bugs.py +412 -0
  85. axon_rag-0.1.0/tests/test_graphrag_tuning_fixes.py +308 -0
  86. axon_rag-0.1.0/tests/test_lint.py +109 -0
  87. axon_rag-0.1.0/tests/test_llm_copilot_flow.py +156 -0
  88. axon_rag-0.1.0/tests/test_llm_providers.py +2857 -0
  89. axon_rag-0.1.0/tests/test_loaders.py +1720 -0
  90. axon_rag-0.1.0/tests/test_main.py +15313 -0
  91. axon_rag-0.1.0/tests/test_mcp_server.py +541 -0
  92. axon_rag-0.1.0/tests/test_mixin_integration.py +102 -0
  93. axon_rag-0.1.0/tests/test_mounts.py +701 -0
  94. axon_rag-0.1.0/tests/test_new_features.py +1264 -0
  95. axon_rag-0.1.0/tests/test_new_loaders.py +57 -0
  96. axon_rag-0.1.0/tests/test_offline.py +332 -0
  97. axon_rag-0.1.0/tests/test_performance.py +227 -0
  98. axon_rag-0.1.0/tests/test_projects.py +1418 -0
  99. axon_rag-0.1.0/tests/test_query_router_robustness.py +1585 -0
  100. axon_rag-0.1.0/tests/test_repl_animation.py +84 -0
  101. axon_rag-0.1.0/tests/test_repl_commands.py +1718 -0
  102. axon_rag-0.1.0/tests/test_repl_e2e.py +59 -0
  103. axon_rag-0.1.0/tests/test_repl_helpers.py +476 -0
  104. axon_rag-0.1.0/tests/test_retrievers.py +623 -0
  105. axon_rag-0.1.0/tests/test_runtime.py +205 -0
  106. axon_rag-0.1.0/tests/test_runtime_stress.py +109 -0
  107. axon_rag-0.1.0/tests/test_sentence_window.py +133 -0
  108. axon_rag-0.1.0/tests/test_sessions.py +416 -0
  109. axon_rag-0.1.0/tests/test_shares.py +704 -0
  110. axon_rag-0.1.0/tests/test_sparse_retrieval.py +196 -0
  111. axon_rag-0.1.0/tests/test_splitters.py +1748 -0
  112. axon_rag-0.1.0/tests/test_splitters_extra.py +55 -0
  113. axon_rag-0.1.0/tests/test_splitters_semantic.py +40 -0
  114. axon_rag-0.1.0/tests/test_streaming.py +231 -0
  115. axon_rag-0.1.0/tests/test_stress.py +230 -0
  116. axon_rag-0.1.0/tests/test_stress_new.py +80 -0
  117. axon_rag-0.1.0/tests/test_stress_perf.py +101 -0
  118. axon_rag-0.1.0/tests/test_surface_parity_contract.py +378 -0
  119. axon_rag-0.1.0/tests/test_tools.py +107 -0
  120. axon_rag-0.1.0/tests/test_vector_store.py +2723 -0
  121. axon_rag-0.1.0/tests/test_webapp_ui.py +95 -0
axon_rag-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Open Source Contributor
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,300 @@
1
+ Metadata-Version: 2.4
2
+ Name: axon-rag
3
+ Version: 0.1.0
4
+ Summary: General-purpose open-source RAG engine with multi-LLM, hybrid retrieval, GraphRAG, and MCP support
5
+ Author: Open Source Contributor
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/jyunming/studio_brain_open
8
+ Project-URL: Documentation, https://github.com/jyunming/studio_brain_open/tree/main/docs
9
+ Project-URL: Repository, https://github.com/jyunming/studio_brain_open
10
+ Project-URL: Bug Tracker, https://github.com/jyunming/studio_brain_open/issues
11
+ Keywords: rag,llm,embeddings,vector-search,knowledge-base,mcp,ollama,graphrag
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
15
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
16
+ Classifier: License :: OSI Approved :: MIT License
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Operating System :: OS Independent
22
+ Requires-Python: >=3.10
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ Requires-Dist: numpy>=1.20.0
26
+ Requires-Dist: pydantic>=2.0.0
27
+ Requires-Dist: python-dotenv>=1.0.0
28
+ Requires-Dist: sentence-transformers>=3.0.0
29
+ Requires-Dist: tf-keras>=2.0.0
30
+ Requires-Dist: ollama>=0.1.0
31
+ Requires-Dist: openai>=1.0.0
32
+ Requires-Dist: google-genai>=1.4.0
33
+ Requires-Dist: rank_bm25>=0.2.2
34
+ Requires-Dist: httpx>=0.25.0
35
+ Requires-Dist: mcp>=1.0.0
36
+ Requires-Dist: pyyaml>=6.0.0
37
+ Requires-Dist: pandas>=2.0.0
38
+ Requires-Dist: Pillow>=10.0.0
39
+ Requires-Dist: tqdm>=4.66.0
40
+ Requires-Dist: fastapi>=0.100.0
41
+ Requires-Dist: uvicorn>=0.22.0
42
+ Requires-Dist: python-docx>=1.0.0
43
+ Requires-Dist: python-pptx>=0.6.18
44
+ Requires-Dist: pymupdf>=1.24.0
45
+ Requires-Dist: pypdf>=4.0.0
46
+ Requires-Dist: openpyxl>=3.1.0
47
+ Requires-Dist: pyarrow>=10.0.0
48
+ Requires-Dist: prompt_toolkit>=3.0.0
49
+ Requires-Dist: rich>=13.0.0
50
+ Requires-Dist: tiktoken>=0.7.0
51
+ Requires-Dist: lancedb>=0.8.0
52
+ Provides-Extra: ui
53
+ Requires-Dist: streamlit>=1.30.0; extra == "ui"
54
+ Provides-Extra: chroma
55
+ Requires-Dist: chromadb>=0.4.0; extra == "chroma"
56
+ Provides-Extra: qdrant
57
+ Requires-Dist: qdrant-client<2.0.0,>=1.7.0; extra == "qdrant"
58
+ Provides-Extra: fastembed
59
+ Requires-Dist: fastembed<1.0.0,>=0.1.0; extra == "fastembed"
60
+ Provides-Extra: graphrag
61
+ Requires-Dist: networkx>=3.0; extra == "graphrag"
62
+ Requires-Dist: leidenalg>=0.11.0; extra == "graphrag"
63
+ Requires-Dist: igraph>=1.0.0; extra == "graphrag"
64
+ Provides-Extra: gliner
65
+ Requires-Dist: gliner>=0.2.0; extra == "gliner"
66
+ Provides-Extra: llmlingua
67
+ Requires-Dist: llmlingua>=0.2.0; extra == "llmlingua"
68
+ Provides-Extra: rebel
69
+ Requires-Dist: transformers>=4.20.0; extra == "rebel"
70
+ Provides-Extra: loaders
71
+ Requires-Dist: ebooklib>=0.18; extra == "loaders"
72
+ Requires-Dist: striprtf>=0.0.26; extra == "loaders"
73
+ Requires-Dist: extract-msg>=0.28.0; extra == "loaders"
74
+ Provides-Extra: eval
75
+ Requires-Dist: deepeval>=0.21.0; extra == "eval"
76
+ Provides-Extra: dev
77
+ Requires-Dist: pytest<8.0.0,>=7.4.0; extra == "dev"
78
+ Requires-Dist: pytest-asyncio<1.0.0,>=0.21.0; extra == "dev"
79
+ Requires-Dist: pytest-cov<5.0.0,>=4.1.0; extra == "dev"
80
+ Requires-Dist: black==23.12.1; extra == "dev"
81
+ Requires-Dist: ruff<1.0.0,>=0.1.0; extra == "dev"
82
+ Requires-Dist: mypy<2.0.0,>=1.5.0; extra == "dev"
83
+ Requires-Dist: pre-commit<4.0.0,>=3.4.0; extra == "dev"
84
+ Provides-Extra: all
85
+ Requires-Dist: streamlit>=1.30.0; extra == "all"
86
+ Requires-Dist: chromadb>=0.4.0; extra == "all"
87
+ Requires-Dist: qdrant-client<2.0.0,>=1.7.0; extra == "all"
88
+ Requires-Dist: fastembed<1.0.0,>=0.1.0; extra == "all"
89
+ Requires-Dist: networkx>=3.0; extra == "all"
90
+ Requires-Dist: leidenalg>=0.11.0; extra == "all"
91
+ Requires-Dist: igraph>=1.0.0; extra == "all"
92
+ Requires-Dist: gliner>=0.2.0; extra == "all"
93
+ Requires-Dist: llmlingua>=0.2.0; extra == "all"
94
+ Requires-Dist: transformers>=4.20.0; extra == "all"
95
+ Requires-Dist: ebooklib>=0.18; extra == "all"
96
+ Requires-Dist: striprtf>=0.0.26; extra == "all"
97
+ Requires-Dist: extract-msg>=0.28.0; extra == "all"
98
+ Dynamic: license-file
99
+
100
+ <div align="center">
101
+ <img src="docs/assets/repl-animation.gif" alt="Axon" width="400" />
102
+
103
+ <h3>Your documents, answerable. On your hardware.</h3>
104
+
105
+ <p>
106
+ Drop in PDFs, code, spreadsheets, or URLs — ask anything, get cited answers from a local LLM.<br/>
107
+ Nothing leaves your machine.
108
+ </p>
109
+
110
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
111
+ [![Tests](https://img.shields.io/badge/tests-passing-brightgreen.svg)](tests/)
112
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
113
+ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
114
+
115
+ </div>
116
+
117
+ ---
118
+
119
+ <div align="center">
120
+ <img src="docs/assets/repl-demo.png" alt="Axon REPL startup" width="820" />
121
+ </div>
122
+
123
+ ---
124
+
125
+ ## 🤔 Why Axon?
126
+
127
+ Most RAG tools make you choose between **cloud power** and **data privacy**. Axon runs entirely on your hardware — full capability, zero egress.
128
+
129
+ - 🔒 **Private by default** — all inference runs locally via Ollama or vLLM. No API key, no upload, no telemetry.
130
+ - 📄 **Ingest anything** — 54 file formats (PDF, DOCX, Jupyter, code, images, URLs) in one command. SHA-256 dedup skips unchanged files.
131
+ - 🤖 **Works in your tools** — `@axon` in Copilot Chat, MCP for Claude Code / Codex / Gemini CLI / Cursor, Graph panel in VS Code or your browser.
132
+ - 🤝 **Built for teams** — share your knowledge base with signed, revocable read-only keys. Per-user permissions, full audit trail, no extra infrastructure.
133
+ - 🕸️ **See your knowledge as a graph** — interactive 3D entity-relationship graph. Embedded webview in VS Code; opens in your browser everywhere else. Click any node to jump to the exact source line.
134
+ - 🔬 **Production-grade retrieval** — hybrid search, reranking, HyDE, multi-query expansion, and automatic web fallback. Zero manual tuning.
135
+
136
+ ---
137
+
138
+ ## ✨ Capabilities
139
+
140
+ <table>
141
+ <tr>
142
+ <td width="50%" valign="top">
143
+
144
+ ### 🔍 Retrieval
145
+ - Hybrid semantic + keyword search
146
+ - HyDE, multi-query, step-back, query decomposition
147
+ - Sentence-window context retrieval
148
+ - BGE reranker for second-pass precision
149
+ - Web fallback via Brave Search (CRAG-Lite)
150
+ - Smart per-question query routing
151
+
152
+ </td>
153
+ <td width="50%" valign="top">
154
+
155
+ ### 🧠 Graph Intelligence
156
+ - **RAPTOR** — hierarchical corpus summaries
157
+ - **GraphRAG** — entity/relation/community graph (local / global / hybrid)
158
+ - **Code Graph** — file/class/function graph with import edges
159
+ - Interactive 3D graph — embedded webview in VS Code, browser elsewhere
160
+
161
+ </td>
162
+ </tr>
163
+ <tr>
164
+ <td width="50%" valign="top">
165
+
166
+ ### 📥 Ingest Everything
167
+ - **54 file formats** — PDF, DOCX, XLSX, PPTX, Jupyter, images, 24 code formats
168
+ - URL ingestion — any public web page
169
+ - SHA-256 dedup skips unchanged files
170
+ - Stale detection for modified sources
171
+ - 4 content-aware chunking strategies
172
+
173
+ </td>
174
+ <td width="50%" valign="top">
175
+
176
+ ### 🔧 LLMs & Embeddings
177
+ - **Local:** Ollama, vLLM
178
+ - **Cloud:** OpenAI, Gemini, xAI Grok, GitHub Copilot (API)
179
+ - Hot-swap provider and model — no restart needed
180
+ - Streaming on all providers
181
+ - 4 embedding providers; BGE-M3 for multilingual
182
+
183
+ </td>
184
+ </tr>
185
+ <tr>
186
+ <td width="50%" valign="top">
187
+
188
+ ### 🏗️ Projects & Privacy
189
+ - Isolated knowledge base per project, with nesting
190
+ - Federated search across projects (`@projects`, `@mounts`, `@store`)
191
+ - **Strict offline / air-gapped mode** — zero outbound calls
192
+ - **AxonStore** — signed read-only sharing across OS users
193
+
194
+ </td>
195
+ <td width="50%" valign="top">
196
+
197
+ ### 🛡️ Governance & Agents
198
+ - **Governance Console** — full audit trail of every query
199
+ - Graceful maintenance states: `normal → draining → readonly → offline`
200
+ - **REST API** — 54 endpoints with Swagger docs at `/docs`
201
+ - **MCP server** — 30 tools for Claude Code, Codex, Gemini, Cursor, Copilot
202
+ - **`@axon`** VS Code chat participant with Graph and Governance panels
203
+
204
+ </td>
205
+ </tr>
206
+ </table>
207
+
208
+ ---
209
+
210
+ ## ⚡ Quick Start
211
+
212
+ ```bash
213
+ pip install -e . # requires Python 3.10+ and Ollama
214
+ axon # launches the interactive REPL
215
+ ```
216
+
217
+ **[→ Full installation guide with VS Code, MCP, and cloud provider setup](docs/GETTING_STARTED.md)**
218
+
219
+ ---
220
+
221
+ ## 🚀 Entry Points
222
+
223
+ | Command | Starts | Default Port | Best For |
224
+ |---------|--------|-------------|---------|
225
+ | `axon` | Interactive REPL | — | Day-to-day exploration, power users |
226
+ | `axon-api` | FastAPI REST server | `8000` | Agents, scripts, CI pipelines |
227
+ | `axon-mcp` | MCP stdio server | — | Any MCP-compatible agent (Claude Code, Codex, Gemini CLI, Cursor, Copilot…) |
228
+ | `axon-ui` | Streamlit UI | `8501` | Browser-based exploration |
229
+
230
+ ---
231
+
232
+ ## 🔌 VS Code + GitHub Copilot
233
+
234
+ <div align="center">
235
+ <img src="docs/assets/AxonCopilot.gif" alt="Axon Copilot integration" width="400" />
236
+ </div>
237
+
238
+ <br/>
239
+
240
+ <div align="center">
241
+ <img src="docs/assets/vscode-graph-panel.png" alt="Axon VS Code Graph Panel — answer, cited sources, and interactive 3D code graph" width="820" />
242
+ </div>
243
+
244
+ <br/>
245
+
246
+ Install the bundled VSIX to unlock the **`@axon` chat participant**, **Knowledge Graph panel**, **Code Graph panel**, and **Governance dashboard** — directly inside VS Code alongside Copilot.
247
+
248
+ ```
249
+ Extensions panel → "..." → Install from VSIX...
250
+ → run `axon-ext` (or install from VSIX manually)
251
+ ```
252
+
253
+ Or connect via MCP for Copilot agent mode — point `.vscode/mcp.json` at `axon-mcp` and all 30 tools appear in the agent hammer menu automatically.
254
+
255
+ **[Full setup guide →](docs/SETUP.md)**
256
+
257
+ ---
258
+
259
+ ## 📚 Documentation
260
+
261
+ **Getting started**
262
+
263
+ | | Guide | What it covers |
264
+ |-|-------|---------------|
265
+ | 🚀 | **[Getting Started](docs/GETTING_STARTED.md)** | First-time walkthrough — ingest, query, settings |
266
+ | ⚙️ | **[Setup Guide](docs/SETUP.md)** | Install, models, VS Code extension, MCP connection |
267
+ | 🔧 | **[Troubleshooting](docs/TROUBLESHOOTING.md)** | Common errors and platform-specific fixes |
268
+
269
+ **Reference**
270
+
271
+ | | Guide | What it covers |
272
+ |-|-------|---------------|
273
+ | 🔑 | **[Admin Reference](docs/ADMIN_REFERENCE.md)** | Every endpoint, REPL command, CLI flag, and config option |
274
+ | ⚡ | **[Quick Reference](docs/QUICKREF.md)** | Commands and flags at a glance |
275
+ | 📡 | **[API Reference](docs/API_REFERENCE.md)** | Full REST endpoint reference with request/response schemas |
276
+ | 🔌 | **[MCP Tools](docs/MCP_TOOLS.md)** | All 30 MCP tool signatures with parameter defaults |
277
+
278
+ **Deep dives**
279
+
280
+ | | Guide | What it covers |
281
+ |-|-------|---------------|
282
+ | 🤖 | **[Model Guide](docs/MODEL_GUIDE.md)** | Choosing LLM and embeddings; per-provider config examples |
283
+ | 🔬 | **[Advanced RAG](docs/ADVANCED_RAG.md)** | HyDE, RAPTOR, GraphRAG, CRAG-Lite — how each technique works |
284
+ | 🌐 | **[Web Search](docs/WEB_SEARCH.md)** | Brave Search integration, CRAG-Lite fallback setup |
285
+ | 🏝️ | **[Offline / Air-gap Guide](docs/OFFLINE_GUIDE.md)** | Full air-gap setup, model pre-download, local-assets-only mode |
286
+ | 💻 | **[Code RAG Guide](docs/CODE_RAG_GUIDE.md)** | Code graph retrieval and structural search |
287
+ | 🤝 | **[AxonStore](docs/AXON_STORE.md)** | Multi-user sharing, revocation, and the lease lifecycle |
288
+ | 📊 | **[Governance Console](docs/GOVERNANCE_CONSOLE.md)** | Audit trail, maintenance runbook, session management |
289
+ | 📈 | **[Evaluation Guide](docs/EVALUATION.md)** | RAGAS metrics, running evals, building testsets |
290
+ | 🛠️ | **[Development Guide](docs/DEVELOPMENT.md)** | Tests, contributing, pre-commit hooks |
291
+
292
+ ---
293
+
294
+ ## 🔒 Security
295
+
296
+ Ingestion is sandboxed to a configurable base directory (`RAG_INGEST_BASE`). Requests outside it are rejected with `403`. See [SECURITY.md](SECURITY.md).
297
+
298
+ ## 📄 License
299
+
300
+ MIT — see [LICENSE](LICENSE).
@@ -0,0 +1,201 @@
1
+ <div align="center">
2
+ <img src="docs/assets/repl-animation.gif" alt="Axon" width="400" />
3
+
4
+ <h3>Your documents, answerable. On your hardware.</h3>
5
+
6
+ <p>
7
+ Drop in PDFs, code, spreadsheets, or URLs — ask anything, get cited answers from a local LLM.<br/>
8
+ Nothing leaves your machine.
9
+ </p>
10
+
11
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
12
+ [![Tests](https://img.shields.io/badge/tests-passing-brightgreen.svg)](tests/)
13
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
14
+ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
15
+
16
+ </div>
17
+
18
+ ---
19
+
20
+ <div align="center">
21
+ <img src="docs/assets/repl-demo.png" alt="Axon REPL startup" width="820" />
22
+ </div>
23
+
24
+ ---
25
+
26
+ ## 🤔 Why Axon?
27
+
28
+ Most RAG tools make you choose between **cloud power** and **data privacy**. Axon runs entirely on your hardware — full capability, zero egress.
29
+
30
+ - 🔒 **Private by default** — all inference runs locally via Ollama or vLLM. No API key, no upload, no telemetry.
31
+ - 📄 **Ingest anything** — 54 file formats (PDF, DOCX, Jupyter, code, images, URLs) in one command. SHA-256 dedup skips unchanged files.
32
+ - 🤖 **Works in your tools** — `@axon` in Copilot Chat, MCP for Claude Code / Codex / Gemini CLI / Cursor, Graph panel in VS Code or your browser.
33
+ - 🤝 **Built for teams** — share your knowledge base with signed, revocable read-only keys. Per-user permissions, full audit trail, no extra infrastructure.
34
+ - 🕸️ **See your knowledge as a graph** — interactive 3D entity-relationship graph. Embedded webview in VS Code; opens in your browser everywhere else. Click any node to jump to the exact source line.
35
+ - 🔬 **Production-grade retrieval** — hybrid search, reranking, HyDE, multi-query expansion, and automatic web fallback. Zero manual tuning.
36
+
37
+ ---
38
+
39
+ ## ✨ Capabilities
40
+
41
+ <table>
42
+ <tr>
43
+ <td width="50%" valign="top">
44
+
45
+ ### 🔍 Retrieval
46
+ - Hybrid semantic + keyword search
47
+ - HyDE, multi-query, step-back, query decomposition
48
+ - Sentence-window context retrieval
49
+ - BGE reranker for second-pass precision
50
+ - Web fallback via Brave Search (CRAG-Lite)
51
+ - Smart per-question query routing
52
+
53
+ </td>
54
+ <td width="50%" valign="top">
55
+
56
+ ### 🧠 Graph Intelligence
57
+ - **RAPTOR** — hierarchical corpus summaries
58
+ - **GraphRAG** — entity/relation/community graph (local / global / hybrid)
59
+ - **Code Graph** — file/class/function graph with import edges
60
+ - Interactive 3D graph — embedded webview in VS Code, browser elsewhere
61
+
62
+ </td>
63
+ </tr>
64
+ <tr>
65
+ <td width="50%" valign="top">
66
+
67
+ ### 📥 Ingest Everything
68
+ - **54 file formats** — PDF, DOCX, XLSX, PPTX, Jupyter, images, 24 code formats
69
+ - URL ingestion — any public web page
70
+ - SHA-256 dedup skips unchanged files
71
+ - Stale detection for modified sources
72
+ - 4 content-aware chunking strategies
73
+
74
+ </td>
75
+ <td width="50%" valign="top">
76
+
77
+ ### 🔧 LLMs & Embeddings
78
+ - **Local:** Ollama, vLLM
79
+ - **Cloud:** OpenAI, Gemini, xAI Grok, GitHub Copilot (API)
80
+ - Hot-swap provider and model — no restart needed
81
+ - Streaming on all providers
82
+ - 4 embedding providers; BGE-M3 for multilingual
83
+
84
+ </td>
85
+ </tr>
86
+ <tr>
87
+ <td width="50%" valign="top">
88
+
89
+ ### 🏗️ Projects & Privacy
90
+ - Isolated knowledge base per project, with nesting
91
+ - Federated search across projects (`@projects`, `@mounts`, `@store`)
92
+ - **Strict offline / air-gapped mode** — zero outbound calls
93
+ - **AxonStore** — signed read-only sharing across OS users
94
+
95
+ </td>
96
+ <td width="50%" valign="top">
97
+
98
+ ### 🛡️ Governance & Agents
99
+ - **Governance Console** — full audit trail of every query
100
+ - Graceful maintenance states: `normal → draining → readonly → offline`
101
+ - **REST API** — 54 endpoints with Swagger docs at `/docs`
102
+ - **MCP server** — 30 tools for Claude Code, Codex, Gemini, Cursor, Copilot
103
+ - **`@axon`** VS Code chat participant with Graph and Governance panels
104
+
105
+ </td>
106
+ </tr>
107
+ </table>
108
+
109
+ ---
110
+
111
+ ## ⚡ Quick Start
112
+
113
+ ```bash
114
+ pip install -e . # requires Python 3.10+ and Ollama
115
+ axon # launches the interactive REPL
116
+ ```
117
+
118
+ **[→ Full installation guide with VS Code, MCP, and cloud provider setup](docs/GETTING_STARTED.md)**
119
+
120
+ ---
121
+
122
+ ## 🚀 Entry Points
123
+
124
+ | Command | Starts | Default Port | Best For |
125
+ |---------|--------|-------------|---------|
126
+ | `axon` | Interactive REPL | — | Day-to-day exploration, power users |
127
+ | `axon-api` | FastAPI REST server | `8000` | Agents, scripts, CI pipelines |
128
+ | `axon-mcp` | MCP stdio server | — | Any MCP-compatible agent (Claude Code, Codex, Gemini CLI, Cursor, Copilot…) |
129
+ | `axon-ui` | Streamlit UI | `8501` | Browser-based exploration |
130
+
131
+ ---
132
+
133
+ ## 🔌 VS Code + GitHub Copilot
134
+
135
+ <div align="center">
136
+ <img src="docs/assets/AxonCopilot.gif" alt="Axon Copilot integration" width="400" />
137
+ </div>
138
+
139
+ <br/>
140
+
141
+ <div align="center">
142
+ <img src="docs/assets/vscode-graph-panel.png" alt="Axon VS Code Graph Panel — answer, cited sources, and interactive 3D code graph" width="820" />
143
+ </div>
144
+
145
+ <br/>
146
+
147
+ Install the bundled VSIX to unlock the **`@axon` chat participant**, **Knowledge Graph panel**, **Code Graph panel**, and **Governance dashboard** — directly inside VS Code alongside Copilot.
148
+
149
+ ```
150
+ Extensions panel → "..." → Install from VSIX...
151
+ → run `axon-ext` (or install from VSIX manually)
152
+ ```
153
+
154
+ Or connect via MCP for Copilot agent mode — point `.vscode/mcp.json` at `axon-mcp` and all 30 tools appear in the agent hammer menu automatically.
155
+
156
+ **[Full setup guide →](docs/SETUP.md)**
157
+
158
+ ---
159
+
160
+ ## 📚 Documentation
161
+
162
+ **Getting started**
163
+
164
+ | | Guide | What it covers |
165
+ |-|-------|---------------|
166
+ | 🚀 | **[Getting Started](docs/GETTING_STARTED.md)** | First-time walkthrough — ingest, query, settings |
167
+ | ⚙️ | **[Setup Guide](docs/SETUP.md)** | Install, models, VS Code extension, MCP connection |
168
+ | 🔧 | **[Troubleshooting](docs/TROUBLESHOOTING.md)** | Common errors and platform-specific fixes |
169
+
170
+ **Reference**
171
+
172
+ | | Guide | What it covers |
173
+ |-|-------|---------------|
174
+ | 🔑 | **[Admin Reference](docs/ADMIN_REFERENCE.md)** | Every endpoint, REPL command, CLI flag, and config option |
175
+ | ⚡ | **[Quick Reference](docs/QUICKREF.md)** | Commands and flags at a glance |
176
+ | 📡 | **[API Reference](docs/API_REFERENCE.md)** | Full REST endpoint reference with request/response schemas |
177
+ | 🔌 | **[MCP Tools](docs/MCP_TOOLS.md)** | All 30 MCP tool signatures with parameter defaults |
178
+
179
+ **Deep dives**
180
+
181
+ | | Guide | What it covers |
182
+ |-|-------|---------------|
183
+ | 🤖 | **[Model Guide](docs/MODEL_GUIDE.md)** | Choosing LLM and embeddings; per-provider config examples |
184
+ | 🔬 | **[Advanced RAG](docs/ADVANCED_RAG.md)** | HyDE, RAPTOR, GraphRAG, CRAG-Lite — how each technique works |
185
+ | 🌐 | **[Web Search](docs/WEB_SEARCH.md)** | Brave Search integration, CRAG-Lite fallback setup |
186
+ | 🏝️ | **[Offline / Air-gap Guide](docs/OFFLINE_GUIDE.md)** | Full air-gap setup, model pre-download, local-assets-only mode |
187
+ | 💻 | **[Code RAG Guide](docs/CODE_RAG_GUIDE.md)** | Code graph retrieval and structural search |
188
+ | 🤝 | **[AxonStore](docs/AXON_STORE.md)** | Multi-user sharing, revocation, and the lease lifecycle |
189
+ | 📊 | **[Governance Console](docs/GOVERNANCE_CONSOLE.md)** | Audit trail, maintenance runbook, session management |
190
+ | 📈 | **[Evaluation Guide](docs/EVALUATION.md)** | RAGAS metrics, running evals, building testsets |
191
+ | 🛠️ | **[Development Guide](docs/DEVELOPMENT.md)** | Tests, contributing, pre-commit hooks |
192
+
193
+ ---
194
+
195
+ ## 🔒 Security
196
+
197
+ Ingestion is sandboxed to a configurable base directory (`RAG_INGEST_BASE`). Requests outside it are rejected with `403`. See [SECURITY.md](SECURITY.md).
198
+
199
+ ## 📄 License
200
+
201
+ MIT — see [LICENSE](LICENSE).