Please note, this engine is currently under development and not currently available on the CodeClimate platform.

codeclimate-shellcheck is a Code Climate engine that wraps ShellCheck. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.

ShellCheck is a static analysis tool for shell scripts.

1. If you haven't already, install the Code Climate CLI.
2. Run codeclimate engines:enable shellcheck. This command both installs the engine and enables it in your .codeclimate.yml file.
3. You're ready to analyze! Browse into your project's folder and run codeclimate analyze.

For help with ShellCheck, check out their documentation.

If you're running into a Code Climate issue, first look over this project's GitHub Issues, as your question may have already been covered. If not, go ahead and open a support ticket with us.