ShellTool

[bniladridas]

Summary

Added ability for the RAG assistant to execute shell commands using the new SHELL: tool, enabling git operations and other command-line tasks directly from the TUI.

Features

• SHELL: tool - Execute any shell command via SHELL: <command> prefix
• Git Operations - Full git workflow support (status, add, commit, push, etc.)
• Natural Language - LLM can interpret natural language requests and execute appropriate commands

Testing Commands and Outputs

Test 1: Python Script with SHELL Prefix

cd /Users/niladri/rag && python -c "
from src.rag.rag_engine import RAGEngine
import logging
logging.basicConfig(level=logging.WARNING)
rag = RAGEngine()
rag.set_backend('ollama')
tests = [
    'SHELL: git status',
    'SHELL: git add .',
    'SHELL: git diff --staged',
    'SHELL: git commit -m \"feat: test commit\"',
]
for q in tests:
    print(f'Q: {q}')
    resp = rag.generate_response(q)
    print(f'A: {resp[:300]}...' if len(resp) > 300 else f'A: {resp}')
    print()
"

Output:

Q: SHELL: git status
A: On branch main
Your branch is up to date with 'origin/main'.

Changes to be committed:
  modified:   skill.asc
  modified:   src/rag/rag_engine.py
  modified:   src/rag/tools.py
  modified:   src/rag/ui/tui.py

Q: SHELL: git add .
A: (command completed with no output)

Q: SHELL: git diff --staged
A: diff --git a/skill.asc b/skill.asc
...

Test 2: ToolExecutor Direct Tests

cd /Users/niladri/rag && python -c "
from src.rag.tools import ToolExecutor
t = ToolExecutor()
tests = [
    'SHELL: git status',
    'SHELL: git add .',
    'SHELL: git diff --staged',
    'SHELL: git log --oneline -3',
    'SHELL: git branch',
]
for cmd in tests:
    print(f'=== {cmd} ===')
    print(t.execute_tool(cmd))
    print()
"

Output:

=== SHELL: git status ===
On branch main
Your branch is up to date with 'origin/main'.

Changes not staged for commit:
  modified:   skill.asc
  modified:   src/rag/rag_engine.py
  modified:   src/rag/tools.py
  modified:   src/rag/ui/tui.py

no changes added to commit

=== SHELL: git add . ===
(command completed with no output)

=== SHELL: git log --oneline -3 ===
5e208a2 docs: update webpage version
03c7778 docs: update changelog
a997df5 chore(release): 1.8.3

=== SHELL: git branch ===
* main

Test 3: TUI Natural Language

❯ ollama:llama3 run git status
Batches: 100%|████████████████████████████████| 1/1 [00:00<00:00, 4.76it/s]
INFO: Retrieved 3 context docs for query: run git status
INFO: Generating text with backend: ollama
INFO: Ollama request using model: llama3
INFO: Ollama response received: SHELL: git status...
INFO: Iteration response: 'SHELL: git status'
INFO: Tool executed, result: On branch main...
A: You've got a bunch of changes waiting to be committed!

According to the `git status` tool, your local branch "main" is up to date with the remote repository "origin/main". You've made some modifications to files:
- skill.asc
- src/rag/rag_engine.py
- src/rag/tools.py
- src/rag/ui/tui.py

To proceed, you can use `git restore --staged <file>` to unstage individual files or commit all changes at once using `git add .` followed by `git commit -m "commit message"`.

❯ ollama:llama3 add the files
A: Based on your request, you want to stage the modified files for the next commit. The `git add` command will update what will be committed.

❯ ollama:llama3 show me recent commits
A: Here are the recent commits...

❯ ollama:llama3 push to remote
A: To https://github.com/bniladridas/rag
   5e208a2..183acc7  main -> main

Test 4: Direct Tool Prefix in TUI

❯ SHELL: git status
On branch main
Your branch is up to date with 'origin/main'.

Changes to be committed:
  modified:   skill.asc
  modified:   src/rag/rag_engine.py
  modified:   src/rag/tools.py
  modified:   src/rag/ui/tui.py

❯ SHELL: git add .
(command completed with no output)

❯ SHELL: git log --oneline -3
5e208a2 docs: update webpage version
03c7778 docs: update changelog
a997df5 chore(release): 1.8.3

❯ SHELL: git branch
* main

❯ SHELL: git push
To https://github.com/bniladridas/rag
   5e208a2..183acc7  main -> main

Implementation Files

• src/rag/tools.py - SHELL tool implementation with _execute_shell() method
• src/rag/rag_engine.py - Tool execution logic and prompt updates
• skill.asc - LLM system instructions with SHELL tool documentation
• README.asc - Documentation with examples

Status

Complete - Merged to main (commit 183acc7)

---

Related: Issue #72