ai-rules-sync AGENTS.md

AGENTS instructions

Project Overview

AI Rules Sync (AIS) is a CLI tool for synchronizing, managing, and sharing AI agent rules across projects using symbolic links.

Tech Stack

• Language: TypeScript (strict mode)
• Build: tsc (ES modules)
• Test: Vitest
• CLI Framework: Commander.js
• Package Manager: pnpm

Key Features

• Multi-repository rule management (Cursor, Copilot, Claude, Trae)
• Symbolic link-based synchronization
• Shell tab completion (bash, zsh, fish)
• Plugin-based adapter architecture

Directory Structure

src/
├── adapters/           # Tool-specific adapters (cursor, copilot, claude, trae)
│   ├── base.ts         # Base adapter factory
│   ├── types.ts        # Adapter interfaces
│   └── index.ts        # Adapter registry
├── commands/           # CLI command handlers
│   ├── handlers.ts     # Core command logic (add, remove, link, unlink)
│   ├── install.ts      # Install command
│   └── helpers.ts      # Shared utilities
├── cli/
│   └── register.ts     # CLI registration
├── completion/
│   └── scripts.ts      # Shell completion scripts
├── config.ts           # Global config (~/.config/ai-rules-sync/)
├── project-config.ts   # Project config (ai-rules-sync.json)
├── sync-engine.ts      # Symlink creation/removal
├── link.ts             # Link utilities
├── git.ts              # Git operations
├── utils.ts            # Shared utilities
└── index.ts            # Entry point

Development Commands

# Build TypeScript
npm run build

# Run tests (watch mode)
npm test

# Run tests once
npx vitest run

# Test CLI locally
node dist/index.js <command>

Code Style Guidelines

1. TypeScript Strict Mode: All code must pass strict type checking
2. Functional Programming: Prefer pure functions, avoid side effects where possible
3. Testing Required: All new features must have tests in src/__tests__/
4. ES Modules: Use .js extension in imports for Node.js compatibility
5. Error Handling: Use descriptive error messages with chalk for CLI output