Skip to content

Commit f79c31a

Browse files
authored
Documentation: Add docs for new third-party plugins (#276)
Added three plugins to the documentation page.
1 parent e4b5094 commit f79c31a

1 file changed

Lines changed: 102 additions & 1 deletion

File tree

docs/guide/third-party-plugins.md

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Community plugins for the B2C CLI including IntelliJ SFCC config integration and macOS Keychain credential storage.
2+
description: Community plugins for the B2C CLI including IntelliJ SFCC config integration, credential storage, docs search, catalog reduction, and pipeline visualization.
33
---
44

55
# 3rd Party Plugins
@@ -185,6 +185,107 @@ b2c code deploy
185185
b2c code deploy
186186
```
187187

188+
### Docs Viewer Plugin
189+
190+
**Repository:** [taurgis/b2c-plugin-docs-viewer](https://github.com/taurgis/b2c-plugin-docs-viewer)
191+
192+
Searches Salesforce Help and fetches Help or Developer docs content directly from the CLI. This is useful when you want to look up platform documentation without leaving your terminal.
193+
194+
#### Installation
195+
196+
```bash
197+
b2c plugins install b2c-plugin-help-docs-viewer
198+
```
199+
200+
If Playwright Chromium is not installed yet:
201+
202+
```bash
203+
npx playwright install chromium
204+
```
205+
206+
#### Features
207+
208+
- Searches Salesforce Help with boxed, column-aligned results
209+
- Fetches Help or Developer docs pages by URL or by ID from the latest search
210+
- Fetches search results and article content in one command
211+
- Reuses cached results for up to 5 days, with `--no-cache` to bypass caching
212+
- Supports JSON output and optional raw extracted HTML
213+
214+
#### Usage
215+
216+
```bash
217+
# Search Salesforce Help
218+
b2c docs search-help-site "b2c commerce roles" --limit 5
219+
220+
# Fetch an article by URL or by search result ID
221+
b2c docs help-site-article "https://help.salesforce.com/s/articleView?id=cc.b2c_roles_and_permissions.htm&type=5"
222+
b2c docs help-site-article 2
223+
224+
# Search and fetch details in one step
225+
b2c docs fetch-results-help-site "pipelines" --limit 3
226+
```
227+
228+
### Catalog Reducer Plugin
229+
230+
**Repository:** [taurgis/b2c-plugin-catalog-reducer](https://github.com/taurgis/b2c-plugin-catalog-reducer)
231+
232+
Generates smaller, representative Salesforce B2C Commerce catalog datasets from large source XML files. This is useful for creating fixtures, benchmarks, and reduced datasets for local development.
233+
234+
#### Installation
235+
236+
```bash
237+
b2c plugins install b2c-plugin-catalog-reducer
238+
```
239+
240+
#### Features
241+
242+
- Reduces large catalog XML files into smaller fixture datasets
243+
- Supports preferred product IDs, master-product targets, attribute-driven selection, and filler products
244+
- Writes catalog, inventory, and pricebook outputs in one run
245+
- Supports source-derived storefront catalogs and generated or source-derived pricebooks
246+
- Validates generated XML against bundled catalog, inventory, and pricebook schemas
247+
248+
#### Usage
249+
250+
```bash
251+
# Reduce a catalog using a custom config file
252+
b2c catalog reduce -i ./catalog.xml -o ./catalog-reduced.xml -c ./catalog-reducer.json
253+
```
254+
255+
The reducer writes the reduced catalog plus derived inventory and pricebook XML outputs. Relative paths in `pricebookSourceFiles` and `storefrontSourceFiles` are resolved from the config file location.
256+
257+
### Pipeline Visualizer Plugin
258+
259+
**Repository:** [taurgis/b2c-plugin-pipeline-visualizer](https://github.com/taurgis/b2c-plugin-pipeline-visualizer)
260+
261+
Generates ASCII and SVG previews of SFCC pipeline XML files. This is useful for inspecting pipeline structure, branch flow, and layout without opening Business Manager.
262+
263+
#### Installation
264+
265+
```bash
266+
b2c plugins install b2c-plugin-pipeline-visualizer
267+
```
268+
269+
#### Features
270+
271+
- Exports ASCII previews from pipeline XML files
272+
- Generates SVG image output for rendered pipeline layouts
273+
- Supports branch filtering for focused views
274+
- Can include grids, node lists, edge lists, and bendpoint details
275+
- Uses the same layout and edge routing logic across ASCII and SVG output
276+
277+
#### Usage
278+
279+
```bash
280+
# Export an ASCII view
281+
b2c pipeline ascii path/to/pipeline.xml --out debug/layouts/pipeline.txt
282+
283+
# Export an SVG image
284+
b2c pipeline image path/to/pipeline.xml --out debug/layouts/pipeline.svg
285+
```
286+
287+
Output is written to the file specified by `--out`.
288+
188289
## Creating Your Own Plugin
189290

190291
Want to create a plugin? See the [Extending the CLI](./extending) guide for documentation on:

0 commit comments

Comments
 (0)