Skip to content

Commit 52d7a6d

Browse files
committed
fix: correct inaccurate flags and commands in CLI skill documentation
- b2c-ecdn: fix zones create flags, remove nonexistent cache purge --purge-everything and certificates get command - b2c-users-roles: fix clients create --display-name to --name, add required --password and --orgs flags, add --current/--new to clients password - b2c-am: fix --expand syntax to use comma-separated values - b2c-job: add missing job log command, expand search and wait docs
1 parent 1b0b4ce commit 52d7a6d

5 files changed

Lines changed: 42 additions & 15 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@salesforce/b2c-cli': patch
3+
---
4+
5+
Fix inaccurate flags and commands in CLI skill documentation for job, ecdn, am, and users-roles skills

skills/b2c-cli/skills/b2c-am/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ b2c am clients list --json
4848
b2c am clients get <api-client-id>
4949

5050
# with expanded organizations and roles
51-
b2c am clients get <api-client-id> --expand organizations --expand roles
51+
b2c am clients get <api-client-id> --expand organizations,roles
5252
```
5353

5454
### Create Client

skills/b2c-cli/skills/b2c-ecdn/SKILL.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ b2c ecdn zones list --tenant-id zzxy_prd --json
3131

3232
```bash
3333
# create a new storefront zone
34-
b2c ecdn zones create --tenant-id zzxy_prd --storefront-hostname www.example.com --origin-hostname origin.example.com
34+
b2c ecdn zones create --tenant-id zzxy_prd --domain-name example.com
3535
```
3636

3737
### Purge Cache
@@ -42,9 +42,6 @@ b2c ecdn cache purge --tenant-id zzxy_prd --zone my-zone --path /products --path
4242

4343
# purge by cache tags
4444
b2c ecdn cache purge --tenant-id zzxy_prd --zone my-zone --tag product-123 --tag category-456
45-
46-
# purge everything
47-
b2c ecdn cache purge --tenant-id zzxy_prd --zone my-zone --purge-everything
4845
```
4946

5047
### Manage Certificates
@@ -56,9 +53,6 @@ b2c ecdn certificates list --tenant-id zzxy_prd --zone my-zone
5653
# add a new certificate
5754
b2c ecdn certificates add --tenant-id zzxy_prd --zone my-zone --hostname www.example.com --certificate-file ./cert.pem --private-key-file ./key.pem
5855

59-
# get certificate details
60-
b2c ecdn certificates get --tenant-id zzxy_prd --zone my-zone --certificate-id abc123
61-
6256
# validate a custom hostname
6357
b2c ecdn certificates validate --tenant-id zzxy_prd --zone my-zone --certificate-id abc123
6458
```

skills/b2c-cli/skills/b2c-job/SKILL.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,12 +148,38 @@ b2c job export --global-data meta_data --timeout 600
148148

149149
For full control over the export configuration (including `catalog_static_resources`, `library_static_resources`, and `customer_lists`), use `--data-units` with a JSON string matching the `ExportDataUnitsConfiguration` shape.
150150

151+
### View Job Logs
152+
153+
```bash
154+
# get the log from the most recent execution of a job
155+
b2c job log my-custom-job
156+
157+
# get the log from the most recent failed execution
158+
b2c job log my-custom-job --failed
159+
160+
# get the log from a specific execution
161+
b2c job log my-custom-job abc123-def456
162+
```
163+
151164
### Search Job Executions
152165

153166
```bash
154-
# search for job executions
167+
# search for recent job executions
155168
b2c job search
156169

170+
# filter by job ID
171+
b2c job search --job-id my-custom-job
172+
173+
# filter by status
174+
b2c job search --status ERROR
175+
b2c job search --status RUNNING,PENDING
176+
177+
# control result count and pagination
178+
b2c job search --count 50 --start 0
179+
180+
# sort results
181+
b2c job search --sort-by start_time --sort-order desc
182+
157183
# search with JSON output
158184
b2c job search --json
159185
```
@@ -163,11 +189,13 @@ b2c job search --json
163189
```bash
164190
# wait for a specific job execution to complete (requires both job ID and execution ID)
165191
b2c job wait <job-id> <execution-id>
166-
```
167192

168-
### More Commands
193+
# wait with a timeout
194+
b2c job wait <job-id> <execution-id> --timeout 600
169195

170-
See `b2c job --help` for a full list of available commands and options in the `job` topic.
196+
# wait with a custom polling interval
197+
b2c job wait <job-id> <execution-id> --poll-interval 5
198+
```
171199

172200
## Related Skills
173201

skills/b2c-cli/skills/b2c-users-roles/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ b2c am orgs list
7878
b2c am clients list
7979

8080
# create an API client
81-
b2c am clients create --display-name "My Client" --org MyOrg
81+
b2c am clients create --name "My Client" --orgs MyOrg --password "securePassword123"
8282

83-
# reset API client password
84-
b2c am clients password my-client-id
83+
# change API client password
84+
b2c am clients password my-client-id --current "oldPass" --new "newPass123"
8585
```
8686

8787
## Business Manager Roles

0 commit comments

Comments
 (0)