docs(readme): refresh feature-first layout and screenshots
@@ -1,6 +1,6 @@
|
|||||||
# @eko24ive/pi-ask
|
# @eko24ive/pi-ask
|
||||||
|
|
||||||
`@eko24ive/pi-ask` adds an interactive `ask_user` clarification tool.
|
`@eko24ive/pi-ask` is an ask tool that cares about your answers.
|
||||||
|
|
||||||
It lets an agent pause, ask structured questions in a terminal UI, and continue with normalized answers instead of guessing.
|
It lets an agent pause, ask structured questions in a terminal UI, and continue with normalized answers instead of guessing.
|
||||||
|
|
||||||
@@ -18,24 +18,63 @@ You can also install from git:
|
|||||||
pi install git:github.com/eko24ive/pi-ask
|
pi install git:github.com/eko24ive/pi-ask
|
||||||
```
|
```
|
||||||
|
|
||||||
### Screenshots
|
|
||||||
|
|
||||||
| | | |
|
|
||||||
| --- | --- | --- |
|
|
||||||
|  |  |  |
|
|
||||||
|  |  | |
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
Once installed, this package gives the agent a native way to ask for clarification instead of guessing.
|
Once installed, this package gives the agent a native way to ask for clarification instead of guessing.
|
||||||
|
|
||||||
- 🧭 **Multi-question flow** — gather several answers in one pass.
|
- 🧭 Familiar ask-style interface: tabbed questions, single/multi select, and preview mode
|
||||||
- ✅ **Single + multi select** — support simple and additive choices.
|
- ✍️ Inline free-form `Type your own` answers
|
||||||
- 🪟 **Preview mode** — show richer options with a dedicated preview pane.
|
- 📝 Question-level and option-level notes
|
||||||
- ✍️ **Custom answers** — users can choose `Type your own` and type inline.
|
- 👀 Review tab with `Submit`, `Elaborate`, and `Cancel`
|
||||||
- 📝 **Notes** — add question-level or option-level context without breaking the flow.
|
- 💬 Elaboration flow to capture note-based clarification before final submission
|
||||||
- 👀 **Submit screen** — check everything before submitting answers back to the agent.
|
- ⌨️ Fast keyboard-first interaction (also mobile-friendly in remote sessions)
|
||||||
- ⌨️ **Fast keyboard UX** — number shortcuts, inline selection, notes, and submit navigation.
|
|
||||||
|
## Feature walkthrough
|
||||||
|
|
||||||
|
### Multi-question flow (tabs)
|
||||||
|
Move across several related questions in one ask flow.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Single-select question
|
||||||
|
Pick one option when answers are mutually exclusive.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Multi-select question
|
||||||
|
Choose multiple options when several answers apply.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Preview mode
|
||||||
|
Use a dedicated preview pane when options need richer detail.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Custom answer (`Type your own`)
|
||||||
|
Capture free-form input inline without leaving the flow.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Option notes
|
||||||
|
Attach clarification notes to a specific option (`n`).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Question notes
|
||||||
|
Add notes at question level for broader context (`Shift+N`).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Review tab — Submit
|
||||||
|
Review all answers before returning them to the agent.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Review tab — Elaborate
|
||||||
|
Ask the agent to elaborate on notes before finalizing choices.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Use
|
## Use
|
||||||
|
|
||||||
|
|||||||
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 50 KiB |
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 76 KiB |
|
After Width: | Height: | Size: 47 KiB |
|
After Width: | Height: | Size: 50 KiB |
|
After Width: | Height: | Size: 51 KiB |
|
After Width: | Height: | Size: 42 KiB |