@polterware/polterbase 0.1.2 → 0.2.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 (3) hide show
  1. package/README.md +30 -11
  2. package/dist/index.js +1638 -196
  3. package/package.json +9 -5
package/README.md CHANGED
@@ -6,14 +6,15 @@
6
6
 
7
7
  An optimized interactive CLI for managing Supabase CLI workflows with more speed, consistency, and discoverability.
8
8
 
9
- Polterbase is a productivity layer on top of the official `supabase` CLI. Instead of memorizing command trees, you choose categories, build commands interactively, attach global flags, and pin common workflows for one-click reuse.
9
+ Polterbase is a productivity layer on top of the official `supabase` CLI. Instead of memorizing command trees, you browse one unified board, add extra args interactively, attach global flags, and pin common workflows for one-click reuse.
10
10
 
11
11
  ## Features
12
12
 
13
13
  - **Interactive Command Builder**: Guided flow for command + subcommand + extra args
14
- - **Supabase Command Discovery**: Organized by practical categories
14
+ - **Suggested Subcommand Picker**: Select common args (for example `db pull`) from boxed sections before typing custom args
15
+ - **Unified Command Board**: Pinned runs, pinned commands, grouped categories, and actions in boxed sections on one screen
15
16
  - **Global Flags Picker**: Add common global flags in one step
16
- - **Pinned Commands**: Save successful command combinations for faster repetition
17
+ - **Pinned Commands and Runs**: Toggle base command pins with `→` and pin exact runs after success
17
18
  - **Custom Command Mode**: Run raw Supabase arguments like `-v` or `status -o json`
18
19
  - **Shell Execution**: Executes your local `supabase` binary directly
19
20
  - **TypeScript-based CLI**: Strongly typed internal implementation
@@ -42,6 +43,20 @@ polterbase
42
43
 
43
44
  `polterbase` is a global CLI tool. Do not add it to `dependencies` or `devDependencies` of app projects.
44
45
 
46
+ ### Update
47
+
48
+ If you run Polterbase with `npx`, always use the latest published version explicitly:
49
+
50
+ ```bash
51
+ npx @polterware/polterbase@latest
52
+ ```
53
+
54
+ If you installed it globally, update it with:
55
+
56
+ ```bash
57
+ npm install -g @polterware/polterbase@latest
58
+ ```
59
+
45
60
  ---
46
61
 
47
62
  ## Requirements
@@ -74,12 +89,11 @@ supabase <command> <extra-args> <global-flags>
74
89
 
75
90
  ### Typical Flow
76
91
 
77
- 1. Choose a category
78
- 2. Choose a base command
79
- 3. Add optional extra args
92
+ 1. Choose a command from the unified board
93
+ 2. Optionally pin/unpin with `→`
94
+ 3. Choose suggested args or type custom extra args
80
95
  4. Pick optional global flags
81
96
  5. Confirm and execute
82
- 6. Optionally pin command after success
83
97
 
84
98
  ---
85
99
 
@@ -156,11 +170,16 @@ Available global flags in the interactive selector:
156
170
 
157
171
  ## Pinned Commands
158
172
 
159
- After a successful execution, Polterbase can pin the command for quick reuse.
173
+ Polterbase supports two pinned sections at the top of the main menu:
174
+
175
+ - `Pinned Runs` for exact commands like `db pull --debug`
176
+ - `Pinned Commands` for base commands like `db` or `start`
160
177
 
161
- Pinned items appear at the top of the main menu and can be removed via:
178
+ The main menu and the suggested-args screen group related options into boxed sections so pinned items, command groups, and actions stay visually separated.
162
179
 
163
- - `Manage Pinned Commands`
180
+ Use `→` on a selected base command to pin or unpin it.
181
+ Use `→` on the suggested subcommand screen to pin exact runs like `db pull` before executing.
182
+ After a successful execution, Polterbase can also pin that exact command into `Pinned Runs`.
164
183
 
165
184
  Pins are persisted locally using OS-level app config storage.
166
185
 
@@ -245,7 +264,7 @@ Polterbase forwards execution to Supabase CLI. Use `--debug` and re-run to inspe
245
264
 
246
265
  ### Pinned commands are missing
247
266
 
248
- Pins are only suggested after successful runs. Confirm the pin prompt after a successful command.
267
+ Pins are managed directly in the board. Select a base command and press `→` to pin it, or pin an exact run after a successful execution.
249
268
 
250
269
  ### Interactive prompt did not open correctly
251
270