b2c-docs

B2C Docs Skill

読み込み済みのスキルや現在のプロジェクトコンテキストで回答できない、B2C Commerce の開発者または管理者からのあらゆる質問には、このスキルを使用してください。 ドキュメントコーパスには、Script API リファレンス、Commerce API（SCAPI／OCAPI）の統合パターン、ストアフロントフレームワークのガイド（SFRA、PWA Kit、Storefront Next）、Business Manager の管理およびマーチャンダイジング（Salesforce Help）、ジョブステップのパラメーター、認証フロー、ツールの設定が含まれています。

b2c CLI を使用して、複数のコーパスにまたがる B2C Commerce のドキュメントを検索・閲覧できます。対象は、Script API リファレンス（dw.* クラス／モジュール）、Developer Center ガイド（Commerce API、PWA Kit、SFRA などに関する概念解説や手順）、Salesforce Help（help.salesforce.com の Business Manager 管理およびマーチャンダイジング関連コンテンツ）、ツールのドキュメント（このプロジェクト独自のガイド）、標準（システム）ジョブステップカタログ、および XSD スキーマです。

ヒント： b2c がグローバルにインストールされていない場合は、代わりに npx @salesforce/b2c-cli を使用してください（例：npx @salesforce/b2c-cli docs search ProductMgr）。

MCP との同等性： b2c-dx-mcp サーバーが接続されている場合、そのドキュメントツール（docs_search、docs_read、docs_list、docs_schema_search、docs_schema_read、docs_schema_list）では、ここで説明するものと同じコーパスを検索でき、同じ検索、ワークスペース認識、トピックのスコープ設定の動作が適用されます。

主な機能

• 複数コーパスの検索 — Script API、Developer Center ガイド、OCAPI リファレンス、Salesforce Help（管理者向け＋マーチャンダイジング）、内部ツールのドキュメント（ガイド、CLI リファレンス、MCP、VS Code 拡張機能）、ジョブステップ、スキーマを統合インデックスで検索します
• ワークスペースを認識した検索 — プロジェクトの種類（カートリッジ、SFRA、PWA Kit、Storefront Next）を自動検出し、関連ドキュメントの優先度を上げるとともに、競合するストアフロントフレームワークの優先度を下げます
• カテゴリによる絞り込み — --category を使用して、検索対象を特定のコーパスに絞り込みます（例：commerce-api、pwa-kit-managed-runtime、sfra、script-api、help-admin、help-merchant、help-kb）
• トリアージ用メタデータ — 検索結果には category、summary、keywords、url が含まれており、全文を読まずに適切な結果を特定できます
• ローカルキャッシュを備えたオンラインコンテンツ — Script API、Developer Center ガイド、Salesforce Help は閲覧時にオンラインで取得され、ローカル（メモリ＋ディスク、TTL は 7 日間）にキャッシュされるため、再度閲覧する際にはネットワークアクセスが不要です。オフライン時は、概要、見出し、両方の URL を表示するフォールバックが適用されます
• コンテンツを考慮したランキング — BM25 方式の検索インデックスでタイトル、セクション見出し、概要、キーワードを索引化し、概念的な質問に対する検索精度を高めます
• 2 種類の URL — 公開されている各ドキュメント項目には、ユーザー向けの .html ページを指す url と、未加工の .md ソースを指す sourceUrl の両方が含まれています。Script API の項目は developer.salesforce.com に、Salesforce Help の項目はコンテンツを未加工の Markdown ミラーから提供しながら、help.salesforce.com の公開中の記事にリンクします。コンテンツは sourceUrl 経由で取得され、オフライン時はフォールバックが適用されます
• 関連コンテンツ — Developer Center ガイドには、TOC 上で直近の親項目と子項目が relatedEntries として含まれます。Salesforce Help のランディング項目では、リンク先の子記事に同じフィールドを使用し、未加工の Markdown に対応する 関連コンテンツ セクションも含まれます
• トピックの許可リスト — --topics フラグ、SFCC_DOCS_TOPICS 環境変数、または docsCategories 設定フィールド（dw.json の docs-categories、SFCC_DOCS_CATEGORIES、package.json）を使用して、コーパス全体を選択したカテゴリに限定できます。MCP サーバーには --docs-topics 起動フラグがあります
• ペイロードを抑えた既定値 — MCP ツールは結果数を 5 件に制限し、既定では必要最小限のフィールドを返します。CLI の既定値は 20 件で、詳細モードでは拡張フィールドを追加します

例

ドキュメントを検索する

# Search across all documentation
b2c docs search "passwordless login"

# Filter by category for targeted results
b2c docs search "passwordless login" --category commerce-api

# Search Developer Center guides
b2c docs search "storefront components" --category sfra
b2c docs search "deploy bundle" --category pwa-kit-managed-runtime

# Search Script API reference
b2c docs search ProductMgr --category script-api
b2c docs search "catalog product"

# Find a standard job step by type ID
b2c docs search ImportCatalog

# Search Salesforce Help — administration (import/export, jobs, security, Account Manager)
b2c docs search "site import export" --category help-admin

# Search Salesforce Help — merchandising (catalogs, promotions, search, pricing)
b2c docs search "price book assignment" --category help-merchant

# Search Salesforce Help Knowledge Articles — troubleshooting, known issues, how-to answers
b2c docs search "code upload certificate hyperforce" --category help-kb

# Search tooling documentation
b2c docs search "authentication setup" --category tooling
b2c docs search "import set" --category tooling

# Limit results (CLI default is 20, MCP default is 5)
b2c docs search authentication --limit 5

# Read the next page of ranked results
b2c docs search authentication --limit 5 --offset 5

# Show extended fields (url, sourceUrl, summary, keywords)
b2c docs search authentication --columns id,title,category,url,summary
# or use -x for extended output
b2c docs search authentication -x

# Workspace awareness is ON by default — search auto-detects the project type
b2c docs search "components"

# Opt out of workspace awareness
b2c docs search "components" --workspace all

# Force auto-detection explicitly
b2c docs search "hooks" --workspace auto

# Search with specific workspace types (boosts relevant docs)
b2c docs search "page designer" --workspace sfra

# Search with multiple workspace types (union of their boost categories)
b2c docs search "checkout" --workspace cartridges,pwa-kit-v3

# List all available documentation
b2c docs search --list

# List entries in a specific category
b2c docs search --list --category commerce-api

# List docs relevant to a specific workspace (list does not auto-detect)
b2c docs search --list --workspace cartridges

# Bound the entire corpus to specific topics (allowlist; env: SFCC_DOCS_TOPICS)
b2c docs search "login" --topics sfnext,commerce-api

--topics と --category の違い： --category は単一のクエリを絞り込みます。--topics（CLI フラグまたは SFCC_DOCS_TOPICS 環境変数）は、利用可能なコーパス全体を制限する許可リストです。--category／--workspace はその範囲内で絞り込み、docs read はその範囲外の ID を解決しません。プロジェクトに関連するドキュメントのみを表示するには、この設定を固定してください。MCP サーバーにも、同等の起動フラグ --docs-topics と環境変数 SFCC_DOCS_TOPICS があります。

ワークスペースを考慮した検索

ドキュメント検索では、プロジェクトが使用しているワークスペースのフレームワークを認識し、関連するドキュメントを自動的に優先します。これにより、SFRA、PWA Kit、Storefront Next プロジェクトに適したガイドを見つけやすくなります。この機能はデフォルトで有効です。

仕組み：

• 自動検出（デフォルト）： docs search はワークスペースの構成からプロジェクトの種類を自動的に検出します。明示的に指定するには --workspace auto を渡します
• 明示的な指定： ワークスペースの種類を1つ以上、カンマ区切りで指定します：cartridges、sfra、pwa-kit-v3、または storefront-next。複数の種類を指定すると、それぞれのブースト対象カテゴリが統合されます
• 認識機能を無効化： --workspace all を使用すると、ワークスペースの優先設定なしで検索できます

カテゴリのブースト対応表：

• 常に関連（すべてのワークスペース）：b2c-commerce、commerce-solutions、ocapi、tooling
• cartridges → script-api、job-step
• sfra → sfra
• pwa-kit-v3 → pwa-kit-managed-runtime、commerce-api
• storefront-next → sfnext、commerce-api

競合するフレームワークの優先度を下げる： ワークスペースが検出または指定されると、検索エンジンは現在のものではないストアフロントのフレームワークガイドの優先度を下げます（x0.3）。たとえば、ワークスペースが sfra の場合、pwa-kit-managed-runtime と sfnext のカテゴリの優先度が下がります。これにより、検索結果を非表示にせずに順位が調整されます。

SFRA と cartridges の違い： SFRA プロジェクトは cartridges と sfra の両方として検出されます（SFRA は app_storefront_base カートリッジを含むため、より細かい分類です）。SFRA ではないカートリッジプロジェクト（カスタム API カートリッジ、またはカートリッジも含む PWA Kit／Storefront Next のリポジトリ）は cartridges のみとして検出されるため、sfra ドキュメントはブーストされません。

検出または指定されたワークスペースは、関連するドキュメントを常にブースト（順位を上げる）しますが、カテゴリを非表示にはしません。結果を特定のカテゴリに厳密に絞り込むには、--category または --topics を使用してください。

--list の動作： --list でカタログを参照する場合、ワークスペースの自動検出は無効になります。--workspace <type> を明示的に渡して絞り込まない限り、リストにはコーパス全体が表示されます。

例：

# Auto-detect and boost relevant docs (default behavior)
b2c docs search "components"

# Search with specific workspace type
b2c docs search "checkout" --workspace sfra

# Search with multiple workspace types
b2c docs search "deploy" --workspace pwa-kit-v3,storefront-next

ドキュメントを読む

# Read Script API documentation
b2c docs read ProductMgr
b2c docs read dw.catalog.ProductMgr

# Read Developer Center guides by namespaced ID
b2c docs read sfnext/sfnext-get-started
b2c docs read commerce-api/slas-passwordless-login-registration
b2c docs read pwa-kit-managed-runtime/getting-started

# Read Salesforce Help articles by namespaced ID
b2c docs read help-admin/b2c_site_import_export
b2c docs read help-merchant/b2c_creating_price_books
b2c docs read help-kb/002772125

# Read tooling guides
b2c docs read guide-authentication
b2c docs read guide-configuration

# Output raw markdown (for piping)
b2c docs read ProductMgr --raw

# Output as JSON
b2c docs read ProductMgr --json

完全一致とあいまい検索： docs read は、完全一致する ID（例：dw.catalog.ProductMgr）を決定的に解決します。あいまいなクエリ（例：productmgr）の場合は、docs search と同じワークスペースを考慮したランキングを適用します。そのため、あいまい検索で読み込むと、検索で最上位にランクされた結果が解決されます。対象外にするには --workspace all を渡します。

コンテンツソース： Script API、Developer Center ガイド、Salesforce Help、ツールのドキュメントは、.md ソース（sourceUrl）からオンラインで取得され、ローカルにキャッシュされます。オフラインの場合は、概要、見出し、両方の URL による代替表示が行われます。CLI に同梱されているのは、標準のジョブステップのみです。

引用またはブラウザーで開くためにユーザー向けの .html ページ URL、または生の .md ソース URL を取得するには、--json 出力を使用するか、検索結果で --columns url,sourceUrl を指定してください。

標準ジョブステップカタログ

同梱コーパスには、標準（システム）ジョブステップの種類 ID のカタログが含まれます。これは、Business Manager のジョブフローに追加される組み込みステップ（たとえば ImportCatalog、ExportCatalog、ImportInventoryLists）です。各ステップのページには、用途と設定パラメーター（必須項目、デフォルト値、許可される値）が記載されています。

# Read the catalog overview (all standard step type IDs)
b2c docs read job-steps

# Read a specific step's purpose + configuration parameters
b2c docs read ImportCatalog

# Search for a step
b2c docs search "import price"
b2c docs search ExportInventoryLists --category job-step

標準ステップをジョブフローで使用する方法（カスタムステップとの連結、IMPEX ファイルの受け渡し、フロー内ステップと CLI の同等機能の使い分け）については、b2c:b2c-custom-job-steps と b2c-cli:b2c-job のスキルを参照してください。

ドキュメントをダウンロードする

B2C Commerce インスタンスから最新の Script API ドキュメントをダウンロードします。CLI は dw.json、SFCC_* 環境変数、設定プラグインから対象サーバーと認証情報を自動検出するため、上書きする場合にのみ --server が必要です。CLI が認識している内容を確認するには b2c setup inspect を実行してください。トラブルシューティングについては、b2c-cli:b2c-config スキルを参照してください。

# Download to a directory (uses configured instance)
b2c docs download ./my-docs

# Override server explicitly
b2c docs download ./docs --server sandbox.demandware.net

# Keep the original archive
b2c docs download ./docs --keep-archive

XSD スキーマを読み取る

インポート／エクスポートデータ形式用に同梱されている XSD スキーマファイルを読み取ります。

# Read a schema by name
b2c docs schema catalog

# Fuzzy match schema name
b2c docs schema order

# List all available schemas
b2c docs schema --list

# Print the filesystem path to the schema file
b2c docs schema catalog --path

# Validate an XML file against a schema using xmllint
xmllint --schema "$(b2c docs schema catalog --path)" my-catalog.xml --noout

ドキュメントのカテゴリ

カテゴリ	説明	ID の例
script-api	サーバーサイド Script API リファレンス（dw.* クラス／モジュール）	dw.catalog.ProductMgr、dw.order.Basket
commerce-api	Commerce API（SCAPI／OCAPI）の概念ガイドおよび手順ガイド	commerce-api/slas-passwordless-login-registration
pwa-kit-managed-runtime	PWA Kit および Managed Runtime（MRT）のガイド	pwa-kit-managed-runtime/getting-started
sfra	Storefront Reference Architecture（SFRA）のガイド	sfra/controllers-and-routes
sfnext	Storefront Next のガイド	sfnext/sfnext-get-started
b2c-commerce	B2C Commerce プラットフォームの一般的なガイド	b2c-commerce/business-manager-overview
commerce-solutions	B2C Commerce ソリューション — ボット管理、キャッシュ戦略、フラッシュセールのトラフィック、および業界ソリューション	commerce-solutions/bot-management
ocapi	OCAPI リファレンス — Open Commerce API の使用方法、フック、設定、ベストプラクティス	ocapi/ocapisettings、ocapi/bestpractices
tooling	B2C CLI リファレンス、ガイド、MCP ドキュメント、SDK のガイダンス、VS Code 拡張機能のドキュメント	guide-authentication、cli-jobs
job-step	標準（システム）ジョブステップのカタログ	ImportCatalog、ExportCatalog、job-steps
help-admin	Salesforce Help — 管理／運用（インポート／エクスポート、ジョブ、レプリケーション、セキュリティ、Account Manager、権限、ログ、在庫）	help-admin/b2c_site_import_export
help-merchant	Salesforce Help — マーチャンダイジング（カタログ、商品、プロモーション、検索、コンテンツ、分析、SEO）	help-merchant/b2c_creating_price_books
help-kb	Salesforce Help ナレッジ記事 — トラブルシューティング、既知の問題、手順に関する回答（記事番号で識別）	help-kb/002772125

URL： job-step を除くすべてのカテゴリには、url（人が読むための .html ページ）と sourceUrl（機械可読な .md）の両方があります。help-admin／help-merchant／help-kb では、url は help.salesforce.com の公開記事を指し、コンテンツは sourceUrl から読み込まれます。job-step のエントリにはどちらもありません（コンテンツはインラインで同梱されています）。

キャッシュ： オンラインコーパス（script-api、各ガイドカテゴリ、help-admin／help-merchant／help-kb、tooling）のコンテンツは、docs read の実行時に取得され、ローカルにキャッシュされます。b2c docs cache でキャッシュを確認し、b2c docs cache --clear で削除できます（再取得が強制されます）。

一般的なスクリプト API クラス

クラス	説明
dw.catalog.ProductMgr	商品の管理と検索
dw.catalog.Product	商品データと属性
dw.order.Basket	ショッピングバスケットの操作
dw.order.Order	注文処理
dw.customer.CustomerMgr	顧客管理
dw.system.Site	サイト設定
dw.web.URLUtils	URL 生成ユーティリティ

一般的なスキーマ

スキーマ	説明
catalog	商品カタログのインポート／エクスポート
order	注文データのインポート／エクスポート
customer	顧客データのインポート／エクスポート
inventory	在庫データのインポート／エクスポート
pricebook	価格表のインポート／エクスポート
promotion	プロモーションの定義
coupon	クーポンコードのインポート／エクスポート
jobs	ジョブステップの定義

CLI コマンドを探す

b2c docs search はドキュメントを検索します。タスクを実行する b2c コマンドを調べるには、代わりに CLI 自体のコマンドを検索してください。

b2c commands search "deploy cartridges"
b2c commands search "environment variables" --topic mrt --json

エージェントスキルを読む

CLI には、エージェントスキル（このようなワークフローガイド）がバンドルされています。プラグインをインストールせずに、コマンドやトピックに関するスキルを読んだり、スキルを検索したりできます。

b2c docs skill                          # list b2c-cli skills
b2c docs skill code deploy              # skill covering a command or topic
b2c docs skill --search "site import"   # search skills
b2c docs skill --all --search "hooks"   # include b2c, b2c-ops, storefront-next

その他のコマンド

利用可能なコマンドとオプションの一覧は、b2c docs --help を参照してください。