Skip to content

Commit 122ae08

Browse files
Resources command update in score-compose and score-k8s cli files (#158)
2 parents f36e32b + 1309ec2 commit 122ae08

File tree

2 files changed

+114
-2
lines changed
  • content/en/docs/score implementation

2 files changed

+114
-2
lines changed

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,62 @@ Displays help output for the `run` command.
230230
score-compose run -h
231231
```
232232

233+
## `resources`
234+
235+
The `resources` command provides subcommands related to provisioned resources in `score-compose`.
236+
237+
```bash
238+
score-compose resources [command]
239+
```
240+
241+
### Subcommands
242+
243+
#### `get-outputs`
244+
245+
Returns the outputs of provisioned resources. This command retrieves values that can be used by workloads or other processes.
246+
247+
```bash
248+
score-compose resources get-outputs
249+
```
250+
251+
#### `list`
252+
253+
Lists the unique identifiers (UIDs) of all provisioned resources.
254+
255+
```bash
256+
score-compose resources list
257+
```
258+
259+
### Flags
260+
261+
#### `--help` | `-h`
262+
263+
Displays help information for the `resources` command, including its available subcommands.
264+
265+
```bash
266+
score-compose resources --help
267+
```
268+
269+
### Global Flags
270+
271+
These flags apply to all `score-compose resources` commands:
272+
273+
#### `--quiet`
274+
275+
Mutes any logging output.
276+
277+
```bash
278+
score-compose resources --quiet
279+
```
280+
281+
#### `--verbose count` | `-v`
282+
283+
Increases log verbosity and detail by specifying this flag one or more times.
284+
285+
```bash
286+
score-compose resources --verbose
287+
```
288+
233289
## `help`
234290

235291
The help command provides information on all commands.

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

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ linkTitle: "CLI reference"
44
description: "CLI reference for score-k8s"
55
weight: 2
66
aliases:
7-
- /docs/reference/score-cli/score-k8s/cli
7+
- /docs/reference/score-cli/score-k8s/cli
88
---
99

1010
The `score-k8s` CLI provides a set of commands and flags to enable the generation of Kubernetes manifests from Score specifications.
@@ -173,9 +173,65 @@ Displays help information for `completion`, providing a short description of the
173173
score-k8s completion --help
174174
```
175175

176+
## `resources`
177+
178+
The `resources` command provides subcommands related to provisioned resources in `score-k8s`.
179+
180+
```bash
181+
score-k8s resources [command]
182+
```
183+
184+
### Subcommands
185+
186+
#### `get-outputs`
187+
188+
Returns the outputs of provisioned resources. This command retrieves values that can be used by workloads or other processes.
189+
190+
```bash
191+
score-k8s resources get-outputs
192+
```
193+
194+
#### `list`
195+
196+
Lists the unique identifiers (UIDs) of all provisioned resources.
197+
198+
```bash
199+
score-k8s resources list
200+
```
201+
202+
### Flags
203+
204+
#### `--help` | `-h`
205+
206+
Displays help information for the `resources` command, including its available subcommands.
207+
208+
```bash
209+
score-k8s resources --help
210+
```
211+
212+
### Global Flags
213+
214+
These flags apply to all `score-k8s resources` commands:
215+
216+
#### `--quiet`
217+
218+
Mutes any logging output.
219+
220+
```bash
221+
score-k8s resources --quiet
222+
```
223+
224+
#### `--verbose count` | `-v`
225+
226+
Increases log verbosity and detail by specifying this flag one or more times.
227+
228+
```bash
229+
score-k8s resources --verbose
230+
```
231+
176232
## `help`
177233

178-
The `help` command provides information on all commands.
234+
The help command provides information on all commands.
179235

180236
```bash
181237
score-k8s help [command] [flags]

0 commit comments

Comments
 (0)