@dotdotgod/codex 0.1.14 → 0.1.15
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
CHANGED
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
# @dotdotgod/codex
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> **Change a file, know what else must be checked.**
|
|
4
|
+
|
|
5
|
+
Codex adapter for dotdotgod's context curation workflow. It packages reusable skills that help Codex load curated project memory, plan from docs before implementation, and initialize the shared agent documentation scaffold so changes start with the right specs, tests, plans, and archive map.
|
|
4
6
|
|
|
5
7
|
## What Gets Better?
|
|
6
8
|
|
|
7
|
-
- Codex can start from `AGENTS.md` and the dotdotgod docs map
|
|
9
|
+
- Codex can start from `AGENTS.md` and the dotdotgod docs map.
|
|
8
10
|
- Load guidance prefers `dotdotgod load-snapshot <root> --json` when the CLI is available, then falls back to README-index reads.
|
|
9
11
|
- 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.
|
|
10
|
-
- Product intent, design rationale, and verification standards stay in durable docs
|
|
12
|
+
- Product intent, design rationale, and verification standards stay in durable docs.
|
|
11
13
|
- Planning work captures current intent in `docs/plan/<task-slug>/README.md` before implementation.
|
|
12
14
|
- Completed plans and temporary reports use the same archive structure as Pi and Claude Code, turning outcomes into future context.
|
|
13
15
|
- `dd:load`, `dd:plan`, and `dd:init` can be used as command-like trigger phrases where direct slash commands are unavailable.
|
|
@@ -48,6 +50,6 @@ pnpm --filter @dotdotgod/codex run pack:dry-run
|
|
|
48
50
|
|
|
49
51
|
## Compared with Graphify-Style Memory
|
|
50
52
|
|
|
51
|
-
This adapter packages reusable workflow skills
|
|
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.
|
|
52
54
|
|
|
53
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.
|
package/hooks/README.md
CHANGED
|
@@ -13,11 +13,17 @@ Use hooks only when you want opt-in reminders, lightweight validation, or local
|
|
|
13
13
|
## Opt-In Levels
|
|
14
14
|
|
|
15
15
|
- `advisory`: print reminders or read-only status only.
|
|
16
|
-
- `validate`: run `dotdotgod validate` after docs work or at stop time.
|
|
16
|
+
- `validate`: run `dotdotgod validate . --include-local-memory --check-index` after docs work or at stop time.
|
|
17
17
|
- `strict-plan-safety`: add local blocking scripts only when a reliable plan-only state signal exists.
|
|
18
18
|
|
|
19
19
|
Start with advisory hooks. Do not enable blocking hooks until you have tested the hook payload, Codex trust state, and your local policy script.
|
|
20
20
|
|
|
21
|
+
## Review Before First Run
|
|
22
|
+
|
|
23
|
+
Codex may detect a configured hook but keep it disabled until you review it. If Codex shows `1 hook needs review before it can run. Open /hooks to review it.`, open `/hooks`, inspect the command, and approve only commands you trust.
|
|
24
|
+
|
|
25
|
+
After approval, trigger a small supported edit such as an `apply_patch` documentation comment change and confirm the hook status message or command output appears. If the hook was added while a Codex session was already running, restart Codex before the smoke test so the current configuration is loaded.
|
|
26
|
+
|
|
21
27
|
## Advisory `hooks.json` Example
|
|
22
28
|
|
|
23
29
|
This example reminds Codex to use dotdotgod intentionally at session start:
|
|
@@ -51,12 +57,12 @@ matcher = "Edit|Write|apply_patch"
|
|
|
51
57
|
|
|
52
58
|
[[hooks.PostToolUse.hooks]]
|
|
53
59
|
type = "command"
|
|
54
|
-
command = "
|
|
60
|
+
command = "dotdotgod validate . --include-local-memory --check-index"
|
|
55
61
|
timeout = 120
|
|
56
|
-
statusMessage = "Checking dotdotgod docs
|
|
62
|
+
statusMessage = "Checking dotdotgod docs and index freshness"
|
|
57
63
|
```
|
|
58
64
|
|
|
59
|
-
Use validation hooks only by explicit opt-in. They are useful for docs-heavy sessions but can be noisy if they run after every supported edit.
|
|
65
|
+
Use validation hooks only by explicit opt-in. They are useful for docs-heavy sessions but can be noisy if they run after every supported edit. `--check-index` compares current markdown fingerprints with `.dotdotgod/manifest.json` without refreshing the cache; if the only failure is an index freshness error, run `dotdotgod index .` or `pnpm run verify:cache` intentionally.
|
|
60
66
|
|
|
61
67
|
## Prompt Reminder Pattern
|
|
62
68
|
|
package/package.json
CHANGED
|
@@ -20,6 +20,6 @@ Put durable, project-wide instructions in `AGENTS.md`:
|
|
|
20
20
|
- coding and review expectations
|
|
21
21
|
- environment constraints
|
|
22
22
|
|
|
23
|
-
For projects using the dotdotgod CLI, `dotdotgod validate` is the enforcement point for machine-readable docs rules such as fenced `json dotdotgod` traceability blocks in behavior specs. Keep the detailed schema in the CLI and its validation errors
|
|
23
|
+
For projects using the dotdotgod CLI, `dotdotgod validate` is the enforcement point for machine-readable docs rules such as fenced `json dotdotgod` traceability blocks in behavior specs. Keep the detailed schema in the CLI and its validation errors.
|
|
24
24
|
|
|
25
25
|
Do not duplicate the same body in `CLAUDE.md` and `CODEX.md`; duplication causes drift.
|
|
@@ -34,7 +34,7 @@ Do not modify files during the load pass unless the user explicitly asks for edi
|
|
|
34
34
|
- `docs/plan/README.md`
|
|
35
35
|
- `docs/archive/README.md`
|
|
36
36
|
4. Start with `AGENTS.md`, `README.md`, and `docs/README.md` when they are not already clear from the CLI snapshot or loaded context.
|
|
37
|
-
5. Follow README indexes. Read relevant docs under `docs/spec`, `docs/test`, and `docs/arch` selectively
|
|
37
|
+
5. Follow README indexes. Read relevant docs under `docs/spec`, `docs/test`, and `docs/arch` selectively unless the task needs a full refresh.
|
|
38
38
|
6. List `docs/plan` entries first, then selectively read only relevant active plans.
|
|
39
39
|
7. Use `docs/archive/README.md` as the archive history map. Do not scan archive bodies by default; read targeted completed plans under `docs/archive/plan/` or reports under `docs/archive/report/` only when directly relevant.
|
|
40
40
|
8. Avoid broad reads of generated outputs, dependencies, databases, caches, secrets, and `.env*` contents.
|