@iamdevlinph/codex-kit 1.0.9 → 1.0.10
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 +7 -3
- package/assets/TEMPLATE_AGENTS.md +28 -2
- package/bin/codex-kit.js +23 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -168,9 +168,13 @@ pnpm dlx @iamdevlinph/codex-kit@latest project sync
|
|
|
168
168
|
codex-kit project status
|
|
169
169
|
```
|
|
170
170
|
|
|
171
|
-
`project sync` never edits `AGENTS.md
|
|
172
|
-
only applicable reusable changes while preserving local
|
|
173
|
-
|
|
171
|
+
`project sync` never edits `AGENTS.md` or project skills. It prints a prompt
|
|
172
|
+
asking Codex to merge only applicable reusable changes while preserving local
|
|
173
|
+
adaptations. Reconciliation keeps always-on rules in `AGENTS.md` and may create
|
|
174
|
+
or update task-specific workflows under `.agents/skills` when the updated
|
|
175
|
+
template warrants them. Critical safety and authorization rules remain in
|
|
176
|
+
`AGENTS.md`, and speculative skills are avoided. After reviewing the semantic
|
|
177
|
+
merge and any skill changes, record the applied template hash:
|
|
174
178
|
|
|
175
179
|
```sh
|
|
176
180
|
codex-kit project mark-applied
|
|
@@ -13,6 +13,28 @@ the managed markers.
|
|
|
13
13
|
priorities, deferred requirements, product or implementation decisions, and
|
|
14
14
|
major completed milestones.
|
|
15
15
|
|
|
16
|
+
## Instructions And Skills
|
|
17
|
+
|
|
18
|
+
- Keep `AGENTS.md` focused on durable, always-applicable repository context:
|
|
19
|
+
architecture, conventions, commands, safety and authorization boundaries,
|
|
20
|
+
verification expectations, and concise pointers to specialized workflows.
|
|
21
|
+
- Use project skills under `.agents/skills/<skill-name>/SKILL.md` for repeatable,
|
|
22
|
+
task-specific workflows or detailed guidance needed only for matching tasks.
|
|
23
|
+
- In existing projects, review large task-specific procedures in `AGENTS.md`.
|
|
24
|
+
When a procedure is reusable and conditionally relevant, extract it into a
|
|
25
|
+
project skill and leave a concise routing rule in `AGENTS.md`.
|
|
26
|
+
- Preserve critical safety, authorization, destructive-operation, database, and
|
|
27
|
+
deployment restrictions in `AGENTS.md`, even when a skill contains the
|
|
28
|
+
detailed workflow.
|
|
29
|
+
- In new projects, begin with a concise `AGENTS.md`. Add a skill only after a
|
|
30
|
+
concrete repeatable workflow or specialized procedure is identified; do not
|
|
31
|
+
create speculative skills.
|
|
32
|
+
- Avoid duplicating detailed instructions between `AGENTS.md` and `SKILL.md`.
|
|
33
|
+
Keep the always-on rule in `AGENTS.md` and the conditional procedure in the
|
|
34
|
+
skill.
|
|
35
|
+
- Each project skill must use valid YAML frontmatter with a clear `name` and a
|
|
36
|
+
`description` that states when the skill should trigger.
|
|
37
|
+
|
|
16
38
|
## Template Maintenance
|
|
17
39
|
|
|
18
40
|
- Projects normally use `AGENTS.md` as the active instruction file. The source
|
|
@@ -52,8 +74,12 @@ contents of TEMPLATE_AGENTS.md between
|
|
|
52
74
|
<!-- END codex-kit:shared-template -->. Preserve every repository-specific
|
|
53
75
|
instruction from the current AGENTS.md after the managed block under
|
|
54
76
|
# Project-Specific Instructions, remove only duplicate shared rules, and do not
|
|
55
|
-
change project behavior.
|
|
56
|
-
|
|
77
|
+
change project behavior. Review existing project skills under .agents/skills and
|
|
78
|
+
move conditionally relevant, repeatable procedures out of AGENTS.md only when a
|
|
79
|
+
skill is warranted. Preserve critical safety and authorization rules in
|
|
80
|
+
AGENTS.md, preserve existing relevant skills, avoid speculative skills, and
|
|
81
|
+
validate any skill you create or modify. Afterward, summarize what was preserved,
|
|
82
|
+
what moved into a skill, and whether any local rules appear template-worthy.
|
|
57
83
|
```
|
|
58
84
|
|
|
59
85
|
## Core Behavior
|
package/bin/codex-kit.js
CHANGED
|
@@ -266,7 +266,29 @@ function saveProjectState(cwd, state) {
|
|
|
266
266
|
write(join(cwd, PROJECT_STATE_FILE), `${JSON.stringify(state, null, 2)}\n`);
|
|
267
267
|
}
|
|
268
268
|
function templatePrompt() {
|
|
269
|
-
return `Template reference updated. Ask Codex
|
|
269
|
+
return `Template reference updated. Ask Codex:
|
|
270
|
+
|
|
271
|
+
The project's TEMPLATE_AGENTS.md was refreshed from codex-kit. Compare it with
|
|
272
|
+
AGENTS.md and merge only new or changed reusable guidelines that apply to this
|
|
273
|
+
repository.
|
|
274
|
+
|
|
275
|
+
Keep durable, always-applicable repository rules in AGENTS.md. When the updated
|
|
276
|
+
template identifies a repeatable, task-specific procedure, inspect existing
|
|
277
|
+
project skills under .agents/skills and create or update a skill only when it
|
|
278
|
+
would reduce conditional detail in AGENTS.md. Preserve existing relevant skills
|
|
279
|
+
and avoid duplicating detailed instructions between AGENTS.md and SKILL.md.
|
|
280
|
+
|
|
281
|
+
Keep critical safety, authorization, database, deployment, and destructive-
|
|
282
|
+
operation restrictions in AGENTS.md even when a skill contains the detailed
|
|
283
|
+
workflow. Do not create speculative skills.
|
|
284
|
+
|
|
285
|
+
Preserve project-specific instructions and existing adaptations. Do not replace
|
|
286
|
+
AGENTS.md wholesale. If a template rule conflicts with a local rule, keep the
|
|
287
|
+
local rule and report the conflict.
|
|
288
|
+
|
|
289
|
+
Summarize what was added, updated, skipped, adapted, or moved into a skill, and
|
|
290
|
+
why. Validate any created or modified skills. When finished, run codex-kit
|
|
291
|
+
project mark-applied.`;
|
|
270
292
|
}
|
|
271
293
|
function managedBlock(content, begin, end) {
|
|
272
294
|
return `${begin}\n${content.trimEnd()}\n${end}`;
|