@open-agent-toolkit/cli 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/assets/agents/oat-codebase-mapper.md +275 -0
- package/assets/agents/oat-reviewer.md +350 -0
- package/assets/agents/skeptical-evaluator.md +126 -0
- package/assets/docs/contributing/code.md +95 -0
- package/assets/docs/contributing/commit-conventions.md +41 -0
- package/assets/docs/contributing/design-principles.md +124 -0
- package/assets/docs/contributing/documentation.md +69 -0
- package/assets/docs/contributing/hooks-and-safety.md +31 -0
- package/assets/docs/contributing/index.md +18 -0
- package/assets/docs/contributing/markdown-features.md +117 -0
- package/assets/docs/contributing/skills.md +68 -0
- package/assets/docs/guide/cli-reference.md +211 -0
- package/assets/docs/guide/concepts.md +88 -0
- package/assets/docs/guide/configuration.md +130 -0
- package/assets/docs/guide/documentation/commands.md +157 -0
- package/assets/docs/guide/documentation/index.md +27 -0
- package/assets/docs/guide/documentation/quickstart.md +164 -0
- package/assets/docs/guide/documentation/workflows.md +67 -0
- package/assets/docs/guide/getting-started.md +63 -0
- package/assets/docs/guide/ideas/index.md +34 -0
- package/assets/docs/guide/ideas/lifecycle.md +106 -0
- package/assets/docs/guide/index.md +20 -0
- package/assets/docs/guide/provider-sync/commands.md +100 -0
- package/assets/docs/guide/provider-sync/config.md +77 -0
- package/assets/docs/guide/provider-sync/index.md +65 -0
- package/assets/docs/guide/provider-sync/manifest-and-drift.md +55 -0
- package/assets/docs/guide/provider-sync/providers.md +67 -0
- package/assets/docs/guide/provider-sync/scope-and-surface.md +64 -0
- package/assets/docs/guide/skills/index.md +115 -0
- package/assets/docs/guide/tool-packs.md +167 -0
- package/assets/docs/guide/workflow/artifacts.md +44 -0
- package/assets/docs/guide/workflow/hill-checkpoints.md +53 -0
- package/assets/docs/guide/workflow/index.md +34 -0
- package/assets/docs/guide/workflow/lifecycle.md +207 -0
- package/assets/docs/guide/workflow/pr-flow.md +55 -0
- package/assets/docs/guide/workflow/repo-analysis.md +96 -0
- package/assets/docs/guide/workflow/reviews.md +98 -0
- package/assets/docs/guide/workflow/state-machine.md +74 -0
- package/assets/docs/index.md +45 -0
- package/assets/docs/quickstart.md +162 -0
- package/assets/docs/reference/docs-index-contract.md +53 -0
- package/assets/docs/reference/file-locations.md +109 -0
- package/assets/docs/reference/index.md +29 -0
- package/assets/docs/reference/oat-directory-structure.md +236 -0
- package/assets/docs/reference/troubleshooting.md +63 -0
- package/assets/public-package-versions.json +6 -0
- package/assets/scripts/resolve-tracking.sh +233 -0
- package/assets/skills/analyze/SKILL.md +358 -0
- package/assets/skills/compare/SKILL.md +276 -0
- package/assets/skills/create-agnostic-skill/SKILL.md +410 -0
- package/assets/skills/create-agnostic-skill/references/skill-template.md +195 -0
- package/assets/skills/deep-research/SKILL.md +350 -0
- package/assets/skills/deep-research/references/schema-analysis.md +93 -0
- package/assets/skills/deep-research/references/schema-architectural.md +75 -0
- package/assets/skills/deep-research/references/schema-base.md +70 -0
- package/assets/skills/deep-research/references/schema-comparative.md +72 -0
- package/assets/skills/deep-research/references/schema-conceptual.md +68 -0
- package/assets/skills/deep-research/references/schema-technical.md +64 -0
- package/assets/skills/oat-agent-instructions-analyze/SKILL.md +500 -0
- package/assets/skills/oat-agent-instructions-analyze/references/analysis-artifact-template.md +248 -0
- package/assets/skills/oat-agent-instructions-analyze/references/bundle-summary-template.md +31 -0
- package/assets/skills/oat-agent-instructions-analyze/references/directory-assessment-criteria.md +93 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/agent-instruction.md +575 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/cursor-rules-files.md +510 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/provider-reference.md +429 -0
- package/assets/skills/oat-agent-instructions-analyze/references/docs/rules-files.md +594 -0
- package/assets/skills/oat-agent-instructions-analyze/references/file-type-discovery-checklist.md +273 -0
- package/assets/skills/oat-agent-instructions-analyze/references/quality-checklist.md +125 -0
- package/assets/skills/oat-agent-instructions-analyze/references/recommendation-pack-template.md +45 -0
- package/assets/skills/oat-agent-instructions-analyze/references/recommendations-manifest-template.yaml +27 -0
- package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-instruction-files.sh +120 -0
- package/assets/skills/oat-agent-instructions-analyze/scripts/resolve-providers.sh +135 -0
- package/assets/skills/oat-agent-instructions-apply/SKILL.md +507 -0
- package/assets/skills/oat-agent-instructions-apply/references/apply-plan-template.md +80 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/agent-instruction.md +575 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/cursor-rules-files.md +510 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/provider-reference.md +429 -0
- package/assets/skills/oat-agent-instructions-apply/references/docs/rules-files.md +594 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/agents-md-root.md +85 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/agents-md-scoped.md +62 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/claude-rule.md +67 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/copilot-instruction.md +70 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/copilot-shim.md +35 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/frontmatter/cursor-rule.md +84 -0
- package/assets/skills/oat-agent-instructions-apply/references/instruction-file-templates/glob-scoped-rule.md +59 -0
- package/assets/skills/oat-docs/SKILL.md +214 -0
- package/assets/skills/oat-docs-analyze/SKILL.md +355 -0
- package/assets/skills/oat-docs-analyze/references/analysis-artifact-template.md +192 -0
- package/assets/skills/oat-docs-analyze/references/directory-assessment-criteria.md +46 -0
- package/assets/skills/oat-docs-analyze/references/quality-checklist.md +48 -0
- package/assets/skills/oat-docs-apply/SKILL.md +339 -0
- package/assets/skills/oat-docs-apply/references/apply-plan-template.md +69 -0
- package/assets/skills/oat-doctor/SKILL.md +293 -0
- package/assets/skills/oat-idea-ideate/SKILL.md +187 -0
- package/assets/skills/oat-idea-new/SKILL.md +152 -0
- package/assets/skills/oat-idea-scratchpad/SKILL.md +115 -0
- package/assets/skills/oat-idea-summarize/SKILL.md +172 -0
- package/assets/skills/oat-pjm-add-backlog-item/SKILL.md +155 -0
- package/assets/skills/oat-pjm-review-backlog/SKILL.md +171 -0
- package/assets/skills/oat-pjm-review-backlog/references/backlog-review-template.md +172 -0
- package/assets/skills/oat-pjm-update-repo-reference/SKILL.md +128 -0
- package/assets/skills/oat-project-capture/SKILL.md +306 -0
- package/assets/skills/oat-project-clear-active/SKILL.md +50 -0
- package/assets/skills/oat-project-complete/SKILL.md +461 -0
- package/assets/skills/oat-project-design/SKILL.md +461 -0
- package/assets/skills/oat-project-discover/SKILL.md +395 -0
- package/assets/skills/oat-project-document/SKILL.md +468 -0
- package/assets/skills/oat-project-implement/SKILL.md +736 -0
- package/assets/skills/oat-project-import-plan/SKILL.md +228 -0
- package/assets/skills/oat-project-import-plan/scripts/find-recent-provider-plans.sh +149 -0
- package/assets/skills/oat-project-new/SKILL.md +74 -0
- package/assets/skills/oat-project-next/SKILL.md +345 -0
- package/assets/skills/oat-project-open/SKILL.md +47 -0
- package/assets/skills/oat-project-plan/SKILL.md +415 -0
- package/assets/skills/oat-project-plan-writing/SKILL.md +116 -0
- package/assets/skills/oat-project-pr-final/SKILL.md +391 -0
- package/assets/skills/oat-project-pr-progress/SKILL.md +354 -0
- package/assets/skills/oat-project-progress/SKILL.md +342 -0
- package/assets/skills/oat-project-promote-spec-driven/SKILL.md +155 -0
- package/assets/skills/oat-project-quick-start/SKILL.md +363 -0
- package/assets/skills/oat-project-reconcile/SKILL.md +738 -0
- package/assets/skills/oat-project-review-provide/SKILL.md +728 -0
- package/assets/skills/oat-project-review-receive/SKILL.md +641 -0
- package/assets/skills/oat-project-review-receive-remote/SKILL.md +235 -0
- package/assets/skills/oat-project-revise/SKILL.md +316 -0
- package/assets/skills/oat-project-spec/SKILL.md +471 -0
- package/assets/skills/oat-project-subagent-implement/SKILL.md +549 -0
- package/assets/skills/oat-project-subagent-implement/examples/pattern-hill-checkpoint.md +110 -0
- package/assets/skills/oat-project-subagent-implement/examples/pattern-parallel-phases.md +118 -0
- package/assets/skills/oat-project-subagent-implement/scripts/dispatch.sh +133 -0
- package/assets/skills/oat-project-subagent-implement/scripts/reconcile.sh +182 -0
- package/assets/skills/oat-project-subagent-implement/scripts/review-gate.sh +187 -0
- package/assets/skills/oat-project-subagent-implement/tests/fixtures/sample-plan.md +234 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-dry-run.sh +126 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-hill-checkpoint.sh +127 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-reconcile.sh +254 -0
- package/assets/skills/oat-project-subagent-implement/tests/test-review-gate.sh +220 -0
- package/assets/skills/oat-project-summary/SKILL.md +227 -0
- package/assets/skills/oat-repo-knowledge-index/SKILL.md +724 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/architecture.md +83 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/concerns.md +97 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/conventions.md +100 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/integrations.md +91 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/stack.md +86 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/structure.md +88 -0
- package/assets/skills/oat-repo-knowledge-index/references/templates/testing.md +137 -0
- package/assets/skills/oat-repo-maintainability-review/SKILL.md +198 -0
- package/assets/skills/oat-repo-maintainability-review/references/dx-checklist.md +33 -0
- package/assets/skills/oat-repo-maintainability-review/references/repo-review-artifact-template.md +72 -0
- package/assets/skills/oat-repo-maintainability-review/references/repo-review-rubric.md +66 -0
- package/assets/skills/oat-repo-maintainability-review/scripts/resolve-analysis-output.sh +162 -0
- package/assets/skills/oat-review-provide/SKILL.md +231 -0
- package/assets/skills/oat-review-provide/references/review-artifact-template.md +55 -0
- package/assets/skills/oat-review-provide/scripts/resolve-review-output.sh +124 -0
- package/assets/skills/oat-review-receive/SKILL.md +238 -0
- package/assets/skills/oat-review-receive-remote/SKILL.md +250 -0
- package/assets/skills/oat-worktree-bootstrap/SKILL.md +208 -0
- package/assets/skills/oat-worktree-bootstrap/references/worktree-conventions.md +58 -0
- package/assets/skills/oat-worktree-bootstrap-auto/SKILL.md +245 -0
- package/assets/skills/oat-worktree-bootstrap-auto/scripts/bootstrap.sh +194 -0
- package/assets/skills/skeptic/SKILL.md +261 -0
- package/assets/skills/synthesize/SKILL.md +361 -0
- package/assets/templates/backlog-item.md +24 -0
- package/assets/templates/design.md +315 -0
- package/assets/templates/discovery.md +135 -0
- package/assets/templates/docs-app-fuma/app/[[...slug]]/page.tsx +30 -0
- package/assets/templates/docs-app-fuma/app/api/search/route.ts +8 -0
- package/assets/templates/docs-app-fuma/app/globals.css +69 -0
- package/assets/templates/docs-app-fuma/app/layout.tsx +26 -0
- package/assets/templates/docs-app-fuma/docs/contributing.md +71 -0
- package/assets/templates/docs-app-fuma/docs/getting-started.md +40 -0
- package/assets/templates/docs-app-fuma/docs/index.md +13 -0
- package/assets/templates/docs-app-fuma/lib/source.ts +8 -0
- package/assets/templates/docs-app-fuma/next.config.js +6 -0
- package/assets/templates/docs-app-fuma/package.json.template +38 -0
- package/assets/templates/docs-app-fuma/postcss.config.mjs +7 -0
- package/assets/templates/docs-app-fuma/source.config.ts +14 -0
- package/assets/templates/docs-app-fuma/tsconfig.json +25 -0
- package/assets/templates/docs-app-mkdocs/docs/contributing.md +122 -0
- package/assets/templates/docs-app-mkdocs/docs/getting-started.md +28 -0
- package/assets/templates/docs-app-mkdocs/docs/index.md +8 -0
- package/assets/templates/docs-app-mkdocs/mkdocs.yml +47 -0
- package/assets/templates/docs-app-mkdocs/package.json.template +19 -0
- package/assets/templates/docs-app-mkdocs/requirements.txt +6 -0
- package/assets/templates/docs-app-mkdocs/setup-docs.sh +18 -0
- package/assets/templates/ideas/idea-discovery.md +39 -0
- package/assets/templates/ideas/idea-summary.md +42 -0
- package/assets/templates/ideas/ideas-backlog.md +21 -0
- package/assets/templates/ideas/ideas-scratchpad.md +10 -0
- package/assets/templates/implementation.md +207 -0
- package/assets/templates/plan.md +171 -0
- package/assets/templates/roadmap.md +24 -0
- package/assets/templates/spec.md +138 -0
- package/assets/templates/state.md +49 -0
- package/assets/templates/summary.md +82 -0
- package/dist/agents/canonical/index.d.ts +4 -0
- package/dist/agents/canonical/index.d.ts.map +1 -0
- package/dist/agents/canonical/index.js +2 -0
- package/dist/agents/canonical/parse.d.ts +4 -0
- package/dist/agents/canonical/parse.d.ts.map +1 -0
- package/dist/agents/canonical/parse.js +97 -0
- package/dist/agents/canonical/render.d.ts +3 -0
- package/dist/agents/canonical/render.d.ts.map +1 -0
- package/dist/agents/canonical/render.js +17 -0
- package/dist/agents/canonical/types.d.ts +22 -0
- package/dist/agents/canonical/types.d.ts.map +1 -0
- package/dist/agents/canonical/types.js +1 -0
- package/dist/app/command-context.d.ts +21 -0
- package/dist/app/command-context.d.ts.map +1 -0
- package/dist/app/command-context.js +18 -0
- package/dist/app/create-program.d.ts +3 -0
- package/dist/app/create-program.d.ts.map +1 -0
- package/dist/app/create-program.js +17 -0
- package/dist/commands/__tests__/helpers.d.ts +12 -0
- package/dist/commands/__tests__/helpers.d.ts.map +1 -0
- package/dist/commands/__tests__/helpers.js +36 -0
- package/dist/commands/backlog/index.d.ts +14 -0
- package/dist/commands/backlog/index.d.ts.map +1 -0
- package/dist/commands/backlog/index.js +80 -0
- package/dist/commands/backlog/init.d.ts +2 -0
- package/dist/commands/backlog/init.d.ts.map +1 -0
- package/dist/commands/backlog/init.js +66 -0
- package/dist/commands/backlog/regenerate-index.d.ts +2 -0
- package/dist/commands/backlog/regenerate-index.d.ts.map +1 -0
- package/dist/commands/backlog/regenerate-index.js +78 -0
- package/dist/commands/backlog/shared/generate-id.d.ts +4 -0
- package/dist/commands/backlog/shared/generate-id.d.ts.map +1 -0
- package/dist/commands/backlog/shared/generate-id.js +65 -0
- package/dist/commands/cleanup/artifacts/artifacts.d.ts +44 -0
- package/dist/commands/cleanup/artifacts/artifacts.d.ts.map +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.js +381 -0
- package/dist/commands/cleanup/artifacts/artifacts.types.d.ts +13 -0
- package/dist/commands/cleanup/artifacts/artifacts.types.d.ts.map +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.types.js +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.utils.d.ts +14 -0
- package/dist/commands/cleanup/artifacts/artifacts.utils.d.ts.map +1 -0
- package/dist/commands/cleanup/artifacts/artifacts.utils.js +74 -0
- package/dist/commands/cleanup/cleanup.types.d.ts +26 -0
- package/dist/commands/cleanup/cleanup.types.d.ts.map +1 -0
- package/dist/commands/cleanup/cleanup.types.js +1 -0
- package/dist/commands/cleanup/cleanup.utils.d.ts +17 -0
- package/dist/commands/cleanup/cleanup.utils.d.ts.map +1 -0
- package/dist/commands/cleanup/cleanup.utils.js +44 -0
- package/dist/commands/cleanup/index.d.ts +3 -0
- package/dist/commands/cleanup/index.d.ts.map +1 -0
- package/dist/commands/cleanup/index.js +9 -0
- package/dist/commands/cleanup/project/project.d.ts +20 -0
- package/dist/commands/cleanup/project/project.d.ts.map +1 -0
- package/dist/commands/cleanup/project/project.js +263 -0
- package/dist/commands/cleanup/project/project.utils.d.ts +8 -0
- package/dist/commands/cleanup/project/project.utils.d.ts.map +1 -0
- package/dist/commands/cleanup/project/project.utils.js +48 -0
- package/dist/commands/config/index.d.ts +16 -0
- package/dist/commands/config/index.d.ts.map +1 -0
- package/dist/commands/config/index.js +700 -0
- package/dist/commands/docs/analyze.d.ts +8 -0
- package/dist/commands/docs/analyze.d.ts.map +1 -0
- package/dist/commands/docs/analyze.js +45 -0
- package/dist/commands/docs/apply.d.ts +8 -0
- package/dist/commands/docs/apply.d.ts.map +1 -0
- package/dist/commands/docs/apply.js +45 -0
- package/dist/commands/docs/index-generate/generator.d.ts +9 -0
- package/dist/commands/docs/index-generate/generator.d.ts.map +1 -0
- package/dist/commands/docs/index-generate/generator.js +114 -0
- package/dist/commands/docs/index-generate/index.d.ts +16 -0
- package/dist/commands/docs/index-generate/index.d.ts.map +1 -0
- package/dist/commands/docs/index-generate/index.js +72 -0
- package/dist/commands/docs/index.d.ts +3 -0
- package/dist/commands/docs/index.d.ts.map +1 -0
- package/dist/commands/docs/index.js +17 -0
- package/dist/commands/docs/init/index.d.ts +18 -0
- package/dist/commands/docs/init/index.d.ts.map +1 -0
- package/dist/commands/docs/init/index.js +129 -0
- package/dist/commands/docs/init/resolve-options.d.ts +41 -0
- package/dist/commands/docs/init/resolve-options.d.ts.map +1 -0
- package/dist/commands/docs/init/resolve-options.js +120 -0
- package/dist/commands/docs/init/scaffold.d.ts +18 -0
- package/dist/commands/docs/init/scaffold.d.ts.map +1 -0
- package/dist/commands/docs/init/scaffold.js +233 -0
- package/dist/commands/docs/migrate/codemod.d.ts +6 -0
- package/dist/commands/docs/migrate/codemod.d.ts.map +1 -0
- package/dist/commands/docs/migrate/codemod.js +62 -0
- package/dist/commands/docs/migrate/frontmatter.d.ts +12 -0
- package/dist/commands/docs/migrate/frontmatter.d.ts.map +1 -0
- package/dist/commands/docs/migrate/frontmatter.js +55 -0
- package/dist/commands/docs/migrate/index.d.ts +18 -0
- package/dist/commands/docs/migrate/index.d.ts.map +1 -0
- package/dist/commands/docs/migrate/index.js +138 -0
- package/dist/commands/docs/nav/contents.d.ts +14 -0
- package/dist/commands/docs/nav/contents.d.ts.map +1 -0
- package/dist/commands/docs/nav/contents.js +106 -0
- package/dist/commands/docs/nav/index.d.ts +3 -0
- package/dist/commands/docs/nav/index.d.ts.map +1 -0
- package/dist/commands/docs/nav/index.js +7 -0
- package/dist/commands/docs/nav/sync.d.ts +20 -0
- package/dist/commands/docs/nav/sync.d.ts.map +1 -0
- package/dist/commands/docs/nav/sync.js +92 -0
- package/dist/commands/doctor/index.d.ts +32 -0
- package/dist/commands/doctor/index.d.ts.map +1 -0
- package/dist/commands/doctor/index.js +373 -0
- package/dist/commands/index-cmd/index.d.ts +11 -0
- package/dist/commands/index-cmd/index.d.ts.map +1 -0
- package/dist/commands/index-cmd/index.js +62 -0
- package/dist/commands/index-cmd/thin-index.d.ts +19 -0
- package/dist/commands/index-cmd/thin-index.d.ts.map +1 -0
- package/dist/commands/index-cmd/thin-index.js +330 -0
- package/dist/commands/index.d.ts +3 -0
- package/dist/commands/index.d.ts.map +1 -0
- package/dist/commands/index.js +38 -0
- package/dist/commands/init/detect-docs.d.ts +11 -0
- package/dist/commands/init/detect-docs.d.ts.map +1 -0
- package/dist/commands/init/detect-docs.js +51 -0
- package/dist/commands/init/gitignore.d.ts +6 -0
- package/dist/commands/init/gitignore.d.ts.map +1 -0
- package/dist/commands/init/gitignore.js +41 -0
- package/dist/commands/init/index.d.ts +70 -0
- package/dist/commands/init/index.d.ts.map +1 -0
- package/dist/commands/init/index.js +570 -0
- package/dist/commands/init/tools/core/index.d.ts +12 -0
- package/dist/commands/init/tools/core/index.d.ts.map +1 -0
- package/dist/commands/init/tools/core/index.js +67 -0
- package/dist/commands/init/tools/core/install-core.d.ts +30 -0
- package/dist/commands/init/tools/core/install-core.d.ts.map +1 -0
- package/dist/commands/init/tools/core/install-core.js +50 -0
- package/dist/commands/init/tools/docs/index.d.ts +17 -0
- package/dist/commands/init/tools/docs/index.d.ts.map +1 -0
- package/dist/commands/init/tools/docs/index.js +110 -0
- package/dist/commands/init/tools/docs/install-docs.d.ts +23 -0
- package/dist/commands/init/tools/docs/install-docs.d.ts.map +1 -0
- package/dist/commands/init/tools/docs/install-docs.js +58 -0
- package/dist/commands/init/tools/ideas/index.d.ts +16 -0
- package/dist/commands/init/tools/ideas/index.d.ts.map +1 -0
- package/dist/commands/init/tools/ideas/index.js +94 -0
- package/dist/commands/init/tools/ideas/install-ideas.d.ts +25 -0
- package/dist/commands/init/tools/ideas/install-ideas.d.ts.map +1 -0
- package/dist/commands/init/tools/ideas/install-ideas.js +78 -0
- package/dist/commands/init/tools/index.d.ts +51 -0
- package/dist/commands/init/tools/index.d.ts.map +1 -0
- package/dist/commands/init/tools/index.js +387 -0
- package/dist/commands/init/tools/project-management/index.d.ts +12 -0
- package/dist/commands/init/tools/project-management/index.d.ts.map +1 -0
- package/dist/commands/init/tools/project-management/index.js +61 -0
- package/dist/commands/init/tools/project-management/install-project-management.d.ts +22 -0
- package/dist/commands/init/tools/project-management/install-project-management.d.ts.map +1 -0
- package/dist/commands/init/tools/project-management/install-project-management.js +52 -0
- package/dist/commands/init/tools/research/index.d.ts +17 -0
- package/dist/commands/init/tools/research/index.d.ts.map +1 -0
- package/dist/commands/init/tools/research/index.js +110 -0
- package/dist/commands/init/tools/research/install-research.d.ts +23 -0
- package/dist/commands/init/tools/research/install-research.d.ts.map +1 -0
- package/dist/commands/init/tools/research/install-research.js +52 -0
- package/dist/commands/init/tools/shared/copy-helpers.d.ts +12 -0
- package/dist/commands/init/tools/shared/copy-helpers.d.ts.map +1 -0
- package/dist/commands/init/tools/shared/copy-helpers.js +52 -0
- package/dist/commands/init/tools/shared/skill-manifest.d.ts +22 -0
- package/dist/commands/init/tools/shared/skill-manifest.d.ts.map +1 -0
- package/dist/commands/init/tools/shared/skill-manifest.js +102 -0
- package/dist/commands/init/tools/shared/version.d.ts +3 -0
- package/dist/commands/init/tools/shared/version.d.ts.map +1 -0
- package/dist/commands/init/tools/shared/version.js +27 -0
- package/dist/commands/init/tools/utility/index.d.ts +17 -0
- package/dist/commands/init/tools/utility/index.d.ts.map +1 -0
- package/dist/commands/init/tools/utility/index.js +109 -0
- package/dist/commands/init/tools/utility/install-utility.d.ts +20 -0
- package/dist/commands/init/tools/utility/install-utility.d.ts.map +1 -0
- package/dist/commands/init/tools/utility/install-utility.js +35 -0
- package/dist/commands/init/tools/workflows/index.d.ts +14 -0
- package/dist/commands/init/tools/workflows/index.d.ts.map +1 -0
- package/dist/commands/init/tools/workflows/index.js +84 -0
- package/dist/commands/init/tools/workflows/install-workflows.d.ts +32 -0
- package/dist/commands/init/tools/workflows/install-workflows.d.ts.map +1 -0
- package/dist/commands/init/tools/workflows/install-workflows.js +135 -0
- package/dist/commands/instructions/index.d.ts +3 -0
- package/dist/commands/instructions/index.d.ts.map +1 -0
- package/dist/commands/instructions/index.js +9 -0
- package/dist/commands/instructions/instructions.types.d.ts +52 -0
- package/dist/commands/instructions/instructions.types.d.ts.map +1 -0
- package/dist/commands/instructions/instructions.types.js +1 -0
- package/dist/commands/instructions/instructions.utils.d.ts +13 -0
- package/dist/commands/instructions/instructions.utils.d.ts.map +1 -0
- package/dist/commands/instructions/instructions.utils.js +211 -0
- package/dist/commands/instructions/sync/sync.d.ts +4 -0
- package/dist/commands/instructions/sync/sync.d.ts.map +1 -0
- package/dist/commands/instructions/sync/sync.js +142 -0
- package/dist/commands/instructions/validate/validate.d.ts +4 -0
- package/dist/commands/instructions/validate/validate.d.ts.map +1 -0
- package/dist/commands/instructions/validate/validate.js +53 -0
- package/dist/commands/internal/index.d.ts +3 -0
- package/dist/commands/internal/index.d.ts.map +1 -0
- package/dist/commands/internal/index.js +7 -0
- package/dist/commands/internal/validate-oat-skills.d.ts +10 -0
- package/dist/commands/internal/validate-oat-skills.d.ts.map +1 -0
- package/dist/commands/internal/validate-oat-skills.js +66 -0
- package/dist/commands/local/apply.d.ts +6 -0
- package/dist/commands/local/apply.d.ts.map +1 -0
- package/dist/commands/local/apply.js +56 -0
- package/dist/commands/local/expand.d.ts +8 -0
- package/dist/commands/local/expand.d.ts.map +1 -0
- package/dist/commands/local/expand.js +83 -0
- package/dist/commands/local/index.d.ts +3 -0
- package/dist/commands/local/index.d.ts.map +1 -0
- package/dist/commands/local/index.js +248 -0
- package/dist/commands/local/manage.d.ts +18 -0
- package/dist/commands/local/manage.d.ts.map +1 -0
- package/dist/commands/local/manage.js +66 -0
- package/dist/commands/local/status.d.ts +7 -0
- package/dist/commands/local/status.d.ts.map +1 -0
- package/dist/commands/local/status.js +46 -0
- package/dist/commands/local/sync.d.ts +20 -0
- package/dist/commands/local/sync.d.ts.map +1 -0
- package/dist/commands/local/sync.js +40 -0
- package/dist/commands/project/archive/archive-utils.d.ts +70 -0
- package/dist/commands/project/archive/archive-utils.d.ts.map +1 -0
- package/dist/commands/project/archive/archive-utils.js +236 -0
- package/dist/commands/project/archive/index.d.ts +20 -0
- package/dist/commands/project/archive/index.d.ts.map +1 -0
- package/dist/commands/project/archive/index.js +217 -0
- package/dist/commands/project/index.d.ts +3 -0
- package/dist/commands/project/index.d.ts.map +1 -0
- package/dist/commands/project/index.js +15 -0
- package/dist/commands/project/new/index.d.ts +17 -0
- package/dist/commands/project/new/index.d.ts.map +1 -0
- package/dist/commands/project/new/index.js +76 -0
- package/dist/commands/project/new/scaffold.d.ts +24 -0
- package/dist/commands/project/new/scaffold.d.ts.map +1 -0
- package/dist/commands/project/new/scaffold.js +177 -0
- package/dist/commands/project/open/index.d.ts +26 -0
- package/dist/commands/project/open/index.d.ts.map +1 -0
- package/dist/commands/project/open/index.js +139 -0
- package/dist/commands/project/pause/index.d.ts +27 -0
- package/dist/commands/project/pause/index.d.ts.map +1 -0
- package/dist/commands/project/pause/index.js +120 -0
- package/dist/commands/project/set-mode/index.d.ts +14 -0
- package/dist/commands/project/set-mode/index.d.ts.map +1 -0
- package/dist/commands/project/set-mode/index.js +115 -0
- package/dist/commands/providers/index.d.ts +4 -0
- package/dist/commands/providers/index.d.ts.map +1 -0
- package/dist/commands/providers/index.js +11 -0
- package/dist/commands/providers/inspect/inspect.d.ts +4 -0
- package/dist/commands/providers/inspect/inspect.d.ts.map +1 -0
- package/dist/commands/providers/inspect/inspect.js +156 -0
- package/dist/commands/providers/list/list.d.ts +4 -0
- package/dist/commands/providers/list/list.d.ts.map +1 -0
- package/dist/commands/providers/list/list.js +163 -0
- package/dist/commands/providers/providers.types.d.ts +63 -0
- package/dist/commands/providers/providers.types.d.ts.map +1 -0
- package/dist/commands/providers/providers.types.js +1 -0
- package/dist/commands/providers/set/index.d.ts +4 -0
- package/dist/commands/providers/set/index.d.ts.map +1 -0
- package/dist/commands/providers/set/index.js +138 -0
- package/dist/commands/remove/index.d.ts +3 -0
- package/dist/commands/remove/index.d.ts.map +1 -0
- package/dist/commands/remove/index.js +9 -0
- package/dist/commands/remove/skill/index.d.ts +2 -0
- package/dist/commands/remove/skill/index.d.ts.map +1 -0
- package/dist/commands/remove/skill/index.js +1 -0
- package/dist/commands/remove/skill/remove-skill.d.ts +23 -0
- package/dist/commands/remove/skill/remove-skill.d.ts.map +1 -0
- package/dist/commands/remove/skill/remove-skill.js +231 -0
- package/dist/commands/remove/skills/index.d.ts +2 -0
- package/dist/commands/remove/skills/index.d.ts.map +1 -0
- package/dist/commands/remove/skills/index.js +1 -0
- package/dist/commands/remove/skills/remove-skills.d.ts +14 -0
- package/dist/commands/remove/skills/remove-skills.d.ts.map +1 -0
- package/dist/commands/remove/skills/remove-skills.js +98 -0
- package/dist/commands/repo/index.d.ts +3 -0
- package/dist/commands/repo/index.d.ts.map +1 -0
- package/dist/commands/repo/index.js +7 -0
- package/dist/commands/repo/pr-comments/collect/collect-comments.d.ts +9 -0
- package/dist/commands/repo/pr-comments/collect/collect-comments.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/collect-comments.js +284 -0
- package/dist/commands/repo/pr-comments/collect/graphql-queries.d.ts +3 -0
- package/dist/commands/repo/pr-comments/collect/graphql-queries.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/graphql-queries.js +56 -0
- package/dist/commands/repo/pr-comments/collect/index.d.ts +4 -0
- package/dist/commands/repo/pr-comments/collect/index.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/index.js +25 -0
- package/dist/commands/repo/pr-comments/collect/pr-comments.types.d.ts +62 -0
- package/dist/commands/repo/pr-comments/collect/pr-comments.types.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/collect/pr-comments.types.js +1 -0
- package/dist/commands/repo/pr-comments/index.d.ts +3 -0
- package/dist/commands/repo/pr-comments/index.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/index.js +9 -0
- package/dist/commands/repo/pr-comments/triage-collection/index.d.ts +4 -0
- package/dist/commands/repo/pr-comments/triage-collection/index.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/triage-collection/index.js +21 -0
- package/dist/commands/repo/pr-comments/triage-collection/triage-comments.d.ts +13 -0
- package/dist/commands/repo/pr-comments/triage-collection/triage-comments.d.ts.map +1 -0
- package/dist/commands/repo/pr-comments/triage-collection/triage-comments.js +81 -0
- package/dist/commands/shared/adopt-stray.d.ts +22 -0
- package/dist/commands/shared/adopt-stray.d.ts.map +1 -0
- package/dist/commands/shared/adopt-stray.js +135 -0
- package/dist/commands/shared/agents-md.d.ts +18 -0
- package/dist/commands/shared/agents-md.d.ts.map +1 -0
- package/dist/commands/shared/agents-md.js +81 -0
- package/dist/commands/shared/codex-strays.d.ts +16 -0
- package/dist/commands/shared/codex-strays.d.ts.map +1 -0
- package/dist/commands/shared/codex-strays.js +116 -0
- package/dist/commands/shared/frontmatter-write.d.ts +8 -0
- package/dist/commands/shared/frontmatter-write.d.ts.map +1 -0
- package/dist/commands/shared/frontmatter-write.js +27 -0
- package/dist/commands/shared/frontmatter.d.ts +6 -0
- package/dist/commands/shared/frontmatter.d.ts.map +1 -0
- package/dist/commands/shared/frontmatter.js +35 -0
- package/dist/commands/shared/messages.d.ts +2 -0
- package/dist/commands/shared/messages.d.ts.map +1 -0
- package/dist/commands/shared/messages.js +1 -0
- package/dist/commands/shared/oat-paths.d.ts +2 -0
- package/dist/commands/shared/oat-paths.d.ts.map +1 -0
- package/dist/commands/shared/oat-paths.js +13 -0
- package/dist/commands/shared/shared.prompts.d.ts +21 -0
- package/dist/commands/shared/shared.prompts.d.ts.map +1 -0
- package/dist/commands/shared/shared.prompts.js +107 -0
- package/dist/commands/shared/shared.utils.d.ts +6 -0
- package/dist/commands/shared/shared.utils.d.ts.map +1 -0
- package/dist/commands/shared/shared.utils.js +9 -0
- package/dist/commands/state/generate.d.ts +21 -0
- package/dist/commands/state/generate.d.ts.map +1 -0
- package/dist/commands/state/generate.js +440 -0
- package/dist/commands/state/index.d.ts +11 -0
- package/dist/commands/state/index.d.ts.map +1 -0
- package/dist/commands/state/index.js +58 -0
- package/dist/commands/status/index.d.ts +44 -0
- package/dist/commands/status/index.d.ts.map +1 -0
- package/dist/commands/status/index.js +340 -0
- package/dist/commands/sync/apply.d.ts +4 -0
- package/dist/commands/sync/apply.d.ts.map +1 -0
- package/dist/commands/sync/apply.js +100 -0
- package/dist/commands/sync/dry-run.d.ts +4 -0
- package/dist/commands/sync/dry-run.d.ts.map +1 -0
- package/dist/commands/sync/dry-run.js +74 -0
- package/dist/commands/sync/index.d.ts +4 -0
- package/dist/commands/sync/index.d.ts.map +1 -0
- package/dist/commands/sync/index.js +225 -0
- package/dist/commands/sync/sync.types.d.ts +80 -0
- package/dist/commands/sync/sync.types.d.ts.map +1 -0
- package/dist/commands/sync/sync.types.js +1 -0
- package/dist/commands/sync/sync.utils.d.ts +3 -0
- package/dist/commands/sync/sync.utils.d.ts.map +1 -0
- package/dist/commands/sync/sync.utils.js +8 -0
- package/dist/commands/tools/index.d.ts +3 -0
- package/dist/commands/tools/index.d.ts.map +1 -0
- package/dist/commands/tools/index.js +17 -0
- package/dist/commands/tools/info/index.d.ts +4 -0
- package/dist/commands/tools/info/index.d.ts.map +1 -0
- package/dist/commands/tools/info/index.js +74 -0
- package/dist/commands/tools/info/info-tool.d.ts +21 -0
- package/dist/commands/tools/info/info-tool.d.ts.map +1 -0
- package/dist/commands/tools/info/info-tool.js +52 -0
- package/dist/commands/tools/install/index.d.ts +4 -0
- package/dist/commands/tools/install/index.d.ts.map +1 -0
- package/dist/commands/tools/install/index.js +34 -0
- package/dist/commands/tools/list/index.d.ts +4 -0
- package/dist/commands/tools/list/index.d.ts.map +1 -0
- package/dist/commands/tools/list/index.js +25 -0
- package/dist/commands/tools/list/list-tools.d.ts +13 -0
- package/dist/commands/tools/list/list-tools.d.ts.map +1 -0
- package/dist/commands/tools/list/list-tools.js +43 -0
- package/dist/commands/tools/outdated/index.d.ts +4 -0
- package/dist/commands/tools/outdated/index.d.ts.map +1 -0
- package/dist/commands/tools/outdated/index.js +25 -0
- package/dist/commands/tools/outdated/outdated-tools.d.ts +13 -0
- package/dist/commands/tools/outdated/outdated-tools.d.ts.map +1 -0
- package/dist/commands/tools/outdated/outdated-tools.js +43 -0
- package/dist/commands/tools/remove/index.d.ts +5 -0
- package/dist/commands/tools/remove/index.d.ts.map +1 -0
- package/dist/commands/tools/remove/index.js +122 -0
- package/dist/commands/tools/remove/remove-tools.d.ts +31 -0
- package/dist/commands/tools/remove/remove-tools.d.ts.map +1 -0
- package/dist/commands/tools/remove/remove-tools.js +41 -0
- package/dist/commands/tools/shared/auto-sync.d.ts +16 -0
- package/dist/commands/tools/shared/auto-sync.d.ts.map +1 -0
- package/dist/commands/tools/shared/auto-sync.js +17 -0
- package/dist/commands/tools/shared/scan-tools.d.ts +18 -0
- package/dist/commands/tools/shared/scan-tools.d.ts.map +1 -0
- package/dist/commands/tools/shared/scan-tools.js +128 -0
- package/dist/commands/tools/shared/types.d.ts +12 -0
- package/dist/commands/tools/shared/types.d.ts.map +1 -0
- package/dist/commands/tools/shared/types.js +1 -0
- package/dist/commands/tools/update/index.d.ts +8 -0
- package/dist/commands/tools/update/index.d.ts.map +1 -0
- package/dist/commands/tools/update/index.js +149 -0
- package/dist/commands/tools/update/update-tools.d.ts +29 -0
- package/dist/commands/tools/update/update-tools.d.ts.map +1 -0
- package/dist/commands/tools/update/update-tools.js +148 -0
- package/dist/config/index.d.ts +4 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +2 -0
- package/dist/config/oat-config.d.ts +61 -0
- package/dist/config/oat-config.d.ts.map +1 -0
- package/dist/config/oat-config.js +319 -0
- package/dist/config/runtime.d.ts +2 -0
- package/dist/config/runtime.d.ts.map +1 -0
- package/dist/config/runtime.js +3 -0
- package/dist/config/sync-config.d.ts +49 -0
- package/dist/config/sync-config.d.ts.map +1 -0
- package/dist/config/sync-config.js +94 -0
- package/dist/drift/detector.d.ts +4 -0
- package/dist/drift/detector.d.ts.map +1 -0
- package/dist/drift/detector.js +69 -0
- package/dist/drift/drift.types.d.ts +17 -0
- package/dist/drift/drift.types.d.ts.map +1 -0
- package/dist/drift/drift.types.js +1 -0
- package/dist/drift/index.d.ts +4 -0
- package/dist/drift/index.d.ts.map +1 -0
- package/dist/drift/index.js +2 -0
- package/dist/drift/strays.d.ts +7 -0
- package/dist/drift/strays.d.ts.map +1 -0
- package/dist/drift/strays.js +153 -0
- package/dist/engine/compute-plan.d.ts +16 -0
- package/dist/engine/compute-plan.d.ts.map +1 -0
- package/dist/engine/compute-plan.js +234 -0
- package/dist/engine/engine.types.d.ts +28 -0
- package/dist/engine/engine.types.d.ts.map +1 -0
- package/dist/engine/engine.types.js +8 -0
- package/dist/engine/execute-plan.d.ts +5 -0
- package/dist/engine/execute-plan.d.ts.map +1 -0
- package/dist/engine/execute-plan.js +141 -0
- package/dist/engine/hook.d.ts +23 -0
- package/dist/engine/hook.d.ts.map +1 -0
- package/dist/engine/hook.js +254 -0
- package/dist/engine/index.d.ts +9 -0
- package/dist/engine/index.d.ts.map +1 -0
- package/dist/engine/index.js +6 -0
- package/dist/engine/markers.d.ts +6 -0
- package/dist/engine/markers.d.ts.map +1 -0
- package/dist/engine/markers.js +24 -0
- package/dist/engine/scanner.d.ts +11 -0
- package/dist/engine/scanner.d.ts.map +1 -0
- package/dist/engine/scanner.js +65 -0
- package/dist/engine/test-helpers.d.ts +3 -0
- package/dist/engine/test-helpers.d.ts.map +1 -0
- package/dist/engine/test-helpers.js +31 -0
- package/dist/errors/cli-error.d.ts +5 -0
- package/dist/errors/cli-error.d.ts.map +1 -0
- package/dist/errors/cli-error.js +8 -0
- package/dist/errors/index.d.ts +2 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/index.js +1 -0
- package/dist/fs/assets.d.ts +2 -0
- package/dist/fs/assets.d.ts.map +1 -0
- package/dist/fs/assets.js +22 -0
- package/dist/fs/index.d.ts +4 -0
- package/dist/fs/index.d.ts.map +1 -0
- package/dist/fs/index.js +3 -0
- package/dist/fs/io.d.ts +9 -0
- package/dist/fs/io.d.ts.map +1 -0
- package/dist/fs/io.js +74 -0
- package/dist/fs/paths.d.ts +9 -0
- package/dist/fs/paths.d.ts.map +1 -0
- package/dist/fs/paths.js +42 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +48 -0
- package/dist/manifest/hash.d.ts +5 -0
- package/dist/manifest/hash.d.ts.map +1 -0
- package/dist/manifest/hash.js +75 -0
- package/dist/manifest/index.d.ts +5 -0
- package/dist/manifest/index.d.ts.map +1 -0
- package/dist/manifest/index.js +3 -0
- package/dist/manifest/manager.d.ts +8 -0
- package/dist/manifest/manager.d.ts.map +1 -0
- package/dist/manifest/manager.js +86 -0
- package/dist/manifest/manifest.types.d.ts +157 -0
- package/dist/manifest/manifest.types.d.ts.map +1 -0
- package/dist/manifest/manifest.types.js +56 -0
- package/dist/providers/claude/adapter.d.ts +3 -0
- package/dist/providers/claude/adapter.d.ts.map +1 -0
- package/dist/providers/claude/adapter.js +20 -0
- package/dist/providers/claude/index.d.ts +3 -0
- package/dist/providers/claude/index.d.ts.map +1 -0
- package/dist/providers/claude/index.js +2 -0
- package/dist/providers/claude/paths.d.ts +4 -0
- package/dist/providers/claude/paths.d.ts.map +1 -0
- package/dist/providers/claude/paths.js +38 -0
- package/dist/providers/claude/rule-transform.d.ts +3 -0
- package/dist/providers/claude/rule-transform.d.ts.map +1 -0
- package/dist/providers/claude/rule-transform.js +22 -0
- package/dist/providers/codex/adapter.d.ts +3 -0
- package/dist/providers/codex/adapter.d.ts.map +1 -0
- package/dist/providers/codex/adapter.js +20 -0
- package/dist/providers/codex/codec/config-merge.d.ts +17 -0
- package/dist/providers/codex/codec/config-merge.d.ts.map +1 -0
- package/dist/providers/codex/codec/config-merge.js +61 -0
- package/dist/providers/codex/codec/export-to-codex.d.ts +9 -0
- package/dist/providers/codex/codec/export-to-codex.d.ts.map +1 -0
- package/dist/providers/codex/codec/export-to-codex.js +45 -0
- package/dist/providers/codex/codec/import-from-codex.d.ts +9 -0
- package/dist/providers/codex/codec/import-from-codex.d.ts.map +1 -0
- package/dist/providers/codex/codec/import-from-codex.js +52 -0
- package/dist/providers/codex/codec/shared.d.ts +7 -0
- package/dist/providers/codex/codec/shared.d.ts.map +1 -0
- package/dist/providers/codex/codec/shared.js +21 -0
- package/dist/providers/codex/codec/sync-extension.d.ts +32 -0
- package/dist/providers/codex/codec/sync-extension.d.ts.map +1 -0
- package/dist/providers/codex/codec/sync-extension.js +227 -0
- package/dist/providers/codex/index.d.ts +6 -0
- package/dist/providers/codex/index.d.ts.map +1 -0
- package/dist/providers/codex/index.js +5 -0
- package/dist/providers/codex/paths.d.ts +4 -0
- package/dist/providers/codex/paths.d.ts.map +1 -0
- package/dist/providers/codex/paths.js +28 -0
- package/dist/providers/copilot/adapter.d.ts +3 -0
- package/dist/providers/copilot/adapter.d.ts.map +1 -0
- package/dist/providers/copilot/adapter.js +30 -0
- package/dist/providers/copilot/index.d.ts +3 -0
- package/dist/providers/copilot/index.d.ts.map +1 -0
- package/dist/providers/copilot/index.js +2 -0
- package/dist/providers/copilot/paths.d.ts +4 -0
- package/dist/providers/copilot/paths.d.ts.map +1 -0
- package/dist/providers/copilot/paths.js +38 -0
- package/dist/providers/copilot/rule-transform.d.ts +3 -0
- package/dist/providers/copilot/rule-transform.d.ts.map +1 -0
- package/dist/providers/copilot/rule-transform.js +58 -0
- package/dist/providers/cursor/adapter.d.ts +3 -0
- package/dist/providers/cursor/adapter.d.ts.map +1 -0
- package/dist/providers/cursor/adapter.js +20 -0
- package/dist/providers/cursor/index.d.ts +3 -0
- package/dist/providers/cursor/index.d.ts.map +1 -0
- package/dist/providers/cursor/index.js +2 -0
- package/dist/providers/cursor/paths.d.ts +4 -0
- package/dist/providers/cursor/paths.d.ts.map +1 -0
- package/dist/providers/cursor/paths.js +38 -0
- package/dist/providers/cursor/rule-transform.d.ts +3 -0
- package/dist/providers/cursor/rule-transform.d.ts.map +1 -0
- package/dist/providers/cursor/rule-transform.js +48 -0
- package/dist/providers/gemini/adapter.d.ts +3 -0
- package/dist/providers/gemini/adapter.d.ts.map +1 -0
- package/dist/providers/gemini/adapter.js +20 -0
- package/dist/providers/gemini/index.d.ts +3 -0
- package/dist/providers/gemini/index.d.ts.map +1 -0
- package/dist/providers/gemini/index.js +2 -0
- package/dist/providers/gemini/paths.d.ts +4 -0
- package/dist/providers/gemini/paths.d.ts.map +1 -0
- package/dist/providers/gemini/paths.js +28 -0
- package/dist/providers/shared/adapter.types.d.ts +21 -0
- package/dist/providers/shared/adapter.types.d.ts.map +1 -0
- package/dist/providers/shared/adapter.types.js +1 -0
- package/dist/providers/shared/adapter.utils.d.ts +12 -0
- package/dist/providers/shared/adapter.utils.d.ts.map +1 -0
- package/dist/providers/shared/adapter.utils.js +57 -0
- package/dist/providers/shared/agent-codec.types.d.ts +13 -0
- package/dist/providers/shared/agent-codec.types.d.ts.map +1 -0
- package/dist/providers/shared/agent-codec.types.js +1 -0
- package/dist/providers/shared/index.d.ts +6 -0
- package/dist/providers/shared/index.d.ts.map +1 -0
- package/dist/providers/shared/index.js +2 -0
- package/dist/providers/shared/markdown-agent-codec.d.ts +5 -0
- package/dist/providers/shared/markdown-agent-codec.d.ts.map +1 -0
- package/dist/providers/shared/markdown-agent-codec.js +12 -0
- package/dist/release/public-package-contract.d.ts +14 -0
- package/dist/release/public-package-contract.d.ts.map +1 -0
- package/dist/release/public-package-contract.js +97 -0
- package/dist/rules/canonical/index.d.ts +6 -0
- package/dist/rules/canonical/index.d.ts.map +1 -0
- package/dist/rules/canonical/index.js +4 -0
- package/dist/rules/canonical/parse.d.ts +9 -0
- package/dist/rules/canonical/parse.d.ts.map +1 -0
- package/dist/rules/canonical/parse.js +103 -0
- package/dist/rules/canonical/provider-filenames.d.ts +3 -0
- package/dist/rules/canonical/provider-filenames.d.ts.map +1 -0
- package/dist/rules/canonical/provider-filenames.js +13 -0
- package/dist/rules/canonical/render.d.ts +5 -0
- package/dist/rules/canonical/render.d.ts.map +1 -0
- package/dist/rules/canonical/render.js +32 -0
- package/dist/rules/canonical/types.d.ts +16 -0
- package/dist/rules/canonical/types.d.ts.map +1 -0
- package/dist/rules/canonical/types.js +6 -0
- package/dist/shared/index.d.ts +3 -0
- package/dist/shared/index.d.ts.map +1 -0
- package/dist/shared/index.js +1 -0
- package/dist/shared/types.d.ts +10 -0
- package/dist/shared/types.d.ts.map +1 -0
- package/dist/shared/types.js +14 -0
- package/dist/ui/ansi.d.ts +2 -0
- package/dist/ui/ansi.d.ts.map +1 -0
- package/dist/ui/ansi.js +19 -0
- package/dist/ui/index.d.ts +7 -0
- package/dist/ui/index.d.ts.map +1 -0
- package/dist/ui/index.js +3 -0
- package/dist/ui/logger.d.ts +15 -0
- package/dist/ui/logger.d.ts.map +1 -0
- package/dist/ui/logger.js +52 -0
- package/dist/ui/output.d.ts +16 -0
- package/dist/ui/output.d.ts.map +1 -0
- package/dist/ui/output.js +135 -0
- package/dist/ui/spinner.d.ts +16 -0
- package/dist/ui/spinner.d.ts.map +1 -0
- package/dist/ui/spinner.js +46 -0
- package/dist/validation/index.d.ts +3 -0
- package/dist/validation/index.d.ts.map +1 -0
- package/dist/validation/index.js +1 -0
- package/dist/validation/skills.d.ts +10 -0
- package/dist/validation/skills.d.ts.map +1 -0
- package/dist/validation/skills.js +166 -0
- package/package.json +62 -0
|
@@ -0,0 +1,594 @@
|
|
|
1
|
+
# Rules and Instruction Files — Cross-Provider Deep Dive
|
|
2
|
+
|
|
3
|
+
> Research synthesis compiled 2026-02-19 from official provider documentation.
|
|
4
|
+
> For provider-specific links, see [provider-reference.md](./provider-reference.md).
|
|
5
|
+
> For the generalized instruction file playbook, see [agent-instruction.md](./agent-instruction.md).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Table of Contents
|
|
10
|
+
|
|
11
|
+
1. [What This Document Covers](#1-what-this-document-covers)
|
|
12
|
+
2. [Claude Code](#2-claude-code)
|
|
13
|
+
3. [Cursor](#3-cursor)
|
|
14
|
+
4. [GitHub Copilot](#4-github-copilot)
|
|
15
|
+
5. [Cross-Provider Comparison](#5-cross-provider-comparison)
|
|
16
|
+
6. [Quantitative Data: Sizes, Limits, Token Budgets](#6-quantitative-data-sizes-limits-token-budgets)
|
|
17
|
+
7. [Context Engineering Principles](#7-context-engineering-principles)
|
|
18
|
+
8. [Best Practices (Cross-Provider Consensus)](#8-best-practices-cross-provider-consensus)
|
|
19
|
+
9. [Anti-Patterns](#9-anti-patterns)
|
|
20
|
+
10. [Portability Strategy](#10-portability-strategy)
|
|
21
|
+
11. [Sources](#11-sources)
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 1. What This Document Covers
|
|
26
|
+
|
|
27
|
+
This document provides a deep, provider-specific reference for **rules files and instruction files** — the mechanisms each tool uses to give persistent, scoped context to AI coding agents. It complements `agent-instruction.md` (the generalized playbook) by going deeper into how each tool actually works.
|
|
28
|
+
|
|
29
|
+
**Scope:** Claude Code rules & memory, Cursor rules, Copilot instructions. Copilot is included here (rather than only in agent-instruction.md) because its scoped instruction files (`.instructions.md` with `applyTo` globs) function more like rules than like traditional agent instructions — they activate conditionally based on file patterns, just like Claude's path-scoped rules and Cursor's glob-attached rules.
|
|
30
|
+
|
|
31
|
+
**Out of scope:** Skills, subagents, hooks, plugins (see their respective guides).
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 2. Claude Code
|
|
36
|
+
|
|
37
|
+
### 2.1 File Hierarchy
|
|
38
|
+
|
|
39
|
+
Source: [code.claude.com/docs/en/memory](https://code.claude.com/docs/en/memory) (official)
|
|
40
|
+
|
|
41
|
+
Claude Code loads instruction files from a 6-level hierarchy:
|
|
42
|
+
|
|
43
|
+
| Memory Type | Location | Purpose | Shared With |
|
|
44
|
+
| ------------------ | ----------------------------------------------------------------------------------------------- | --------------------------------------------------- | ---------------- |
|
|
45
|
+
| **Managed policy** | macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`; Linux: `/etc/claude-code/CLAUDE.md` | Organization-wide instructions managed by IT/DevOps | All users in org |
|
|
46
|
+
| **Project memory** | `./CLAUDE.md` **or** `./.claude/CLAUDE.md` | Team-shared instructions for the project | Team (git) |
|
|
47
|
+
| **Project rules** | `./.claude/rules/*.md` | Modular, topic-specific project instructions | Team (git) |
|
|
48
|
+
| **User memory** | `~/.claude/CLAUDE.md` | Personal preferences for all projects | Just you |
|
|
49
|
+
| **Project local** | `./CLAUDE.local.md` | Personal project-specific preferences | Just you |
|
|
50
|
+
| **Auto memory** | `~/.claude/projects/<project>/memory/` | Claude's automatic notes and learnings | Just you |
|
|
51
|
+
|
|
52
|
+
Both `./CLAUDE.md` and `./.claude/CLAUDE.md` are valid project memory locations. `CLAUDE.local.md` is automatically gitignored.
|
|
53
|
+
|
|
54
|
+
### 2.2 Discovery and Loading
|
|
55
|
+
|
|
56
|
+
**Upward recursion at launch:**
|
|
57
|
+
|
|
58
|
+
> "Claude Code reads memories recursively: starting in the cwd, Claude Code recurses up to (but not including) the root directory `/` and reads any CLAUDE.md or CLAUDE.local.md files it finds."
|
|
59
|
+
|
|
60
|
+
**Downward discovery on demand:**
|
|
61
|
+
|
|
62
|
+
> "Claude will also discover CLAUDE.md nested in subtrees under your current working directory. Instead of loading them at launch, they are only included when Claude reads files in those subtrees."
|
|
63
|
+
|
|
64
|
+
- **Loaded at launch:** All CLAUDE.md files in the directory hierarchy **above** the working directory
|
|
65
|
+
- **Loaded on demand:** CLAUDE.md files in **child** directories, only when Claude reads files there
|
|
66
|
+
- **Auto memory:** First 200 lines of `MEMORY.md` loaded at startup; topic files read on demand
|
|
67
|
+
|
|
68
|
+
The `--add-dir` flag gives Claude access to extra directories. CLAUDE.md from those dirs is NOT loaded unless `CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1` is set.
|
|
69
|
+
|
|
70
|
+
### 2.3 @-Import Syntax
|
|
71
|
+
|
|
72
|
+
CLAUDE.md files can import additional files using `@path/to/import`:
|
|
73
|
+
|
|
74
|
+
```markdown
|
|
75
|
+
@AGENTS.md
|
|
76
|
+
@docs/git-instructions.md
|
|
77
|
+
@~/.claude/my-project-instructions.md
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Key behaviors:
|
|
81
|
+
|
|
82
|
+
- Relative paths resolve **relative to the file containing the import**, not the working directory
|
|
83
|
+
- Absolute and `@~/` home paths supported
|
|
84
|
+
- Recursive imports supported, **max depth of 5 hops**
|
|
85
|
+
- NOT evaluated inside markdown code spans or code blocks
|
|
86
|
+
- First-time imports trigger a one-time approval dialog per project (cannot be re-prompted if declined)
|
|
87
|
+
- For worktrees: use `@~/.claude/my-project-instructions.md` since `CLAUDE.local.md` only exists in one worktree
|
|
88
|
+
|
|
89
|
+
### 2.4 Override and Merge Semantics
|
|
90
|
+
|
|
91
|
+
> "More specific instructions take precedence over broader ones."
|
|
92
|
+
|
|
93
|
+
Precedence (highest to lowest):
|
|
94
|
+
|
|
95
|
+
1. **Managed policy** (cannot be overridden)
|
|
96
|
+
2. **Project rules** (`.claude/rules/*.md`) — same priority as `.claude/CLAUDE.md`
|
|
97
|
+
3. **Project memory** (`./CLAUDE.md`)
|
|
98
|
+
4. **User memory** (`~/.claude/CLAUDE.md`)
|
|
99
|
+
5. **Project local** (`./CLAUDE.local.md`)
|
|
100
|
+
6. **Auto memory**
|
|
101
|
+
|
|
102
|
+
> "User-level rules are loaded before project rules, giving project rules higher priority."
|
|
103
|
+
|
|
104
|
+
Settings precedence is separate: Managed > CLI args > Local > Project > User. Permission evaluation: deny first, then ask, then allow. First matching rule wins.
|
|
105
|
+
|
|
106
|
+
### 2.5 Modular Rules (`.claude/rules/`)
|
|
107
|
+
|
|
108
|
+
All `.md` files in `.claude/rules/` are automatically loaded as project memory. Subdirectories are fully supported and recursively discovered. Symlinks are supported; circular symlinks handled gracefully.
|
|
109
|
+
|
|
110
|
+
**Unconditional rules** (no frontmatter) load on every session.
|
|
111
|
+
|
|
112
|
+
**Conditional rules** use `paths` frontmatter — the only documented frontmatter field for rules:
|
|
113
|
+
|
|
114
|
+
```yaml
|
|
115
|
+
---
|
|
116
|
+
paths:
|
|
117
|
+
- 'src/api/**/*.ts'
|
|
118
|
+
- 'src/**/*.{ts,tsx}'
|
|
119
|
+
---
|
|
120
|
+
# API Development Rules
|
|
121
|
+
- All API endpoints must include input validation
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
User-level rules go in `~/.claude/rules/` and apply to all projects (lower priority than project rules).
|
|
125
|
+
|
|
126
|
+
### 2.6 AGENTS.md Support
|
|
127
|
+
|
|
128
|
+
**AGENTS.md is NOT natively supported by Claude Code** (GitHub issue #6235 has 2,700+ upvotes, still open). The recommended workaround is a one-line `CLAUDE.md`:
|
|
129
|
+
|
|
130
|
+
```markdown
|
|
131
|
+
@AGENTS.md
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
This leverages @-import. Alternative: symlink `ln -s AGENTS.md CLAUDE.md`.
|
|
135
|
+
|
|
136
|
+
### 2.7 Skills vs CLAUDE.md vs Rules
|
|
137
|
+
|
|
138
|
+
Source: [code.claude.com/docs/en/best-practices](https://code.claude.com/docs/en/best-practices) (official)
|
|
139
|
+
|
|
140
|
+
| Mechanism | Always loaded | On-demand | Best for |
|
|
141
|
+
| -------------------- | ---------------- | ------------ | ---------------------------------------------- |
|
|
142
|
+
| **CLAUDE.md** | Yes | No | Broad project conventions loaded every session |
|
|
143
|
+
| **Rules (no paths)** | Yes | No | Focused topic files always relevant to project |
|
|
144
|
+
| **Rules (w/ paths)** | No | Yes | File-type-specific conventions |
|
|
145
|
+
| **Skills** | Description only | Full content | Domain knowledge, reusable workflows, tasks |
|
|
146
|
+
| **Auto memory** | 200 lines | Rest | Claude's own learnings and project patterns |
|
|
147
|
+
|
|
148
|
+
> "CLAUDE.md is loaded every session, so only include things that apply broadly. For domain knowledge or workflows that are only relevant sometimes, use skills instead."
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## 3. Cursor
|
|
153
|
+
|
|
154
|
+
### 3.1 Rule Types
|
|
155
|
+
|
|
156
|
+
Source: [cursor.com/docs/context/rules](https://cursor.com/docs/context/rules) (official)
|
|
157
|
+
|
|
158
|
+
Rules provide system-level instructions to Cursor's Agent:
|
|
159
|
+
|
|
160
|
+
> "Large language models don't retain memory between completions. Rules provide persistent, reusable context at the prompt level."
|
|
161
|
+
|
|
162
|
+
> "Rule contents are included at the start of the model context."
|
|
163
|
+
|
|
164
|
+
### 3.2 File Format (.mdc)
|
|
165
|
+
|
|
166
|
+
Cursor supports `.md` and `.mdc` extensions:
|
|
167
|
+
|
|
168
|
+
> "Use `.mdc` files with frontmatter to specify `description` and `globs` for more control over when rules are applied."
|
|
169
|
+
|
|
170
|
+
```yaml
|
|
171
|
+
---
|
|
172
|
+
description: 'Python coding guidelines for backend services'
|
|
173
|
+
alwaysApply: false
|
|
174
|
+
globs: ['src/**/*.ts', 'lib/**/*.ts']
|
|
175
|
+
---
|
|
176
|
+
# Rule Title
|
|
177
|
+
Rule content in markdown format.
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
Rules support `@filename.ts` syntax to reference files without duplicating content.
|
|
181
|
+
|
|
182
|
+
### 3.3 Frontmatter Fields — Complete Reference
|
|
183
|
+
|
|
184
|
+
The official documentation defines **three** frontmatter fields:
|
|
185
|
+
|
|
186
|
+
| Field | Type | Purpose |
|
|
187
|
+
| ------------- | ------------------ | ------------------------------------------------------ |
|
|
188
|
+
| `description` | string | Concise explanation; used by Agent to decide relevance |
|
|
189
|
+
| `alwaysApply` | boolean | When `true`, rule included in every session |
|
|
190
|
+
| `globs` | string or string[] | File patterns for auto-attachment |
|
|
191
|
+
|
|
192
|
+
**Activation mode is derived from the combination:**
|
|
193
|
+
|
|
194
|
+
| Configuration | Resulting Mode |
|
|
195
|
+
| ----------------------------------------------- | -------------------------------------------------------- |
|
|
196
|
+
| `alwaysApply: true` | **Always** — included in every session |
|
|
197
|
+
| `alwaysApply: false` + `globs` set | **Auto Attached** — included when matching files appear |
|
|
198
|
+
| `alwaysApply: false` + `description` (no globs) | **Agent Requested** — Agent decides based on description |
|
|
199
|
+
| No frontmatter / none set | **Manual** — user must @-mention the rule |
|
|
200
|
+
|
|
201
|
+
> **Note:** `agentRequested` and `manual` are NOT official frontmatter fields — those behaviors are achieved through combinations of the three real fields above.
|
|
202
|
+
|
|
203
|
+
### 3.4 Rule Scopes
|
|
204
|
+
|
|
205
|
+
**Project Rules:** `.cursor/rules/` directory, version-controlled, supports subdirectories.
|
|
206
|
+
|
|
207
|
+
**User Rules:** Configured in **Cursor Settings** UI (Settings > General > Rules for AI). NOT file-system-based — there is no `~/.cursor/rules/` directory. Apply only to Agent (Chat), not to Inline Edit or Cursor Tab.
|
|
208
|
+
|
|
209
|
+
**Team Rules:** Dashboard-managed, available on Team/Enterprise plans. Can be enforced to prevent user disabling.
|
|
210
|
+
|
|
211
|
+
### 3.5 AGENTS.md — First-Class Support
|
|
212
|
+
|
|
213
|
+
Cursor natively reads AGENTS.md:
|
|
214
|
+
|
|
215
|
+
> "AGENTS.md is a simple markdown file for defining agent instructions. Place it in your project root as an alternative to `.cursor/rules`."
|
|
216
|
+
|
|
217
|
+
Nested AGENTS.md in subdirectories is supported with hierarchical precedence (more specific wins).
|
|
218
|
+
|
|
219
|
+
| Aspect | AGENTS.md | .cursor/rules |
|
|
220
|
+
| ------------------ | ------------------------- | --------------------- |
|
|
221
|
+
| Format | Plain markdown | .mdc with frontmatter |
|
|
222
|
+
| Activation control | Always on | Four activation modes |
|
|
223
|
+
| Glob targeting | No | Yes |
|
|
224
|
+
| Cross-tool compat | Yes (Claude, Codex, etc.) | Cursor-specific |
|
|
225
|
+
|
|
226
|
+
### 3.6 Precedence
|
|
227
|
+
|
|
228
|
+
> "Rules are applied in this order: Team Rules → Project Rules → User Rules. All applicable rules are merged; earlier sources take precedence when guidance conflicts."
|
|
229
|
+
|
|
230
|
+
### 3.7 Legacy .cursorrules
|
|
231
|
+
|
|
232
|
+
> "The `.cursorrules` (legacy) file in your project root is still supported but will be deprecated. We recommend migrating to Project Rules or to AGENTS.md."
|
|
233
|
+
|
|
234
|
+
### 3.8 Cursor 2.2+ Folder Format (RULE.md)
|
|
235
|
+
|
|
236
|
+
Source: community references (not confirmed in primary official docs)
|
|
237
|
+
|
|
238
|
+
As of Cursor 2.2, new rules are created as folders: `.cursor/rules/<name>/RULE.md`. Legacy `.mdc` files continue to work. This is the Cursor UI's default for _new_ rules, not a change to how rules are read.
|
|
239
|
+
|
|
240
|
+
### 3.9 Notepads vs Rules
|
|
241
|
+
|
|
242
|
+
| Aspect | Rules | Notepads |
|
|
243
|
+
| --------------- | -------------------------------------------- | ----------------------------- |
|
|
244
|
+
| Activation | Automatic (various modes) | Manual (@-reference only) |
|
|
245
|
+
| Storage | File system (`.cursor/rules/`) | Cursor UI (Explorer sidebar) |
|
|
246
|
+
| Version control | Yes (project rules) | No — local to Cursor instance |
|
|
247
|
+
| Team sharing | Via repo (project) or dashboard (team) | Not shareable |
|
|
248
|
+
| Token usage | Always-on rules consume tokens every session | Only when referenced |
|
|
249
|
+
|
|
250
|
+
Use rules for standards that should apply automatically. Use notepads for on-demand reference material.
|
|
251
|
+
|
|
252
|
+
### 3.10 Limitations
|
|
253
|
+
|
|
254
|
+
Rules only apply to **Agent (Chat)**. They do NOT affect:
|
|
255
|
+
|
|
256
|
+
- Cursor Tab (autocomplete suggestions)
|
|
257
|
+
- Inline Edit (Cmd/Ctrl+K) — for user rules specifically
|
|
258
|
+
- Other AI features beyond Agent
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
## 4. GitHub Copilot
|
|
263
|
+
|
|
264
|
+
### 4.1 Repository-Level Instructions
|
|
265
|
+
|
|
266
|
+
Source: [docs.github.com](https://docs.github.com/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot) (official)
|
|
267
|
+
|
|
268
|
+
**File:** `.github/copilot-instructions.md` — always-on, automatically included in every chat request.
|
|
269
|
+
|
|
270
|
+
> "The instructions in the file(s) are available for use by Copilot as soon as you save the file(s). Instructions are automatically added to requests that you submit to Copilot."
|
|
271
|
+
|
|
272
|
+
Format: plain Markdown. Whitespace between instructions is ignored. VS Code `/init` command can auto-generate this file. Recommended max: **~1,000 lines**.
|
|
273
|
+
|
|
274
|
+
### 4.2 Scoped Instruction Files
|
|
275
|
+
|
|
276
|
+
**Pattern:** `.github/instructions/<NAME>.instructions.md` — activated by file pattern matching (similar to Claude rules and Cursor glob rules).
|
|
277
|
+
|
|
278
|
+
**Frontmatter — all supported fields:**
|
|
279
|
+
|
|
280
|
+
| Field | Required | Description |
|
|
281
|
+
| -------------- | -------- | ---------------------------------------------------------------------------------------- |
|
|
282
|
+
| `applyTo` | No | Glob pattern(s), comma-separated. Relative to workspace root. |
|
|
283
|
+
| `description` | No | Short description shown on hover (VS Code). Enables semantic matching when no `applyTo`. |
|
|
284
|
+
| `name` | No | Display name in UI (VS Code). Defaults to filename. |
|
|
285
|
+
| `excludeAgent` | No | Prevents use by a specific agent. Values: `"code-review"` or `"coding-agent"`. |
|
|
286
|
+
|
|
287
|
+
```yaml
|
|
288
|
+
---
|
|
289
|
+
applyTo: '**/*.ts,**/*.tsx'
|
|
290
|
+
excludeAgent: 'code-review'
|
|
291
|
+
---
|
|
292
|
+
When writing TypeScript code in this repository...
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
Scoped instructions are **additive** — they combine with (not replace) the main `copilot-instructions.md`:
|
|
296
|
+
|
|
297
|
+
> "If the path you specify matches a file that Copilot is working on, and a repository-wide custom instructions file also exists, then the instructions from both files are used."
|
|
298
|
+
|
|
299
|
+
### 4.3 Prompt Files
|
|
300
|
+
|
|
301
|
+
Source: [code.visualstudio.com](https://code.visualstudio.com/docs/copilot/customization/prompt-files) (official)
|
|
302
|
+
|
|
303
|
+
**Pattern:** `.github/prompts/<NAME>.prompt.md` — **manually invoked** task templates, fundamentally different from instructions:
|
|
304
|
+
|
|
305
|
+
> "Unlike custom instructions that apply automatically, you invoke prompt files manually in chat."
|
|
306
|
+
|
|
307
|
+
Instructions = rules/standards (always-on or pattern-matched). Prompt files = tasks/workflows (manually invoked via `/name`).
|
|
308
|
+
|
|
309
|
+
**Frontmatter fields:** `name`, `description`, `argument-hint`, `agent`, `model`, `tools`.
|
|
310
|
+
Body supports file references (`[name](path)` or `#file:path`), tool references (`#tool:name`), and variable syntax (`${workspaceFolder}`, `${selection}`, `${input:varName}`).
|
|
311
|
+
|
|
312
|
+
### 4.4 Custom Agent Files
|
|
313
|
+
|
|
314
|
+
**Pattern:** `*.agent.md` — custom agents with rich frontmatter.
|
|
315
|
+
|
|
316
|
+
| Field | Required | Description |
|
|
317
|
+
| ------------- | -------- | -------------------------------------------------------------- |
|
|
318
|
+
| `description` | **Yes** | Agent purpose and capabilities |
|
|
319
|
+
| `name` | No | Display name |
|
|
320
|
+
| `target` | No | `vscode` or `github-copilot` (defaults to both) |
|
|
321
|
+
| `tools` | No | List of tool names; defaults to all |
|
|
322
|
+
| `infer` | No | Auto-selection based on task context (default: `true`) |
|
|
323
|
+
| `mcp-servers` | No | Additional MCP servers (org/enterprise only for direct config) |
|
|
324
|
+
| `metadata` | No | Key-value annotation |
|
|
325
|
+
|
|
326
|
+
Body max: **30,000 characters.**
|
|
327
|
+
|
|
328
|
+
### 4.5 AGENTS.md Support
|
|
329
|
+
|
|
330
|
+
Copilot reads AGENTS.md natively. The full list of supported instruction file types:
|
|
331
|
+
|
|
332
|
+
- `/.github/copilot-instructions.md`
|
|
333
|
+
- `/.github/instructions/**/*.instructions.md`
|
|
334
|
+
- `**/AGENTS.md`
|
|
335
|
+
- `/CLAUDE.md`
|
|
336
|
+
- `/GEMINI.md`
|
|
337
|
+
|
|
338
|
+
VS Code settings: `chat.useAgentsMdFile` (root), `chat.useNestedAgentsMdFiles` (subfolders, experimental).
|
|
339
|
+
|
|
340
|
+
The coding agent reads `**/AGENTS.md` anywhere in the repo — **nearest file takes precedence** based on proximity to files being edited.
|
|
341
|
+
|
|
342
|
+
### 4.6 Precedence
|
|
343
|
+
|
|
344
|
+
> "Personal instructions take the highest priority. Repository instructions come next, and then organization instructions are prioritized last. However, all sets of relevant instructions are provided to Copilot."
|
|
345
|
+
|
|
346
|
+
1. **Personal** (highest) — via github.com/copilot interface
|
|
347
|
+
2. **Repository** — copilot-instructions.md + matching scoped files + AGENTS.md
|
|
348
|
+
3. **Organization** (lowest) — via org settings; GitHub.com only (not IDEs), public preview
|
|
349
|
+
|
|
350
|
+
### 4.7 Coding Agent Environment
|
|
351
|
+
|
|
352
|
+
**File:** `.github/workflows/copilot-setup-steps.yml` — GitHub Actions workflow for pre-installing dependencies.
|
|
353
|
+
|
|
354
|
+
> "The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot."
|
|
355
|
+
|
|
356
|
+
Must be on the default branch. Timeout capped at 59 minutes. The coding agent has read-only repo access and can only push to `copilot/` branches.
|
|
357
|
+
|
|
358
|
+
### 4.8 Feature Support Matrix
|
|
359
|
+
|
|
360
|
+
| Feature | copilot-instructions.md | \*.instructions.md | AGENTS.md | Organization |
|
|
361
|
+
| -------------------- | ----------------------- | ------------------ | --------- | ------------ |
|
|
362
|
+
| Chat (GitHub.com) | Yes | Yes | — | Yes |
|
|
363
|
+
| Chat (VS Code) | Yes | Yes | Yes | No |
|
|
364
|
+
| Code review | Yes | Yes (configurable) | — | Yes |
|
|
365
|
+
| Coding agent | Yes | Yes | Yes | Yes |
|
|
366
|
+
| **Code completions** | **No** | **No** | **No** | **No** |
|
|
367
|
+
|
|
368
|
+
> Custom instructions "are not taken into account for inline suggestions as you type in the editor."
|
|
369
|
+
|
|
370
|
+
### 4.9 VS Code Settings
|
|
371
|
+
|
|
372
|
+
| Setting | Purpose |
|
|
373
|
+
| ---------------------------------- | -------------------------------------- |
|
|
374
|
+
| `chat.instructionsFilesLocations` | Where to find instruction files |
|
|
375
|
+
| `chat.promptFilesLocations` | Where to find prompt files |
|
|
376
|
+
| `chat.includeApplyingInstructions` | Enable pattern-based matching |
|
|
377
|
+
| `chat.useAgentsMdFile` | Enable AGENTS.md detection |
|
|
378
|
+
| `chat.useNestedAgentsMdFiles` | Enable nested AGENTS.md (experimental) |
|
|
379
|
+
| `chat.useClaudeMdFile` | Enable CLAUDE.md detection |
|
|
380
|
+
|
|
381
|
+
---
|
|
382
|
+
|
|
383
|
+
## 5. Cross-Provider Comparison
|
|
384
|
+
|
|
385
|
+
### 5.1 File Pattern Scoping
|
|
386
|
+
|
|
387
|
+
All three providers support file-pattern-based activation — this is the unifying "rules" concept:
|
|
388
|
+
|
|
389
|
+
| Provider | Mechanism | Frontmatter field | Pattern syntax |
|
|
390
|
+
| ----------- | ---------------------------------------- | --------------------------- | ------------------------------------ |
|
|
391
|
+
| Claude Code | `.claude/rules/*.md` | `paths` (array) | Glob: `**/*.ts`, `{src,lib}/**/*.ts` |
|
|
392
|
+
| Cursor | `.cursor/rules/*.mdc` | `globs` (string or array) | Glob: `*.tsx`, `src/**/*.ts` |
|
|
393
|
+
| Copilot | `.github/instructions/*.instructions.md` | `applyTo` (comma-separated) | Glob: `**/*.ts,**/*.tsx` |
|
|
394
|
+
|
|
395
|
+
### 5.2 Activation Modes
|
|
396
|
+
|
|
397
|
+
| Mode | Claude Code | Cursor | Copilot |
|
|
398
|
+
| ------------------- | -------------------------------------- | --------------------------------- | ------------------------------------------------------ |
|
|
399
|
+
| Always on | Rules without `paths` / CLAUDE.md | `alwaysApply: true` | copilot-instructions.md |
|
|
400
|
+
| File-pattern scoped | Rules with `paths` | `globs` set | `applyTo` globs |
|
|
401
|
+
| Agent-determined | Skills (via description) | Agent Requested (via description) | N/A (description enables semantic matching in VS Code) |
|
|
402
|
+
| Manual invocation | Skills with `disable-model-invocation` | Manual @-mention | Prompt files (`/name`) |
|
|
403
|
+
|
|
404
|
+
### 5.3 Precedence Comparison
|
|
405
|
+
|
|
406
|
+
| Provider | Precedence (highest → lowest) |
|
|
407
|
+
| ----------- | ------------------------------------------------------------------------------------ |
|
|
408
|
+
| Claude Code | Managed > Project rules ≈ Project memory > User memory > Project local > Auto memory |
|
|
409
|
+
| Cursor | Team > Project > User |
|
|
410
|
+
| Copilot | Personal > Repository > Organization |
|
|
411
|
+
|
|
412
|
+
### 5.4 AGENTS.md Support
|
|
413
|
+
|
|
414
|
+
| Provider | Native support | Nested | Import mechanism |
|
|
415
|
+
| ----------- | -------------------------------- | ---------------------- | -------------------- |
|
|
416
|
+
| Claude Code | **No** (use `@AGENTS.md` import) | N/A | `@path` in CLAUDE.md |
|
|
417
|
+
| Cursor | **Yes** (first-class) | Yes (hierarchical) | N/A — read directly |
|
|
418
|
+
| Copilot | **Yes** (`**/AGENTS.md`) | Yes (nearest wins) | N/A — read directly |
|
|
419
|
+
| Codex | **Yes** (primary format) | Yes (override pattern) | N/A — native |
|
|
420
|
+
|
|
421
|
+
---
|
|
422
|
+
|
|
423
|
+
## 6. Quantitative Data: Sizes, Limits, Token Budgets
|
|
424
|
+
|
|
425
|
+
### Hard Limits (Documented)
|
|
426
|
+
|
|
427
|
+
| Provider | Limit | Source |
|
|
428
|
+
| -------------- | ----------------------------------------------------------------- | ---------------------------- |
|
|
429
|
+
| Codex | 32 KiB combined instruction files | OpenAI Codex docs (official) |
|
|
430
|
+
| Copilot | ~1,000 lines max per file | GitHub docs (official) |
|
|
431
|
+
| Copilot agents | 30,000 chars per agent body | GitHub docs (official) |
|
|
432
|
+
| Claude Code | Skill descriptions: 2% of context window (~16,000 chars fallback) | Claude Code docs (official) |
|
|
433
|
+
| Cursor | No documented hard limit; 500 lines recommended | Cursor docs (official) |
|
|
434
|
+
|
|
435
|
+
### Practical Sizing
|
|
436
|
+
|
|
437
|
+
| Metric | Target | Source type |
|
|
438
|
+
| --------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
439
|
+
| Root instruction file | 60–500 lines (300 good target) | Practitioner consensus |
|
|
440
|
+
| Scoped rules / .mdc files | Under 50–80 lines each | Community consensus |
|
|
441
|
+
| SKILL.md / prompt files | Under 500 lines; move reference to supporting files | Official (Claude) |
|
|
442
|
+
| Total instruction budget | Under 32 KiB as safe cross-provider ceiling | Official (Codex) |
|
|
443
|
+
| Fresh monorepo session cost | ~20k tokens (10% of 200k budget) | Practitioner ([Shrivu Shankar](https://blog.sshh.io/p/how-i-use-every-claude-code-feature)) |
|
|
444
|
+
| LLM instruction adherence | Degrades significantly above 150–200 instructions | [Builder.io](https://www.builder.io/c/docs/ai-instruction-best-practices) (non-official) |
|
|
445
|
+
|
|
446
|
+
---
|
|
447
|
+
|
|
448
|
+
## 7. Context Engineering Principles
|
|
449
|
+
|
|
450
|
+
Source: [Anthropic Engineering](https://www.anthropic.com/engineering/effective-context-engineering-for-ai-agents) (official)
|
|
451
|
+
|
|
452
|
+
1. **Context is a finite resource with diminishing returns.** Attention budget constraints mean more context does not equal better results.
|
|
453
|
+
|
|
454
|
+
2. **Pursue the minimal set** of information that fully outlines expected behavior. Start minimal, add based on observed failures.
|
|
455
|
+
|
|
456
|
+
3. **Use progressive disclosure.** Always-on rules should be minimal; domain knowledge should load on demand via skills or scoped rules.
|
|
457
|
+
|
|
458
|
+
4. **Few-shot examples over exhaustive edge case lists.** "Examples are the pictures worth a thousand words."
|
|
459
|
+
|
|
460
|
+
5. **Structural format.** Organize instructions into distinct sections using Markdown headers. Put critical rules near the top (positional recall bias).
|
|
461
|
+
|
|
462
|
+
Source: [Martin Fowler](https://martinfowler.com/articles/exploring-gen-ai/context-engineering-coding-agents.html) (reputable engineering source)
|
|
463
|
+
|
|
464
|
+
Context loading strategies:
|
|
465
|
+
|
|
466
|
+
- **LLM-controlled**: Agent decides when context is needed (skills, agent-requested rules)
|
|
467
|
+
- **Human-triggered**: Explicit activation via commands (manual rules, prompt files)
|
|
468
|
+
- **Deterministic**: Tool-driven events (hooks, auto-attached rules)
|
|
469
|
+
|
|
470
|
+
---
|
|
471
|
+
|
|
472
|
+
## 8. Best Practices (Cross-Provider Consensus)
|
|
473
|
+
|
|
474
|
+
These practices converge across official docs from Anthropic, GitHub, and Cursor, plus reputable engineering sources.
|
|
475
|
+
|
|
476
|
+
### What to Include
|
|
477
|
+
|
|
478
|
+
- Build, test, lint commands the agent cannot guess
|
|
479
|
+
- Code style rules that differ from language defaults
|
|
480
|
+
- Repository etiquette (branch naming, PR conventions)
|
|
481
|
+
- Architectural decisions specific to the project
|
|
482
|
+
- Developer environment quirks (required env vars)
|
|
483
|
+
- Common gotchas or non-obvious behaviors
|
|
484
|
+
- The "WHY" behind conventions (improves edge case handling)
|
|
485
|
+
- Three-tier boundaries: Always / Ask First / Never
|
|
486
|
+
|
|
487
|
+
### What to Exclude
|
|
488
|
+
|
|
489
|
+
- Anything the agent can figure out by reading code
|
|
490
|
+
- Standard language conventions the agent already knows
|
|
491
|
+
- Detailed API documentation (link instead)
|
|
492
|
+
- Code style that a linter enforces — "never send an LLM to do a linter's job" ([Builder.io](https://www.builder.io/blog/agents-md), non-official)
|
|
493
|
+
- Information that changes frequently
|
|
494
|
+
- Long explanations or tutorials
|
|
495
|
+
- One-off task-specific instructions (pollute long-term context)
|
|
496
|
+
|
|
497
|
+
### Writing Style
|
|
498
|
+
|
|
499
|
+
- Use concrete, specific language; avoid vague instructions
|
|
500
|
+
- Provide real-world examples from the actual codebase
|
|
501
|
+
- Use markdown headings for clear section organization
|
|
502
|
+
- Keep instructions short and self-contained
|
|
503
|
+
- Use emphasis ("IMPORTANT", "YOU MUST") sparingly for critical rules (Claude official)
|
|
504
|
+
- Provide alternatives ("use Y instead") rather than only prohibitions ("never use X")
|
|
505
|
+
|
|
506
|
+
### Iterative Development
|
|
507
|
+
|
|
508
|
+
- Start small; add rules based on what the agent gets wrong, not as comprehensive manuals
|
|
509
|
+
- "Each addition should solve a real problem you have encountered, not theoretical concerns" ([Addy Osmani](https://addyosmani.com/blog/good-spec/), non-official)
|
|
510
|
+
- Treat instruction files like code: review when things go wrong, prune regularly, version control
|
|
511
|
+
- "If Claude keeps doing something you don't want despite having a rule against it, the file is probably too long" (Claude official)
|
|
512
|
+
|
|
513
|
+
---
|
|
514
|
+
|
|
515
|
+
## 9. Anti-Patterns
|
|
516
|
+
|
|
517
|
+
### Content Anti-Patterns
|
|
518
|
+
|
|
519
|
+
1. **Over-specified instruction files**: Too long; agent ignores critical rules lost in noise. Fix: ruthlessly prune.
|
|
520
|
+
2. **Vague instructions**: "Most agent files fail because they're too vague." ([Addy Osmani](https://addyosmani.com/blog/good-spec/), non-official) Fix: be specific with examples.
|
|
521
|
+
3. **Auto-generated instruction files**: These are high-leverage documents requiring careful manual curation.
|
|
522
|
+
4. **Stale rules**: Rules that don't match current framework/API versions cause deprecated code generation.
|
|
523
|
+
5. **Kitchen sink sessions**: Mixing unrelated tasks pollutes context. Fix: clear between tasks. (Claude official)
|
|
524
|
+
6. **Dumping entire documentation**: Without summarization, this overwhelms the agent. Fix: link to docs instead.
|
|
525
|
+
|
|
526
|
+
### Structural Anti-Patterns
|
|
527
|
+
|
|
528
|
+
7. **Copy/pasting root content into scoped files**: Creates drift. Fix: use imports or references.
|
|
529
|
+
8. **Circular imports or deep include chains**: Fix: max 5 hops (Claude), keep flat.
|
|
530
|
+
9. **Relying on subtle tool-specific precedence**: Different tools merge differently. Fix: design so intent is clear regardless of tool.
|
|
531
|
+
10. **Over-scoping monorepos into dozens of tiny files**: Fix: scope only where real divergence exists.
|
|
532
|
+
|
|
533
|
+
---
|
|
534
|
+
|
|
535
|
+
## 10. Portability Strategy
|
|
536
|
+
|
|
537
|
+
### The Fragmentation Problem
|
|
538
|
+
|
|
539
|
+
Each tool has its own format: Claude (`CLAUDE.md` + `.claude/`), Cursor (`.cursor/rules/*.mdc`), Copilot (`.github/copilot-instructions.md` + `.github/instructions/`), Codex (`AGENTS.md`), Junie (`.junie/guidelines.md`). This creates maintenance burden and content drift.
|
|
540
|
+
|
|
541
|
+
### AGENTS.md as Convergence Point
|
|
542
|
+
|
|
543
|
+
AGENTS.md (stewarded by the Linux Foundation's Agentic AI Foundation) has 60,000+ repos and 20+ compatible tools. It serves as the lowest-common-denominator standard — the "EditorConfig for coding agents." It cannot express tool-specific features (glob scoping, skill metadata, hooks) but works for shared content.
|
|
544
|
+
|
|
545
|
+
### Recommended Layered Approach
|
|
546
|
+
|
|
547
|
+
1. **Canonical content** in AGENTS.md or a shared source directory
|
|
548
|
+
2. **Tool-specific adapters** that import/sync from the canonical source
|
|
549
|
+
3. **Tool-specific extensions** for features that don't port (Claude rules with `paths`, Cursor `globs`, Copilot `applyTo`)
|
|
550
|
+
|
|
551
|
+
The three-tier discovery pattern (global > project root > nested/scoped) is consistent across all providers and provides a natural adapter surface.
|
|
552
|
+
|
|
553
|
+
---
|
|
554
|
+
|
|
555
|
+
## 11. Sources
|
|
556
|
+
|
|
557
|
+
### Official Documentation (Highest Reliability)
|
|
558
|
+
|
|
559
|
+
- [Claude Code Memory Docs](https://code.claude.com/docs/en/memory) — CLAUDE.md hierarchy, @-imports, rules, auto memory
|
|
560
|
+
- [Claude Code Settings](https://code.claude.com/docs/en/settings) — Settings hierarchy, permissions
|
|
561
|
+
- [Claude Code Best Practices](https://code.claude.com/docs/en/best-practices) — What to include/exclude, anti-patterns
|
|
562
|
+
- [Claude Code Skills](https://code.claude.com/docs/en/skills) — Skills vs rules vs CLAUDE.md
|
|
563
|
+
- [Cursor Rules Docs](https://cursor.com/docs/context/rules) — .mdc format, frontmatter, activation modes, AGENTS.md, precedence
|
|
564
|
+
- [GitHub Copilot Custom Instructions](https://docs.github.com/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot) — File format, scoped instructions, precedence
|
|
565
|
+
- [VS Code Copilot Customization](https://code.visualstudio.com/docs/copilot/customization/custom-instructions) — VS Code settings, AGENTS.md, CLAUDE.md support
|
|
566
|
+
- [VS Code Prompt Files](https://code.visualstudio.com/docs/copilot/customization/prompt-files) — Prompt file format and frontmatter
|
|
567
|
+
- [GitHub Copilot Custom Agents Reference](https://docs.github.com/en/copilot/reference/custom-agents-configuration) — Agent file format
|
|
568
|
+
- [GitHub Copilot Coding Agent Environment](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment) — copilot-setup-steps.yml
|
|
569
|
+
- [GitHub Copilot Organization Instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-organization-instructions) — Org-level settings
|
|
570
|
+
- [Anthropic Context Engineering](https://www.anthropic.com/engineering/effective-context-engineering-for-ai-agents) — Foundational principles
|
|
571
|
+
- [AGENTS.md Specification](https://agents.md/) — Cross-tool standard, governance
|
|
572
|
+
- [OpenAI Codex AGENTS.md Guide](https://developers.openai.com/codex/guides/agents-md/) — 32KiB limit, hierarchy, override pattern
|
|
573
|
+
- [Feature Request: AGENTS.md in Claude Code — Issue #6235](https://github.com/anthropics/claude-code/issues/6235) — Current status
|
|
574
|
+
|
|
575
|
+
### Reputable Engineering Blogs (High Reliability)
|
|
576
|
+
|
|
577
|
+
- [Martin Fowler — Context Engineering for Coding Agents](https://martinfowler.com/articles/exploring-gen-ai/context-engineering-coding-agents.html) — Context loading strategies taxonomy
|
|
578
|
+
- [Addy Osmani — How to Write a Good Spec for AI Agents](https://addyosmani.com/blog/good-spec/) — Spec structure, boundary tiers
|
|
579
|
+
- [Builder.io — Skills vs Rules vs Commands](https://www.builder.io/blog/agent-skills-rules-commands) — Taxonomy, progressive disclosure
|
|
580
|
+
- [Builder.io — AGENTS.md Guide](https://www.builder.io/blog/agents-md) — Practical tips, safety permissions
|
|
581
|
+
- [Trigger.dev — How to Write Great Cursor Rules](https://trigger.dev/blog/cursor-rules) — .mdc best practices
|
|
582
|
+
- [.NET Blog — Prompt Files and Instructions Files Explained](https://devblogs.microsoft.com/dotnet/prompt-files-and-instructions-files-explained/) — Copilot prompt files vs instructions
|
|
583
|
+
|
|
584
|
+
### Practitioner Reports (Medium-High Reliability)
|
|
585
|
+
|
|
586
|
+
- [Shrivu Shankar — How I Use Every Claude Code Feature](https://blog.sshh.io/p/how-i-use-every-claude-code-feature) — 13KB CLAUDE.md in practice, 20k token startup cost
|
|
587
|
+
- [HumanLayer — Writing a Good CLAUDE.md](https://www.humanlayer.dev/blog/writing-a-good-claude-md) — 300-line target, 100 instruction max
|
|
588
|
+
- [Arun Iyer — Instruction Files for AI Coding Assistants](https://aruniyer.github.io/blog/agents-md-instruction-files.html) — Cross-tool comparison
|
|
589
|
+
|
|
590
|
+
### Research
|
|
591
|
+
|
|
592
|
+
- [ManyIFEval — "Curse of Instructions"](https://openreview.net/forum?id=R6q67CDBCH) — Instruction count vs compliance
|
|
593
|
+
- ["Lost in the Middle"](https://arxiv.org/abs/2307.03172) — Positional recall bias
|
|
594
|
+
- [Context Degradation — Chroma Research](https://research.trychroma.com/context-rot) — Long-context precision loss
|