Skip to content

docs: fix outdated docs #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
empwilli merged 4 commits into from
Mar 17, 2025
Merged

docs: fix outdated docs #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f77b7c0
docs: add note on how to run set connection in docker container
empwilli Mar 14, 2025
c59305e
docs: fix invalid help string for docker inject command
empwilli Mar 14, 2025
8b128d8
chore: bump version to 0.24.16
empwilli Mar 14, 2025
0767914
docs: fix errors in CLI command docs
empwilli Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
13 changes: 11 additions & 2 deletions src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))]
Expand Down Expand Up @@ -313,7 +320,9 @@ pub enum SshConfig {
compress_image: Option<Compression>,
},

/// 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")]
Expand Down
Loading