{"id":95,"date":"2024-11-14T18:53:26","date_gmt":"2024-11-14T17:53:26","guid":{"rendered":"https:\/\/aralez.co\/index.php\/docs\/documentation\/2-getting-started\/usage\/"},"modified":"2025-09-11T12:50:52","modified_gmt":"2025-09-11T10:50:52","password":"","slug":"usage","status":"publish","type":"docs","link":"https:\/\/aralez.co\/index.php\/docs\/usage\/","title":{"rendered":"Usage (Windows)"},"content":{"rendered":"\n

This section provides a detailed guide on how to use Aralez<\/strong>, including available options, commands, and example workflows to maximize its utility.<\/p>\n\n\n\n

<\/div>\n\n\n\n

Basic Command<\/strong><\/h4>\n\n\n\n

The tool can be executed with the following syntax:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
aralez.exe<\/span> [OPTIONS]<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
The OPTIONS<\/span> parameter allows you to customize the behavior of the tool, such as enabling debug mode, displaying configuration details, or modifying the embedded configuration.<\/p>\n\n\n\n
\n
Important<\/strong>: Aralez should be executed with administrator privilege with PowerShell or CMD on Windows.<\/em><\/p>\n<\/blockquote>\n\n\n\n
<\/div>\n\n\n\n
Options<\/h5>\n\n\n\n
\n
\n
--debug<\/span><\/code><\/strong><\/h6>\n<\/div>\n\n\n\n
\n
Description<\/strong>: Activates debug mode to provide detailed logs and verbose output during execution. This option is useful for troubleshooting and monitoring the internal workings of the tool.<\/p>\n\n\n\n
Example Usage<\/strong>:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
aralez.exe<\/span> <\/span>--debug<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Behavior<\/strong>: Outputs additional runtime information, including executed tasks, configuration details, and potential issues on the console.<\/p>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
--show_config<\/code><\/strong><\/span><\/code><\/strong><\/h6>\n<\/div>\n\n\n\n
\n
Description<\/strong>: Displays the current embedded configuration file in YAML format without executing any tasks.<\/p>\n\n\n\n
Example Usage<\/strong>:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
aralez.exe<\/span> <\/span>--show_config<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Behavior<\/strong>: Loads the embedded configuration and prints it to the console for review or debugging.<\/p>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
--change_config <\/code><\/strong><\/code><\/strong><\/span><\/code><\/strong><\/h6>\n<\/div>\n\n\n\n
\n
Structure<\/strong>: –change_config <CONFIG_FILE> <OUTPUT_FILE><\/span><\/p>\n\n\n\n
Description<\/strong>: Updates the embedded configuration in the executable using CONFIG_FILE<\/span> and saves the updated version to OUTPUT_FILE<\/span>.<\/p>\n\n\n\n
\n
Important<\/strong>: If the new config is not valid, an error will be raised and the config won’t be updated.   <\/p>\n<\/blockquote>\n\n\n\n
Required Parameters<\/strong>:<\/p>\n\n\n\n
    \n
  • CONFIG_FILE<\/span><\/code>: Path to the new configuration file (in YAML format).<\/li>\n<\/ul>\n\n\n\n
    Example Usage<\/strong>:<\/p>\n\n\n\n
    <\/path><\/path><\/svg><\/span>
    aralez.exe<\/span> <\/span>--change_config<\/span> <\/span>new_config.yml<\/span> <\/span>new_aralez.exe<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
    Behavior<\/strong>: Creates a new_aralez.exe<\/code> binary with the updated configuration embedded, leaving the original executable untouched.<\/p>\n<\/div>\n<\/div>\n\n\n\n
    \n
    \n
    --check_config <\/code><\/strong><\/code><\/strong><\/span><\/code><\/strong><\/h6>\n<\/div>\n\n\n\n
    \n
    Description<\/strong>: Validates the current configuration file for correctness and potential errors.<\/p>\n\n\n\n
    Example Usage<\/strong>:<\/p>\n\n\n\n
    <\/path><\/path><\/svg><\/span>
    aralez.exe<\/span> <\/span>--check_config<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
    Behavior<\/strong>: Loads and parses the configuration file, checking for syntax or logical errors. Prints the validation result to the console.<\/p>\n<\/div>\n<\/div>\n\n\n\n
    \n
    \n
    --add_tool<\/code><\/strong><\/span><\/code><\/strong><\/h6>\n<\/div>\n\n\n\n
    \n
    Structure<\/strong>: --add_tool <EXECUTABLE_TOOL_PATH> <OUTPUT_FILE><\/code><\/span><\/p>\n\n\n\n
    Description<\/strong>: Adds a new external executable tool to the Aralez<\/strong> resource set.<\/p>\n\n\n\n
    Required Parameters<\/strong>:<\/p>\n\n\n\n
      \n
    • EXECUTABLE_TOOL_PATH<\/code><\/span><\/code>: Path to the external executable tool you want to add.<\/li>\n\n\n\n
    • OUTPUT_FILE<\/code><\/span><\/code>: Path to the output binary with the new tool embedded.<\/li>\n<\/ul>\n\n\n\n
      Example Usage<\/strong>:<\/p>\n\n\n\n
      <\/path><\/path><\/svg><\/span>
      aralez.exe<\/span> <\/span>--add_tool<\/span> <\/span>tool.exe<\/span> <\/span>updated_aralez.exe<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
      Behavior<\/strong>: Creates updated_aralez.exe<\/code>, embedding the specified tool inside the binary.<\/p>\n<\/div>\n<\/div>\n\n\n\n
      \n
      \n
      --remove_tool <\/code><\/strong><\/code><\/strong><\/span><\/code><\/strong><\/h6>\n<\/div>\n\n\n\n
      \n
      Structure<\/strong>: --remove_tool <EXECUTABLE_TOOL_NAME> <OUTPUT_FILE><\/code><\/span><\/p>\n\n\n\n
      Description<\/strong>: Removes an external tool from the Aralez<\/strong> resource set.<\/p>\n\n\n\n
      Required Parameters<\/strong>:<\/p>\n\n\n\n
        \n
      • EXECUTABLE_TOOL_NAME<\/code><\/span><\/code>: Name of the tool to be removed.<\/li>\n\n\n\n
      • OUTPUT_FILE<\/code><\/span><\/code>: Path to the output binary without the specified tool.<\/li>\n<\/ul>\n\n\n\n
        Example Usage<\/strong>:<\/p>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        aralez.exe<\/span> <\/span>--remove_tool<\/span> <\/span>tool.exe<\/span> <\/span>updated_aralez.exe<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        Behavior<\/strong>: Creates updated_aralez.exe<\/code>, removing the specified tool from the embedded resources.<\/p>\n<\/div>\n<\/div>\n\n\n\n
        \n
        \n
        --list_tools <\/code><\/strong><\/code><\/strong><\/span><\/code><\/strong><\/h6>\n<\/div>\n\n\n\n
        \n
        Description<\/strong>: Lists all external tools currently embedded in Aralez<\/strong>.<\/p>\n\n\n\n
        Example Usage<\/strong>:<\/p>\n\n\n\n
        <\/path><\/path><\/svg><\/span>
        aralez.exe<\/span> <\/span>--list_tools<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        Behavior<\/strong>: Prints the list of embedded external tools to the console.<\/p>\n<\/div>\n<\/div>\n\n\n\n
        <\/div>\n\n\n\n
        Workflows<\/h4>\n\n\n\n
        <\/div>\n\n\n\n
        Running a Data Collection Task<\/strong><\/h5>\n\n\n\n
        Scenario<\/strong>: You want to collect system and file data with the default configuration.<\/p>\n\n\n\n
        Steps<\/strong>:<\/p>\n\n\n\n
          \n
        • Ensure the configuration is correctly set up. Display the config of Aralez<\/strong> and check the content.<\/li>\n<\/ul>\n\n\n\n
          <\/path><\/path><\/svg><\/span>
          aralez.exe<\/span> <\/span>--show_config<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
            \n
          • Check the config before executing Aralez<\/strong><\/li>\n<\/ul>\n\n\n\n
            <\/path><\/path><\/svg><\/span>
            aralez.exe<\/span> <\/span>--check_config<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
              \n
            • Run Aralez<\/strong> without additional flags:<\/li>\n<\/ul>\n\n\n\n
              <\/div>
              \n
              \n
              <\/path><\/path><\/svg><\/span>
              aralez.exe<\/span><\/span><\/code><\/pre><\/div>\n<\/div>\n<\/div><\/div>\n\n\n\n
              Output<\/strong>:<\/p>\n\n\n\n
                \n
              • Collected data is saved in the directory specified in the configuration file.<\/li>\n\n\n\n
              • The directory is compressed into a ZIP archive for convenience.<\/li>\n<\/ul>\n\n\n\n
                <\/div>\n\n\n\n
                Updating and Validating Configuration<\/strong><\/h5>\n\n\n\n
                Scenario<\/strong>: You need to modify the configuration for a specific use case.<\/p>\n\n\n\n
                Steps<\/strong>:<\/p>\n\n\n\n
                  \n
                • Edit or create a new custom_config.yml<\/span> file.<\/li>\n<\/ul>\n\n\n\n
                    \n
                  • Embed the new configuration into a custom executable:<\/li>\n<\/ul>\n\n\n\n
                    <\/path><\/path><\/svg><\/span>
                    aralez.exe<\/span> <\/span>--change_config<\/span> <\/span>custom_config.yml<\/span> <\/span>custom_aralez.exe<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
                    If the configuration file is valid, custom_aralez.exe<\/span> will be created.<\/p>\n\n\n\n
                    Output<\/strong>:<\/p>\n\n\n\n
                      \n
                    • If the configuration file is valid, custom_aralez.exe<\/span> will be created with the updated configuration.<\/li>\n<\/ul>\n\n\n\n
                      <\/div>\n\n\n\n
                      Debugging Task Execution<\/strong><\/h5>\n\n\n\n
                      Scenario<\/strong>: You encounter unexpected behavior during a task and want detailed logs.<\/p>\n\n\n\n
                      Steps<\/strong>:<\/p>\n\n\n\n
                        \n
                      • Run the tool in debug mode:<\/li>\n<\/ul>\n\n\n\n
                        <\/path><\/path><\/svg><\/span>
                        aralez.exe<\/span> <\/span>--debug<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
                        Output<\/strong>:<\/p>\n\n\n\n
                          \n
                        • Detailed information about task progression, including configuration parsing, data collection, and errors are displayed to the console.<\/li>\n<\/ul>\n\n\n\n
                          <\/p>\n","protected":false},"excerpt":{"rendered":"
                          This section provides a detailed guide on how to use Aralez, including available options, commands, and example workflows to maximize its utility. Basic Command The tool can be executed with the following syntax: The OPTIONS parameter allows you to customize the behavior of the tool, such as enabling debug mode, displaying configuration details, or modifying […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_themeisle_gutenberg_block_has_review":false,"footnotes":""},"doc_category":[11],"doc_tag":[],"class_list":["post-95","docs","type-docs","status-publish","hentry","doc_category-2-getting-started"],"blocksy_meta":[],"aioseo_notices":[],"year_month":"2026-04","word_count":665,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"ab","author_nicename":"admin5116","author_url":"https:\/\/aralez.co\/index.php\/author\/admin5116\/"},"doc_category_info":[{"term_name":"2. Getting Started","term_url":"https:\/\/aralez.co\/index.php\/docs-category\/2-getting-started\/"}],"doc_tag_info":[],"_links":{"self":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs\/95","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/comments?post=95"}],"version-history":[{"count":43,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs\/95\/revisions"}],"predecessor-version":[{"id":594,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/docs\/95\/revisions\/594"}],"wp:attachment":[{"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/media?parent=95"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/doc_category?post=95"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/aralez.co\/index.php\/wp-json\/wp\/v2\/doc_tag?post=95"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}