Category: zsh

Custom Command Namespace

Posted on by Jim O'Connell Posted in bash, commandline, unix, zshTagged , , Leave a comment
Reading Time: 2 minutes

If you are a moderate to heavy user of the command line in Linux or OS X, you’ll eventually build up a set of custom commands and shortcuts that you’ve written that help streamline your workflow. These are known as “aliases.”
Let’s say you frequently find yourself searching your shell history for a command you used before.
To display your command history, you simply type historyin your shell, and every command you’ve typed streams by.
This is useful, of course, but most likely you want to know about a particular command you typed, so you might use shell redirection to pipe the output to another command, in this case, grep to find lines in history that are interesting to you. In this example, we’re looking for commands we’ve typed that involved the word “projects”: $ history | grep projects 9627 cd projects/ansible_dexter 9641 cd ~/projects/ansible_dexter 9675 cd projects/ansible_dexter 9684 cd ~/projects/sendgrid-test 9696 source /home/jim/projects/sns_python/venv/bin/activate 9707 source /home/jim/projects/sns_python/venv/bin/activate 9713 cd ~/projects/ 9863 cp -r ~/projects/sendgrid-test/lib64 . 9865 cp -r ~/projects/sendgrid-test/share . 9962 cd projects 9972 cd projects/terraform-provider-aws 9979 cd projects/terraform-provider-aws 10003 cd projects/terraform-provider-aws For me, this is something I do so frequently that I wanted to shorten that command to the minimum number of characters. I settled upon hg for “history grep”, so I created an alias as a line in my ~/.zshrc file: alias hg="history | grep" The ~/.zshrc (or ~/.bashrc if you use bash as your shell,) is a file that gets read every time you log in and sets up your preferred environment. Perfect! Now, if I want to search history for commands that included a particular string, I can just type hg projects and I will get the above output. Well, nearly perfect…

As it happens, hg is also a command used by the Mercurial Source Code Management system. This is not a big issue for me, as I’m a loyal Git user, but it presents an interesting dilemma:

How do I protect against command name collisions in my aliases?

You see, pretty much any alias you create has the potential to conflict with a command someone else has written, but where this gets even more complicated is when these commands are referenced from a script. Scripts should, however, only call external programs using the program’s full path, e.g.:/bin/ls instead of just ls A blog post by Brandon Rhodes proposes an interesting solution: Prepend all of your custom commands and aliases with a comma. Interestingly, a comma is just a normal letter to the shell, no different than renaming your command jimoconnell_hg, though a comma is of course much shorter.

I found this tip via the excellent ‘/r/commandline’ subreddit.

I haven’t used this technique much at all yet, so let me know what you think!

Create a Directory and `cd` into it in one command

Posted on by Jim O'Connell Posted in bash, commandline, unix, zshLeave a comment
Reading Time: 2 minutes

(This post is meant not only to describe a little shell function, but to introduce you to a powerful, yet simple concept.)

When I’m working with a command line, I will frequently need to create a directory and then immediately change to that directory.

Let’s say I’m starting a new project.  I will cd  into my ~/projects directory and then create a new folder where I’ll be putting my files.  After creating the new folder, I’ll generally need to cd to that folder. cd ~/projects mkdir foo cd foo

My first thought was to write a little alias that combined the two operations, but aliases don’t really handle parameters well, so I wrote it as a shell function.  (I use the amazing zsh as my terminal shell, but this approach works just the same in bash.) In the below example, the “$1” refers to the argument passed. “$2”, “$3” and so on also work. (Be sure to quote them!) mgo () { mkdir "$1"<br /> cd "$1" } You can paste that into your shell and it will work for the duration of your session, but of course the better way of making it available is to put it in your ~/.zshrc or whatever your ~/.profile file is in your shell of choice. For example, in OS X, you have to first create the file:

Start up Terminal. Type "cd ~/" to go to your home folder. Type "touch .bash_profile" to create your new file. Edit .bash_profile with your favorite editor (or you can just type "open -e .bash_profile" to open it in TextEdit.

To use it, you need to have that file be re-read, so you can either close and re-open your terminal, source the file you just edited, or just paste the function in to have it be active for the current session.

I realize that this is an insanely simple thing to worry over, but so much of the Linux/Unix philosophy is about making things just a bit more efficient and shell functions are a very approachable way to craft your own customizations for efficiency.

Another Example: If you’re a python programmer or student, you are probably aware of venv, the virtual environment for Python that create lightweight Virtual Environment on a directory-by-directory basis. If you have, you know that each time you move to a project directory, you need to type ./venv/bin/activate to set up the environment. A clever function I found a while back takes over the cd command to check for a virtual environment and activate it if it exists: cd () { builtin cd $1 if [[ -d ./venv/bin ]] then source ./venv/bin/activate fi if [[ -d ./bin ]] then source ./bin/activate fi } Both of the above examples are simple, but useful. Please leave a comment below if you know of any other good examples, or can think of a good use case for a function.