Skip to content

Commit ffa124c

Browse files
committed
Add a 'version' command
Make it easy for a caller to report which runtime they're using. Signed-off-by: W. Trevor King <[email protected]>
1 parent 11da397 commit ffa124c

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

runtime.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,29 @@ Global options may take positional arguments (e.g. `--log-level debug`), but the
1616

1717
## Commands
1818

19+
### version
20+
21+
* *Options* None are required, but the runtime may support options.
22+
* *Standard streams*
23+
* *stdin:* The runtime may not attempt to read from its stdin.
24+
* *stdout:* The runtime must print its name, a space, and its version as the first line to its stdout.
25+
The name may contain any Unicode characters except a control codes and newlines.
26+
The runtime may print additional lines its stdout, and the format for those lines is not specified in this document.
27+
* *stderr:* The runtime may print diagnostic messages to stderr, and the format for those lines is not specified in this document.
28+
* *Exit code:* The runtime must exit with zero.
29+
30+
Print the runtime version and exit.
31+
The version
32+
33+
Example:
34+
```sh
35+
$ funC version
36+
funC 1.0.0
37+
Built for x86_64-pc-linux-gnu
38+
$ echo $?
39+
0
40+
```
41+
1942
### start
2043

2144
Starts a container from a bundle directory.

0 commit comments

Comments
 (0)