@kirill.konshin/agents

AI Agent rules and configuration for monorepos. Provides a standardized set of coding conventions, patterns, and best practices that AI coding assistants can use.

Installation

npm install @kirill.konshin/agents --save-dev
# or
yarn add @kirill.konshin/agents --dev

Usage

Option 1: Prepare Script (Recommended)

Add to your package.json:

{
    "scripts": {
        "prepare": "agents init"
    }
}

This will automatically generate/update AGENTS.md when:

• Running npm install / yarn install
• After cloning the repository

Option 2: Manual Generation

# Generate AGENTS.md (skips if exists and wasn't generated by this tool)
npx agents init

# Force update AGENTS.md
npx agents update

How It Works

The CLI combines all markdown rule files from the package into a single AGENTS.md file in your project root. This file is recognized by AI coding assistants (like Augment, Cursor, GitHub Copilot, etc.) and used to understand your project's conventions.

Generated File

The generated AGENTS.md includes:

• A marker comment to identify it was generated by this tool
• All rules from the package, separated by horizontal rules
• A section for custom project-specific rules

Skipping Existing Files

If AGENTS.md already exists and wasn't generated by this tool, the init command will skip it to avoid overwriting your custom rules. Use update to force regeneration.

Included Rules

| File | Description | | ------------------ | -------------------------------------- | | 01-agents.md | Task management and build verification | | 02-changesets.md | Changesets workflow for versioning | | 03-turbo.md | Turborepo patterns and conventions | | 04-typescript.md | TypeScript coding conventions | | 05-testing.md | Vitest testing patterns | | 06-style.md | General coding style guidelines |

Customization

Adding Project-Specific Rules

The generated AGENTS.md includes a "Custom Rules" section at the bottom. Add your project-specific rules there - they won't be overwritten on updates.

Using with .augment/rules

If you use Augment's .augment/rules/ directory, you can reference the package rules and add repo-specific extensions:

# TypeScript

General TypeScript rules are provided by `@kirill.konshin/agents` package.
See: `node_modules/@kirill.konshin/agents/rules/04-typescript.md`

# Repo-Specific

Additional rules specific to this repository...

Versioning

When you update @kirill.konshin/agents, run npx agents update to regenerate AGENTS.md with the latest rules.

License

MIT