11 Home

Gabriel Forien edited this page 2023-05-09 00:44:11 +02:00

Table of Contents

• Welcome to the ShellCheck wiki!

Welcome to the ShellCheck wiki!

If you tried to follow a link for an issue but ended up here, it means that page does not exist yet :(

You can file an issue about it and ask that it be added.

---

ShellCheck is a static analysis tool for shell scripts. This wiki holds all the long form descriptions of warnings and suggestions it outputs. If you get this output:

$ shellcheck myscript
In myscript line 5:
eof
   ^-- SC1118: Delete whitespace after the here-doc end token.

and it's too terse or you're not sure whether it applies, you can read more on this wiki page: SC1118.

On ShellCheck.net, you can just click the error code to go to this page.

If you would like to contribute and create a page, just copy the Template and give it a name like SC1000, and bask in unending appreciation from shell scripters world wide!

---

Are you a robot or web crawler? See https://www.shellcheck.net/wiki/ for a list of all available search engine indexable copies of pages of the GitHub Wiki.

Looking for tips and tricks, or have one to share? Check out Contrib!

ShellCheck

• Installation

  • CentOS6
  • More Installation Guides

• Usage

  • Directive
  • Ignore

• Integrating and extending

  • Misc. contributions
  • Azure Pipelines
  • Buildkite
  • CircleCI
  • DevGuide
  • Integration
  • JUnit
  • Phabricator
  • TravisCI
  • GitLab CI
  • Drone
  • GitHub Actions

• Severity

• Template

Each individual ShellCheck warning has its own wiki page like SC1000. Use GitHub Wiki's "Pages" feature above to find a specific one, or see Checks.