{"id":141,"date":"2026-10-12T12:41:38","date_gmt":"2026-10-12T12:41:38","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/2009\/06\/20\/set-unix-home-dir-property-using-ant\/"},"modified":"2026-10-12T12:41:38","modified_gmt":"2026-10-12T12:41:38","slug":"set-unix-home-dir-property-using-ant","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/set-unix-home-dir-property-using-ant\/","title":{"rendered":"Apache Ant: Set the Current User Home Directory with env.HOME (and Safe Fallbacks)"},"content":{"rendered":"\n

Originally published on 2009-06-20; fully revised and updated.<\/em><\/p>\n\n\n\n

If you maintain Apache Ant build files, you often need a reliable way to reference the current user\u2019s home directory for config files, cache paths, or generated artifacts. This guide shows the original env.HOME<\/code> approach, when to prefer it, and how to add a safer fallback for mixed environments.<\/p>\n\n\n\n

This article is an expanded, modernized version of the original note: SET UNIX HOME DIR PROPERTY using ANT<\/a>.<\/p>\n\n\n\n

\"Original<\/figure>\n\n\n\n

Set HOME from environment variables in Ant<\/h2>\n\n\n\n

Ant can import OS environment variables into properties using <property environment="env"\/><\/code>. After that, an environment variable like HOME<\/code> becomes available as ${env.HOME}<\/code>.<\/p>\n\n\n

<project<\/span> name<\/span>=\"test\"<\/span> default<\/span>=\"myhome\"<\/span>><\/span>\n    <property<\/span> environment<\/span>=\"env\"<\/span>\/><\/span>\n\n    <target<\/span> name<\/span>=\"myhome\"<\/span>><\/span>\n        <echo<\/span> message<\/span>=\"My home is ${env.HOME}\"<\/span>\/><\/span>\n    <\/target<\/span>><\/span>\n<\/project<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
How the property is resolved at runtime<\/h2>\n\n\n\n
\nflowchart TD\n    A[Run ant target] --> B[Load env via property environment env]\n    B --> C{env.HOME available}\n    C -- yes --> D[Set home dir to env.HOME]\n    C -- no --> E[Fallback to user.home]\n    D --> F[Use home.dir in tasks]\n    E --> F\n<\/pre>\n\n\n\n
Compare home-directory property options<\/h2>\n\n\n\n
In practice, you usually choose between environment-based and JVM-based properties depending on where the build runs.<\/p>\n\n\n\n
Property<\/th>Source<\/th>Best use case<\/th>Caveat<\/th><\/tr><\/thead>
${env.HOME}<\/code><\/td>OS environment variable<\/td>Unix\/Linux\/macOS shells and agents where HOME is set<\/td>Can be missing in non-interactive or locked-down CI environments<\/td><\/tr>
${user.home}<\/code><\/td>JVM system property<\/td>Portable fallback across platforms<\/td>Represents the JVM user context, which may differ from shell expectations<\/td><\/tr>
${env.USERPROFILE}<\/code><\/td>Windows environment variable<\/td>Native Windows build agents<\/td>Not available on Unix-like systems<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Use a portable Ant pattern with fallback<\/h2>\n\n\n\n
The pattern below prefers env.HOME<\/code> when present and falls back to user.home<\/code>. It also echoes values for troubleshooting.<\/p>\n\n\n
<project<\/span> name<\/span>=\"home-demo\"<\/span> default<\/span>=\"show-home\"<\/span>><\/span>\n    <property<\/span> environment<\/span>=\"env\"<\/span>\/><\/span>\n\n    <!-- Prefer HOME when available --><\/span>\n    <condition<\/span> property<\/span>=\"home.dir\"<\/span> value<\/span>=\"${env.HOME}\"<\/span>><\/span>\n        <isset<\/span> property<\/span>=\"env.HOME\"<\/span>\/><\/span>\n    <\/condition<\/span>><\/span>\n\n    <!-- Fallback to JVM-level home --><\/span>\n    <property<\/span> name<\/span>=\"home.dir\"<\/span> value<\/span>=\"${user.home}\"<\/span>\/><\/span>\n\n    <target<\/span> name<\/span>=\"show-home\"<\/span>><\/span>\n        <echo<\/span> message<\/span>=\"env.HOME=${env.HOME}\"<\/span>\/><\/span>\n        <echo<\/span> message<\/span>=\"user.home=${user.home}\"<\/span>\/><\/span>\n        <echo<\/span> message<\/span>=\"home.dir=${home.dir}\"<\/span>\/><\/span>\n    <\/target<\/span>><\/span>\n<\/project<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Run and verify<\/h2>\n\n\n
ant -f build.xml show-home\nHOME=\/tmp\/<\/span>demo ant -f build.xml show-home<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
Common pitfalls<\/h2>\n\n\n\n
  • Forgetting <property environment="env"\/><\/code>, which makes ${env.HOME}<\/code> unavailable.<\/li>
  • Assuming HOME<\/code> is always defined in CI.<\/li>
  • Expecting later property declarations to overwrite earlier ones; Ant properties are typically set once.<\/li>
  • Using only Unix-style variables on Windows agents.<\/li><\/ul>\n\n\n\n
    Best practices<\/h2>\n\n\n\n
    • Standardize on a single internal property such as home.dir<\/code>.<\/li>
    • Prefer env.HOME<\/code> when present, with user.home<\/code> as a default.<\/li>
    • Add a diagnostic target that echoes resolved path values.<\/li>
    • Validate behavior on each build environment type (developer laptop, Linux CI, Windows CI).<\/li><\/ul>\n","protected":false},"excerpt":{"rendered":"
      Learn how to read the logged-in user\u2019s home directory in Ant using env.HOME, then make it portable with a user.home fallback. Includes build.xml patterns you can use in local builds and CI.<\/p>\n","protected":false},"author":1,"featured_media":4091,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_joinchat":[],"footnotes":""},"categories":[4957],"tags":[209,3316,3313,3315,545,593,1073,1158,3317,3314,169,3318,1927],"class_list":["post-141","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-linux","tag-ant","tag-home-directory","tag-homedir","tag-homedir-in-build-xml","tag-how","tag-process","tag-properties","tag-set","tag-set-home-directory-properites-in-unix","tag-set-properties","tag-unix","tag-unix-home-dir-property-setting-by-ant","tag-using"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/141","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=141"}],"version-history":[{"count":3,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/141\/revisions"}],"predecessor-version":[{"id":78990,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/141\/revisions\/78990"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media\/4091"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=141"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=141"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=141"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}