Skip to content

Commit 690445e

Browse files
claveryclavery
committed
plugin readmes
1 parent da63ba7 commit 690445e

3 files changed

Lines changed: 266 additions & 0 deletions

File tree

‎docs/.vitepress/config.mts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ const guideSidebar = [
99
{ text: 'Installation', link: '/guide/installation' },
1010
{ text: 'Authentication Setup', link: '/guide/authentication' },
1111
{ text: 'Configuration', link: '/guide/configuration' },
12+
{ text: 'Agent Skills & Plugins', link: '/guide/claude-code-plugin' },
1213
],
1314
},
1415
{

‎docs/guide/claude-code-plugin.md‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
# Agent Skills & Claude Code Plugin
2+
3+
The B2C CLI provides agent skills that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects.
4+
5+
These skills follow the [Agent Skills](https://agentskills.io/home) standard and can be used with multiple agentic IDEs including [Claude Code](https://claude.ai/code), Cursor, GitHub Copilot, and OpenAI Codex.
6+
7+
## Overview
8+
9+
When installed, the skills teach AI assistants about B2C Commerce CLI commands and best practices, enabling them to help you with:
10+
11+
- Deploying cartridges and managing code versions
12+
- Running jobs and importing/exporting site archives
13+
- Managing On-Demand Sandboxes and Managed Runtime environments
14+
- WebDAV file operations
15+
- SLAS client configuration
16+
17+
## Installation
18+
19+
### Prerequisites
20+
21+
- [Claude Code](https://claude.ai/code) installed and configured
22+
23+
### Add the Marketplace
24+
25+
First, add the B2C Developer Tooling marketplace:
26+
27+
```bash
28+
claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
29+
```
30+
31+
### Install the Plugin
32+
33+
Install the `b2c-cli` plugin at your preferred scope:
34+
35+
::: code-group
36+
37+
```bash [Project Scope]
38+
# Available only in the current project
39+
claude plugin install b2c-cli --scope project
40+
```
41+
42+
```bash [User Scope]
43+
# Available in all your projects
44+
claude plugin install b2c-cli --scope user
45+
```
46+
47+
:::
48+
49+
### Verify Installation
50+
51+
```bash
52+
claude plugin list
53+
```
54+
55+
You should see `b2c-cli@b2c-developer-tooling` in the list.
56+
57+
## Available Skills
58+
59+
The plugin includes skills for each major CLI topic:
60+
61+
| Skill | Description |
62+
|-------|-------------|
63+
| `b2c-code` | Code version deployment and management |
64+
| `b2c-job` | Job execution and site archive import/export (IMPEX) |
65+
| `b2c-sites` | Storefront sites listing and inspection |
66+
| `b2c-webdav` | WebDAV file operations (ls, get, put, rm, zip, unzip) |
67+
| `b2c-ods` | On-Demand Sandbox management |
68+
| `b2c-mrt` | Managed Runtime project and deployment management |
69+
| `b2c-slas` | SLAS client management |
70+
71+
## Usage Examples
72+
73+
Once installed, you can ask Claude to help with B2C Commerce tasks:
74+
75+
**Deploy code:**
76+
> "Deploy the cartridges in ./cartridges to my sandbox"
77+
78+
**Check code versions:**
79+
> "List all code versions on my instance and show which one is active"
80+
81+
**Run a job:**
82+
> "Run the reindex job on my sandbox"
83+
84+
**Manage files:**
85+
> "Download the latest log files from my instance"
86+
87+
**Create a sandbox:**
88+
> "Create a new On-Demand Sandbox with TTL of 48 hours"
89+
90+
Claude will use the appropriate `b2c` CLI commands based on your request and the skills it has learned.
91+
92+
## Updating the Plugin
93+
94+
To get the latest plugin updates:
95+
96+
```bash
97+
claude plugin marketplace update
98+
claude plugin update b2c-cli@b2c-developer-tooling
99+
```
100+
101+
## Uninstalling
102+
103+
To remove the plugin:
104+
105+
```bash
106+
claude plugin uninstall b2c-cli@b2c-developer-tooling
107+
```
108+
109+
To remove the marketplace:
110+
111+
```bash
112+
claude plugin marketplace remove b2c-developer-tooling
113+
```
114+
115+
## Using Skills with Other IDEs
116+
117+
The B2C CLI skills follow the [Agent Skills](https://agentskills.io/home) standard and can be used with other AI-powered development tools.
118+
119+
### CLI Setup Command
120+
121+
::: warning Coming Soon
122+
The `b2c setup skills` command is not yet available. Use the manual method below for now.
123+
:::
124+
125+
```bash
126+
# Configure skills for your IDE (coming soon)
127+
b2c setup skills --ide cursor
128+
b2c setup skills --ide copilot
129+
```
130+
131+
### Manual Setup
132+
133+
You can manually copy skill files from the [plugins/b2c-cli/skills/](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c-cli/skills) directory to your IDE's configuration:
134+
135+
#### Cursor
136+
137+
Copy the skill SKILL.md files to `.cursor/rules/` in your project or configure globally in Cursor settings.
138+
139+
#### GitHub Copilot
140+
141+
Append the skill content to `.github/copilot-instructions.md` in your repository.
142+
143+
#### OpenAI Codex
144+
145+
Configure per the OpenAI Codex documentation for custom instructions.
146+
147+
### Skill Files
148+
149+
Each skill is a Markdown file containing instructions and examples:
150+
151+
| Skill | File |
152+
|-------|------|
153+
| Code Deployment | `b2c-code/SKILL.md` |
154+
| Job Execution | `b2c-job/SKILL.md` |
155+
| Site Management | `b2c-sites/SKILL.md` |
156+
| WebDAV Operations | `b2c-webdav/SKILL.md` |
157+
| Sandbox Management | `b2c-ods/SKILL.md` |
158+
| MRT Management | `b2c-mrt/SKILL.md` |
159+
| SLAS Configuration | `b2c-slas/SKILL.md` |

‎plugins/README.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# B2C CLI Agent Skills & Claude Code Plugins
2+
3+
This directory contains agent skills and [Claude Code](https://claude.ai/code) plugins that enhance the AI-assisted development experience when working with Salesforce B2C Commerce projects.
4+
5+
These skills follow the [Agent Skills](https://agentskills.io/home) format and can be used with multiple agentic IDEs including Claude Code, Cursor, GitHub Copilot, and OpenAI Codex.
6+
7+
## Available Plugins
8+
9+
| Plugin | Description |
10+
|--------|-------------|
11+
| `b2c-cli` | Skills for Salesforce Commerce Cloud B2C CLI operations |
12+
13+
## Installation
14+
15+
### 1. Add the Marketplace
16+
17+
First, add the B2C Developer Tooling marketplace to Claude Code:
18+
19+
```bash
20+
claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
21+
```
22+
23+
### 2. Install the Plugin
24+
25+
Install the b2c-cli plugin at your preferred scope:
26+
27+
```bash
28+
# Install for the current project only
29+
claude plugin install b2c-cli --scope project
30+
31+
# Install for the current user (available in all projects)
32+
claude plugin install b2c-cli --scope user
33+
34+
# Install locally (development/testing)
35+
claude plugin install b2c-cli --scope local
36+
```
37+
38+
### 3. Verify Installation
39+
40+
```bash
41+
claude plugin list
42+
```
43+
44+
## Plugin: b2c-cli
45+
46+
The `b2c-cli` plugin provides skills that teach Claude about B2C Commerce CLI commands and best practices. When installed, Claude can help you with:
47+
48+
- **Code Deployment** (`b2c-code`) - Deploy cartridges and manage code versions
49+
- **Job Execution** (`b2c-job`) - Run jobs and import/export site archives
50+
- **Site Management** (`b2c-sites`) - List and inspect storefront sites
51+
- **WebDAV Operations** (`b2c-webdav`) - File operations on instances
52+
- **Sandbox Management** (`b2c-ods`) - Manage On-Demand Sandboxes
53+
- **MRT Management** (`b2c-mrt`) - Manage Managed Runtime projects and deployments
54+
- **SLAS Configuration** (`b2c-slas`) - Manage SLAS API clients and credentials
55+
56+
### Skills
57+
58+
Each skill is defined in the `b2c-cli/skills/` directory:
59+
60+
```
61+
plugins/b2c-cli/skills/
62+
├── b2c-code/SKILL.md # Code deployment commands
63+
├── b2c-job/SKILL.md # Job execution commands
64+
├── b2c-mrt/SKILL.md # Managed Runtime commands
65+
├── b2c-ods/SKILL.md # On-Demand Sandbox commands
66+
├── b2c-sites/SKILL.md # Sites commands
67+
├── b2c-slas/SKILL.md # SLAS commands
68+
└── b2c-webdav/SKILL.md # WebDAV commands
69+
```
70+
71+
## For Contributors
72+
73+
When modifying CLI commands, update the corresponding skill in `plugins/b2c-cli/skills/b2c-<topic>/SKILL.md` to keep documentation in sync.
74+
75+
## Using Skills with Other Agentic IDEs
76+
77+
The skills in this plugin follow the [Agent Skills](https://agentskills.io/home) standard and can be used with other AI-powered development tools like Cursor, GitHub Copilot, and OpenAI Codex.
78+
79+
### Option 1: CLI Setup Command
80+
81+
::: warning Coming Soon
82+
The `b2c setup skills` command is not yet available. Use the manual method below for now.
83+
:::
84+
85+
```bash
86+
# Configure skills for your IDE (coming soon)
87+
b2c setup skills --ide cursor
88+
b2c setup skills --ide copilot
89+
```
90+
91+
### Option 2: Manual Setup
92+
93+
Copy the skill files from [`plugins/b2c-cli/skills/`](./b2c-cli/skills/) to your IDE's rules or instructions directory:
94+
95+
- **Cursor**: Copy to `.cursor/rules/` or configure in Cursor settings
96+
- **GitHub Copilot**: Add to `.github/copilot-instructions.md`
97+
- **Codex**: Configure per OpenAI Codex documentation
98+
99+
Each skill is a Markdown file (`SKILL.md`) containing instructions and examples that teach the AI about B2C Commerce CLI commands.
100+
101+
## Learn More
102+
103+
- [Agent Skills Standard](https://agentskills.io/home)
104+
- [Claude Code Plugin Documentation](https://code.claude.com/docs/en/plugins)
105+
- [Plugin Marketplaces](https://code.claude.com/docs/en/plugin-marketplaces)
106+
- [B2C CLI Documentation](https://salesforcecommercecloud.github.io/b2c-developer-tooling/)

0 commit comments

Comments
 (0)