Skip to content

Commit db66b17

Browse files
claveryclavery
committed
flags docs upate
1 parent c9a2815 commit db66b17

6 files changed

Lines changed: 126 additions & 126 deletions

File tree

‎docs/cli/code.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,12 @@ b2c code deploy [CARTRIDGEPATH]
8080

8181
In addition to [global flags](./index#global-flags):
8282

83-
| Flag | Short | Description | Default |
84-
|------|-------|-------------|---------|
85-
| `--reload` | `-r` | Reload (re-activate) code version after deploy | `false` |
86-
| `--delete` | | Delete existing cartridges before upload | `false` |
87-
| `--cartridge` | `-c` | Include specific cartridge(s) (can be repeated) | |
88-
| `--exclude-cartridge` | `-x` | Exclude specific cartridge(s) (can be repeated) | |
83+
| Flag | Description | Default |
84+
|------|-------------|---------|
85+
| `--reload`, `-r` | Reload (re-activate) code version after deploy | `false` |
86+
| `--delete` | Delete existing cartridges before upload | `false` |
87+
| `--cartridge`, `-c` | Include specific cartridge(s) (can be repeated) | |
88+
| `--exclude-cartridge`, `-x` | Exclude specific cartridge(s) (can be repeated) | |
8989

9090
### Examples
9191

@@ -154,9 +154,9 @@ b2c code activate [CODEVERSION]
154154

155155
In addition to [global flags](./index#global-flags):
156156

157-
| Flag | Short | Description | Default |
158-
|------|-------|-------------|---------|
159-
| `--reload` | `-r` | Reload the code version (toggle activation to force reload) | `false` |
157+
| Flag | Description | Default |
158+
|------|-------------|---------|
159+
| `--reload`, `-r` | Reload the code version (toggle activation to force reload) | `false` |
160160

161161
### Examples
162162

@@ -207,9 +207,9 @@ b2c code delete CODEVERSION
207207

208208
In addition to [global flags](./index#global-flags):
209209

210-
| Flag | Short | Description | Default |
211-
|------|-------|-------------|---------|
212-
| `--force` | `-f` | Skip confirmation prompt | `false` |
210+
| Flag | Description | Default |
211+
|------|-------------|---------|
212+
| `--force`, `-f` | Skip confirmation prompt | `false` |
213213

214214
### Examples
215215

@@ -254,10 +254,10 @@ b2c code watch [CARTRIDGEPATH]
254254

255255
In addition to [global flags](./index#global-flags):
256256

257-
| Flag | Short | Description |
258-
|------|-------|-------------|
259-
| `--cartridge` | `-c` | Include specific cartridge(s) (can be repeated) |
260-
| `--exclude-cartridge` | `-x` | Exclude specific cartridge(s) (can be repeated) |
257+
| Flag | Description |
258+
|------|-------------|
259+
| `--cartridge`, `-c` | Include specific cartridge(s) (can be repeated) |
260+
| `--exclude-cartridge`, `-x` | Exclude specific cartridge(s) (can be repeated) |
261261

262262
### Examples
263263

‎docs/cli/index.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ These flags are available on all commands that interact with B2C instances:
88

99
### Instance Flags
1010

11-
| Flag | Short | Environment Variable | Description |
12-
|------|-------|---------------------|-------------|
13-
| `--server` | `-s` | `SFCC_SERVER` | B2C instance hostname |
14-
| `--webdav-server` | | `SFCC_WEBDAV_SERVER` | Secure WebDAV hostname |
15-
| `--code-version` | `-v` | `SFCC_CODE_VERSION` | Code version |
11+
| Flag | Environment Variable | Description |
12+
|------|---------------------|-------------|
13+
| `--server`, `-s` | `SFCC_SERVER` | B2C instance hostname |
14+
| `--webdav-server` | `SFCC_WEBDAV_SERVER` | Secure WebDAV hostname |
15+
| `--code-version`, `-v` | `SFCC_CODE_VERSION` | Code version |
1616

1717
### Authentication Flags
1818

19-
| Flag | Short | Environment Variable | Description |
20-
|------|-------|---------------------|-------------|
21-
| `--client-id` | | `SFCC_CLIENT_ID` | OAuth client ID |
22-
| `--client-secret` | | `SFCC_CLIENT_SECRET` | OAuth client secret |
23-
| `--username` | `-u` | `SFCC_USERNAME` | Username for Basic Auth |
24-
| `--password` | `-p` | `SFCC_PASSWORD` | Password/access key for Basic Auth |
19+
| Flag | Environment Variable | Description |
20+
|------|---------------------|-------------|
21+
| `--client-id` | `SFCC_CLIENT_ID` | OAuth client ID |
22+
| `--client-secret` | `SFCC_CLIENT_SECRET` | OAuth client secret |
23+
| `--username`, `-u` | `SFCC_USERNAME` | Username for Basic Auth |
24+
| `--password`, `-p` | `SFCC_PASSWORD` | Password/access key for Basic Auth |
2525

2626
## Command Topics
2727

‎docs/cli/jobs.md‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ b2c job run JOBID
2222

2323
In addition to [global flags](./index#global-flags):
2424

25-
| Flag | Short | Description | Default |
26-
|------|-------|-------------|---------|
27-
| `--wait` | `-w` | Wait for job to complete | `false` |
28-
| `--timeout` | `-t` | Timeout in seconds when waiting | No timeout |
29-
| `--param` | `-P` | Job parameter in format "name=value" (repeatable) | |
30-
| `--no-wait-running` | | Do not wait for running job to finish before starting | `false` |
31-
| `--show-log` | | Show job log on failure | `true` |
25+
| Flag | Description | Default |
26+
|------|-------------|---------|
27+
| `--wait`, `-w` | Wait for job to complete | `false` |
28+
| `--timeout`, `-t` | Timeout in seconds when waiting | No timeout |
29+
| `--param`, `-P` | Job parameter in format "name=value" (repeatable) | |
30+
| `--no-wait-running` | Do not wait for running job to finish before starting | `false` |
31+
| `--show-log` | Show job log on failure | `true` |
3232

3333
### Examples
3434

@@ -76,11 +76,11 @@ b2c job wait JOBID EXECUTIONID
7676

7777
In addition to [global flags](./index#global-flags):
7878

79-
| Flag | Short | Description | Default |
80-
|------|-------|-------------|---------|
81-
| `--timeout` | `-t` | Timeout in seconds | No timeout |
82-
| `--poll-interval` | | Polling interval in seconds | `3` |
83-
| `--show-log` | | Show job log on failure | `true` |
79+
| Flag | Description | Default |
80+
|------|-------------|---------|
81+
| `--timeout`, `-t` | Timeout in seconds | No timeout |
82+
| `--poll-interval` | Polling interval in seconds | `3` |
83+
| `--show-log` | Show job log on failure | `true` |
8484

8585
### Examples
8686

@@ -115,14 +115,14 @@ b2c job search
115115

116116
In addition to [global flags](./index#global-flags):
117117

118-
| Flag | Short | Description | Default |
119-
|------|-------|-------------|---------|
120-
| `--job-id` | `-j` | Filter by job ID | |
121-
| `--status` | | Filter by status (comma-separated: RUNNING,PENDING,OK,ERROR) | |
122-
| `--count` | `-n` | Maximum number of results | `25` |
123-
| `--start` | | Starting index for pagination | `0` |
124-
| `--sort-by` | | Sort by field (start_time, end_time, job_id, status) | `start_time` |
125-
| `--sort-order` | | Sort order (asc, desc) | `desc` |
118+
| Flag | Description | Default |
119+
|------|-------------|---------|
120+
| `--job-id`, `-j` | Filter by job ID | |
121+
| `--status` | Filter by status (comma-separated: RUNNING,PENDING,OK,ERROR) | |
122+
| `--count`, `-n` | Maximum number of results | `25` |
123+
| `--start` | Starting index for pagination | `0` |
124+
| `--sort-by` | Sort by field (start_time, end_time, job_id, status) | `start_time` |
125+
| `--sort-order` | Sort order (asc, desc) | `desc` |
126126

127127
### Examples
128128

@@ -178,12 +178,12 @@ b2c job import TARGET
178178

179179
In addition to [global flags](./index#global-flags):
180180

181-
| Flag | Short | Description | Default |
182-
|------|-------|-------------|---------|
183-
| `--keep-archive` | `-k` | Keep archive on instance after import | `false` |
184-
| `--remote` | `-r` | Target is a filename already on the instance (in Impex/src/instance/) | `false` |
185-
| `--timeout` | `-t` | Timeout in seconds | No timeout |
186-
| `--show-log` | | Show job log on failure | `true` |
181+
| Flag | Description | Default |
182+
|------|-------------|---------|
183+
| `--keep-archive`, `-k` | Keep archive on instance after import | `false` |
184+
| `--remote`, `-r` | Target is a filename already on the instance (in Impex/src/instance/) | `false` |
185+
| `--timeout`, `-t` | Timeout in seconds | No timeout |
186+
| `--show-log` | Show job log on failure | `true` |
187187

188188
### Examples
189189

@@ -230,22 +230,22 @@ b2c job export
230230

231231
In addition to [global flags](./index#global-flags):
232232

233-
| Flag | Short | Description | Default |
234-
|------|-------|-------------|---------|
235-
| `--output` | `-o` | Output path for the export | `.` (current directory) |
236-
| `--data-units` | | Data units JSON configuration | |
237-
| `--site` | | Site ID(s) to export (comma-separated, repeatable) | |
238-
| `--site-data` | | Site data types to export (comma-separated) | |
239-
| `--global-data` | | Global data types to export (comma-separated) | |
240-
| `--catalog` | | Catalog ID(s) to export (comma-separated) | |
241-
| `--pricebook` | | Pricebook ID(s) to export (comma-separated) | |
242-
| `--library` | | Library ID(s) to export (comma-separated) | |
243-
| `--inventory` | | Inventory list ID(s) to export (comma-separated) | |
244-
| `--keep-archive` | `-k` | Keep archive on instance after download | `false` |
245-
| `--no-download` | | Do not download archive (implies --keep-archive) | `false` |
246-
| `--zip-only` | | Save as zip file without extracting | `false` |
247-
| `--timeout` | `-t` | Timeout in seconds | No timeout |
248-
| `--show-log` | | Show job log on failure | `true` |
233+
| Flag | Description | Default |
234+
|------|-------------|---------|
235+
| `--output`, `-o` | Output path for the export | `.` (current directory) |
236+
| `--data-units` | Data units JSON configuration | |
237+
| `--site` | Site ID(s) to export (comma-separated, repeatable) | |
238+
| `--site-data` | Site data types to export (comma-separated) | |
239+
| `--global-data` | Global data types to export (comma-separated) | |
240+
| `--catalog` | Catalog ID(s) to export (comma-separated) | |
241+
| `--pricebook` | Pricebook ID(s) to export (comma-separated) | |
242+
| `--library` | Library ID(s) to export (comma-separated) | |
243+
| `--inventory` | Inventory list ID(s) to export (comma-separated) | |
244+
| `--keep-archive`, `-k` | Keep archive on instance after download | `false` |
245+
| `--no-download` | Do not download archive (implies --keep-archive) | `false` |
246+
| `--zip-only` | Save as zip file without extracting | `false` |
247+
| `--timeout`, `-t` | Timeout in seconds | No timeout |
248+
| `--show-log` | Show job log on failure | `true` |
249249

250250
### Examples
251251

‎docs/cli/mrt.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Commands for managing Managed Runtime (MRT) projects, environments, and bundles.
66

77
These flags are available on all MRT commands:
88

9-
| Flag | Short | Environment Variable | Description |
10-
|------|-------|---------------------|-------------|
11-
| `--api-key` | | `SFCC_MRT_API_KEY` | MRT API key |
12-
| `--project` | `-p` | `SFCC_MRT_PROJECT` | MRT project slug |
13-
| `--environment` | `-e` | `SFCC_MRT_ENVIRONMENT` | Target environment (e.g., staging, production) |
9+
| Flag | Environment Variable | Description |
10+
|------|---------------------|-------------|
11+
| `--api-key` | `SFCC_MRT_API_KEY` | MRT API key |
12+
| `--project`, `-p` | `SFCC_MRT_PROJECT` | MRT project slug |
13+
| `--environment`, `-e` | `SFCC_MRT_ENVIRONMENT` | Target environment (e.g., staging, production) |
1414

1515
### Configuration Sources
1616

@@ -73,15 +73,15 @@ b2c mrt push [FLAGS]
7373

7474
In addition to [global MRT flags](#global-mrt-flags):
7575

76-
| Flag | Short | Description | Default |
77-
|------|-------|-------------|---------|
78-
| `--message` | `-m` | Bundle message/description | |
79-
| `--build-dir` | `-b` | Path to the build directory | `build` |
80-
| `--ssr-only` | | Glob patterns for server-only files (comma-separated) | `ssr.js,server/**/*` |
81-
| `--ssr-shared` | | Glob patterns for shared files (comma-separated) | `static/**/*,client/**/*` |
82-
| `--node-version` | `-n` | Node.js version for SSR runtime | `20.x` |
83-
| `--ssr-param` | | SSR parameter in key=value format (can be specified multiple times) | |
84-
| `--json` | | Output result as JSON | |
76+
| Flag | Description | Default |
77+
|------|-------------|---------|
78+
| `--message`, `-m` | Bundle message/description | |
79+
| `--build-dir`, `-b` | Path to the build directory | `build` |
80+
| `--ssr-only` | Glob patterns for server-only files (comma-separated) | `ssr.js,server/**/*` |
81+
| `--ssr-shared` | Glob patterns for shared files (comma-separated) | `static/**/*,client/**/*` |
82+
| `--node-version`, `-n` | Node.js version for SSR runtime | `20.x` |
83+
| `--ssr-param` | SSR parameter in key=value format (can be specified multiple times) | |
84+
| `--json` | Output result as JSON | |
8585

8686
### Examples
8787

@@ -143,19 +143,19 @@ b2c mrt env create SLUG [FLAGS]
143143

144144
In addition to [global MRT flags](#global-mrt-flags):
145145

146-
| Flag | Short | Description | Default |
147-
|------|-------|-------------|---------|
148-
| `--name` | `-n` | Display name for the environment | **Required** |
149-
| `--region` | `-r` | AWS region for SSR deployment | |
150-
| `--production` | | Mark as a production environment | `false` |
151-
| `--hostname` | | Hostname pattern for V8 Tag loading | |
152-
| `--external-hostname` | | Full external hostname (e.g., www.example.com) | |
153-
| `--external-domain` | | External domain for Universal PWA SSR (e.g., example.com) | |
154-
| `--allow-cookies` | | Forward HTTP cookies to origin | `false` |
155-
| `--no-allow-cookies` | | Disable cookie forwarding | |
156-
| `--enable-source-maps` | | Enable source map support in the environment | `false` |
157-
| `--no-enable-source-maps` | | Disable source map support | |
158-
| `--json` | | Output result as JSON | |
146+
| Flag | Description | Default |
147+
|------|-------------|---------|
148+
| `--name`, `-n` | Display name for the environment | **Required** |
149+
| `--region`, `-r` | AWS region for SSR deployment | |
150+
| `--production` | Mark as a production environment | `false` |
151+
| `--hostname` | Hostname pattern for V8 Tag loading | |
152+
| `--external-hostname` | Full external hostname (e.g., www.example.com) | |
153+
| `--external-domain` | External domain for Universal PWA SSR (e.g., example.com) | |
154+
| `--allow-cookies` | Forward HTTP cookies to origin | `false` |
155+
| `--no-allow-cookies` | Disable cookie forwarding | |
156+
| `--enable-source-maps` | Enable source map support in the environment | `false` |
157+
| `--no-enable-source-maps` | Disable source map support | |
158+
| `--json` | Output result as JSON | |
159159

160160
### Supported Regions
161161

@@ -221,10 +221,10 @@ b2c mrt env delete SLUG [FLAGS]
221221

222222
In addition to [global MRT flags](#global-mrt-flags):
223223

224-
| Flag | Short | Description | Default |
225-
|------|-------|-------------|---------|
226-
| `--force` | `-f` | Skip confirmation prompt | `false` |
227-
| `--json` | | Output result as JSON | |
224+
| Flag | Description | Default |
225+
|------|-------------|---------|
226+
| `--force`, `-f` | Skip confirmation prompt | `false` |
227+
| `--json` | Output result as JSON | |
228228

229229
### Examples
230230

‎docs/cli/ods.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ b2c ods list
5353

5454
### Flags
5555

56-
| Flag | Short | Description | Default |
57-
|------|-------|-------------|---------|
58-
| `--realm` | `-r` | Filter by realm ID (four-letter ID) | |
59-
| `--filter-params` | | Raw filter parameters (e.g., "realm=abcd&state=started") | |
60-
| `--show-deleted` | | Include deleted sandboxes in the list | `false` |
61-
| `--columns` | `-c` | Columns to display (comma-separated) | |
62-
| `--extended` | `-x` | Show all columns including extended fields | `false` |
56+
| Flag | Description | Default |
57+
|------|-------------|---------|
58+
| `--realm`, `-r` | Filter by realm ID (four-letter ID) | |
59+
| `--filter-params` | Raw filter parameters (e.g., "realm=abcd&state=started") | |
60+
| `--show-deleted` | Include deleted sandboxes in the list | `false` |
61+
| `--columns`, `-c` | Columns to display (comma-separated) | |
62+
| `--extended`, `-x` | Show all columns including extended fields | `false` |
6363

6464
### Available Columns
6565

@@ -110,16 +110,16 @@ b2c ods create --realm <REALM>
110110

111111
### Flags
112112

113-
| Flag | Short | Description | Default |
114-
|------|-------|-------------|---------|
115-
| `--realm` | `-r` | (Required) Realm ID (four-letter ID) | |
116-
| `--ttl` | | Time to live in hours (0 for infinite) | `24` |
117-
| `--profile` | | Resource profile (medium, large, xlarge, xxlarge) | `medium` |
118-
| `--auto-scheduled` | | Enable automatic start/stop scheduling | `false` |
119-
| `--wait` | `-w` | Wait for sandbox to reach started or failed state | `false` |
120-
| `--poll-interval` | | Polling interval in seconds when using --wait | `10` |
121-
| `--timeout` | | Maximum wait time in seconds (0 for no timeout) | `600` |
122-
| `--set-permissions` | | Automatically set OCAPI and WebDAV permissions | |
113+
| Flag | Description | Default |
114+
|------|-------------|---------|
115+
| `--realm`, `-r` | (Required) Realm ID (four-letter ID) | |
116+
| `--ttl` | Time to live in hours (0 for infinite) | `24` |
117+
| `--profile` | Resource profile (medium, large, xlarge, xxlarge) | `medium` |
118+
| `--auto-scheduled` | Enable automatic start/stop scheduling | `false` |
119+
| `--wait`, `-w` | Wait for sandbox to reach started or failed state | `false` |
120+
| `--poll-interval` | Polling interval in seconds when using --wait | `10` |
121+
| `--timeout` | Maximum wait time in seconds (0 for no timeout) | `600` |
122+
| `--set-permissions` | Automatically set OCAPI and WebDAV permissions | |
123123

124124
### Examples
125125

@@ -324,9 +324,9 @@ b2c ods delete <SANDBOXID>
324324

325325
### Flags
326326

327-
| Flag | Short | Description | Default |
328-
|------|-------|-------------|---------|
329-
| `--force` | `-f` | Skip confirmation prompt | `false` |
327+
| Flag | Description | Default |
328+
|------|-------------|---------|
329+
| `--force`, `-f` | Skip confirmation prompt | `false` |
330330

331331
### Examples
332332

‎docs/cli/webdav.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ These flags are available on all WebDAV commands:
88

99
### Root Directory
1010

11-
| Flag | Short | Description | Default |
12-
|------|-------|-------------|---------|
13-
| `--root` | `-r` | WebDAV root directory | `impex` |
11+
| Flag | Description | Default |
12+
|------|-------------|---------|
13+
| `--root`, `-r` | WebDAV root directory | `impex` |
1414

1515
Available roots:
1616

@@ -239,9 +239,9 @@ b2c webdav rm <PATH>
239239

240240
### Flags
241241

242-
| Flag | Short | Description | Default |
243-
|------|-------|-------------|---------|
244-
| `--force` | `-f` | Skip confirmation prompt | `false` |
242+
| Flag | Description | Default |
243+
|------|-------------|---------|
244+
| `--force`, `-f` | Skip confirmation prompt | `false` |
245245

246246
### Examples
247247

0 commit comments

Comments
 (0)