shellcheck

Shell script static analysis tool. Check shell scripts for errors, usage of deprecated/insecure features, and bad practices. More information: <https://www.shellcheck.net>.

Install

All systems
curl cmd.cat/shellcheck.sh
Debian Debian
apt-get install ShellCheck
Ubuntu
apt-get install ShellCheck
Arch Arch Linux
pacman -S ShellCheck
image/svg+xml Kali Linux
apt-get install ShellCheck
Fedora
dnf install ShellCheck
Windows (WSL2)
sudo apt-get update sudo apt-get install ShellCheck
OS X
brew install ShellCheck
Raspbian
apt-get install ShellCheck

Shell script static analysis tool. Check shell scripts for errors, usage of deprecated/insecure features, and bad practices. More information: <https://www.shellcheck.net>.

  • Check a shell script:
    shellcheck path/to/script.sh
  • Check a shell script interpreting it as the specified shell dialect (overrides the shebang at the top of the script):
    shellcheck --shell sh|bash|dash|ksh path/to/script.sh
  • Ignore one or more error types:
    shellcheck --exclude SC1009,SC1073 path/to/script.sh
  • Also check any sourced shell scripts:
    shellcheck --check-sourced path/to/script.sh
  • Display output in the specified format (defaults to `tty`):
    shellcheck --format tty|checkstyle|diff|gcc|json|json1|quiet path/to/script.sh
  • Enable one or more optional checks:
    shellcheck --enable=add-default-case|avoid-nullary-conditions
  • List all available optional checks that are disabled by default:
    shellcheck --list-optional

© tl;dr; authors and contributors