Linux command line navigation tips/tricks 3 - the CDPATH environment variable
In the first part of this series, we discussed the cd - command in detail, and the in the second part, we took an in-depth look into the pushd and popd commands as well as the scenarios where-in they come in handy.
Continuing with our discussion on the command line navigation aspects, in this tutorial, we'll discuss the CDPATH environment variable through easy-to-understand examples. We'll also discuss some advanced details related to this variable.
The CDPATH environment variable
Even if your command line work involves performing all operations under a particular directory - say your home directory - then also you have to provide absolute paths while switching directories. For example, consider a situation where-in I am in /home/himanshu/Downloads directory:
And the requirement is to switch to the /home/himanshu/Desktop directory. To do this, usually, I'll have to either run:
Wouldn't it be easy if I could just run the following command:
Yes, that's possible. And this is where the CDPATH environment variable comes in.You can use this variable to define the base directory for the cd command.
If you try printing its value, you'll see that this env variable is empty by default:
$ echo $CDPATH
Now, considering the case we've been discussing so far, let's use this environment variable to define /home/himanshu as the base directory for the cd command.
The easiest way to do this is:
And now, I can do what I wasn't able to do earlier - from within the /home/himanshu/Downloads directory, run the cd Desktop command successfully.
$ cd Desktop/
This means that I can now do a cd to any directory under /home/himanshu without explicitly specifying /home/himanshu or ~ or ../ (or multiple ../)in the cd command.
Points to keep in mind
So you now know how we used the CDPATH environment variable to easily switch to/from /home/himanshu/Downloads from/to /home/himanshu/Desktop. Now, consider a situation where-in the /home/himanshu/Desktop directory contains a subdirectory named Downloads, and it's the latter where you intend to switch.
But suddenly you realize that doing a cd Desktop will take you to /home/himanshu/Desktop. So, to make sure that doesn't happen, you do:
While there's no problem in the aforementioned command per se, that's an extra effort on your part (howsoever little it may be), especially considering that you'll have to do this each time such a situation arises. A more elegant solution to this problem can be to originally set the CDPATH variable in the following way:
This means you're telling the cd command to first look for the directory in the current working directory, and then try searching the /home/himanshu directory. Of course, whether or not you want the cd command to behave this way depends entirely on your preference or requirement - my idea behind discussing this point was to let you know that this kind of situation may arise.
As you would have understood by now, once the CDPATH env variable is set, it's value - or the set of paths it contains - are the only places on the system where the cd command searches for directories (except of course the scenarios where-in you use absolute paths). So, it's entirely up to you to make sure that the behavior of the command remains consistent.
Moving on, if there's a bash script that uses the cd command with relative paths, then it's better to clear or unset the CDPATH environment variable first, unless you are ok with getting trapped into unforeseen problems. Alternatively, rather than using the export command on the terminal to set CDPATH, you can set the environment variable in your
.bashrc file after testing for interactive/non-interactive shells to make sure that the change you're trying to make is only reflected in interactive shells.
The order in which paths appear in the environment variable's value is also important. For example, if the current directory is listed before /home/himanshu, then the cd command will first search for a directory in the present working directory and then move on to /home/himanshu. However, if the value is "/home/himanshu:." then the first search will be made in /home/himanshu and after that the current directory. Needless to say, this will effect what the cd command does and may cause problems if you aren't aware of the order of paths.
Always keep in mind that the CDPATH environment variable, as the name suggests, works only for the cd command. This means that while inside the /home/himanshu/Downloads directory, you can run the cd Desktop command to switch to /home/himanshu/Desktop directory, but you can't do an ls. Here's an example:
$ ls Desktop
ls: cannot access Desktop: No such file or directory
However, there could be some simple workarounds. For example, we can achieve what we want with minimal effort in the following way:
$ cd Desktop/;ls
backup backup~ Downloads gdb.html outline~ outline.txt outline.txt~
But yeah, there might not be a workaround for every situation.
Another important point: as you might have observed, whenever you use the cd command with the CDPATH environment variable set, the command produces the full path of directory you are switching to in the output. Needless to say, not everybody would want to have this information each time they run the cd command on their machine.
To make sure this output gets suppressed, you can use the following command:
alias cd='>/dev/null cd'
The aforementioned command will mute the output whenever the cd command is successful, but will allow the error messages to be produced whenever the command fails.
Lastly, in case you face a problem where-in after setting the CDPATH environment variable, you can't use the shell's tab completion feature, then you can try installing and enabling bash-completion - more on it here.
The CDPATH environment variable is a double-edged sword - if not used with caution and complete knowledge, it may land you in some complex traps that may require a lot of your time precious time to get resolved. Of course, that doesn't mean you should never give it a try; just evaluate all the available options and if you conclude that using CDPATH would be of great help, then do go ahead and use it.
Have you been using CDPATH like a pro? Do you have some more tips to share? Please share your thoughts in the comments below.