Skip to content

Commit 64574ee

Browse files
claveryclavery
committed
documentation
1 parent f2338a7 commit 64574ee

3 files changed

Lines changed: 280 additions & 5 deletions

File tree

‎docs/.vitepress/config.mts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ const guideSidebar = [
3838
{ text: 'SLAS Commands', link: '/cli/slas' },
3939
{ text: 'Custom APIs', link: '/cli/custom-apis' },
4040
{ text: 'SCAPI Schemas', link: '/cli/scapi-schemas' },
41+
{ text: 'Setup Commands', link: '/cli/setup' },
4142
{ text: 'Auth Commands', link: '/cli/auth' },
4243
{ text: 'Logging', link: '/cli/logging' },
4344
],

‎docs/cli/setup.md‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
---
2+
description: Commands for installing AI agent skills for Claude Code, Cursor, Windsurf, and other agentic IDEs.
3+
---
4+
5+
# Setup Commands
6+
7+
Commands for setting up the development environment with AI agent skills.
8+
9+
## b2c setup skills
10+
11+
Install agent skills from the B2C Developer Tooling project to AI-powered IDEs.
12+
13+
This command downloads skills from GitHub releases and installs them to the configuration directories of supported IDEs. Skills teach AI assistants about B2C Commerce development, CLI commands, and best practices.
14+
15+
### Usage
16+
17+
```bash
18+
b2c setup skills [SKILLSET]
19+
```
20+
21+
### Arguments
22+
23+
| Argument | Description | Default |
24+
|----------|-------------|---------|
25+
| `SKILLSET` | Skill set to install: `b2c`, `b2c-cli`, or `all` | `all` |
26+
27+
### Flags
28+
29+
| Flag | Description | Default |
30+
|------|-------------|---------|
31+
| `--list`, `-l` | List available skills without installing | `false` |
32+
| `--skill` | Install specific skill(s) (can be repeated) | |
33+
| `--ide` | Target IDE(s) (can be repeated) | Auto-detect |
34+
| `--global`, `-g` | Install to user home directory (global scope) | `false` |
35+
| `--update`, `-u` | Update existing skills (overwrite) | `false` |
36+
| `--version` | Specific release version | `latest` |
37+
| `--force` | Skip confirmation prompts (non-interactive) | `false` |
38+
| `--json` | Output results as JSON | `false` |
39+
40+
### Supported IDEs
41+
42+
| IDE Value | IDE Name | Project Path | Global Path |
43+
|-----------|----------|--------------|-------------|
44+
| `claude-code` | Claude Code | `.claude/skills/` | `~/.claude/skills/` |
45+
| `cursor` | Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
46+
| `windsurf` | Windsurf | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
47+
| `github-copilot` | GitHub Copilot | `.github/skills/` | `~/.copilot/skills/` |
48+
| `codex` | Codex CLI | `.codex/skills/` | `~/.codex/skills/` |
49+
| `opencode` | OpenCode | `.opencode/skills/` | `~/.config/opencode/skills/` |
50+
| `manual` | Manual | `.claude/skills/` | `~/.claude/skills/` |
51+
52+
Use `manual` when you want to install to the Claude Code paths without marketplace recommendations.
53+
54+
### Examples
55+
56+
```bash
57+
# List all available skills
58+
b2c setup skills --list
59+
60+
# Interactive installation (auto-detects IDEs)
61+
b2c setup skills
62+
63+
# Install to Cursor (project scope)
64+
b2c setup skills --ide cursor
65+
66+
# Install to Cursor (global/user scope)
67+
b2c setup skills --ide cursor --global
68+
69+
# Install to multiple IDEs
70+
b2c setup skills --ide cursor --ide windsurf
71+
72+
# Install only b2c-cli skills
73+
b2c setup skills b2c-cli --ide cursor
74+
75+
# Install specific skills only
76+
b2c setup skills --skill b2c-code --skill b2c-webdav --ide cursor
77+
78+
# Update existing skills
79+
b2c setup skills --ide cursor --update
80+
81+
# Non-interactive mode (for CI/CD)
82+
b2c setup skills --ide cursor --global --force
83+
84+
# Install a specific version
85+
b2c setup skills --version v0.1.0 --ide cursor
86+
87+
# Output as JSON
88+
b2c setup skills --list --json
89+
```
90+
91+
### Interactive Mode
92+
93+
When run without `--force`, the command provides an interactive experience:
94+
95+
1. Downloads skills from the latest release (or specified version)
96+
2. Auto-detects installed IDEs
97+
3. Prompts you to select target IDEs
98+
4. Shows installation preview
99+
5. Confirms before installing
100+
6. Reports results
101+
102+
### Claude Code Recommendation
103+
104+
For Claude Code users, we recommend using the plugin marketplace for automatic updates:
105+
106+
```bash
107+
claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
108+
claude plugin install b2c-cli
109+
claude plugin install b2c
110+
```
111+
112+
The marketplace provides:
113+
- Automatic updates when new versions are released
114+
- Centralized plugin management
115+
- Version tracking
116+
117+
Use `--ide manual` if you prefer manual installation to the same paths.
118+
119+
### Skill Sets
120+
121+
| Skill Set | Description |
122+
|-----------|-------------|
123+
| `b2c` | B2C Commerce development patterns and practices |
124+
| `b2c-cli` | B2C CLI commands and operations |
125+
| `all` | Both skill sets (default) |
126+
127+
### Output
128+
129+
When installing, the command reports:
130+
- Successfully installed skills with paths
131+
- Skipped skills (already exist, use `--update` to overwrite)
132+
- Errors encountered during installation
133+
134+
Example output:
135+
136+
```
137+
Downloading skills from release latest...
138+
Detecting installed IDEs...
139+
Installing 24 skills to Cursor (project)
140+
141+
Successfully installed 24 skill(s):
142+
- b2c-code → .cursor/skills/b2c-code/
143+
- b2c-webdav → .cursor/skills/b2c-webdav/
144+
...
145+
```
146+
147+
### Environment
148+
149+
Skills are downloaded from the GitHub releases of the [b2c-developer-tooling](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling) repository:
150+
151+
| Artifact | Contents |
152+
|----------|----------|
153+
| `b2c-cli-skills.zip` | Skills for B2C CLI commands and operations |
154+
| `b2c-skills.zip` | Skills for B2C Commerce development patterns |
155+
156+
Downloaded artifacts are cached locally at: `~/.cache/b2c-cli/skills/{version}/{skillset}/`
157+
158+
### See Also
159+
160+
- [Agent Skills & Plugins Guide](/guide/agent-skills) - Overview of available skills
161+
- [Claude Code Skills Documentation](https://claude.ai/code) - Claude Code skill format
162+
- [Cursor Skills Documentation](https://cursor.com/docs/context/skills) - Cursor skill format

‎docs/guide/agent-skills.md‎

Lines changed: 117 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,28 +103,140 @@ To remove the marketplace:
103103
claude plugin marketplace remove b2c-developer-tooling
104104
```
105105

106+
## Installation with B2C CLI
107+
108+
The B2C CLI provides a `setup skills` command that downloads and installs agent skills to any supported IDE.
109+
110+
### List Available Skills
111+
112+
```bash
113+
b2c setup skills --list
114+
```
115+
116+
### Install to Specific IDEs
117+
118+
::: code-group
119+
120+
```bash [Project Scope]
121+
# Install to Cursor (current project only)
122+
b2c setup skills --ide cursor
123+
124+
# Install to Windsurf
125+
b2c setup skills --ide windsurf
126+
127+
# Install to multiple IDEs
128+
b2c setup skills --ide cursor --ide windsurf
129+
```
130+
131+
```bash [User Scope]
132+
# Install globally (available in all projects)
133+
b2c setup skills --ide cursor --global
134+
135+
# Install to GitHub Copilot globally
136+
b2c setup skills --ide github-copilot --global
137+
```
138+
139+
:::
140+
141+
### Install Specific Skills
142+
143+
```bash
144+
# Install only certain skills
145+
b2c setup skills --skill b2c-code --skill b2c-webdav --ide cursor
146+
147+
# Install only b2c-cli skills (not b2c development skills)
148+
b2c setup skills b2c-cli --ide cursor
149+
```
150+
151+
### Update Existing Skills
152+
153+
```bash
154+
# Overwrite existing skills with latest versions
155+
b2c setup skills --ide cursor --update
156+
```
157+
158+
### Non-Interactive Mode
159+
160+
For CI/CD pipelines or scripted installations:
161+
162+
```bash
163+
b2c setup skills --ide cursor --global --force
164+
```
165+
166+
See [Setup Commands](/cli/setup) for full CLI documentation.
167+
106168
## Installation with Other IDEs
107169

108170
The B2C skills follow the [Agent Skills](https://agentskills.io/home) standard and can be used with other AI-powered development tools.
109171

172+
::: tip Recommended
173+
Use the [`b2c setup skills`](/cli/setup) command for easier installation to any supported IDE.
174+
:::
175+
110176
### Cursor
111177

112178
See the [Cursor Skills documentation](https://cursor.com/docs/context/skills) for configuration instructions.
113179

114-
Copy skill files from the plugin directories to your Cursor skills location:
180+
Skills are installed to:
181+
- **Project scope**: `.cursor/skills/` in your project
182+
- **User scope**: `~/.cursor/skills/`
115183

116-
- [b2c-cli skills](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c-cli/skills)
117-
- [b2c skills](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/tree/main/plugins/b2c/skills)
184+
### Windsurf
185+
186+
See the [Windsurf documentation](https://docs.windsurf.com/) for configuration instructions.
187+
188+
Skills are installed to:
189+
- **Project scope**: `.windsurf/skills/` in your project
190+
- **User scope**: `~/.codeium/windsurf/skills/`
118191

119192
### VS Code with GitHub Copilot
120193

121194
See the [VS Code Agent Skills documentation](https://code.visualstudio.com/docs/copilot/customization/agent-skills) for configuration instructions.
122195

196+
Skills are installed to:
197+
- **Project scope**: `.github/skills/` in your project
198+
- **User scope**: `~/.copilot/skills/`
199+
123200
You can also append skill content to `.github/copilot-instructions.md` in your repository.
124201

125-
### Other IDEs
202+
### Codex CLI
203+
204+
See the [Codex documentation](https://github.com/openai/codex) for configuration instructions.
205+
206+
Skills are installed to:
207+
- **Project scope**: `.codex/skills/` in your project
208+
- **User scope**: `~/.codex/skills/`
209+
210+
### OpenCode
211+
212+
See the [OpenCode documentation](https://opencode.ai/) for configuration instructions.
213+
214+
Skills are installed to:
215+
- **Project scope**: `.opencode/skills/` in your project
216+
- **User scope**: `~/.config/opencode/skills/`
217+
218+
### Manual Installation
219+
220+
For other AI-powered IDEs, download the skills zip files from the [latest GitHub release](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/releases/latest):
221+
222+
| Artifact | Contents |
223+
|----------|----------|
224+
| `b2c-cli-skills.zip` | Skills for B2C CLI commands and operations |
225+
| `b2c-skills.zip` | Skills for B2C Commerce development patterns |
226+
227+
Each zip contains a `skills/` folder with individual skill directories. Extract and copy to your IDE's custom instructions location:
228+
229+
```bash
230+
# Download from latest release
231+
curl -LO https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/releases/latest/download/b2c-cli-skills.zip
232+
curl -LO https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/releases/latest/download/b2c-skills.zip
233+
234+
# Extract and copy to your IDE's skills directory
235+
unzip b2c-cli-skills.zip -d /path/to/your/ide/skills/
236+
unzip b2c-skills.zip -d /path/to/your/ide/skills/
237+
```
126238

127-
For other AI-powered IDEs, copy the `SKILL.md` files and any `references/` directories to your IDE's custom instructions location.
239+
Each skill is a directory containing a `SKILL.md` file and optionally a `references/` folder with additional documentation.
128240

129241
## Usage Examples
130242

0 commit comments

Comments
 (0)