Setting GUI Visible Environment Variables with OS Catalina

catalinaenvironment-variablesxcode

I need to set a number of Environment variables that can be seen by GUI apps (i.e. Xcode). When running from a terminal this is trivial and is simply a case of adding a. number of export commands to my .bash_profile e.g.

export BOOST_INCLUDE=~/boost/boost-XXXX/boost

Unfortunately GUI apps do not see values set in .bash_profile. I am using Catalina and it appears that Apple modifies the mechanism every time MacOs is updated. Many online guides are out of date….

This article: http://www.dowdandassociates.com/blog/content/howto-set-an-environment-variable-in-mac-os-x-launchd-plist/ suggests that launchctl should do what I need but even the following simple example does not work:

In a terminal:

/bin/launchctl setenv FOO BAR

Then close the terminal and open a new one

Check the value:

echo $FOO

The output should be

BAR

But it is unset. Note it is also unset in the original terminal so I am not convinced that the command /bin/launchctl setenv FOO BAR is doing anything.

Note: This is about setting the environment variable for GUI apps NOT just for the terminal.

Best Answer

Run launchctl setenv FOO BAR in Terminal.app, then quit (Cmd-Q) and restart Terminal.

Related Solutions

Why can’t I control environment variables via /etc/environment

/etc/environment may work in Linux but doesn't in OS X. There exist other options to accomplish similar results though.

Additional paths

Additional paths can be added in /etc/paths.d by creating a text file there listing one path component per line (e.g. sudo echo /usr/local/superbin > /etc/paths.d/superbin).

Other environment variables

As more or less everything is controlled by launchd these days global environment variables can be specified directly in /etc/launchd.conf as described in this StackOverflow answer.

Defining environment variables with launchd/launchctl

For the sake of clarity, I will refer to this solution as the static solution, the second solution as the dynamic solution, and finally this one as the launch agent solution. I am going to compare the static and dynamic solution with the launch agent one, respectively.

The static solution involves the editing of /etc/launchd.conf. This has the advantage, as with the launch agent solution, that the variables are set right at the login. Disadvantages are that

the variables are defined for all users. The launch agent solution lets each user decide for himself. If one wants to define variables for all users with the launch agent solution, the shell script can be amended with a loop (and another file),
the definition of the variables in /etc/launchd.conf does not allow for things like variable substitution and such stuff (at least that is my guess, maybe it is feasible),
obviously, you need access to /etc/launchd.conf to pull the static solution off, with the other one you can put all files at accessible places, e.g. the launch agent in ~/Library/LaunchAgents/,
the variables are not available immediately after editing the file, as with the launch agent solution (but see below).

The dynamic solution is similar to the launch agent solution. Its disadvantage is that the variables are not available right after login, you first need to (re-)define them. To combine the dynamic solution with the other, imagine you wanted to set the variable FOO to the content of the variable BAR. You would fire up a shell, say the bash, and type

launchctl setenv FOO "$BAR"
echo 'setenv FOO $BAR' >> ~/.conf.launchd

Then FOO would be available in all applications started after this definition, and would also be defined right after the next login.

Related Question