1
0
mirror of https://github.com/containers/youki synced 2025-11-10 19:08:42 +01:00
youki/crates/liboci-cli/README.md
Christophe de Dinechin b9b5fa877b
Liboci additional flags and subcommands, as required by ociplex (#2149)
Add the missing OCI cli options and change options order

- checkpoint:

Add the missing command-line options as documented for runc, and also reorder
the options to match the documentation:
https://github.com/opencontainers/runc/blob/main/man/runc-checkpoint.8.md

(This does not mean that they are necessarily implemented)

- no-pivot:

The --no-pivot option is documented in
https://github.com/opencontainers/runc/blob/main/man/runc-create.8.md

Also change the options order in order to match the doc, this makes the code a
bit easier to maintain.

- exec:

Add the missing command-line options for the exec subcommand.
Reference: https://github.com/opencontainers/runc/blob/main/man/runc-exec.8.md

- run:

Also change the order to match the documentation in
https://github.com/opencontainers/runc/blob/main/man/runc-run.8.md

- update

Add command-line options as documented in
https://github.com/opencontainers/runc/blob/main/man/runc-update.8.md

- spec:

Add the missing bundle option, as documented in
https://github.com/opencontainers/runc/blob/main/man/runc-spec.8.md

- features

The 'features' subcommand is not publicly documented yet, but it was introduced
in `runc` in https://github.com/opencontainers/runc/pull/3296.

- liboci-cli: Update README with information about features subcommand

The `features` subcommand is  implemented in `runc`, but not documented.
See https://github.com/opencontainers/runc/pull/3296

- list: Add missing command-line options

Add the command-line options documented in

-------

Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
Signed-off-by: yihuaf <yihuaf@unkies.org>
Co-authored-by: yihuaf <yihuaf@unkies.org>
2023-07-13 14:17:01 -07:00

28 lines
1.6 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 | ✅ | | ✅ | ✅ | ✅ |
| features | ✅ | | ✅ | | |
| list | ✅ | | ✅ | ✅ | ✅ |
| pause | ✅ | | ✅ | ✅ | ✅ |
| ps | ✅ | | ✅ | ✅ | ✅ |
| restore | | | ✅ | ✅ | |
| resume | ✅ | | ✅ | ✅ | ✅ |
| run | ✅ | | ✅ | ✅ | ✅ |
| spec | ✅ | | ✅ | ✅ | ✅ |
| update | | | ✅ | ✅ | |