koalamankoalaman/shellcheck/.claude/CLAUDE.md

shellcheck

CLAUDE.md40k starsChanged 16 months agoGPL-3.0View on GitHub

For interactive development, use cabal repl then :load ShellCheck.Debug. After editing, reload with :r and test with shellcheckString "your shell code". To inspect the AST without an interactive session: ShellCheck…

We split this CLAUDE.md into the rules it gives an agent

5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.

Licensed with conditions — read it at the source. We count its rules but don't quote them. Read them on GitHub.

≈ “Common” is an estimate: at least 1 in 5 of the 25,680 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Jul 22, 2018Package request: shellcheck — termux/termux-packages16 reactions · 18 comments
Mar 11, 2020Create rego code-documentation support to support generating documentation about policies — open-policy-agent/opa14 reactions · 22 comments
Sep 25, 2020New quick fix options to disable the rule for the line, file or the project — vscode-shellcheck/vscode-shellcheck10 reactions · 11 comments
Sep 30, 2017Implement shellcheck in CI — bats-core/bats-core8 reactions · 6 comments
Jan 7, 2023Bundle ShellCheck executables for most platforms — bash-lsp/bash-language-server6 reactions · 12 comments

30 more on GitHub

Apr 15, 2021Wiki: Show number of pages. — refined-github/refined-github6 reactions · 4 comments
Nov 10, 2018Include Shellcheck utility — clearlinux/distribution6 reactions · 7 comments
Feb 6, 2015Mention shellcheck — progrium/bashstyle6 reactions · 3 comments
Jun 27, 2022Docs: Add rationale to rules — typescript-eslint/typescript-eslint5 reactions · 2 comments
Aug 11, 2017Feature request: Establish a pattern of providing a link to explain a lint failure — squizlabs/PHP_CodeSniffer5 reactions · 2 comments
Feb 14, 2017Provide Rationale Reference — ansible/ansible-lint5 reactions · 2 comments
Mar 4, 2016Upstream issues — aurutils/aurutils5 reactions · 9 comments
Apr 6, 2025[Wolfi Package Request]: shellcheck — wolfi-dev/os4 reactions · 3 comments
Mar 1, 2021Terrascan rule classification with numbering/coding and extra details — tenable/terrascan4 reactions · 2 comments
Feb 26, 2021npm seems to install an older version of git-open — paulirish/git-open4 reactions
Sep 21, 2020Add shellcheck linter — micro-editor/micro4 reactions · 2 comments
Jan 18, 2023Run shellcheck for <nixpkgs>.writers scripts — cachix/git-hooks.nix3 reactions
Mar 26, 2021Fix container image build — djrobstep/migra3 reactions · 3 comments
Aug 4, 2020[sof-test] add set -e to all test cases (Unless You Love Debugging) — thesofproject/sof-test3 reactions · 9 comments
Nov 15, 2019Make shellcheck docker image version configurable — buildkite-plugins/shellcheck-buildkite-plugin3 reactions · 2 comments
Dec 29, 2017Intergrating shellcheck in to travis — GameServerManagers/LinuxGSM3 reactions · 3 comments
Aug 18, 2016Shellcheck — mchav/with3 reactions · 1 comment
Oct 12, 2026fix(ci): ride out GitHub release 5xx bursts in the actionlint toolchain fetch — JovieInc/Jovie2 reactions · 2 comments
Aug 4, 2025shellcheck 0.11.0 — Homebrew/homebrew-core2 reactions · 1 comment
Jun 12, 2025Allow selecting subpath of archives in `ADD` — moby/buildkit2 reactions · 2 comments
Jan 2, 2025🐛 Fix: Correct absolute path for shebang in shell script — jpanther/congo2 reactions · 3 comments
Jun 23, 2024Bump shellcheck to latest v0.10.0 release — etcd-io/etcd2 reactions
Apr 29, 2024pre-commit handling — redhat-plumbers-in-action/differential-shellcheck2 reactions · 1 comment
Mar 21, 2024Support the --rcfile flag when running Shellcheck — super-linter/super-linter2 reactions · 1 comment
Feb 9, 2024Use pre-commit in CI — ComputationalRadiationPhysics/picongpu2 reactions · 7 comments
Dec 12, 2023Update default shellcheck to latest stable — CircleCI-Public/shellcheck-orb2 reactions · 1 comment
Nov 2, 2022Not working on docker-compose.yaml output filled with `No linters found for "Log"` — fnando/vscode-linter2 reactions · 1 comment
May 20, 2022Double quote `$XDG...` in shell exports — b3nj5m1n/xdg-ninja2 reactions · 3 comments
Dec 10, 2021[Icon Request] Support for ShellCheck — vscode-icons/vscode-icons2 reactions · 7 comments
Sep 3, 2016JSON output, checkstyle compatible — client9/misspell2 reactions

On Stack Overflow · 30

Nov 21, 2008What's a concise way to check that environment variables are set in a Unix shell script?616 votes
Feb 15, 2012How to read a space-delimited string into an array in Bash?462 votes
May 12, 2015What does this error mean? (SC2129: Consider using { cmd1; cmd2; } >> file instead of individual redirects.)35 votes
Oct 28, 2019Why does shellcheck fail when a source file is representing the variables at the top of a script?30 votes
Oct 28, 2019Why does shellcheck fail when a source file is representing the variables at the top of a script?29 votes · 5 answers

25 more on Stack Overflow

Mar 7, 2017Is there a linter for fish like there is for bash with shellcheck?23 votes · 2 answers
Aug 7, 2021How do you fix or mask a 1091 error found with shellcheck when including a source in a bash script?9 votes · 2 answers
Aug 26, 2020openBinaryFile: does not exist (No such file or directory) when using shellcheck8 votes
Mar 6, 2023Prettier shell script format6 votes
Aug 8, 2021How do you fix or mask a 1091 error found with shellcheck when including a source in a bash script?5 votes
Oct 12, 2018Bash script command and getting rid of shellcheck error SC21815 votes · 1 answer
Oct 8, 2021How can prevent bash tokenising string variable expansion?4 votes
May 4, 2022Correct usage of find and while-read loop in different formats?3 votes · 1 answer
Mar 3, 2022How to get the list of files in a directory in a shell script?3 votes
Feb 12, 2021bash EOF in if statement3 votes
Feb 27, 2018Cannot figure out how to fix shellcheck complaint that I should not use a glob as a command when starting one script from another3 votes · 1 answer
Nov 6, 2015syntax error near unexpected token `(' (possible bash bug)3 votes
Feb 15, 2022How to check if a process id (PID) exists2 votes
Nov 15, 2021Bash script to find factorial2 votes
Jul 16, 2021Checking Regular File and Directory Ownership and Group Membership in a Bash Shell Script2 votes
May 20, 2021How to Prefix Substrings in a Space-Delimited String in Shell Script2 votes
Apr 29, 2020Quoting a path in linux2 votes
Mar 1, 2018Cannot source bash script - unexpected end of file2 votes
Aug 13, 2024Why does shellcheck fail when a source file is representing the variables at the top of a script?1 vote
Aug 23, 2022Shell script: use if on environmental variable1 vote
Apr 1, 2022How to split string into parameters in bash?1 vote
Feb 14, 2022How to write bash function to print and run command when the command has arguments with spaces or things to be expanded1 vote
Mar 2, 2018Echo PHP into file linux1 vote
Aug 5, 2017Conditional in Docker argument in Bash1 vote · 2 answers
Jul 31, 2015Terminal - run 'file' (file type) for the whole directory1 vote

On YouTube · 13

Apr 27, 2021Fix Your Shell Scripts With Shellcheck — DistroTube15k views · 65 comments
Jul 27, 2019Easily check errors in shell scripts using ShellCheck on Windows, Mac & Linux [Hindi] — TechChip6.6k views · 113 comments
Aug 7, 2022ShellCheck : Vérifiez vos scripts shell — Adrien Linuxtricks3.8k views · 30 comments
May 5, 2020Linting and Improving Your Bash Scripts with ShellCheck — Nick Janetakis2.4k views · 7 comments
Feb 18, 2022Write Better Bash Scripts! Use ShellCheck and shfmt — Tom on the Internet1.5k views · 5 comments

8 more on YouTube

Apr 30, 2026ShellCheck Saves You — Hack the Clown1.1k views · 19 comments
Apr 26, 2022Test If Your Shell Scripts Are POSIX Compliant with ShellCheck — Nick Janetakis1k views
May 17, 2022ShellCheck's -x Flag Lets You Source Files without SC1091 Warnings — Nick Janetakis668 views · 2 comments
Apr 12, 2022Respecting the cd or exit Pattern Suggested by ShellCheck SC2164 — Nick Janetakis375 views · 1 comment
Jun 24, 2020BASH #2 if else, case Условия и переключатели — NixScript258 views
Jan 27, 2026Command Injection in Bash Arithmetic Expressions | A Subtle Bug You Didn't Know Existed — ruatelo37 views
Aug 8, 2020Unix & Linux: How can I read line by line from a variable in bash? (6 Solutions!!) — Roel Van de Paar31 views
Jan 9, 2026Binärgewitter Talk #152: 3rd Party BIOS-Zulieferer — Binaergewitter3 views

On Hacker News · 13

Mar 18, 2021ShellCheck: A static analysis tool for shell scripts399 points · 73 comments
Mar 2, 2016ShellCheck – A shell script static analysis tool7 points
Dec 22, 2016ShellCheck, a static analysis tool for shell scripts6 points
Jan 5, 2020ShellCheck: Lint for Shell Scripts5 points · 1 comment
Nov 7, 2021Shellcheck Version 0.8.0 Released4 points · 1 comment

8 more on Hacker News

Apr 25, 2017Shellcheck linter rule SC2002: Useless use of cat4 points
Dec 30, 2025Gallery of Bad Shell Code3 points
Mar 31, 2017ShellCheck – A shell script static analysis tool3 points
Sep 14, 2022ShellCheck: Shell script static analysis tool2 points
Aug 4, 2015ShellCheck, a static analysis tool for shell scripts2 points
Jul 7, 2014ShellCheck - A shell script static analysis tool2 points
Jul 30, 2019ShellCheck – a static analysis tool for shell scripts1 point
May 29, 2014ShellCheck, a static analysis tool for shell scripts, written in Haskell1 point

On Bluesky · 5

Nov 5, 2025ShellCheck : un outil d’analyse statique Open Source pour détecter les erreurs, mauvaises pratiques et problèmes de portabilité dans les… — @bearstech.com12 likes and reposts
Dec 4, 2024Also discovered ShellCheck for linting shell scripts. So `local readonly myvar` is wrong. That should be `local -r myvar` 🤷… — @tdpauw.bsky.social3 likes and reposts
Jan 28, 2025Shellcheck would have caught this for me. github.com/koalaman/she... — @acjay.com2 likes and reposts
Jul 4, 2024シェルスクリプトの静的解析ツールの shellcheck を試してみた。 github.com/koalaman/she... 自分はシェルスクリプトは雰囲気でしか使ってなかったけど、落とし穴の多い言語なので、指摘は勉強になるね。… — @msakai.bsky.social2 likes and reposts
Feb 10, 2026github.com/koalaman/she... ほえーこれ haskell で書かれてたのかすげえ — @senkenn.dev1 likes and repost

On the web · 5

Jun 8, 2024Consider adding Shellcheck to the project · Issue #45 — google.com
Nov 14, 2023include shell in ShellCheck Docker image for glob support — google.com
Feb 21, 2020Support PKGBUILD files · Issue #1843 · koalaman/shellcheck — google.com
Jun 18, 2019Also handle SCRIPTDIR with source directive #1617 — google.com
Sep 22, 2015Document and implement return values of shellcheck #470 — google.com

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free