getaiready/AIReady Check
Run AI readiness analysis and block PRs that break your AI context budget
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| directory | Directory to analyze | no | . |
| include | Comma-separated glob patterns to include (e.g., "**/*.{ts,py,java}") | no | — |
| exclude | Comma-separated glob patterns to exclude | no | — |
| threshold | Minimum AI readiness score (0-100) required to pass | no | 70 |
| fail-on | Fail on issues of this severity or higher (critical, major, any, none) | no | critical |
| fail-on-regression | Fail if the current score is lower than the last recorded baseline on the platform | no | false |
| tools | Tools to run (comma-separated). Defaults to all 9 analysis tools. | no | patterns,context,consistency,ai-signal,grounding,testability,doc-drift,deps,change-amp |
| upload-to-saas | Upload results to AIReady SaaS for historical tracking | no | false |
| api-key | AIReady API key (required if upload-to-saas is true) | no | — |
| repo-id | Repository ID in AIReady SaaS (required if upload-to-saas is true) | no | — |
Outputs
| name | description |
|---|---|
| score | Overall AI readiness score |
| passed | Whether the check passed (true/false) |
| issues | Number of issues found |
| critical | Number of critical issues |
| major | Number of major issues |