mirror of https://github.com/shellcheck-py/shellcheck-py.git synced 2025-10-14 02:06:44 +08:00

python3/pip3 wrapper for installing shellcheck

Find a file

anthony sottile ce7b1d2e41 Some checks are pending main / main-windows (push) Waiting to run Details main / main-macos (push) Waiting to run Details main / main-macos-intel (push) Waiting to run Details main / main-linux (push) Waiting to run Details Merge pull request #151 from shellcheck-py/pre-commit-ci-update-config [pre-commit.ci] pre-commit autoupdate		2025-10-13 13:01:02 -04:00
.github/workflows	py310+	2025-10-09 17:48:13 -04:00
.gitignore	remove unneeded gitignore lines	2022-03-13 19:56:48 -04:00
.pre-commit-config.yaml	[pre-commit.ci] pre-commit autoupdate	2025-10-13 16:59:20 +00:00
.pre-commit-hooks.yaml	Improve documentation / pre-commit metadata	2019-11-05 10:02:41 -08:00
LICENSE	[license] Fill in name & year (#3 )	2019-11-04 17:13:34 -05:00
README.md	v0.11.0.1	2025-08-09 13:05:50 -04:00
setup.cfg	py310+	2025-10-09 17:48:13 -04:00
setup.py	Replace wheel's bdist_wheel with setuptools	2025-03-05 10:08:36 -05:00
tox.ini	py38-plus	2023-07-01 15:43:35 -04:00

shellcheck-py

A python wrapper to provide a pip-installable shellcheck binary.

Internally this package provides a convenient way to download the pre-built shellcheck binary for your particular platform.

pip install shellcheck-py

After installation, the shellcheck binary should be available in your environment (or shellcheck.exe on windows).

See pre-commit for instructions

Sample .pre-commit-config.yaml:

-   repo: https://github.com/shellcheck-py/shellcheck-py
    rev: v0.11.0.1
    hooks:
    -   id: shellcheck