1
0
mirror of https://github.com/containers/youki synced 2024-09-20 19:02:41 +02:00
youki/crates/liboci-cli/README.md
David Gibson ea448d05a8 Add some rudimentary documentation to the liboci-cli crate
In particular it has a summary of what subcommands implemented by various
runtimes are included in the frontend crate so far.

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2021-12-03 12:41:50 +11:00

27 lines
1.5 KiB
Markdown

# liboci-cli
This is a crate to parse command line arguments for OCI container
runtimes as specified in the [OCI Runtime Command Line
Interface][https://github.com/opencontainers/runtime-tools/blob/master/docs/command-line-interface.md).
## Implemented subcommands
| Command | liboci-cli | CLI Specification | runc | crun | youki |
| :--------: | :--------: | :---------------: | :--: | :--: | :---: |
| create | ✅ | ✅ | ✅ | ✅ | ✅ |
| start | ✅ | ✅ | ✅ | ✅ | ✅ |
| state | ✅ | ✅ | ✅ | ✅ | ✅ |
| kill | ✅ | ✅ | ✅ | ✅ | ✅ |
| delete | ✅ | ✅ | ✅ | ✅ | ✅ |
| checkpoint | | | ✅ | ✅ | |
| events | | | ✅ | | ✅ |
| exec | | | ✅ | ✅ | ✅ |
| list | | | ✅ | ✅ | ✅ |
| pause | | | ✅ | ✅ | ✅ |
| ps | | | ✅ | ✅ | ✅ |
| restore | | | ✅ | ✅ | |
| resume | | | ✅ | ✅ | ✅ |
| run | | | ✅ | ✅ | ✅ |
| spec | | | ✅ | ✅ | ✅ |
| update | | | ✅ | ✅ | |