Skip to content

Commit d6147fe

Browse files
committed
plugin: question-only /code-ask (v1.2)
1 parent 78b7968 commit d6147fe

4 files changed

Lines changed: 84 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Works in Hermes CLI, Telegram, and Hermes Desktop.
3131
| `/code-read <repo> <path>` | Read an exact file |
3232
| `/code-search <repo> "query"` | Hybrid semantic + literal search |
3333
| `/code-context <repo> "query"` | Retrieve a compact context pack |
34-
| `/code-ask <repo> "query" "question"` | Retrieve + answer with citations |
34+
| `/code-ask <repo> "question"` | Retrieve + answer with citations (add an optional `"query"` before the question to steer retrieval) |
3535

3636
Telegram uses underscore forms (`/code_ask`, …).
3737

@@ -124,8 +124,8 @@ exactly as `/code-repos` prints it (case-sensitive).
124124
# 4. Context pack — retrieve snippets, then ask follow-ups in plain chat
125125
/code-context hello-world "startup and initialization flow" 6
126126
127-
# 5. Grounded Q&A — first string is the SEARCH query, second is the QUESTION
128-
/code-ask hello-world "input validation" "How are user inputs validated, and where could that fail?"
127+
# 5. Grounded Q&A — your question retrieves on its own; add a query first to steer
128+
/code-ask hello-world "How are user inputs validated, and where could that fail?"
129129
/code-ask hello-world "database connection setup" "Walk me through how a connection is opened, reused, and closed." 8
130130
```
131131

‎commands.py‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,9 @@ def _handle_code_help_command(raw_args):
4646
"/code_search <repo_name> \"query\" [n_results]",
4747
"/code-context <repo_name> \"query\" [n_results]",
4848
"/code_context <repo_name> \"query\" [n_results]",
49-
"/code-ask <repo_name> \"query\" \"question\" [n_results]",
50-
"/code_ask <repo_name> \"query\" \"question\" [n_results]",
49+
"/code-ask <repo_name> \"question\" [n_results]",
50+
"/code_ask <repo_name> \"question\" [n_results]",
51+
"/code-ask <repo_name> \"retrieval query\" \"question\" [n_results]",
5152
"/code-read <repo_name> <relative_path> [max_bytes]",
5253
"/code_read <repo_name> <relative_path> [max_bytes]",
5354
"",
@@ -120,19 +121,38 @@ def _handle_code_context_command(raw_args):
120121
return _format_context_command_output(result)
121122

122123

124+
_ASK_USAGE = (
125+
'Usage: /code-ask <repo_name> "<question>" [n_results]\n'
126+
' or: /code-ask <repo_name> "<retrieval query>" "<question>" [n_results]'
127+
)
128+
129+
123130
def _handle_code_ask_command(raw_args, ctx=None):
124131
try:
125132
args = shlex.split(raw_args or "")
126133
except ValueError as error:
127-
return f"Usage: /code-ask <repo_name> <query> <question> [n_results]\nError: {error}"
134+
return f"{_ASK_USAGE}\nError: {error}"
128135

129-
if len(args) < 3:
130-
return "Usage: /code-ask <repo_name> <query> <question> [n_results]"
136+
if len(args) < 2:
137+
return _ASK_USAGE
131138

139+
# The question is the only required input; it doubles as the retrieval
140+
# query unless an explicit query is given (mirrors the dashboard).
141+
# Forms: <repo> <question> | <repo> <question> <n>
142+
# <repo> <query> <question> | <repo> <query> <question> <n>
132143
repo_name = args[0]
133-
query = args[1]
134-
question = args[2]
135-
n_results = args[3] if len(args) > 3 else 5
144+
rest = args[1:]
145+
n_results = 5
146+
if len(rest) > 1 and rest[-1].isdigit():
147+
n_results = rest[-1]
148+
rest = rest[:-1]
149+
150+
if len(rest) == 1:
151+
query = question = rest[0]
152+
elif len(rest) == 2:
153+
query, question = rest
154+
else:
155+
return _ASK_USAGE
136156

137157
result = _search_context(repo_name, query, n_results)
138158
prompt = _format_ask_command_output(result, question=question)

‎plugin.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
name: sourcevault-code-tools
2-
version: "1.1"
2+
version: "1.2"
33
description: Adds signed sourcevault code tools and slash commands.

‎test_plugin.py‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,5 +239,57 @@ def test_failed_followup_keeps_primary(self):
239239
self.assertEqual(plugin._merge_search_results(primary, failed), primary)
240240

241241

242+
243+
244+
class TestAskCommandForms(unittest.TestCase):
245+
"""Argument forms for /code-ask. _search_context is stubbed (no network)."""
246+
247+
def setUp(self):
248+
self.commands = sys.modules["sourcevault_code_tools.commands"]
249+
self.calls = []
250+
self._real = self.commands._search_context
251+
252+
def stub(repo_name, query, n_results):
253+
self.calls.append({"repo": repo_name, "query": query, "n": n_results})
254+
return json.dumps({"ok": True, "repo_name": repo_name, "query": query, "results": [
255+
{"file": "a.js", "chunk": 0, "content": "code", "preview": "code"},
256+
]})
257+
258+
self.commands._search_context = stub
259+
260+
def tearDown(self):
261+
self.commands._search_context = self._real
262+
263+
def test_question_only(self):
264+
out = plugin._handle_code_ask_command('myrepo "How does auth work?"')
265+
self.assertEqual(self.calls[0]["query"], "How does auth work?")
266+
self.assertEqual(self.calls[0]["n"], 5)
267+
self.assertIn("How does auth work?", out)
268+
269+
def test_question_only_with_count(self):
270+
plugin._handle_code_ask_command('myrepo "How does auth work?" 8')
271+
self.assertEqual(self.calls[0]["query"], "How does auth work?")
272+
self.assertEqual(self.calls[0]["n"], "8")
273+
274+
def test_query_and_question(self):
275+
plugin._handle_code_ask_command('myrepo "hmac signature" "Is this replay-safe?"')
276+
self.assertEqual(self.calls[0]["query"], "hmac signature")
277+
278+
def test_query_question_and_count(self):
279+
plugin._handle_code_ask_command('myrepo "hmac" "Is this safe?" 9')
280+
self.assertEqual(self.calls[0]["query"], "hmac")
281+
self.assertEqual(self.calls[0]["n"], "9")
282+
283+
def test_too_few_args_shows_usage(self):
284+
out = plugin._handle_code_ask_command("myrepo")
285+
self.assertIn("Usage:", out)
286+
self.assertEqual(self.calls, [])
287+
288+
def test_numeric_question_is_not_eaten_as_count(self):
289+
# A lone trailing number with nothing else is the question, not n.
290+
plugin._handle_code_ask_command('myrepo "404"')
291+
self.assertEqual(self.calls[0]["query"], "404")
292+
293+
242294
if __name__ == "__main__":
243295
unittest.main(verbosity=2)

0 commit comments

Comments
 (0)