ShellCheck

CodeRabbit’s guide to ShellCheck.

ShellCheck is a linter for shell scripts.

CodeRabbit runs ShellCheck v0.11.0.

Files

ShellCheck will run on files with the following extensions:

• .sh
• .bash
• .ksh
• .dash

Configuration

enabled · boolean · default: true

Enable ShellCheck: ShellCheck is a static analysis tool that finds bugs in your shell.

.coderabbit.yaml

.coderabbit.yaml

reviews:
  tools:
    shellcheck:
      enabled: true

Web UI

In your organization or repository settings, go to Reviews → Tools and turn the tool on or off with its toggle.

CodeRabbit passes the following ShellCheck options based on the selected profile:

Chill

--severity=warning

Assertive

--severity=style

When we skip ShellCheck

CodeRabbit will skip running ShellCheck when:

• ShellCheck is already running in GitHub workflows.

Links

• ShellCheck Wiki