rigjs 4.0.14 → 4.0.16
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/.claude/skills/rig-wiki/SKILL.md +28 -2
- package/RIG_WIKI_SKILL.md +28 -2
- package/built/index.js +171 -174
- package/lib/wiki/indexCmd.ts +1 -1
- package/lib/wiki/ingest.ts +2 -2
- package/lib/wiki/init.ts +4 -4
- package/lib/wiki/pathGuard.ts +24 -7
- package/lib/wiki/qmd.ts +64 -9
- package/lib/wiki/query.ts +1 -1
- package/lib/wiki/rebuild.ts +3 -3
- package/lib/wiki/survey.ts +10 -4
- package/lib/wiki/wikiignore.ts +93 -0
- package/package.json +3 -2
|
@@ -89,13 +89,39 @@ Note: page directories (`sources/`, `entities/`, `concepts/`, `synthesis/`, `que
|
|
|
89
89
|
- **Never** init a vault at a **hidden path** (any segment starting with `.`) or a **.gitignored** path. rig wiki refuses at the CLI level.
|
|
90
90
|
- **`rig wiki scan` exit 10 (RAW DRIFT)** = a `raw/` file's bytes changed since last scan. Do NOT auto-fix or re-ingest. Surface to the user as a data-integrity warning.
|
|
91
91
|
- **`rig wiki lint` exit 11** = severe findings. Surface the report path and the top findings; do not auto-fix unless the user asks.
|
|
92
|
-
- **Never** suggest editing `~/.rig
|
|
92
|
+
- **Never** suggest editing `~/.rig/<project>/wiki/*.sqlite` or `~/.cache/qmd/`. Those are rebuildable caches.
|
|
93
93
|
|
|
94
94
|
## Auto-exclusions (no config needed)
|
|
95
95
|
|
|
96
96
|
The scanner skips these automatically — do not waste user time adding them to `exclude`:
|
|
97
97
|
- Any path segment starting with `.` (`.git/`, `.obsidian/`, `.vscode/`, `.DS_Store`, …).
|
|
98
98
|
- Any path matched by the project's `.gitignore`.
|
|
99
|
+
- Any path matched by `.wikiignore` (see below).
|
|
100
|
+
|
|
101
|
+
### `.wikiignore` — wiki-only ignore file
|
|
102
|
+
|
|
103
|
+
Same syntax as `.gitignore`. Lives anywhere from the vault root up to the
|
|
104
|
+
scan-root project dir; the walker honors all `.wikiignore` files between
|
|
105
|
+
a candidate and the vault root (nested files compose, gitignore-style).
|
|
106
|
+
|
|
107
|
+
Use it for paths git tracks intentionally but the wiki MUST skip — the
|
|
108
|
+
canonical case is a private repo's secrets dir (e.g. overmind's
|
|
109
|
+
`keychain/`, `secrets/`, `.env*` outside of `.gitignore`). The same
|
|
110
|
+
filter applies to both `rig wiki sync` walk and `rig wiki ingest <path>`,
|
|
111
|
+
so an explicit `ingest keychain/foo.md` is refused, not just silently
|
|
112
|
+
unscanned.
|
|
113
|
+
|
|
114
|
+
Drop it at the scan root:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
# <project>/.wikiignore — same syntax as .gitignore
|
|
118
|
+
keychain/
|
|
119
|
+
secrets/
|
|
120
|
+
personal/life/ # remove if you want this indexed
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
`rig wiki init` prints a tip suggesting `.wikiignore` when the scan root
|
|
124
|
+
has none.
|
|
99
125
|
|
|
100
126
|
Defaults in `.rig/config.yml` from `init`:
|
|
101
127
|
- `include: ['**']` — everything that survives the auto-skips
|
|
@@ -171,7 +197,7 @@ No global registry. No `package.rig.json5` wiki block (that file is for legacy r
|
|
|
171
197
|
|
|
172
198
|
- Vector-only retrieval: Qwen3-Embedding-0.6B (~610MB) + Qwen3-Reranker-0.6B (~610MB), both CDN-mirrored at `assets.terncloud.com/rig/models/`.
|
|
173
199
|
- Models auto-downloaded on first use into `~/.cache/qmd/models/`; subsequent runs are instant.
|
|
174
|
-
- Per-vault SQLite at `~/.rig
|
|
200
|
+
- Per-vault SQLite at `~/.rig/<project>/wiki/<wiki-name>.sqlite` (sqlite-vec extension). `<project>` is resolved from the nearest `package.json#name` walking up from the vault root (legacy `~/.rig/cache/qmd/<wiki>.sqlite` migrates on first open). Machine-local cache, no need to gitignore inside the vault.
|
|
175
201
|
- `ingest` triggers incremental embed at the end — no need to manually call `index` in routine use.
|
|
176
202
|
- macOS-only in v1.
|
|
177
203
|
|
package/RIG_WIKI_SKILL.md
CHANGED
|
@@ -89,13 +89,39 @@ Note: page directories (`sources/`, `entities/`, `concepts/`, `synthesis/`, `que
|
|
|
89
89
|
- **Never** init a vault at a **hidden path** (any segment starting with `.`) or a **.gitignored** path. rig wiki refuses at the CLI level.
|
|
90
90
|
- **`rig wiki scan` exit 10 (RAW DRIFT)** = a `raw/` file's bytes changed since last scan. Do NOT auto-fix or re-ingest. Surface to the user as a data-integrity warning.
|
|
91
91
|
- **`rig wiki lint` exit 11** = severe findings. Surface the report path and the top findings; do not auto-fix unless the user asks.
|
|
92
|
-
- **Never** suggest editing `~/.rig
|
|
92
|
+
- **Never** suggest editing `~/.rig/<project>/wiki/*.sqlite` or `~/.cache/qmd/`. Those are rebuildable caches.
|
|
93
93
|
|
|
94
94
|
## Auto-exclusions (no config needed)
|
|
95
95
|
|
|
96
96
|
The scanner skips these automatically — do not waste user time adding them to `exclude`:
|
|
97
97
|
- Any path segment starting with `.` (`.git/`, `.obsidian/`, `.vscode/`, `.DS_Store`, …).
|
|
98
98
|
- Any path matched by the project's `.gitignore`.
|
|
99
|
+
- Any path matched by `.wikiignore` (see below).
|
|
100
|
+
|
|
101
|
+
### `.wikiignore` — wiki-only ignore file
|
|
102
|
+
|
|
103
|
+
Same syntax as `.gitignore`. Lives anywhere from the vault root up to the
|
|
104
|
+
scan-root project dir; the walker honors all `.wikiignore` files between
|
|
105
|
+
a candidate and the vault root (nested files compose, gitignore-style).
|
|
106
|
+
|
|
107
|
+
Use it for paths git tracks intentionally but the wiki MUST skip — the
|
|
108
|
+
canonical case is a private repo's secrets dir (e.g. overmind's
|
|
109
|
+
`keychain/`, `secrets/`, `.env*` outside of `.gitignore`). The same
|
|
110
|
+
filter applies to both `rig wiki sync` walk and `rig wiki ingest <path>`,
|
|
111
|
+
so an explicit `ingest keychain/foo.md` is refused, not just silently
|
|
112
|
+
unscanned.
|
|
113
|
+
|
|
114
|
+
Drop it at the scan root:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
# <project>/.wikiignore — same syntax as .gitignore
|
|
118
|
+
keychain/
|
|
119
|
+
secrets/
|
|
120
|
+
personal/life/ # remove if you want this indexed
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
`rig wiki init` prints a tip suggesting `.wikiignore` when the scan root
|
|
124
|
+
has none.
|
|
99
125
|
|
|
100
126
|
Defaults in `.rig/config.yml` from `init`:
|
|
101
127
|
- `include: ['**']` — everything that survives the auto-skips
|
|
@@ -171,7 +197,7 @@ No global registry. No `package.rig.json5` wiki block (that file is for legacy r
|
|
|
171
197
|
|
|
172
198
|
- Vector-only retrieval: Qwen3-Embedding-0.6B (~610MB) + Qwen3-Reranker-0.6B (~610MB), both CDN-mirrored at `assets.terncloud.com/rig/models/`.
|
|
173
199
|
- Models auto-downloaded on first use into `~/.cache/qmd/models/`; subsequent runs are instant.
|
|
174
|
-
- Per-vault SQLite at `~/.rig
|
|
200
|
+
- Per-vault SQLite at `~/.rig/<project>/wiki/<wiki-name>.sqlite` (sqlite-vec extension). `<project>` is resolved from the nearest `package.json#name` walking up from the vault root (legacy `~/.rig/cache/qmd/<wiki>.sqlite` migrates on first open). Machine-local cache, no need to gitignore inside the vault.
|
|
175
201
|
- `ingest` triggers incremental embed at the end — no need to manually call `index` in routine use.
|
|
176
202
|
- macOS-only in v1.
|
|
177
203
|
|