@veewo/claw 0.1.33 → 0.1.35
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 +44 -44
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,48 +1,48 @@
|
|
|
1
|
-
# @veewo/claw
|
|
2
|
-
|
|
1
|
+
# @veewo/claw
|
|
2
|
+
|
|
3
3
|
Publishable `claw` CLI for `.claw` project startup recovery, planning, search, truth ingestion, and completion refresh.
|
|
4
|
-
|
|
5
|
-
Install:
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install -g @veewo/claw
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
After installing the CLI, semantic search still needs one-time setup inside each `.claw` project:
|
|
12
|
-
|
|
13
|
-
1. Run `claw context` so `.claw/project.json` is normalized and the default local embedding config is present.
|
|
14
|
-
2. Run `claw search index --refresh` once so the local embedding model can be downloaded or reused and the first vector index can be built.
|
|
15
|
-
|
|
16
|
-
Then run:
|
|
17
|
-
|
|
18
|
-
```bash
|
|
19
|
-
claw init
|
|
20
|
-
claw search index --refresh
|
|
21
|
-
claw search "existing truth or ADR topic"
|
|
22
|
-
claw plan write --title "My task" --goal "Define the first task"
|
|
23
|
-
```
|
|
24
|
-
|
|
4
|
+
|
|
5
|
+
Install:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @veewo/claw
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
After installing the CLI, semantic search still needs one-time setup inside each `.claw` project:
|
|
12
|
+
|
|
13
|
+
1. Run `claw context` so `.claw/project.json` is normalized and the default local embedding config is present.
|
|
14
|
+
2. Run `claw search index --refresh` once so the local embedding model can be downloaded or reused and the first vector index can be built.
|
|
15
|
+
|
|
16
|
+
Then run:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
claw init
|
|
20
|
+
claw search index --refresh
|
|
21
|
+
claw search "existing truth or ADR topic"
|
|
22
|
+
claw plan write --title "My task" --goal "Define the first task"
|
|
23
|
+
```
|
|
24
|
+
|
|
25
25
|
Codex startup workflow should rely on the session hook/startup recovery path instead of treating any extra manual recovery step as required after plan creation.
|
|
26
|
-
|
|
27
|
-
`claw search` is project-scoped recall for project docs: `.claw` memory, truth, ADR, and declared markdown external docs. Call it before plan creation and before research-style investigation. It is meant to absorb a natural-language prompt or keyword query against project documentation, recover prior truth and ADR context, and narrow the space before later code-location work. It is not a code-search command.
|
|
28
|
-
|
|
29
|
-
Configured `memory.externalDocPaths` only contribute `.md` files to this recall surface.
|
|
30
|
-
|
|
31
|
-
Recommended first-time search setup from a project root:
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
claw context
|
|
35
|
-
claw search index --refresh
|
|
36
|
-
```
|
|
37
|
-
|
|
26
|
+
|
|
27
|
+
`claw search` is project-scoped recall for project docs: `.claw` memory, truth, ADR, and declared markdown external docs. Call it before plan creation and before research-style investigation. It is meant to absorb a natural-language prompt or keyword query against project documentation, recover prior truth and ADR context, and narrow the space before later code-location work. It is not a code-search command.
|
|
28
|
+
|
|
29
|
+
Configured `memory.externalDocPaths` only contribute `.md` files to this recall surface.
|
|
30
|
+
|
|
31
|
+
Recommended first-time search setup from a project root:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
claw context
|
|
35
|
+
claw search index --refresh
|
|
36
|
+
```
|
|
37
|
+
|
|
38
38
|
That first refresh creates the project-local sqlite recall store at `.claw/memory.sqlite`, resolves the local embedding cache, and writes the first vector index for searchable markdown docs. By default claw uses a platform-global model cache directory (`%LOCALAPPDATA%\\claw\\models` on Windows, `~/Library/Caches/claw/models` on macOS, and `$XDG_CACHE_HOME/claw/models` or `~/.cache/claw/models` on Linux). Project-local `.claw/models` remains available as a fallback cache location instead of the default primary cache.
|
|
39
|
-
|
|
40
|
-
`claw search index --refresh` incrementally syncs the current project's markdown recall index. Unchanged docs reuse existing sqlite rows and embeddings, changed docs are re-embedded, deleted docs are removed, and embedding config changes trigger a full vector refresh. On large projects, the refresh now defaults to processing at most 100 newly added or changed files per run so the backlog can advance across multiple refreshes.
|
|
41
|
-
|
|
39
|
+
|
|
40
|
+
`claw search index --refresh` incrementally syncs the current project's markdown recall index. Unchanged docs reuse existing sqlite rows and embeddings, changed docs are re-embedded, deleted docs are removed, and embedding config changes trigger a full vector refresh. On large projects, the refresh now defaults to processing at most 100 newly added or changed files per run so the backlog can advance across multiple refreshes.
|
|
41
|
+
|
|
42
42
|
`claw search index --refresh` supports local semantic indexing with a GitNexus-style transformers backend when `.claw/project.json` sets `memory.embedding.provider` to `local`. Local embedding execution now batches inference inside a single worker/model session by default, and you can still force CPU rescue refreshes with `memory.embedding.local.device = cpu` or `CLAW_EMBEDDING_LOCAL_DEVICE=cpu`. If you explicitly set `memory.embedding.local.modelCacheDir`, claw first checks that local cache for the target model, then reuses the global cache when it already has the model, and only downloads into the configured local cache when neither location has it. Without an explicit local cache dir, claw downloads into the platform-global cache by default.
|
|
43
|
-
|
|
44
|
-
`claw search ...` accepts either `claw search "topic"` or `claw search --query "topic"`, and expects that refreshed vector index to exist. If the project has no vector index yet, the command fails until you configure `memory.embedding` and run `claw search index --refresh`.
|
|
45
|
-
|
|
46
|
-
Repository:
|
|
47
|
-
|
|
48
|
-
- [claw-kit](https://github.com/chanyuenpang/claw-kit)
|
|
43
|
+
|
|
44
|
+
`claw search ...` accepts either `claw search "topic"` or `claw search --query "topic"`, and expects that refreshed vector index to exist. If the project has no vector index yet, the command fails until you configure `memory.embedding` and run `claw search index --refresh`.
|
|
45
|
+
|
|
46
|
+
Repository:
|
|
47
|
+
|
|
48
|
+
- [claw-kit](https://github.com/chanyuenpang/claw-kit)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veewo/claw",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.35",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Publishable claw CLI for .claw project startup recovery, planning, search, truth ingestion, and completion refresh.",
|
|
6
6
|
"homepage": "https://github.com/chanyuenpang/claw-kit",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"claw": "./dist/bin.js"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@veewo/claw-core": "0.1.
|
|
24
|
+
"@veewo/claw-core": "0.1.35"
|
|
25
25
|
},
|
|
26
26
|
"scripts": {
|
|
27
27
|
"build": "tsc -p tsconfig.json",
|