ExAthena.Tools.UsageRules (ExAthena v0.17.0)

Copy Markdown View Source

Read dependency usage rules — the LLM-oriented usage-rules.md docs that Elixir libraries ship in their Hex package (the usage_rules convention).

These live locally in the project's deps:

  • deps/<pkg>/usage-rules.md → addressed as <pkg>
  • deps/<pkg>/usage-rules/<topic>.md → addressed as <pkg>:<topic>

Prefer this over web_fetch of hexdocs: it's local, fast, version-accurate for exactly the deps in this project, and can't time out on a slow network.

  • No package arg → lists every available rule set in the project's deps.
  • package: "ash" → returns deps/ash/usage-rules.md.
  • package: "phoenix:html" → returns deps/phoenix/usage-rules/html.md.