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,127 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: opensrc
|
|
3
|
+
description: Fetch source code for npm, PyPI, or crates.io packages and GitHub/GitLab repos to provide AI agents with implementation context beyond types and docs. Use when needing to understand how a library works internally, debug dependency issues, or explore package implementations.
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
tags: [research, integration]
|
|
6
|
+
dependencies: []
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# opensrc
|
|
10
|
+
|
|
11
|
+
## When to Use
|
|
12
|
+
|
|
13
|
+
- When you need actual dependency source code to understand behavior or debug issues.
|
|
14
|
+
|
|
15
|
+
## When NOT to Use
|
|
16
|
+
|
|
17
|
+
- When API docs or local type definitions are sufficient for the task.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## When to Use
|
|
21
|
+
|
|
22
|
+
- Need to understand how a library/package works internally (not just its interface)
|
|
23
|
+
- Debugging issues where types alone are insufficient
|
|
24
|
+
- Exploring implementation patterns in dependencies
|
|
25
|
+
- Agent needs to reference actual source code of a package
|
|
26
|
+
|
|
27
|
+
## Quick Start
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Install globally or use npx
|
|
31
|
+
npm install -g opensrc
|
|
32
|
+
|
|
33
|
+
# Fetch npm package (auto-detects installed version from lockfile)
|
|
34
|
+
npx opensrc zod
|
|
35
|
+
|
|
36
|
+
# Fetch from other registries
|
|
37
|
+
npx opensrc pypi:requests # Python/PyPI
|
|
38
|
+
npx opensrc crates:serde # Rust/crates.io
|
|
39
|
+
|
|
40
|
+
# Fetch GitHub repo directly
|
|
41
|
+
npx opensrc vercel/ai # owner/repo shorthand
|
|
42
|
+
npx opensrc github:owner/repo # explicit prefix
|
|
43
|
+
npx opensrc https://github.com/colinhacks/zod # full URL
|
|
44
|
+
|
|
45
|
+
# Fetch specific version/ref
|
|
46
|
+
npx opensrc zod@3.22.0
|
|
47
|
+
npx opensrc owner/repo@v1.0.0
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Commands
|
|
51
|
+
|
|
52
|
+
| Command | Description |
|
|
53
|
+
| ----------------------- | ------------------------------- |
|
|
54
|
+
| `opensrc <packages...>` | Fetch source for packages/repos |
|
|
55
|
+
| `opensrc list` | List all fetched sources |
|
|
56
|
+
| `opensrc remove <name>` | Remove specific source |
|
|
57
|
+
| `opensrc clean` | Remove all sources |
|
|
58
|
+
|
|
59
|
+
## Output Structure
|
|
60
|
+
|
|
61
|
+
After fetching, sources stored in `opensrc/` directory:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
opensrc/
|
|
65
|
+
├── settings.json # User preferences
|
|
66
|
+
├── sources.json # Index of fetched packages/repos
|
|
67
|
+
└── repos/
|
|
68
|
+
└── github.com/
|
|
69
|
+
└── owner/
|
|
70
|
+
└── repo/ # Cloned source code
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## File Modifications
|
|
74
|
+
|
|
75
|
+
On first run, opensrc prompts to modify:
|
|
76
|
+
|
|
77
|
+
- `.gitignore` - adds `opensrc/` to ignore list
|
|
78
|
+
- `tsconfig.json` - excludes `opensrc/` from compilation
|
|
79
|
+
- `AGENTS.md` - adds section pointing agents to source code
|
|
80
|
+
|
|
81
|
+
Use `--modify` or `--modify=false` to skip prompt.
|
|
82
|
+
|
|
83
|
+
## Key Behaviors
|
|
84
|
+
|
|
85
|
+
1. **Version Detection** - For npm, auto-detects installed version from `node_modules`, `package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`
|
|
86
|
+
2. **Repository Resolution** - Resolves package to its git repo via registry API, clones at matching tag
|
|
87
|
+
3. **Monorepo Support** - Handles packages in monorepos via `repository.directory` field
|
|
88
|
+
4. **Shallow Clone** - Uses `--depth 1` for efficient cloning, removes `.git` after clone
|
|
89
|
+
5. **Tag Fallback** - Tries `v{version}`, `{version}`, then default branch if tag not found
|
|
90
|
+
|
|
91
|
+
## Common Workflows
|
|
92
|
+
|
|
93
|
+
### Fetching a Package
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# Agent needs to understand zod's implementation
|
|
97
|
+
npx opensrc zod
|
|
98
|
+
# → Detects version from lockfile
|
|
99
|
+
# → Finds repo URL from npm registry
|
|
100
|
+
# → Clones at matching git tag
|
|
101
|
+
# → Source available at opensrc/repos/github.com/colinhacks/zod/
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Updating Sources
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
# Re-run same command to update to currently installed version
|
|
108
|
+
npx opensrc zod
|
|
109
|
+
# → Checks if version changed
|
|
110
|
+
# → Re-clones if needed
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Multiple Sources
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
# Fetch multiple at once
|
|
117
|
+
npx opensrc react react-dom next
|
|
118
|
+
npx opensrc zod pypi:pydantic vercel/ai
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## References
|
|
122
|
+
|
|
123
|
+
For detailed information:
|
|
124
|
+
|
|
125
|
+
- [CLI Usage & Options](references/cli-usage.md) - Full command reference
|
|
126
|
+
- [Architecture](references/architecture.md) - Code structure and extension
|
|
127
|
+
- [Registry Support](references/registry-support.md) - npm, PyPI, crates.io details
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# opensrc Architecture
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
- Directory structure
|
|
5
|
+
- Core flow
|
|
6
|
+
- Key modules
|
|
7
|
+
- Type definitions
|
|
8
|
+
- Extension points
|
|
9
|
+
|
|
10
|
+
## Directory Structure
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
src/
|
|
14
|
+
├── index.ts # CLI entry, Commander setup
|
|
15
|
+
├── types.ts # Shared type definitions
|
|
16
|
+
├── commands/
|
|
17
|
+
│ ├── fetch.ts # Main fetch logic
|
|
18
|
+
│ ├── list.ts # List sources
|
|
19
|
+
│ ├── remove.ts # Remove sources
|
|
20
|
+
│ └── clean.ts # Clean all sources
|
|
21
|
+
└── lib/
|
|
22
|
+
├── git.ts # Clone, path management
|
|
23
|
+
├── repo.ts # Parse/resolve repo specs
|
|
24
|
+
├── version.ts # Detect installed versions
|
|
25
|
+
├── agents.ts # AGENTS.md/sources.json updates
|
|
26
|
+
├── gitignore.ts # .gitignore management
|
|
27
|
+
├── tsconfig.ts # tsconfig.json exclude
|
|
28
|
+
├── settings.ts # User preferences
|
|
29
|
+
├── prompt.ts # Interactive prompts
|
|
30
|
+
└── registries/
|
|
31
|
+
├── index.ts # Registry detection/routing
|
|
32
|
+
├── npm.ts # npm registry API
|
|
33
|
+
├── pypi.ts # PyPI API
|
|
34
|
+
└── crates.ts # crates.io API
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Core Flow
|
|
38
|
+
|
|
39
|
+
### Fetch Package
|
|
40
|
+
|
|
41
|
+
1. **Parse input** - Detect registry prefix or repo format
|
|
42
|
+
2. **Version detection** (npm only) - Check lockfiles/node_modules
|
|
43
|
+
3. **Registry lookup** - Query API for repo URL
|
|
44
|
+
4. **Clone** - Shallow clone at matching git tag
|
|
45
|
+
5. **Update index** - Write to sources.json, optionally AGENTS.md
|
|
46
|
+
|
|
47
|
+
### Input Type Detection
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
detectInputType(spec) → "package" | "repo"
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
- Registry prefix (`npm:`, `pypi:`, `crates:`) → package
|
|
54
|
+
- Repo pattern (`owner/repo`, URL, `github:`) → repo
|
|
55
|
+
- Default → package (npm)
|
|
56
|
+
|
|
57
|
+
## Key Modules
|
|
58
|
+
|
|
59
|
+
### registries/index.ts
|
|
60
|
+
|
|
61
|
+
Routes to correct registry handler:
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
parsePackageSpec(spec): PackageSpec
|
|
65
|
+
resolvePackage(spec): ResolvedPackage
|
|
66
|
+
detectRegistry(spec): { registry, cleanSpec }
|
|
67
|
+
detectInputType(spec): "package" | "repo"
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### git.ts
|
|
71
|
+
|
|
72
|
+
Manages cloning and source storage:
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
fetchSource(resolved, cwd): FetchResult
|
|
76
|
+
fetchRepoSource(resolved, cwd): FetchResult
|
|
77
|
+
listSources(cwd): { packages, repos }
|
|
78
|
+
removePackageSource(name, cwd, registry): { removed, repoRemoved }
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Storage structure: `opensrc/repos/{host}/{owner}/{repo}/`
|
|
82
|
+
|
|
83
|
+
### version.ts
|
|
84
|
+
|
|
85
|
+
Detects installed npm versions (priority order):
|
|
86
|
+
1. `node_modules/{pkg}/package.json`
|
|
87
|
+
2. `package-lock.json`
|
|
88
|
+
3. `pnpm-lock.yaml`
|
|
89
|
+
4. `yarn.lock`
|
|
90
|
+
5. `package.json` (strips range prefixes)
|
|
91
|
+
|
|
92
|
+
### repo.ts
|
|
93
|
+
|
|
94
|
+
Parses repo specs, resolves via GitHub/GitLab API:
|
|
95
|
+
|
|
96
|
+
```typescript
|
|
97
|
+
parseRepoSpec(spec): RepoSpec | null
|
|
98
|
+
resolveRepo(spec): ResolvedRepo
|
|
99
|
+
isRepoSpec(spec): boolean
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Supports: GitHub, GitLab, Bitbucket (GitHub/GitLab via API).
|
|
103
|
+
|
|
104
|
+
## Type Definitions
|
|
105
|
+
|
|
106
|
+
```typescript
|
|
107
|
+
type Registry = "npm" | "pypi" | "crates"
|
|
108
|
+
|
|
109
|
+
interface PackageSpec {
|
|
110
|
+
registry: Registry
|
|
111
|
+
name: string
|
|
112
|
+
version?: string
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
interface ResolvedPackage {
|
|
116
|
+
registry: Registry
|
|
117
|
+
name: string
|
|
118
|
+
version: string
|
|
119
|
+
repoUrl: string
|
|
120
|
+
repoDirectory?: string // For monorepos
|
|
121
|
+
gitTag: string
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
interface RepoSpec {
|
|
125
|
+
host: string // github.com, gitlab.com
|
|
126
|
+
owner: string
|
|
127
|
+
repo: string
|
|
128
|
+
ref?: string // Branch, tag, commit
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
interface FetchResult {
|
|
132
|
+
package: string
|
|
133
|
+
version: string
|
|
134
|
+
path: string
|
|
135
|
+
success: boolean
|
|
136
|
+
error?: string
|
|
137
|
+
registry?: Registry
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Extension Points
|
|
142
|
+
|
|
143
|
+
### Adding a Registry
|
|
144
|
+
|
|
145
|
+
1. Create `registries/{name}.ts`:
|
|
146
|
+
- `parse{Name}Spec(spec)` - Parse name@version
|
|
147
|
+
- `resolve{Name}Package(name, version)` - Query API, return ResolvedPackage
|
|
148
|
+
|
|
149
|
+
2. Update `registries/index.ts`:
|
|
150
|
+
- Add prefix to `REGISTRY_PREFIXES`
|
|
151
|
+
- Add case to `parsePackageSpec` and `resolvePackage`
|
|
152
|
+
|
|
153
|
+
3. Add to `Registry` type in `types.ts`
|
|
154
|
+
|
|
155
|
+
### Registry Implementation Pattern
|
|
156
|
+
|
|
157
|
+
```typescript
|
|
158
|
+
// Parse spec into name/version
|
|
159
|
+
export function parseSpec(spec: string): { name: string; version?: string }
|
|
160
|
+
|
|
161
|
+
// Query registry API, extract repo URL
|
|
162
|
+
async function fetchInfo(name: string): Promise<RegistryResponse>
|
|
163
|
+
|
|
164
|
+
// Normalize git URLs (remove git+, .git suffix)
|
|
165
|
+
function extractRepoUrl(info): string | null
|
|
166
|
+
|
|
167
|
+
// Main resolver
|
|
168
|
+
export async function resolve(name: string, version?: string): Promise<ResolvedPackage>
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Git Tag Resolution
|
|
172
|
+
|
|
173
|
+
Clone tries tags in order:
|
|
174
|
+
1. `v{version}` (most common)
|
|
175
|
+
2. `{version}` (no prefix)
|
|
176
|
+
3. Default branch (fallback with warning)
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# opensrc CLI Reference
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
- Fetch command (default)
|
|
5
|
+
- List command
|
|
6
|
+
- Remove command
|
|
7
|
+
- Clean command
|
|
8
|
+
- Global options
|
|
9
|
+
|
|
10
|
+
## Fetch Command (Default)
|
|
11
|
+
|
|
12
|
+
Fetch source for packages/repos.
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
opensrc [packages...] [options]
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Package Formats
|
|
19
|
+
|
|
20
|
+
| Format | Example | Description |
|
|
21
|
+
|--------|---------|-------------|
|
|
22
|
+
| `<name>` | `zod` | npm package (latest or installed version) |
|
|
23
|
+
| `<name>@<version>` | `zod@3.22.0` | npm package at specific version |
|
|
24
|
+
| `npm:<name>` | `npm:react` | Explicit npm prefix |
|
|
25
|
+
| `pypi:<name>` | `pypi:requests` | Python package from PyPI |
|
|
26
|
+
| `pip:<name>` | `pip:flask` | Alias for pypi: |
|
|
27
|
+
| `crates:<name>` | `crates:serde` | Rust crate from crates.io |
|
|
28
|
+
| `cargo:<name>` | `cargo:tokio` | Alias for crates: |
|
|
29
|
+
|
|
30
|
+
### Repository Formats
|
|
31
|
+
|
|
32
|
+
| Format | Example |
|
|
33
|
+
|--------|---------|
|
|
34
|
+
| `owner/repo` | `vercel/ai` |
|
|
35
|
+
| `owner/repo@ref` | `vercel/ai@v1.0.0` |
|
|
36
|
+
| `owner/repo#ref` | `vercel/ai#main` |
|
|
37
|
+
| `github:owner/repo` | `github:facebook/react` |
|
|
38
|
+
| `gitlab:owner/repo` | `gitlab:inkscape/inkscape` |
|
|
39
|
+
| `https://github.com/...` | Full URL |
|
|
40
|
+
|
|
41
|
+
### Options
|
|
42
|
+
|
|
43
|
+
| Option | Description |
|
|
44
|
+
|--------|-------------|
|
|
45
|
+
| `--cwd <path>` | Working directory (default: cwd) |
|
|
46
|
+
| `--modify` | Allow file modifications (skip prompt) |
|
|
47
|
+
| `--modify=false` | Deny file modifications (skip prompt) |
|
|
48
|
+
|
|
49
|
+
### Examples
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# Single package
|
|
53
|
+
opensrc zod
|
|
54
|
+
|
|
55
|
+
# Multiple packages
|
|
56
|
+
opensrc react react-dom next
|
|
57
|
+
|
|
58
|
+
# Mixed registries
|
|
59
|
+
opensrc zod pypi:requests crates:serde
|
|
60
|
+
|
|
61
|
+
# Specific versions
|
|
62
|
+
opensrc zod@3.22.0
|
|
63
|
+
opensrc pypi:requests==2.31.0
|
|
64
|
+
|
|
65
|
+
# GitHub repos
|
|
66
|
+
opensrc vercel/ai
|
|
67
|
+
opensrc facebook/react@v18.2.0
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## List Command
|
|
71
|
+
|
|
72
|
+
List all fetched sources.
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
opensrc list [options]
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Options
|
|
79
|
+
|
|
80
|
+
| Option | Description |
|
|
81
|
+
|--------|-------------|
|
|
82
|
+
| `--json` | Output as JSON |
|
|
83
|
+
| `--cwd <path>` | Working directory |
|
|
84
|
+
|
|
85
|
+
### Output
|
|
86
|
+
|
|
87
|
+
Groups by registry (npm, PyPI, crates.io) and repos:
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
npm Packages:
|
|
91
|
+
|
|
92
|
+
zod@3.22.0
|
|
93
|
+
Path: opensrc/repos/github.com/colinhacks/zod
|
|
94
|
+
Fetched: Jan 10, 2025
|
|
95
|
+
|
|
96
|
+
Repositories:
|
|
97
|
+
|
|
98
|
+
github.com/vercel/ai@main
|
|
99
|
+
Path: opensrc/repos/github.com/vercel/ai
|
|
100
|
+
Fetched: Jan 10, 2025
|
|
101
|
+
|
|
102
|
+
Total: 1 package(s) (1 npm), 1 repo(s)
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## Remove Command
|
|
106
|
+
|
|
107
|
+
Remove specific sources.
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
opensrc remove <packages...> [options]
|
|
111
|
+
opensrc rm <packages...> # alias
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Options
|
|
115
|
+
|
|
116
|
+
| Option | Description |
|
|
117
|
+
|--------|-------------|
|
|
118
|
+
| `--cwd <path>` | Working directory |
|
|
119
|
+
|
|
120
|
+
### Examples
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
opensrc remove zod
|
|
124
|
+
opensrc rm pypi:requests
|
|
125
|
+
opensrc remove vercel/ai
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Clean Command
|
|
129
|
+
|
|
130
|
+
Remove all sources by category.
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
opensrc clean [options]
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Options
|
|
137
|
+
|
|
138
|
+
| Option | Description |
|
|
139
|
+
|--------|-------------|
|
|
140
|
+
| `--packages` | Only remove packages (all registries) |
|
|
141
|
+
| `--repos` | Only remove repos |
|
|
142
|
+
| `--npm` | Only remove npm packages |
|
|
143
|
+
| `--pypi` | Only remove PyPI packages |
|
|
144
|
+
| `--crates` | Only remove crates.io packages |
|
|
145
|
+
| `--cwd <path>` | Working directory |
|
|
146
|
+
|
|
147
|
+
### Examples
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
opensrc clean # Remove everything
|
|
151
|
+
opensrc clean --packages # Remove all packages, keep repos
|
|
152
|
+
opensrc clean --npm # Remove only npm packages
|
|
153
|
+
opensrc clean --repos # Remove only repos
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## File Modifications
|
|
157
|
+
|
|
158
|
+
On first run, prompts to modify:
|
|
159
|
+
|
|
160
|
+
1. **`.gitignore`** - Adds `opensrc/` entry
|
|
161
|
+
2. **`tsconfig.json`** - Adds `opensrc/` to exclude array
|
|
162
|
+
3. **`AGENTS.md`** - Adds source code reference section
|
|
163
|
+
|
|
164
|
+
Choice saved to `opensrc/settings.json`.
|
|
165
|
+
|
|
166
|
+
### AGENTS.md Section
|
|
167
|
+
|
|
168
|
+
Adds guidance for AI agents:
|
|
169
|
+
|
|
170
|
+
```markdown
|
|
171
|
+
<!-- opensrc:start -->
|
|
172
|
+
## Source Code Reference
|
|
173
|
+
Source code for dependencies is available in `opensrc/`...
|
|
174
|
+
See `opensrc/sources.json` for the list of available packages.
|
|
175
|
+
<!-- opensrc:end -->
|
|
176
|
+
```
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# Registry Support
|
|
2
|
+
|
|
3
|
+
## Contents
|
|
4
|
+
- npm (Node.js)
|
|
5
|
+
- PyPI (Python)
|
|
6
|
+
- crates.io (Rust)
|
|
7
|
+
- Repository hosts
|
|
8
|
+
|
|
9
|
+
## npm (Node.js)
|
|
10
|
+
|
|
11
|
+
**Prefixes:** `npm:` (or none - default)
|
|
12
|
+
|
|
13
|
+
**API:** `https://registry.npmjs.org/{package}`
|
|
14
|
+
|
|
15
|
+
### Version Detection
|
|
16
|
+
|
|
17
|
+
Auto-detects installed version from (in order):
|
|
18
|
+
1. `node_modules/{pkg}/package.json`
|
|
19
|
+
2. `package-lock.json` (npm v6 and v7+ formats)
|
|
20
|
+
3. `pnpm-lock.yaml`
|
|
21
|
+
4. `yarn.lock`
|
|
22
|
+
5. `package.json` dependencies (strips `^`, `~`, etc.)
|
|
23
|
+
|
|
24
|
+
### Spec Parsing
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
zod → name: zod, version: (detected or latest)
|
|
28
|
+
zod@3.22.0 → name: zod, version: 3.22.0
|
|
29
|
+
@babel/core → name: @babel/core (scoped)
|
|
30
|
+
@babel/core@7.0.0 → name: @babel/core, version: 7.0.0
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Repo URL Extraction
|
|
34
|
+
|
|
35
|
+
From `repository` field, normalizes:
|
|
36
|
+
- `git+https://...` → `https://...`
|
|
37
|
+
- `git://...` → `https://...`
|
|
38
|
+
- `git+ssh://git@...` → `https://...`
|
|
39
|
+
- Removes `.git` suffix
|
|
40
|
+
- Handles `github:owner/repo` shorthand
|
|
41
|
+
|
|
42
|
+
### Monorepo Support
|
|
43
|
+
|
|
44
|
+
Uses `repository.directory` field for packages in monorepos.
|
|
45
|
+
Path becomes: `repos/{host}/{owner}/{repo}/{directory}`
|
|
46
|
+
|
|
47
|
+
## PyPI (Python)
|
|
48
|
+
|
|
49
|
+
**Prefixes:** `pypi:`, `pip:`, `python:`
|
|
50
|
+
|
|
51
|
+
**API:** `https://pypi.org/pypi/{package}/json`
|
|
52
|
+
|
|
53
|
+
### Spec Parsing
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
requests → name: requests
|
|
57
|
+
requests==2.31.0 → name: requests, version: 2.31.0
|
|
58
|
+
requests@2.31.0 → name: requests, version: 2.31.0
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Repo URL Extraction
|
|
62
|
+
|
|
63
|
+
Checks `project_urls` in order:
|
|
64
|
+
1. `Source`, `Source Code`
|
|
65
|
+
2. `Repository`, `GitHub`
|
|
66
|
+
3. `Code`, `Homepage`
|
|
67
|
+
|
|
68
|
+
Falls back to `home_page` if it's a git URL.
|
|
69
|
+
|
|
70
|
+
## crates.io (Rust)
|
|
71
|
+
|
|
72
|
+
**Prefixes:** `crates:`, `cargo:`, `rust:`
|
|
73
|
+
|
|
74
|
+
**API:** `https://crates.io/api/v1/crates/{crate}`
|
|
75
|
+
|
|
76
|
+
### Spec Parsing
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
serde → name: serde
|
|
80
|
+
serde@1.0.0 → name: serde, version: 1.0.0
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Repo URL Extraction
|
|
84
|
+
|
|
85
|
+
Uses `repository` field, falls back to `homepage` if it's a git URL.
|
|
86
|
+
|
|
87
|
+
## Repository Hosts
|
|
88
|
+
|
|
89
|
+
### GitHub
|
|
90
|
+
|
|
91
|
+
**API:** `https://api.github.com/repos/{owner}/{repo}`
|
|
92
|
+
|
|
93
|
+
Resolves default branch, constructs clone URL.
|
|
94
|
+
|
|
95
|
+
**Rate limiting:** 60 req/hour unauthenticated. Error on 403.
|
|
96
|
+
|
|
97
|
+
### GitLab
|
|
98
|
+
|
|
99
|
+
**API:** `https://gitlab.com/api/v4/projects/{owner}%2F{repo}`
|
|
100
|
+
|
|
101
|
+
Resolves default branch, constructs clone URL.
|
|
102
|
+
|
|
103
|
+
### Bitbucket
|
|
104
|
+
|
|
105
|
+
Supported for parsing (`bitbucket:owner/repo`), but no API resolution.
|
|
106
|
+
Assumes `main` as default branch.
|
|
107
|
+
|
|
108
|
+
## Repo Spec Formats
|
|
109
|
+
|
|
110
|
+
| Format | Example | Host |
|
|
111
|
+
|--------|---------|------|
|
|
112
|
+
| `owner/repo` | `vercel/ai` | github.com |
|
|
113
|
+
| `github:owner/repo` | `github:facebook/react` | github.com |
|
|
114
|
+
| `gitlab:owner/repo` | `gitlab:inkscape/inkscape` | gitlab.com |
|
|
115
|
+
| `bitbucket:owner/repo` | `bitbucket:atlassian/python-bitbucket` | bitbucket.org |
|
|
116
|
+
| `host/owner/repo` | `gitlab.com/owner/repo` | (from URL) |
|
|
117
|
+
| Full URL | `https://github.com/...` | (from URL) |
|
|
118
|
+
|
|
119
|
+
## Ref Specifications
|
|
120
|
+
|
|
121
|
+
Append to repo spec:
|
|
122
|
+
|
|
123
|
+
| Suffix | Example | Meaning |
|
|
124
|
+
|--------|---------|---------|
|
|
125
|
+
| `@ref` | `owner/repo@v1.0.0` | Tag, branch, or commit |
|
|
126
|
+
| `#ref` | `owner/repo#main` | Branch (alternative syntax) |
|
|
127
|
+
|
|
128
|
+
URL paths also supported: `https://github.com/owner/repo/tree/branch`
|
|
129
|
+
|
|
130
|
+
## Git Tag Patterns
|
|
131
|
+
|
|
132
|
+
When cloning packages, tries tags in order:
|
|
133
|
+
1. `v{version}` - Most common (e.g., `v3.22.0`)
|
|
134
|
+
2. `{version}` - No prefix (e.g., `3.22.0`)
|
|
135
|
+
3. Default branch - Fallback with warning
|
|
136
|
+
|
|
137
|
+
Uses `--depth 1 --single-branch` for efficient cloning.
|