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
Copy file name to clipboardExpand all lines: docs/CHANGELOG.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,11 @@
1
1
# @salesforce/b2c-dx-docs
2
2
3
+
## 0.2.13
4
+
5
+
### Patch Changes
6
+
7
+
-[#318](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/pull/318)[`6880a84`](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/commit/6880a846aacd029a1eb510023aa76f4b844ec26e) - Added per-instance safety configuration with rule-based actions (allow/block/confirm) and interactive confirmation mode. Safety can now be configured in `dw.json` with granular rules for HTTP paths, job IDs, and CLI commands. (Thanks [@clavery](https://github.com/clavery)!)
Copy file name to clipboardExpand all lines: docs/cli/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ b2c sandbox list # ✅ Allowed
51
51
b2c sandbox create --realm test# ❌ Blocked
52
52
```
53
53
54
-
Safety Mode operates at the HTTP layer and cannot be bypassed by command-line flags. See the [Security Guide](/guide/security#operational-security-safety-mode) for detailed information.
54
+
Safety Mode operates at the HTTP layer and cannot be bypassed by command-line flags. See the [Safety Mode](/guide/safety) guide for detailed information.
@@ -615,6 +615,79 @@ If detailed usage data is present (granular history, profiles, etc.), the comman
615
615
616
616
---
617
617
618
+
## b2c sandbox settings
619
+
620
+
Show effective OCAPI and WebDAV settings for a specific sandbox.
621
+
622
+
### Usage
623
+
624
+
```bash
625
+
b2c sandbox settings <SANDBOXID>
626
+
```
627
+
628
+
### Arguments
629
+
630
+
| Argument | Description | Required |
631
+
|----------|-------------|----------|
632
+
|`SANDBOXID`| Sandbox ID (UUID or realm-instance, e.g., `zzzv-123`) | Yes |
633
+
634
+
### Examples
635
+
636
+
```bash
637
+
# Show settings summary for a sandbox
638
+
b2c sandbox settings zzzz-001
639
+
640
+
# Output full settings payload as JSON
641
+
b2c sandbox settings zzzz-001 --json
642
+
```
643
+
644
+
### Output
645
+
646
+
When not using `--json`, the command prints:
647
+
648
+
- Number of OCAPI client entries
649
+
- Number of WebDAV client entries
650
+
- A short per-client breakdown for each settings type
651
+
652
+
---
653
+
654
+
## b2c sandbox storage
655
+
656
+
Show filesystem storage usage for a specific sandbox.
657
+
658
+
### Usage
659
+
660
+
```bash
661
+
b2c sandbox storage <SANDBOXID>
662
+
```
663
+
664
+
### Arguments
665
+
666
+
| Argument | Description | Required |
667
+
|----------|-------------|----------|
668
+
|`SANDBOXID`| Sandbox ID (UUID or realm-instance, e.g., `zzzv-123`) | Yes |
669
+
670
+
### Examples
671
+
672
+
```bash
673
+
# Show storage table for a sandbox
674
+
b2c sandbox storage zzzz-001
675
+
676
+
# Output raw storage response as JSON
677
+
b2c sandbox storage zzzz-001 --json
678
+
```
679
+
680
+
### Output
681
+
682
+
When not using `--json`, the command prints a table with one row per filesystem:
683
+
684
+
- Filesystem name
685
+
- Total space (MB)
686
+
- Used space (MB)
687
+
- Used percentage
688
+
689
+
---
690
+
618
691
## Sandbox Aliases
619
692
620
693
Sandbox aliases let you access a sandbox via a custom hostname instead of the default instance hostname.
@@ -976,56 +1049,86 @@ For the complete response including all metadata, use the `--json` flag.
976
1049
977
1050
## Realm-Level Commands
978
1051
979
-
Realm commands operate at the **realm** level rather than on an individual sandbox. They are available as both `realm` topic commands and as `sandbox realm` subcommands:
1052
+
Realm commands operate at the **realm** level rather than on an individual sandbox. Use them under the existing sandbox topics:
To run `b2c realm` commands, your user or API client must have **realm‑level access** in Account Manager (typically a role ending in `_sbx` for sandbox management).
1063
+
To run `b2c sandbox realm` (or `b2c ods realm`) commands, your user or API client must have **realm‑level access** in Account Manager (typically a role ending in `_sbx` for sandbox management).
989
1064
990
-
### b2c realm list
1065
+
### b2c sandbox realm list
991
1066
992
1067
List realms eligible for sandbox management.
993
1068
994
1069
#### Usage
995
1070
996
1071
```bash
997
-
b2c realm list [REALM]
1072
+
b2c sandbox realm list [REALM]
998
1073
```
999
1074
1000
1075
#### Arguments
1001
1076
1002
1077
| Argument | Description | Required |
1003
1078
|----------|-------------|----------|
1004
-
|`REALM`|Specific realm ID (four-letter ID) to get details for| No |
1079
+
|`REALM`|Optional realm ID filter (four-letter ID) | No |
1005
1080
1006
1081
#### Examples
1007
1082
1008
1083
```bash
1009
1084
# List all realms you can manage
1010
-
b2c realm list
1085
+
b2c sandbox realm list
1011
1086
1012
1087
# List a single realm
1013
-
b2c realm list zzzz
1088
+
b2c sandbox realm list zzzz
1014
1089
1015
1090
# JSON output
1016
-
b2c realm list --json
1091
+
b2c sandbox realm list --json
1017
1092
```
1018
1093
1019
-
When `REALM` is omitted, the command discovers realms from the `/me` endpoint and then fetches configuration for each.
1094
+
When `REALM` is omitted, the command discovers realms from the `/me` endpoint.
1095
+
1096
+
### b2c sandbox realm configuration
1020
1097
1021
-
### b2c realm get
1098
+
Get sandbox configuration for a specific realm.
1099
+
1100
+
#### Usage
1101
+
1102
+
```bash
1103
+
b2c sandbox realm configuration <REALM>
1104
+
```
1105
+
1106
+
#### Arguments
1107
+
1108
+
| Argument | Description | Required |
1109
+
|----------|-------------|----------|
1110
+
|`REALM`| Realm ID (four-letter ID) | Yes |
1111
+
1112
+
#### Examples
1113
+
1114
+
```bash
1115
+
# Get realm sandbox configuration
1116
+
b2c sandbox realm configuration zzzz
1117
+
1118
+
# JSON output
1119
+
b2c sandbox realm configuration zzzz --json
1120
+
```
1121
+
1122
+
When not using `--json`, the command prints configuration details such as emails, sandbox limits, TTL values, and start/stop schedulers.
1123
+
1124
+
### b2c sandbox realm get
1022
1125
1023
1126
Get detailed information about a specific realm, including configuration.
1024
1127
1025
1128
#### Usage
1026
1129
1027
1130
```bash
1028
-
b2c realm get <REALM>
1131
+
b2c sandbox realm get <REALM>
1029
1132
```
1030
1133
1031
1134
#### Arguments
@@ -1038,10 +1141,10 @@ b2c realm get <REALM>
1038
1141
1039
1142
```bash
1040
1143
# Get realm details
1041
-
b2c realm get zzzz
1144
+
b2c sandbox realm get zzzz
1042
1145
1043
1146
# JSON output (includes configuration and account details when available)
1044
-
b2c realm get zzzz --json
1147
+
b2c sandbox realm get zzzz --json
1045
1148
```
1046
1149
1047
1150
#### Output
@@ -1058,14 +1161,14 @@ The command prints:
1058
1161
- Whether local users are allowed
1059
1162
- Start/stop scheduler definitions (as JSON) when present
1060
1163
1061
-
### b2c realm update
1164
+
### b2c sandbox realm update
1062
1165
1063
1166
Update realm‑level sandbox configuration for TTL and start/stop schedulers.
1064
1167
1065
1168
#### Usage
1066
1169
1067
1170
```bash
1068
-
b2c realm update <REALM> [FLAGS]
1171
+
b2c sandbox realm update <REALM> [FLAGS]
1069
1172
```
1070
1173
1071
1174
#### Arguments
@@ -1096,30 +1199,30 @@ The scheduler flags expect a JSON value or the literal string `"null"`:
1096
1199
1097
1200
```bash
1098
1201
# Set max TTL to unlimited and default TTL to 24 hours
When not using `--json`, the command prints a summary including:
@@ -1159,3 +1262,46 @@ When not using `--json`, the command prints a summary including:
1159
1262
1160
1263
If detailed usage is available, it prints a hint to re-run with `--json` for the full structure. If no usage data is returned for the requested period, it prints a friendly message instead of failing.
1161
1264
1265
+
### b2c sandbox realm usages
1266
+
1267
+
Show usage information for multiple realms in one request.
1268
+
1269
+
#### Usage
1270
+
1271
+
```bash
1272
+
b2c sandbox realm usages [FLAGS]
1273
+
```
1274
+
1275
+
#### Flags
1276
+
1277
+
| Flag | Description |
1278
+
|------|-------------|
1279
+
|`--realm`| Realm IDs to include (repeat flag or provide comma-separated values) |
1280
+
|`--from`| Earliest date to include in usage (ISO 8601) |
1281
+
|`--to`| Latest date to include in usage (ISO 8601) |
1282
+
|`--detailed-report`| Include detailed usage information in the response |
1283
+
1284
+
If `--realm` is omitted, the command auto-discovers realms from `/me` and queries usage for all discovered realms.
1285
+
1286
+
#### Examples
1287
+
1288
+
```bash
1289
+
# Usage for all realms available to the current user
|`SFCC_SAFETY_CONFIRM`| Enable confirmation mode for safety: `true` or `1` (see [Safety Mode](/guide/safety#confirmation-mode)) |
89
+
|`SFCC_SAFETY_CONFIG`| Path to global safety config file (see [Safety Mode](/guide/safety#global-safety-config)) |
88
90
89
91
## .env File
90
92
@@ -150,6 +152,8 @@ For projects that work with multiple instances, use the `configs` array:
150
152
}
151
153
```
152
154
155
+
Each instance can have its own `safety` configuration for per-instance operational safety. See [Safety Mode](/guide/safety#per-instance-configuration) for details.
156
+
153
157
Use the `-i` or `--instance` flag to select a specific configuration:
0 commit comments