@@ -11,11 +11,21 @@ bootc-status - Display status
11
11
12
12
Display status
13
13
14
- This will output a YAML-formatted object using a schema intended to
15
- match a Kubernetes resource that describes the state of the booted
16
- system.
14
+ If standard output is a terminal, this will output a description of the
15
+ bootc system state. If standard output is not a terminal, output a
16
+ YAML-formatted object using a schema intended to match a Kubernetes
17
+ resource that describes the state of the booted system.
17
18
18
- The exact API format is not currently declared stable.
19
+ ## Parsing output via programs
20
+
21
+ Either the default YAML format or \`\- -format=json\` can be used. Do not
22
+ attempt to explicitly parse the output of \`\- -format=humanreadable\` as
23
+ it will very likely change over time.
24
+
25
+ ## Programmatically detecting whether the system is deployed via bootc
26
+
27
+ Invoke e.g. \` bootc status \- -json\` , and check if \` status.booted\` is
28
+ not \` null\` .
19
29
20
30
# OPTIONS
21
31
@@ -26,16 +36,18 @@ The exact API format is not currently declared stable.
26
36
\
27
37
* Possible values:*
28
38
39
+ > - humanreadable: Output in Human Readable format
40
+ >
29
41
> - yaml: Output in YAML format
30
42
>
31
43
> - json: Output in JSON format
32
44
33
45
** \- -format-version** =* FORMAT_VERSION*
34
46
35
47
: The desired format version. There is currently one supported
36
- version, which is version \` 0\` . Pass this option to explicitly
37
- request it; it is possible that multiple versions will be supported
38
- in the future
48
+ version, which is exposed as both \` 0\` and \` 1 \` . Pass this option
49
+ to explicitly request it; it is possible that another future version
50
+ 2 or newer will be supported in the future
39
51
40
52
** \- -booted**
41
53
@@ -47,4 +59,4 @@ The exact API format is not currently declared stable.
47
59
48
60
# VERSION
49
61
50
- v0.1.13
62
+ v0.1.16
0 commit comments