{"id":88,"date":"2025-02-01T22:36:52","date_gmt":"2025-02-01T22:36:52","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/2008\/11\/25\/running-native-programs-in-ant\/"},"modified":"2025-02-01T22:36:52","modified_gmt":"2025-02-01T22:36:52","slug":"running-native-programs-in-ant","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/running-native-programs-in-ant\/","title":{"rendered":"How to Run Executable & Native Programs in an Ant Script"},"content":{"rendered":"\n

How to Run Executable & Native Programs in an Ant Script<\/strong><\/h1>\n\n\n\n

Apache Ant<\/strong> allows you to run executable files (.exe<\/code>) and native programs<\/strong> using the <exec><\/code> task. This guide explains how to:
\u2705 Execute an external program or script
\u2705 Pass arguments to the program
\u2705 Handle output and errors
\u2705 Run Windows executables (.exe<\/code>) and Unix shell scripts (.sh<\/code>)<\/p>\n\n\n\n

\n\n\n\n

1. Running an Executable (.exe<\/code>) in Ant Script<\/strong><\/h2>\n\n\n\n

If you have a Windows executable<\/strong> (e.g., myprogram.exe<\/code>) and want to run it using Ant, use the <exec><\/code> task.<\/p>\n\n\n\n

Example: Run an EXE File<\/strong><\/h3>\n\n\n
<project<\/span> name<\/span>=\"RunExeExample\"<\/span> default<\/span>=\"runExe\"<\/span> basedir<\/span>=\".\"<\/span>><\/span>\n    <target<\/span> name<\/span>=\"runExe\"<\/span>><\/span>\n        <exec<\/span> executable<\/span>=\"C:\\path\\to\\myprogram.exe\"<\/span>><\/span>\n            <arg<\/span> value<\/span>=\"--option1\"<\/span>\/><\/span>\n            <arg<\/span> value<\/span>=\"value1\"<\/span>\/><\/span>\n        <\/exec<\/span>><\/span>\n    <\/target<\/span>><\/span>\n<\/project<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
\u2705 This will run:<\/p>\n\n\n
C<\/span>:\\path<\/span>\\to<\/span>\\myprogram<\/span>.exe<\/span> --option1<\/span> value1<\/span>\n<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
Key Points:<\/strong><\/p>\n\n\n\n
    \n
  • Replace C:\\path\\to\\myprogram.exe<\/code> with the actual path of your executable.<\/li>\n\n\n\n
  • Use <arg><\/code> to pass arguments<\/strong> to the executable.<\/li>\n<\/ul>\n\n\n\n
    \n\n\n\n
    2. Running a Native Program (Any OS)<\/strong><\/h2>\n\n\n\n
    You can run system commands (e.g., cmd.exe<\/code> for Windows or sh<\/code> for Unix).<\/p>\n\n\n\n
    Example: Running a Shell Script (.sh<\/code>)<\/strong><\/h3>\n\n\n
    <target<\/span> name<\/span>=\"runShell\"<\/span>><\/span>\n    <exec<\/span> executable<\/span>=\"sh\"<\/span>><\/span>\n        <arg<\/span> value<\/span>=\"-c\"<\/span>\/><\/span>\n        <arg<\/span> value<\/span>=\"ls -la\"<\/span>\/><\/span>\n    <\/exec<\/span>><\/span>\n<\/target<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    \u2705 This runs the command:<\/p>\n\n\n
    sh -c \"ls -la\"<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    Example: Running a Windows Command (cmd.exe<\/code>)<\/strong><\/h3>\n\n\n
    <target<\/span> name<\/span>=\"runCmd\"<\/span>><\/span>\n    <exec<\/span> executable<\/span>=\"cmd.exe\"<\/span>><\/span>\n        <arg<\/span> value<\/span>=\"\/c\"<\/span>\/><\/span>\n        <arg<\/span> value<\/span>=\"dir\"<\/span>\/><\/span>\n    <\/exec<\/span>><\/span>\n<\/target<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    \u2705 This runs:<\/p>\n\n\n
    cmd.exe \/c \"dir\"<\/span>\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    (Lists directory contents on Windows.)<\/em><\/p>\n\n\n\n
    \n\n\n\n
    3. Capturing Output and Logging<\/strong><\/h2>\n\n\n\n
    You can capture output from the executable into a file<\/strong> or display it in the Ant log<\/strong>.<\/p>\n\n\n\n
    Example: Redirect Output to a Log File<\/strong><\/h3>\n\n\n
    <target<\/span> name<\/span>=\"runExeWithLog\"<\/span>><\/span>\n    <exec<\/span> executable<\/span>=\"C:\\path\\to\\myprogram.exe\"<\/span> output<\/span>=\"output.log\"<\/span> error<\/span>=\"error.log\"<\/span>\/><\/span>\n<\/target<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    \u2705 This saves standard output to output.log<\/code> and errors to error.log<\/code>.<\/p>\n\n\n\n
    \n\n\n\n
    4. Setting Environment Variables<\/strong><\/h2>\n\n\n\n
    You may need to set environment variables<\/strong> before running an executable.<\/p>\n\n\n\n
    Example: Setting an Environment Variable<\/strong><\/h3>\n\n\n
    <target<\/span> name<\/span>=\"runWithEnv\"<\/span>><\/span>\n    <exec<\/span> executable<\/span>=\"myprogram.exe\"<\/span>><\/span>\n        <env<\/span> key<\/span>=\"MY_ENV_VAR\"<\/span> value<\/span>=\"some_value\"<\/span>\/><\/span>\n    <\/exec<\/span>><\/span>\n<\/target<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    \u2705 This sets MY_ENV_VAR=some_value<\/code> before running myprogram.exe<\/code>.<\/p>\n\n\n\n
    \n\n\n\n
    5. Running Background Processes<\/strong><\/h2>\n\n\n\n
    To run a program without waiting for it to finish<\/strong>, set spawn=\"true\"<\/code>.<\/p>\n\n\n
    <target<\/span> name<\/span>=\"runInBackground\"<\/span>><\/span>\n    <exec<\/span> executable<\/span>=\"C:\\path\\to\\myprogram.exe\"<\/span> spawn<\/span>=\"true\"<\/span>\/><\/span>\n<\/target<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    \u2705 This starts myprogram.exe<\/code> and allows Ant to continue execution.<\/p>\n\n\n\n
    \n\n\n\n
    6. Full Example: Running an EXE, Capturing Output, and Setting Env Variables<\/strong><\/h2>\n\n\n
    <project<\/span> name<\/span>=\"FullExample\"<\/span> default<\/span>=\"runExe\"<\/span> basedir<\/span>=\".\"<\/span>><\/span>\n    <target<\/span> name<\/span>=\"runExe\"<\/span>><\/span>\n        <exec<\/span> executable<\/span>=\"C:\\path\\to\\myprogram.exe\"<\/span> output<\/span>=\"program_output.log\"<\/span> error<\/span>=\"program_error.log\"<\/span>><\/span>\n            <env<\/span> key<\/span>=\"CONFIG_PATH\"<\/span> value<\/span>=\"C:\\configs\"<\/span>\/><\/span>\n            <arg<\/span> value<\/span>=\"--config\"<\/span>\/><\/span>\n            <arg<\/span> value<\/span>=\"config.json\"<\/span>\/><\/span>\n        <\/exec<\/span>><\/span>\n    <\/target<\/span>><\/span>\n<\/project<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    \u2705 This:<\/p>\n\n\n\n
      \n
    • Runs myprogram.exe --config config.json<\/code><\/li>\n\n\n\n
    • Captures output in program_output.log<\/code> and errors in program_error.log<\/code><\/li>\n\n\n\n
    • Sets the environment variable CONFIG_PATH=C:\\configs<\/code><\/li>\n<\/ul>\n\n\n\n
      \n\n\n\n
      7. Conclusion<\/strong><\/h2>\n\n\n\n
      With Ant\u2019s <exec><\/code> task, you can execute native programs, EXE files, and shell scripts<\/strong>, pass arguments, capture output, and set environment variables. \ud83d\ude80<\/p>\n\n\n\n
      Would you like help automating builds, integrating with Java, or scheduling tasks in Ant<\/strong>? Let me know! \ud83d\ude0a<\/p>\n\n\n\n
      Apache Ant <exec><\/code> Task Parameters Table<\/strong><\/h1>\n\n\n\n
      The <exec><\/code> task in Apache Ant<\/strong> is used to run external programs, executables, scripts, or system commands. The following table lists all the available parameters for the <exec><\/code> task along with their descriptions and example usage.<\/p>\n\n\n\n
      \n\n\n\n
      \ud83d\udccc Table: <exec><\/code> Task Parameters<\/strong><\/h3>\n\n\n\n
      Parameter<\/th>Description<\/th>Required<\/th>Example Usage<\/th><\/tr><\/thead>
      executable<\/code><\/strong><\/td>The program or command to execute (full path if necessary)<\/td>\u2705 Yes<\/td><exec executable=\"cmd.exe\"\/><\/code><\/td><\/tr>
      dir<\/code><\/strong><\/td>Specifies the working directory for the command execution<\/td>\u274c No<\/td><exec executable=\"myprogram.exe\" dir=\"C:\\mydir\"\/><\/code><\/td><\/tr>
      os<\/code><\/strong><\/td>Restricts execution to specific OS (comma-separated)<\/td>\u274c No<\/td><exec executable=\"ls\" os=\"Linux,MacOS\"\/><\/code><\/td><\/tr>
      failonerror<\/code><\/strong><\/td>If true<\/code>, the build fails on non-zero exit codes<\/td>\u274c No (default: false<\/code>)<\/td><exec executable=\"myprogram.exe\" failonerror=\"true\"\/><\/code><\/td><\/tr>
      spawn<\/code><\/strong><\/td>If true<\/code>, runs the process in the background<\/td>\u274c No (default: false<\/code>)<\/td><exec executable=\"notepad.exe\" spawn=\"true\"\/><\/code><\/td><\/tr>
      output<\/code><\/strong><\/td>Captures the program\u2019s standard output to a file<\/td>\u274c No<\/td><exec executable=\"myprogram.exe\" output=\"output.log\"\/><\/code><\/td><\/tr>
      error<\/code><\/strong><\/td>Captures the program\u2019s error output to a file<\/td>\u274c No<\/td><exec executable=\"myprogram.exe\" error=\"error.log\"\/><\/code><\/td><\/tr>
      input<\/code><\/strong><\/td>Redirects a file as standard input for the process<\/td>\u274c No<\/td><exec executable=\"myprogram.exe\" input=\"input.txt\"\/><\/code><\/td><\/tr>
      logerror<\/code><\/strong><\/td>If true<\/code>, logs error messages to the Ant console<\/td>\u274c No (default: false<\/code>)<\/td><exec executable=\"myprogram.exe\" logerror=\"true\"\/><\/code><\/td><\/tr>
      resultproperty<\/code><\/strong><\/td>Stores the exit code of the command in a property<\/td>\u274c No<\/td><exec executable=\"myprogram.exe\" resultproperty=\"exit.code\"\/><\/code><\/td><\/tr>
      timeout<\/code><\/strong><\/td>Sets a timeout (in milliseconds) for execution<\/td>\u274c No<\/td><exec executable=\"myprogram.exe\" timeout=\"5000\"\/><\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n
      \ud83d\udccc Special Nested Elements in <exec><\/code><\/strong><\/h3>\n\n\n\n
      Element<\/th>Description<\/th>Example Usage<\/th><\/tr><\/thead>
      <arg><\/code><\/strong><\/td>Passes command-line arguments<\/td><arg value=\"--config config.json\"\/><\/code><\/td><\/tr>
      <env><\/code><\/strong><\/td>Sets environment variables for execution<\/td><env key=\"JAVA_HOME\" value=\"C:\\Java\"\/><\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n
      \ud83d\udccc Example: Full <exec><\/code> Task Usage<\/strong><\/h3>\n\n\n
      <project<\/span> name<\/span>=\"RunExecutable\"<\/span> default<\/span>=\"execute\"<\/span> basedir<\/span>=\".\"<\/span>><\/span>\n    <target<\/span> name<\/span>=\"execute\"<\/span>><\/span>\n        <exec<\/span> executable<\/span>=\"C:\\path\\to\\myprogram.exe\"<\/span> dir<\/span>=\"C:\\mydir\"<\/span> failonerror<\/span>=\"true\"<\/span> timeout<\/span>=\"10000\"<\/span> output<\/span>=\"output.log\"<\/span> error<\/span>=\"error.log\"<\/span>><\/span>\n            <arg<\/span> value<\/span>=\"--config\"<\/span>\/><\/span>\n            <arg<\/span> value<\/span>=\"config.json\"<\/span>\/><\/span>\n            <env<\/span> key<\/span>=\"CONFIG_PATH\"<\/span> value<\/span>=\"C:\\configs\"<\/span>\/><\/span>\n        <\/exec<\/span>><\/span>\n    <\/target<\/span>><\/span>\n<\/project<\/span>><\/span>\n<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
      \u2705 This script:<\/strong><\/p>\n\n\n\n
        \n
      • Runs myprogram.exe --config config.json<\/code> in C:\\mydir<\/code><\/li>\n\n\n\n
      • Stops execution if an error occurs (failonerror=\"true\"<\/code>)<\/li>\n\n\n\n
      • Captures standard output (output.log<\/code>) and errors (error.log<\/code>)<\/li>\n\n\n\n
      • Uses an environment variable CONFIG_PATH=C:\\configs<\/code><\/li>\n<\/ul>\n\n\n\n
        \n\n\n\n
        \ud83c\udfaf Conclusion<\/strong><\/h2>\n\n\n\n
        The <exec><\/code><\/strong> task in Ant is highly flexible and allows running external programs with environment control, error handling, and logging. By using parameters and nested elements effectively, you can automate complex tasks<\/strong> seamlessly. \ud83d\ude80<\/p>\n\n\n\n
        Would you like additional help with Ant automation, Java builds, or integrating with Jenkins<\/strong>? Let me know! \ud83d\ude0a<\/p>\n","protected":false},"excerpt":{"rendered":"
        How to Run Executable & Native Programs in an Ant Script Apache Ant allows you to run executable files (.exe) and native programs using the <exec> task. This guide explains how to:\u2705 Execute an external program or script\u2705 Pass arguments to the program\u2705 Handle output and errors\u2705 Run Windows executables (.exe) and Unix shell scripts…<\/p>\n","protected":false},"author":1,"featured_media":3608,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","_joinchat":[],"footnotes":""},"categories":[12],"tags":[209,1897,1898,1896,1892,1894,1893,1668,1899,1895],"class_list":["post-88","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-apache-ant","tag-ant","tag-ant-guide","tag-ant-native","tag-ant-tutorials","tag-native","tag-native-programs-in-ant","tag-programs","tag-run","tag-running-native-programs-in-ant","tag-running-programs"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/88","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=88"}],"version-history":[{"count":3,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/88\/revisions"}],"predecessor-version":[{"id":48326,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/88\/revisions\/48326"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media\/3608"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=88"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=88"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=88"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}