Agent Friendly Code

koalaman/shellcheck

GitHub
https://github.com/koalaman/shellcheck

ShellCheck, a static analysis tool for shell scripts

Stars:
40.2k
Language:
Haskell
Default branch:
master
Last scored:
Overall

At a glance

Rank
#342 of 401
#6 of 7 Haskell repos
Checks passed
7 of 16
Full list below
Best set up for
GPT-5 Codex
Score 60.0
Needs most work for
Aider
Biggest fix: .aider.conf.yml (+14.1 pts)

What it has

What it's missing

What to fix first

Pick an AI agent

Showing fixes for Claude Code

  1. 1
    AGENTS.md / CLAUDE.md
    Add an AGENTS.md covering project goals, layout, setup commands, and conventions. Aim for 800+ chars of real guidance (not boilerplate).
    +13.2 pts
  2. 2
    Reproducible dev env
    Add a Makefile or devcontainer or Dockerfile so the agent can set up the project in one command.
    +11.8 pts
  3. 3
    Linter / formatter config
    Configure a linter/formatter (ESLint+Prettier, Biome, Ruff, rustfmt+clippy, golangci-lint) and commit the config.
    +7.9 pts

Score for each AI agent

Each agent looks for different things in a repo, based on its own docs. Under each score are the three checks it cares about most; the agent's name links to its leaderboard. How each agent is scored →

GPT-5 Codex
#329 of 401
60.0
  • AGENTS.md / CLAUDE.md
  • README
  • Test suite
Devin
#344 of 401
59.7
  • Reproducible dev env
  • Dependency manifest
  • Test suite
Claude Code
#336 of 401
56.6
  • AGENTS.md / CLAUDE.md
  • Test suite
  • Reproducible dev env
Kimi CLI
#342 of 401
56.3
  • AGENTS.md / CLAUDE.md
  • Test suite
  • Dependency manifest
Pi
#338 of 401
56.3
  • AGENTS.md / CLAUDE.md
  • Test suite
  • Linter / formatter config
Gemini CLI
#323 of 401
55.7
  • GEMINI.md
  • README
  • Test suite
Cursor
#324 of 401
55.4
  • Cursor rules (.cursor/rules)
  • README
  • Type configuration
OpenHands
#351 of 401
54.2
  • CI configuration
  • Dependency manifest
  • Reproducible dev env
Aider
#326 of 401
52.1
  • .aider.conf.yml
  • Linter / formatter config
  • Test suite

Does koalaman/shellcheck have agent instructions?

An AGENTS.md (or CLAUDE.md) at the root tells AI coding agents how to build, test and work in the repo. A few agents also read a file of their own.

AGENTS.md / CLAUDE.md
None at the root (no AGENTS.md, CLAUDE.md or AGENT.md)
Agent-specific files
None: no GEMINI.md, .cursor/rules, .openhands/setup.sh or .aider.conf.yml
Repos that have one
0 of 7 Haskell repos · 214 of 401 repos on the leaderboard · See examples →

All 16 checks · 7 passed

AGENTS.md / CLAUDE.md· 0% pass
No agent instructions file found
.aider.conf.yml· 0% pass
No .aider.conf.yml at repo root
CI configuration· 100% pass
1 GitHub Actions workflow
.github/workflows
CONTRIBUTING guide· 0% pass
No CONTRIBUTING file
Cursor rules (.cursor/rules)· 0% pass
No .cursor/rules/*.mdc or .cursorrules
Dependency manifest· 100% pass
Manifest present
stack.yaml
Reproducible dev env· 0% pass
No Makefile / devcontainer / Docker / equivalent found
GEMINI.md· 0% pass
No GEMINI.md at repo root
License file· 100% pass
License present
LICENSE
Linter / formatter config· 0% pass
No linter/formatter config found
.openhands/setup.sh· 0% pass
No .openhands/setup.sh
Pre-commit / git hooks· 0% pass
No pre-commit / husky / lefthook found
README· 100% pass
README detailed (21,155 characters)
README.md
Manageable size· 100% pass
71 files
Test suite· 100% pass
Found /test
test
Type configuration· 100% pass
Typed language (Haskell)

How koalaman/shellcheck compares

vs leaderboard average
12.6 pts below
Average 68.9
vs Haskell average
7.7 pts below
Average 64.0
Stars among Haskell repos
#2 of 7

Missing here, and how many repos have it

  • CONTRIBUTING guide · passed by 86% of leaderboard repos, 71% of Haskell repos
  • Linter / formatter config · passed by 66% of leaderboard repos, 0% of Haskell repos
  • Pre-commit / git hooks · passed by 29% of leaderboard repos, 0% of Haskell repos

Passes checks most repos miss

  • Manageable size · only 17% of repos pass it

One fix for the most agents: AGENTS.md / CLAUDE.md would raise the score for all 9 agents, by up to 14.1 points.

Similar repos

Same language and host as this repo, closest in overall score.

All Haskell repos →

Add a badge to your README

Paste this at the top of the README. It shows the score, and links back to this page.

Agent friendly score for github/koalaman/shellcheck
[![Agent Friendly](https://agentfriendlycode.com/api/badge/github/koalaman/shellcheck.svg)](https://agentfriendlycode.com/repo/github/koalaman/shellcheck)

Check the score on every pull request

A GitHub Action posts one comment per pull request with how the score changed and why.