@veewo/claw 0.1.49 → 0.1.50
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 +79 -79
- package/package.json +41 -41
package/README.md
CHANGED
|
@@ -1,79 +1,79 @@
|
|
|
1
|
-
# @veewo/claw
|
|
2
|
-
|
|
3
|
-
`@veewo/claw` is the CLI entrypoint for running the `.claw` workflow in a project.
|
|
4
|
-
|
|
5
|
-
It gives agents and developers a concrete way to plan work, recall project knowledge, deposit truth and ADR notes, and close rounds out cleanly instead of leaving project state scattered across transient chats.
|
|
6
|
-
|
|
7
|
-
## What the CLI is for
|
|
8
|
-
|
|
9
|
-
- initialize and normalize the `.claw` project surface
|
|
10
|
-
- run project-scoped planning and task lifecycle commands
|
|
11
|
-
- index and query project documentation recall
|
|
12
|
-
- support truth ingestion and closeout flows
|
|
13
|
-
|
|
14
|
-
## Install
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
npm install -g @veewo/claw
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
After installing the CLI, project search still needs one-time setup inside each `.claw` project:
|
|
21
|
-
|
|
22
|
-
1. Run `claw context` so `.claw/project.json` is normalized and the default local embedding config is present.
|
|
23
|
-
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.
|
|
24
|
-
|
|
25
|
-
Then run:
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
claw init
|
|
29
|
-
claw search index --refresh
|
|
30
|
-
claw search "existing truth or ADR topic"
|
|
31
|
-
claw plan create --title "My task" --goal "Define the first task"
|
|
32
|
-
claw plan create "My templated task" --template default --goal "Route through the default template"
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
`claw plan create` defaults to the `default` seed template. You can also select a template explicitly with `claw plan create "<title>" --template <name>` or `claw plan create --template <name> --title "<title>"`.
|
|
36
|
-
|
|
37
|
-
When `.claw/project.json` has `planning: true`, the default `default` template seeds `process.discussing` with:
|
|
38
|
-
|
|
39
|
-
1. a planning task that refines the request and appends executable tasks
|
|
40
|
-
2. an activation task that bridges into `process.active`
|
|
41
|
-
|
|
42
|
-
When `planning: false`, `claw plan create` seeds the smallest executable plan directly in `process.active`.
|
|
43
|
-
|
|
44
|
-
## Workflow shape
|
|
45
|
-
|
|
46
|
-
In a typical round, the CLI helps land this loop in a project:
|
|
47
|
-
|
|
48
|
-
`plan` -> `search and recall` -> `execute` -> `deposit truth / ADR` -> `close out`
|
|
49
|
-
|
|
50
|
-
That project-level plan structure helps agents carry longer-running work more cleanly than leaving the task in loose chat state alone.
|
|
51
|
-
|
|
52
|
-
Codex startup workflow should rely on the session hook or startup recovery path instead of treating any extra manual recovery step as required after plan creation.
|
|
53
|
-
|
|
54
|
-
## Search and recall
|
|
55
|
-
|
|
56
|
-
`claw search` is the project recall command for `.claw` memory, truth, ADR, and declared markdown docs. Use it for retained project context rather than code search.
|
|
57
|
-
|
|
58
|
-
When a task needs deeper code investigation or relationship tracing, GitNexus can complement this workflow, but it is optional rather than required for using `claw` itself.
|
|
59
|
-
|
|
60
|
-
Typical setup:
|
|
61
|
-
|
|
62
|
-
```bash
|
|
63
|
-
claw context
|
|
64
|
-
claw search index --refresh
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
If you need deeper backup detail on config or recall behavior, use the adapter reference notes in [packages/codex-adapter/references/project-config-reference.md](../codex-adapter/references/project-config-reference.md) or [packages/opencode-adapter/references/project-config-reference.md](../opencode-adapter/references/project-config-reference.md).
|
|
68
|
-
|
|
69
|
-
## Configuration
|
|
70
|
-
|
|
71
|
-
If you need backup `.claw/project.json` detail, start with the adapter reference notes above and use [docs/project-json-reference.md](../../docs/project-json-reference.md) only for deeper canonical detail.
|
|
72
|
-
|
|
73
|
-
`claw-kit` also stays usable alongside other harnesses or external skills, so the CLI does not assume a single host or investigation surface.
|
|
74
|
-
|
|
75
|
-
The config model is team-friendly as well: `.claw/project.json` carries the shared canonical workflow, while `.claw/project-override.json` leaves room for personal runtime preferences.
|
|
76
|
-
|
|
77
|
-
## Repository
|
|
78
|
-
|
|
79
|
-
- [claw-kit](https://github.com/chanyuenpang/claw-kit)
|
|
1
|
+
# @veewo/claw
|
|
2
|
+
|
|
3
|
+
`@veewo/claw` is the CLI entrypoint for running the `.claw` workflow in a project.
|
|
4
|
+
|
|
5
|
+
It gives agents and developers a concrete way to plan work, recall project knowledge, deposit truth and ADR notes, and close rounds out cleanly instead of leaving project state scattered across transient chats.
|
|
6
|
+
|
|
7
|
+
## What the CLI is for
|
|
8
|
+
|
|
9
|
+
- initialize and normalize the `.claw` project surface
|
|
10
|
+
- run project-scoped planning and task lifecycle commands
|
|
11
|
+
- index and query project documentation recall
|
|
12
|
+
- support truth ingestion and closeout flows
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install -g @veewo/claw
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
After installing the CLI, project search still needs one-time setup inside each `.claw` project:
|
|
21
|
+
|
|
22
|
+
1. Run `claw context` so `.claw/project.json` is normalized and the default local embedding config is present.
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
Then run:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
claw init
|
|
29
|
+
claw search index --refresh
|
|
30
|
+
claw search "existing truth or ADR topic"
|
|
31
|
+
claw plan create --title "My task" --goal "Define the first task"
|
|
32
|
+
claw plan create "My templated task" --template default --goal "Route through the default template"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`claw plan create` defaults to the `default` seed template. You can also select a template explicitly with `claw plan create "<title>" --template <name>` or `claw plan create --template <name> --title "<title>"`.
|
|
36
|
+
|
|
37
|
+
When `.claw/project.json` has `planning: true`, the default `default` template seeds `process.discussing` with:
|
|
38
|
+
|
|
39
|
+
1. a planning task that refines the request and appends executable tasks
|
|
40
|
+
2. an activation task that bridges into `process.active`
|
|
41
|
+
|
|
42
|
+
When `planning: false`, `claw plan create` seeds the smallest executable plan directly in `process.active`.
|
|
43
|
+
|
|
44
|
+
## Workflow shape
|
|
45
|
+
|
|
46
|
+
In a typical round, the CLI helps land this loop in a project:
|
|
47
|
+
|
|
48
|
+
`plan` -> `search and recall` -> `execute` -> `deposit truth / ADR` -> `close out`
|
|
49
|
+
|
|
50
|
+
That project-level plan structure helps agents carry longer-running work more cleanly than leaving the task in loose chat state alone.
|
|
51
|
+
|
|
52
|
+
Codex startup workflow should rely on the session hook or startup recovery path instead of treating any extra manual recovery step as required after plan creation.
|
|
53
|
+
|
|
54
|
+
## Search and recall
|
|
55
|
+
|
|
56
|
+
`claw search` is the project recall command for `.claw` memory, truth, ADR, and declared markdown docs. Use it for retained project context rather than code search.
|
|
57
|
+
|
|
58
|
+
When a task needs deeper code investigation or relationship tracing, GitNexus can complement this workflow, but it is optional rather than required for using `claw` itself.
|
|
59
|
+
|
|
60
|
+
Typical setup:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
claw context
|
|
64
|
+
claw search index --refresh
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
If you need deeper backup detail on config or recall behavior, use the adapter reference notes in [packages/codex-adapter/references/project-config-reference.md](../codex-adapter/references/project-config-reference.md) or [packages/opencode-adapter/references/project-config-reference.md](../opencode-adapter/references/project-config-reference.md).
|
|
68
|
+
|
|
69
|
+
## Configuration
|
|
70
|
+
|
|
71
|
+
If you need backup `.claw/project.json` detail, start with the adapter reference notes above and use [docs/project-json-reference.md](../../docs/project-json-reference.md) only for deeper canonical detail.
|
|
72
|
+
|
|
73
|
+
`claw-kit` also stays usable alongside other harnesses or external skills, so the CLI does not assume a single host or investigation surface.
|
|
74
|
+
|
|
75
|
+
The config model is team-friendly as well: `.claw/project.json` carries the shared canonical workflow, while `.claw/project-override.json` leaves room for personal runtime preferences.
|
|
76
|
+
|
|
77
|
+
## Repository
|
|
78
|
+
|
|
79
|
+
- [claw-kit](https://github.com/chanyuenpang/claw-kit)
|
package/package.json
CHANGED
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@veewo/claw",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"type": "module",
|
|
5
|
-
"description": "CLI for running the .claw workflow: project planning, recall, truth ingestion, and closeout.",
|
|
6
|
-
"keywords": [
|
|
7
|
-
"claw",
|
|
8
|
-
".claw",
|
|
9
|
-
"agent-workflow",
|
|
10
|
-
"knowledge-capture",
|
|
11
|
-
"project-memory",
|
|
12
|
-
"truth",
|
|
13
|
-
"adr",
|
|
14
|
-
"cli"
|
|
15
|
-
],
|
|
16
|
-
"homepage": "https://github.com/chanyuenpang/claw-kit",
|
|
17
|
-
"repository": {
|
|
18
|
-
"type": "git",
|
|
19
|
-
"url": "https://github.com/chanyuenpang/claw-kit.git",
|
|
20
|
-
"directory": "packages/cli"
|
|
21
|
-
},
|
|
22
|
-
"license": "MIT",
|
|
23
|
-
"publishConfig": {
|
|
24
|
-
"access": "public"
|
|
25
|
-
},
|
|
26
|
-
"files": [
|
|
27
|
-
"dist",
|
|
28
|
-
"README.md"
|
|
29
|
-
],
|
|
30
|
-
"bin": {
|
|
31
|
-
"claw": "./dist/bin.js"
|
|
32
|
-
},
|
|
33
|
-
"dependencies": {
|
|
34
|
-
"@veewo/claw-core": "0.1.
|
|
35
|
-
},
|
|
36
|
-
"scripts": {
|
|
37
|
-
"build": "tsc -p tsconfig.json",
|
|
38
|
-
"check": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json --noEmit",
|
|
39
|
-
"test": "tsc -p tsconfig.test.json && node --test dist-test/**/*.test.js"
|
|
40
|
-
}
|
|
41
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@veewo/claw",
|
|
3
|
+
"version": "0.1.50",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "CLI for running the .claw workflow: project planning, recall, truth ingestion, and closeout.",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"claw",
|
|
8
|
+
".claw",
|
|
9
|
+
"agent-workflow",
|
|
10
|
+
"knowledge-capture",
|
|
11
|
+
"project-memory",
|
|
12
|
+
"truth",
|
|
13
|
+
"adr",
|
|
14
|
+
"cli"
|
|
15
|
+
],
|
|
16
|
+
"homepage": "https://github.com/chanyuenpang/claw-kit",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "https://github.com/chanyuenpang/claw-kit.git",
|
|
20
|
+
"directory": "packages/cli"
|
|
21
|
+
},
|
|
22
|
+
"license": "MIT",
|
|
23
|
+
"publishConfig": {
|
|
24
|
+
"access": "public"
|
|
25
|
+
},
|
|
26
|
+
"files": [
|
|
27
|
+
"dist",
|
|
28
|
+
"README.md"
|
|
29
|
+
],
|
|
30
|
+
"bin": {
|
|
31
|
+
"claw": "./dist/bin.js"
|
|
32
|
+
},
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"@veewo/claw-core": "0.1.50"
|
|
35
|
+
},
|
|
36
|
+
"scripts": {
|
|
37
|
+
"build": "tsc -p tsconfig.json",
|
|
38
|
+
"check": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json --noEmit",
|
|
39
|
+
"test": "tsc -p tsconfig.test.json && node --test dist-test/**/*.test.js"
|
|
40
|
+
}
|
|
41
|
+
}
|