Skip to content

Commit 290060e

Browse files
committed
docs: document RAG support
1 parent 0f23b55 commit 290060e

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,16 @@ CRLLM is designed to be easy to use right from your terminal. Below are some exa
102102
To perform a code review for a file or GIT repository run:
103103
```sh
104104
crllm path/to/your/codefile.py
105+
```
106+
107+
## Enabling RAG Support
108+
109+
To enhance code reviews with source context, enable RAG (Retrieval-Augmented Generation) in `crllm_config.toml`:
110+
111+
```toml
112+
[rag]
113+
enabled = true
114+
embedding_model = "all-minilm" # Specify the embedding model
115+
src_path = "./" # Define the root path of your source code
116+
src_glob = "**/*.py" # Use glob patterns to match source files (e.g., Python files)
105117
```

0 commit comments

Comments
 (0)