@dotdotgod/codex 0.1.16 → 0.1.18
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 +34 -12
- package/package.json +21 -8
- package/skills/doc-first-planning/SKILL.md +1 -0
- package/skills/project-load/SKILL.md +1 -0
package/README.md
CHANGED
|
@@ -1,19 +1,39 @@
|
|
|
1
1
|
# @dotdotgod/codex
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@dotdotgod/codex) [](https://github.com/dotdotgod/dotdotgod/tree/main/packages/codex) [](../../LICENSE)
|
|
4
|
+
|
|
3
5
|
> **Change a file, know what else must be checked.**
|
|
4
6
|
|
|
5
|
-
Codex adapter for dotdotgod's context curation workflow. It packages reusable skills that help Codex load
|
|
7
|
+
Codex adapter for dotdotgod's context curation workflow. It packages reusable skills that help Codex initialize shared agent docs, load bounded project memory, and plan from docs before implementation.
|
|
8
|
+
|
|
9
|
+
Impact/context in practice:
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
dd:init creates the memory scaffold
|
|
13
|
+
dd:load reads a bounded snapshot and relevant docs
|
|
14
|
+
dd:plan captures durable task intent before implementation
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The same project-memory graph that powers `dotdotgod graph impact` can surface likely related docs, tests, source, and config for changed files. The graph is not only traceability: it also uses Markdown links, README routes, headings, package metadata, memory-area membership, commands, tests, and deterministic routing hints.
|
|
6
18
|
|
|
7
19
|
## What Gets Better?
|
|
8
20
|
|
|
9
21
|
- Codex can start from `AGENTS.md` and the dotdotgod docs map.
|
|
10
22
|
- Load guidance prefers `dotdotgod load-snapshot <root> --json` when the CLI is available, then falls back to README-index reads.
|
|
11
23
|
- Codex can use docs structure as retrieval intent: specs for behavior, architecture for rationale, tests for verification, plans for current work, and archive indexes for past decisions.
|
|
12
|
-
- Product intent, design rationale, and verification standards stay in durable docs.
|
|
13
24
|
- Planning work captures current intent in `docs/plan/<task-slug>/README.md` before implementation.
|
|
14
25
|
- Completed plans and temporary reports use the same archive structure as Pi and Claude Code, turning outcomes into future context.
|
|
15
26
|
- `dd:load`, `dd:plan`, and `dd:init` can be used as command-like trigger phrases where direct slash commands are unavailable.
|
|
16
27
|
|
|
28
|
+
## Shared Memory and Traceability Model
|
|
29
|
+
|
|
30
|
+
By default, `docs/spec/**` has two roles: it is stable shared/fresh project memory, and it is the traceability-enforced behavior-spec path. These concepts are independent:
|
|
31
|
+
|
|
32
|
+
- `memory.areas` customizes memory classification, freshness, local/shared scope, priorities, and archive-body inclusion.
|
|
33
|
+
- `traceability.required` / `traceability.exclude` customizes which markdown paths must end with `json dotdotgod` blocks.
|
|
34
|
+
|
|
35
|
+
`docs/archive/README.md` is the history map. Archive bodies remain targeted historical memory and should not be read broadly by default.
|
|
36
|
+
|
|
17
37
|
## Included
|
|
18
38
|
|
|
19
39
|
- Codex plugin manifest: `.codex-plugin/plugin.json`
|
|
@@ -30,6 +50,15 @@ Codex can run lifecycle hooks from trusted Codex configuration layers. dotdotgod
|
|
|
30
50
|
|
|
31
51
|
Use hooks only when you want opt-in reminders or validation around the same workflow. See [`hooks/README.md`](hooks/README.md) for advisory examples and stricter plan-safety patterns.
|
|
32
52
|
|
|
53
|
+
## Shared Contract
|
|
54
|
+
|
|
55
|
+
- `AGENTS.md` remains canonical.
|
|
56
|
+
- `CODEX.md` stays thin and points to `AGENTS.md`.
|
|
57
|
+
- Active plans use `docs/plan/<task-slug>/README.md`.
|
|
58
|
+
- Completed plans move to `docs/archive/plan/<task-slug>/`.
|
|
59
|
+
- Temporary reports move to `docs/archive/report/<report-slug>/`.
|
|
60
|
+
- `docs/archive/README.md` is the archive map; archive bodies should be read only when targeted.
|
|
61
|
+
|
|
33
62
|
## Local Development
|
|
34
63
|
|
|
35
64
|
Run package checks:
|
|
@@ -39,17 +68,10 @@ pnpm --filter @dotdotgod/codex run verify
|
|
|
39
68
|
pnpm --filter @dotdotgod/codex run pack:dry-run
|
|
40
69
|
```
|
|
41
70
|
|
|
42
|
-
##
|
|
71
|
+
## Learn More
|
|
43
72
|
|
|
44
|
-
|
|
45
|
-
- `CODEX.md` stays thin and points to `AGENTS.md`.
|
|
46
|
-
- Active plans use `docs/plan/<task-slug>/README.md`.
|
|
47
|
-
- Completed plans move to `docs/archive/plan/<task-slug>/`.
|
|
48
|
-
- Temporary reports move to `docs/archive/report/<report-slug>/`.
|
|
49
|
-
- `docs/archive/README.md` is the archive map; archive bodies should be read only when targeted.
|
|
73
|
+
See the [root README](../../README.md), [GitHub repository](https://github.com/dotdotgod/dotdotgod), [`docs/concept/CONTEXT_CURATION.md`](../../docs/concept/CONTEXT_CURATION.md), [`docs/concept/CONTEXT_MECHANICS.md`](../../docs/concept/CONTEXT_MECHANICS.md), [`docs/spec/MEMORY_AREA_CONFIG.md`](../../docs/spec/MEMORY_AREA_CONFIG.md), and [`docs/spec/TRACEABILITY_CONFIG.md`](../../docs/spec/TRACEABILITY_CONFIG.md).
|
|
50
74
|
|
|
51
75
|
## Compared with Graphify-Style Memory
|
|
52
76
|
|
|
53
|
-
This adapter packages reusable workflow skills. It guides Codex to prefer a bounded dotdotgod load snapshot when available, avoid broad archive scans, and follow README indexes before reading raw files.
|
|
54
|
-
|
|
55
|
-
The strength is structured retrieval: project docs declare which files are rules, specs, architecture, verification, active intent, or historical memory. That keeps the memory layer portable across Codex runtimes and useful on small tasks where a large graph report would be overhead.
|
|
77
|
+
This adapter packages reusable workflow skills. It guides Codex to prefer a bounded dotdotgod load snapshot when available, avoid broad archive scans, and follow README indexes before reading raw files. The strength is structured retrieval from project-declared memory, not a giant graph report.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dotdotgod/codex",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.18",
|
|
4
4
|
"description": "Codex adapter for dotdotgod project memory workflows.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -8,14 +8,22 @@
|
|
|
8
8
|
"access": "public"
|
|
9
9
|
},
|
|
10
10
|
"keywords": [
|
|
11
|
-
"codex",
|
|
12
|
-
"dotdotgod",
|
|
13
11
|
"agent-memory",
|
|
12
|
+
"ai-coding-agent",
|
|
13
|
+
"codex",
|
|
14
|
+
"context-curation",
|
|
14
15
|
"documentation",
|
|
16
|
+
"dotdotgod",
|
|
17
|
+
"graph-impact",
|
|
18
|
+
"planning",
|
|
15
19
|
"plugin",
|
|
16
20
|
"project-memory",
|
|
17
|
-
"
|
|
21
|
+
"traceability"
|
|
18
22
|
],
|
|
23
|
+
"scripts": {
|
|
24
|
+
"verify": "node -e \"const fs=require('fs'); const req=['.codex-plugin/plugin.json','skills/project-load/SKILL.md','skills/doc-first-planning/SKILL.md','skills/project-initializer/SKILL.md','skills/project-initializer/scripts/init_project.sh','hooks/README.md']; JSON.parse(fs.readFileSync('.codex-plugin/plugin.json','utf8')); for (const f of req) { if (!fs.existsSync(f)) throw new Error('missing '+f); } console.log('codex adapter ok')\"",
|
|
25
|
+
"pack:dry-run": "pnpm pack --dry-run --json"
|
|
26
|
+
},
|
|
19
27
|
"files": [
|
|
20
28
|
".codex-plugin",
|
|
21
29
|
"skills",
|
|
@@ -23,8 +31,13 @@
|
|
|
23
31
|
"README.md",
|
|
24
32
|
"LICENSE"
|
|
25
33
|
],
|
|
26
|
-
"
|
|
27
|
-
|
|
28
|
-
"
|
|
34
|
+
"homepage": "https://github.com/dotdotgod/dotdotgod/tree/main/packages/codex#readme",
|
|
35
|
+
"repository": {
|
|
36
|
+
"type": "git",
|
|
37
|
+
"url": "git+https://github.com/dotdotgod/dotdotgod.git",
|
|
38
|
+
"directory": "packages/codex"
|
|
39
|
+
},
|
|
40
|
+
"bugs": {
|
|
41
|
+
"url": "https://github.com/dotdotgod/dotdotgod/issues"
|
|
29
42
|
}
|
|
30
|
-
}
|
|
43
|
+
}
|
|
@@ -31,6 +31,7 @@ Prefer live repository docs in this order:
|
|
|
31
31
|
- If the session is long or noisy, suggest a user-initiated planning-focused compaction before writing or revising the plan; do not compact automatically because compaction is lossy.
|
|
32
32
|
2. Gather evidence before planning.
|
|
33
33
|
- When the request contains explicit project-memory refs such as `[[PLAN_MODE]]`, run `dotdotgod expand <root> "<request>" --json` before broad `grep` or `find` scans, then read the resolved candidates selectively.
|
|
34
|
+
- When the request uses high-signal natural refs such as `PLAN_MODE`, `docs/spec/PLAN_MODE.md`, or quoted doc names, run `dotdotgod expand <root> "<request>" --fuzzy --json`; skip fuzzy expansion for generic low-signal words alone and respect configured fuzzy low-signal add/remove terms.
|
|
34
35
|
- Search docs by domain terms from the user request.
|
|
35
36
|
- Read nearest README indexes and relevant focused docs.
|
|
36
37
|
- For behavior changes, prefer specs with CLI-enforced fenced `json dotdotgod` traceability blocks in the final section; use their source, test, related-doc, and verification-command mappings before editing code.
|
|
@@ -18,6 +18,7 @@ Do not modify files during the load pass unless the user explicitly asks for edi
|
|
|
18
18
|
- Mention user changes and avoid reverting or cleaning them.
|
|
19
19
|
2. Prefer the bounded CLI snapshot when available.
|
|
20
20
|
- If the user prompt contains explicit project-memory refs such as `[[PLAN_MODE]]`, run `dotdotgod expand <root> "<prompt>" --json` before broad `grep` or `find` scans, then read the resolved candidates selectively.
|
|
21
|
+
- If the prompt has high-signal natural refs such as `PLAN_MODE`, `docs/spec/PLAN_MODE.md`, or quoted doc names, use `dotdotgod expand <root> "<prompt>" --fuzzy --json` before broad scans; avoid fuzzy expansion for low-signal generic words alone and respect configured fuzzy low-signal add/remove terms.
|
|
21
22
|
- If `dotdotgod` is installed or available in the repository, run `dotdotgod load-snapshot <root> --json`.
|
|
22
23
|
- If the local environment allows package execution but no `dotdotgod` binary is available, optionally run `npx @dotdotgod/cli load-snapshot <root> --json`.
|
|
23
24
|
- Treat the snapshot as the first-pass project-memory map for cache status, graph size, memory areas, related communities, and archive inclusion policy.
|