Reference

CLI and GitHub Action

Command-line usage, flags, exit codes, and the composite GitHub Action.

CLI

npx -y github:epistemedeus/ai-readiness yoursite.com
npx -y github:epistemedeus/ai-readiness yoursite.com --json
npx -y github:epistemedeus/ai-readiness mcp   # start the stdio MCP server

The CLI (index.js) prints a scored report with PASS/WARN/FAIL lines and a fix hint per gap. Flags and behaviors:

  • --json: print the raw run() result as JSON and exit 0
  • mcp or --mcp: switch to the stdio MCP server instead of the one-shot check
  • Package bins: ai-readiness (CLI and MCP launcher) and ai-readiness-mcp (MCP server directly) (package.json)
  • Errors (bad URL, non-public host, fetch failure) print to stderr and exit 1

GitHub Action

The repo doubles as a composite action (action.yml): input url (required), runs the CLI against it. Example:

- uses: epistemedeus/ai-readiness@main
  with:
    url: https://yoursite.com
Built withSourcey