CLI and Cursor skill to refine graphify knowledge graphs with DeepRefine
Project description
Type /deeprefine in your AI coding assistant after you've built a graphify knowledge base — it patches graphify-out/graph.json from your session's query history to evolve your LLM-Wiki.
Works in Cursor (deeprefine cursor install). /deeprefine runs the same control flow as Reafiner.refine() in the agent: graphify query / k-hop reads (no FAISS), session LLM for judgement/abduction/actions, mandatory loop_trace_*.json, then deeprefine apply. Optional deeprefine refine = full FAISS + API runtime.
/deeprefine
Typical flow: graphify . → graphify query "..." → /deeprefine (agent loop: search → judge → abduct → actions → deeprefine apply).
That's it. Under graphify-out/.deeprefine/ you get:
graphify-out/
├── graph.json updated graph (graphify reads this)
└── .deeprefine/
├── history.jsonl queries queued for refinement
├── refinement_results_*.jsonl run logs
└── graph.json.bak backup before each refine
Standalone repo. Model code (
autorefiner,atlas_rag) lives in a separate DeepRefine checkout.
pip install deeprefine-cliships the CLI andSKILL.md. Agent mode (/deeprefine): same loop logic, no FAISS retriever, no extra API keys. CLI mode (deeprefine refine): fullReafiner+ embeddings (vLLM or API).
News
- [2026/6/2] deeprefine-cli v0.1.7 — agent Reafiner loop +
deeprefine loop/apply --trace-file.
Quick start
| Step | What |
|---|---|
| 1 | Install DeepRefine in atlastune |
| 2 | pip install deeprefine-cli |
| 3 | deeprefine cursor install in your KB project |
| 4 | (Optional) start local vLLM, or use your API provider |
| 5 | Cursor: /deeprefine (agent loop); or terminal: history add + deeprefine refine |
# 1) DeepRefine (once)
conda activate atlastune
cd /path/to/DeepRefine && pip install -e .
# 2) CLI (once per env)
pip install deeprefine-cli
# 3) Cursor skill (KB project root)
cd /path/to/your-kb-project
deeprefine cursor install
# 4) Optional local vLLM (each session, from DeepRefine repo)
bash /path/to/DeepRefine/scripts/vllm_serve/qwen3-0.6b-emb.sh
bash /path/to/DeepRefine/scripts/vllm_serve/qwen3-8b-vllm-reafiner.sh
# OR use your API provider (no local vLLM)
export DEEPREFINE_LLM_URL=your-llm-endpoint
export DEEPREFINE_EMBED_URL=your-embed-endpoint
export DEEPREFINE_LLM_API_KEY=your_llm_api_key
export DEEPREFINE_EMBED_API_KEY=your_embed_api_key
export DEEPREFINE_MODEL=your_llm_model
export DEEPREFINE_EMBED_MODEL=your_embed_model
# optional (if your provider uses one key for both):
# export DEEPREFINE_API_KEY=your_shared_api_key
# optional model overrides:
# 5) Refine
# Cursor: /deeprefine (agent loop: graphify query + judgement/abduction/actions + deeprefine apply)
# Terminal CLI mode:
deeprefine history add --query "your question"
deeprefine refine
Pipeline
| Stage | Tool | Input | Output |
|---|---|---|---|
| Build | graphify | Project files | graphify-out/graph.json |
| Query | graphify | Questions | graphify query "..." |
| Refine | deeprefine | Graph + query history | Updated graph.json, logs |
project files
│
▼ graphify
graph.json ◄────────────────────────┐
│ │
▼ graphify query "..." │ deeprefine refine
▼ graphify query "..." │ (per session query)
▼ ... │
(many Q&A in session) │
│ │
▼ /deeprefine │
(DeepRefine loop) ────────────────────┘
│
▼ graphify query (verify)
DeepRefine does not build the graph; it patches graph.json so later graphify query retrieves better.
Repository layout
DeepRefine-Skill/ ← this repo (PyPI: deeprefine-cli)
├── deeprefine_skill/ ← package (SKILL.md bundled)
└── scripts/deeprefine.py
DeepRefine/ ← separate clone
├── autorefiner/
├── AutoSchemaKG/
└── scripts/vllm_serve/
your-kb-project/
└── graphify-out/
├── graph.json
└── .deeprefine/ ← history, logs, FAISS cache
Recommended sibling layout (auto-detects ../DeepRefine when DEEPREFINE_REPO is unset):
www/code/
├── DeepRefine/
└── DeepRefine-Skill/
Installation
1. DeepRefine (atlastune)
conda activate atlastune
cd /path/to/DeepRefine
pip install -e .
2. CLI
| Method | Command |
|---|---|
| PyPI (recommended) | pip install deeprefine-cli |
| Source | pip install -e /path/to/DeepRefine-Skill |
deeprefine --help # verify
3. DeepRefine path (optional)
Only if DeepRefine is not ../DeepRefine and not found by walking up from cwd:
export DEEPREFINE_REPO=/path/to/DeepRefine
4. Inference
Default: use your API provider from environment.
Optional local vLLM (from the DeepRefine repo):
conda activate atlastune
bash /path/to/DeepRefine/scripts/vllm_serve/qwen3-0.6b-emb.sh
bash /path/to/DeepRefine/scripts/vllm_serve/qwen3-8b-vllm-reafiner.sh
| Variable | Default |
|---|---|
DEEPREFINE_LLM_URL |
(empty; SDK default endpoint) |
DEEPREFINE_EMBED_URL |
(empty; SDK default endpoint) |
DEEPREFINE_API_KEY |
fallback to OPENAI_API_KEY |
DEEPREFINE_LLM_API_KEY |
fallback to DEEPREFINE_API_KEY |
DEEPREFINE_EMBED_API_KEY |
fallback to DEEPREFINE_API_KEY |
DEEPREFINE_MODEL |
gpt-4.1-mini |
DEEPREFINE_EMBED_MODEL |
text-embedding-3-small |
5. Cursor skill
Run at KB project root (folder with or that will have graphify-out/):
| Command | Scope |
|---|---|
deeprefine cursor install |
.cursor/skills/ (this project) |
deeprefine cursor install --user |
~/.cursor/skills/ (all projects) |
deeprefine install |
alias for cursor install |
deeprefine cursor uninstall |
remove skill |
Workflow with graphify
One-time
pip install graphifyy deeprefine-cli # deeprefine-cli in atlastune
cd /path/to/your-kb-project
graphify cursor install
deeprefine cursor install
Each session (KB project root)
| # | Action |
|---|---|
| 1 | graphify . or /graphify . → graphify-out/graph.json |
| 2 | graphify query "..." |
| 3 | Cursor chat: /deeprefine (agent loop; no manual history add) |
| 4 | Terminal: deeprefine history add → deeprefine refine (FAISS + API/vLLM) |
| 5 | (optional) graphify query "..." to verify |
Commands
All commands below run from KB project root.
| Command | Description |
|---|---|
deeprefine history add --query "..." |
Record a query after graph Q&A |
deeprefine history list |
List all history entries |
deeprefine history list --pending |
List unrefined queries only |
deeprefine refine |
Refine all pending queries |
deeprefine refine --query "..." |
Refine one query (also recorded) |
deeprefine refine --rebuild-index |
Rebuild FAISS before refine |
deeprefine loop init/validate/finish |
Agent loop trace (enforces Reafiner rules) |
deeprefine apply --trace-file T --refinement-file F |
Apply actions (requires valid trace) |
deeprefine index --rebuild |
Rebuild FAISS cache only |
deeprefine cursor install | uninstall |
Manage Cursor skill |
Artifacts (graphify-out/.deeprefine/)
| File | Purpose |
|---|---|
history.jsonl |
Query history |
refinement_results_*.jsonl |
Refinement logs |
graph.json.bak |
Backup before refine |
reafiner.pkl |
FAISS index cache |
Cursor agent instructions: SKILL.md → installed as .cursor/skills/deeprefine/SKILL.md.
Where to run what
| What | Where |
|---|---|
pip install deeprefine-cli |
Anywhere (atlastune for refine) |
pip install -e .../DeepRefine |
DeepRefine repo |
graphify / deeprefine cursor install |
KB project root |
deeprefine refine / history |
KB project root |
| vLLM serve scripts | DeepRefine repo |
License
MIT — see LICENSE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
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 deeprefine_cli-0.1.7.tar.gz.
File metadata
- Download URL: deeprefine_cli-0.1.7.tar.gz
- Upload date:
- Size: 26.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
106eda6ce56a051af95837aa83165564be73c2a3ec54cfda02843a7a7fed440d
|
|
| MD5 |
567932d5736f85db418abe60c82cf396
|
|
| BLAKE2b-256 |
f0fa4359dda98021fe39721fca1bbe25591373931232a1ab6e8b184452c3e204
|
File details
Details for the file deeprefine_cli-0.1.7-py3-none-any.whl.
File metadata
- Download URL: deeprefine_cli-0.1.7-py3-none-any.whl
- Upload date:
- Size: 26.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a2785128bae852345b34443a0d10134760f049a76a01f31cbb67d66ff18447b
|
|
| MD5 |
e063a41b0ea0f6bef7fa0cafcd7c7d07
|
|
| BLAKE2b-256 |
7573b081ca26597b8f0650760bad0771dcb8aa88f44c81d5399baddc4ae8fd94
|