API Reference usage_rules v#1.3.0

Copy Markdown View Source

Modules

Config-driven tool for managing AGENTS.md files and agent skills from Elixir dependencies.

Validates documentation references in usage-rules-managed markdown files by driving ex_doc's own autolink pipeline over them.

Mix Tasks

Shows documentation for Elixir modules and functions in markdown format.

Installs usage_rules

Prints each dependency that ships usage rules, and which sub-rule files exist.

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.

Sync AGENTS.md and agent skills from project config

Validates module, function, and file references found in the files generated and managed by mix usage_rules.sync, using ex_doc's own autolink pipeline. Warnings are ex_doc's own, printed with file/line information — the same warnings a HexDocs build would emit over the same content. See UsageRules.Validator for exactly what is and is not checked.