diff --git a/Cargo.lock b/Cargo.lock index 1e49c94..12bed4c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2401,7 +2401,7 @@ dependencies = [ [[package]] name = "omnect-cli" -version = "0.24.15" +version = "0.24.16" dependencies = [ "actix-web", "anyhow", diff --git a/Cargo.toml b/Cargo.toml index 84a2434..a11635a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT OR Apache-2.0" name = "omnect-cli" readme = "README.md" repository = "https://github.com/omnect/omnect-cli" -version = "0.24.15" +version = "0.24.16" [dependencies] actix-web = "4.9" diff --git a/src/cli.rs b/src/cli.rs index 62ae41e..551ccfb 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -13,7 +13,14 @@ const COPYRIGHT: &str = "Copyright © 2021 by conplement AG"; #[command(after_help = COPYRIGHT)] /// manage docker containers in a firmware image pub enum Docker { - /// pull and inject a docker image (not supported via omnect-ui container) + /// pull and inject a docker image into the factory partition. + /// + /// Note: This command injects the docker image into the factory partition. + /// Therefore, the injected image will remain there even after factory + /// resets. + /// + /// Furthermore, the command is currently only supported for native + /// omnect-cli, i.e., it will not work for the omnect-cli docker image. Inject { /// full qualified name of the docker image #[clap(short = 'd', long = "docker-image", required(true))] @@ -313,7 +320,9 @@ pub enum SshConfig { compress_image: Option, }, - /// set ssh connection parameters (currently not working in docker image) + /// set ssh connection parameters (see + /// https://github.com/omnect/omnect-cli?tab=readme-ov-file#usage-with-docker + /// for details on how to use this command with the docker image) SetConnection { /// username for the login on the device. #[arg(short = 'u', long = "user", default_value = "omnect")]