jb/pi-ask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add native pi-style @ file references

Browse Source
This commit is contained in:
Erik Kotsiuba
2026-04-25 20:01:43 +02:00
parent 7cca5eb54d
commit 8206be370e
3 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -1
View File
@@ -25,6 +25,7 @@ Once installed, this package gives the agent a native way to ask for clarificati
- 🧭 Familiar ask-style interface: tabbed questions, single/multi select, and preview mode - 🧭 Familiar ask-style interface: tabbed questions, single/multi select, and preview mode
- ✍️ Inline free-form `Type your own` answers - ✍️ Inline free-form `Type your own` answers
- 📎 Native pi-style `@` file references inside answer and note editors
- 📝 Question-level and option-level notes - 📝 Question-level and option-level notes
- 👀 Review tab with `Submit`, `Elaborate`, and `Cancel` - 👀 Review tab with `Submit`, `Elaborate`, and `Cancel`
- 💬 Elaboration flow to capture note-based clarification before final submission - 💬 Elaboration flow to capture note-based clarification before final submission
@@ -57,6 +58,11 @@ Capture free-form input inline without leaving the flow.
![Inline custom answer input for Type your own option](docs/media/feature-custom-answer-input.png) ![Inline custom answer input for Type your own option](docs/media/feature-custom-answer-input.png)
### Native `@` file references
Use pi-style `@` file path autocomplete inside free-form answers and note editors.
![Native pi-style @ file references inside the ask flow](docs/media/feature-at-file-mentions.png)
### Option notes ### Option notes
Attach clarification notes to a specific option (`n`). Attach clarification notes to a specific option (`n`).
@@ -105,7 +111,7 @@ Ask the agent to elaborate on notes before finalizing choices.
After installation, the extension registers the `ask_user` tool. After installation, the extension registers the `ask_user` tool.
Agents can auto-discover and call it when they need clarification instead of guessing. In interactive sessions, it opens a terminal UI flow for structured answers and returns normalized answers back to the agent. Agents can auto-discover and call it when they need clarification instead of guessing. In interactive sessions, it opens a terminal UI flow for structured answers, supports native pi-style `@` file references while typing answers or notes, and returns normalized answers back to the agent.
This package also bundles the `ask-user` skill profile from `skills/ask-user/SKILL.md`. It reinforces when to use the tool, is enabled by default when installed, and can be disabled via `pi config`. The skill was inspired by https://github.com/edlsh/pi-ask-user. This package also bundles the `ask-user` skill profile from `skills/ask-user/SKILL.md`. It reinforces when to use the tool, is enabled by default when installed, and can be disabled via `pi config`. The skill was inspired by https://github.com/edlsh/pi-ask-user.
docs/contract.md
+1 -1
View File
@@ -191,7 +191,7 @@ This document defines the stable external behavior. It does not explain internal
- tabbed multi-question flow - tabbed multi-question flow
- single-select, multi-select, and preview questions - single-select, multi-select, and preview questions
- inline free-form answers for all question types - inline free-form answers for all question types
- pi-style `@` file path autocomplete inside free-form answer and note editors - native pi-style `@` file path autocomplete inside free-form answer and note editors
- question notes via `Shift+N` - question notes via `Shift+N`
- option notes via `n` - option notes via `n`
- number-key quick selection - number-key quick selection
docs/media/feature-at-file-mentions.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 40 KiB