@pzy560117/codex-harness 0.1.3 → 0.1.5
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 +164 -27
- package/bin/harness.js +7 -7
- package/lib/commands/doctor.js +12 -12
- package/lib/commands/init.js +105 -105
- package/lib/commands/run.js +22 -22
- package/lib/commands/verify.js +12 -12
- package/lib/main.js +62 -62
- package/lib/powershell/find-powershell.js +20 -20
- package/lib/powershell/invoke-script.js +34 -34
- package/lib/project/assert-initialized.js +20 -20
- package/lib/project/detect-project-root.js +5 -5
- package/lib/release/cache-layout.js +34 -34
- package/lib/release/download-release.js +25 -25
- package/lib/release/package-source-layout.js +13 -13
- package/lib/release/release-config.js +6 -6
- package/lib/release/release-manifest.js +76 -76
- package/lib/release/resolve-package-source.js +21 -21
- package/lib/release/resolve-version.js +26 -26
- package/lib/release/unpack-zip.js +25 -25
- package/lib/release/verify-sha256.js +16 -16
- package/package-source/AGENTS.md +48 -57
- package/package-source/PACKAGE.md +7 -7
- package/package-source/README.md +85 -81
- package/package-source/docs/codex-harness-engineering/templates/AGENTS.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/README.md +21 -20
- package/package-source/docs/codex-harness-engineering/templates/bootstrap-codex-harness.ps1 +144 -110
- package/package-source/docs/codex-harness-engineering/templates/ci/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/ci/github-action-codex-review.yml +110 -110
- package/package-source/docs/codex-harness-engineering/templates/config/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/config/agents/architect.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/backend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-researcher.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-worker.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/explorer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/failure-triage.toml +19 -18
- package/package-source/docs/codex-harness-engineering/templates/config/agents/frontend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/harness-writer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/planner.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/readonly-research.toml +14 -13
- package/package-source/docs/codex-harness-engineering/templates/config/agents/reviewer.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/security-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage1-reviewer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage2-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-planner.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-runner.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/visual-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/codex-agent-roles.md +24 -24
- package/package-source/docs/codex-harness-engineering/templates/config/codex-config.toml +12 -12
- package/package-source/docs/codex-harness-engineering/templates/config/codex-readme.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/config/env-check.ps1 +44 -40
- package/package-source/docs/codex-harness-engineering/templates/config/env.example +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/global-AGENTS.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/config/global-config.toml +19 -19
- package/package-source/docs/codex-harness-engineering/templates/config/rules/agents.md +118 -115
- package/package-source/docs/codex-harness-engineering/templates/config/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/config/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/config/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/config/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/config/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/context/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CHANGELOG_AI.md +11 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +114 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DB_SCHEMA.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DECISIONS.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/KNOWN_ISSUES.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/PROJECT_CONTEXT.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/architecture-brief.md +58 -58
- package/package-source/docs/codex-harness-engineering/templates/context/dev-plan.md +89 -83
- package/package-source/docs/codex-harness-engineering/templates/context/feature-pack.md +101 -101
- package/package-source/docs/codex-harness-engineering/templates/context/repo-map.md +102 -78
- package/package-source/docs/codex-harness-engineering/templates/context/service-dependency-matrix.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/contracts/AGENTS.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/contracts/README.md +24 -16
- package/package-source/docs/codex-harness-engineering/templates/contracts/openapi.yaml +182 -182
- package/package-source/docs/codex-harness-engineering/templates/contracts/orval.config.ts +20 -20
- package/package-source/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -34
- package/package-source/docs/codex-harness-engineering/templates/design/AGENTS.md +21 -0
- package/package-source/docs/codex-harness-engineering/templates/design/ai-image-brief.md +122 -122
- package/package-source/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/docs/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/architecture-constraints.md +97 -83
- package/package-source/docs/codex-harness-engineering/templates/docs/code-semantics-and-navigation.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/directory-structure-template.md +88 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +165 -138
- package/package-source/docs/codex-harness-engineering/templates/docs/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/docs/harness-architecture.md +78 -78
- package/package-source/docs/codex-harness-engineering/templates/docs/install-manifest-governance.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-architecture.md +241 -219
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-import.md +108 -108
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-lint.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-checklist.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-usage.md +107 -43
- package/package-source/docs/codex-harness-engineering/templates/docs/project-agents-template.md +211 -154
- package/package-source/docs/codex-harness-engineering/templates/docs/prompt-knowledge-integration.md +100 -89
- package/package-source/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -45
- package/package-source/docs/codex-harness-engineering/templates/docs/requirement-prep-kit/README.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/docs/rule-governance.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/service-dependency-matrix.md +70 -55
- package/package-source/docs/codex-harness-engineering/templates/docs/task-session-strategy.md +133 -116
- package/package-source/docs/codex-harness-engineering/templates/docs/team-knowledge-sync.md +187 -187
- package/package-source/docs/codex-harness-engineering/templates/docs/trace-format.md +44 -32
- package/package-source/docs/codex-harness-engineering/templates/governance/AGENTS.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/governance/branch-protection-checklist.md +50 -50
- package/package-source/docs/codex-harness-engineering/templates/governance/feedback-evolution-loop.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/governance/retry-budget.yaml +30 -30
- package/package-source/docs/codex-harness-engineering/templates/governance/risk-levels.yaml +53 -53
- package/package-source/docs/codex-harness-engineering/templates/governance/sandbox-policy.md +13 -13
- package/package-source/docs/codex-harness-engineering/templates/hooks/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/hooks/hook-stop-verify.ps1 +171 -118
- package/package-source/docs/codex-harness-engineering/templates/hooks/hooks.json +40 -40
- package/package-source/docs/codex-harness-engineering/templates/knowledge/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/knowledge/catalog.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/knowledge/decisions/DECISION-HARNESS-001.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/knowledge/guidelines/GUIDELINE-RULES-001.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/knowledge/knowledge-catalog.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/plan-template.md +252 -252
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/spec-template.md +145 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/tasks-template.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/package-assets/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/AGENTS.md +25 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/README.md +118 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/START-HERE.md +66 -53
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/agent-ecosystem-practices.md +140 -140
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/best-practices.md +9 -9
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/codex-global-rules-example.md +48 -48
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/goal-templates.md +380 -380
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/README.md +64 -64
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/openapi.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/orval.config.ts +20 -20
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ai-image-brief.md +44 -44
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/component-map.md +17 -17
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/design-brief.md +58 -58
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/frontend-architecture.md +106 -106
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/image-to-frontend-spec.md +72 -72
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/screen-states.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ui-image-review.md +38 -38
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/difficulty-research.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/page-inventory.md +5 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/prd-lite.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/requirement-interface-matrix.md +32 -32
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/state-matrix.yaml +14 -14
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/model/Ticket.ts +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/ticket-api.ts +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/http-client.ts +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/ui/TicketFilterBar.tsx +72 -72
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/plans/features/ticket-filter.dev-plan.md +48 -48
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/progress.txt +1 -1
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/stories/TicketFilterBar.stories.tsx +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/task.json +54 -54
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/verify.ps1 +42 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/global-rules-and-bootstrap.md +157 -157
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/goal-harness-integration-guide.md +364 -364
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-flow.md +7 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-guide.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/knowledge-surface-map.md +186 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/mode-matrix.md +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/new-project-usage.md +176 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/project-agents-template.md +168 -154
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/superpowers-codex-solo-builder-playbook.md +676 -676
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/AGENTS.md +22 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +89 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/dev-plan.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/README.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +161 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/trace-format.md +86 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/11-security-design.md +43 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +690 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +23 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/verify-matrix.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/README.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/commands/e2e.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/README.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/Mobile_App_Production_Readiness_Framework_/347/247/273/345/212/250/347/253/257/345/205/250/345/271/263/345/217/260/347/224/237/344/272/247/345/217/257/344/270/212/347/272/277/350/247/204/350/214/203.md +2457 -2457
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/catalog.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/architecture.md +358 -358
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/AI_Coding_Production_Control_Framework_AI/345/206/231/345/256/214/347/232/204/344/273/243/347/240/201/345/246/202/344/275/225/344/270/215/345/244/261/346/216/247.md +2055 -2055
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/catalog.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/initial-content.md +296 -296
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/integration-roadmap.md +221 -221
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/architecture-constraints.md +95 -83
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-semantics-and-navigation.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/frontend-quality-rules.md +138 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/service-dependency-matrix.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/speckit-requirements-gate.md +124 -124
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/PACKAGE.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/README.md +52 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/install-agent-here.ps1 +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/agents.md +115 -115
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/HOW_TO_USE_SKILLS.md +79 -79
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/academic-mermaid-diagrams/SKILL.md +172 -172
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/SKILL.md +152 -152
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/references/command-recipes.md +92 -92
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/auto-commit/SKILL.md +324 -322
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/better-icons/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/references/windows-openrouter-clash-playbook.md +94 -94
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/diagnose-openrouter-route.ps1 +282 -282
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/ensure-openrouter-rule.ps1 +101 -101
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/fixing-metadata/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/frontend-design/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/git-xianyu-analyzer/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/SKILL.md +204 -188
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/current-repo-sync-matrix.md +150 -110
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/stale-patterns.md +65 -65
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/init-autopilot/SKILL.md +17 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/log-analysis-optimization/SKILL.md +5 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/prd-writer-skill/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-planner/SKILL.md +11 -11
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-runner/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-mock-cleaner/SKILL.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/SKILL.md +67 -67
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/agents/openai.yaml +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/scripts/configure-qoder-codex-api.ps1 +278 -278
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/requirements-design-template/SKILL.md +87 -87
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/skills-index.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-analyze/SKILL.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-checklist/SKILL.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-clarify/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-e2e-tasks/SKILL.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-implement/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-plan/SKILL.md +140 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-specify/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-tasks/SKILL.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-verify/SKILL.md +144 -142
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/SKILL.md +145 -143
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/current-repo-notes.md +42 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/github-samples.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/scripts/collect-root-doc-facts.ps1 +174 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/ai-integrity-and-originality.md +191 -191
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/citation-templates.md +99 -99
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/final-checklist.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/photographer-booking-paper.md +85 -85
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/test-result-templates.md +22 -22
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/thesis-analysis-template.md +63 -63
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/update-codemaps/SKILL.md +31 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/README.md +15 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.analyze.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.checklist.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.clarify.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.e2e-testing.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.implement.md +56 -56
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.plan.md +137 -134
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.specify.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.tasks.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.verify.md +130 -130
- package/package-source/docs/codex-harness-engineering/templates/product/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/product/acceptance-criteria.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/difficulty-research.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/page-inventory.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -158
- package/package-source/docs/codex-harness-engineering/templates/product/requirement-interface-matrix.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -105
- package/package-source/docs/codex-harness-engineering/templates/prompts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/prompts/controller-loop.md +88 -88
- package/package-source/docs/codex-harness-engineering/templates/prompts/failure-triage.md +71 -69
- package/package-source/docs/codex-harness-engineering/templates/prompts/harness-audit.md +54 -52
- package/package-source/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -148
- package/package-source/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -67
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-one-task.md +45 -43
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage1-spec.md +111 -109
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage2-quality.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/prompts/visual-evaluator.md +80 -78
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/backend-worker.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/docs-worker.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/frontend-worker.md +46 -46
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/harness-writer.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/test-runner.md +27 -27
- package/package-source/docs/codex-harness-engineering/templates/runtime/AGENTS.md +66 -50
- package/package-source/docs/codex-harness-engineering/templates/runtime/codex-loop.ps1 +2129 -231
- package/package-source/docs/codex-harness-engineering/templates/runtime/doctor.ps1 +224 -224
- package/package-source/docs/codex-harness-engineering/templates/runtime/project-task-template.json +42 -39
- package/package-source/docs/codex-harness-engineering/templates/runtime/scripts/test-install-modes.ps1 +2 -2
- package/package-source/docs/codex-harness-engineering/templates/runtime/smoke-task.json +52 -52
- package/package-source/docs/codex-harness-engineering/templates/runtime/task-run-profile.json +86 -86
- package/package-source/docs/codex-harness-engineering/templates/runtime/task.json +11 -8
- package/package-source/docs/codex-harness-engineering/templates/runtime/verify.ps1 +21 -21
- package/package-source/docs/codex-harness-engineering/templates/scripts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/spec/10-data-model.md +23 -7
- package/package-source/docs/codex-harness-engineering/templates/spec/11-security-design.md +30 -13
- package/package-source/docs/codex-harness-engineering/templates/spec/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_CRITERIA.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_EXAMPLES.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/testing/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -48
- package/package-source/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +5 -4
- package/package-source/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -20
- package/package-source/docs/codex-harness-engineering/templates/testing/RISK_BASED_TEST_PLAN.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -97
- package/package-source/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +6 -5
- package/package-source/docs/codex-harness-engineering/templates/testing/coverage-policy.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/testing/e2e-plan.md +139 -139
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-findings.example.json +3 -3
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-triage.md +62 -62
- package/package-source/docs/codex-harness-engineering/templates/testing/test-data-plan.md +36 -36
- package/package-source/docs/codex-harness-engineering/templates/testing/test-report.md +85 -41
- package/package-source/docs/codex-harness-engineering/templates/testing/verify-matrix.md +15 -5
- package/package-source/docs/codex-harness-engineering/templates/tools/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/acceptance-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/architecture-lint.ps1 +150 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/backend-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/business-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/component-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/config-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/context-lint.ps1 +187 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/contract-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/data-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/directory-lint.ps1 +152 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/docs-lint.ps1 +40 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/impact-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/integration-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/mobile-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/observability-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/performance-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/refactor-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/security-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/session-lint.ps1 +126 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/spec-lint.ps1 +285 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/state-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/style-lint.ps1 +155 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/testing-lint.ps1 +192 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/ui-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/eval-case.yaml +24 -24
- package/package-source/docs/codex-harness-engineering/templates/trace/trace.schema.json +101 -101
- package/package-source/install-manifest.json +149 -79
- package/package-source/tools/install/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/tools/install/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/tools/install/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/tools/install/bootstrap-codex-harness.ps1 +145 -129
- package/package-source/tools/install/env-check.ps1 +40 -40
- package/package-source/tools/install/init-project.ps1 +1 -1
- package/package-source/tools/install/install-agent-here.ps1 +57 -57
- package/package-source/tools/install/install-agent.ps1 +33 -31
- package/package.json +23 -23
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
| 场景 | 推荐入口 | 说明 |
|
|
8
8
|
| --- | --- | --- |
|
|
9
|
-
| 第一次接入 Harness | `tools\\install/init-project.ps1` | thin 初始化 `AGENTS.md`、`tools/harness/*`、`.codex/`、`.codex-harness/`、`docs/ai/`、`docs/architecture/` 和 `docs/spec/` |
|
|
10
|
-
| spec / plan 已确认,准备切主控 | `tools/harness/templates/project-task-template.json` -> `task.json` -> `tools/harness/codex-loop.ps1 -RunUntilDone` | 交互模式在这里结束,后续默认由 driver 接管 |
|
|
11
|
-
| 单个需求串行实现 | `tools/harness/codex-loop.ps1 -RunUntilDone` | 一个 Git 工作区里按 `task.json` 优先级逐个完成任务 |
|
|
9
|
+
| 第一次接入 Harness | `tools\\install/init-project.ps1` | thin 初始化 `AGENTS.md`、`tools/harness/*`、`.codex/`、`.codex-harness/`、`docs/ai/`、`docs/architecture/` 和 `docs/spec/` |
|
|
10
|
+
| spec / plan 已确认,准备切主控 | `tools/harness/templates/project-task-template.json` -> `task.json` -> `tools/harness/codex-loop.ps1 -RunUntilDone` | 交互模式在这里结束,后续默认由 driver 接管 |
|
|
11
|
+
| 单个需求串行实现 | `tools/harness/codex-loop.ps1 -RunUntilDone` | 一个 Git 工作区里按 `task.json` 优先级逐个完成任务 |
|
|
12
12
|
| 需要沉淀项目经验 | `docs/knowledge/knowledge-catalog.md` -> `ARCHIVE-001` | 任务结束后把可复用经验归档为知识条目 |
|
|
13
13
|
| 既有项目冷启动知识库 | `docs/harness/knowledge-import.md` | 从 README、docs、代码结构、issue/review 中提取 draft 条目 |
|
|
14
14
|
| 维护知识库健康 | `docs/harness/knowledge-lint.md` | 检查索引、孤儿条目、重复、冲突、成熟度和长期未引用条目 |
|
|
@@ -20,39 +20,67 @@
|
|
|
20
20
|
|
|
21
21
|
| 模式 | 命令入口 | 输出内容 |
|
|
22
22
|
| --- | --- | --- |
|
|
23
|
-
| `project` | `tools\\install/init-project.ps1` / `tools\\install/install-agent.ps1 -ProjectRoot . -Scope project` | 新默认 thin project 入口,只输出项目运行必需内容 |
|
|
24
|
-
| `full` | `tools\\install/install-agent.ps1 -Mode full` | 显式 legacy full 入口,同时安装项目 runtime、`.agents/` vendor 包和共享资源 |
|
|
25
|
-
| `vendor` | `tools\\install/install-agent.ps1 -Mode vendor` / `tools\\install/install-agent.ps1 -Scope vendor` | 只复制 `.agents/` vendor 包,适合离线或强隔离场景 |
|
|
26
|
-
| `user` | `tools\\install/install-user.ps1` / `tools\\install/install-agent.ps1 -Scope user` | 只写入 `%USERPROFILE%/.codex/packages/codex-harness/` 下的 package source 和 user lock |
|
|
27
|
-
|
|
28
|
-
`full` 行为作为显式 legacy 兼容入口保留。当前包已经提供 package lock、只读升级/卸载计划、安全 `-Upgrade` 和 vendor `-Uninstall`。新分层入口优先使用 wrapper 或等价 `-Scope user|project|vendor` 命令:`tools\\install/install-user.ps1` 等价于 `tools\\install/install-agent.ps1 -Scope user`,`tools\\install/init-project.ps1` 等价于 `tools\\install/install-agent.ps1 -ProjectRoot . -Scope project`。当前不提供 `harness install-user` 子命令。当前不提供 `harness init-project` 子命令。Windows PowerShell 主链路请直接运行这两个 wrapper,避免误以为存在独立 CLI。`-Scope project` 与无参数 `tools\\install/install-agent.ps1 -ProjectRoot .` 等价,都是新项目默认 thin 输出,只生成项目运行必需 runtime、项目级 `.agents/` active surface、`.codex/`、`.codex-harness/state/config.json`、`.codex-harness/locks/package.lock.json`、`.codex-harness/manifests/install-manifest.json`、`docs/ai/`、`docs/architecture/constraints.md`、`docs/spec/01..14` 和 `tools/`,不复制完整 vendor 镜像、`docs/harness/`、`docs/testing/`、`docs/knowledge/` 或 `docs/requirement-prep-kit/`。`-Scope user` 只安装用户级 package source 并写入用户级 lock。
|
|
23
|
+
| `project` | `tools\\install/init-project.ps1` / `tools\\install/install-agent.ps1 -ProjectRoot . -Scope project` | 新默认 thin project 入口,只输出项目运行必需内容 |
|
|
24
|
+
| `full` | `tools\\install/install-agent.ps1 -Mode full` | 显式 legacy full 入口,同时安装项目 runtime、`.agents/` vendor 包和共享资源 |
|
|
25
|
+
| `vendor` | `tools\\install/install-agent.ps1 -Mode vendor` / `tools\\install/install-agent.ps1 -Scope vendor` | 只复制 `.agents/` vendor 包,适合离线或强隔离场景 |
|
|
26
|
+
| `user` | `tools\\install/install-user.ps1` / `tools\\install/install-agent.ps1 -Scope user` | 只写入 `%USERPROFILE%/.codex/packages/codex-harness/` 下的 package source 和 user lock |
|
|
27
|
+
|
|
28
|
+
`full` 行为作为显式 legacy 兼容入口保留。当前包已经提供 package lock、只读升级/卸载计划、安全 `-Upgrade` 和 vendor `-Uninstall`。新分层入口优先使用 wrapper 或等价 `-Scope user|project|vendor` 命令:`tools\\install/install-user.ps1` 等价于 `tools\\install/install-agent.ps1 -Scope user`,`tools\\install/init-project.ps1` 等价于 `tools\\install/install-agent.ps1 -ProjectRoot . -Scope project`。当前不提供 `harness install-user` 子命令。当前不提供 `harness init-project` 子命令。Windows PowerShell 主链路请直接运行这两个 wrapper,避免误以为存在独立 CLI。`-Scope project` 与无参数 `tools\\install/install-agent.ps1 -ProjectRoot .` 等价,都是新项目默认 thin 输出,只生成项目运行必需 runtime、项目级 `.agents/` active surface、`.codex/`、`.codex-harness/state/config.json`、`.codex-harness/locks/package.lock.json`、`.codex-harness/manifests/install-manifest.json`、`docs/ai/`、`docs/architecture/constraints.md`、`docs/spec/01..14` 和 `tools/`,不复制完整 vendor 镜像、`docs/harness/`、`docs/testing/`、`docs/knowledge/` 或 `docs/requirement-prep-kit/`。`-Scope user` 只安装用户级 package source 并写入用户级 lock。
|
|
29
|
+
|
|
30
|
+
## `docs/ai/` 导航层
|
|
31
|
+
|
|
32
|
+
- `repo-map.md`
|
|
33
|
+
- `architecture-brief.md`
|
|
34
|
+
- `CURRENT_TASK.md`
|
|
35
|
+
- `PROJECT_CONTEXT.md`
|
|
36
|
+
- `DECISIONS.md`
|
|
37
|
+
- `API_MAP.md`
|
|
38
|
+
- `DB_SCHEMA.md`
|
|
39
|
+
- `KNOWN_ISSUES.md`
|
|
40
|
+
- `CHANGELOG_AI.md`
|
|
41
|
+
|
|
42
|
+
推荐顺序:
|
|
43
|
+
|
|
44
|
+
1. 先裁剪 `repo-map.md` 和 `architecture-brief.md`
|
|
45
|
+
2. 再补 `CURRENT_TASK.md`
|
|
46
|
+
3. 复杂项目再补 `PROJECT_CONTEXT.md`、`DECISIONS.md`、`API_MAP.md`、`DB_SCHEMA.md`
|
|
47
|
+
4. 把长期可复用经验沉淀到 `docs/knowledge/*`
|
|
48
|
+
|
|
49
|
+
接入完成后,建议再确认项目最小文档集是否齐全:
|
|
50
|
+
|
|
51
|
+
- `AGENTS.md`
|
|
52
|
+
- `README.md`
|
|
53
|
+
- `docs/architecture/constraints.md` 或等价架构 truth source
|
|
54
|
+
- `docs/ai/repo-map.md`
|
|
55
|
+
- `docs/ai/CURRENT_TASK.md`
|
|
56
|
+
- `docs/testing/TEST_STRATEGY.md`
|
|
29
57
|
|
|
30
58
|
```powershell
|
|
31
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-user.ps1
|
|
32
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/init-project.ps1
|
|
33
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Scope vendor
|
|
59
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-user.ps1
|
|
60
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/init-project.ps1
|
|
61
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Scope vendor
|
|
34
62
|
```
|
|
35
63
|
|
|
36
|
-
直接运行 `tools\\install/bootstrap-codex-harness.ps1` 或旧 `-Mode project` 仍使用 legacy profile,适合需要保留完整 harness 文档包的旧项目;新项目默认使用 `tools\\install/init-project.ps1` 或等价 `-ProjectRoot . -Scope project`。
|
|
64
|
+
直接运行 `tools\\install/bootstrap-codex-harness.ps1` 或旧 `-Mode project` 仍使用 legacy profile,适合需要保留完整 harness 文档包的旧项目;新项目默认使用 `tools\\install/init-project.ps1` 或等价 `-ProjectRoot . -Scope project`。
|
|
37
65
|
|
|
38
66
|
`tools/harness/doctor.ps1` 会按 `installScope=project` 检查 thin 输出:缺少 `.codex-harness/manifests/install-manifest.json` 会提示 warning,snapshot JSON 非法、`docs/architecture/constraints.md` 或 `docs/spec/01..14` 缺失会失败;发现 `.agents/`、`docs/harness/`、`docs/testing/`、`docs/knowledge/` 或 `docs/requirement-prep-kit/` 时只提示 legacy 残留 warning,不会自动删除。
|
|
39
67
|
|
|
40
68
|
Phase 7 切换门禁先看 doctor 的 readiness 汇总:
|
|
41
69
|
|
|
42
70
|
- `Readiness gate: PASS` 且 `ProjectShape: thin-project`:项目已满足 thin 前置条件。
|
|
43
|
-
- `ProjectShape: thin-project-missing-user-package`:先运行 `powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-user.ps1`,再重新运行 `tools/harness/doctor.ps1`。
|
|
71
|
+
- `ProjectShape: thin-project-missing-user-package`:先运行 `powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-user.ps1`,再重新运行 `tools/harness/doctor.ps1`。
|
|
44
72
|
- `ProjectShape: thin-project-with-legacy-residue` 或 `legacy-full-project`:先运行 `-MigratePlan` 查看分类,再按报告决定是否运行 `-MigrateApply -Confirm`。
|
|
45
|
-
- `ProjectShape: vendor-project`:保留 vendor 模式时运行 `powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Scope vendor` 或重新运行 `tools/harness/doctor.ps1` 复核 drift。
|
|
46
|
-
- `ProjectShape: not-installed`:先运行 `powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/init-project.ps1`。
|
|
73
|
+
- `ProjectShape: vendor-project`:保留 vendor 模式时运行 `powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Scope vendor` 或重新运行 `tools/harness/doctor.ps1` 复核 drift。
|
|
74
|
+
- `ProjectShape: not-installed`:先运行 `powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/init-project.ps1`。
|
|
47
75
|
|
|
48
76
|
readiness gate 只读;它只报告阻断项和 `FixCommand`,不会自动安装、迁移、删除或覆盖项目文件。
|
|
49
77
|
|
|
50
78
|
已有 legacy `.agents/` 项目不要直接清理目录。先运行只读迁移计划:
|
|
51
79
|
|
|
52
80
|
```powershell
|
|
53
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -MigratePlan
|
|
54
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -MigrateApply
|
|
55
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -MigrateApply -Confirm
|
|
81
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -MigratePlan
|
|
82
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -MigrateApply
|
|
83
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -MigrateApply -Confirm
|
|
56
84
|
```
|
|
57
85
|
|
|
58
86
|
操作顺序固定为:
|
|
@@ -74,15 +102,15 @@ powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-age
|
|
|
74
102
|
已安装项目先用只读计划判断风险:
|
|
75
103
|
|
|
76
104
|
```powershell
|
|
77
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -UpgradePlan
|
|
78
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -UninstallPlan
|
|
105
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -UpgradePlan
|
|
106
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -UninstallPlan
|
|
79
107
|
```
|
|
80
108
|
|
|
81
109
|
计划中没有 `blocked-user-drift` 时,才执行写入命令:
|
|
82
110
|
|
|
83
111
|
```powershell
|
|
84
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Upgrade
|
|
85
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Uninstall
|
|
112
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Upgrade
|
|
113
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-agent.ps1 -ProjectRoot . -Uninstall
|
|
86
114
|
```
|
|
87
115
|
|
|
88
116
|
`-Upgrade` 只覆盖 lock 记录中未发生用户 drift 的不可变文件,并刷新 `.codex-harness/locks/package.lock.json`。`-Uninstall` 只删除 lock 中 `scope=vendor` 的 managed files,保留 project scope 和 user scope。
|
|
@@ -106,18 +134,21 @@ powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/install-age
|
|
|
106
134
|
3. 如果是 legacy 未分类文件,保留现状,等后续独立任务补逐项确认机制。
|
|
107
135
|
4. 如果 dry-run 出现非空 `actualWrites`,说明执行边界异常,停止继续操作并回退到计划阶段排查。
|
|
108
136
|
|
|
109
|
-
## 1. 初始化
|
|
110
|
-
|
|
111
|
-
```powershell
|
|
112
|
-
git status --short
|
|
113
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/init-project.ps1
|
|
114
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\
|
|
115
|
-
|
|
137
|
+
## 1. 初始化
|
|
138
|
+
|
|
139
|
+
```powershell
|
|
140
|
+
git status --short
|
|
141
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/init-project.ps1
|
|
142
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\install/env-check.ps1
|
|
143
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\harness/doctor.ps1
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
如果项目存在 `build`、`lint`、`test`、`typecheck`、`docker build` 或 CI workflow,首次接入时应同时把这些命令和环境变量依赖补到 `docs/harness/env-and-deployment-template.md`,不要只留在 `package.json` 或 CI 配置里。
|
|
116
147
|
|
|
117
148
|
## 2. 创建任务
|
|
118
149
|
|
|
119
150
|
```powershell
|
|
120
|
-
Copy-Item .\tools\harness\templates\tools/harness/templates/project-task-template.json .\task.json
|
|
151
|
+
Copy-Item .\tools\harness\templates\tools/harness/templates/project-task-template.json .\task.json
|
|
121
152
|
```
|
|
122
153
|
|
|
123
154
|
建议 `runtime.git` 使用:
|
|
@@ -129,21 +160,54 @@ Copy-Item .\tools\harness\templates\tools/harness/templates/project-task-templat
|
|
|
129
160
|
}
|
|
130
161
|
```
|
|
131
162
|
|
|
132
|
-
## 3. 运行 Driver
|
|
133
|
-
|
|
134
|
-
```powershell
|
|
135
|
-
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\harness/codex-loop.ps1 -RunUntilDone
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
|
|
163
|
+
## 3. 运行 Driver
|
|
164
|
+
|
|
165
|
+
```powershell
|
|
166
|
+
powershell -NoProfile -ExecutionPolicy Bypass -File .\tools\\harness/codex-loop.ps1 -RunUntilDone
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### 3.1 内容门禁怎么配
|
|
170
|
+
|
|
171
|
+
建议在项目 `task.json` 里显式写出默认门禁档位:
|
|
172
|
+
|
|
173
|
+
```json
|
|
174
|
+
{
|
|
175
|
+
"runtime": {
|
|
176
|
+
"content_gates": {
|
|
177
|
+
"default_mode": "core"
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
门禁分层:
|
|
184
|
+
|
|
185
|
+
- `core`:默认档位,适合新项目冷启动
|
|
186
|
+
- `recommended`:适合团队已经稳定维护文档和测试 truth source 的项目
|
|
187
|
+
- `full`:只适合非常重治理的项目,不建议作为新项目默认值
|
|
188
|
+
- `risk_tags`:只给高风险任务启用专项门禁,例如 `security`、`data`、`integration`、`mobile`
|
|
189
|
+
|
|
190
|
+
示例:
|
|
191
|
+
|
|
192
|
+
```json
|
|
193
|
+
{
|
|
194
|
+
"id": "ORDER-001",
|
|
195
|
+
"task_kind": "feature_impl",
|
|
196
|
+
"risk_tags": ["security", "data"]
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
- `.codex/agents/*.toml` 同时提供只读辅助子代理和写入型 worker 子代理。
|
|
139
201
|
- 这些子代理开始前必须先读 `AGENTS.md`、`docs/harness/task-session-strategy.md`、`.codex/rules/agents.md` 和对应 `.agents/skills/*/SKILL.md`(如存在)。
|
|
140
202
|
- 如果是被 stop hook 拦下后继续执行的下一轮,也先按上面这组文档重读一遍,再决定是否启用子代理。
|
|
141
203
|
- 如果主控需要更新 `task.json`、`AGENTS.md`、`.codex/*`、`.codex/rules/*`、`docs/harness/*`、prompt 或其他非 driver 内容,必须委派 `harness-writer`、`docs-worker` 或匹配的实现 worker,不能由主控会话自己写。
|
|
142
|
-
- 目标项目的 `.agents/` 默认不再复制项目运行时用的 `.codex/` 或 `docs/harness/`;这些内容直接安装到项目根。为了支持安装后的再次 bootstrap,`.agents/docs/codex-harness-engineering/templates/` 会保留模板复制源。
|
|
143
|
-
- `docs/
|
|
144
|
-
-
|
|
145
|
-
-
|
|
146
|
-
-
|
|
204
|
+
- 目标项目的 `.agents/` 默认不再复制项目运行时用的 `.codex/` 或 `docs/harness/`;这些内容直接安装到项目根。为了支持安装后的再次 bootstrap,`.agents/docs/codex-harness-engineering/templates/` 会保留模板复制源。
|
|
205
|
+
- `docs/ai/` 是项目导航层;默认先读 `repo-map.md`、`architecture-brief.md`、`CURRENT_TASK.md`。
|
|
206
|
+
- `docs/knowledge/` 是项目级知识层;实现会话按 `knowledge-catalog.md`、`catalog.md`、具体条目的顺序按需读取,归档任务负责更新索引。
|
|
207
|
+
- 已有项目接入时,可先按 `docs/harness/knowledge-import.md` 冷启动 5-13 条 draft 知识;导入过程用 `import-state.json` 或导入报告记录 processed/pending/skipped/low_confidence 来源和 resume cursor,后续任务通过引用和验证逐步提升成熟度。
|
|
208
|
+
- 每隔一段任务后,按 `docs/harness/knowledge-lint.md` 检查索引一致、重复、冲突和长期未引用条目。
|
|
209
|
+
- 如果团队维护独立知识库,按 `docs/harness/team-knowledge-sync.md` 把跨项目候选写入 `contributions/pending/`;该同步失败只能降级为候选报告,不能阻塞本地实现验证。
|
|
210
|
+
- 如果需要接入 MCP、外部文档或代码语义工具,先读 `docs/harness/mcp-knowledge-governance.md` 和 `docs/harness/code-semantics-and-navigation.md`。
|
|
147
211
|
|
|
148
212
|
## 4. UI 项目要求
|
|
149
213
|
|
package/package-source/docs/codex-harness-engineering/templates/docs/project-agents-template.md
CHANGED
|
@@ -1,154 +1,211 @@
|
|
|
1
|
-
# Project AGENTS.md Template
|
|
2
|
-
|
|
3
|
-
本文是生成项目根 `AGENTS.md` 的通用模板,不应原样复制后长期保留占位符。生成时先分析项目事实,再按项目类型裁剪章节。
|
|
4
|
-
|
|
5
|
-
## 使用原则
|
|
6
|
-
|
|
7
|
-
- `AGENTS.md` 是给编码 Agent 的入口规则,不是 README 的复刻。
|
|
8
|
-
- 只写会改变 Agent 行为的项目特定信息;通用工程常识、formatter/linter 已覆盖的内容不要写。
|
|
9
|
-
- 根 `AGENTS.md` 保持短入口,建议 60-120 行;细节放到 `docs/`、`rules/`、`specs/` 或测试文档,并在入口索引引用。
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
|
23
|
-
|
|
|
24
|
-
|
|
|
25
|
-
|
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
-
|
|
137
|
-
-
|
|
138
|
-
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
1
|
+
# Project AGENTS.md Template
|
|
2
|
+
|
|
3
|
+
本文是生成项目根 `AGENTS.md` 的通用模板,不应原样复制后长期保留占位符。生成时先分析项目事实,再按项目类型裁剪章节。
|
|
4
|
+
|
|
5
|
+
## 使用原则
|
|
6
|
+
|
|
7
|
+
- `AGENTS.md` 是给编码 Agent 的入口规则,不是 README 的复刻。
|
|
8
|
+
- 只写会改变 Agent 行为的项目特定信息;通用工程常识、formatter/linter 已覆盖的内容不要写。
|
|
9
|
+
- 根 `AGENTS.md` 保持短入口,建议 60-120 行;细节放到 `docs/`、`rules/`、`specs/` 或测试文档,并在入口索引引用。
|
|
10
|
+
- 根 `AGENTS.md` 只写全项目都成立的入口规则;目录独有的模块职责、边界、入口、测试命令、坑点和禁止事项,优先写进最接近该目录的子目录 `AGENTS.md`。
|
|
11
|
+
- 如果项目同时维护模板源、镜像和运行时副本,先确认哪一份是 canonical;默认优先修改模板 canonical,再同步活跃副本,不要只修当前工作区现状。
|
|
12
|
+
- 每条禁令必须给替代方案;不能说明替代方案的内容先写成风险或待确认项。
|
|
13
|
+
- 可以自动检查的规则优先进入 lint、schema、hook、CI、verify 脚本,不只依赖文字提醒。
|
|
14
|
+
- 规则从 Bad Case 迭代:重复 review 问题、线上事故、新人必踩坑、Agent 反复犯错,才升级为入口规则。
|
|
15
|
+
- `project_doc_fallback_filenames` 只在目录缺少 `AGENTS.md` 时生效;生成了根 `AGENTS.md` 的项目,不要再依赖 fallback 文件作为额外入口。
|
|
16
|
+
- 不用 `developer_instructions` 或 `model_instructions_file` 承载普通项目规则;这些是 config 层上下文入口,默认应保持为空。
|
|
17
|
+
|
|
18
|
+
## 生成前事实扫描
|
|
19
|
+
|
|
20
|
+
先收集这些事实,再填模板:
|
|
21
|
+
|
|
22
|
+
| 事实 | 来源 |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| 项目类型 | README、目录结构、启动脚本、部署文件 |
|
|
25
|
+
| 技术栈 | `package.json`、`pyproject.toml`、`go.mod`、`pom.xml`、Dockerfile |
|
|
26
|
+
| 常用命令 | scripts、Makefile、CI、现有 docs |
|
|
27
|
+
| 架构边界 | `src/`、`apps/`、`packages/`、`services/`、`docs/architecture*` |
|
|
28
|
+
| 代码地图 | `docs/ai/repo-map.md`、`codemaps/*`、架构索引或模块清单 |
|
|
29
|
+
| 测试入口 | test scripts、`tests/`、Playwright/Cypress/Pytest/Vitest 配置 |
|
|
30
|
+
| 自动化检查 | linter、formatter、typecheck、CI、hooks |
|
|
31
|
+
| 命名与业务词典 | `docs/harness/code-style-and-naming.md`、`docs/code-style.md`、接口 / 数据字典 |
|
|
32
|
+
| 私域知识 | 内部组件库、私有 API、特殊目录、历史迁移约束 |
|
|
33
|
+
| Bad Case | 近期 review、bug 标签、trace、失败复盘、团队反复纠正事项 |
|
|
34
|
+
|
|
35
|
+
最小核心文档集建议至少覆盖:
|
|
36
|
+
|
|
37
|
+
- `AGENTS.md`
|
|
38
|
+
- `README.md`
|
|
39
|
+
- `docs/architecture.md`
|
|
40
|
+
- `docs/code-style.md`
|
|
41
|
+
- `docs/api-convention.md`
|
|
42
|
+
- `docs/component-map.md`
|
|
43
|
+
- `docs/test-strategy.md`
|
|
44
|
+
- `docs/current-task.md`
|
|
45
|
+
|
|
46
|
+
## 根 AGENTS.md 模板
|
|
47
|
+
|
|
48
|
+
```markdown
|
|
49
|
+
# AGENTS.md
|
|
50
|
+
|
|
51
|
+
本文件只保留当前项目中每次编码会话都必须知道的规则。更详细的背景、接口、测试和部署说明见下方索引。
|
|
52
|
+
|
|
53
|
+
## 项目边界
|
|
54
|
+
|
|
55
|
+
- 项目类型:<应用 / 库 / monorepo / harness / 模板 / 服务端 / 前端 / 全栈>
|
|
56
|
+
- 主要技术栈:<只列非默认且会影响实现选择的技术>
|
|
57
|
+
- 真实入口:<启动、构建、测试、driver 或任务系统入口>
|
|
58
|
+
- 代码地图:`<docs/ai/repo-map.md 或同类导航文件>`;需要理解模块位置时先读它,再进入具体目录。
|
|
59
|
+
- 如果存在目录级 `AGENTS.md`:进入对应目录后同时遵守根规则和本地规则。
|
|
60
|
+
- 不要把 README 的业务介绍复制到这里;README 回答“项目是什么”,本文件回答“Agent 怎么改”。
|
|
61
|
+
|
|
62
|
+
## 模板与 Canonical
|
|
63
|
+
|
|
64
|
+
- 如果仓库同时存在模板源、运行时副本、镜像或 package-assets:先说明哪一份是 canonical。
|
|
65
|
+
- 默认修改顺序:`<template canonical>` -> `<active mirror>` -> `<runtime copy>`。
|
|
66
|
+
- 不要只修当前工作区现状而漏掉模板源。
|
|
67
|
+
|
|
68
|
+
## 常用命令
|
|
69
|
+
|
|
70
|
+
| 场景 | 命令 | 说明 |
|
|
71
|
+
| --- | --- | --- |
|
|
72
|
+
| 安装 | `<command>` | <必要前提或包管理器> |
|
|
73
|
+
| 开发 | `<command>` | <端口 / 环境变量 / mock 说明> |
|
|
74
|
+
| 测试 | `<command>` | <默认测试范围> |
|
|
75
|
+
| 类型 / lint | `<command>` | <失败时处理方式> |
|
|
76
|
+
| 构建 | `<command>` | <产物路径或限制> |
|
|
77
|
+
|
|
78
|
+
## 架构与目录规则
|
|
79
|
+
|
|
80
|
+
| 场景 | 应使用 | 不要使用 |
|
|
81
|
+
| --- | --- | --- |
|
|
82
|
+
| <例如 API 入口> | `<path/helper>` | <禁止路径或绕路方式> |
|
|
83
|
+
| <例如状态管理> | `<existing-pattern>` | <不要引入的新库> |
|
|
84
|
+
| <例如数据访问> | `<repository/service>` | <不要跨层调用> |
|
|
85
|
+
|
|
86
|
+
常见可直接复用的规则样板:
|
|
87
|
+
|
|
88
|
+
```text
|
|
89
|
+
前端:
|
|
90
|
+
- 页面只负责展示和组合
|
|
91
|
+
- 业务逻辑放 hooks
|
|
92
|
+
- 接口请求放 services
|
|
93
|
+
- 类型放 types
|
|
94
|
+
- 常量放 constants
|
|
95
|
+
- 公共组件放 components/common
|
|
96
|
+
|
|
97
|
+
后端:
|
|
98
|
+
- Controller 只处理请求和响应
|
|
99
|
+
- Service 处理业务逻辑
|
|
100
|
+
- Repository/DAO 处理数据库
|
|
101
|
+
- DTO 处理输入输出结构
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## 项目硬约束
|
|
105
|
+
|
|
106
|
+
- <CRITICAL 规则 1>;替代方案:<明确可执行做法>。
|
|
107
|
+
- <CRITICAL 规则 2>;替代方案:<明确可执行做法>。
|
|
108
|
+
- <安全 / 数据 / 权限 / 迁移 / 发布红线>;替代方案:<明确可执行做法>。
|
|
109
|
+
|
|
110
|
+
常见禁止事项样板:
|
|
111
|
+
|
|
112
|
+
```text
|
|
113
|
+
- 禁止在页面组件中直接请求接口;替代方案:统一走 services / API client。
|
|
114
|
+
- 禁止重复封装 axios/fetch;替代方案:复用现有 HTTP client。
|
|
115
|
+
- 禁止在公共组件里写业务逻辑;替代方案:把业务逻辑下沉到 feature 或 hooks。
|
|
116
|
+
- 禁止绕过权限系统;替代方案:复用既有权限入口或 policy。
|
|
117
|
+
- 禁止新增 utils2、common2、helper2 这类目录;替代方案:放回既有模块或补目录级规则后再新增。
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## 测试与完成定义
|
|
121
|
+
|
|
122
|
+
- 修改 <模块/路径> 后至少运行 `<command>`。
|
|
123
|
+
- 涉及 <API/业务流/权限/支付/外部系统> 时,必须补充 <单元/集成/E2E/契约/真实环境 smoke> 证据。
|
|
124
|
+
- 完成声明必须包含实际运行过的命令和结果;不要只说“应该可以”。
|
|
125
|
+
|
|
126
|
+
## 工作区与提交
|
|
127
|
+
|
|
128
|
+
- 开始前检查 `git status --short`;不要覆盖用户未说明的改动。
|
|
129
|
+
- 只修改与当前任务相关的文件。
|
|
130
|
+
- 禁止使用破坏性 Git 命令,除非用户明确要求。
|
|
131
|
+
- 提交前运行与改动匹配的验证命令。
|
|
132
|
+
|
|
133
|
+
## 深文档索引
|
|
134
|
+
|
|
135
|
+
- 架构:`<docs/architecture.md>`
|
|
136
|
+
- 代码地图:`<docs/ai/repo-map.md>`
|
|
137
|
+
- 代码风格 / 命名:`<docs/harness/code-style-and-naming.md 或 docs/code-style.md>`
|
|
138
|
+
- API / 契约:`<docs/api.md>`
|
|
139
|
+
- 测试策略:`<docs/testing.md>`
|
|
140
|
+
- 部署 / 运维:`<docs/deploy.md>`
|
|
141
|
+
- 历史坑 / 项目知识:`<docs/knowledge/>`
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## 子目录 AGENTS.md 模板
|
|
145
|
+
|
|
146
|
+
只有 monorepo 或目录规则明显不同时才添加子目录 `AGENTS.md`。子目录规则应比根规则更具体。
|
|
147
|
+
|
|
148
|
+
````markdown
|
|
149
|
+
# <path> AGENTS.md
|
|
150
|
+
|
|
151
|
+
## 作用范围
|
|
152
|
+
|
|
153
|
+
- 本文件只适用于 `<path>/` 下的改动。
|
|
154
|
+
- 根 `AGENTS.md` 仍然有效;本文件只补充或收紧本目录规则。
|
|
155
|
+
|
|
156
|
+
## 本目录约束
|
|
157
|
+
|
|
158
|
+
- 本目录负责什么:<职责>
|
|
159
|
+
- 本目录不负责什么:<边界>
|
|
160
|
+
- 技术栈 / 框架:<目录特定信息>
|
|
161
|
+
- 入口文件:<真实入口>
|
|
162
|
+
- 修改前必须先看:<核心文件 / 规则 / 测试>
|
|
163
|
+
- 测试命令:<目录级验证命令>
|
|
164
|
+
- 常见复用对象:<组件 / hook / service / helper / fixture>
|
|
165
|
+
|
|
166
|
+
## 决策表
|
|
167
|
+
|
|
168
|
+
| 场景 | 应使用 | 不要使用 |
|
|
169
|
+
| --- | --- | --- |
|
|
170
|
+
| <场景> | <本目录模式> | <禁止做法> |
|
|
171
|
+
| 复用同类能力 | <已有组件 / hook / service / helper> | <重复新建一套实现> |
|
|
172
|
+
|
|
173
|
+
## 代码示例
|
|
174
|
+
|
|
175
|
+
```<language>
|
|
176
|
+
// 3-10 行真实项目代码,展示应该复用的模式
|
|
177
|
+
```
|
|
178
|
+
````
|
|
179
|
+
|
|
180
|
+
## CLAUDE.md 组合模板
|
|
181
|
+
|
|
182
|
+
仅当团队主要使用 Claude Code 且需要 Claude 专属能力时添加。通用规则仍放 `AGENTS.md`。
|
|
183
|
+
|
|
184
|
+
```markdown
|
|
185
|
+
# CLAUDE.md
|
|
186
|
+
|
|
187
|
+
@AGENTS.md
|
|
188
|
+
|
|
189
|
+
## Claude Code 专属规则
|
|
190
|
+
|
|
191
|
+
- 使用 hooks / commands / memory 的项目约定:<只写 Claude Code 独有内容>。
|
|
192
|
+
- 个人本地偏好放 `CLAUDE.local.md`,不要提交。
|
|
193
|
+
- 不要在这里重复 `AGENTS.md` 已有规则。
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
## 裁剪检查
|
|
197
|
+
|
|
198
|
+
生成后逐条检查:
|
|
199
|
+
|
|
200
|
+
| 检查项 | 处理 |
|
|
201
|
+
| --- | --- |
|
|
202
|
+
| 是否超过 120 行 | 下沉细节到深文档,只保留索引 |
|
|
203
|
+
| 是否复制 README 项目介绍 | 删除,改为 README 链接 |
|
|
204
|
+
| 是否包含通用编码常识 | 删除 |
|
|
205
|
+
| 是否缺少代码地图入口 | 新增 `docs/ai/repo-map.md` 或说明为什么项目太小不需要 |
|
|
206
|
+
| 是否把目录级规则堆在根 AGENTS.md | 下沉到最接近适用范围的子目录 `AGENTS.md` |
|
|
207
|
+
| 是否没有说明 canonical | 补充模板源 / 活跃副本 / 运行时副本的优先级 |
|
|
208
|
+
| 禁令是否没有替代方案 | 补替代方案或降级为风险 |
|
|
209
|
+
| 是否引用不存在的命令或路径 | 修正或删除 |
|
|
210
|
+
| 自动化可检查的内容是否只写文字 | 补充脚本 / hook / CI / verify 入口 |
|
|
211
|
+
| 深文档是否无法从入口发现 | 加入索引 |
|