-
Notifications
You must be signed in to change notification settings - Fork 153
Update README with Skills.sh installation guide #14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: trunk
Are you sure you want to change the base?
Changes from all commits
192f792
3d3867b
50719a6
cc621d5
ff837eb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,8 +34,58 @@ Agent Skills solve this by giving AI assistants **expert-level WordPress knowled | |
| | **wp-playground** | WordPress Playground for instant local environments | | ||
| | **wpds** | WordPress Design System | | ||
|
|
||
| ## How It Works | ||
|
|
||
| Each skill is a self-contained folder with instructions, references, and optional scripts: | ||
|
|
||
| ``` | ||
| skills/wp-block-development/ | ||
| ├── SKILL.md # Main instructions (when to use, procedure, verification) | ||
| ├── references/ # Deep-dive docs on specific topics | ||
| │ ├── block-json.md | ||
| │ ├── deprecations.md | ||
| │ └── ... | ||
| └── scripts/ # Deterministic helpers (detection, validation) | ||
| └── list_blocks.mjs | ||
| ``` | ||
|
|
||
| When you ask your AI assistant to work on WordPress code, it reads these skills and follows the documented procedures rather than guessing. | ||
|
|
||
|
|
||
| ## Global vs. Project Scope | ||
|
|
||
| Skills can be installed in two scopes: | ||
|
|
||
| **Global** — installed in your home directory (e.g. `~/.claude/skills/`, `~/.cursor/skills/`). | ||
| - Available across **all** your projects automatically. | ||
| - Best for individual developers who want WordPress knowledge in every repo. | ||
|
|
||
| **Project** — installed inside a repository (e.g. `.claude/skills/`, `.github/skills/`, `.cursor/skills/`). | ||
| - Available only within **that specific project**. | ||
| - Can be committed to version control so the entire team benefits. | ||
|
|
||
| You can use both at the same time. When a skill exists in both scopes, the project-level version is used. | ||
|
|
||
| ## Quick Start | ||
|
|
||
| The fastest way to install skills is with a single command: | ||
|
|
||
| ```bash | ||
| npx skills add WordPress/agent-skills --skill wp-plugin-development | ||
| ``` | ||
|
|
||
| To see all available skills: | ||
|
|
||
| ```bash | ||
| npx skills add WordPress/agent-skills --list | ||
| ``` | ||
|
|
||
| To install multiple skills at once: | ||
|
|
||
| ```bash | ||
| npx skills add WordPress/agent-skills --skill wp-plugin-development wp-abilities-api wp-playground | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @fellyph we are also recommending installation via our own custom I'd personally prefer using a general purpose command for installation that is maintained by the community since it is common logic for those installing skill sets. But either way, it seems like it would be good to pick one. Is there something the custom scripts do that I think the custom script has been there from the beginning when @Jameswlepage hard-reset this repo and contributed a large set of WP agent skills (from under the Automattic GH org).
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we get more people installing via npx skills, a better position on popular skills, and more visibility. |
||
| ``` | ||
|
|
||
| ### Install globally for Claude Code | ||
|
|
||
| ```bash | ||
|
|
@@ -100,23 +150,6 @@ node shared/scripts/skillpack-install.mjs --dest=../my-repo --targets=claude,cur | |
|
|
||
| Copy any skill folder from `skills/` into your project's instructions directory for your AI assistant. | ||
|
|
||
| ## How It Works | ||
|
|
||
| Each skill contains: | ||
|
|
||
| ``` | ||
| skills/wp-block-development/ | ||
| ├── SKILL.md # Main instructions (when to use, procedure, verification) | ||
| ├── references/ # Deep-dive docs on specific topics | ||
| │ ├── block-json.md | ||
| │ ├── deprecations.md | ||
| │ └── ... | ||
| └── scripts/ # Deterministic helpers (detection, validation) | ||
| └── list_blocks.mjs | ||
| ``` | ||
|
|
||
| When you ask your AI assistant to work on WordPress code, it reads these skills and follows the documented procedures rather than guessing. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| - **WordPress 6.9+** (PHP 7.2.24+) | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.