agent-rules

<!-- markdownlint-disable --> <p align="center"><h1 align="center"> agent-rules </h1> </p> <p align="center"> Rules and instructions for agentic coding tools like Cursor, GitHub Copilot, Claude CLI and Gemini CLI. </p> <p align="center"> <a href="https://www.npmjs.com/package/agent-rules"><img src="https://badgen.net/npm/v/agent-rules" alt="npm version"/></a> <a href="https://www.npmjs.com/package/agent-rules"><img src="https://badgen.net/npm/license/agent-rules" alt="license"/></a> <a href="https://www.npmjs.com/package/agent-rules"><img src="https://badgen.net/npm/dt/agent-rules" alt="downloads"/></a> <a href="https://github.com/lirantal/agent-rules/actions/workflows/ci.yml"><img src="https://github.com/lirantal/agent-rules/actions/workflows/ci.yml/badge.svg?branch=main" alt="build"/></a> <a href="https://codecov.io/gh/lirantal/agent-rules"><img src="https://badgen.net/codecov/c/github/lirantal/agent-rules" alt="codecov"/></a> <a href="./SECURITY.md"><img src="https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg" alt="Responsible Disclosure Policy" /></a> </p> <div align="center"> <img src="https://raw.githubusercontent.com/lirantal/agent-rules/refs/heads/main/.github/agent-rules-1.png" alt="agent-rules logo"/> </div>

Usage

Interactive Mode

npx agent-rules

This will start an interactive session where you can select the AI app and topics.

Supported AI Apps

| AI App | Supported | |--------|-----------| | GitHub Copilot | ✅ | | Cursor | ✅ | | Claude CLI | ✅ | | Gemini CLI | ✅ |

Command Line Interface

You can also use command line flags to skip the interactive prompts:

# Generate rules for a specific AI app and topic
npx agent-rules --app cursor --topics secure-code

# Generate rules for multiple topics
npx agent-rules --app github-copilot --topics secure-code --topics testing

# Include MCP (Model Context Protocol) configuration
npx agent-rules --app github-copilot --topics testing --mcp

# Include custom commands (prompts)
npx agent-rules --app github-copilot --topics secure-code --commands

# Combine multiple features
npx agent-rules --app github-copilot --topics secure-code --mcp --commands

# Use short flags
npx agent-rules -a claude-code -t security-vulnerabilities -m -c

# Show help
npx agent-rules --help

# Show version
npx agent-rules --version

Available Options

Flags:

• -a, --app <app> - AI app to generate rules for
• -t, --topics <topics> - Topics to generate rules for (can be specified multiple times)
• -m, --mcp - Include MCP (Model Context Protocol) server configuration
• -c, --commands - Include custom commands/prompts
• -h, --help - Show help message
• -v, --version - Show version number

AI Apps:

• github-copilot - GitHub Copilot
• cursor - Cursor
• claude-code - Claude Code
• gemini - Gemini CLI

Topics:

• secure-code - Secure coding practices
• security-vulnerabilities - Security vulnerability scanning and fixes
• testing - Testing strategy and guidelines

Features

📋 Instructions & Rules

Scaffold AI-specific coding instructions and best practices rules into your project:

• Security-focused coding practices
• Vulnerability detection and remediation
• Testing strategies and guidelines

🔌 MCP (Model Context Protocol) Configuration

Automatically configure MCP servers for enhanced agentic coding capabilities:

• GitHub Copilot: Configures .vscode/mcp.json
• Gemini CLI: Configures .gemini/settings.json
• Non-destructive merging with existing configurations

Learn more in the MCP Feature Documentation.

⚡ Custom Commands & Prompts

Scaffold reusable commands and prompts for your AI coding assistant:

• GitHub Copilot: Deploys to .github/prompts/ as prompt files
• Pre-built commands for common workflows (e.g., implementing GitHub issues)
• Easily extensible with your own custom commands

Learn more in the Commands Feature Documentation.

Rules

Current category of rules available:

• Secure coding practices, based on Liran Tal's Node.js Secure Coding
• Security vulnerabilities, based on Snyk.io
• Testing strategy and test code guidelines, built from Yoni Goldberg's JavaScript Testing and Liran Tal's testing strategy

Documentation

• Project documentation - development, testing, architecture, and conventions.

Contributing

Please consult CONTRIBUTING for guidelines on contributing to this project.

Author

agent-rules © Liran Tal, Released under the Apache-2.0 License.