codexkit 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.codex/.env.example +27 -0
- package/.codex/.template-manifest.json +631 -0
- package/.codex/.version +1 -0
- package/.codex/agents/builder.toml +104 -0
- package/.codex/agents/debugger.toml +67 -0
- package/.codex/agents/general.toml +41 -0
- package/.codex/agents/painter.toml +40 -0
- package/.codex/agents/planner.toml +60 -0
- package/.codex/agents/refactorer.toml +76 -0
- package/.codex/agents/reviewer.toml +60 -0
- package/.codex/agents/runner.toml +40 -0
- package/.codex/agents/scout.toml +133 -0
- package/.codex/agents/shipper.toml +69 -0
- package/.codex/agents/vision.toml +69 -0
- package/.codex/config.toml +146 -0
- package/.codex/context/architecture.md +66 -0
- package/.codex/context/conventions.md +98 -0
- package/.codex/context/current-priorities.md +33 -0
- package/.codex/context/decision-log.md +93 -0
- package/.codex/context/gotchas.md +42 -0
- package/.codex/context/index.md +21 -0
- package/.codex/context/session-context.md +11 -0
- package/.codex/context/worklog.md +9 -0
- package/.codex/hooks/README.md +17 -0
- package/.codex/hooks/after_agent.sh +11 -0
- package/.codex/hooks/after_tool_use.sh +10 -0
- package/.codex/hooks/post_commit.sh +10 -0
- package/.codex/hooks/pre_commit.sh +6 -0
- package/.codex/hooks/session_start.sh +18 -0
- package/.codex/hooks/stop.sh +10 -0
- package/.codex/mcp/README.md +143 -0
- package/.codex/mcp/basic-memory.toml.example +10 -0
- package/.codex/mcp/context7.toml.example +13 -0
- package/.codex/mcp/exa.toml.example +12 -0
- package/.codex/mcp/memory-bridge.toml.example +15 -0
- package/.codex/mcp/memory.toml.example +6 -0
- package/.codex/mcp/ref.toml.example +13 -0
- package/.codex/mcp/tilth.toml.example +10 -0
- package/.codex/memory/README.md +29 -0
- package/.codex/memory/_templates/README.md +26 -0
- package/.codex/memory/_templates/design.md +15 -0
- package/.codex/memory/_templates/gotcha.md +9 -0
- package/.codex/memory/_templates/handoff.md +9 -0
- package/.codex/memory/_templates/prd.md +13 -0
- package/.codex/memory/_templates/project.md +9 -0
- package/.codex/memory/_templates/proposal.md +13 -0
- package/.codex/memory/_templates/research.md +9 -0
- package/.codex/memory/_templates/roadmap.md +11 -0
- package/.codex/memory/_templates/session-context.md +7 -0
- package/.codex/memory/_templates/state.md +11 -0
- package/.codex/memory/_templates/tasks.md +9 -0
- package/.codex/memory/_templates/tech-stack.md +9 -0
- package/.codex/memory/_templates/user.md +7 -0
- package/.codex/memory/project/gotchas.md +5 -0
- package/.codex/memory/project/project.md +12 -0
- package/.codex/memory/project/roadmap.md +15 -0
- package/.codex/memory/project/state.md +22 -0
- package/.codex/memory/project/tech-stack.md +19 -0
- package/.codex/memory/project/user.md +10 -0
- package/.codex/memory/research/.gitkeep +1 -0
- package/.codex/memory/session-context.md +18 -0
- package/.codex/plans/README.md +7 -0
- package/.codex/prompts/compound.md +154 -0
- package/.codex/prompts/create.md +238 -0
- package/.codex/prompts/design.md +90 -0
- package/.codex/prompts/handoff.md +184 -0
- package/.codex/prompts/init-context.md +185 -0
- package/.codex/prompts/init-user.md +93 -0
- package/.codex/prompts/init.md +103 -0
- package/.codex/prompts/lfg.md +140 -0
- package/.codex/prompts/plan.md +140 -0
- package/.codex/prompts/pr.md +150 -0
- package/.codex/prompts/research.md +137 -0
- package/.codex/prompts/resume.md +105 -0
- package/.codex/prompts/review-codebase.md +147 -0
- package/.codex/prompts/ship.md +334 -0
- package/.codex/prompts/start.md +141 -0
- package/.codex/prompts/status.md +102 -0
- package/.codex/prompts/ui-inspire.md +151 -0
- package/.codex/prompts/ui-review.md +86 -0
- package/.codex/prompts/verify.md +181 -0
- package/.codex/scripts/append_worklog.sh +20 -0
- package/.codex/scripts/apply_worklog_archive.sh +48 -0
- package/.codex/scripts/audit_memory_hygiene.sh +102 -0
- package/.codex/scripts/build_memory_index.sh +167 -0
- package/.codex/scripts/build_prior_related_work.sh +127 -0
- package/.codex/scripts/build_startup_brief.sh +52 -0
- package/.codex/scripts/close_bead.sh +103 -0
- package/.codex/scripts/detect_changed_files.sh +38 -0
- package/.codex/scripts/ensure_beads.sh +14 -0
- package/.codex/scripts/memory_search.sh +292 -0
- package/.codex/scripts/prepare_worklog_archive.sh +115 -0
- package/.codex/scripts/search_bead_context.sh +214 -0
- package/.codex/scripts/start_bead.sh +129 -0
- package/.codex/scripts/sync_bead_context.sh +288 -0
- package/.codex/scripts/validate_memory_docs.sh +44 -0
- package/.codex/scripts/verify_bead.sh +154 -0
- package/.codex/skills/accessibility-audit/SKILL.md +191 -0
- package/.codex/skills/agent-browser/SKILL.md +413 -0
- package/.codex/skills/agent-teams/SKILL.md +268 -0
- package/.codex/skills/augment-context-engine/SKILL.md +115 -0
- package/.codex/skills/augment-context-engine/mcp.json +6 -0
- package/.codex/skills/beads/SKILL.md +181 -0
- package/.codex/skills/beads/references/BEST_PRACTICES.md +27 -0
- package/.codex/skills/beads/references/BOUNDARIES.md +219 -0
- package/.codex/skills/beads/references/DEPENDENCIES.md +124 -0
- package/.codex/skills/beads/references/EXAMPLES.md +45 -0
- package/.codex/skills/beads/references/FILE_CLAIMING.md +101 -0
- package/.codex/skills/beads/references/GIT_SYNC.md +25 -0
- package/.codex/skills/beads/references/HIERARCHY.md +71 -0
- package/.codex/skills/beads/references/MULTI_AGENT.md +40 -0
- package/.codex/skills/beads/references/RESUMABILITY.md +177 -0
- package/.codex/skills/beads/references/SESSION_PROTOCOL.md +61 -0
- package/.codex/skills/beads/references/TASK_CREATION.md +38 -0
- package/.codex/skills/beads/references/TROUBLESHOOTING.md +38 -0
- package/.codex/skills/beads/references/WORKFLOWS.md +226 -0
- package/.codex/skills/beads-bridge/SKILL.md +321 -0
- package/.codex/skills/brainstorming/SKILL.md +114 -0
- package/.codex/skills/bug-triage/SKILL.md +191 -0
- package/.codex/skills/chrome-devtools/SKILL.md +76 -0
- package/.codex/skills/chrome-devtools/mcp.json +19 -0
- package/.codex/skills/cloudflare/SKILL.md +253 -0
- package/.codex/skills/cloudflare/references/agents-sdk/README.md +35 -0
- package/.codex/skills/cloudflare/references/agents-sdk/api.md +100 -0
- package/.codex/skills/cloudflare/references/agents-sdk/configuration.md +99 -0
- package/.codex/skills/cloudflare/references/agents-sdk/gotchas.md +59 -0
- package/.codex/skills/cloudflare/references/agents-sdk/patterns.md +89 -0
- package/.codex/skills/cloudflare/references/ai-gateway/README.md +695 -0
- package/.codex/skills/cloudflare/references/ai-search/README.md +14 -0
- package/.codex/skills/cloudflare/references/ai-search/api.md +38 -0
- package/.codex/skills/cloudflare/references/ai-search/configuration.md +52 -0
- package/.codex/skills/cloudflare/references/ai-search/gotchas.md +41 -0
- package/.codex/skills/cloudflare/references/ai-search/patterns.md +45 -0
- package/.codex/skills/cloudflare/references/analytics-engine/README.md +14 -0
- package/.codex/skills/cloudflare/references/analytics-engine/api.md +27 -0
- package/.codex/skills/cloudflare/references/analytics-engine/configuration.md +45 -0
- package/.codex/skills/cloudflare/references/analytics-engine/gotchas.md +3 -0
- package/.codex/skills/cloudflare/references/analytics-engine/patterns.md +36 -0
- package/.codex/skills/cloudflare/references/api/README.md +21 -0
- package/.codex/skills/cloudflare/references/api/api.md +31 -0
- package/.codex/skills/cloudflare/references/api/configuration.md +20 -0
- package/.codex/skills/cloudflare/references/api/gotchas.md +28 -0
- package/.codex/skills/cloudflare/references/api/patterns.md +47 -0
- package/.codex/skills/cloudflare/references/api-shield/README.md +20 -0
- package/.codex/skills/cloudflare/references/api-shield/api.md +78 -0
- package/.codex/skills/cloudflare/references/api-shield/configuration.md +128 -0
- package/.codex/skills/cloudflare/references/api-shield/gotchas.md +51 -0
- package/.codex/skills/cloudflare/references/api-shield/patterns.md +145 -0
- package/.codex/skills/cloudflare/references/argo-smart-routing/README.md +16 -0
- package/.codex/skills/cloudflare/references/argo-smart-routing/api.md +50 -0
- package/.codex/skills/cloudflare/references/argo-smart-routing/configuration.md +53 -0
- package/.codex/skills/cloudflare/references/argo-smart-routing/gotchas.md +16 -0
- package/.codex/skills/cloudflare/references/argo-smart-routing/patterns.md +45 -0
- package/.codex/skills/cloudflare/references/bindings/README.md +14 -0
- package/.codex/skills/cloudflare/references/bindings/api.md +3 -0
- package/.codex/skills/cloudflare/references/bindings/configuration.md +58 -0
- package/.codex/skills/cloudflare/references/bindings/gotchas.md +35 -0
- package/.codex/skills/cloudflare/references/bindings/patterns.md +37 -0
- package/.codex/skills/cloudflare/references/bot-management/README.md +71 -0
- package/.codex/skills/cloudflare/references/bot-management/api.md +168 -0
- package/.codex/skills/cloudflare/references/bot-management/configuration.md +114 -0
- package/.codex/skills/cloudflare/references/bot-management/gotchas.md +99 -0
- package/.codex/skills/cloudflare/references/bot-management/patterns.md +125 -0
- package/.codex/skills/cloudflare/references/browser-rendering/README.md +16 -0
- package/.codex/skills/cloudflare/references/browser-rendering/api.md +54 -0
- package/.codex/skills/cloudflare/references/browser-rendering/configuration.md +47 -0
- package/.codex/skills/cloudflare/references/browser-rendering/gotchas.md +29 -0
- package/.codex/skills/cloudflare/references/browser-rendering/patterns.md +29 -0
- package/.codex/skills/cloudflare/references/c3/README.md +264 -0
- package/.codex/skills/cloudflare/references/cache-reserve/README.md +93 -0
- package/.codex/skills/cloudflare/references/cache-reserve/api.md +176 -0
- package/.codex/skills/cloudflare/references/cache-reserve/configuration.md +164 -0
- package/.codex/skills/cloudflare/references/cache-reserve/gotchas.md +203 -0
- package/.codex/skills/cloudflare/references/cache-reserve/patterns.md +180 -0
- package/.codex/skills/cloudflare/references/containers/README.md +16 -0
- package/.codex/skills/cloudflare/references/containers/api.md +43 -0
- package/.codex/skills/cloudflare/references/containers/configuration.md +56 -0
- package/.codex/skills/cloudflare/references/containers/gotchas.md +21 -0
- package/.codex/skills/cloudflare/references/containers/patterns.md +40 -0
- package/.codex/skills/cloudflare/references/cron-triggers/README.md +85 -0
- package/.codex/skills/cloudflare/references/cron-triggers/api.md +198 -0
- package/.codex/skills/cloudflare/references/cron-triggers/configuration.md +151 -0
- package/.codex/skills/cloudflare/references/cron-triggers/gotchas.md +129 -0
- package/.codex/skills/cloudflare/references/cron-triggers/patterns.md +122 -0
- package/.codex/skills/cloudflare/references/d1/README.md +92 -0
- package/.codex/skills/cloudflare/references/d1/api.md +141 -0
- package/.codex/skills/cloudflare/references/d1/configuration.md +127 -0
- package/.codex/skills/cloudflare/references/d1/gotchas.md +70 -0
- package/.codex/skills/cloudflare/references/d1/patterns.md +144 -0
- package/.codex/skills/cloudflare/references/ddos/README.md +34 -0
- package/.codex/skills/cloudflare/references/ddos/api.md +136 -0
- package/.codex/skills/cloudflare/references/ddos/configuration.md +67 -0
- package/.codex/skills/cloudflare/references/ddos/gotchas.md +114 -0
- package/.codex/skills/cloudflare/references/ddos/patterns.md +158 -0
- package/.codex/skills/cloudflare/references/do-storage/README.md +62 -0
- package/.codex/skills/cloudflare/references/do-storage/api.md +89 -0
- package/.codex/skills/cloudflare/references/do-storage/configuration.md +116 -0
- package/.codex/skills/cloudflare/references/do-storage/gotchas.md +93 -0
- package/.codex/skills/cloudflare/references/do-storage/patterns.md +112 -0
- package/.codex/skills/cloudflare/references/durable-objects/README.md +125 -0
- package/.codex/skills/cloudflare/references/durable-objects/api.md +152 -0
- package/.codex/skills/cloudflare/references/durable-objects/configuration.md +148 -0
- package/.codex/skills/cloudflare/references/durable-objects/gotchas.md +158 -0
- package/.codex/skills/cloudflare/references/durable-objects/patterns.md +255 -0
- package/.codex/skills/cloudflare/references/email-routing/README.md +18 -0
- package/.codex/skills/cloudflare/references/email-routing/api.md +46 -0
- package/.codex/skills/cloudflare/references/email-routing/configuration.md +63 -0
- package/.codex/skills/cloudflare/references/email-routing/gotchas.md +16 -0
- package/.codex/skills/cloudflare/references/email-routing/patterns.md +46 -0
- package/.codex/skills/cloudflare/references/email-workers/README.md +598 -0
- package/.codex/skills/cloudflare/references/hyperdrive/README.md +62 -0
- package/.codex/skills/cloudflare/references/hyperdrive/api.md +137 -0
- package/.codex/skills/cloudflare/references/hyperdrive/configuration.md +133 -0
- package/.codex/skills/cloudflare/references/hyperdrive/gotchas.md +184 -0
- package/.codex/skills/cloudflare/references/hyperdrive/patterns.md +176 -0
- package/.codex/skills/cloudflare/references/images/README.md +14 -0
- package/.codex/skills/cloudflare/references/images/api.md +3 -0
- package/.codex/skills/cloudflare/references/images/configuration.md +45 -0
- package/.codex/skills/cloudflare/references/images/gotchas.md +23 -0
- package/.codex/skills/cloudflare/references/images/patterns.md +31 -0
- package/.codex/skills/cloudflare/references/kv/README.md +60 -0
- package/.codex/skills/cloudflare/references/kv/api.md +114 -0
- package/.codex/skills/cloudflare/references/kv/configuration.md +92 -0
- package/.codex/skills/cloudflare/references/kv/gotchas.md +117 -0
- package/.codex/skills/cloudflare/references/kv/patterns.md +139 -0
- package/.codex/skills/cloudflare/references/miniflare/README.md +64 -0
- package/.codex/skills/cloudflare/references/miniflare/api.md +144 -0
- package/.codex/skills/cloudflare/references/miniflare/configuration.md +203 -0
- package/.codex/skills/cloudflare/references/miniflare/gotchas.md +187 -0
- package/.codex/skills/cloudflare/references/miniflare/patterns.md +211 -0
- package/.codex/skills/cloudflare/references/network-interconnect/README.md +60 -0
- package/.codex/skills/cloudflare/references/network-interconnect/api.md +240 -0
- package/.codex/skills/cloudflare/references/network-interconnect/configuration.md +127 -0
- package/.codex/skills/cloudflare/references/network-interconnect/gotchas.md +171 -0
- package/.codex/skills/cloudflare/references/network-interconnect/patterns.md +171 -0
- package/.codex/skills/cloudflare/references/observability/README.md +18 -0
- package/.codex/skills/cloudflare/references/observability/api.md +51 -0
- package/.codex/skills/cloudflare/references/observability/configuration.md +60 -0
- package/.codex/skills/cloudflare/references/observability/gotchas.md +36 -0
- package/.codex/skills/cloudflare/references/observability/patterns.md +42 -0
- package/.codex/skills/cloudflare/references/pages/README.md +76 -0
- package/.codex/skills/cloudflare/references/pages/api.md +200 -0
- package/.codex/skills/cloudflare/references/pages/configuration.md +228 -0
- package/.codex/skills/cloudflare/references/pages/gotchas.md +161 -0
- package/.codex/skills/cloudflare/references/pages/patterns.md +145 -0
- package/.codex/skills/cloudflare/references/pages-functions/README.md +57 -0
- package/.codex/skills/cloudflare/references/pages-functions/api.md +201 -0
- package/.codex/skills/cloudflare/references/pages-functions/configuration.md +159 -0
- package/.codex/skills/cloudflare/references/pages-functions/gotchas.md +151 -0
- package/.codex/skills/cloudflare/references/pages-functions/patterns.md +190 -0
- package/.codex/skills/cloudflare/references/pipelines/README.md +664 -0
- package/.codex/skills/cloudflare/references/pulumi/README.md +107 -0
- package/.codex/skills/cloudflare/references/pulumi/api.md +194 -0
- package/.codex/skills/cloudflare/references/pulumi/configuration.md +216 -0
- package/.codex/skills/cloudflare/references/pulumi/gotchas.md +223 -0
- package/.codex/skills/cloudflare/references/pulumi/patterns.md +139 -0
- package/.codex/skills/cloudflare/references/queues/README.md +69 -0
- package/.codex/skills/cloudflare/references/queues/api.md +138 -0
- package/.codex/skills/cloudflare/references/queues/configuration.md +125 -0
- package/.codex/skills/cloudflare/references/queues/gotchas.md +112 -0
- package/.codex/skills/cloudflare/references/queues/patterns.md +155 -0
- package/.codex/skills/cloudflare/references/r2/README.md +61 -0
- package/.codex/skills/cloudflare/references/r2/api.md +127 -0
- package/.codex/skills/cloudflare/references/r2/configuration.md +76 -0
- package/.codex/skills/cloudflare/references/r2/gotchas.md +94 -0
- package/.codex/skills/cloudflare/references/r2/patterns.md +127 -0
- package/.codex/skills/cloudflare/references/r2-data-catalog/README.md +18 -0
- package/.codex/skills/cloudflare/references/r2-data-catalog/api.md +29 -0
- package/.codex/skills/cloudflare/references/r2-data-catalog/configuration.md +39 -0
- package/.codex/skills/cloudflare/references/r2-data-catalog/gotchas.md +20 -0
- package/.codex/skills/cloudflare/references/r2-data-catalog/patterns.md +46 -0
- package/.codex/skills/cloudflare/references/r2-sql/README.md +512 -0
- package/.codex/skills/cloudflare/references/realtime-sfu/README.md +21 -0
- package/.codex/skills/cloudflare/references/realtime-sfu/api.md +135 -0
- package/.codex/skills/cloudflare/references/realtime-sfu/configuration.md +63 -0
- package/.codex/skills/cloudflare/references/realtime-sfu/gotchas.md +75 -0
- package/.codex/skills/cloudflare/references/realtime-sfu/patterns.md +102 -0
- package/.codex/skills/cloudflare/references/realtimekit/README.md +81 -0
- package/.codex/skills/cloudflare/references/realtimekit/api.md +164 -0
- package/.codex/skills/cloudflare/references/realtimekit/configuration.md +147 -0
- package/.codex/skills/cloudflare/references/realtimekit/gotchas.md +172 -0
- package/.codex/skills/cloudflare/references/realtimekit/patterns.md +155 -0
- package/.codex/skills/cloudflare/references/sandbox/README.md +90 -0
- package/.codex/skills/cloudflare/references/sandbox/api.md +178 -0
- package/.codex/skills/cloudflare/references/sandbox/configuration.md +131 -0
- package/.codex/skills/cloudflare/references/sandbox/gotchas.md +156 -0
- package/.codex/skills/cloudflare/references/sandbox/patterns.md +203 -0
- package/.codex/skills/cloudflare/references/secrets-store/README.md +58 -0
- package/.codex/skills/cloudflare/references/secrets-store/api.md +182 -0
- package/.codex/skills/cloudflare/references/secrets-store/configuration.md +140 -0
- package/.codex/skills/cloudflare/references/secrets-store/gotchas.md +129 -0
- package/.codex/skills/cloudflare/references/secrets-store/patterns.md +218 -0
- package/.codex/skills/cloudflare/references/smart-placement/README.md +91 -0
- package/.codex/skills/cloudflare/references/smart-placement/api.md +139 -0
- package/.codex/skills/cloudflare/references/smart-placement/configuration.md +129 -0
- package/.codex/skills/cloudflare/references/smart-placement/gotchas.md +87 -0
- package/.codex/skills/cloudflare/references/smart-placement/patterns.md +135 -0
- package/.codex/skills/cloudflare/references/snippets/README.md +15 -0
- package/.codex/skills/cloudflare/references/snippets/api.md +47 -0
- package/.codex/skills/cloudflare/references/snippets/configuration.md +33 -0
- package/.codex/skills/cloudflare/references/snippets/gotchas.md +21 -0
- package/.codex/skills/cloudflare/references/snippets/patterns.md +34 -0
- package/.codex/skills/cloudflare/references/spectrum/README.md +16 -0
- package/.codex/skills/cloudflare/references/spectrum/api.md +24 -0
- package/.codex/skills/cloudflare/references/spectrum/configuration.md +43 -0
- package/.codex/skills/cloudflare/references/spectrum/gotchas.md +42 -0
- package/.codex/skills/cloudflare/references/spectrum/patterns.md +40 -0
- package/.codex/skills/cloudflare/references/static-assets/README.md +14 -0
- package/.codex/skills/cloudflare/references/static-assets/api.md +3 -0
- package/.codex/skills/cloudflare/references/static-assets/configuration.md +47 -0
- package/.codex/skills/cloudflare/references/static-assets/gotchas.md +44 -0
- package/.codex/skills/cloudflare/references/static-assets/patterns.md +42 -0
- package/.codex/skills/cloudflare/references/stream/README.md +103 -0
- package/.codex/skills/cloudflare/references/stream/api.md +204 -0
- package/.codex/skills/cloudflare/references/stream/configuration.md +127 -0
- package/.codex/skills/cloudflare/references/stream/gotchas.md +131 -0
- package/.codex/skills/cloudflare/references/stream/patterns.md +152 -0
- package/.codex/skills/cloudflare/references/tail-workers/README.md +640 -0
- package/.codex/skills/cloudflare/references/terraform/README.md +76 -0
- package/.codex/skills/cloudflare/references/terraform/api.md +159 -0
- package/.codex/skills/cloudflare/references/terraform/configuration.md +156 -0
- package/.codex/skills/cloudflare/references/terraform/gotchas.md +207 -0
- package/.codex/skills/cloudflare/references/terraform/patterns.md +135 -0
- package/.codex/skills/cloudflare/references/tunnel/README.md +82 -0
- package/.codex/skills/cloudflare/references/tunnel/api.md +105 -0
- package/.codex/skills/cloudflare/references/tunnel/configuration.md +113 -0
- package/.codex/skills/cloudflare/references/tunnel/gotchas.md +115 -0
- package/.codex/skills/cloudflare/references/tunnel/patterns.md +157 -0
- package/.codex/skills/cloudflare/references/turn/README.md +699 -0
- package/.codex/skills/cloudflare/references/turnstile/README.md +14 -0
- package/.codex/skills/cloudflare/references/turnstile/api.md +3 -0
- package/.codex/skills/cloudflare/references/turnstile/configuration.md +19 -0
- package/.codex/skills/cloudflare/references/turnstile/gotchas.md +27 -0
- package/.codex/skills/cloudflare/references/turnstile/patterns.md +41 -0
- package/.codex/skills/cloudflare/references/vectorize/README.md +682 -0
- package/.codex/skills/cloudflare/references/waf/README.md +14 -0
- package/.codex/skills/cloudflare/references/waf/api.md +3 -0
- package/.codex/skills/cloudflare/references/waf/configuration.md +44 -0
- package/.codex/skills/cloudflare/references/waf/gotchas.md +24 -0
- package/.codex/skills/cloudflare/references/waf/patterns.md +29 -0
- package/.codex/skills/cloudflare/references/web-analytics/README.md +19 -0
- package/.codex/skills/cloudflare/references/web-analytics/api.md +52 -0
- package/.codex/skills/cloudflare/references/web-analytics/configuration.md +31 -0
- package/.codex/skills/cloudflare/references/web-analytics/gotchas.md +28 -0
- package/.codex/skills/cloudflare/references/web-analytics/patterns.md +52 -0
- package/.codex/skills/cloudflare/references/workerd/README.md +47 -0
- package/.codex/skills/cloudflare/references/workerd/api.md +199 -0
- package/.codex/skills/cloudflare/references/workerd/configuration.md +185 -0
- package/.codex/skills/cloudflare/references/workerd/gotchas.md +203 -0
- package/.codex/skills/cloudflare/references/workerd/patterns.md +216 -0
- package/.codex/skills/cloudflare/references/workers/README.md +96 -0
- package/.codex/skills/cloudflare/references/workers/api.md +137 -0
- package/.codex/skills/cloudflare/references/workers/configuration.md +147 -0
- package/.codex/skills/cloudflare/references/workers/gotchas.md +99 -0
- package/.codex/skills/cloudflare/references/workers/patterns.md +149 -0
- package/.codex/skills/cloudflare/references/workers-ai/README.md +116 -0
- package/.codex/skills/cloudflare/references/workers-for-platforms/README.md +48 -0
- package/.codex/skills/cloudflare/references/workers-for-platforms/api.md +169 -0
- package/.codex/skills/cloudflare/references/workers-for-platforms/configuration.md +136 -0
- package/.codex/skills/cloudflare/references/workers-for-platforms/gotchas.md +130 -0
- package/.codex/skills/cloudflare/references/workers-for-platforms/patterns.md +170 -0
- package/.codex/skills/cloudflare/references/workers-playground/README.md +16 -0
- package/.codex/skills/cloudflare/references/workers-playground/api.md +20 -0
- package/.codex/skills/cloudflare/references/workers-playground/configuration.md +3 -0
- package/.codex/skills/cloudflare/references/workers-playground/gotchas.md +35 -0
- package/.codex/skills/cloudflare/references/workers-playground/patterns.md +42 -0
- package/.codex/skills/cloudflare/references/workers-vpc/README.md +579 -0
- package/.codex/skills/cloudflare/references/workflows/README.md +62 -0
- package/.codex/skills/cloudflare/references/workflows/api.md +125 -0
- package/.codex/skills/cloudflare/references/workflows/configuration.md +177 -0
- package/.codex/skills/cloudflare/references/workflows/gotchas.md +136 -0
- package/.codex/skills/cloudflare/references/workflows/patterns.md +132 -0
- package/.codex/skills/cloudflare/references/wrangler/README.md +90 -0
- package/.codex/skills/cloudflare/references/wrangler/api.md +140 -0
- package/.codex/skills/cloudflare/references/wrangler/configuration.md +128 -0
- package/.codex/skills/cloudflare/references/wrangler/gotchas.md +93 -0
- package/.codex/skills/cloudflare/references/wrangler/patterns.md +150 -0
- package/.codex/skills/cloudflare/references/zaraz/README.md +360 -0
- package/.codex/skills/code-navigation/SKILL.md +130 -0
- package/.codex/skills/code-review/SKILL.md +208 -0
- package/.codex/skills/compaction/SKILL.md +317 -0
- package/.codex/skills/condition-based-waiting/SKILL.md +123 -0
- package/.codex/skills/condition-based-waiting/example.ts +158 -0
- package/.codex/skills/context-engineering/SKILL.md +176 -0
- package/.codex/skills/context-initialization/SKILL.md +70 -0
- package/.codex/skills/context-management/SKILL.md +163 -0
- package/.codex/skills/core-data-expert/SKILL.md +93 -0
- package/.codex/skills/core-data-expert/references/batch-operations.md +543 -0
- package/.codex/skills/core-data-expert/references/cloudkit-integration.md +259 -0
- package/.codex/skills/core-data-expert/references/concurrency.md +522 -0
- package/.codex/skills/core-data-expert/references/fetch-requests.md +643 -0
- package/.codex/skills/core-data-expert/references/glossary.md +233 -0
- package/.codex/skills/core-data-expert/references/migration.md +393 -0
- package/.codex/skills/core-data-expert/references/model-configuration.md +597 -0
- package/.codex/skills/core-data-expert/references/performance.md +300 -0
- package/.codex/skills/core-data-expert/references/persistent-history.md +553 -0
- package/.codex/skills/core-data-expert/references/project-audit.md +60 -0
- package/.codex/skills/core-data-expert/references/saving.md +574 -0
- package/.codex/skills/core-data-expert/references/stack-setup.md +625 -0
- package/.codex/skills/core-data-expert/references/testing.md +300 -0
- package/.codex/skills/core-data-expert/references/threading.md +589 -0
- package/.codex/skills/debugging/SKILL.md +203 -0
- package/.codex/skills/deep-research/SKILL.md +384 -0
- package/.codex/skills/defense-in-depth/SKILL.md +166 -0
- package/.codex/skills/dependency-upgrades/SKILL.md +198 -0
- package/.codex/skills/design-system-audit/SKILL.md +153 -0
- package/.codex/skills/development-lifecycle/SKILL.md +356 -0
- package/.codex/skills/dispatching-parallel-agents/SKILL.md +191 -0
- package/.codex/skills/docs-handoff/SKILL.md +175 -0
- package/.codex/skills/executing-plans/SKILL.md +247 -0
- package/.codex/skills/figma/SKILL.md +224 -0
- package/.codex/skills/figma/mcp.json +6 -0
- package/.codex/skills/finishing-a-development-branch/SKILL.md +357 -0
- package/.codex/skills/frontend-design/SKILL.md +176 -0
- package/.codex/skills/gemini-large-context/SKILL.md +216 -0
- package/.codex/skills/git-pr-prep/SKILL.md +179 -0
- package/.codex/skills/index-knowledge/SKILL.md +413 -0
- package/.codex/skills/jira/SKILL.md +283 -0
- package/.codex/skills/jira/mcp.json +6 -0
- package/.codex/skills/memory-system/SKILL.md +93 -0
- package/.codex/skills/mockup-to-code/SKILL.md +184 -0
- package/.codex/skills/mqdh/SKILL.md +171 -0
- package/.codex/skills/obsidian/SKILL.md +187 -0
- package/.codex/skills/obsidian/mcp.json +22 -0
- package/.codex/skills/opensrc/SKILL.md +127 -0
- package/.codex/skills/opensrc/references/architecture.md +176 -0
- package/.codex/skills/opensrc/references/cli-usage.md +176 -0
- package/.codex/skills/opensrc/references/registry-support.md +137 -0
- package/.codex/skills/pdf-extract/SKILL.md +438 -0
- package/.codex/skills/playwright/SKILL.md +320 -0
- package/.codex/skills/playwright/mcp.json +16 -0
- package/.codex/skills/playwriter/SKILL.md +158 -0
- package/.codex/skills/polar/SKILL.md +102 -0
- package/.codex/skills/prd/SKILL.md +146 -0
- package/.codex/skills/prd-task/SKILL.md +182 -0
- package/.codex/skills/prd-task/references/prd-schema.json +124 -0
- package/.codex/skills/prompt-leverage/SKILL.md +69 -0
- package/.codex/skills/prompt-leverage/agents/openai.yaml +4 -0
- package/.codex/skills/prompt-leverage/references/framework.md +91 -0
- package/.codex/skills/prompt-leverage/scripts/augment_prompt.py +114 -0
- package/.codex/skills/ralph/SKILL.md +296 -0
- package/.codex/skills/react-best-practices/AGENTS.md +2410 -0
- package/.codex/skills/react-best-practices/README.md +123 -0
- package/.codex/skills/react-best-practices/SKILL.md +133 -0
- package/.codex/skills/react-best-practices/metadata.json +15 -0
- package/.codex/skills/react-best-practices/rules/_sections.md +46 -0
- package/.codex/skills/react-best-practices/rules/_template.md +28 -0
- package/.codex/skills/react-best-practices/rules/advanced-event-handler-refs.md +55 -0
- package/.codex/skills/react-best-practices/rules/advanced-use-latest.md +49 -0
- package/.codex/skills/react-best-practices/rules/async-api-routes.md +38 -0
- package/.codex/skills/react-best-practices/rules/async-defer-await.md +80 -0
- package/.codex/skills/react-best-practices/rules/async-dependencies.md +36 -0
- package/.codex/skills/react-best-practices/rules/async-parallel.md +28 -0
- package/.codex/skills/react-best-practices/rules/async-suspense-boundaries.md +99 -0
- package/.codex/skills/react-best-practices/rules/bundle-barrel-imports.md +59 -0
- package/.codex/skills/react-best-practices/rules/bundle-conditional.md +31 -0
- package/.codex/skills/react-best-practices/rules/bundle-defer-third-party.md +49 -0
- package/.codex/skills/react-best-practices/rules/bundle-dynamic-imports.md +35 -0
- package/.codex/skills/react-best-practices/rules/bundle-preload.md +50 -0
- package/.codex/skills/react-best-practices/rules/client-event-listeners.md +74 -0
- package/.codex/skills/react-best-practices/rules/client-localstorage-schema.md +71 -0
- package/.codex/skills/react-best-practices/rules/client-passive-event-listeners.md +48 -0
- package/.codex/skills/react-best-practices/rules/client-swr-dedup.md +56 -0
- package/.codex/skills/react-best-practices/rules/js-batch-dom-css.md +82 -0
- package/.codex/skills/react-best-practices/rules/js-cache-function-results.md +80 -0
- package/.codex/skills/react-best-practices/rules/js-cache-property-access.md +28 -0
- package/.codex/skills/react-best-practices/rules/js-cache-storage.md +70 -0
- package/.codex/skills/react-best-practices/rules/js-combine-iterations.md +32 -0
- package/.codex/skills/react-best-practices/rules/js-early-exit.md +50 -0
- package/.codex/skills/react-best-practices/rules/js-hoist-regexp.md +45 -0
- package/.codex/skills/react-best-practices/rules/js-index-maps.md +37 -0
- package/.codex/skills/react-best-practices/rules/js-length-check-first.md +49 -0
- package/.codex/skills/react-best-practices/rules/js-min-max-loop.md +82 -0
- package/.codex/skills/react-best-practices/rules/js-set-map-lookups.md +24 -0
- package/.codex/skills/react-best-practices/rules/js-tosorted-immutable.md +57 -0
- package/.codex/skills/react-best-practices/rules/rendering-activity.md +26 -0
- package/.codex/skills/react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
- package/.codex/skills/react-best-practices/rules/rendering-conditional-render.md +40 -0
- package/.codex/skills/react-best-practices/rules/rendering-content-visibility.md +38 -0
- package/.codex/skills/react-best-practices/rules/rendering-hoist-jsx.md +46 -0
- package/.codex/skills/react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
- package/.codex/skills/react-best-practices/rules/rendering-svg-precision.md +28 -0
- package/.codex/skills/react-best-practices/rules/rerender-defer-reads.md +39 -0
- package/.codex/skills/react-best-practices/rules/rerender-dependencies.md +45 -0
- package/.codex/skills/react-best-practices/rules/rerender-derived-state.md +29 -0
- package/.codex/skills/react-best-practices/rules/rerender-functional-setstate.md +74 -0
- package/.codex/skills/react-best-practices/rules/rerender-lazy-state-init.md +58 -0
- package/.codex/skills/react-best-practices/rules/rerender-memo.md +44 -0
- package/.codex/skills/react-best-practices/rules/rerender-transitions.md +40 -0
- package/.codex/skills/react-best-practices/rules/server-after-nonblocking.md +73 -0
- package/.codex/skills/react-best-practices/rules/server-cache-lru.md +41 -0
- package/.codex/skills/react-best-practices/rules/server-cache-react.md +76 -0
- package/.codex/skills/react-best-practices/rules/server-parallel-fetching.md +83 -0
- package/.codex/skills/react-best-practices/rules/server-serialization.md +38 -0
- package/.codex/skills/receiving-code-review/SKILL.md +252 -0
- package/.codex/skills/refactoring/SKILL.md +217 -0
- package/.codex/skills/repo-orientation/SKILL.md +156 -0
- package/.codex/skills/requesting-code-review/SKILL.md +397 -0
- package/.codex/skills/resend/SKILL.md +177 -0
- package/.codex/skills/resend/references/react-email.md +287 -0
- package/.codex/skills/resend/references/receive-email.md +248 -0
- package/.codex/skills/resend/references/send-email.md +318 -0
- package/.codex/skills/root-cause-tracing/SKILL.md +192 -0
- package/.codex/skills/root-cause-tracing/find-polluter.sh +63 -0
- package/.codex/skills/safe-implementation/SKILL.md +205 -0
- package/.codex/skills/session-management/SKILL.md +10 -0
- package/.codex/skills/sharing-skills/SKILL.md +214 -0
- package/.codex/skills/skill-creator/SKILL.md +156 -0
- package/.codex/skills/source-code-research/SKILL.md +293 -0
- package/.codex/skills/source-code-research/references/analysis-tips.md +43 -0
- package/.codex/skills/source-code-research/references/anti-patterns.md +36 -0
- package/.codex/skills/source-code-research/references/common-patterns.md +57 -0
- package/.codex/skills/source-code-research/references/example-workflow.md +60 -0
- package/.codex/skills/source-code-research/references/further-reading.md +5 -0
- package/.codex/skills/source-code-research/references/source-structure.md +45 -0
- package/.codex/skills/stitch/SKILL.md +147 -0
- package/.codex/skills/stitch/mcp.json +9 -0
- package/.codex/skills/structured-edit/SKILL.md +181 -0
- package/.codex/skills/subagent-driven-development/SKILL.md +237 -0
- package/.codex/skills/supabase/SKILL.md +130 -0
- package/.codex/skills/supabase/mcp.json +27 -0
- package/.codex/skills/supabase-postgres-best-practices/AGENTS.md +1490 -0
- package/.codex/skills/supabase-postgres-best-practices/SKILL.md +65 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/advanced-full-text-search.md +55 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/advanced-jsonb-indexing.md +49 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/conn-idle-timeout.md +46 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/conn-limits.md +44 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/conn-pooling.md +41 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/conn-prepared-statements.md +46 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/data-batch-inserts.md +54 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/data-n-plus-one.md +53 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/data-pagination.md +50 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/data-upsert.md +50 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/lock-advisory.md +56 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/lock-deadlock-prevention.md +68 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/lock-short-transactions.md +50 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/lock-skip-locked.md +54 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/monitor-explain-analyze.md +45 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/monitor-pg-stat-statements.md +55 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/monitor-vacuum-analyze.md +55 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/query-composite-indexes.md +44 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/query-covering-indexes.md +40 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/query-index-types.md +45 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/query-missing-indexes.md +43 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/query-partial-indexes.md +45 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/schema-data-types.md +46 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/schema-foreign-key-indexes.md +59 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/schema-lowercase-identifiers.md +55 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/schema-partitioning.md +55 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/schema-primary-keys.md +61 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/security-privileges.md +54 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/security-rls-basics.md +50 -0
- package/.codex/skills/supabase-postgres-best-practices/rules/security-rls-performance.md +57 -0
- package/.codex/skills/swarm-coordination/SKILL.md +179 -0
- package/.codex/skills/swarm-coordination/references/architecture.md +39 -0
- package/.codex/skills/swarm-coordination/references/delegation-worker-protocol.md +145 -0
- package/.codex/skills/swarm-coordination/references/dependency-graph.md +50 -0
- package/.codex/skills/swarm-coordination/references/drift-check.md +90 -0
- package/.codex/skills/swarm-coordination/references/integration-beads.md +20 -0
- package/.codex/skills/swarm-coordination/references/launch-flow.md +186 -0
- package/.codex/skills/swarm-coordination/references/reconciler.md +172 -0
- package/.codex/skills/swarm-coordination/references/tier-enforcement.md +78 -0
- package/.codex/skills/swarm-coordination/references/tmux-integration.md +134 -0
- package/.codex/skills/swift-concurrency/SKILL.md +266 -0
- package/.codex/skills/swift-concurrency/references/actors.md +640 -0
- package/.codex/skills/swift-concurrency/references/async-algorithms.md +822 -0
- package/.codex/skills/swift-concurrency/references/async-await-basics.md +249 -0
- package/.codex/skills/swift-concurrency/references/async-sequences.md +670 -0
- package/.codex/skills/swift-concurrency/references/core-data.md +533 -0
- package/.codex/skills/swift-concurrency/references/glossary.md +128 -0
- package/.codex/skills/swift-concurrency/references/linting.md +142 -0
- package/.codex/skills/swift-concurrency/references/memory-management.md +542 -0
- package/.codex/skills/swift-concurrency/references/migration.md +1076 -0
- package/.codex/skills/swift-concurrency/references/performance.md +574 -0
- package/.codex/skills/swift-concurrency/references/sendable.md +578 -0
- package/.codex/skills/swift-concurrency/references/tasks.md +604 -0
- package/.codex/skills/swift-concurrency/references/testing.md +565 -0
- package/.codex/skills/swift-concurrency/references/threading.md +452 -0
- package/.codex/skills/swiftui-expert-skill/SKILL.md +329 -0
- package/.codex/skills/swiftui-expert-skill/references/animation-advanced.md +351 -0
- package/.codex/skills/swiftui-expert-skill/references/animation-basics.md +284 -0
- package/.codex/skills/swiftui-expert-skill/references/animation-transitions.md +326 -0
- package/.codex/skills/swiftui-expert-skill/references/image-optimization.md +286 -0
- package/.codex/skills/swiftui-expert-skill/references/layout-best-practices.md +312 -0
- package/.codex/skills/swiftui-expert-skill/references/liquid-glass.md +377 -0
- package/.codex/skills/swiftui-expert-skill/references/list-patterns.md +153 -0
- package/.codex/skills/swiftui-expert-skill/references/modern-apis.md +400 -0
- package/.codex/skills/swiftui-expert-skill/references/performance-patterns.md +377 -0
- package/.codex/skills/swiftui-expert-skill/references/scroll-patterns.md +305 -0
- package/.codex/skills/swiftui-expert-skill/references/sheet-navigation-patterns.md +292 -0
- package/.codex/skills/swiftui-expert-skill/references/state-management.md +447 -0
- package/.codex/skills/swiftui-expert-skill/references/text-formatting.md +285 -0
- package/.codex/skills/swiftui-expert-skill/references/view-structure.md +276 -0
- package/.codex/skills/systematic-debugging/SKILL.md +402 -0
- package/.codex/skills/task-planning/SKILL.md +205 -0
- package/.codex/skills/test-driven-development/SKILL.md +388 -0
- package/.codex/skills/test-strategy/SKILL.md +186 -0
- package/.codex/skills/testing-anti-patterns/SKILL.md +320 -0
- package/.codex/skills/testing-skills-with-subagents/SKILL.md +405 -0
- package/.codex/skills/tilth-cli/SKILL.md +180 -0
- package/.codex/skills/tool-priority/SKILL.md +299 -0
- package/.codex/skills/ui-inspiration-scout/SKILL.md +203 -0
- package/.codex/skills/ui-ux-research/SKILL.md +35 -0
- package/.codex/skills/using-git-worktrees/SKILL.md +259 -0
- package/.codex/skills/using-skills/SKILL.md +117 -0
- package/.codex/skills/v0/SKILL.md +158 -0
- package/.codex/skills/v0/mcp.json +6 -0
- package/.codex/skills/v1-run/SKILL.md +175 -0
- package/.codex/skills/v1-run/mcp.json +6 -0
- package/.codex/skills/vercel-deploy-claimable/SKILL.md +124 -0
- package/.codex/skills/vercel-deploy-claimable/scripts/deploy.sh +249 -0
- package/.codex/skills/verification/SKILL.md +191 -0
- package/.codex/skills/verification-before-completion/SKILL.md +236 -0
- package/.codex/skills/visual-analysis/SKILL.md +154 -0
- package/.codex/skills/web-design-guidelines/SKILL.md +46 -0
- package/.codex/skills/writing-plans/SKILL.md +320 -0
- package/.codex/skills/writing-skills/SKILL.md +287 -0
- package/.codex/skills/writing-skills/anthropic-best-practices.md +1173 -0
- package/.codex/skills/writing-skills/graphviz-conventions.dot +172 -0
- package/.codex/skills/writing-skills/persuasion-principles.md +220 -0
- package/.codex/skills/writing-skills/references/anti-patterns.md +25 -0
- package/.codex/skills/writing-skills/references/claude-search-optimization.md +140 -0
- package/.codex/skills/writing-skills/references/discovery-workflow.md +11 -0
- package/.codex/skills/writing-skills/references/file-organization.md +32 -0
- package/.codex/skills/writing-skills/references/flowcharts-and-examples.md +57 -0
- package/.codex/skills/writing-skills/references/rationalization-hardening.md +75 -0
- package/.codex/skills/writing-skills/references/testing-skill-types.md +52 -0
- package/.template-manifest.json +631 -0
- package/AGENTS.md +719 -0
- package/AGENTS.override.md.example +7 -0
- package/CHANGELOG.md +28 -0
- package/LICENSE +21 -0
- package/README.md +641 -0
- package/bin/codexkit +148 -0
- package/install/bead-close.sh +20 -0
- package/install/bead-search.sh +18 -0
- package/install/bead-start.sh +20 -0
- package/install/bead-sync.sh +19 -0
- package/install/bead-verify.sh +20 -0
- package/install/generate-manifest.sh +55 -0
- package/install/install-global.sh +150 -0
- package/install/install-project.sh +704 -0
- package/install/install-remote.sh +152 -0
- package/install/patch.sh +478 -0
- package/install/plugin.sh +565 -0
- package/install/run-codex.sh +68 -0
- package/install/template.sh +620 -0
- package/install/validate.sh +653 -0
- package/package.json +39 -0
- package/templates/global/.codex-config-template.toml +87 -0
- package/templates/global/AGENTS.override.md +18 -0
- package/templates/global/README.md +29 -0
- package/templates/project/.codex-config-template.toml +26 -0
- package/templates/project/AGENTS.md.template +27 -0
- package/templates/project/README.md +24 -0
|
@@ -0,0 +1,293 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: source-code-research
|
|
3
|
+
description: "Use when researching library implementation details beyond API docs. Fetches package source code using opensrc to understand internals, edge cases, and implementation patterns. Complements documentation-based research with actual code inspection."
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
tags: [research, code-quality]
|
|
6
|
+
dependencies: [opensrc]
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Source Code Research - Deep Library Investigation
|
|
10
|
+
|
|
11
|
+
Fetch and analyze package source code when documentation is insufficient.
|
|
12
|
+
|
|
13
|
+
## When to Use
|
|
14
|
+
|
|
15
|
+
- Documentation gaps — API docs don't explain behavior clearly
|
|
16
|
+
- Edge cases — need to understand how library handles corner cases
|
|
17
|
+
- Implementation details — need to see actual code, not just interfaces
|
|
18
|
+
- Debugging — library behaving unexpectedly, need to trace internals
|
|
19
|
+
- Evaluation — deciding if library fits requirements, need to assess quality
|
|
20
|
+
- Type definitions — TypeScript types exist but implementation unclear
|
|
21
|
+
|
|
22
|
+
## When NOT to Use
|
|
23
|
+
|
|
24
|
+
- Official docs answer your question (check Context7 first)
|
|
25
|
+
- You only need API syntax (codesearch is faster)
|
|
26
|
+
- Library is too large to analyze in session (>50k LOC)
|
|
27
|
+
|
|
28
|
+
## Prerequisites
|
|
29
|
+
|
|
30
|
+
OpenSrc must be available:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npx opensrc --help
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
If not installed, it will be fetched via npx automatically.
|
|
37
|
+
|
|
38
|
+
## Workflow
|
|
39
|
+
|
|
40
|
+
### Step 1: Identify What to Fetch
|
|
41
|
+
|
|
42
|
+
Determine the minimal package/repo needed:
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
// If researching a specific npm package
|
|
46
|
+
const target = "zod"; // Just the package name
|
|
47
|
+
|
|
48
|
+
// If researching Python library
|
|
49
|
+
const target = "pypi:requests";
|
|
50
|
+
|
|
51
|
+
// If researching Rust crate
|
|
52
|
+
const target = "crates:serde";
|
|
53
|
+
|
|
54
|
+
// If researching GitHub repo directly
|
|
55
|
+
const target = "vercel/ai"; // or "github:vercel/ai@v3.0.0"
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Step 2: Fetch Source Code
|
|
59
|
+
|
|
60
|
+
Run opensrc to clone the repository:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx opensrc <package>
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Examples:**
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx opensrc zod # Fetch latest zod from npm
|
|
70
|
+
npx opensrc zod@3.22.0 # Fetch specific version
|
|
71
|
+
npx opensrc pypi:requests # Fetch Python package
|
|
72
|
+
npx opensrc vercel/ai # Fetch GitHub repo
|
|
73
|
+
npx opensrc vercel/ai@v3.0.0 # Fetch specific tag
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**What happens:**
|
|
77
|
+
|
|
78
|
+
- Clones source to `opensrc/repos/<host>/<owner>/<repo>/`
|
|
79
|
+
- Auto-detects version from lockfiles if no version specified
|
|
80
|
+
- Updates `opensrc/sources.json` with metadata
|
|
81
|
+
- Adds `opensrc/` to `.gitignore` automatically (asks once)
|
|
82
|
+
|
|
83
|
+
### Step 3: Locate Relevant Code
|
|
84
|
+
|
|
85
|
+
Use search tools to find code you need:
|
|
86
|
+
|
|
87
|
+
```typescript
|
|
88
|
+
// Find all TypeScript source files
|
|
89
|
+
glob({ pattern: "opensrc/**/src/**/*.ts" });
|
|
90
|
+
|
|
91
|
+
// Search for specific function/class
|
|
92
|
+
grep({
|
|
93
|
+
pattern: "class ValidationError",
|
|
94
|
+
path: "opensrc/",
|
|
95
|
+
include: "*.ts",
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
// Search for function pattern
|
|
99
|
+
grep({
|
|
100
|
+
pattern: "export function parse",
|
|
101
|
+
path: "opensrc/",
|
|
102
|
+
include: "*.ts",
|
|
103
|
+
});
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Step 4: Read and Analyze
|
|
107
|
+
|
|
108
|
+
Read the implementation:
|
|
109
|
+
|
|
110
|
+
```typescript
|
|
111
|
+
// Read the file
|
|
112
|
+
read({ filePath: "opensrc/repos/github.com/colinhacks/zod/src/types.ts" });
|
|
113
|
+
|
|
114
|
+
// Use LSP for navigation (if available)
|
|
115
|
+
lsp_lsp_goto_definition({
|
|
116
|
+
filePath: "opensrc/.../file.ts",
|
|
117
|
+
line: 42,
|
|
118
|
+
character: 10,
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
// Find all references
|
|
122
|
+
lsp_lsp_find_references({
|
|
123
|
+
filePath: "opensrc/.../file.ts",
|
|
124
|
+
line: 42,
|
|
125
|
+
character: 10,
|
|
126
|
+
});
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Step 5: Document Findings
|
|
130
|
+
|
|
131
|
+
Write research findings to bead artifact:
|
|
132
|
+
|
|
133
|
+
````markdown
|
|
134
|
+
# Research: [Library Name] Implementation
|
|
135
|
+
|
|
136
|
+
**Package:** [name@version]
|
|
137
|
+
**Source:** opensrc/repos/[path]
|
|
138
|
+
**Focus:** [What you were investigating]
|
|
139
|
+
|
|
140
|
+
## Key Findings
|
|
141
|
+
|
|
142
|
+
### [Topic 1]: [Function/Pattern Name]
|
|
143
|
+
|
|
144
|
+
**Location:** `opensrc/repos/.../file.ts:42`
|
|
145
|
+
|
|
146
|
+
**Implementation:**
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
// Paste relevant code snippet
|
|
150
|
+
```
|
|
151
|
+
````
|
|
152
|
+
|
|
153
|
+
**Insights:**
|
|
154
|
+
|
|
155
|
+
- [What you learned]
|
|
156
|
+
- [Edge cases discovered]
|
|
157
|
+
- [Performance implications]
|
|
158
|
+
|
|
159
|
+
**Confidence:** High (direct source code)
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
### [Topic 2]: [Another Discovery]
|
|
164
|
+
|
|
165
|
+
[Same structure]
|
|
166
|
+
|
|
167
|
+
## Answers to Original Questions
|
|
168
|
+
|
|
169
|
+
1. **Q:** [Original question]
|
|
170
|
+
**A:** [Answer based on source code]
|
|
171
|
+
**Evidence:** `file.ts:123-145`
|
|
172
|
+
|
|
173
|
+
2. **Q:** [Another question]
|
|
174
|
+
**A:** [Answer]
|
|
175
|
+
|
|
176
|
+
## Recommendations
|
|
177
|
+
|
|
178
|
+
Based on source analysis:
|
|
179
|
+
|
|
180
|
+
- [Recommendation 1]
|
|
181
|
+
- [Recommendation 2]
|
|
182
|
+
|
|
183
|
+
## Caveats
|
|
184
|
+
|
|
185
|
+
- Version analyzed: [version]
|
|
186
|
+
- Code may have changed in newer versions
|
|
187
|
+
- Private APIs discovered may change without notice
|
|
188
|
+
|
|
189
|
+
````
|
|
190
|
+
|
|
191
|
+
## Limitations
|
|
192
|
+
|
|
193
|
+
### When Source Code Won't Help
|
|
194
|
+
|
|
195
|
+
- **Build-time transforms**: Source may differ from runtime (Babel, webpack)
|
|
196
|
+
- **Native modules**: C/C++ code requires different analysis
|
|
197
|
+
- **Minified code**: Some packages don't publish source
|
|
198
|
+
- **Monorepos**: May need to navigate complex structure
|
|
199
|
+
|
|
200
|
+
### Alternatives
|
|
201
|
+
|
|
202
|
+
If opensrc doesn't work:
|
|
203
|
+
|
|
204
|
+
1. **GitHub web interface**: Browse online at github.com/owner/repo
|
|
205
|
+
2. **npm unpacked**: `npm pack <package>` then extract
|
|
206
|
+
3. **node_modules**: If already installed, check `node_modules/<package>/`
|
|
207
|
+
4. **Source maps**: If debugging, browser DevTools may show original source
|
|
208
|
+
|
|
209
|
+
## Integration with Other Research Methods
|
|
210
|
+
|
|
211
|
+
Source code research complements other tools:
|
|
212
|
+
|
|
213
|
+
| Method | Best For | Source Code Adds |
|
|
214
|
+
| -------------- | -------------------------- | ------------------------------ |
|
|
215
|
+
| **Context7** | API docs, official guides | Implementation details |
|
|
216
|
+
| **codesearch** | Usage patterns in the wild | Canonical implementation |
|
|
217
|
+
| **grepsearch** | Real-world examples | How library itself works |
|
|
218
|
+
| **Web search** | Tutorials, blog posts | Ground truth from source |
|
|
219
|
+
| **Codebase** | Project-specific patterns | How dependencies actually work |
|
|
220
|
+
|
|
221
|
+
**Recommended flow:**
|
|
222
|
+
|
|
223
|
+
1. Context7 - Check official docs
|
|
224
|
+
2. Codebase - Check existing usage
|
|
225
|
+
3. **Source code** - If still unclear, fetch source
|
|
226
|
+
4. codesearch/grepsearch - See how others use it
|
|
227
|
+
5. Web search - Last resort for context
|
|
228
|
+
|
|
229
|
+
## Cleanup
|
|
230
|
+
|
|
231
|
+
After research is complete:
|
|
232
|
+
|
|
233
|
+
```bash
|
|
234
|
+
# Remove specific package
|
|
235
|
+
npx opensrc remove <package>
|
|
236
|
+
|
|
237
|
+
# Remove all sources
|
|
238
|
+
npx opensrc clean
|
|
239
|
+
|
|
240
|
+
# Remove just npm packages
|
|
241
|
+
npx opensrc clean --npm
|
|
242
|
+
|
|
243
|
+
# Keep sources for documentation
|
|
244
|
+
# (opensrc/ is gitignored, won't be committed)
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## Success Criteria
|
|
248
|
+
|
|
249
|
+
You've successfully used this skill when:
|
|
250
|
+
|
|
251
|
+
- [ ] Fetched correct package/version source
|
|
252
|
+
- [ ] Located relevant implementation code
|
|
253
|
+
- [ ] Understood behavior from reading source
|
|
254
|
+
- [ ] Documented findings with file:line references
|
|
255
|
+
- [ ] Answered original research question with high confidence
|
|
256
|
+
- [ ] Provided code evidence for claims
|
|
257
|
+
|
|
258
|
+
## Quick Reference
|
|
259
|
+
|
|
260
|
+
```bash
|
|
261
|
+
# Fetch package source
|
|
262
|
+
npx opensrc <package> # npm (auto-detect version)
|
|
263
|
+
npx opensrc <package>@<version> # npm (specific version)
|
|
264
|
+
npx opensrc pypi:<package> # Python
|
|
265
|
+
npx opensrc crates:<package> # Rust
|
|
266
|
+
npx opensrc <owner>/<repo> # GitHub
|
|
267
|
+
npx opensrc <owner>/<repo>@<tag> # GitHub (specific tag)
|
|
268
|
+
|
|
269
|
+
# List fetched sources
|
|
270
|
+
npx opensrc list
|
|
271
|
+
npx opensrc list --json
|
|
272
|
+
|
|
273
|
+
# Remove sources
|
|
274
|
+
npx opensrc remove <package>
|
|
275
|
+
npx opensrc clean
|
|
276
|
+
npx opensrc clean --npm --pypi --crates
|
|
277
|
+
|
|
278
|
+
# Source location
|
|
279
|
+
opensrc/repos/<host>/<owner>/<repo>/
|
|
280
|
+
|
|
281
|
+
# Metadata
|
|
282
|
+
opensrc/sources.json
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## References
|
|
286
|
+
|
|
287
|
+
- `references/common-patterns.md` - Error handling, tracing behavior, quality evaluation patterns
|
|
288
|
+
- `references/source-structure.md` - npm/PyPI/Rust source layouts
|
|
289
|
+
- `references/analysis-tips.md` - Tests, examples, changelog, types, blame
|
|
290
|
+
- `references/example-workflow.md` - Full zod async refinement workflow
|
|
291
|
+
- `references/anti-patterns.md` - What not to do when researching
|
|
292
|
+
- `references/further-reading.md` - External links
|
|
293
|
+
````
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Tips for Efficient Analysis
|
|
2
|
+
|
|
3
|
+
## 1. Start with Tests
|
|
4
|
+
|
|
5
|
+
Tests often show real-world usage better than docs:
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
glob({ pattern: "opensrc/**/*.test.{ts,js}" });
|
|
9
|
+
read({ filePath: "opensrc/.../feature.test.ts" });
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## 2. Check Examples Directory
|
|
13
|
+
|
|
14
|
+
Many repos have `examples/` or `samples/`:
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
glob({ pattern: "opensrc/**/examples/**/*" });
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## 3. Read CHANGELOG for Context
|
|
21
|
+
|
|
22
|
+
Understand recent changes:
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
read({ filePath: "opensrc/.../CHANGELOG.md" });
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 4. Check TypeScript Definitions
|
|
29
|
+
|
|
30
|
+
Often more accurate than docs:
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
glob({ pattern: "opensrc/**/*.d.ts" });
|
|
34
|
+
read({ filePath: "opensrc/.../index.d.ts" });
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## 5. Use Blame for History (if needed)
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
cd opensrc/repos/github.com/owner/repo
|
|
41
|
+
git log --oneline -- src/file.ts
|
|
42
|
+
git show <commit>:src/file.ts
|
|
43
|
+
```
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Anti-Patterns
|
|
2
|
+
|
|
3
|
+
## ❌ Don't: Fetch Entire Ecosystem
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
# Bad: Fetching everything
|
|
7
|
+
npx opensrc react
|
|
8
|
+
npx opensrc react-dom
|
|
9
|
+
npx opensrc react-router
|
|
10
|
+
npx opensrc react-query
|
|
11
|
+
# ... (too much code)
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
**Do:** Fetch only what you need to answer specific question.
|
|
15
|
+
|
|
16
|
+
## ❌ Don't: Read Random Files
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
// Bad: Reading without purpose
|
|
20
|
+
read({ filePath: "opensrc/.../index.ts" });
|
|
21
|
+
read({ filePath: "opensrc/.../utils.ts" });
|
|
22
|
+
read({ filePath: "opensrc/.../helpers.ts" });
|
|
23
|
+
// ... (unfocused exploration)
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Do:** Use grep to find relevant code first, then read.
|
|
27
|
+
|
|
28
|
+
## ❌ Don't: Ignore Version Mismatch
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# Bad: Fetching latest when project uses old version
|
|
32
|
+
npx opensrc zod # Fetches 3.23.x
|
|
33
|
+
# But project uses zod@3.20.0 (different behavior)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Do:** Specify version matching your lockfile, or let opensrc auto-detect.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Common Patterns
|
|
2
|
+
|
|
3
|
+
## Pattern 1: Understanding Error Handling
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
// 1. Fetch package
|
|
7
|
+
// bash: npx opensrc zod
|
|
8
|
+
|
|
9
|
+
// 2. Find error classes
|
|
10
|
+
grep({ pattern: "class.*Error", path: "opensrc/", include: "*.ts" });
|
|
11
|
+
|
|
12
|
+
// 3. Read error implementation
|
|
13
|
+
read({ filePath: "opensrc/repos/.../errors.ts" });
|
|
14
|
+
|
|
15
|
+
// 4. Find where errors are thrown
|
|
16
|
+
grep({ pattern: "throw new", path: "opensrc/", include: "*.ts" });
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Pattern 2: Tracing Function Behavior
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
// 1. Fetch source
|
|
23
|
+
// bash: npx opensrc react-hook-form
|
|
24
|
+
|
|
25
|
+
// 2. Find function definition
|
|
26
|
+
grep({
|
|
27
|
+
pattern: "export function useForm",
|
|
28
|
+
path: "opensrc/",
|
|
29
|
+
include: "*.ts",
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
// 3. Read implementation
|
|
33
|
+
read({ filePath: "opensrc/.../useForm.ts" });
|
|
34
|
+
|
|
35
|
+
// 4. Find dependencies
|
|
36
|
+
grep({ pattern: "import.*from", path: "opensrc/.../useForm.ts" });
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Pattern 3: Evaluating Library Quality
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
// 1. Fetch source
|
|
43
|
+
// bash: npx opensrc candidate-library
|
|
44
|
+
|
|
45
|
+
// 2. Check test coverage
|
|
46
|
+
glob({ pattern: "opensrc/**/*.test.ts" });
|
|
47
|
+
glob({ pattern: "opensrc/**/*.spec.ts" });
|
|
48
|
+
|
|
49
|
+
// 3. Read tests for usage patterns
|
|
50
|
+
read({ filePath: "opensrc/.../feature.test.ts" });
|
|
51
|
+
|
|
52
|
+
// 4. Check for TypeScript usage
|
|
53
|
+
glob({ pattern: "opensrc/**/tsconfig.json" });
|
|
54
|
+
|
|
55
|
+
// 5. Review package.json for dependencies
|
|
56
|
+
read({ filePath: "opensrc/.../package.json" });
|
|
57
|
+
```
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Example: Complete Workflow
|
|
2
|
+
|
|
3
|
+
**Scenario:** Need to understand how zod handles async refinements.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
# 1. Fetch source
|
|
7
|
+
npx opensrc zod
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
// 2. Find refinement code
|
|
12
|
+
grep({
|
|
13
|
+
pattern: "refine.*async",
|
|
14
|
+
path: "opensrc/",
|
|
15
|
+
include: "*.ts",
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
// 3. Locate implementation
|
|
19
|
+
ast_grep({
|
|
20
|
+
pattern: "refine($$$) { $$$ }",
|
|
21
|
+
path: "opensrc/repos/github.com/colinhacks/zod/",
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
// 4. Read the implementation
|
|
25
|
+
read({
|
|
26
|
+
filePath: "opensrc/repos/github.com/colinhacks/zod/src/types.ts",
|
|
27
|
+
offset: 500,
|
|
28
|
+
limit: 100,
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
// 5. Check tests for usage examples
|
|
32
|
+
glob({
|
|
33
|
+
pattern: "opensrc/**/zod/**/*.test.ts",
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
read({
|
|
37
|
+
filePath: "opensrc/repos/.../async.test.ts",
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
// 6. Document findings
|
|
41
|
+
write({
|
|
42
|
+
filePath: ".beads/artifacts/br-xxx/research.md",
|
|
43
|
+
content: `# Zod Async Refinements
|
|
44
|
+
|
|
45
|
+
**Finding:** Async refinements use \`parseAsync()\` not \`parse()\`
|
|
46
|
+
|
|
47
|
+
**Evidence:** \`src/types.ts:842-856\`
|
|
48
|
+
|
|
49
|
+
Async refinements return Promise<Output> and require:
|
|
50
|
+
- Use \`.parseAsync()\` method
|
|
51
|
+
- Refinement function must return Promise<boolean>
|
|
52
|
+
- Errors handled via Promise rejection
|
|
53
|
+
|
|
54
|
+
**Code snippet:**
|
|
55
|
+
[paste relevant code]
|
|
56
|
+
|
|
57
|
+
**Recommendation:** Use \`.refine(async (val) => {...})\` with \`.parseAsync()\`
|
|
58
|
+
`,
|
|
59
|
+
});
|
|
60
|
+
```
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Source Structure Guide
|
|
2
|
+
|
|
3
|
+
## npm Packages
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
opensrc/
|
|
7
|
+
└── repos/
|
|
8
|
+
└── github.com/ # npm packages resolve to GitHub
|
|
9
|
+
└── owner/
|
|
10
|
+
└── repo/
|
|
11
|
+
├── src/ # Source code (usually)
|
|
12
|
+
├── dist/ # Built output (ignore)
|
|
13
|
+
├── test/ # Tests (useful for examples)
|
|
14
|
+
├── package.json # Dependencies, scripts
|
|
15
|
+
└── README.md # Often has examples
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Python Packages (PyPI)
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
opensrc/
|
|
22
|
+
└── repos/
|
|
23
|
+
└── github.com/ # Most PyPI packages on GitHub
|
|
24
|
+
└── owner/
|
|
25
|
+
└── repo/
|
|
26
|
+
├── src/ # or package_name/
|
|
27
|
+
├── tests/ # Python tests
|
|
28
|
+
├── setup.py # Package config
|
|
29
|
+
└── pyproject.toml
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Rust Crates
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
opensrc/
|
|
36
|
+
└── repos/
|
|
37
|
+
└── github.com/
|
|
38
|
+
└── owner/
|
|
39
|
+
└── repo/
|
|
40
|
+
├── src/
|
|
41
|
+
│ └── lib.rs # Main library file
|
|
42
|
+
├── tests/
|
|
43
|
+
├── Cargo.toml # Dependencies
|
|
44
|
+
└── examples/ # Usage examples
|
|
45
|
+
```
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: stitch
|
|
3
|
+
description: Google Stitch MCP for AI-powered UI design. Extract design context, generate code from designs, and create screens from descriptions. Use when working with Stitch designs and UI generation.
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
tags: [design, mcp, ui]
|
|
6
|
+
dependencies: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Google Stitch MCP
|
|
10
|
+
|
|
11
|
+
## When to Use
|
|
12
|
+
|
|
13
|
+
- When you need to generate or inspect Google Stitch UI designs via MCP.
|
|
14
|
+
|
|
15
|
+
## When NOT to Use
|
|
16
|
+
|
|
17
|
+
- When you don't have Stitch access or don't need Stitch-generated UI.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Overview
|
|
21
|
+
|
|
22
|
+
Stitch MCP is Google's official Model Context Protocol server for interacting with Google Stitch designs. It allows AI agents to extract design context (colors, typography, spacing), generate production-ready code from designs, and create new designs from text descriptions.
|
|
23
|
+
|
|
24
|
+
## Endpoint
|
|
25
|
+
|
|
26
|
+
**MCP Server URL**: `https://stitch.googleapis.com/mcp`
|
|
27
|
+
|
|
28
|
+
**Authentication**: Google Cloud credentials with Bearer token and project ID header
|
|
29
|
+
|
|
30
|
+
## Prerequisites
|
|
31
|
+
|
|
32
|
+
1. **Google Cloud Project** with Stitch API enabled
|
|
33
|
+
2. **Google Cloud CLI** (`gcloud`) installed and initialized
|
|
34
|
+
3. **Required IAM Roles**:
|
|
35
|
+
- `roles/serviceusage.serviceUsageAdmin` (to enable the service)
|
|
36
|
+
- `roles/mcp.toolUser` (to call MCP tools)
|
|
37
|
+
|
|
38
|
+
## Setup Steps
|
|
39
|
+
|
|
40
|
+
### 1. Enable Stitch API in Google Cloud
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# Set your Google Cloud project
|
|
44
|
+
gcloud config set project PROJECT_ID
|
|
45
|
+
|
|
46
|
+
# Enable the Stitch MCP service
|
|
47
|
+
gcloud beta services mcp enable stitch.googleapis.com --project=PROJECT_ID
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 2. Get Your Access Token
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# Authenticate with Google Cloud
|
|
54
|
+
gcloud auth login
|
|
55
|
+
|
|
56
|
+
# Get your access token
|
|
57
|
+
gcloud auth print-access-token
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 3. Set Environment Variables
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# Set your Google Cloud project ID
|
|
64
|
+
export GOOGLE_CLOUD_PROJECT="your-project-id"
|
|
65
|
+
|
|
66
|
+
# Get and set your access token
|
|
67
|
+
export STITCH_ACCESS_TOKEN=$(gcloud auth print-access-token)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 4. Configuration
|
|
71
|
+
|
|
72
|
+
Configure Stitch MCP in Codexkit's MCP config, then restart Codex CLI so the server is reloaded. Once environment variables are set, the tools will be available.
|
|
73
|
+
|
|
74
|
+
## Available Tools
|
|
75
|
+
|
|
76
|
+
Once configured, the Stitch MCP exposes the following tools:
|
|
77
|
+
|
|
78
|
+
| Tool | Description |
|
|
79
|
+
| ---------------------------------- | --------------------------------- |
|
|
80
|
+
| `stitch_list_projects` | List all your Stitch projects |
|
|
81
|
+
| `stitch_create_project` | Create a new UI design project |
|
|
82
|
+
| `stitch_get_project` | Get project details |
|
|
83
|
+
| `stitch_list_screens` | List screens in a project |
|
|
84
|
+
| `stitch_get_screen` | Get screen details with HTML code |
|
|
85
|
+
| `stitch_generate_screen_from_text` | Generate UI from text prompt |
|
|
86
|
+
|
|
87
|
+
## Usage Examples
|
|
88
|
+
|
|
89
|
+
### List Projects
|
|
90
|
+
|
|
91
|
+
```typescript
|
|
92
|
+
stitch_list_projects({});
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Create a Project
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
stitch_create_project({
|
|
99
|
+
title: "My E-commerce App",
|
|
100
|
+
});
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Generate Screen from Text
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
stitch_generate_screen_from_text({
|
|
107
|
+
projectId: "my-project-123",
|
|
108
|
+
prompt:
|
|
109
|
+
"Create a modern login page with email and password fields, social login buttons, and a forgot password link",
|
|
110
|
+
deviceType: "MOBILE",
|
|
111
|
+
});
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Troubleshooting
|
|
115
|
+
|
|
116
|
+
### "Stitch API not enabled"
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
gcloud beta services mcp enable stitch.googleapis.com --project=YOUR_PROJECT_ID
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### "Authentication failed"
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
# Refresh your access token (expires after ~1 hour)
|
|
126
|
+
export STITCH_ACCESS_TOKEN=$(gcloud auth print-access-token)
|
|
127
|
+
# Restart Codex CLI
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### "Project not set"
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
gcloud config set project YOUR_PROJECT_ID
|
|
134
|
+
export GOOGLE_CLOUD_PROJECT=YOUR_PROJECT_ID
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Documentation
|
|
138
|
+
|
|
139
|
+
- [Google Stitch](https://stitch.withgoogle.com)
|
|
140
|
+
- [Stitch MCP Setup](https://stitch.withgoogle.com/docs/mcp/setup)
|
|
141
|
+
- [Google Cloud MCP Overview](https://docs.cloud.google.com/mcp/overview)
|
|
142
|
+
|
|
143
|
+
## Tips
|
|
144
|
+
|
|
145
|
+
- Access tokens expire after ~1 hour, refresh with `gcloud auth print-access-token`
|
|
146
|
+
- Use descriptive prompts for better UI generation results
|
|
147
|
+
- Test generated code in your target framework before production use
|