feat(esp_cli_commands): Rename the component to esp_cli_commands

Author: SoucheSouche

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -32,7 +32,7 @@ body:
         - eigen
         - esp_daylight
         - esp_delta_ota
-        - esp_commands
+        - esp_cli_commands
         - esp_encrypted_img
         - esp_flash_dispatcher
         - esp_gcov

.github/workflows/upload_component.yml

@@ -34,7 +34,7 @@ jobs:
             dhara
             eigen
             esp_daylight
-            esp_commands
+            esp_cli_commands
             esp_delta_ota
             esp_encrypted_img
             esp_flash_dispatcher

.idf_build_apps.toml

@@ -8,7 +8,7 @@ manifest_file = [
     "ccomp_timer/.build-test-rules.yml",
     "coremark/.build-test-rules.yml",
     "esp_daylight/.build-test-rules.yml",
-    "esp_commands/.build-test-rules.yml",
+    "esp_cli_commands/.build-test-rules.yml",
     "esp_encrypted_img/.build-test-rules.yml",
     "esp_flash_dispatcher/.build-test-rules.yml",
     "esp_gcov/.build-test-rules.yml",

esp_commands/.build-test-rules.yml renamed to esp_cli_commands/.build-test-rules.yml

@@ -1,3 +1,3 @@
-esp_commands/test_apps:
+esp_cli_commands/test_apps:
   enable:
     - if: (IDF_TARGET in ["esp32", "linux"]) and (IDF_VERSION_MAJOR == 5 and IDF_VERSION_MINOR >= 3)

esp_commands/CMakeLists.txt renamed to esp_cli_commands/CMakeLists.txt

@@ -1,8 +1,8 @@
 idf_build_get_property(idf_target IDF_TARGET)
 
-set(srcs "src/esp_commands.c"
-         "src/esp_dynamic_commands.c"
-         "src/esp_commands_helpers.c")
+set(srcs "src/esp_cli_commands.c"
+         "src/esp_cli_dynamic_commands.c"
+         "src/esp_cli_commands_helpers.c")
 
 idf_component_register(
     SRCS ${srcs}
@@ -13,5 +13,5 @@ idf_component_register(
 
 if(${idf_target} STREQUAL "linux")
     # Add custom ld file 
-    target_link_options(${COMPONENT_TARGET} INTERFACE "-Wl,-T,${CMAKE_CURRENT_SOURCE_DIR}/linux/esp_commands.ld")
+    target_link_options(${COMPONENT_TARGET} INTERFACE "-Wl,-T,${CMAKE_CURRENT_SOURCE_DIR}/linux/esp_cli_commands.ld")
 endif()

esp_commands/LICENSE renamed to esp_cli_commands/LICENSE

@@ -1,6 +1,6 @@
 # ESP Commands
 
-The `esp_commands` component provides a flexible command registration and execution framework for ESP-IDF applications.  
+The `esp_cli_commands` component provides a flexible command registration and execution framework for ESP-IDF applications.  
 It allows applications to define console-like commands with metadata (help text, hints, glossary entries) and register them dynamically or statically.
 
 ---
@@ -25,17 +25,17 @@ It allows applications to define console-like commands with metadata (help text,
 By default, the component is initialized with a default configuration. It is however possible for the user to update this configuration with the call of the following API:
 
 ```c
-esp_commands_config_t config = {
+esp_cli_commands_config_t config = {
     .heap_caps_used = <user specific value>,
     .max_cmdline_length = <user specific value>,
     .max_cmdline_args = <user specific value>,
     .hint_color = <user specific value>,
     .hint_bold = <user specific value>
 };
-esp_commands_update_config(&config);
+esp_cli_commands_update_config(&config);
 ```
 
-- `write_func`: The custom write function used by esp_commands to output data (default to posix write is not specified)
+- `write_func`: The custom write function used by esp_cli_commands to output data (default to posix write is not specified)
 - `max_cmdline_length`: Maximum command line buffer length (bytes).
 - `max_cmdline_args`: Maximum number of arguments parsed.
 - `hint_color`: ANSI color code used for hints.
@@ -47,49 +47,49 @@ esp_commands_update_config(&config);
 
 ### Command Structure
 
-A command is described by the `esp_command_t` struct:
+A command is described by the `esp_cli_command_t` struct:
 
 ```c
-typedef struct esp_command {
+typedef struct esp_cli_command {
     const char *name;                     /*!< Command name */
     const char *group;                    /*!< Group/category */
     const char *help;                     /*!< Short help text */
-    esp_command_func_t func;              /*!< Command implementation */
+    esp_cli_command_func_t func;              /*!< Command implementation */
     void *func_ctx;                       /*!< User context */
-    esp_command_hint_t hint_cb;           /*!< Hint callback */
-    esp_command_glossary_t glossary_cb;   /*!< Glossary callback */
-} esp_command_t;
+    esp_cli_command_hint_t hint_cb;           /*!< Hint callback */
+    esp_cli_command_glossary_t glossary_cb;   /*!< Glossary callback */
+} esp_cli_command_t;
 ```
 
 ### Static Registration
 
-Use the `ESP_COMMAND_REGISTER` macro to register a command at compile time:
+Use the `ESP_CLI_COMMAND_REGISTER` macro to register a command at compile time:
 
 ```c
-static int my_cmd(void *context, esp_commands_exec_arg_t *cmd_arg, int argc, char **argv) {
+static int my_cmd(void *context, esp_cli_commands_exec_arg_t *cmd_arg, int argc, char **argv) {
     printf("Hello from my_cmd!\n");
     return 0;
 }
 
-ESP_COMMAND_REGISTER(my_cmd, tools, "Prints hello", my_cmd, NULL, NULL, NULL);
+ESP_CLI_COMMAND_REGISTER(my_cmd, tools, "Prints hello", my_cmd, NULL, NULL, NULL);
 ```
 
-This places the command into the `.esp_commands` section in flash.
+This places the command into the `.esp_cli_commands` section in flash.
 
 ### Dynamic Registration
 
 Commands can also be registered/unregistered at runtime:
 
 ```c
-esp_command_t cmd = {
+esp_cli_command_t cmd = {
     .name = "my_cmd",
     .group = "tools",
     .help = "Prints hello",
     .func = my_cmd,
 };
 
-esp_commands_register_cmd(&cmd);
-esp_commands_unregister_cmd("echo");
+esp_cli_commands_register_cmd(&cmd);
+esp_cli_commands_unregister_cmd("echo");
 ```
 
 ---
@@ -100,7 +100,7 @@ Commands can be executed from a command line string:
 
 ```c
 int cmd_ret;
-esp_err_t ret = esp_commands_execute("my_cmd arg1 arg2", &cmd_ret, NULL, STDOUT_FILENO);
+esp_err_t ret = esp_cli_commands_execute("my_cmd arg1 arg2", &cmd_ret, NULL, STDOUT_FILENO);
 ```
 
 - `cmd_set`: Limits execution to a set of commands (or `NULL` for all commands).
@@ -115,9 +115,9 @@ esp_err_t ret = esp_commands_execute("my_cmd arg1 arg2", &cmd_ret, NULL, STDOUT_
 Completion & Help APIs:
 
 ```c
-esp_commands_get_completion(NULL, "ec", completion_cb);
-const char *hint = esp_commands_get_hint(NULL, "echo", &color, &bold);
-const char *glossary = esp_commands_get_glossary(NULL, "echo");
+esp_cli_commands_get_completion(NULL, "ec", completion_cb);
+const char *hint = esp_cli_commands_get_hint(NULL, "echo", &color, &bold);
+const char *glossary = esp_cli_commands_get_glossary(NULL, "echo");
 ```
 
 - **Completion**: Suggests matching commands.
@@ -132,15 +132,15 @@ Command sets allow grouping subsets of commands for filtering:
 
 ```c
 const char *cmd_names[] = {"echo", "my_cmd"};
-esp_command_set_handle_t set =
-    ESP_COMMANDS_CREATE_CMD_SET(cmd_names, FIELD_ACCESSOR(name));
+esp_cli_command_set_handle_t set =
+    ESP_CLI_COMMANDS_CREATE_CMD_SET(cmd_names, ESP_CLI_COMMAND_FIELD_ACCESSOR(name));
 
-esp_commands_execute("my_cmd", NULL, set, NULL);
-esp_commands_destroy_cmd_set(&set);
+esp_cli_commands_execute("my_cmd", NULL, set, NULL);
+esp_cli_commands_destroy_cmd_set(&set);
 ```
 
 - Create sets by name, group, or other fields.
-- Concatenate sets with `esp_commands_concat_cmd_set()`.
+- Concatenate sets with `esp_cli_commands_concat_cmd_set()`.
 - Destroy sets when no longer needed.
 
 ---
@@ -149,7 +149,7 @@ esp_commands_destroy_cmd_set(&set);
 
 ```c
 #include <stdio.h>
-#include "esp_commands.h"
+#include "esp_cli_commands.h"
 
 // Example command function
 static int hello_cmd(void *ctx, int argc, char **argv) {
@@ -158,22 +158,22 @@ static int hello_cmd(void *ctx, int argc, char **argv) {
 }
 
 // Register command statically
-ESP_COMMAND_REGISTER(hello_cmd, demo, "Prints a hello message", hello_cmd, NULL, NULL, NULL);
+ESP_CLI_COMMAND_REGISTER(hello_cmd, demo, "Prints a hello message", hello_cmd, NULL, NULL, NULL);
 
 void app_main(void) {
     // Update configuration (optional)
-    esp_commands_config_t config = {
+    esp_cli_commands_config_t config = {
         .heap_caps_used = MALLOC_CAP_INTERNAL,
         .max_cmdline_length = 64,
         .max_cmdline_args = 4,
         .hint_color = 31, // Red foreground
         .hint_bold = true
     };
-    esp_commands_update_config(&config);
+    esp_cli_commands_update_config(&config);
 
     // Execute command
     int ret_val;
-    esp_err_t ret = esp_commands_execute("hello_cmd", &ret_val, NULL, NULL);
+    esp_err_t ret = esp_cli_commands_execute("hello_cmd", &ret_val, NULL, NULL);
     if (ret == ESP_OK) {
         printf("Command executed successfully, return value: %d\n", ret_val);
     } else {
@@ -186,10 +186,10 @@ void app_main(void) {
 
 ## API Reference
 
-- **Configuration**: `esp_commands_update_config()`
-- **Registration**: `esp_commands_register_cmd()`, `esp_commands_unregister_cmd()`
-- **Execution**: `esp_commands_execute()`, `esp_commands_find_command()`
-- **Completion & Help APIs**: `esp_commands_get_completion()`, `esp_commands_get_hint()`, `esp_commands_get_glossary()`
-- **Command Sets**: `esp_commands_create_cmd_set()`, `esp_commands_concat_cmd_set()`, `esp_commands_destroy_cmd_set()`
+- **Configuration**: `esp_cli_commands_update_config()`
+- **Registration**: `esp_cli_commands_register_cmd()`, `esp_cli_commands_unregister_cmd()`
+- **Execution**: `esp_cli_commands_execute()`, `esp_cli_commands_find_command()`
+- **Completion & Help APIs**: `esp_cli_commands_get_completion()`, `esp_cli_commands_get_hint()`, `esp_cli_commands_get_glossary()`
+- **Command Sets**: `esp_cli_commands_create_cmd_set()`, `esp_cli_commands_concat_cmd_set()`, `esp_cli_commands_destroy_cmd_set()`
 
 ---

esp_commands/README.md renamed to esp_cli_commands/README.md

@@ -1,9 +1,9 @@
 version: "0.1.0"
-description: "esp_commands - Command handling component"
-url: https://github.com/espressif/idf-extra-components/tree/master/esp_commands
+description: "esp_cli_commands - Command handling component"
+url: https://github.com/espressif/idf-extra-components/tree/master/esp_cli_commands
 dependencies:
   idf: ">=5.3"
 sbom:
   manifests:
-    - path: sbom_esp_commands.yml
+    - path: sbom_esp_cli_commands.yml
       dest: .