Howto Make Script More Portable With #!/usr/bin/env As a Shebang

by on March 6, 2007 · 19 comments· LAST UPDATED February 21, 2008

in , ,

You may have noticed that most shell and perl script starts with the following line:
#!/bin/bash
OR
#!/usr/bin/perl

It is called a shebang. It consists of a number sign and an exclamation point character (#!), followed by the full path to the interpreter such as /bin/bash. All scripts under UNIX and Linux execute using the interpreter specified on a first line.

However there is a small problem. BASH or Perl is not always in the same location (read as PATH) such as /bin/bash or /usr/bin/perl. If you want to make sure that script is portable across different UNIX like operating system you need to use /usr/bin/env command.

env command allows to run a program in a modified environment.

Find line
#!/bin/bash

Replace with
#!/usr/bin/env bash

For example here is a small script:

#!/usr/bin/env bash
x=5
y=10
echo "$x and $y"

OR

#!/usr/bin/env perl
use warnings;
print "Hello " x 5;
print "\\n";

Now you don’t have to search for a program via the PATH environment variable. This makes the script more portable. Also note that it is not foolproof method. Always make sure you have /usr/bin/env exists or use a softlink/symbolic link to point it to correct path. And yes your work (script) looks more professional with this hack :)

TwitterFacebookGoogle+PDF versionFound an error/typo on this page? Help us!

{ 19 comments… read them below or add one }

1 bhaskar March 7, 2007 at 3:15 pm

I am confused.
Why is /usr/bin/env more portable than /bin/bash.
Besides on most linux distros bash is found in /bin, but env is not guaranteed to be found under /usr/bin.
e.g. in my case (FC5) env is under /bin.
My point is , which ever way you need to know the absolute path to either env, or bash, so why bother ?

Reply

2 nixCraft March 7, 2007 at 4:27 pm

If you move from Linux distro to BSD you will see bash is located at /usr/local/bin/bash OR to Solaris you will see bash at /opt or some other location. Instead of adjusting all the location admin can create a /usr/bin/env softlink and problem solved. Just imagine you have 100s of shell and perl scripts…

This is not just about Linux. It is about running a script under different UNIX like oses.

Reply

3 nag July 12, 2007 at 9:43 pm

Thanks for “shebang” and its explanation. Its really helpful.

Reply

4 IHar Filipau August 2, 2007 at 8:07 am

The only problem I have with env, that on some systems lacking ‘use warnings’, I can’t pass ‘-w’ on command line. Or is it possible somehow?

Reply

5 nixCraft September 6, 2007 at 9:44 am

You can pass /bin/path/to/mybinary -w

Reply

6 Carsten January 14, 2009 at 8:45 am

I do not feel very comfortable with the security aspects of this hack.
It may be more portable but it reduces control.
Bash and other shells are hardened so that they can be used for admin jobs withstanding tampering efforts by non root users.
Using the described “env” solution may introduce vulnerabilities which are difficult to oversee or analyze.
Instead of linking env and using it to deal with compatibity I rather add compatibility links to my systems which link bash or perl to a uniform location e.g. ln -s /usr/local/bin/bash /bin/bash

Reply

7 Terrible January 26, 2009 at 10:00 pm

Terrible advice. Do not do this. Portability should stem from your installion routines, not some security and design problem causing hack.

Reply

8 robsku December 17, 2010 at 11:29 pm

@Terrible
You could be correct, but I’d like to hear your opinion of why exactly is it more harmful?

Well, it runs the command, perl for example, like you would run perl by hand – so I assume it searches via PATH – I can see that individual user may then create executable ‘perl’ of his own under his home directory and change PATH so that env will call that… However that already means that user in question is doing this on purpose, in which case he could just call the harmful program himself – no need to even include the script, perl nor env on that and if done that way it would not affect other users which would still get to run the script as intended.

However security and holes in it can be complex issues and I’m not a professional at all… If indeed using env is more of a possible security issue than creating shebang pointing right to correct interpreter in install routine I would love to learn why exactly is it safer, about possible security issues in using env, etc.
I would think that when installed system wide both ways would be as safe – and one trying to do harm could install the whole software locally under his home directory anyway but could not alter what is ran when other users call the script in question – not understanding makes me even more curious, but most importantly I want to ensure security…

Reply

9 someone August 13, 2011 at 7:01 pm

Even the official python tutorial website is using:
#! /usr/bin/env python
http://docs.python.org/tutorial/interpreter.html

Reply

10 Triston J. Taylor December 24, 2012 at 6:11 pm

Here’s an idea, instead of wasting cpu and peoples time, suggest a link to /bin/bash always. This stupid idea of using env command is a waste of the unix operating system.

Symbolic links were created to solve problems exactly like this. Some idiot came up with the great idea to make it more complicated by suggesting a link to bin env… I swear this is absolutely retarded.

Quit being lazy and put a proper link in /bin. What is the point in spawning processes you don’t need? More professional? According to who? The idiots who never wrote a single program of assembler code in their life? The idiots who couldn’t write a bash script to remove duplicate words from a list without resorting to external commands?

Oh yeah, you must mean those idiots…. The one’s who couldn’t code their way out of wet paper sack.

Reply

11 Triston J. Taylor December 24, 2012 at 6:16 pm

And another thing, if its really that important to be portable, and you can’t create a link in /bin then your scripts need to be auto-generated on-site with the proper header line.

Quit wasting resources and practice efficiency. Wastefulness is a bad habit that not only adds up, but is certain to be a perpetual mistake.

Reply

12 Anon March 21, 2014 at 12:24 am

Are you seriously saying that a person is an idiot just because of this? You look like one acting like you are the only one who knows… Just saying.

Reply

13 Ian Epp July 17, 2013 at 9:16 pm

@Triston J. Taylor
I came here to solve a problem with the python interpreter changing based on which python virtual environment was activated at a given time. Remapping the symlink doesn’t work at all as I may have one shell in one environment and another in a completely different one – it invokes different python symlinks. Using env fixes this perfectly.

Reply

14 Rodney September 20, 2013 at 7:50 pm

One problem with /usr/bin/env SomeCmd is you can’t pass additional arguments.

So you can’t /usr/bin/env SomeCmd -someArg -someOtherArg

Why? Because /usr/bin/env doesn’t support passing those as arguments on same platforms.

One hack to work around this is

Reply

15 Rodney September 20, 2013 at 7:52 pm
16 Ovidiu January 31, 2014 at 4:25 pm

It is not a portable solution. On Windows you could have C:\cygwin64\bin\env.exe instead of /usr/bin/env.

So assuming the path of env is not a portable solution.

Reply

17 snke April 22, 2014 at 5:57 am

I just want to add to this now seven-year-old conversation that modern developers often change their development environment depending on which project they are working on.

For example using rvm you might often change which version of the ruby interpreter you are using to ensure compatibility across different versions or to work on legacy code. Switching rubies switches your PATH to point to whichever ruby you are using.

Additionally a developer may want to develop in a different version of say, python, than the version that ships with OS X, but doesn’t want to overwrite the system’s version or uninstall it because they know they do not know what the consequences of doing so. Using a package manager like Homebrew makes it easy to install scripting languages for the local user rather than forcing you to install it as root. Is that not more secure?

In each of these scenarios you want to be using /usr/bin/env in your scripts because hard-coding the binary location is not practical and will be irritating to anyone else on your team if you try and pass off a script with something like #!/Users/joejimbob/.rvm/rubies/ruby-1.9.3-p286/bin/ruby at the top. Saying MY script doesn’t work because YOU don’t know how to symlink might earn me 3 or 4 old school points, but I would still be a jerk.

As for being wasteful, trading end-user CPU cycles for a shorter development time and broader compatibility is the world we live in. Rejecting this and calling people lazy for it, is an obsolete way of thinking and shows a distrust of modern methods and software which is the sign of a bad coder (see #6 here: http://www.yacoset.com/Home/signs-that-you-re-a-bad-programmer). Isn’t abstraction the way by which we accomplish the most amazing things with technology? Isn’t it more wasteful to waste development time by re-inventing the wheel and forcing your peers to understand YOUR style rather than what’s most practical?

I inherited a system from such old-fashioned types of people and I can tell you I still haven’t unearthed all of their “gotchas” of absolute paths and i-dont-trust-this-new-language-so-im-going-to-be-clever types of garbage. The way they did things was to approach the problem as if they were the first person to ever tackle it or that at the very least, they knew better because they’ve been around longer. I swear these guys thought they were going to be buried with the server.

Reply

18 Pete April 23, 2014 at 2:56 pm

@Ovidiu
Well you have to start somewhere! For the most part *nix distributions have standardized the locations so that both /usr/bin/env and /bin/env exist.

@snke
Totally agree. I came here because I am faced with Perl code that starts “#! /usr/bin/perl”, but I have a requirement that means using a later release of Perl than that installed in the system area and in the environment I work in we are not allowed to change the “system” perl or add to its modules. So it should have been coded “#! /usr/bin/env perl”.
Thanks for the page you linked to.

Reply

19 Matt D. October 14, 2014 at 11:29 am

I would also like to add that this technique has allowed my scripts to be portable to OSX where bash is still stuck at version 3. For example, I’ve installed mac ports and set my path for ‘bash’ to take precedence. But if I were to hard-code #!/bin/bash then that would do no good.

@Pete
‘which env’ on OSX 10.9 /usr/bin/env as the only result and appears to be the most portable between Cygwin, Linux, and OSX.

Reply

Leave a Comment

Tagged as: , , , , , , , , , , , , , , , ,

Previous post:

Next post: