pi-ask-user 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -11
  2. package/package.json +16 -1
package/README.md CHANGED
@@ -1,14 +1,14 @@
1
1
  # pi-ask-user
2
2
 
3
- A Pi package that provides an interactive `ask_user` tool for gathering user input during agent execution.
3
+ A Pi package that adds an interactive `ask_user` tool for collecting user decisions during an agent run.
4
4
 
5
5
  ## Features
6
6
 
7
7
  - Single-select option lists
8
8
  - Multi-select option lists
9
- - Optional freeform response mode
10
- - Context text support
11
- - Graceful fallback when UI is unavailable
9
+ - Optional freeform responses
10
+ - Context display support
11
+ - Graceful fallback when interactive UI is unavailable
12
12
 
13
13
  ## Install
14
14
 
@@ -16,11 +16,13 @@ A Pi package that provides an interactive `ask_user` tool for gathering user inp
16
16
  pi install npm:pi-ask-user
17
17
  ```
18
18
 
19
- ## Use
19
+ ## Tool name
20
20
 
21
- Once installed, the tool is available to the agent as `ask_user`.
21
+ The registered tool name is:
22
22
 
23
- Example call shape:
23
+ - `ask_user`
24
+
25
+ ## Example usage shape
24
26
 
25
27
  ```json
26
28
  {
@@ -41,11 +43,20 @@ Example call shape:
41
43
  pi -e ./index.ts
42
44
  ```
43
45
 
44
- ## Publish
46
+ ## Release workflow
45
47
 
46
- ```bash
47
- npm publish
48
- ```
48
+ ### One-time setup
49
+
50
+ 1. Add `NPM_TOKEN` in GitHub repo secrets.
51
+ 2. Keep `package.json` version in sync with release tag.
52
+
53
+ ### Publish with provenance (recommended)
54
+
55
+ - Create tag: `vX.Y.Z`
56
+ - Create a GitHub Release for that tag
57
+ - The `publish.yml` workflow publishes to npm with `--provenance`
58
+
59
+ You can also trigger the publish workflow manually from GitHub Actions.
49
60
 
50
61
  ## License
51
62
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pi-ask-user",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Interactive ask_user tool for pi-coding-agent with multi-select and freeform input UI",
5
5
  "type": "module",
6
6
  "keywords": [
@@ -12,7 +12,19 @@
12
12
  "ask_user",
13
13
  "interactive"
14
14
  ],
15
+ "author": "Enzo Lucchesi <enzo@edl.sh>",
15
16
  "license": "MIT",
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "git+https://github.com/edlsh/pi-ask-user.git"
20
+ },
21
+ "bugs": {
22
+ "url": "https://github.com/edlsh/pi-ask-user/issues"
23
+ },
24
+ "homepage": "https://github.com/edlsh/pi-ask-user#readme",
25
+ "publishConfig": {
26
+ "access": "public"
27
+ },
16
28
  "pi": {
17
29
  "extensions": [
18
30
  "./index.ts"
@@ -23,6 +35,9 @@
23
35
  "README.md",
24
36
  "LICENSE"
25
37
  ],
38
+ "scripts": {
39
+ "check": "npm pack --dry-run"
40
+ },
26
41
  "peerDependencies": {
27
42
  "@mariozechner/pi-coding-agent": "*",
28
43
  "@mariozechner/pi-tui": "*",