checkmate

# CheckMate | [![npm version](https://img.shields.io/npm/v/checkmateai.svg)](https://www.npmjs.com/package/checkmateai) [![Star on GitHub](https://img.shields.io/github/stars/richardsondx/checkmate?style=social)](https://github.com/richardsondx/checkmate/stargazers)

By [@Richardsondx](https://x.com/richardsondx)

[![CheckMate Demo](https://i3.ytimg.com/vi/fM8DmUkt7WY/maxresdefault.jpg)](https://youtu.be/fM8DmUkt7WY)


AI-powered specs verification that block bad code, see through hallucination, and prevent AI from breaking your code.

CheckMate is an AI Test Driven Development tool that challenges AI's overconfidence with a logical reasoning verification process using LLM.

It's built with Cursor AI in mind.

## Requirements

CheckMate works best with both API keys:

- **OpenAI API Key**: Required for GPT models (default `quick` verifier)
- **Anthropic API Key**: Required for Cursor models (default `reason` generator)

## Quick Setup

```bash
# Install globally
npm install -g checkmateai

# Initialize in your project
npx checkmateai init
```

That's it! `checkmate init` takes care of everything - creating directories, config files, and setting up Cursor integration.

It will setup your app and generate a checkmate rules folder with all the necessary rules:
   These rules will include:
   - pre-task.mdc - Runs before each task
   - post-task.mdc - Runs after each task
   - post-push.mdc - Runs after each push
   - spec-assistant.mdc - Helps with spec creation and format guidance
   - spec-linter.mdc - Automated linting and fixing of spec files
   - verification-trigger.mdc - Triggers feature verification workflow
   - autofix-enforcer.mdc - Enforces auto-fix attempts on failures
   - drift-detector.mdc - Detects spec-vs-code drift
   - non-interactive-mode.mdc - For headless CheckMate runs
   - ai-feature-validation-guidelines.mdc - Instructional guide for AI validation
   - ai-verify-llm-reasoning-workflow-docs.mdc - Documentation for LLM reasoning workflow


After