{"_id":"@brandongtr/rule-agent-cli","name":"@brandongtr/rule-agent-cli","dist-tags":{"beta":"1.0.1-beta.0","latest":"1.0.1-beta.0"},"versions":{"1.0.1-beta.0":{"name":"@brandongtr/rule-agent-cli","version":"1.0.1-beta.0","description":"A CLI tool to review git diffs against cursor rules using Claude Code","type":"module","main":"dist/index.js","bin":{"rule-review":"dist/index.js"},"scripts":{"build":"tsc","start":"node dist/index.js","dev":"tsx src/index.ts","test":"echo \"No tests yet\" && exit 0","lint":"echo \"No linting configured\" && exit 0"},"keywords":["cli","git","review","cursor","rules","claude","code-review","typescript"],"author":{"name":"Brandon GTR"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/brandongtr/rule-agent-cli.git"},"bugs":{"url":"https://github.com/brandongtr/rule-agent-cli/issues"},"homepage":"https://github.com/brandongtr/rule-agent-cli#readme","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"dependencies":{"@anthropic-ai/claude-code":"^1.0.0","commander":"^12.0.0","dotenv":"^16.0.0"},"devDependencies":{"@types/node":"^20.0.0","tsx":"^4.0.0","typescript":"^5.0.0"},"_id":"@brandongtr/rule-agent-cli@1.0.1-beta.0","gitHead":"8fa8cf25da7a2ad2999b4adc1c6fb8744517c96a","types":"./dist/index.d.ts","_nodeVersion":"18.20.8","_npmVersion":"10.8.2","dist":{"integrity":"sha512-M+DY7fzs98fwaKNE0rcSFTaINgZ9dLO/NnklLNjs73UbuK0K9GmjZV7ZNKkFipjkJOdH6IeS85fV3xFzYlmq1g==","shasum":"7b553f30fd2a9efbe8a7bfc7bd968a6d3b77f26c","tarball":"https://registry.npmjs.org/@brandongtr/rule-agent-cli/-/rule-agent-cli-1.0.1-beta.0.tgz","fileCount":27,"unpackedSize":42643,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCG4UJFuJTOhkvMQR5EDjP7VWz2R30jITGeQ8p0ECmhqQIhALggvGOmzRE8cmIqwSvMKfSlcbLPVbj7AMBSutw7c3t6"}]},"_npmUser":{"name":"niubrandon","email":"niubrandon@gmail.com","actor":{"name":"niubrandon","email":"niubrandon@gmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"niubrandon","email":"niubrandon@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/rule-agent-cli_1.0.1-beta.0_1751558356311_0.36860492586038496"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-03T15:59:16.230Z","1.0.1-beta.0":"2025-07-03T15:59:16.501Z","modified":"2025-07-03T15:59:16.787Z"},"maintainers":[{"name":"niubrandon","email":"niubrandon@gmail.com"}],"description":"A CLI tool to review git diffs against cursor rules using Claude Code","homepage":"https://github.com/brandongtr/rule-agent-cli#readme","keywords":["cli","git","review","cursor","rules","claude","code-review","typescript"],"repository":{"type":"git","url":"git+https://github.com/brandongtr/rule-agent-cli.git"},"author":{"name":"Brandon GTR"},"bugs":{"url":"https://github.com/brandongtr/rule-agent-cli/issues"},"license":"MIT","readme":"# Rule Agent CLI\n\nA TypeScript CLI tool that reviews git diffs against cursor rules using Claude Code SDK.\n\n## Features\n\n- 🔍 Review git commits or unstaged changes against cursor rules\n- 📋 Auto-detects cursor rules from `.cursorrules` or `.cursor/rules/*.mdc`\n- 🤖 Uses Claude Code SDK for intelligent rule analysis\n- 📊 Provides violations, suggestions, and summaries for each file\n\n## Installation\n\n### From npm (Recommended)\n\n```bash\n# Install globally\nnpm install -g @brandongtr/rule-agent-cli\n\n# Or use with npx (no installation required)\nnpx @brandongtr/rule-agent-cli rule-review --help\n```\n\n### From Source\n\n1. Clone and install dependencies:\n```bash\ngit clone https://github.com/brandongtr/rule-agent-cli.git\ncd rule-agent-cli\nnpm install\n```\n\n2. Set up environment variables:\n```bash\ncp .env.example .env\n# Edit .env and add your ANTHROPIC_API_KEY\n```\n\n3. Build the project:\n```bash\nnpm run build\n```\n\n## Usage\n\n### Basic Commands\n\n```bash\n# Review latest commit against auto-detected rules\nrule-review rule-review\n\n# Review specific file in latest commit\nrule-review rule-review --file src/index.ts\n\n# Review unstaged changes\nrule-review rule-review --commit unstaged\n\n# Use custom rules file\nrule-review rule-review --rules .cursor/rules/typescript.mdc\n\n# Combine options: review specific file in unstaged changes\nrule-review rule-review -f src/utils/git.ts -c unstaged\n\n# Review specific commit by hash\nrule-review rule-review -c abc1234\n\n# Review with custom rules and specific file\nrule-review rule-review -r my-rules.md -f src/index.ts\n```\n\n### Using with npx\n\n```bash\n# No installation required - run directly\nnpx @brandongtr/rule-agent-cli rule-review\n\n# Review unstaged changes\nnpx @brandongtr/rule-agent-cli rule-review -c unstaged\n\n# Review specific file\nnpx @brandongtr/rule-agent-cli rule-review -f src/index.ts\n```\n\n### Command Line Options\n\n| Flag | Long Form | Argument | Description |\n|------|-----------|----------|-------------|\n| `-f` | `--file` | `<file>` | Specific file to review (filters diff to single file) |\n| `-c` | `--commit` | `<commit>` | Git commit/reference to review (default: `HEAD`) |\n| `-r` | `--rules` | `<rules>` | Custom path to cursor rules file |\n| `-h` | `--help` | - | Display help information |\n| `-V` | `--version` | - | Display version number |\n\n### Special Commit Values\n\n- `HEAD` (default) - Review the latest commit\n- `unstaged` - Review uncommitted changes in working directory  \n- `<commit-hash>` - Review specific commit by hash\n- `<branch-name>` - Review latest commit on specified branch\n\n### Cursor Rules Detection\n\nThe tool automatically detects cursor rules from:\n1. `.cursorrules` (traditional format)\n2. `.cursor/rules/*.mdc` (new Cursor IDE format)\n3. Custom path via `-r` option\n\n## Environment Variables\n\nRequired:\n- `ANTHROPIC_API_KEY` - Your Anthropic API key\n\nOptional:\n- `CLAUDE_MODEL` - Claude model to use (default: claude-3-5-sonnet-20241022)\n- `ANTHROPIC_BASE_URL` - API base URL (default: https://api.anthropic.com)\n\n## Development\n\n```bash\n# Run in development mode\nnpm run dev\n\n# Build TypeScript\nnpm run build\n\n# Run built version\nnpm start\n```\n\n## Example Output\n\n```\n🔍 Starting rule review...\n📋 Loaded rules from: .cursor/rules/general.mdc\n📄 Analyzing unstaged changes for src/index.ts\n📊 Found 1 file(s) with changes\n\n🔎 Analyzing: src/index.ts\n\n📋 Results for src/index.ts:\n❌ Rule Violations:\n   1. Use of console.log in src/index.ts:8 violates the 'No console log' rule\n\n💡 Suggestions:\n   1. Remove console.log statement or replace with proper logging mechanism\n   2. Use const/let instead of var for variable declaration\n   3. Consider removing badFunction if not used\n\n📝 Summary: The code changes introduce a function with a console.log statement that violates cursor rules. The function also uses outdated var declaration.\n\n✨ Rule review completed!\n```\n\n## Help Output\n\n```\n$ rule-review rule-review --help\nUsage: rule-review rule-review [options]\n\nReview git diffs against cursor rules\n\nOptions:\n  -f, --file <file>      Specific file to review\n  -c, --commit <commit>  Specific commit to review (default: HEAD)\n  -r, --rules <rules>    Path to cursor rules file (default: .cursorrules)\n  -h, --help             display help for command\n```\n","readmeFilename":"README.md","_rev":"1-656655ad622b4b3b3862fad5ac517409"}