{"id":9897,"date":"2023-05-16T16:26:15","date_gmt":"2023-05-16T15:26:15","guid":{"rendered":"https:\/\/www.blopig.com\/blog\/?p=9897"},"modified":"2023-05-23T16:14:33","modified_gmt":"2023-05-23T15:14:33","slug":"streamlining-your-terminal-commands-with-custom-bash-functions-and-aliases","status":"publish","type":"post","link":"https:\/\/www.blopig.com\/blog\/2023\/05\/streamlining-your-terminal-commands-with-custom-bash-functions-and-aliases\/","title":{"rendered":"Streamlining Your Terminal Commands With Custom Bash Functions and Aliases"},"content":{"rendered":"\n

If you’ve ever found yourself typing out the same long commands over and over again, or if you’ve ever wished you could teleport directly to your favourite directories, then this post is for you.<\/p>\n\n\n\n

Before we jump into some useful examples, let’s go over what bash functions and aliases are, and how to set them up.<\/p>\n\n\n\n

Bash Functions vs Aliases<\/h2>\n\n\n\n

A bash function<\/strong> is like a mini script stored in your .bashrc<\/code> or .bash_profile<\/code> file. It can accept arguments, execute a series of commands, and even return a value.<\/p>\n\n\n\n\n\n\n\n

On the other hand, an alias<\/strong> is a simple shortcut for a command or a series of commands. It doesn’t handle arguments or complex logic like a bash function, but it’s great for quick and simple shortcuts.<\/p>\n\n\n\n

Here’s an example of a bash function:<\/p>\n\n\n\n

hello() {\n    echo \"Hello, $1\"\n}<\/pre>\n\n\n\n
And here’s an example of an alias:<\/p>\n\n\n\n
alias ll='ls -l'<\/pre>\n\n\nRead more: Streamlining Your Terminal Commands With Custom Bash Functions and Aliases<\/span><\/a>\n\n\n
To add a custom function or alias, simply add it to your ~\/.bashrc file, or ~\/.zshrc if using zsh. Don’t forget to source the file after updating it!<\/p>\n\n\n\n
Streamlining SLURM Commands<\/h2>\n\n\n\n
Working with SLURM commands can be a bit cumbersome, particularly if you’re running similar jobs repeatedly. Here’s where bash functions come into play. Let’s take a look at a couple of examples:<\/p>\n\n\n\n
slurm_run() {\n        srun --clusters=all -p \"$1\"-debug -D \"\/data\/localhost\/not-backed-up\/turnbull\" --pty \/bin\/bash\n}<\/pre>\n\n\n\n
slurm_run_gpu() {\n        srun --clusters=all --gpus 1 -p \"$1\"-debug -D \"\/data\/localhost\/not-backed-up\/turnbull\" --pty \/bin\/bash\n}<\/pre>\n\n\n\n
These functions let you quickly run interactive jobs on slurm, by simply typing slurm_run or slurm_run_gpu followed by the partition name, saving a lot of typing out and remembering of parameters!<\/p>\n\n\n\n
Quick Directory Access with Aliases<\/h2>\n\n\n\n
You might have certain directories that you access frequently. Typing out the full path every time can be a pain. Aliases are a great solution to this – here are a couple examples:<\/p>\n\n\n\n
alias data=\"cd \/vols\/opig\/users\/turnbull\/Data\"\nalias projects=\"cd \/data\/localhost\/turnbull\/Projects\"<\/pre>\n\n\n\n
Now, to go to your Data directory, you simply type data<\/code>. To go to your Projects directory, just type projects<\/code>. It’s as simple as that!<\/p>\n\n\n\n
Monitoring SLURM Jobs<\/h2>\n\n\n\n
If you’re running a lot of jobs, it’s helpful to keep an eye on their status. Here’s an alias for that:<\/p>\n\n\n\n
alias watch_slurm=\"watch squeue -u turnbull --clusters=all\"<\/pre>\n\n\n\n
Typing watch_slurm<\/code> will now keep a live update of your SLURM jobs.<\/p>\n\n\n\n
Conclusion<\/h2>\n\n\n\n
Custom bash functions and aliases are powerful tools that can significantly streamline your work in the terminal. They not only save time but also make your commands more readable.<\/p>\n","protected":false},"excerpt":{"rendered":"
If you’ve ever found yourself typing out the same long commands over and over again, or if you’ve ever wished you could teleport directly to your favourite directories, then this post is for you. Before we jump into some useful examples, let’s go over what bash functions and aliases are, and how to set them […]<\/p>\n","protected":false},"author":82,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"nf_dc_page":"","wikipediapreview_detectlinks":true,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"ngg_post_thumbnail":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[348,29,296],"tags":[344,412],"ppma_author":[667],"class_list":["post-9897","post","type-post","status-publish","format-standard","hentry","category-bash","category-code","category-hints-and-tips","tag-bash","tag-how-to"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"authors":[{"term_id":667,"user_id":82,"is_guest":0,"slug":"olivert","display_name":"Oliver Turnbull","avatar_url":"https:\/\/secure.gravatar.com\/avatar\/0b20bd3396ebbc89e8634a762722722d9168249244342ce2a0f4f6d05ed796eb?s=96&d=mm&r=g","0":null,"1":"","2":"","3":"","4":"","5":"","6":"","7":"","8":""}],"_links":{"self":[{"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/posts\/9897","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/users\/82"}],"replies":[{"embeddable":true,"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/comments?post=9897"}],"version-history":[{"count":3,"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/posts\/9897\/revisions"}],"predecessor-version":[{"id":9912,"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/posts\/9897\/revisions\/9912"}],"wp:attachment":[{"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/media?parent=9897"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/categories?post=9897"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/tags?post=9897"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/www.blopig.com\/blog\/wp-json\/wp\/v2\/ppma_author?post=9897"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}