Description
ShellCheck is an open-source static analysis tool that finds bugs in shell scripts before they run. It points out quoting mistakes, portability problems, mismatched shebangs, and higher-level semantic issues such as unused or misused variables and wrong test syntax, with explanations you can act on. The site runs ShellCheck in the browser, so you can paste a script into the editor and see the output without installing anything, and it also offers a random example to try. Installing ShellCheck is possible with cabal, apt, dnf, pkg or brew, and it is already packaged for most Linux distributions and many package managers. It is supported as an integrated linter in major code editors, and it is available in code-quality services such as CodeClimate, Codacy and CodeFactor, which can check a GitHub repository automatically. The project is released under the GPLv3 license, which the site calls free as in freedom. The documentation lives on the ShellCheck wiki, with the source on GitHub, and the tool is written in Haskell. ShellCheck works by reading the script and cannot know what a command will do at runtime, so treat its warnings as strong hints to review rather than proof of a bug.…
Highlights
- Static analysis for shell scripts that finds bugs before they run
- Explanations of quoting, portability and semantic issues
- Browser editor to paste and check a script
- Packaged for many distributions and editors
- GPLv3 open source
Ratings & Reviews
No ratings yet
Be the first to rate Shellcheck.
People also visit
Teleport
Certificate authority and access plane for SSH, Kubernetes, web applications
Shellcheck FAQ
What does ShellCheck check?
Common bugs in shell scripts, including quoting, portability and some higher-level semantic problems.
Do I need to install it?
No. You can paste a script into the browser editor. It is also packaged for many systems.
Can I run it in my editor?
Yes. It is supported as an integrated linter in major editors.
Does it prove a script is buggy?
No. It reads the script without running it, so its warnings are strong hints to review.
What are the best Shellcheck alternatives?
Popular alternatives to Shellcheck include Murex, Rumdl and 1build. See all Shellcheck alternatives