You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documentation audit pass: corrected flag mismatches and missing commands
- Documented previously omitted commands: b2c sandbox ips, b2c mrt env var
push, b2c debug
- Fixed MRT reference: project get/update/delete now show the required
positional slug; project member roles use integer values; env invalidate
uses --pattern; redirect create/delete/clone flag names corrected; user
api-key and email-prefs rewritten against the real flags
- Rewrote ecdn flag tables for zones create, cache purge, security update,
speed update, and logpush jobs create to match source
- Removed phantom flags from am users update
- Standardized Node.js requirement on >=22.16.0 across guides
- account-manager guide no longer recommends the unsupported
client_secret_post; authentication warning reframed as guidance
- Added Copilot section to agent-skills so the homepage Copilot link lands
on meaningful content
- Filled gaps in cli/index.md command-topic listing
- b2c debug --help now deep-links to the new docs page
Documentation audit pass: corrected mismatched flags and missing commands across the CLI reference. Highlights:
6
+
7
+
- Documented `b2c sandbox ips`, `b2c mrt env var push`, and `b2c debug` (previously omitted).
8
+
- Fixed `mrt project get/update/delete` examples to use the required positional slug; corrected `mrt project member add/update --role` to integer values; replaced `mrt env invalidate --path` with the actual `--pattern` flag; corrected `mrt env redirect create/delete/clone` flag names; rewrote `mrt user api-key` and `mrt user email-prefs` against the real flags.
9
+
- Rewrote `ecdn zones create`, `ecdn cache purge`, `ecdn security update`, `ecdn speed update`, and `ecdn logpush jobs create` flag tables to match source.
10
+
- Removed phantom flags (`--display-name`, etc.) from `am users update`.
11
+
- Standardized Node.js requirement on `>=22.16.0` across all installation guides.
12
+
-`account-manager` guide no longer recommends the unsupported `client_secret_post`; the `authentication` warning was reframed as guidance toward `client_secret_basic`.
13
+
- Added a Copilot section to the agent-skills guide so the homepage Copilot link points at meaningful content.
14
+
- Filled gaps in the CLI command-topic index (`bm-roles`, `setup`, `ecdn`, `replications`, `scapi-schemas`, `cap`, `logs`).
description: Start a DAP debug adapter for B2C Commerce server-side script debugging.
3
+
---
4
+
5
+
# Debug Command
6
+
7
+
The `b2c debug` command launches a [Debug Adapter Protocol (DAP)](https://microsoft.github.io/debug-adapter-protocol/) adapter that bridges your IDE to the B2C Commerce script debugger. It's designed to be invoked by an IDE (VS Code, JetBrains, etc.) over stdio, not run directly in a shell.
8
+
9
+
## Authentication
10
+
11
+
The script debugger uses **Basic auth** (Business Manager username and password). OAuth credentials are not sufficient. Provide credentials via any of:
|`--cartridge-path`| Path to your cartridges directory. The adapter recursively discovers cartridges under this path and maps them to the running instance. |`.`|
34
+
|`--client-id`| Client ID reported to the B2C script debugger API. Useful when multiple debug sessions share an instance. |`b2c-cli`|
35
+
36
+
Inherits the [global instance and authentication flags](./index#global-flags) (`--server`, `--username`, `--password`, etc.).
37
+
38
+
### Examples
39
+
40
+
```bash
41
+
# Run from a project root with cartridges in ./cartridges or ./
42
+
b2c debug
43
+
44
+
# Point at an explicit cartridges directory
45
+
b2c debug --cartridge-path ./cartridges
46
+
47
+
# Use a non-default debugger client ID
48
+
b2c debug --client-id my-debugger
49
+
```
50
+
51
+
### IDE Integration
52
+
53
+
Most IDEs spawn DAP adapters automatically based on a launch configuration. The adapter speaks DAP over **stdin/stdout**, so direct shell invocation will appear to hang — that's expected. Configure your IDE's debug launcher to invoke `b2c debug` and supply the appropriate environment.
54
+
55
+
## Notes
56
+
57
+
- A warning is emitted if no cartridges are found at `--cartridge-path`.
58
+
- Source maps are derived from the discovered cartridge layout; ensure your local cartridge tree matches what's deployed to the instance, otherwise breakpoints may not bind.
0 commit comments