Hybrid RAG search for Godot documentation
Project description
Godot RAG
Hybrid RAG search for Godot documentation. One command to search all Godot docs.
Installation
Using uv (recommended)
uv pip install godot-rag
Or from wheel:
uv pip install godot_rag-4.4.0-py3-none-any.whl
Using pip
pip install godot-rag
Usage
Search documentation
# Basic search
godot-rag search "Timer"
# Limit results
godot-rag search "Timer" --limit 3
# JSON output (for AI Agent)
godot-rag search "StringName.is_valid_filename" --json
Show info
godot-rag info
Examples
# Search for API
godot-rag search "Vector3.normalized" --limit 3
# Search for concept
godot-rag search "2D pathfinding" --limit 5
# Search for tutorial
godot-rag search "C# Variant" --limit 3
Update
When Godot releases a new version:
# Update godot-docs submodule
cd tools/godot-docs && git pull origin stable
# Rebuild docs and RAG
./build.sh
# Or manually:
python3 tools/godot-docs-rst2md/rst2md_batch.py --src tools/godot-docs --out godot_rag/docs-md
python3 tools/godot-docs-rst2md/rag/cli.py build --docs godot_rag/docs-md --db godot_rag/rag/godot_docs.sqlite
python3 -m build --wheel
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file godot_rag-4.7.0-py3-none-any.whl.
File metadata
- Download URL: godot_rag-4.7.0-py3-none-any.whl
- Upload date:
- Size: 8.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
279163726721879ac458379ba48f9649754e2fb0fd7744a540531b532573c040
|
|
| MD5 |
0aa9f288ae3d111ef6e8bcfa88aba641
|
|
| BLAKE2b-256 |
628c515c25b2431da0a10794e6989070463ebb31eafd7a10a2e9b9c6bf90fa91
|