@iamdevlinph/codex-kit 1.1.6 → 1.1.7
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 +15 -4
- package/assets/TEMPLATE_AGENTS.md +12 -0
- package/assets/skills/codex-kit-reconcile-agents/SKILL.md +19 -11
- package/bin/codex-kit.js +15 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -119,6 +119,13 @@ configuration, and scripts for Codex to derive reliable guidance. It creates:
|
|
|
119
119
|
- `TEMPLATE_AGENTS.md` as the local template reference;
|
|
120
120
|
- `.codex-kit-state.json` for reconciliation bookkeeping.
|
|
121
121
|
|
|
122
|
+
The CLI continues to create only this scaffold, template reference, and state
|
|
123
|
+
file set. During semantic reconciliation, Codex may create or maintain
|
|
124
|
+
`PLANS.md` when repository evidence supports real durable decisions,
|
|
125
|
+
roadmap/status, or resume-worthy completed milestones. Existing `PLANS.md`
|
|
126
|
+
content is preserved and semantically merged; speculative history is never
|
|
127
|
+
invented or backfilled.
|
|
128
|
+
|
|
122
129
|
Initialization includes the first template sync. When the CLI prints an
|
|
123
130
|
initialization or reconciliation prompt, copy the complete marked block into a
|
|
124
131
|
Codex task opened at the project root.
|
|
@@ -129,11 +136,15 @@ After installing a newer package version, refresh the reference template:
|
|
|
129
136
|
codex-kit project sync
|
|
130
137
|
```
|
|
131
138
|
|
|
132
|
-
`project sync` never edits `AGENTS.md` or project skills. The
|
|
133
|
-
compares the refreshed template with the project's
|
|
134
|
-
applicable rules while preserving local organization
|
|
139
|
+
`project sync` never edits `AGENTS.md`, `PLANS.md`, or project skills. The
|
|
140
|
+
reconciliation skill compares the refreshed template with the project's
|
|
141
|
+
guidance and merges only applicable rules while preserving local organization
|
|
142
|
+
and adaptations. It keeps always-on instructions in `AGENTS.md`, moves durable
|
|
143
|
+
roadmap or history out of that file into `PLANS.md`, and reports any created or
|
|
144
|
+
changed plan content. If
|
|
135
145
|
`TEMPLATE_AGENTS.md` was modified locally, sync overwrites it with the packaged
|
|
136
|
-
template. Keep
|
|
146
|
+
template. Keep always-on local rules in `AGENTS.md` and durable product context
|
|
147
|
+
in `PLANS.md`; recover overwritten template
|
|
137
148
|
edits through Git history when needed.
|
|
138
149
|
|
|
139
150
|
After reconciliation and validation, Codex runs:
|
|
@@ -12,6 +12,18 @@ product context, and local conventions in the project's active `AGENTS.md`.
|
|
|
12
12
|
priorities, deferred requirements, product or implementation decisions, and
|
|
13
13
|
major completed milestones.
|
|
14
14
|
|
|
15
|
+
## PLANS.md Maintenance
|
|
16
|
+
|
|
17
|
+
- Read and preserve an existing `PLANS.md` during initialization and template
|
|
18
|
+
reconciliation; semantically merge durable content instead of replacing it.
|
|
19
|
+
- Create `PLANS.md` only when repository evidence contains real roadmap items,
|
|
20
|
+
durable decisions, or resume-worthy completed work. Never invent or backfill
|
|
21
|
+
speculative history.
|
|
22
|
+
- Keep it concise, using sections such as current context, decisions,
|
|
23
|
+
roadmap/status, and major milestones. It is not a per-change changelog.
|
|
24
|
+
- Move roadmap or history misplaced in `AGENTS.md` into `PLANS.md` when the
|
|
25
|
+
content is durable, and keep `AGENTS.md` focused on always-on instructions.
|
|
26
|
+
|
|
15
27
|
## Instructions And Skills
|
|
16
28
|
|
|
17
29
|
- Keep `AGENTS.md` focused on durable, always-applicable repository context:
|
|
@@ -7,24 +7,32 @@ description: Reconcile a refreshed TEMPLATE_AGENTS.md with a project's AGENTS.md
|
|
|
7
7
|
|
|
8
8
|
## Procedure
|
|
9
9
|
|
|
10
|
-
1. Inspect `AGENTS.md`, `
|
|
11
|
-
project's existing `.agents/skills`, and
|
|
12
|
-
the initial status before making changes.
|
|
13
|
-
2. Preserve the existing `AGENTS.md` organization and all
|
|
14
|
-
adaptations. Merge only reusable template guidance that
|
|
15
|
-
repository; report conflicts between local and template
|
|
16
|
-
replace `AGENTS.md` wholesale or copy the complete
|
|
10
|
+
1. Inspect `AGENTS.md`, any existing `PLANS.md`, `TEMPLATE_AGENTS.md`,
|
|
11
|
+
`.codex-kit-state.json`, the project's existing `.agents/skills`, and
|
|
12
|
+
`codex-kit project status`. Record the initial status before making changes.
|
|
13
|
+
2. Preserve the existing `AGENTS.md` and `PLANS.md` organization and all
|
|
14
|
+
project-specific adaptations. Merge only reusable template guidance that
|
|
15
|
+
applies to this repository; report conflicts between local and template
|
|
16
|
+
rules, and do not replace `AGENTS.md` wholesale or copy the complete
|
|
17
|
+
template into it.
|
|
17
18
|
3. Keep critical always-on safety, authorization, secrets, database,
|
|
18
19
|
deployment, and destructive-operation rules in `AGENTS.md`.
|
|
19
|
-
4.
|
|
20
|
+
4. Preserve an existing `PLANS.md` and semantically merge durable product
|
|
21
|
+
context, decisions, roadmap/status, and resume-worthy milestones. Create it
|
|
22
|
+
only when repository evidence contains real durable content; never invent or
|
|
23
|
+
backfill speculative history. Move durable roadmap or history misplaced in
|
|
24
|
+
`AGENTS.md` into `PLANS.md`, keeping it concise rather than turning it into a
|
|
25
|
+
per-change changelog. Report whether `PLANS.md` was preserved, created, or
|
|
26
|
+
updated and why.
|
|
27
|
+
5. Extract only concrete, conditional, repeatable project procedures into a
|
|
20
28
|
focused skill under `.agents/skills/<skill-name>/SKILL.md`. Preserve relevant
|
|
21
29
|
existing skills, use valid YAML frontmatter, and do not create speculative
|
|
22
30
|
skills or duplicate detailed instructions.
|
|
23
|
-
|
|
31
|
+
6. Review the final instruction diff for preserved local rules, duplicates, and
|
|
24
32
|
unintended template edits. Validate every created or modified project skill
|
|
25
33
|
with an available skill validator and run the repository's documented checks.
|
|
26
34
|
Do not mark the template applied until reconciliation and validation succeed.
|
|
27
|
-
|
|
35
|
+
7. Never run `codex-kit project sync` on the user's behalf or recommend it for
|
|
28
36
|
an unreleased local template edit. The user should run `project sync` only
|
|
29
37
|
after updating codex-kit to a released version containing the template
|
|
30
38
|
change. Run `codex-kit project mark-applied` only when the task follows a
|
|
@@ -32,7 +40,7 @@ description: Reconcile a refreshed TEMPLATE_AGENTS.md with a project's AGENTS.md
|
|
|
32
40
|
recorded in step 1 was `reconciliation required`, and reconciliation and
|
|
33
41
|
validation succeeded. Otherwise leave project state unchanged and report the
|
|
34
42
|
remaining release, codex-kit update, user-run sync, and reconciliation steps.
|
|
35
|
-
|
|
43
|
+
8. Summarize added, updated, skipped, adapted, and skill-moved guidance, with
|
|
36
44
|
reasons. Identify genuinely reusable, generalized changes that should be
|
|
37
45
|
promoted to codex-kit's canonical template and report the target section and
|
|
38
46
|
wording.
|
package/bin/codex-kit.js
CHANGED
|
@@ -612,6 +612,11 @@ project-specific guidance to AGENTS.md based only on repository evidence,
|
|
|
612
612
|
including exact verification commands. Then use the global
|
|
613
613
|
$${RECONCILE_SKILL} skill to merge applicable reusable guidance from
|
|
614
614
|
TEMPLATE_AGENTS.md while preserving AGENTS.md organization and local rules.
|
|
615
|
+
Inspect and preserve any existing PLANS.md. Create or maintain a concise
|
|
616
|
+
PLANS.md only when repository evidence contains real roadmap items, durable
|
|
617
|
+
decisions, or resume-worthy completed work; never invent or backfill speculative
|
|
618
|
+
history. Keep always-on repository instructions in AGENTS.md, move misplaced
|
|
619
|
+
roadmap or history into PLANS.md, and report what PLANS.md work was done.
|
|
615
620
|
Validate the final instruction changes, mark the template applied only after
|
|
616
621
|
validation succeeds, and confirm codex-kit project status is up to date.
|
|
617
622
|
===== END CODEX INITIALIZATION PROMPT =====`;
|
|
@@ -623,12 +628,16 @@ function reconciliationPrompt() {
|
|
|
623
628
|
Use the global $${RECONCILE_SKILL} skill to reconcile the existing AGENTS.md
|
|
624
629
|
with the refreshed TEMPLATE_AGENTS.md.
|
|
625
630
|
|
|
626
|
-
Inspect TEMPLATE_AGENTS.md, AGENTS.md, .codex-kit-state.json,
|
|
627
|
-
.agents/skills, and codex-kit project status. Preserve local
|
|
628
|
-
AGENTS.md organization; merge only applicable reusable
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
631
|
+
Inspect TEMPLATE_AGENTS.md, AGENTS.md, PLANS.md, .codex-kit-state.json,
|
|
632
|
+
existing .agents/skills, and codex-kit project status. Preserve local
|
|
633
|
+
adaptations and AGENTS.md/PLANS.md organization; merge only applicable reusable
|
|
634
|
+
guidance. Preserve an existing PLANS.md, and create or update it only for
|
|
635
|
+
evidence-backed durable decisions, roadmap/status, or resume-worthy milestones.
|
|
636
|
+
Never invent or backfill speculative history. Move misplaced roadmap or history
|
|
637
|
+
out of AGENTS.md, keeping critical always-on safety and authorization rules in
|
|
638
|
+
AGENTS.md. The reconciliation must extract only concrete conditional procedures
|
|
639
|
+
into validated skills. Do not copy the complete template or introduce managed
|
|
640
|
+
markers. Report what PLANS.md content was preserved, created, or changed.
|
|
632
641
|
|
|
633
642
|
Validate the final instruction changes. Mark applied only after reconciliation
|
|
634
643
|
and validation succeed, confirm codex-kit project status is up to date, then
|