codexkit 1.0.1 → 1.0.3
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/.codex/.template-manifest.json +32 -24
- package/.codex/.version +1 -1
- package/.codex/agents/builder.toml +6 -1
- package/.codex/agents/debugger.toml +1 -0
- package/.codex/agents/general.toml +6 -1
- package/.codex/agents/painter.toml +1 -0
- package/.codex/agents/planner.toml +1 -0
- package/.codex/agents/refactorer.toml +1 -0
- package/.codex/agents/reviewer.toml +1 -0
- package/.codex/agents/runner.toml +1 -0
- package/.codex/agents/scout.toml +1 -0
- package/.codex/agents/shipper.toml +1 -0
- package/.codex/agents/vision.toml +1 -0
- package/.codex/config.toml +8 -3
- package/.codex/mcp/README.md +19 -3
- package/.codex/mcp/context7.toml.example +25 -8
- package/.codex/mcp/exa.toml.example +8 -1
- package/.codex/prompts/create.md +63 -26
- package/.codex/prompts/init.md +24 -0
- package/.codex/prompts/ship.md +36 -25
- package/.codex/prompts/start.md +2 -2
- package/.codex/prompts/ui-slop-check.md +119 -0
- package/.codex/scripts/start_bead.sh +9 -5
- package/.codex/scripts/verify_bead.sh +18 -6
- package/.codex/skills/frontend-design/SKILL.md +137 -55
- package/.codex/skills/frontend-design/references/color-system.md +125 -0
- package/.codex/skills/frontend-design/references/interaction.md +115 -0
- package/.codex/skills/frontend-design/references/motion-core.md +102 -0
- package/.codex/skills/frontend-design/references/responsive-design.md +104 -0
- package/.codex/skills/frontend-design/references/spatial-design.md +103 -0
- package/.codex/skills/frontend-design/references/typography-rules.md +118 -0
- package/.codex/skills/frontend-design/references/ux-writing.md +105 -0
- package/.template-manifest.json +32 -24
- package/AGENTS.md +3 -3
- package/CHANGELOG.md +33 -0
- package/README.md +3 -1
- package/bin/codexkit +20 -1
- package/package.json +1 -1
|
@@ -1,43 +1,44 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "1.0.
|
|
2
|
+
"version": "1.0.3",
|
|
3
3
|
"generator": "codexkit",
|
|
4
4
|
"files": {
|
|
5
5
|
"templates/global/AGENTS.override.md": "11039408f8776171820ce34165b5da6d52a703d26a938fb773e231a159eefe2c",
|
|
6
6
|
"templates/global/.codex-config-template.toml": "aa3490d544eded2ab1eff3eee89823884d1d0085c502eceb604d89408a94848d",
|
|
7
7
|
"templates/project/.codex-config-template.toml": "dc8ded8af4deaf39155d5fdddeabf0763af5293f24e3477ec871d59fd8530e80",
|
|
8
8
|
"templates/project/AGENTS.md.template": "acb5ea31fd561ddbbc79c6baf6de98b990bbac693ba6d836406d270a1f27a981",
|
|
9
|
-
".codex/config.toml": "
|
|
9
|
+
".codex/config.toml": "32644bd80c9804612a851907c900ccc2edd84683a3470b224d173e29ee318a6a",
|
|
10
10
|
".codex/.env.example": "1827612829279fad025404b763ea214412bd5cd53474ad315909a8c275f12b84",
|
|
11
|
-
".codex/.version": "
|
|
12
|
-
".codex/agents/builder.toml": "
|
|
13
|
-
".codex/agents/debugger.toml": "
|
|
14
|
-
".codex/agents/general.toml": "
|
|
15
|
-
".codex/agents/painter.toml": "
|
|
16
|
-
".codex/agents/planner.toml": "
|
|
17
|
-
".codex/agents/refactorer.toml": "
|
|
18
|
-
".codex/agents/reviewer.toml": "
|
|
19
|
-
".codex/agents/runner.toml": "
|
|
20
|
-
".codex/agents/scout.toml": "
|
|
21
|
-
".codex/agents/shipper.toml": "
|
|
22
|
-
".codex/agents/vision.toml": "
|
|
11
|
+
".codex/.version": "f5e5c9534532840fcd45bb002e69ed85c61dba2753450e26b448b7df1481e24d",
|
|
12
|
+
".codex/agents/builder.toml": "b4e887e5ad5202337b0fda9815588db0eec2deee8fdfbdb8dad6bf2df6bf3d30",
|
|
13
|
+
".codex/agents/debugger.toml": "e67fdaee1807c2d8c40b2752737d6e1f535a0c52d863cc76eb9c8059f292bc13",
|
|
14
|
+
".codex/agents/general.toml": "274489e5d726ee11fc5d9ec43d44c4b7bc1ac22b435ad536af8818c6d430d46c",
|
|
15
|
+
".codex/agents/painter.toml": "bf03cc1cfe383aaa8b46c1a9632b917c79c0cea122ab3dedb3ed79afad580cec",
|
|
16
|
+
".codex/agents/planner.toml": "3b195c6e89065481a0825d652884485883dfca8da07281f113a1025b0971c9e6",
|
|
17
|
+
".codex/agents/refactorer.toml": "0de4d73931352edbef9dcff4bfd6ad4fb61ff10ba5fcf330d724e5f4193fdd67",
|
|
18
|
+
".codex/agents/reviewer.toml": "8634aac733cbf2e9c8d5ad81fc22a17c239156c1d78edb15e94b6f63488c1177",
|
|
19
|
+
".codex/agents/runner.toml": "cb3baca8eb358ace7c4b63f39ec6de0833b6e46655ccf816b0a553ec25faa677",
|
|
20
|
+
".codex/agents/scout.toml": "e06fa68c87261d0bfa8f2e61f34117f2291702236ca98df49d25b2faedeaf55c",
|
|
21
|
+
".codex/agents/shipper.toml": "940c3ffd2c467e11def4c4d87bae4c5244deee42bc48009cabbf1a07009eac4b",
|
|
22
|
+
".codex/agents/vision.toml": "430a3b9ae1f8d2322791b2683ea7cf1ca5dad353f00f2b6c2c09fd8bfe9acbe4",
|
|
23
23
|
".codex/prompts/compound.md": "2f3f713031c6a2591cf257a47f8909874ff0f94cf7a6663eeb8fe30fc1ae2a2e",
|
|
24
|
-
".codex/prompts/create.md": "
|
|
24
|
+
".codex/prompts/create.md": "f8bbe26011ddf5b95a6420ba41ecac2b605d39cf767367b0d3681024b7338dec",
|
|
25
25
|
".codex/prompts/design.md": "ee5dd7883a9ceb28a5c77526c35b040e1127e3de8022654fba2e26b9d42ec529",
|
|
26
26
|
".codex/prompts/handoff.md": "c3a1429739c5e83da931e6fcca7e7c645b92fb70c2c31088446aa6378958e05d",
|
|
27
27
|
".codex/prompts/init-context.md": "1df06b3abbddb8b3b920dbe72f4ea4b1ed2af58e3c4a9067dad128657bae3681",
|
|
28
28
|
".codex/prompts/init-user.md": "2904015a4a699918f27136b8be33a5647543e748ed8c546869d6c7d8e79216b8",
|
|
29
|
-
".codex/prompts/init.md": "
|
|
29
|
+
".codex/prompts/init.md": "9c17f422ee0c196d5e04e0def022d71050396630be82bf97f55139e187a960e5",
|
|
30
30
|
".codex/prompts/lfg.md": "d8d3f99522524f92d35360a9c00fb9410424b8818903ec3bb821cebef8579011",
|
|
31
31
|
".codex/prompts/plan.md": "f47aeb00d01167d5fee372115043fbfcac86216d59987ec16f67e7058aad6c42",
|
|
32
32
|
".codex/prompts/pr.md": "0866ed92ac74447ce01c955f49b00f055c5a244f80bd12a5f679f3860b776212",
|
|
33
33
|
".codex/prompts/research.md": "0ab8c8652d789ffc62a13ef6f7d533f63db77d8292dfaba4888a13a8eddb9d23",
|
|
34
34
|
".codex/prompts/resume.md": "e3d9c00cb1eb05eb367f627a039c0519c694458cf5be83b5ed9873e623e4c8e3",
|
|
35
35
|
".codex/prompts/review-codebase.md": "07f6ea450c02f820871edb2c5432d364dfa8e87bd662f13ba305ccb2cc25a5de",
|
|
36
|
-
".codex/prompts/ship.md": "
|
|
37
|
-
".codex/prompts/start.md": "
|
|
36
|
+
".codex/prompts/ship.md": "bf0eee8272c2ffab78574aef940be07e7dcf4129b7aa9d1368d850be16cde099",
|
|
37
|
+
".codex/prompts/start.md": "4abc1166ae6657070ec3162610504e8e4ba19df595e4552fe30bae70561999e3",
|
|
38
38
|
".codex/prompts/status.md": "c742f0b64b08f59fceb3eb90e1693a81de421c2311eb553f85793faed19e1bca",
|
|
39
39
|
".codex/prompts/ui-inspire.md": "4562892c1b3600d5b936cb5f62f3a45cd2d48dfba16f02a26de9d087e2b15ed6",
|
|
40
40
|
".codex/prompts/ui-review.md": "4b33aa90df5e6bed0a2a5d9a077b8a778577cb0271b3a03a3f41587b6132db09",
|
|
41
|
+
".codex/prompts/ui-slop-check.md": "19e9888ad59cd74ffeb0352b0ea813a8642320774bcdd0b34877e29ae3672e14",
|
|
41
42
|
".codex/prompts/verify.md": "d38dc229c7565c5c9a45869a1a5d17f1c3f6f5fee2f2e94ffe7ac10f9837a2e5",
|
|
42
43
|
".codex/skills/accessibility-audit/SKILL.md": "7cab0faa18ead1d87b62cb33a1f6774d9a485bf570a9b4c3538d811993eefc80",
|
|
43
44
|
".codex/skills/agent-browser/SKILL.md": "953a56fe1c7b40dd16842935f72f91b05bd25635e18196969bce982b7f8ae82a",
|
|
@@ -355,7 +356,14 @@
|
|
|
355
356
|
".codex/skills/figma/SKILL.md": "d9799488d3b8db3b86d633627320fea3ed6deafa11e573a0d4b9aa8e78c50ceb",
|
|
356
357
|
".codex/skills/figma/mcp.json": "1268189eaf6051544d129c9fec82454bb7df4101d22231c65f9a75e5bc1b98d6",
|
|
357
358
|
".codex/skills/finishing-a-development-branch/SKILL.md": "df9295cc756c22775779b7700997ea432b9aafab36d739c8d0b72db25d2e162f",
|
|
358
|
-
".codex/skills/frontend-design/SKILL.md": "
|
|
359
|
+
".codex/skills/frontend-design/SKILL.md": "f7ced66f8871c2015fcdc47fc699012fa515a10763de803cd52d9926e6d3f5c5",
|
|
360
|
+
".codex/skills/frontend-design/references/color-system.md": "c602d11206390802a502592ed2035b964dfc0dada9b61558426752f36b5dda34",
|
|
361
|
+
".codex/skills/frontend-design/references/interaction.md": "98f7f7f5021150eec6e44ede1b9b8c97c025da655dfcea7106dd6ce65569f059",
|
|
362
|
+
".codex/skills/frontend-design/references/motion-core.md": "03ae880a0639e4add78a9dd9974b04eab09a0d43292361e86e53b4c8262b814d",
|
|
363
|
+
".codex/skills/frontend-design/references/responsive-design.md": "38a2c5cad62b3384a56f756942fe13856c0dd164f37abdfaf3181ccd6d8bf685",
|
|
364
|
+
".codex/skills/frontend-design/references/spatial-design.md": "e773f1d77a62696371ed680d58bb78cb94bd16d66e0976b683eb483dfd738a7e",
|
|
365
|
+
".codex/skills/frontend-design/references/typography-rules.md": "9e8d063ce1ef57755b0231e937c05e0b4501a18c00034b7f9d89d1fcfca16d67",
|
|
366
|
+
".codex/skills/frontend-design/references/ux-writing.md": "f0ccd5432eab0b4e8b4ccf38a17551c833df15e14a59c7a9011f45f34d9c3c3c",
|
|
359
367
|
".codex/skills/gemini-large-context/SKILL.md": "9851f1ced0c4bd99f6021cd4bf8c90ac445da25026ed96c99e8c6f38929cea7f",
|
|
360
368
|
".codex/skills/git-pr-prep/SKILL.md": "57e48b83fb11101c1376e727f39332500bbc416838f0e20e4d72d87de2ea6f3a",
|
|
361
369
|
".codex/skills/index-knowledge/SKILL.md": "b1188ba08c583d346be20d8efb0f72f834c968ff5fc708e0f04fdc32aa4d9952",
|
|
@@ -587,14 +595,14 @@
|
|
|
587
595
|
".codex/scripts/memory_search.sh": "4c94a2785ce337f981aa234c8b3a935af9de42117cfbacf979c078718ac9952c",
|
|
588
596
|
".codex/scripts/prepare_worklog_archive.sh": "51d606d69a0e6c73d0e1978cbdcdb581ee9187391bcf8dfbf181d55306edc16f",
|
|
589
597
|
".codex/scripts/search_bead_context.sh": "c2040a7eb6039db278422045196333f70a520f0a6ff2843c5fa06cc08f424060",
|
|
590
|
-
".codex/scripts/start_bead.sh": "
|
|
598
|
+
".codex/scripts/start_bead.sh": "2c86e405df67d2f0dc6d3a616c2a92a13984c2745cbf5c5d5ab4b25a90584eb2",
|
|
591
599
|
".codex/scripts/sync_bead_context.sh": "6b8d6908cffbbf8fdbf5bf548e09788d504daddce092bd7112eee695882a64a7",
|
|
592
600
|
".codex/scripts/validate_memory_docs.sh": "a0a2b184db21dae92c88a0ea837be8bcaf7a47150392034d3110842f266c4afc",
|
|
593
|
-
".codex/scripts/verify_bead.sh": "
|
|
594
|
-
".codex/mcp/README.md": "
|
|
601
|
+
".codex/scripts/verify_bead.sh": "16571365aa54f300ec2554573f13bd74c37b22bfc54e1c09d5b55553855a0add",
|
|
602
|
+
".codex/mcp/README.md": "06c66bf958de327cdb3e14367beb4ad7d82d1ba4a93eb4a2191fe134678ba430",
|
|
595
603
|
".codex/mcp/basic-memory.toml.example": "b40ef19861a8f29d3d78d7b166474cc4d44e79362bf5fc81942754609ff4ee3c",
|
|
596
|
-
".codex/mcp/context7.toml.example": "
|
|
597
|
-
".codex/mcp/exa.toml.example": "
|
|
604
|
+
".codex/mcp/context7.toml.example": "d016f67a43a1e578bb2c0311ba61a6e63e58aff3dc783b084eb082141f79a42b",
|
|
605
|
+
".codex/mcp/exa.toml.example": "7aea5ab1c227ca3cf4ca9c976ec270897f39526954e8618c89764a47ec23f69b",
|
|
598
606
|
".codex/mcp/memory-bridge.toml.example": "3689f1b04410463c2e648e437e16c30901a7b1c5e165255e03b3552c9a4b03e8",
|
|
599
607
|
".codex/mcp/memory.toml.example": "3c5575ebd822729023220c7a6c7f7a6a7e0ac9e43edbf7e0665d4e06938fb8e7",
|
|
600
608
|
".codex/mcp/ref.toml.example": "a7a5d84b04f9d7a35282e91eb45111a0d7ddb185cdc8326461a8306d9b5d802b",
|
package/.codex/.version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.3
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# Builder Agent — Primary implementation specialist
|
|
2
2
|
|
|
3
|
+
name = "builder"
|
|
3
4
|
description = "Primary implementation agent — writes production code with verification and deviation rules."
|
|
4
5
|
model = "gpt-5.3-codex"
|
|
5
6
|
model_reasoning_effort = "medium"
|
|
@@ -25,7 +26,11 @@ During and after execution:
|
|
|
25
26
|
|
|
26
27
|
## Operating Rules
|
|
27
28
|
|
|
28
|
-
- Read files before editing.
|
|
29
|
+
- **Read files before editing** — runtime enforced for existing files.
|
|
30
|
+
Codex rejects Write/Edit on an existing file that has not been Read in
|
|
31
|
+
the current session (`File has not been read in this session. Read the file before editing.`).
|
|
32
|
+
New files can be written freely; the guard only fires for files already on disk.
|
|
33
|
+
Prefer Edit for partial modifications; use Write for new files or full replacements after Read.
|
|
29
34
|
- Keep edits minimal and directly tied to the request.
|
|
30
35
|
- Prefer existing utilities and patterns before creating new abstractions.
|
|
31
36
|
- Ask before irreversible actions (delete data/files, push, merge, destructive commands).
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Debugger Agent — Bug investigation and root cause analysis
|
|
2
2
|
# Systematic debugging with hypothesis-driven investigation
|
|
3
3
|
|
|
4
|
+
name = "debugger"
|
|
4
5
|
description = "Bug investigation specialist — finds root causes through systematic hypothesis testing."
|
|
5
6
|
model = "gpt-5.3-codex"
|
|
6
7
|
model_reasoning_effort = "high"
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# General Agent — Small scoped implementation subtasks
|
|
2
2
|
|
|
3
|
+
name = "general"
|
|
3
4
|
description = "Small, well-defined implementation subtasks with limited scope."
|
|
4
5
|
model = "gpt-5.3-codex"
|
|
5
6
|
model_reasoning_effort = "medium"
|
|
@@ -27,7 +28,11 @@ module, one concrete acceptance target.
|
|
|
27
28
|
## Rules
|
|
28
29
|
|
|
29
30
|
- Stay within the assigned scope.
|
|
30
|
-
- Read affected files before editing.
|
|
31
|
+
- **Read affected files before editing** — runtime enforced for existing files.
|
|
32
|
+
Codex rejects Write/Edit on an existing file that has not been Read in
|
|
33
|
+
the current session (`File has not been read in this session. Read the file before editing.`).
|
|
34
|
+
New files can be written freely; the guard only fires for files already on disk.
|
|
35
|
+
Prefer Edit for partial modifications; use Write for new files or full replacements after Read.
|
|
31
36
|
- Run the smallest verification that proves your slice works.
|
|
32
37
|
- Do not broaden the task without evidence that the current scope is blocked.
|
|
33
38
|
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Planner Agent — Architecture and implementation planning
|
|
2
2
|
# Codexkit planner agent definition
|
|
3
3
|
|
|
4
|
+
name = "planner"
|
|
4
5
|
description = "Plans implementation approach with goal-backward decomposition before coding begins."
|
|
5
6
|
model = "gpt-5.4"
|
|
6
7
|
model_reasoning_effort = "high"
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Refactorer Agent — Safe refactoring specialist
|
|
2
2
|
# Behavior-preserving code improvements with test verification
|
|
3
3
|
|
|
4
|
+
name = "refactorer"
|
|
4
5
|
description = "Safe refactoring specialist — improves code structure while preserving behavior."
|
|
5
6
|
model = "gpt-5.3-codex"
|
|
6
7
|
model_reasoning_effort = "medium"
|
package/.codex/agents/scout.toml
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Scout Agent — External research and documentation specialist
|
|
2
2
|
# Codexkit scout agent definition
|
|
3
3
|
|
|
4
|
+
name = "scout"
|
|
4
5
|
description = "Research specialist for library docs, API references, and external patterns."
|
|
5
6
|
model = "gpt-5.4"
|
|
6
7
|
model_reasoning_effort = "medium"
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Shipper Agent — Release preparation and PR workflow
|
|
2
2
|
# Codexkit shipper agent definition
|
|
3
3
|
|
|
4
|
+
name = "shipper"
|
|
4
5
|
description = "Prepares and validates code for shipping — PR prep, changelog, final verification."
|
|
5
6
|
model = "gpt-5.3-codex"
|
|
6
7
|
sandbox_mode = "workspace-write"
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Vision Agent — UI/UX analysis and accessibility specialist
|
|
2
2
|
# Codexkit vision agent definition
|
|
3
3
|
|
|
4
|
+
name = "vision"
|
|
4
5
|
description = "Visual analysis specialist for UI/UX review, accessibility audits, design consistency, and grounded inspiration scouting."
|
|
5
6
|
model = "gpt-5.4"
|
|
6
7
|
model_reasoning_effort = "high"
|
package/.codex/config.toml
CHANGED
|
@@ -54,13 +54,16 @@ approval_policy = "on-request"
|
|
|
54
54
|
|
|
55
55
|
# ─── Agents ─────────────────────────────────────────────────────────
|
|
56
56
|
#
|
|
57
|
-
# Multi-agent roles. Each role has a .toml
|
|
57
|
+
# Multi-agent roles. Each role has a standalone .toml file in .codex/agents/.
|
|
58
58
|
# Built-in roles (default, explorer, worker) are always available.
|
|
59
|
-
#
|
|
59
|
+
# Codex auto-discovers standalone agent files (must define name, description,
|
|
60
|
+
# developer_instructions). The explicit registrations below provide description
|
|
61
|
+
# visibility in config and are still supported. See: https://developers.openai.com/codex/subagents
|
|
60
62
|
|
|
61
63
|
[agents]
|
|
62
64
|
max_threads = 6
|
|
63
65
|
max_depth = 1
|
|
66
|
+
# job_max_runtime_seconds = 1800 # Default timeout per worker for spawn_agents_on_csv
|
|
64
67
|
|
|
65
68
|
[agents.planner]
|
|
66
69
|
description = "Plans implementation approach with goal-backward decomposition before coding begins."
|
|
@@ -138,7 +141,9 @@ persistence = "save-all"
|
|
|
138
141
|
# ─── Feature Flags ─────────────────────────────────────────────────
|
|
139
142
|
|
|
140
143
|
[features]
|
|
141
|
-
multi_agent
|
|
144
|
+
# multi_agent — enabled by default since Codex v0.115.0; explicit flag no longer required.
|
|
145
|
+
# Uncomment only if you need to disable subagents:
|
|
146
|
+
# multi_agent = false
|
|
142
147
|
# memories = true
|
|
143
148
|
# Experimental / watchlist only:
|
|
144
149
|
# - enable only after public Codex docs make the feature stable enough for your workflow
|
package/.codex/mcp/README.md
CHANGED
|
@@ -37,15 +37,31 @@ From the target project, create `.codex/.env` from `.codex/.env.example` and lau
|
|
|
37
37
|
|
|
38
38
|
**Primary** for precise library API lookups — function signatures, code examples, version-specific docs. Deepest coverage for known libraries.
|
|
39
39
|
|
|
40
|
+
**STDIO (recommended)** — free for basic use, no API key required:
|
|
41
|
+
|
|
42
|
+
```toml
|
|
43
|
+
[mcp_servers.context7]
|
|
44
|
+
command = "npx"
|
|
45
|
+
args = ["-y", "@upstash/context7-mcp"]
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Or via CLI: `codex mcp add context7 -- npx -y @upstash/context7-mcp`
|
|
49
|
+
|
|
50
|
+
For higher rate limits, add an API key from [context7.com](https://context7.com) → Dashboard:
|
|
51
|
+
|
|
52
|
+
```toml
|
|
53
|
+
[mcp_servers.context7.env]
|
|
54
|
+
CONTEXT7_API_KEY = "your-key-here"
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
**Alternative — HTTP remote:**
|
|
58
|
+
|
|
40
59
|
```toml
|
|
41
60
|
[mcp_servers.context7]
|
|
42
61
|
url = "https://mcp.context7.com/mcp"
|
|
43
62
|
env_http_headers = { "CONTEXT7_API_KEY" = "CONTEXT7_API_KEY" }
|
|
44
|
-
startup_timeout_ms = 20_000
|
|
45
63
|
```
|
|
46
64
|
|
|
47
|
-
Get your key at [context7.com](https://context7.com) → Dashboard.
|
|
48
|
-
|
|
49
65
|
### Ref — Documentation search (Primary)
|
|
50
66
|
|
|
51
67
|
**Primary** for broad documentation search — covers official docs, private repos, and PDFs. Has a credit system. Broadest documentation coverage.
|
|
@@ -1,13 +1,30 @@
|
|
|
1
1
|
# Context7 — Library documentation search
|
|
2
|
-
# Provides:
|
|
3
|
-
#
|
|
2
|
+
# Provides: resolve-library-id, get-library-docs
|
|
3
|
+
# Free for basic use (rate-limited). API key for higher limits: https://context7.com/dashboard
|
|
4
4
|
#
|
|
5
|
-
#
|
|
6
|
-
#
|
|
5
|
+
# Option A — STDIO (recommended, no API key required for basic use):
|
|
6
|
+
# codex mcp add context7 -- npx -y @upstash/context7-mcp
|
|
7
7
|
#
|
|
8
|
-
#
|
|
8
|
+
# Option B — STDIO with API key (higher rate limits):
|
|
9
|
+
# Add to ~/.codex/config.toml:
|
|
10
|
+
#
|
|
11
|
+
# [mcp_servers.context7]
|
|
12
|
+
# command = "npx"
|
|
13
|
+
# args = ["-y", "@upstash/context7-mcp"]
|
|
14
|
+
#
|
|
15
|
+
# [mcp_servers.context7.env]
|
|
16
|
+
# CONTEXT7_API_KEY = "your-key-here"
|
|
17
|
+
#
|
|
18
|
+
# Option C — HTTP remote (alternative transport):
|
|
19
|
+
# Keep the key in your shell or .codex/.env, then launch Codex with:
|
|
20
|
+
# codexkit run
|
|
21
|
+
#
|
|
22
|
+
# [mcp_servers.context7]
|
|
23
|
+
# url = "https://mcp.context7.com/mcp"
|
|
24
|
+
# env_http_headers = { "CONTEXT7_API_KEY" = "CONTEXT7_API_KEY" }
|
|
25
|
+
#
|
|
26
|
+
# Add to ~/.codex/config.toml (NOT project-level config):
|
|
9
27
|
|
|
10
28
|
[mcp_servers.context7]
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
startup_timeout_ms = 20_000
|
|
29
|
+
command = "npx"
|
|
30
|
+
args = ["-y", "@upstash/context7-mcp"]
|
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
# Exa — Web search and code context
|
|
2
|
-
#
|
|
2
|
+
# Default tools: exa_web_search_exa, exa_get_code_context_exa
|
|
3
3
|
# Requires: EXA_API_KEY (get from https://exa.ai → Dashboard)
|
|
4
4
|
#
|
|
5
|
+
# Additional tools available via URL params (not enabled by default):
|
|
6
|
+
# deep_search_exa, crawling_exa, company_research_exa,
|
|
7
|
+
# linkedin_search_exa, deep_researcher_start, deep_researcher_check
|
|
8
|
+
#
|
|
9
|
+
# To enable extra tools, append ?tools= to the URL:
|
|
10
|
+
# url = "https://mcp.exa.ai/mcp?tools=web_search_exa,get_code_context_exa,deep_search_exa,crawling_exa"
|
|
11
|
+
#
|
|
5
12
|
# Keep the key in your shell or .codex/.env, then launch Codex with:
|
|
6
13
|
# codexkit run
|
|
7
14
|
#
|
package/.codex/prompts/create.md
CHANGED
|
@@ -76,16 +76,41 @@ If `--type` is provided, use it directly. Otherwise classify and confirm:
|
|
|
76
76
|
- **bug**: broken behavior
|
|
77
77
|
- **task**: tactical change with clear scope
|
|
78
78
|
|
|
79
|
-
## Phase 3:
|
|
79
|
+
## Phase 3: Detect Research Scope
|
|
80
|
+
|
|
81
|
+
Scan `$ARGUMENTS` for signals of external dependencies:
|
|
82
|
+
|
|
83
|
+
| Category | Signal Words |
|
|
84
|
+
| ------------- | ------------------------------------------------------- |
|
|
85
|
+
| Payment | stripe, paypal, paddle, lemonsqueezy, payment, billing |
|
|
86
|
+
| Auth | auth0, clerk, supabase auth, firebase auth, oauth, SAML |
|
|
87
|
+
| Email | resend, sendgrid, postmark, ses, transactional email |
|
|
88
|
+
| Cloud | aws, gcp, azure, vercel, cloudflare, fly.io |
|
|
89
|
+
| Database SaaS | supabase, planetscale, neon, turso, firebase |
|
|
90
|
+
| Analytics | posthog, amplitude, mixpanel, plausible |
|
|
91
|
+
| AI/ML | openai, anthropic, gemini, huggingface, replicate |
|
|
92
|
+
| Storage | s3, r2, cloudinary, uploadthing |
|
|
93
|
+
| Task Tracking | beads_rust, linear, jira |
|
|
94
|
+
|
|
95
|
+
**Classification:**
|
|
96
|
+
|
|
97
|
+
- **internal-only**: No signals detected → all research depths available
|
|
98
|
+
- **external-required**: Signal detected → Minimal and Skip are **blocked**; minimum Standard depth
|
|
99
|
+
|
|
100
|
+
If external dependency is detected, tell the user: "External dependency detected ([category]). Research depth must be Standard or Deep."
|
|
101
|
+
|
|
102
|
+
## Phase 4: Choose Research Depth
|
|
80
103
|
|
|
81
104
|
> **Choose one:**
|
|
82
105
|
>
|
|
83
106
|
> 1. **Deep (Recommended)** — 3-5 investigations: patterns, tests, dependencies, and best practices (~2 min)
|
|
84
107
|
> 2. **Standard** — 2 investigations: patterns + tests (~1 min)
|
|
85
|
-
> 3. **Minimal** — 1 investigation: quick file scan (~30 sec)
|
|
86
|
-
> 4. **Skip** — use current project knowledge only
|
|
108
|
+
> 3. **Minimal** — 1 investigation: quick file scan (~30 sec) ⚠️ _Blocked if external deps detected_
|
|
109
|
+
> 4. **Skip** — use current project knowledge only ⚠️ _Blocked if external deps detected_
|
|
87
110
|
|
|
88
|
-
|
|
111
|
+
**Auto-escalation rule:** If Phase 3 classified as `external-required`, options 3 and 4 are unavailable. Default to Standard.
|
|
112
|
+
|
|
113
|
+
## Phase 5: Gather Context (Delegation by Depth)
|
|
89
114
|
|
|
90
115
|
Based on selected depth:
|
|
91
116
|
|
|
@@ -108,9 +133,20 @@ Based on selected depth:
|
|
|
108
133
|
|
|
109
134
|
- No delegation; use existing `AGENTS.md` + `.codex/context/`
|
|
110
135
|
|
|
136
|
+
**External dependency research (when Phase 3 = external-required):**
|
|
137
|
+
|
|
138
|
+
For any depth (Deep or Standard), `@scout` **must** search for:
|
|
139
|
+
|
|
140
|
+
- Official documentation / API reference for the detected service
|
|
141
|
+
- Current pricing and rate limits
|
|
142
|
+
- Integration examples in the project's language/framework
|
|
143
|
+
- Known gotchas or breaking changes
|
|
144
|
+
|
|
145
|
+
Include source URLs in all research findings. Save findings to `.beads/artifacts/<bead-id>/research.md`.
|
|
146
|
+
|
|
111
147
|
While context is gathered, ask clarifying questions for missing scope/outcomes. For bugs, require repro steps and expected vs actual behavior.
|
|
112
148
|
|
|
113
|
-
## Phase
|
|
149
|
+
## Phase 6: Search Prior Related Work
|
|
114
150
|
|
|
115
151
|
Before creating a new PRD, search durable project context for relevant prior bead work:
|
|
116
152
|
|
|
@@ -134,7 +170,7 @@ When you are ready to write the PRD, you may build that section directly with:
|
|
|
134
170
|
.codex/scripts/build_prior_related_work.sh "$ARGUMENTS" --limit 3
|
|
135
171
|
```
|
|
136
172
|
|
|
137
|
-
## Phase
|
|
173
|
+
## Phase 7: Create Bead
|
|
138
174
|
|
|
139
175
|
Extract title/description from `$ARGUMENTS`:
|
|
140
176
|
|
|
@@ -157,7 +193,7 @@ Create and reserve these files up front so later prompts have predictable inputs
|
|
|
157
193
|
```text
|
|
158
194
|
.beads/artifacts/<bead-id>/
|
|
159
195
|
├── prd.md
|
|
160
|
-
├── research.md # if Phase
|
|
196
|
+
├── research.md # if Phase 5 used scout/explore findings
|
|
161
197
|
├── design.md # if design tradeoffs matter
|
|
162
198
|
└── notes.md # optional clarifications gathered during create
|
|
163
199
|
```
|
|
@@ -165,24 +201,24 @@ Create and reserve these files up front so later prompts have predictable inputs
|
|
|
165
201
|
If the task is epic-sized, define candidate child-bead boundaries in the PRD even if the
|
|
166
202
|
child beads are not created yet.
|
|
167
203
|
|
|
168
|
-
## Phase
|
|
204
|
+
## Phase 8: Write PRD
|
|
169
205
|
|
|
170
206
|
Use the `$prd` skill template to write `.beads/artifacts/<bead-id>/prd.md`. Fill every section from gathered context — no placeholders allowed.
|
|
171
207
|
|
|
172
208
|
### Required Sections
|
|
173
209
|
|
|
174
|
-
| Section
|
|
175
|
-
|
|
|
176
|
-
| Problem Statement
|
|
177
|
-
| Scope (In/Out)
|
|
178
|
-
| Proposed Solution
|
|
179
|
-
| Success Criteria
|
|
180
|
-
| Technical Context
|
|
181
|
-
| Affected Files
|
|
182
|
-
| Prior Related Work | Synced bead summaries and decision/worklog search
|
|
183
|
-
| Tasks
|
|
184
|
-
| Risks
|
|
185
|
-
| Open Questions
|
|
210
|
+
| Section | Source | Required |
|
|
211
|
+
| ------------------ | ---------------------------------------------------------- | ----------------- |
|
|
212
|
+
| Problem Statement | User description + clarifying questions | Always |
|
|
213
|
+
| Scope (In/Out) | User input + codebase exploration | Always |
|
|
214
|
+
| Proposed Solution | Codebase patterns + user intent | Always |
|
|
215
|
+
| Success Criteria | User verification + test commands (must include `Verify:`) | Always |
|
|
216
|
+
| Technical Context | Exploration findings | Always |
|
|
217
|
+
| Affected Files | Exploration findings (real paths from Phase 5) | Always |
|
|
218
|
+
| Prior Related Work | Synced bead summaries and decision/worklog search | If relevant |
|
|
219
|
+
| Tasks | Derived from scope + solution | Always |
|
|
220
|
+
| Risks | Codebase exploration | Feature/epic only |
|
|
221
|
+
| Open Questions | Unresolved items from Phase 5 | If any exist |
|
|
186
222
|
|
|
187
223
|
### Task Format
|
|
188
224
|
|
|
@@ -202,7 +238,7 @@ For feature/epic work, add a short `Execution Strategy` section covering:
|
|
|
202
238
|
- whether child beads are recommended
|
|
203
239
|
- what must be manually verified by a human
|
|
204
240
|
|
|
205
|
-
## Phase
|
|
241
|
+
## Phase 9: Validate PRD
|
|
206
242
|
|
|
207
243
|
Before finalizing, verify:
|
|
208
244
|
|
|
@@ -214,10 +250,11 @@ Before finalizing, verify:
|
|
|
214
250
|
- [ ] Tasks use `[category]` headings
|
|
215
251
|
- [ ] Every task includes verification
|
|
216
252
|
- [ ] No implementation code in PRD
|
|
253
|
+
- [ ] If external deps detected in Phase 3: `research.md` exists in artifacts with source URLs
|
|
217
254
|
|
|
218
255
|
If any check fails, fix it without asking.
|
|
219
256
|
|
|
220
|
-
## Phase
|
|
257
|
+
## Phase 10: Report
|
|
221
258
|
|
|
222
259
|
Output:
|
|
223
260
|
|
|
@@ -232,7 +269,7 @@ br comments add $bead_id "Created prd.md with [N] tasks, [M] success criteria"
|
|
|
232
269
|
|
|
233
270
|
## Related Commands
|
|
234
271
|
|
|
235
|
-
| Need
|
|
236
|
-
|
|
|
237
|
-
| Start working
|
|
238
|
-
| Implement next
|
|
272
|
+
| Need | Command |
|
|
273
|
+
| -------------- | --------------------- |
|
|
274
|
+
| Start working | `/prompts:start <id>` |
|
|
275
|
+
| Implement next | `/prompts:ship <id>` |
|
package/.codex/prompts/init.md
CHANGED
|
@@ -53,6 +53,30 @@ Create or improve `AGENTS.md` (target <60 lines, max 150):
|
|
|
53
53
|
- Boundaries: always / ask-first / never
|
|
54
54
|
- Gotchas
|
|
55
55
|
|
|
56
|
+
### File Operation Guard (include in generated AGENTS.md)
|
|
57
|
+
|
|
58
|
+
Document the runtime-enforced Read-before-Write/Edit rule:
|
|
59
|
+
|
|
60
|
+
```markdown
|
|
61
|
+
## File Operations
|
|
62
|
+
|
|
63
|
+
Codex enforces a **Read-before-Write** guard at runtime for existing files:
|
|
64
|
+
|
|
65
|
+
- **Existing files**: Must be Read before any Write or Edit. The runtime
|
|
66
|
+
rejects the operation with:
|
|
67
|
+
> `File has not been read in this session. Read the file before editing.`
|
|
68
|
+
- **New files**: Can be written freely — the guard only fires for files
|
|
69
|
+
that already exist on disk.
|
|
70
|
+
|
|
71
|
+
**Preferred tool selection:**
|
|
72
|
+
|
|
73
|
+
| Intent | Tool |
|
|
74
|
+
| -------------------------------------- | ----- |
|
|
75
|
+
| Modify part of an existing file | Edit |
|
|
76
|
+
| Full replacement of an existing file | Write (after Read) |
|
|
77
|
+
| Create a file that does not exist yet | Write |
|
|
78
|
+
```
|
|
79
|
+
|
|
56
80
|
Principles: examples over explanation; pointers over copies; merge existing custom rules.
|
|
57
81
|
|
|
58
82
|
## Phase 4: Create Tech Stack + Context Docs
|