ShellCheck: 39,456 GitHub Stars — 셸 스크립트 분석을 위한 완전 설치 및 설정 가이드 2026

# 패키지 인덱스 업데이트
sudo apt update

# ShellCheck 설치
sudo apt install -y shellcheck

# 버전 확인
shellcheck --version
# ShellCheck - shell script analysis tool
# version: 0.11.0
# license: GNU General Public License, version 3
# website: https://www.shellcheck.net

# DNF를 통해 설치
sudo dnf install -y shellcheck

# 버전 확인
shellcheck --version

# Homebrew를 통해 설치
brew install shellcheck

# 버전 확인
shellcheck --version

# Chocolatey를 통해 설치 (관리자 권한)
choco install shellcheck

# 버전 확인
shellcheck --version

# 로컬 설치 없이 Docker로 실행
docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:stable \
  /mnt/deploy.sh

# 현재 디렉토리 모든 스크립트 검사
docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:stable \
  /mnt/*.sh

# 재현 가능한 CI 빌드를 위해 특정 버전 고정
docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:v0.11.0 \
  /mnt/deploy.sh

# 저장소 클론
git clone https://github.com/koalaman/shellcheck.git
cd shellcheck

# Stack으로 빌드
stack install

# 또는 Cabal로 빌드
cabal update
cabal install

# .pre-commit-config.yaml에 추가
repos:
  - repo: https://github.com/koalaman/shellcheck-precommit
    rev: v0.11.0
    hooks:
      - id: shellcheck
        args: ["--severity=warning"]

// settings.json
{
  "shellcheck.executablePath": "shellcheck",
  "shellcheck.exclude": ["SC1090", "SC1091"],
  "shellcheck.severity": "warning",
  "shellcheck.run": "onType"
}

" .vimrc 또는 init.vim
let g:ale_linters = {
\   'sh': ['shellcheck'],
\}

" 저장 시 및 입력 중 실행
let g:ale_lint_on_save = 1
let g:ale_lint_on_text_changed = 'always'

-- init.lua (nvim-lspconfig)
require('lspconfig').bashls.setup {
  settings = {
    bashIde = {
      shellcheckPath = "shellcheck"
    }
  }
}

;; Flycheck와 함께 사용 (init.el)
(add-hook 'sh-mode-hook #'flycheck-mode)
(setq flycheck-shellcheck-severity "warning")

// SublimeLinter.sublime-settings
{
  "linters": {
    "shellcheck": {
      "executable": "shellcheck",
      "args": ["--severity=warning"]
    }
  }
}

# .github/workflows/shellcheck.yml
name: ShellCheck

on: [push, pull_request]

jobs:
  shellcheck:
    runs-on: ubuntu-latest
    steps:
      - name: 저장소 체크아웃
        uses: actions/checkout@v4

      - name: ShellCheck 실행
        uses: ludeeus/action-shellcheck@master
        env:
          SEVERITY: warning
        with:
          ignore_paths: >-
            ./vendor
            ./third_party

# .github/workflows/shellcheck-manual.yml
name: ShellCheck Manual

on: [push, pull_request]

jobs:
  shellcheck:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: ShellCheck 설치
        run: |
          wget -qO- "https://github.com/koalaman/shellcheck/releases/download/v0.11.0/shellcheck-v0.11.0.linux.x86_64.tar.xz" | tar -xJf -
          sudo cp "shellcheck-v0.11.0/shellcheck" /usr/local/bin/

      - name: 모든 셸 스크립트 린팅
        run: |
          find . -name "*.sh" -type f -print0 | \
            xargs -0 shellcheck --severity=warning --format=tty

# .gitlab-ci.yml
stages:
  - lint

shellcheck:
  stage: lint
  image: koalaman/shellcheck-alpine:stable
  script:
    - find . -name "*.sh" -type f -exec shellcheck --severity=warning {} +
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

// Jenkinsfile
pipeline {
    agent any

    stages {
        stage('ShellCheck') {
            steps {
                sh '''
                    #!/bin/bash
                    set -euo pipefail

                    if ! command -v shellcheck &> /dev/null; then
                        echo "ShellCheck 설치 중..."
                        apt-get update && apt-get install -y shellcheck
                    fi

                    find . -name "*.sh" -type f -print0 | \
                        xargs -0 shellcheck --severity=warning
                '''
            }
        }
    }

    post {
        failure {
            echo "ShellCheck에서 문제를 발견했습니다. 빌드 로그를 검토하세요."
        }
    }
}

# .circleci/config.yml
version: 2.1
orbs:
  shellcheck: circleci/shellcheck@3.2.0

workflows:
  lint:
    jobs:
      - shellcheck/check:
          severity: "warning"
          exclude: "SC1090,SC1091"

#!/bin/bash
# shellcheck disable=SC2086
echo $UNQUOTED_VAR  # 이 줄에서 SC2086 비활성화

# shellcheck disable=SC2034
UNUSED_VAR="이 변수는 할당되었지만 사용되지 않음"

# 블록 후 재활성화
# shellcheck enable=SC2086
echo "$PROPERLY_QUOTED"

# .shellcheckrc — 프로젝트 수준 구성
# 저장소 루트 또는 $HOME/.shellcheckrc에 배치

# shebang이 없는 스크립트의 셸 방언 설정
shell=bash

# 특정 검사 전역 제외
disable=SC1090,SC1091,SC2155

# 최소 심각도 설정 (error, warning, info, style)
severity=warning

# 선택적 검사 활성화
enable=require-variable-braces,check-set-e-suppressed

# 외부 소스 지정 (소스 파일의 경우)
external-sources=true

# 오류와 경고만 보고 (info/style 제외)
shellcheck --severity=warning script.sh

# 오류만 보고
shellcheck --severity=error script.sh

# 사람이 읽을 수 있는 터미널 출력 (기본)
shellcheck --format=tty script.sh

# JSON 출력 — 프로그래매틱 처리용
shellcheck --format=json script.sh > shellcheck-report.json

# CheckStyle XML (Jenkins, GitLab 호환)
shellcheck --format=checkstyle script.sh > shellcheck.xml

# GCC 호환 경고 (범용 에디터 통합)
shellcheck --format=gcc script.sh

# SARIF 출력 — GitHub Security 탭 통합
shellcheck --format=sarif script.sh > shellcheck.sarif

#!/bin/bash
set -euo pipefail

SEVERITY="warning"
SCRIPT_DIRS=("scripts/" "bin/" "deploy/")
EXCLUDES=()

# 제외 목록 구성
for code in SC1090 SC1091 SC2155; do
    EXCLUDES+=("-e" "$code")
done

# 모든 셸 스크립트 찾아서 린팅
find "${SCRIPT_DIRS[@]}" -name "*.sh" -type f -print0 | \
    xargs -0 shellcheck --severity="$SEVERITY" "${EXCLUDES[@]}"

echo "모든 스크립트가 심각도 $SEVERITY 로 ShellCheck 통과"

# .github/workflows/security-scan.yml
name: Security Scan
on: [push, pull_request]

jobs:
  scan:
    runs-on: ubuntu-latest
    permissions:
      security-events: write
      contents: read
    steps:
      - uses: actions/checkout@v4

      - name: ShellCheck SARIF 실행
        run: |
          find . -name "*.sh" -type f -print0 | \
            xargs -0 shellcheck --format=sarif > shellcheck.sarif || true

      - name: GitHub Security에 업로드
        uses: github/codeql-action/upload-sarif@v3
        if: always()
        with:
          sarif_file: shellcheck.sarif

# Dockerfile
FROM koalaman/shellcheck:stable AS lint
WORKDIR /scripts
COPY . .
RUN find . -name "*.sh" -exec shellcheck --severity=warning {} +

FROM alpine:3.20 AS runtime
COPY --from=lint /scripts/deploy.sh /usr/local/bin/
ENTRYPOINT ["/usr/local/bin/deploy.sh"]

#!/bin/bash
# ci-metrics.sh — 시간 경과에 따른 shellcheck 경고 수 추적

WARNINGS=$(find . -name "*.sh" -exec shellcheck --severity=warning --format=json {} + | \
    jq '. | length')

echo "shellcheck_warnings $WARNINGS" >> metrics.txt