Skip to content
HALOWERK

Codewerk

shellcheck

Runs the official statically linked ShellCheck 0.11.0 release binary (GPL-3.0, SHA-256 checked against the GitHub release digest) on your script in an isolated, resource-limited child process without network, shell or configuration files (--norc, sourced files are never followed). The dialect comes from the shebang or the shell field (sh, bash, dash, ksh, busybox). Results are taken from ShellCheck JSON output (json1); with fix=true the unified diff of ShellCheck's own auto-fixes is.

POST https://code.halowerk.com/v1/shellcheck

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
scriptstringYesThe shell script text (UTF-8, max. 1 MB).
shellstringNoDialect; default: taken from the shebang.
severitystringNoMinimum severity to report.
excludearrayNoSC codes to suppress, e.g. ["SC2086"].
enablearrayNoOptional checks to enable (shellcheck --list-optional).
fixbooleanNoAlso return ShellCheck's auto-fix as unified diff.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "script"
  ],
  "properties": {
    "script": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000000,
      "description": "The shell script text (UTF-8, max. 1 MB)."
    },
    "shell": {
      "type": "string",
      "enum": [
        "sh",
        "bash",
        "dash",
        "ksh",
        "busybox"
      ],
      "description": "Dialect; default: taken from the shebang."
    },
    "severity": {
      "type": "string",
      "enum": [
        "error",
        "warning",
        "info",
        "style"
      ],
      "default": "style",
      "description": "Minimum severity to report."
    },
    "exclude": {
      "type": "array",
      "maxItems": 100,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^SC[0-9]{4}$"
      },
      "description": "SC codes to suppress, e.g. [\"SC2086\"]."
    },
    "enable": {
      "type": "array",
      "maxItems": 20,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "add-default-case",
          "avoid-negated-conditions",
          "avoid-nullary-conditions",
          "check-extra-masked-returns",
          "check-set-e-suppressed",
          "check-unassigned-uppercase",
          "deprecate-which",
          "quote-safe-variables",
          "require-double-brackets",
          "require-variable-braces",
          "useless-use-of-cat",
          "all"
        ]
      },
      "description": "Optional checks to enable (shellcheck --list-optional)."
    },
    "fix": {
      "type": "boolean",
      "default": false,
      "description": "Also return ShellCheck's auto-fix as unified diff."
    }
  }
}

Open original schema

Published input example

{
  "script": "#!/bin/bash\nfor f in $(ls *.txt); do\n  cat $f\ndone\n",
  "fix": true
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’