Skip to content

Commit 47dca20

Browse files
authored
Add Claude/Copilot plugin marketplace support (#22)
* Add Claude plugin marketplace support Expose commerce-apps skills as a `cap-dev` plugin via `.claude-plugin/marketplace.json` so users can install from the Claude/Copilot plugin marketplace. Adds Agent Skills section to README with installation instructions and manual IDE paths. * Update marketplace owner to Salesforce * Add per-IDE installation sections to Agent Skills * Keep manual installation table for non-marketplace IDEs
1 parent d494798 commit 47dca20

3 files changed

Lines changed: 111 additions & 51 deletions

File tree

.claude-plugin/marketplace.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "commerce-apps",
3+
"description": "Commerce Apps development skills for building, validating, and submitting Salesforce Commerce Cloud app packages.",
4+
"version": "0.0.1",
5+
"owner": {
6+
"name": "Salesforce"
7+
},
8+
"plugins": [
9+
{
10+
"name": "cap-dev",
11+
"description": "Skills for scaffolding, packaging, validating, and submitting Commerce App Packages (CAPs) for Salesforce Commerce Cloud.",
12+
"author": {
13+
"name": "Salesforce"
14+
},
15+
"license": "Apache-2.0",
16+
"source": "./.claude",
17+
"category": "productivity",
18+
"strict": false
19+
}
20+
]
21+
}

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,11 @@ $RECYCLE.BIN/
6161
# Keep the .gitignore file itself!
6262
!.gitignore
6363

64-
# Keep Claude Code and Cursor directories
64+
# Keep Claude Code, Cursor, and plugin marketplace directories
6565
!.claude/
6666
!.claude/**
67+
!.claude-plugin/
68+
!.claude-plugin/**
6769
!.cursor/
6870
!.cursor/**
6971

README.md

Lines changed: 87 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -30,35 +30,9 @@ Merchants install Commerce Apps through Business Manager with a click-to-install
3030

3131
## Quick Start
3232

33-
### Using Claude Code Skills
33+
### Using Agent Skills
3434

35-
If you're using Claude Code, we provide comprehensive skills to streamline development:
36-
37-
**Start a new app:**
38-
```
39-
/scaffold-app
40-
```
41-
42-
**Generate impex files:**
43-
```
44-
/generate-service-impex
45-
/generate-site-preferences-impex
46-
/generate-custom-object-impex
47-
```
48-
49-
**Package and validate:**
50-
```
51-
/package-app
52-
/validate-app
53-
/validate-impex
54-
```
55-
56-
**Submit to registry:**
57-
```
58-
/submit-app
59-
```
60-
61-
See [CONTRIBUTING.md](CONTRIBUTING.md) for complete skill documentation.
35+
If you're using Claude Code, Cursor, Copilot, or another IDE with plugin support, install the `cap-dev` plugin for skills that streamline the full development workflow — see [Agent Skills](#agent-skills) below.
6236

6337
### Manual Development
6438

@@ -198,13 +172,96 @@ Commerce App frontend extensions target the Storefront Next stack:
198172

199173
Backend adapters use the Commerce Cloud Script API (CommonJS, `require('dw/...')` modules).
200174

175+
## Agent Skills
176+
177+
Turn your coding agent into a Commerce Apps specialist. Skills give Claude Code, Cursor, GitHub Copilot, and Codex deep expertise in scaffolding, packaging, validating, and submitting Commerce App Packages.
178+
179+
Skills follow the open [Agent Skills](https://agentskills.io/home) standard and work with [Claude Code](https://claude.ai/code), Cursor, GitHub Copilot, VS Code, Codex, and others.
180+
181+
### Quick Start
182+
183+
Install via your IDE's plugin marketplace or manually copy skills into your IDE's skills directory.
184+
185+
#### Claude Code
186+
187+
```bash
188+
claude plugin marketplace add SalesforceCommerceCloud/commerce-apps
189+
claude plugin install cap-dev --scope project
190+
```
191+
192+
Use `--scope user` instead to install globally across all projects.
193+
194+
#### GitHub Copilot (VS Code)
195+
196+
In VS Code, open the Command Palette (`Cmd/Ctrl+Shift+P`) and run:
197+
198+
```
199+
Chat: Install Plugin from Source
200+
```
201+
202+
Then enter: `SalesforceCommerceCloud/commerce-apps`
203+
204+
#### GitHub Copilot CLI
205+
206+
```bash
207+
copilot plugin marketplace add SalesforceCommerceCloud/commerce-apps
208+
copilot plugin install cap-dev@commerce-apps
209+
```
210+
211+
#### Manual Installation
212+
213+
For IDEs without marketplace support, copy the skills directory:
214+
215+
| IDE | Project Path | User Path |
216+
|-----|--------------|-----------|
217+
| Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
218+
| Windsurf | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
219+
| Codex | `.codex/skills/` | `~/.config/codex/skills/` |
220+
| OpenCode | `.opencode/skills/` | `~/.config/opencode/skills/` |
221+
222+
Copy the skills from this repository's `.claude/skills/` directory into the appropriate path for your IDE.
223+
224+
### Available Skills
225+
226+
| Skill | Description |
227+
|-------|-------------|
228+
| `scaffold-app` | Generate complete app structure (UI-only, Backend-only, or Fullstack) |
229+
| `package-app` | Package app into registry-ready ZIP (handles new apps and version bumps) |
230+
| `generate-service-impex` | Generate service credentials, profiles, and definitions |
231+
| `generate-site-preferences-impex` | Generate custom site preference configurations |
232+
| `generate-custom-object-impex` | Generate custom object type definitions |
233+
| `validate-impex` | Validate impex XML syntax, structure, and common errors |
234+
| `validate-app` | Comprehensive pre-submission validation (structure, manifest, SHA256, impex) |
235+
| `submit-app` | Guided PR submission with automated GitHub CLI integration |
236+
237+
### Usage
238+
239+
Once installed, skills are available as slash commands in your IDE:
240+
241+
```
242+
/scaffold-app → Start a new Commerce App
243+
/package-app → Package for submission
244+
/validate-app → Run full validation suite
245+
/submit-app → Submit PR to registry
246+
```
247+
248+
Or ask your agent naturally:
249+
250+
```
251+
"Create a new tax app called my-tax"
252+
"Package the my-tax app for submission"
253+
"Validate my app before I submit"
254+
"Generate service impex for a REST API integration"
255+
```
256+
257+
201258
## Contributing
202259

203-
See [CONTRIBUTING.md](CONTRIBUTING.md) for complete submission requirements and Claude Code skills documentation.
260+
See [CONTRIBUTING.md](CONTRIBUTING.md) for complete submission requirements.
204261

205262
### Publishing Workflow
206263

207-
**Using Claude Code (Recommended):**
264+
**Using Agent Skills (Recommended):**
208265

209266
1. **Scaffold new app:** `/scaffold-app`
210267
2. **Build your app code** (cartridges, extensions, etc.)
@@ -251,26 +308,6 @@ Only commit these files to the repository:
251308

252309
The repository `.gitignore` is configured to exclude extracted directories and system files.
253310

254-
### Claude Code Skills
255-
256-
This repository includes comprehensive skills for Commerce App development:
257-
258-
**App Development:**
259-
- `/scaffold-app` - Generate complete app structure (UI-only, Backend-only, or Fullstack)
260-
- `/package-app` - Package app into registry-ready ZIP (handles both new apps and version bumps)
261-
262-
**Impex Generation:**
263-
- `/generate-service-impex` - Service credentials, profiles, definitions
264-
- `/generate-site-preferences-impex` - Custom site preferences
265-
- `/generate-custom-object-impex` - Custom object types
266-
- `/validate-impex` - Validate all impex files
267-
268-
**Validation:**
269-
- `/validate-app` - Comprehensive architecture-aware validation (structure, manifest, impex, icons, translations)
270-
271-
**Submission:**
272-
- `/submit-app` - Guide through PR submission process with automated GitHub CLI integration
273-
274311
### External Contributors
275312

276313
All external contributors must sign the Contributor License Agreement (CLA). A prompt to sign the agreement appears when a pull request is submitted.

0 commit comments

Comments
 (0)