# usage_rules v1.2.5 - Table of Contents

A config-driven dev tool for Elixir projects to manage AGENTS.md files and agent skills from dependencies

## GUIDES

- [Home](readme.md)

## Modules

- [UsageRules](UsageRules.md): Config-driven tool for managing AGENTS.md files and agent skills from Elixir dependencies.

## Mix Tasks

- [mix usage_rules.docs](Mix.Tasks.UsageRules.Docs.md): Shows documentation for Elixir modules and functions in markdown format.
- [mix usage_rules.install](Mix.Tasks.UsageRules.Install.md): Installs usage_rules
- [mix usage_rules.search_docs](Mix.Tasks.UsageRules.SearchDocs.md): Searches hexdocs with human-readable output (markdown by default).
If no version is specified, defaults to version used in the current mix project.
If called outside of a mix project or the dependency is not used in the
current mix project, defaults to the latest version.
## Search documentation for all dependencies in the current mix project
    $ mix usage_rules.search_docs "search term"
## Search documentation for specific packages
    $ mix usage_rules.search_docs "search term" -p ecto -p ash
## Search documentation for specific versions
    $ mix usage_rules.search_docs "search term" -p ecto@3.13.2 -p ash@3.5.26
## Control output format and pagination
    $ mix usage_rules.search_docs "search term" --output json --page 2 --per-page 20
## Search across all packages on hex
    $ mix usage_rules.search_docs "search term" --everywhere
## Search only in titles
    $ mix usage_rules.search_docs "search term" --query-by title
## Search in specific fields
    $ mix usage_rules.search_docs "search term" --query-by "doc,title,type"

- [mix usage_rules.sync](Mix.Tasks.UsageRules.Sync.md): Sync AGENTS.md and agent skills from project config