@noy-db/in-devtools-tui 0.3.0-pre.8 → 0.3.0
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 +33 -0
- package/package.json +8 -7
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @noy-db/in-devtools-tui
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@noy-db/in-devtools-tui)
|
|
4
|
+
|
|
5
|
+
> Interactive terminal inspector for a live [noy-db](https://github.com/vLannaAi/noy-db) — an [ink](https://github.com/vadimdemedes/ink) TUI over [`@noy-db/in-devtools`](https://www.npmjs.com/package/@noy-db/in-devtools).
|
|
6
|
+
|
|
7
|
+
Part of [**`@noy-db/hub`**](https://www.npmjs.com/package/@noy-db/hub) — the zero-knowledge, offline-first, encrypted document store.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add -D @noy-db/in-devtools-tui
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
Point the `noydb-inspect` bin at a config file that default-exports your `NoydbOptions`. It unlocks the vault (prompting for the passphrase, or reading `--passphrase=…` / `NOYDB_PASSPHRASE`), then opens a read-only terminal dashboard of collections, records, and live writes.
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx noydb-inspect ./noydb.config.mjs --vault=acme
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Add `--meter` to wrap the store in [`@noy-db/to-meter`](https://www.npmjs.com/package/@noy-db/to-meter) and show live store metrics. Like the inspector core it wraps, the TUI is read-only and never persists your passphrase.
|
|
24
|
+
|
|
25
|
+
## Documentation
|
|
26
|
+
|
|
27
|
+
- Guide — [`content/docs/families/in/devtools-tui.md`](https://github.com/vLannaAi/noy-db-docs/blob/main/content/docs/families/in/devtools-tui.md)
|
|
28
|
+
- Source — [`packages/in-devtools-tui`](https://github.com/vLannaAi/noy-db/tree/main/packages/in-devtools-tui)
|
|
29
|
+
- Issues — [github.com/vLannaAi/noy-db/issues](https://github.com/vLannaAi/noy-db/issues)
|
|
30
|
+
|
|
31
|
+
## License
|
|
32
|
+
|
|
33
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@noy-db/in-devtools-tui",
|
|
3
|
-
"version": "0.3.0
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Interactive terminal inspector for a live noy-db (ink TUI over @noy-db/in-devtools).",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -9,23 +9,24 @@
|
|
|
9
9
|
},
|
|
10
10
|
"main": "./dist/bin.js",
|
|
11
11
|
"files": [
|
|
12
|
-
"dist"
|
|
12
|
+
"dist",
|
|
13
|
+
"README.md"
|
|
13
14
|
],
|
|
14
15
|
"dependencies": {
|
|
15
16
|
"ink": "^5.0.1",
|
|
16
17
|
"react": "^18.3.1",
|
|
17
|
-
"@noy-db/to-meter": "0.3.0
|
|
18
|
+
"@noy-db/to-meter": "0.3.0"
|
|
18
19
|
},
|
|
19
20
|
"peerDependencies": {
|
|
20
|
-
"@noy-db/hub": "0.3.0
|
|
21
|
-
"@noy-db/in-devtools": "0.3.0
|
|
21
|
+
"@noy-db/hub": "0.3.0",
|
|
22
|
+
"@noy-db/in-devtools": "0.3.0"
|
|
22
23
|
},
|
|
23
24
|
"devDependencies": {
|
|
24
25
|
"ink-testing-library": "^4.0.0",
|
|
25
26
|
"@types/node": "^22.0.0",
|
|
26
27
|
"@types/react": "^18.3.12",
|
|
27
|
-
"@noy-db/
|
|
28
|
-
"@noy-db/
|
|
28
|
+
"@noy-db/hub": "0.3.0",
|
|
29
|
+
"@noy-db/in-devtools": "0.3.0"
|
|
29
30
|
},
|
|
30
31
|
"engines": {
|
|
31
32
|
"node": ">=22.0.0"
|