gitwtfhub

wtf is agentsmd-check?

7y-9/agentsmd-check — explained in plain English

Analysis updated 2026-05-18

19TypeScriptAudience · developerComplexity · 2/5LicenseSetup · easy

TL;DR

A command line tool that scans a repo's AGENTS.md file and checks whether its instructions are accurate, safe, and actually followable by AI coding agents.

Mindmap

mindmap
  root((repo))
    What it does
      Scans AGENTS.md files
      Flags stale instructions
      Flags unsafe commands
    Tech stack
      TypeScript
      Node.js
      GitHub Actions
    Use cases
      Catch broken build commands
      Catch missing referenced files
      Add CI check for docs
    Audience
      Developers using AI agents
      DevOps teams
    Checks
      Path existence
      Package script mismatch
      Dangerous curl pipe patterns
    Output
      Plain text report
      JSON output

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Why would anyone build with this?

REASON 1

Check that an AGENTS.md file's build and test commands still match the actual project setup.

REASON 2

Catch dangerous instructions like piping a downloaded script directly into sh before an agent runs them.

REASON 3

Add an automated CI check that fails a pull request if AGENTS.md goes stale.

REASON 4

Verify that every file path referenced in AGENTS.md actually exists in the repo.

What's in the stack?

TypeScriptNode.jsGitHub Actions

How it stacks up

7y-9/agentsmd-checkavacocloud/avaco-denobtahir/ironsheet
Stars191919
LanguageTypeScriptTypeScriptTypeScript
Setup difficultyeasymoderateeasy
Complexity2/53/53/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you spin it up?

Difficulty · easy Time to first run · 5min

Requires Node.js 24 or newer.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice and state changes you made.

Wtf does this do

agentsmd-check is a command line tool that scans a repository's AGENTS.md file and checks whether it is accurate, safe, and actually useful for AI coding agents to follow. AGENTS.md has become a kind of README written specifically for AI agents, describing a project's build commands, test commands, code style, and safety rules. The problem this tool addresses is that these files often go stale over time: they might tell an agent to run npm test when the project switched to pnpm, point to a documentation file that was deleted, or reference a Makefile target that no longer exists. The current version checks several things. It looks for a missing root AGENTS.md file, checks markdown formatting like headings and code blocks, verifies that referenced file paths actually exist, compares package manager lockfiles against the commands the file tells agents to run, flags dangerous patterns such as piping a downloaded script straight into sh, and checks whether important sections like testing or safety notes are missing entirely. The goal is not to grade writing quality, but to answer basic questions: can an agent actually follow these instructions, are the commands real, are the referenced files real, and are the instructions safe to run. It runs from the command line and requires Node.js 24 or newer. Once installed, running the check command prints a report listing each problem, the line it was found on, why it is a problem, and a suggested fix. It also supports JSON output for integrating with other tools, and a flag to fail the run on warnings, not just errors. A ready to use GitHub Actions configuration is included so the check can run automatically on every push or pull request. The project explicitly avoids running or hosting coding agents itself, replacing existing project documentation, managing prompts across a team, or forcing one universal AGENTS.md format on every project. It also will not silently rewrite a file without first showing the proposed change. This is described by its author as their first open source project, and they are looking for real examples of stale AGENTS.md instructions, false positives, and rule ideas grounded in an actual repository. It is released under the Apache 2.0 license.

Yoink these prompts

Prompt 1
Add agentsmd-check to my GitHub Actions workflow so it runs on every pull request.
Prompt 2
Explain what SCRIPT001 and PATH001 error codes mean in an agentsmd-check report.
Prompt 3
Help me fix a stale AGENTS.md file based on this tool's suggested fixes.
Prompt 4
Show me how to run agentsmd-check with JSON output for integrating into another tool.

Frequently asked questions

wtf is agentsmd-check?

A command line tool that scans a repo's AGENTS.md file and checks whether its instructions are accurate, safe, and actually followable by AI coding agents.

What language is agentsmd-check written in?

Mainly TypeScript. The stack also includes TypeScript, Node.js, GitHub Actions.

What license does agentsmd-check use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice and state changes you made.

How hard is agentsmd-check to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is agentsmd-check for?

Mainly developer.

View the repo → Decode another repo

This repo across BitVibe Labs

Don't trust strangers blindly. Verify against the repo.