SPDX-License-Identifier: MIT

#Правила использования

UsageRules - это инструмент разработки на основе конфигураций для проектов Elixir, который управляет вашими файлами AGENTS.md и навыками агента из зависимостей. Это:

Собирает и консолидирует файлы (или файлы из каталога [T1]) из ваших зависимостей в AGENTS.md (или любой файл) Генерирует агентские навыки ([T3]] файлы из правил использования зависимостей Встроенные правила использования Elixir и OTP Включает в себя мощную задачу поиска документации через mix usage_rules.search_docs

##Быстрый старт

###Установка

Если вы установили igniter:

Или добавить usage_rules вручную к mix.exs:

Конфигурация

Вся конфигурация находится в конфигурации проекта mix.exs. Добавить ключ :usage_rules:

** Совет: ** Многие агенты кодирования ИИ (Claude Code, Cursor, GitHub Copilot, Windsurf) используют значение description:, чтобы решить, когда автоматически загрузить навык без ручного вызова. Описания с конкретными, наблюдаемыми сигналами, как правило, работают лучше, чем общие ярлыки тем — например, "Load when any file uses Ash.Resource or when debugging Ash.Error.Forbidden", а не ‘Использовать при работе с ресурсами Ash.

UsageRules

UsageRules is a config-driven dev tool for Elixir projects that manages your AGENTS.md file and agent skills from dependencies. It:

• Gathers and consolidates usage-rules.md files (or files from a usage-rules directory) from your dependencies into an AGENTS.md (or any file)
• Generates agent skills (SKILL.md files) from dependency usage rules
• Provides built-in usage rules for Elixir and OTP
• Includes a powerful documentation search task via mix usage_rules.search_docs

Quickstart

Installation

If you have igniter installed:

mix igniter.install usage_rules

Or add usage_rules manually to your mix.exs:

def deps do
  [
    {:usage_rules, "~> 1.1", only: [:dev]},
    {:igniter, "~> 0.6", only: [:dev]}
  ]
end

Configuration

All configuration lives in your mix.exs project config. Add a :usage_rules key:

def project do
  [
    ...
    usage_rules: usage_rules()
  ]
end

defp usage_rules do
  # Example for those using claude.
  [
    file: "CLAUDE.md",
    # rules to include directly in CLAUDE.md
    # :usage_rules itself provides rules for search_docs, docs, etc.
    # use a regex to match multiple deps, or atoms/strings for specific ones
    usage_rules: [:usage_rules, :ash, ~r/^ash_/],
    # If your CLAUDE.md is getting too big, link instead of inlining:
    usage_rules: [:ash, {~r/^ash_/, link: :markdown}],
    # or use skills
    skills: [
      location: ".claude/skills",
      # build skills that combine multiple usage rules
      build: [
        "ash-framework": [
          # The description tells people how to use this skill.
          description: "Use this skill working with Ash Framework or any of its extensions. Always consult this when making any domain changes, features or fixes.",
          # Include all Ash dependencies
          usage_rules: [:ash, ~r/^ash_/]
        ],
        "phoenix-framework": [
          description: "Use this skill working with Phoenix Framework. Consult this when working with the web layer, controllers, views, liveviews etc.",