koalaman/shellcheck

ShellCheck, a static analysis tool for shell scripts

Open original source ↗

From the publisher

README & documentation

Source preview

Read the project’s overview, installation instructions and usage examples. The original README is the source of truth.

[](https://github.com/koalaman/shellcheck/actions/workflows/build.yml) ShellCheck is a GPLv3 tool that gives warnings and suggestions for bash/sh shell scripts: The goals of ShellCheck are to give cryptic error messages. cause a shell to behave strangely and counter-intuitively. advanced user's otherwise working script to fail under future circumstances. See the gallery of bad code for examples of what ShellCheck can help you identify! There are a number of ways to use ShellCheck! Paste a shell script on for instant feedback. ShellCheck.net is always synchronized to the latest git commit, and is the easiest way to give ShellCheck a go. Tell your friends! Run shellcheck yourscript in your terminal for instant output, as seen above. You can see ShellCheck suggestions directly in a variety of editors. While ShellCheck is mostly intended for interactive use, it can easily be added to builds or test suites. It makes canonical use of exit codes, so you can just add…

koalaman/shellcheck on GitHub A short preview, not the full document.

Read the full README ↗ · Preview checked 2026-10-31T13:46:02.534Z

Inside the original README — Document outline
  1. ShellCheck - A shell script static analysis tool
  2. Table of Contents
  3. How to use
  4. On the web
  5. From your terminal
  6. In your editor
  7. In your build or test suites
  8. Installing
  9. pre-commit
  10. Travis CI
  11. Installing a pre-compiled binary
  12. Compiling from source

Headings are captured from the source. Links open the publisher’s document, not a locally hosted copy.

Links from the README

References supplied by the publisher, not independently verified endorsements. Check the destination before downloading files or entering credentials.

Documentation belongs to its respective authors. Reported project/model license: GPL-3.0. A listing is not a grant of reuse or training rights. Confirm the document’s own terms at the source.

What this repository does

ShellCheck, a static analysis tool for shell scripts

Repository facts

Owner
koalaman
Primary language
Haskell
Stars
40,265
Forks
1,972
Open issues + pull requests
1,089
License
GPL-3.0
Archived
No
Default branch
master
Created
2012-11-17T03:15:11.000Z
Last push
2026-10-26T01:55:51.000Z

Topics and intended use

Owner-supplied topics: bash, developer-tools, haskell, linter, shell, static-analysis

Review the README for scope, installation, examples and limitations. We do not run repository code or certify it.

Evaluate before installing

Review licensing and dependencies, inspect recent commits and unresolved issues, and test in an isolated environment before production use. Stars and forks alone cannot answer these questions.

README and project files

Issues and maintenance discussion

Releases and changelog

Source and freshness

Source: GitHub. Metadata observed 2026-10-31T12:19:26.881Z. Daily imports are snapshots, not real-time monitoring.

Popularity and source listings do not establish security, suitability, licensing rights or benchmark performance.

Open original source

Related repositories