Packages

usage_rules

1.2.0
1.2.6 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.0 1.0.3 1.0.2 1.0.1 1.0.0-rc.3 1.0.0-rc.2 1.0.0-rc.1 1.0.0-rc.0 0.1.26 0.1.25 0.1.24 0.1.23 0.1.22 0.1.21 0.1.20 0.1.19 0.1.18 0.1.17 0.1.16 0.1.15 0.1.14 0.1.13 0.1.12 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

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

HexDocs

Current section

42 Versions

Jump to
Readme
42 Versions
3 Dependencies
Dependants
Files
Activity
Hide whitespace

Compare versions

12 files changed
+80 additions
-36 deletions
  @@ -1,4 +1,4 @@
1 - # SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs.contributors>
1 + # SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs/contributors>
2 2 #
3 3 # SPDX-License-Identifier: MIT
  @@ -1,6 +1,6 @@
1 1 <!--
2 2 SPDX-FileCopyrightText: 2025 Zach Daniel
3 - SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs.contributors>
3 + SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs/contributors>
4 4
5 5 SPDX-License-Identifier: MIT
6 6 -->
  @@ -12,6 +12,19 @@ See [Conventional Commits](Https://conventionalcommits.org) for commit guideline
12 12
13 13 <!-- changelog -->
14 14
15 + ## v1.2.0 (2026-02-18)
16 +
17 +
18 +
19 +
20 + ### Features:
21 +
22 + * support options for :all in usage_rules config (#53) by Jinkyou Son
23 +
24 + ### Improvements:
25 +
26 + * allow excluding main usage-rules.md while including sub-rules by Zach Daniel
27 +
15 28 ## v1.1.0 (2026-02-11)
  @@ -1,6 +1,6 @@
1 1 <!--
2 2 SPDX-FileCopyrightText: 2025 Zach Daniel
3 - SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs.contributors>
3 + SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs/contributors>
4 4
5 5 SPDX-License-Identifier: MIT
6 6 -->
  @@ -14,8 +14,8 @@ SPDX-License-Identifier: MIT
14 14
15 15 **UsageRules** is a config-driven dev tool for Elixir projects that manages your AGENTS.md file and agent skills from dependencies. It:
16 16
17 - - Gathers and consolidates `usage-rules.md` files from your dependencies into an AGENTS.md (or any file)
18 - - Generates agent skills (SKILL.md files) from dependency usage rules
17 + - Gathers and consolidates `usage-rules.md` files (or files from a `usage-rules` directory) from your dependencies into an `AGENTS.md` (or any file)
18 + - Generates agent skills (`SKILL.md` files) from dependency usage rules
19 19 - Provides built-in usage rules for Elixir and OTP
20 20 - Includes a powerful documentation search task via `mix usage_rules.search_docs`
21 21
  @@ -34,7 +34,7 @@ Or add `usage_rules` manually to your `mix.exs`:
34 34 ```elixir
35 35 def deps do
36 36 [
37 - {:usage_rules, "~> 1.0", only: [:dev]},
37 + {:usage_rules, "~> 1.1", only: [:dev]},
38 38 {:igniter, "~> 0.6", only: [:dev]}
39 39 ]
40 40 end
  @@ -157,6 +157,7 @@ Each entry in the `usage_rules` list can be:
157 157 | `{:package, link: :markdown}` | Link with `[name](deps/package/usage-rules.md)` style |
158 158 | `{~r/pattern/, link: :markdown}` | Link all matching dependencies with markdown-style |
159 159 | `{"package:sub_rule", link: :at}` | Link a specific sub-rule with @-style |
160 + | `{:package, main: false}` | Exclude the main `usage-rules.md`, include only sub-rules |
160 161
161 162 ### Skills options
162 163
  @@ -251,6 +252,24 @@ defp usage_rules do
251 252 end
252 253 ```
253 254
255 + ### Inline main rules, link sub-rules
256 +
257 + If a package has many sub-rules and you want to keep the main rules inlined but link to sub-rules instead of inlining them all, use `main: false` to declare the same package twice with different options:
258 +
259 + ```elixir
260 + defp usage_rules do
261 + [
262 + file: "AGENTS.md",
263 + usage_rules: [
264 + {:ash, sub_rules: []}, # inline main rules only
265 + {:ash, sub_rules: :all, main: false, link: :markdown} # link sub-rules only
266 + ]
267 + ]
268 + end
269 + ```
270 +
271 + The first entry inlines the main `usage-rules.md` with no sub-rules. The second entry adds all sub-rules as markdown links, with `main: false` preventing a duplicate main entry.
272 +
254 273 ## Agent Skills
255 274
256 275 Skills are SKILL.md files that agent tools like Claude Code can discover and use. UsageRules can automatically generate skills from your dependencies' usage rules.
  @@ -7,7 +7,7 @@
7 7 {<<"GitHub">>,<<"https://github.com/ash-project/usage_rules">>},
8 8 {<<"Website">>,<<"https://ash-hq.org">>}]}.
9 9 {<<"name">>,<<"usage_rules">>}.
10 - {<<"version">>,<<"1.1.0">>}.
10 + {<<"version">>,<<"1.2.0">>}.
11 11 {<<"description">>,
12 12 <<"A config-driven dev tool for Elixir projects to manage AGENTS.md files and agent skills from dependencies">>}.
13 13 {<<"elixir">>,<<"~> 1.18">>}.
  @@ -1,4 +1,4 @@
1 - # SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs.contributors>
1 + # SPDX-FileCopyrightText: 2025 usage_rules contributors <https://github.com/ash-project/usage_rules/graphs/contributors>
2 2 #
3 3 # SPDX-License-Identifier: MIT
Loading more files…