Merge pull request eclipse-iceoryx#106 from orecham/iox2-98-entrypoin…

…t-for-iox2-cli

[eclipse-iceoryx#98] Add entrypoint for iox2 cli

Cargo.toml

@@ -21,6 +21,14 @@ members = [
     "iceoryx2-pal/posix/",
     "iceoryx2-pal/configuration/",
 
+    "iceoryx2-cli/iox2",
+    "iceoryx2-cli/iox2-introspect",
+    "iceoryx2-cli/iox2-processes",
+    "iceoryx2-cli/iox2-pub",
+    "iceoryx2-cli/iox2-rpc",
+    "iceoryx2-cli/iox2-services",
+    "iceoryx2-cli/iox2-sub",
+
     "examples",
 
     "benchmarks/publish-subscribe",
@@ -69,7 +77,10 @@ cc = { version = "1.0.98" }
 cdr = { version = "0.2.4" }
 clap = { version = "4.5.4", features = ["derive"] }
 enum-iterator = { version = "2.1.0" }
+better-panic = { version = "0.3.0" }
+colored = { version = "2.1" }
 generic-tests = { version = "0.1.2" }
+human-panic = { version = "1.2.3" }
 lazy_static = { version = "1.4.0" }
 log = { version = "0.4.21" }
 once_cell = { version = "1.19.0" }
@@ -82,6 +93,7 @@ serde_test = { version = "1.0.176" }
 sha1_smol = { version = "1.0.0" }
 syn = { version = "2.0.66", features = ["full"] }
 termsize = { version = "0.1.6" }
+thiserror = { version = "1.0.56" }
 tiny-fn = { version = "0.1.5" }
 toml = { version = "0.8.13" }
 tracing = { version = "0.1.40" }

doc/release-notes/iceoryx2-unreleased.md

@@ -9,6 +9,8 @@
  <!-- NOTE: Add new entries sorted by issue number to minimize the possibility of conflicts when merging. -->
 
  * Subscriber buffer size can be reduced [#19](https://github.com/eclipse-iceoryx/iceoryx2/issues/19)
+ * CLI for iox2 [#98](https://github.com/eclipse-iceoryx/iceoryx2/issues/98)
+    * Add entrypoint CLI `iox2` in preparation for adding additional CLI commands
  * Introduce Nodes [#102](https://github.com/eclipse-iceoryx/iceoryx2/issues/102)
     * Implement Serialize,Deserialize for
         * `SemanticString`

iceoryx2-cli/iox2-introspect/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "iox2-introspect"
+description = "Iceoryx2: CLI for introspecting iceoryx 2 internals"
+categories = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

iceoryx2-cli/iox2-introspect/src/main.rs

@@ -0,0 +1,15 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+fn main() {
+    println!("Not implemented. Stay tuned!");
+}

iceoryx2-cli/iox2-processes/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "iox2-processes"
+description = "Iceoryx2: CLI for managing iceoryx2 processes"
+categories = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

iceoryx2-cli/iox2-processes/src/main.rs

@@ -0,0 +1,15 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+fn main() {
+    println!("Not implemented. Stay tuned!");
+}

iceoryx2-cli/iox2-pub/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "iox2-pub"
+description = "Iceoryx2: CLI for publishing to iceoryx2"
+categories = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

iceoryx2-cli/iox2-pub/src/main.rs

@@ -0,0 +1,15 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+fn main() {
+    println!("Not implemented. Stay tuned!");
+}

iceoryx2-cli/iox2-rpc/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "iox2-rpc"
+description = "Iceoryx2: CLI for rpc operations"
+categories = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

iceoryx2-cli/iox2-rpc/src/main.rs

@@ -0,0 +1,15 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+fn main() {
+    println!("Not implemented. Stay tuned!");
+}

iceoryx2-cli/iox2-services/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "iox2-services"
+description = "Iceoryx2: CLI for managing iceoryx2 services"
+categories = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

iceoryx2-cli/iox2-services/src/main.rs

@@ -0,0 +1,15 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+fn main() {
+    println!("Not implemented. Stay tuned!");
+}

iceoryx2-cli/iox2-sub/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "iox2-sub"
+description = "Iceoryx2: CLI for subscribing to iceoryx2"
+categories = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

iceoryx2-cli/iox2-sub/src/main.rs

@@ -0,0 +1,15 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+fn main() {
+    println!("Not implemented. Stay tuned!");
+}

iceoryx2-cli/iox2/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "iox2"
+description = "Iceoryx2: CLI entry-point"
+categories = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+keywords = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+[dependencies]
+human-panic = { workspace = true }
+better-panic = { workspace = true }
+clap = { workspace = true }
+colored = { workspace = true }
+thiserror = { workspace = true }

iceoryx2-cli/iox2/src/cli.rs

@@ -0,0 +1,59 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+use clap::Parser;
+use colored::*;
+
+#[derive(Parser, Debug)]
+#[command(
+    name = "iox2",
+    about = "The command-line interface to iceoryx2",
+    long_about = None,
+    version = env!("CARGO_PKG_VERSION"),
+    disable_help_subcommand = true,
+    arg_required_else_help = true,
+    help_template = help_template(),
+)]
+pub struct Cli {
+    #[arg(short, long, help = "List all installed commands")]
+    pub list: bool,
+
+    #[arg(
+        short,
+        long,
+        help = "Display paths that will be checked for installed commands"
+    )]
+    pub paths: bool,
+
+    #[arg(
+        short,
+        long,
+        help = "Specify to execute development versions of commands if they exist"
+    )]
+    pub dev: bool,
+
+    #[arg(hide = true, required = false)]
+    pub external_command: Vec<String>,
+}
+
+fn help_template() -> String {
+    format!(
+        "{}{}{}\n\n{}\n{{options}}\n\n{}\n{{subcommands}}{}{}",
+        "Usage: ".bright_green().bold(),
+        "iox2 ".bold(),
+        "[OPTIONS] [COMMAND]",
+        "Options:".bright_green().bold(),
+        "Commands:".bright_green().bold(),
+        "  ...         ".bold(),
+        "See all installed commands with --list"
+    )
+}