compound-engineering-pi 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +124 -0
- package/bin/compound-engineering-pi +12 -0
- package/bin/compound-plugin +12 -0
- package/compound-engineering-pi +12 -0
- package/compound-plugin +5 -0
- package/docs/pi.md +152 -0
- package/extensions/compound-engineering-compat.ts +452 -0
- package/package.json +84 -0
- package/pi-resources/compound-engineering/mcporter.json +7 -0
- package/plugins/coding-tutor/.claude-plugin/plugin.json +9 -0
- package/plugins/coding-tutor/README.md +37 -0
- package/plugins/coding-tutor/commands/quiz-me.md +1 -0
- package/plugins/coding-tutor/commands/sync-tutorials.md +25 -0
- package/plugins/coding-tutor/commands/teach-me.md +1 -0
- package/plugins/coding-tutor/skills/coding-tutor/SKILL.md +214 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/create_tutorial.py +207 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/index_tutorials.py +193 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/quiz_priority.py +190 -0
- package/plugins/coding-tutor/skills/coding-tutor/scripts/setup_tutorials.py +118 -0
- package/plugins/compound-engineering/.claude-plugin/plugin.json +33 -0
- package/plugins/compound-engineering/CHANGELOG.md +457 -0
- package/plugins/compound-engineering/CLAUDE.md +89 -0
- package/plugins/compound-engineering/LICENSE +21 -0
- package/plugins/compound-engineering/README.md +232 -0
- package/plugins/compound-engineering/agents/design/design-implementation-reviewer.md +109 -0
- package/plugins/compound-engineering/agents/design/design-iterator.md +224 -0
- package/plugins/compound-engineering/agents/design/figma-design-sync.md +190 -0
- package/plugins/compound-engineering/agents/docs/ankane-readme-writer.md +65 -0
- package/plugins/compound-engineering/agents/research/best-practices-researcher.md +126 -0
- package/plugins/compound-engineering/agents/research/framework-docs-researcher.md +106 -0
- package/plugins/compound-engineering/agents/research/git-history-analyzer.md +59 -0
- package/plugins/compound-engineering/agents/research/learnings-researcher.md +264 -0
- package/plugins/compound-engineering/agents/research/repo-research-analyst.md +135 -0
- package/plugins/compound-engineering/agents/review/agent-native-reviewer.md +261 -0
- package/plugins/compound-engineering/agents/review/architecture-strategist.md +67 -0
- package/plugins/compound-engineering/agents/review/code-simplicity-reviewer.md +101 -0
- package/plugins/compound-engineering/agents/review/data-integrity-guardian.md +85 -0
- package/plugins/compound-engineering/agents/review/data-migration-expert.md +112 -0
- package/plugins/compound-engineering/agents/review/deployment-verification-agent.md +174 -0
- package/plugins/compound-engineering/agents/review/dhh-rails-reviewer.md +66 -0
- package/plugins/compound-engineering/agents/review/julik-frontend-races-reviewer.md +221 -0
- package/plugins/compound-engineering/agents/review/kieran-python-reviewer.md +133 -0
- package/plugins/compound-engineering/agents/review/kieran-rails-reviewer.md +115 -0
- package/plugins/compound-engineering/agents/review/kieran-typescript-reviewer.md +124 -0
- package/plugins/compound-engineering/agents/review/pattern-recognition-specialist.md +72 -0
- package/plugins/compound-engineering/agents/review/performance-oracle.md +137 -0
- package/plugins/compound-engineering/agents/review/schema-drift-detector.md +154 -0
- package/plugins/compound-engineering/agents/review/security-sentinel.md +114 -0
- package/plugins/compound-engineering/agents/workflow/bug-reproduction-validator.md +82 -0
- package/plugins/compound-engineering/agents/workflow/every-style-editor.md +64 -0
- package/plugins/compound-engineering/agents/workflow/lint.md +16 -0
- package/plugins/compound-engineering/agents/workflow/pr-comment-resolver.md +84 -0
- package/plugins/compound-engineering/agents/workflow/spec-flow-analyzer.md +134 -0
- package/plugins/compound-engineering/commands/agent-native-audit.md +278 -0
- package/plugins/compound-engineering/commands/changelog.md +138 -0
- package/plugins/compound-engineering/commands/create-agent-skill.md +9 -0
- package/plugins/compound-engineering/commands/deepen-plan.md +546 -0
- package/plugins/compound-engineering/commands/deploy-docs.md +113 -0
- package/plugins/compound-engineering/commands/feature-video.md +342 -0
- package/plugins/compound-engineering/commands/generate_command.md +163 -0
- package/plugins/compound-engineering/commands/heal-skill.md +143 -0
- package/plugins/compound-engineering/commands/lfg.md +20 -0
- package/plugins/compound-engineering/commands/release-docs.md +212 -0
- package/plugins/compound-engineering/commands/report-bug.md +151 -0
- package/plugins/compound-engineering/commands/reproduce-bug.md +100 -0
- package/plugins/compound-engineering/commands/resolve_parallel.md +35 -0
- package/plugins/compound-engineering/commands/resolve_todo_parallel.md +37 -0
- package/plugins/compound-engineering/commands/slfg.md +32 -0
- package/plugins/compound-engineering/commands/technical_review.md +8 -0
- package/plugins/compound-engineering/commands/test-browser.md +339 -0
- package/plugins/compound-engineering/commands/test-xcode.md +332 -0
- package/plugins/compound-engineering/commands/triage.md +311 -0
- package/plugins/compound-engineering/commands/workflows/brainstorm.md +124 -0
- package/plugins/compound-engineering/commands/workflows/compound.md +239 -0
- package/plugins/compound-engineering/commands/workflows/plan.md +551 -0
- package/plugins/compound-engineering/commands/workflows/review.md +526 -0
- package/plugins/compound-engineering/commands/workflows/work.md +433 -0
- package/plugins/compound-engineering/skills/agent-browser/SKILL.md +223 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/SKILL.md +435 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/action-parity-discipline.md +409 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/agent-execution-patterns.md +467 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/agent-native-testing.md +582 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/architecture-patterns.md +478 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/dynamic-context-injection.md +338 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/files-universal-interface.md +301 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/from-primitives-to-domain-tools.md +359 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/mcp-tool-design.md +506 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/mobile-patterns.md +871 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/product-implications.md +443 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/refactoring-to-prompt-native.md +317 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/self-modification.md +269 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/shared-workspace-architecture.md +680 -0
- package/plugins/compound-engineering/skills/agent-native-architecture/references/system-prompt-design.md +250 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/SKILL.md +184 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/database-adapters.md +231 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/module-organization.md +121 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/rails-integration.md +183 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/resources.md +119 -0
- package/plugins/compound-engineering/skills/andrew-kane-gem-writer/references/testing-patterns.md +261 -0
- package/plugins/compound-engineering/skills/brainstorming/SKILL.md +190 -0
- package/plugins/compound-engineering/skills/compound-docs/SKILL.md +511 -0
- package/plugins/compound-engineering/skills/compound-docs/assets/critical-pattern-template.md +34 -0
- package/plugins/compound-engineering/skills/compound-docs/assets/resolution-template.md +93 -0
- package/plugins/compound-engineering/skills/compound-docs/references/yaml-schema.md +65 -0
- package/plugins/compound-engineering/skills/compound-docs/schema.yaml +176 -0
- package/plugins/compound-engineering/skills/create-agent-skills/SKILL.md +275 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/api-security.md +226 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/be-clear-and-direct.md +531 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/best-practices.md +404 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/common-patterns.md +595 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/core-principles.md +437 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/executable-code.md +175 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/iteration-and-testing.md +474 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/official-spec.md +134 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/recommended-structure.md +168 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/skill-structure.md +152 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/using-scripts.md +113 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/using-templates.md +112 -0
- package/plugins/compound-engineering/skills/create-agent-skills/references/workflows-and-validation.md +510 -0
- package/plugins/compound-engineering/skills/create-agent-skills/templates/router-skill.md +73 -0
- package/plugins/compound-engineering/skills/create-agent-skills/templates/simple-skill.md +33 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-reference.md +96 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-script.md +93 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-template.md +74 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/add-workflow.md +120 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/audit-skill.md +138 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/create-domain-expertise-skill.md +605 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/create-new-skill.md +191 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/get-guidance.md +121 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/upgrade-to-router.md +161 -0
- package/plugins/compound-engineering/skills/create-agent-skills/workflows/verify-skill.md +204 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/SKILL.md +185 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/architecture.md +653 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/controllers.md +303 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/frontend.md +510 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/gems.md +266 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/models.md +359 -0
- package/plugins/compound-engineering/skills/dhh-rails-style/references/testing.md +338 -0
- package/plugins/compound-engineering/skills/document-review/SKILL.md +87 -0
- package/plugins/compound-engineering/skills/dspy-ruby/SKILL.md +737 -0
- package/plugins/compound-engineering/skills/dspy-ruby/assets/config-template.rb +187 -0
- package/plugins/compound-engineering/skills/dspy-ruby/assets/module-template.rb +300 -0
- package/plugins/compound-engineering/skills/dspy-ruby/assets/signature-template.rb +221 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/core-concepts.md +674 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/observability.md +366 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/optimization.md +603 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/providers.md +418 -0
- package/plugins/compound-engineering/skills/dspy-ruby/references/toolsets.md +502 -0
- package/plugins/compound-engineering/skills/every-style-editor/SKILL.md +134 -0
- package/plugins/compound-engineering/skills/every-style-editor/references/EVERY_WRITE_STYLE.md +529 -0
- package/plugins/compound-engineering/skills/file-todos/SKILL.md +252 -0
- package/plugins/compound-engineering/skills/file-todos/assets/todo-template.md +155 -0
- package/plugins/compound-engineering/skills/frontend-design/SKILL.md +42 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/SKILL.md +237 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/requirements.txt +2 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/compose_images.py +157 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/edit_image.py +144 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/gemini_images.py +263 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/generate_image.py +133 -0
- package/plugins/compound-engineering/skills/gemini-imagegen/scripts/multi_turn_chat.py +216 -0
- package/plugins/compound-engineering/skills/git-worktree/SKILL.md +302 -0
- package/plugins/compound-engineering/skills/git-worktree/scripts/worktree-manager.sh +337 -0
- package/plugins/compound-engineering/skills/orchestrating-swarms/SKILL.md +1718 -0
- package/plugins/compound-engineering/skills/rclone/SKILL.md +150 -0
- package/plugins/compound-engineering/skills/rclone/scripts/check_setup.sh +60 -0
- package/plugins/compound-engineering/skills/resolve-pr-parallel/SKILL.md +89 -0
- package/plugins/compound-engineering/skills/resolve-pr-parallel/scripts/get-pr-comments +68 -0
- package/plugins/compound-engineering/skills/resolve-pr-parallel/scripts/resolve-pr-thread +23 -0
- package/plugins/compound-engineering/skills/skill-creator/SKILL.md +210 -0
- package/plugins/compound-engineering/skills/skill-creator/scripts/init_skill.py +303 -0
- package/plugins/compound-engineering/skills/skill-creator/scripts/package_skill.py +110 -0
- package/plugins/compound-engineering/skills/skill-creator/scripts/quick_validate.py +65 -0
- package/prompts/deepen-plan.md +549 -0
- package/prompts/feature-video.md +341 -0
- package/prompts/resolve_todo_parallel.md +36 -0
- package/prompts/test-browser.md +342 -0
- package/prompts/workflows-brainstorm.md +123 -0
- package/prompts/workflows-compound.md +238 -0
- package/prompts/workflows-plan.md +550 -0
- package/prompts/workflows-review.md +529 -0
- package/prompts/workflows-work.md +432 -0
- package/skills/agent-browser/SKILL.md +223 -0
- package/skills/agent-native-architecture/SKILL.md +435 -0
- package/skills/agent-native-architecture/references/action-parity-discipline.md +409 -0
- package/skills/agent-native-architecture/references/agent-execution-patterns.md +467 -0
- package/skills/agent-native-architecture/references/agent-native-testing.md +582 -0
- package/skills/agent-native-architecture/references/architecture-patterns.md +478 -0
- package/skills/agent-native-architecture/references/dynamic-context-injection.md +338 -0
- package/skills/agent-native-architecture/references/files-universal-interface.md +301 -0
- package/skills/agent-native-architecture/references/from-primitives-to-domain-tools.md +359 -0
- package/skills/agent-native-architecture/references/mcp-tool-design.md +506 -0
- package/skills/agent-native-architecture/references/mobile-patterns.md +871 -0
- package/skills/agent-native-architecture/references/product-implications.md +443 -0
- package/skills/agent-native-architecture/references/refactoring-to-prompt-native.md +317 -0
- package/skills/agent-native-architecture/references/self-modification.md +269 -0
- package/skills/agent-native-architecture/references/shared-workspace-architecture.md +680 -0
- package/skills/agent-native-architecture/references/system-prompt-design.md +250 -0
- package/skills/agent-native-reviewer/SKILL.md +260 -0
- package/skills/andrew-kane-gem-writer/SKILL.md +184 -0
- package/skills/andrew-kane-gem-writer/references/database-adapters.md +231 -0
- package/skills/andrew-kane-gem-writer/references/module-organization.md +121 -0
- package/skills/andrew-kane-gem-writer/references/rails-integration.md +183 -0
- package/skills/andrew-kane-gem-writer/references/resources.md +119 -0
- package/skills/andrew-kane-gem-writer/references/testing-patterns.md +261 -0
- package/skills/ankane-readme-writer/SKILL.md +63 -0
- package/skills/architecture-strategist/SKILL.md +66 -0
- package/skills/best-practices-researcher/SKILL.md +125 -0
- package/skills/brainstorming/SKILL.md +190 -0
- package/skills/bug-reproduction-validator/SKILL.md +81 -0
- package/skills/code-simplicity-reviewer/SKILL.md +100 -0
- package/skills/compound-docs/SKILL.md +511 -0
- package/skills/compound-docs/assets/critical-pattern-template.md +34 -0
- package/skills/compound-docs/assets/resolution-template.md +93 -0
- package/skills/compound-docs/references/yaml-schema.md +65 -0
- package/skills/compound-docs/schema.yaml +176 -0
- package/skills/create-agent-skills/SKILL.md +275 -0
- package/skills/create-agent-skills/references/api-security.md +226 -0
- package/skills/create-agent-skills/references/be-clear-and-direct.md +531 -0
- package/skills/create-agent-skills/references/best-practices.md +404 -0
- package/skills/create-agent-skills/references/common-patterns.md +595 -0
- package/skills/create-agent-skills/references/core-principles.md +437 -0
- package/skills/create-agent-skills/references/executable-code.md +175 -0
- package/skills/create-agent-skills/references/iteration-and-testing.md +474 -0
- package/skills/create-agent-skills/references/official-spec.md +134 -0
- package/skills/create-agent-skills/references/recommended-structure.md +168 -0
- package/skills/create-agent-skills/references/skill-structure.md +152 -0
- package/skills/create-agent-skills/references/using-scripts.md +113 -0
- package/skills/create-agent-skills/references/using-templates.md +112 -0
- package/skills/create-agent-skills/references/workflows-and-validation.md +510 -0
- package/skills/create-agent-skills/templates/router-skill.md +73 -0
- package/skills/create-agent-skills/templates/simple-skill.md +33 -0
- package/skills/create-agent-skills/workflows/add-reference.md +96 -0
- package/skills/create-agent-skills/workflows/add-script.md +93 -0
- package/skills/create-agent-skills/workflows/add-template.md +74 -0
- package/skills/create-agent-skills/workflows/add-workflow.md +120 -0
- package/skills/create-agent-skills/workflows/audit-skill.md +138 -0
- package/skills/create-agent-skills/workflows/create-domain-expertise-skill.md +605 -0
- package/skills/create-agent-skills/workflows/create-new-skill.md +191 -0
- package/skills/create-agent-skills/workflows/get-guidance.md +121 -0
- package/skills/create-agent-skills/workflows/upgrade-to-router.md +161 -0
- package/skills/create-agent-skills/workflows/verify-skill.md +204 -0
- package/skills/data-integrity-guardian/SKILL.md +84 -0
- package/skills/data-migration-expert/SKILL.md +111 -0
- package/skills/deployment-verification-agent/SKILL.md +173 -0
- package/skills/design-implementation-reviewer/SKILL.md +107 -0
- package/skills/design-iterator/SKILL.md +222 -0
- package/skills/dhh-rails-reviewer/SKILL.md +65 -0
- package/skills/dhh-rails-style/SKILL.md +185 -0
- package/skills/dhh-rails-style/references/architecture.md +653 -0
- package/skills/dhh-rails-style/references/controllers.md +303 -0
- package/skills/dhh-rails-style/references/frontend.md +510 -0
- package/skills/dhh-rails-style/references/gems.md +266 -0
- package/skills/dhh-rails-style/references/models.md +359 -0
- package/skills/dhh-rails-style/references/testing.md +338 -0
- package/skills/document-review/SKILL.md +87 -0
- package/skills/dspy-ruby/SKILL.md +737 -0
- package/skills/dspy-ruby/assets/config-template.rb +187 -0
- package/skills/dspy-ruby/assets/module-template.rb +300 -0
- package/skills/dspy-ruby/assets/signature-template.rb +221 -0
- package/skills/dspy-ruby/references/core-concepts.md +674 -0
- package/skills/dspy-ruby/references/observability.md +366 -0
- package/skills/dspy-ruby/references/optimization.md +603 -0
- package/skills/dspy-ruby/references/providers.md +418 -0
- package/skills/dspy-ruby/references/toolsets.md +502 -0
- package/skills/every-style-editor/SKILL.md +134 -0
- package/skills/every-style-editor/references/EVERY_WRITE_STYLE.md +529 -0
- package/skills/every-style-editor-2/SKILL.md +62 -0
- package/skills/figma-design-sync/SKILL.md +188 -0
- package/skills/file-todos/SKILL.md +252 -0
- package/skills/file-todos/assets/todo-template.md +155 -0
- package/skills/framework-docs-researcher/SKILL.md +105 -0
- package/skills/frontend-design/SKILL.md +42 -0
- package/skills/gemini-imagegen/SKILL.md +237 -0
- package/skills/gemini-imagegen/requirements.txt +2 -0
- package/skills/gemini-imagegen/scripts/compose_images.py +157 -0
- package/skills/gemini-imagegen/scripts/edit_image.py +144 -0
- package/skills/gemini-imagegen/scripts/gemini_images.py +263 -0
- package/skills/gemini-imagegen/scripts/generate_image.py +133 -0
- package/skills/gemini-imagegen/scripts/multi_turn_chat.py +216 -0
- package/skills/git-history-analyzer/SKILL.md +58 -0
- package/skills/git-worktree/SKILL.md +302 -0
- package/skills/git-worktree/scripts/worktree-manager.sh +337 -0
- package/skills/julik-frontend-races-reviewer/SKILL.md +220 -0
- package/skills/kieran-python-reviewer/SKILL.md +132 -0
- package/skills/kieran-rails-reviewer/SKILL.md +114 -0
- package/skills/kieran-typescript-reviewer/SKILL.md +123 -0
- package/skills/learnings-researcher/SKILL.md +263 -0
- package/skills/lint/SKILL.md +14 -0
- package/skills/orchestrating-swarms/SKILL.md +1718 -0
- package/skills/pattern-recognition-specialist/SKILL.md +71 -0
- package/skills/performance-oracle/SKILL.md +136 -0
- package/skills/pr-comment-resolver/SKILL.md +82 -0
- package/skills/rclone/SKILL.md +150 -0
- package/skills/rclone/scripts/check_setup.sh +60 -0
- package/skills/repo-research-analyst/SKILL.md +134 -0
- package/skills/resolve_pr_parallel/SKILL.md +89 -0
- package/skills/resolve_pr_parallel/scripts/get-pr-comments +68 -0
- package/skills/resolve_pr_parallel/scripts/resolve-pr-thread +23 -0
- package/skills/schema-drift-detector/SKILL.md +153 -0
- package/skills/security-sentinel/SKILL.md +113 -0
- package/skills/skill-creator/SKILL.md +210 -0
- package/skills/skill-creator/scripts/init_skill.py +303 -0
- package/skills/skill-creator/scripts/package_skill.py +110 -0
- package/skills/skill-creator/scripts/quick_validate.py +65 -0
- package/skills/spec-flow-analyzer/SKILL.md +133 -0
- package/src/commands/convert.ts +183 -0
- package/src/commands/install.ts +273 -0
- package/src/commands/list.ts +37 -0
- package/src/commands/sync.ts +89 -0
- package/src/converters/claude-to-codex.ts +182 -0
- package/src/converters/claude-to-opencode.ts +395 -0
- package/src/converters/claude-to-pi.ts +205 -0
- package/src/index.ts +22 -0
- package/src/parsers/claude-home.ts +65 -0
- package/src/parsers/claude.ts +252 -0
- package/src/sync/codex.ts +92 -0
- package/src/sync/opencode.ts +75 -0
- package/src/sync/pi.ts +88 -0
- package/src/targets/codex.ts +96 -0
- package/src/targets/index.ts +38 -0
- package/src/targets/opencode.ts +57 -0
- package/src/targets/pi.ts +131 -0
- package/src/templates/pi/compat-extension.ts +452 -0
- package/src/types/claude.ts +90 -0
- package/src/types/codex.ts +23 -0
- package/src/types/opencode.ts +54 -0
- package/src/types/pi.ts +40 -0
- package/src/utils/codex-agents.ts +64 -0
- package/src/utils/files.ts +77 -0
- package/src/utils/frontmatter.ts +65 -0
- package/src/utils/symlink.ts +43 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rclone
|
|
3
|
+
description: Upload, sync, and manage files across cloud storage providers using rclone. Use when uploading files (images, videos, documents) to S3, Cloudflare R2, Backblaze B2, Google Drive, Dropbox, or any S3-compatible storage. Triggers on "upload to S3", "sync to cloud", "rclone", "backup files", "upload video/image to bucket", or requests to transfer files to remote storage.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# rclone File Transfer Skill
|
|
7
|
+
|
|
8
|
+
## Setup Check (Always Run First)
|
|
9
|
+
|
|
10
|
+
Before any rclone operation, verify installation and configuration:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# Check if rclone is installed
|
|
14
|
+
command -v rclone >/dev/null 2>&1 && echo "rclone installed: $(rclone version | head -1)" || echo "NOT INSTALLED"
|
|
15
|
+
|
|
16
|
+
# List configured remotes
|
|
17
|
+
rclone listremotes 2>/dev/null || echo "NO REMOTES CONFIGURED"
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### If rclone is NOT installed
|
|
21
|
+
|
|
22
|
+
Guide the user to install:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# macOS
|
|
26
|
+
brew install rclone
|
|
27
|
+
|
|
28
|
+
# Linux (script install)
|
|
29
|
+
curl https://rclone.org/install.sh | sudo bash
|
|
30
|
+
|
|
31
|
+
# Or via package manager
|
|
32
|
+
sudo apt install rclone # Debian/Ubuntu
|
|
33
|
+
sudo dnf install rclone # Fedora
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### If NO remotes are configured
|
|
37
|
+
|
|
38
|
+
Walk the user through interactive configuration:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
rclone config
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
**Common provider setup quick reference:**
|
|
45
|
+
|
|
46
|
+
| Provider | Type | Key Settings |
|
|
47
|
+
|----------|------|--------------|
|
|
48
|
+
| AWS S3 | `s3` | access_key_id, secret_access_key, region |
|
|
49
|
+
| Cloudflare R2 | `s3` | access_key_id, secret_access_key, endpoint (account_id.r2.cloudflarestorage.com) |
|
|
50
|
+
| Backblaze B2 | `b2` | account (keyID), key (applicationKey) |
|
|
51
|
+
| DigitalOcean Spaces | `s3` | access_key_id, secret_access_key, endpoint (region.digitaloceanspaces.com) |
|
|
52
|
+
| Google Drive | `drive` | OAuth flow (opens browser) |
|
|
53
|
+
| Dropbox | `dropbox` | OAuth flow (opens browser) |
|
|
54
|
+
|
|
55
|
+
**Example: Configure Cloudflare R2**
|
|
56
|
+
```bash
|
|
57
|
+
rclone config create r2 s3 \
|
|
58
|
+
provider=Cloudflare \
|
|
59
|
+
access_key_id=YOUR_ACCESS_KEY \
|
|
60
|
+
secret_access_key=YOUR_SECRET_KEY \
|
|
61
|
+
endpoint=ACCOUNT_ID.r2.cloudflarestorage.com \
|
|
62
|
+
acl=private
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**Example: Configure AWS S3**
|
|
66
|
+
```bash
|
|
67
|
+
rclone config create aws s3 \
|
|
68
|
+
provider=AWS \
|
|
69
|
+
access_key_id=YOUR_ACCESS_KEY \
|
|
70
|
+
secret_access_key=YOUR_SECRET_KEY \
|
|
71
|
+
region=us-east-1
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Common Operations
|
|
75
|
+
|
|
76
|
+
### Upload single file
|
|
77
|
+
```bash
|
|
78
|
+
rclone copy /path/to/file.mp4 remote:bucket/path/ --progress
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Upload directory
|
|
82
|
+
```bash
|
|
83
|
+
rclone copy /path/to/folder remote:bucket/folder/ --progress
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Sync directory (mirror, deletes removed files)
|
|
87
|
+
```bash
|
|
88
|
+
rclone sync /local/path remote:bucket/path/ --progress
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### List remote contents
|
|
92
|
+
```bash
|
|
93
|
+
rclone ls remote:bucket/
|
|
94
|
+
rclone lsd remote:bucket/ # directories only
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Check what would be transferred (dry run)
|
|
98
|
+
```bash
|
|
99
|
+
rclone copy /path remote:bucket/ --dry-run
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Useful Flags
|
|
103
|
+
|
|
104
|
+
| Flag | Purpose |
|
|
105
|
+
|------|---------|
|
|
106
|
+
| `--progress` | Show transfer progress |
|
|
107
|
+
| `--dry-run` | Preview without transferring |
|
|
108
|
+
| `-v` | Verbose output |
|
|
109
|
+
| `--transfers=N` | Parallel transfers (default 4) |
|
|
110
|
+
| `--bwlimit=RATE` | Bandwidth limit (e.g., `10M`) |
|
|
111
|
+
| `--checksum` | Compare by checksum, not size/time |
|
|
112
|
+
| `--exclude="*.tmp"` | Exclude patterns |
|
|
113
|
+
| `--include="*.mp4"` | Include only matching |
|
|
114
|
+
| `--min-size=SIZE` | Skip files smaller than SIZE |
|
|
115
|
+
| `--max-size=SIZE` | Skip files larger than SIZE |
|
|
116
|
+
|
|
117
|
+
## Large File Uploads
|
|
118
|
+
|
|
119
|
+
For videos and large files, use chunked uploads:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
# S3 multipart upload (automatic for >200MB)
|
|
123
|
+
rclone copy large_video.mp4 remote:bucket/ --s3-chunk-size=64M --progress
|
|
124
|
+
|
|
125
|
+
# Resume interrupted transfers
|
|
126
|
+
rclone copy /path remote:bucket/ --progress --retries=5
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Verify Upload
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
# Check file exists and matches
|
|
133
|
+
rclone check /local/file remote:bucket/file
|
|
134
|
+
|
|
135
|
+
# Get file info
|
|
136
|
+
rclone lsl remote:bucket/path/to/file
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## Troubleshooting
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
# Test connection
|
|
143
|
+
rclone lsd remote:
|
|
144
|
+
|
|
145
|
+
# Debug connection issues
|
|
146
|
+
rclone lsd remote: -vv
|
|
147
|
+
|
|
148
|
+
# Check config
|
|
149
|
+
rclone config show remote
|
|
150
|
+
```
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
#!/bin/bash
|
|
2
|
+
# rclone setup checker - verifies installation and configuration
|
|
3
|
+
|
|
4
|
+
set -e
|
|
5
|
+
|
|
6
|
+
echo "=== rclone Setup Check ==="
|
|
7
|
+
echo
|
|
8
|
+
|
|
9
|
+
# Check if rclone is installed
|
|
10
|
+
if command -v rclone >/dev/null 2>&1; then
|
|
11
|
+
echo "✓ rclone installed"
|
|
12
|
+
rclone version | head -1
|
|
13
|
+
echo
|
|
14
|
+
else
|
|
15
|
+
echo "✗ rclone NOT INSTALLED"
|
|
16
|
+
echo
|
|
17
|
+
echo "Install with:"
|
|
18
|
+
echo " macOS: brew install rclone"
|
|
19
|
+
echo " Linux: curl https://rclone.org/install.sh | sudo bash"
|
|
20
|
+
echo " or: sudo apt install rclone"
|
|
21
|
+
exit 1
|
|
22
|
+
fi
|
|
23
|
+
|
|
24
|
+
# Check for configured remotes
|
|
25
|
+
REMOTES=$(rclone listremotes 2>/dev/null || true)
|
|
26
|
+
|
|
27
|
+
if [ -z "$REMOTES" ]; then
|
|
28
|
+
echo "✗ No remotes configured"
|
|
29
|
+
echo
|
|
30
|
+
echo "Run 'rclone config' to set up a remote, or use:"
|
|
31
|
+
echo
|
|
32
|
+
echo " # Cloudflare R2"
|
|
33
|
+
echo " rclone config create r2 s3 provider=Cloudflare \\"
|
|
34
|
+
echo " access_key_id=KEY secret_access_key=SECRET \\"
|
|
35
|
+
echo " endpoint=ACCOUNT_ID.r2.cloudflarestorage.com"
|
|
36
|
+
echo
|
|
37
|
+
echo " # AWS S3"
|
|
38
|
+
echo " rclone config create aws s3 provider=AWS \\"
|
|
39
|
+
echo " access_key_id=KEY secret_access_key=SECRET region=us-east-1"
|
|
40
|
+
echo
|
|
41
|
+
exit 1
|
|
42
|
+
else
|
|
43
|
+
echo "✓ Configured remotes:"
|
|
44
|
+
echo "$REMOTES" | sed 's/^/ /'
|
|
45
|
+
echo
|
|
46
|
+
fi
|
|
47
|
+
|
|
48
|
+
# Test connectivity for each remote
|
|
49
|
+
echo "Testing remote connectivity..."
|
|
50
|
+
for remote in $REMOTES; do
|
|
51
|
+
remote_name="${remote%:}"
|
|
52
|
+
if rclone lsd "$remote" >/dev/null 2>&1; then
|
|
53
|
+
echo " ✓ $remote_name - connected"
|
|
54
|
+
else
|
|
55
|
+
echo " ✗ $remote_name - connection failed (check credentials)"
|
|
56
|
+
fi
|
|
57
|
+
done
|
|
58
|
+
|
|
59
|
+
echo
|
|
60
|
+
echo "=== Setup Complete ==="
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: resolve_pr_parallel
|
|
3
|
+
description: Resolve all PR comments using parallel processing. Use when addressing PR review feedback, resolving review threads, or batch-fixing PR comments.
|
|
4
|
+
argument-hint: "[optional: PR number or current PR]"
|
|
5
|
+
disable-model-invocation: true
|
|
6
|
+
allowed-tools: Bash(gh *), Bash(git *), Read
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Resolve PR Comments in Parallel
|
|
10
|
+
|
|
11
|
+
Resolve all unresolved PR review comments by spawning parallel agents for each thread.
|
|
12
|
+
|
|
13
|
+
## Context Detection
|
|
14
|
+
|
|
15
|
+
Claude Code automatically detects git context:
|
|
16
|
+
- Current branch and associated PR
|
|
17
|
+
- All PR comments and review threads
|
|
18
|
+
- Works with any PR by specifying the number
|
|
19
|
+
|
|
20
|
+
## Workflow
|
|
21
|
+
|
|
22
|
+
### 1. Analyze
|
|
23
|
+
|
|
24
|
+
Fetch unresolved review threads using the GraphQL script:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
bash ${CLAUDE_PLUGIN_ROOT}/skills/resolve-pr-parallel/scripts/get-pr-comments PR_NUMBER
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
This returns only **unresolved, non-outdated** threads with file paths, line numbers, and comment bodies.
|
|
31
|
+
|
|
32
|
+
If the script fails, fall back to:
|
|
33
|
+
```bash
|
|
34
|
+
gh pr view PR_NUMBER --json reviews,comments
|
|
35
|
+
gh api repos/{owner}/{repo}/pulls/PR_NUMBER/comments
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### 2. Plan
|
|
39
|
+
|
|
40
|
+
Create a TodoWrite list of all unresolved items grouped by type:
|
|
41
|
+
- Code changes requested
|
|
42
|
+
- Questions to answer
|
|
43
|
+
- Style/convention fixes
|
|
44
|
+
- Test additions needed
|
|
45
|
+
|
|
46
|
+
### 3. Implement (PARALLEL)
|
|
47
|
+
|
|
48
|
+
Spawn a `pr-comment-resolver` agent for each unresolved item in parallel.
|
|
49
|
+
|
|
50
|
+
If there are 3 comments, spawn 3 agents:
|
|
51
|
+
|
|
52
|
+
1. Task pr-comment-resolver(comment1)
|
|
53
|
+
2. Task pr-comment-resolver(comment2)
|
|
54
|
+
3. Task pr-comment-resolver(comment3)
|
|
55
|
+
|
|
56
|
+
Always run all in parallel subagents/Tasks for each Todo item.
|
|
57
|
+
|
|
58
|
+
### 4. Commit & Resolve
|
|
59
|
+
|
|
60
|
+
- Commit changes with a clear message referencing the PR feedback
|
|
61
|
+
- Resolve each thread programmatically:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
bash ${CLAUDE_PLUGIN_ROOT}/skills/resolve-pr-parallel/scripts/resolve-pr-thread THREAD_ID
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
- Push to remote
|
|
68
|
+
|
|
69
|
+
### 5. Verify
|
|
70
|
+
|
|
71
|
+
Re-fetch comments to confirm all threads are resolved:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
bash ${CLAUDE_PLUGIN_ROOT}/skills/resolve-pr-parallel/scripts/get-pr-comments PR_NUMBER
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Should return an empty array `[]`. If threads remain, repeat from step 1.
|
|
78
|
+
|
|
79
|
+
## Scripts
|
|
80
|
+
|
|
81
|
+
- [scripts/get-pr-comments](scripts/get-pr-comments) - GraphQL query for unresolved review threads
|
|
82
|
+
- [scripts/resolve-pr-thread](scripts/resolve-pr-thread) - GraphQL mutation to resolve a thread by ID
|
|
83
|
+
|
|
84
|
+
## Success Criteria
|
|
85
|
+
|
|
86
|
+
- All unresolved review threads addressed
|
|
87
|
+
- Changes committed and pushed
|
|
88
|
+
- Threads resolved via GraphQL (marked as resolved on GitHub)
|
|
89
|
+
- Empty result from get-pr-comments on verify
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
|
|
3
|
+
set -e
|
|
4
|
+
|
|
5
|
+
if [ $# -lt 1 ]; then
|
|
6
|
+
echo "Usage: get-pr-comments PR_NUMBER [OWNER/REPO]"
|
|
7
|
+
echo "Example: get-pr-comments 123"
|
|
8
|
+
echo "Example: get-pr-comments 123 EveryInc/cora"
|
|
9
|
+
exit 1
|
|
10
|
+
fi
|
|
11
|
+
|
|
12
|
+
PR_NUMBER=$1
|
|
13
|
+
|
|
14
|
+
if [ -n "$2" ]; then
|
|
15
|
+
OWNER=$(echo "$2" | cut -d/ -f1)
|
|
16
|
+
REPO=$(echo "$2" | cut -d/ -f2)
|
|
17
|
+
else
|
|
18
|
+
OWNER=$(gh repo view --json owner -q .owner.login 2>/dev/null)
|
|
19
|
+
REPO=$(gh repo view --json name -q .name 2>/dev/null)
|
|
20
|
+
fi
|
|
21
|
+
|
|
22
|
+
if [ -z "$OWNER" ] || [ -z "$REPO" ]; then
|
|
23
|
+
echo "Error: Could not detect repository. Pass OWNER/REPO as second argument."
|
|
24
|
+
exit 1
|
|
25
|
+
fi
|
|
26
|
+
|
|
27
|
+
gh api graphql -f owner="$OWNER" -f repo="$REPO" -F pr="$PR_NUMBER" -f query='
|
|
28
|
+
query FetchUnresolvedComments($owner: String!, $repo: String!, $pr: Int!) {
|
|
29
|
+
repository(owner: $owner, name: $repo) {
|
|
30
|
+
pullRequest(number: $pr) {
|
|
31
|
+
title
|
|
32
|
+
url
|
|
33
|
+
reviewThreads(first: 100) {
|
|
34
|
+
totalCount
|
|
35
|
+
edges {
|
|
36
|
+
node {
|
|
37
|
+
id
|
|
38
|
+
isResolved
|
|
39
|
+
isOutdated
|
|
40
|
+
isCollapsed
|
|
41
|
+
path
|
|
42
|
+
line
|
|
43
|
+
startLine
|
|
44
|
+
diffSide
|
|
45
|
+
comments(first: 100) {
|
|
46
|
+
totalCount
|
|
47
|
+
nodes {
|
|
48
|
+
id
|
|
49
|
+
author {
|
|
50
|
+
login
|
|
51
|
+
}
|
|
52
|
+
body
|
|
53
|
+
createdAt
|
|
54
|
+
updatedAt
|
|
55
|
+
url
|
|
56
|
+
outdated
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
pageInfo {
|
|
62
|
+
hasNextPage
|
|
63
|
+
endCursor
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}' | jq '.data.repository.pullRequest.reviewThreads.edges | map(select(.node.isResolved == false and .node.isOutdated == false))'
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
|
|
3
|
+
set -e
|
|
4
|
+
|
|
5
|
+
if [ $# -eq 0 ]; then
|
|
6
|
+
echo "Usage: resolve-pr-thread THREAD_ID"
|
|
7
|
+
echo "Example: resolve-pr-thread PRRT_kwDOABC123"
|
|
8
|
+
exit 1
|
|
9
|
+
fi
|
|
10
|
+
|
|
11
|
+
THREAD_ID=$1
|
|
12
|
+
|
|
13
|
+
gh api graphql -f threadId="$THREAD_ID" -f query='
|
|
14
|
+
mutation ResolveReviewThread($threadId: ID!) {
|
|
15
|
+
resolveReviewThread(input: {threadId: $threadId}) {
|
|
16
|
+
thread {
|
|
17
|
+
id
|
|
18
|
+
isResolved
|
|
19
|
+
path
|
|
20
|
+
line
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}'
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: skill-creator
|
|
3
|
+
description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
|
|
4
|
+
license: Complete terms in LICENSE.txt
|
|
5
|
+
disable-model-invocation: true
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Skill Creator
|
|
9
|
+
|
|
10
|
+
This skill provides guidance for creating effective skills.
|
|
11
|
+
|
|
12
|
+
## About Skills
|
|
13
|
+
|
|
14
|
+
Skills are modular, self-contained packages that extend Claude's capabilities by providing
|
|
15
|
+
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
|
|
16
|
+
domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
|
|
17
|
+
equipped with procedural knowledge that no model can fully possess.
|
|
18
|
+
|
|
19
|
+
### What Skills Provide
|
|
20
|
+
|
|
21
|
+
1. Specialized workflows - Multi-step procedures for specific domains
|
|
22
|
+
2. Tool integrations - Instructions for working with specific file formats or APIs
|
|
23
|
+
3. Domain expertise - Company-specific knowledge, schemas, business logic
|
|
24
|
+
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
|
|
25
|
+
|
|
26
|
+
### Anatomy of a Skill
|
|
27
|
+
|
|
28
|
+
Every skill consists of a required SKILL.md file and optional bundled resources:
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
skill-name/
|
|
32
|
+
├── SKILL.md (required)
|
|
33
|
+
│ ├── YAML frontmatter metadata (required)
|
|
34
|
+
│ │ ├── name: (required)
|
|
35
|
+
│ │ └── description: (required)
|
|
36
|
+
│ └── Markdown instructions (required)
|
|
37
|
+
└── Bundled Resources (optional)
|
|
38
|
+
├── scripts/ - Executable code (Python/Bash/etc.)
|
|
39
|
+
├── references/ - Documentation intended to be loaded into context as needed
|
|
40
|
+
└── assets/ - Files used in output (templates, icons, fonts, etc.)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### SKILL.md (required)
|
|
44
|
+
|
|
45
|
+
**Metadata Quality:** The `name` and `description` in YAML frontmatter determine when Claude will use the skill. Be specific about what the skill does and when to use it. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
|
|
46
|
+
|
|
47
|
+
#### Bundled Resources (optional)
|
|
48
|
+
|
|
49
|
+
##### Scripts (`scripts/`)
|
|
50
|
+
|
|
51
|
+
Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
|
|
52
|
+
|
|
53
|
+
- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
|
|
54
|
+
- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
|
|
55
|
+
- **Benefits**: Token efficient, deterministic, may be executed without loading into context
|
|
56
|
+
- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
|
|
57
|
+
|
|
58
|
+
##### References (`references/`)
|
|
59
|
+
|
|
60
|
+
Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
|
|
61
|
+
|
|
62
|
+
- **When to include**: For documentation that Claude should reference while working
|
|
63
|
+
- **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
|
|
64
|
+
- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
|
|
65
|
+
- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
|
|
66
|
+
- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
|
|
67
|
+
- **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
|
|
68
|
+
|
|
69
|
+
##### Assets (`assets/`)
|
|
70
|
+
|
|
71
|
+
Files not intended to be loaded into context, but rather used within the output Claude produces.
|
|
72
|
+
|
|
73
|
+
- **When to include**: When the skill needs files that will be used in the final output
|
|
74
|
+
- **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
|
|
75
|
+
- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
|
|
76
|
+
- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
|
|
77
|
+
|
|
78
|
+
### Progressive Disclosure Design Principle
|
|
79
|
+
|
|
80
|
+
Skills use a three-level loading system to manage context efficiently:
|
|
81
|
+
|
|
82
|
+
1. **Metadata (name + description)** - Always in context (~100 words)
|
|
83
|
+
2. **SKILL.md body** - When skill triggers (<5k words)
|
|
84
|
+
3. **Bundled resources** - As needed by Claude (Unlimited*)
|
|
85
|
+
|
|
86
|
+
*Unlimited because scripts can be executed without reading into context window.
|
|
87
|
+
|
|
88
|
+
## Skill Creation Process
|
|
89
|
+
|
|
90
|
+
To create a skill, follow the "Skill Creation Process" in order, skipping steps only if there is a clear reason why they are not applicable.
|
|
91
|
+
|
|
92
|
+
### Step 1: Understanding the Skill with Concrete Examples
|
|
93
|
+
|
|
94
|
+
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
|
|
95
|
+
|
|
96
|
+
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
|
|
97
|
+
|
|
98
|
+
For example, when building an image-editor skill, relevant questions include:
|
|
99
|
+
|
|
100
|
+
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
|
|
101
|
+
- "Can you give some examples of how this skill would be used?"
|
|
102
|
+
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
|
|
103
|
+
- "What would a user say that should trigger this skill?"
|
|
104
|
+
|
|
105
|
+
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
|
|
106
|
+
|
|
107
|
+
Conclude this step when there is a clear sense of the functionality the skill should support.
|
|
108
|
+
|
|
109
|
+
### Step 2: Planning the Reusable Skill Contents
|
|
110
|
+
|
|
111
|
+
To turn concrete examples into an effective skill, analyze each example by:
|
|
112
|
+
|
|
113
|
+
1. Considering how to execute on the example from scratch
|
|
114
|
+
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
|
|
115
|
+
|
|
116
|
+
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
|
|
117
|
+
|
|
118
|
+
1. Rotating a PDF requires re-writing the same code each time
|
|
119
|
+
2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
|
|
120
|
+
|
|
121
|
+
Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
|
|
122
|
+
|
|
123
|
+
1. Writing a frontend webapp requires the same boilerplate HTML/React each time
|
|
124
|
+
2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
|
|
125
|
+
|
|
126
|
+
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
|
|
127
|
+
|
|
128
|
+
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
|
|
129
|
+
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
|
|
130
|
+
|
|
131
|
+
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
|
|
132
|
+
|
|
133
|
+
### Step 3: Initializing the Skill
|
|
134
|
+
|
|
135
|
+
At this point, it is time to actually create the skill.
|
|
136
|
+
|
|
137
|
+
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
|
|
138
|
+
|
|
139
|
+
When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
|
|
140
|
+
|
|
141
|
+
Usage:
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
scripts/init_skill.py <skill-name> --path <output-directory>
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
The script:
|
|
148
|
+
|
|
149
|
+
- Creates the skill directory at the specified path
|
|
150
|
+
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
|
|
151
|
+
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
|
|
152
|
+
- Adds example files in each directory that can be customized or deleted
|
|
153
|
+
|
|
154
|
+
After initialization, customize or remove the generated SKILL.md and example files as needed.
|
|
155
|
+
|
|
156
|
+
### Step 4: Edit the Skill
|
|
157
|
+
|
|
158
|
+
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Focus on including information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
|
|
159
|
+
|
|
160
|
+
#### Start with Reusable Skill Contents
|
|
161
|
+
|
|
162
|
+
To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
|
|
163
|
+
|
|
164
|
+
Also, delete any example files and directories not needed for the skill. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
|
|
165
|
+
|
|
166
|
+
#### Update SKILL.md
|
|
167
|
+
|
|
168
|
+
**Writing Style:** Write the entire skill using **imperative/infinitive form** (verb-first instructions), not second person. Use objective, instructional language (e.g., "To accomplish X, do Y" rather than "You should do X" or "If you need to do X"). This maintains consistency and clarity for AI consumption.
|
|
169
|
+
|
|
170
|
+
To complete SKILL.md, answer the following questions:
|
|
171
|
+
|
|
172
|
+
1. What is the purpose of the skill, in a few sentences?
|
|
173
|
+
2. When should the skill be used?
|
|
174
|
+
3. In practice, how should Claude use the skill? All reusable skill contents developed above should be referenced so that Claude knows how to use them.
|
|
175
|
+
|
|
176
|
+
### Step 5: Packaging a Skill
|
|
177
|
+
|
|
178
|
+
Once the skill is ready, it should be packaged into a distributable zip file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
scripts/package_skill.py <path/to/skill-folder>
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
Optional output directory specification:
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
scripts/package_skill.py <path/to/skill-folder> ./dist
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
The packaging script will:
|
|
191
|
+
|
|
192
|
+
1. **Validate** the skill automatically, checking:
|
|
193
|
+
- YAML frontmatter format and required fields
|
|
194
|
+
- Skill naming conventions and directory structure
|
|
195
|
+
- Description completeness and quality
|
|
196
|
+
- File organization and resource references
|
|
197
|
+
|
|
198
|
+
2. **Package** the skill if validation passes, creating a zip file named after the skill (e.g., `my-skill.zip`) that includes all files and maintains the proper directory structure for distribution.
|
|
199
|
+
|
|
200
|
+
If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
|
|
201
|
+
|
|
202
|
+
### Step 6: Iterate
|
|
203
|
+
|
|
204
|
+
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
|
|
205
|
+
|
|
206
|
+
**Iteration workflow:**
|
|
207
|
+
1. Use the skill on real tasks
|
|
208
|
+
2. Notice struggles or inefficiencies
|
|
209
|
+
3. Identify how SKILL.md or bundled resources should be updated
|
|
210
|
+
4. Implement changes and test again
|