ShellCheck

File_closed07 · Jul 7, 2020

ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell scripts.

The goals of ShellCheck are

To point out and clarify typical beginner’s syntax issues that cause a shell to give cryptic error messages.
To point out and clarify typical intermediate level semantic problems that cause a shell to behave strangely and counter-intuitively.
To point out subtle caveats, corner cases and pitfalls that may cause an advanced user’s otherwise working script to fail under future circumstances.

Installing

The easiest way to install ShellCheck locally is through your package manager.

On systems with Cabal (installs to ~/.cabal/bin):

Code:
cabal update

cabal install ShellCheck

On Debian based distros:

Code:
apt-get install shellcheck

On Arch Linux based distros:

Code:
pacman -S shellcheck

On Gentoo based distros:

Code:
emerge --ask shellcheck

On EPEL based distros:

Code:
yum -y install epel-release
yum install ShellCheck

On Fedora based distros:

Code:
dnf install ShellCheck

On OS X with homebrew:

Code:
brew install shellcheck

On OS X with MacPorts:

Code:
port install shellcheck

On openSUSE:Tumbleweed:

Code:
zypper in ShellCheck