Skip to content

Commit a7fd948

Browse files
chore: update cli documentation for score-compore resources list (#162)
2 parents 3ff7963 + 2623e45 commit a7fd948

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

content/en/docs/score implementation/score-compose/cli.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,16 @@ Lists the unique identifiers (UIDs) of all provisioned resources.
256256
score-compose resources list
257257
```
258258

259+
##### Flags
260+
261+
###### `--format` | `-f`
262+
263+
Display listed resources in the format provided. Uses `table` as default value. Allowed values: `table`, `json`
264+
265+
```bash
266+
score-compose resources list --format json
267+
```
268+
259269
### Flags
260270

261271
#### `--help` | `-h`
@@ -306,12 +316,12 @@ score-compose provisioners list [flags]
306316

307317
##### Flags
308318

309-
###### --format | -f
319+
###### `--format` | `-f`
310320

311321
Display listed provisioners in the format provided. Uses `table` as default value. Allowed values: `table`, `json`
312322

313323
```bash
314-
score-compose provisioners list --fornat json
324+
score-compose provisioners list --format json
315325
```
316326

317327
### Flags

content/en/docs/score implementation/score-compose/resources-provisioners.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ aliases:
2727
| `service-port` | (any) | `workload`, `port` | `hostname`, `port` |
2828
| `s3` | (any) | (none) | `endpoint`, `access_key_id`, `secret_key`, `bucket`, with `region=""`, `aws_access_key_id=<access_key_id>`, and `aws_secret_key=<secret_key>` for compatibility |
2929
| `volume` | (any) | (none) | `source` |
30-
| mssql | (any) | (none) | `server`, `port`, `connection`, `database`, `username`, `password` |
30+
| `mssql` | (any) | (none) | `server`, `port`, `connection`, `database`, `username`, `password` |
3131

3232
These can be found in the default provisioners file. You are encouraged to write your own provisioners and add them to the `.score-compose` directory (with the `.provisioners.yaml` extension) or contribute them upstream to the [default.provisioners.yaml](https://github.com/score-spec/score-compose/blob/main/internal/command/default.provisioners.yaml) file.
3333

0 commit comments

Comments
 (0)