kavrix 0.2.12 → 0.2.13

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.
package/README.md CHANGED
@@ -12,6 +12,26 @@ policies and temporary grants bound what each executable may do, and
12
12
  `kavrix agent run` brokers every request from AI coding agents against those
13
13
  policies.
14
14
 
15
+ ![Kavrix interactive TUI — unlocked home](media/demo-frame-home-unlocked.png)
16
+
17
+ ## Interactive TUI
18
+
19
+ On Linux, macOS, and Windows with Node.js `>=24.12.0`, Kavrix ships a real Ink
20
+ terminal UI (no mocks — every action runs the same CLI):
21
+
22
+ ```sh
23
+ kavrix init # TUI onboarding on an interactive TTY (default)
24
+ kavrix tui # full app: profiles, vaults, credentials, doctor, recovery, …
25
+ ```
26
+
27
+ Use `kavrix init --no-tui` for classic line prompts, or stdin/explicit routing
28
+ for scripts.
29
+
30
+ ![Kavrix TUI demo](media/kavrix-tui-demo.gif)
31
+
32
+ Full video on GitHub:
33
+ [kavrix-tui-demo.mp4](https://github.com/d4rkNinja/kavrix/blob/main/docs/assets/kavrix-tui-demo.mp4).
34
+
15
35
  ## Requirements
16
36
 
17
37
  - Node.js `>=24.12.0 <25` or `>=25.1.0`
@@ -34,9 +54,10 @@ For a new local-file setup, run:
34
54
  kavrix init
35
55
  ```
36
56
 
37
- The guided TTY flow preflights the profile and protected destinations, then uses
38
- masked prompts to create an encrypted database, one default vault, and a
39
- separate recovery kit. It verifies recovery before selecting the profile.
57
+ On an interactive TTY, `kavrix init` opens Ink onboarding by default (pass
58
+ `--no-tui` for classic masked line prompts). It preflights the profile and
59
+ protected destinations, then creates an encrypted database, one default vault,
60
+ and a separate recovery kit. It verifies recovery before selecting the profile.
40
61
  Protected labels and passphrases never enter argv, environment variables, or
41
62
  the generated non-secret config reference.
42
63
 
@@ -97,7 +118,8 @@ never store MongoDB credentials, passphrases, private labels, keys, or values.
97
118
  | `key status/verify/copy/replicate/assign/rewrap` | Manage protected key files. |
98
119
  | `recovery create/verify/status/revoke/use` | Manage recovery kits. |
99
120
  | `doctor`, `doctor health` | Validate a vault; repair bounded transient state safely. |
100
- | `init`, `vault`, `legacy v2 commands` | Guided local setup; explicit/non-TTY init remains version 2 compatible. |
121
+ | `tui` / `ui` | Full interactive Ink app against the real CLI (TTY required). |
122
+ | `init`, `vault`, `legacy v2 commands` | Ink TUI onboarding on TTY (`--no-tui` classic); explicit/non-TTY init stays v2. |
101
123
  | `run` | Execute one command with selected credentials injected as environment variables only. |
102
124
  | `policy create/list/show/remove/check/explain/lint/diff/suggest` | Stored rules plus read-only simulation, diagnostics, previews, and narrowing advice. |
103
125
  | `grant create/list/show/revoke` | Temporary consumable authorizations with live expiry, restrictions, and use caps. |