Packages
A config-driven dev tool for Elixir projects to manage AGENTS.md files and agent skills from dependencies
Current section
42 Versions
Jump to
Current section
42 Versions
Compare versions
7
files changed
+53
additions
-9
deletions
| @@ -5,6 +5,19 @@ See [Conventional Commits](Https://conventionalcommits.org) for commit guideline | |
| 5 5 | |
| 6 6 | <!-- changelog --> |
| 7 7 | |
| 8 | + ## v0.1.24 (2025-08-31) |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + ### Bug Fixes: |
| 14 | + |
| 15 | + * typo in OTP usage rules (#22) by Hubert Pompecki |
| 16 | + |
| 17 | + ### Improvements: |
| 18 | + |
| 19 | + * Add warning about %{} pattern matching (#23) by jlgeering |
| 20 | + |
| 8 21 | ## v0.1.23 (2025-07-22) |
| @@ -8,13 +8,26 @@ | |
| 8 8 | |
| 9 9 | ## Quickstart |
| 10 10 | |
| 11 | - ```sh |
| 12 | - # install usage_rules into your project |
| 13 | - mix igniter.install usage_rules |
| 11 | + Begin by installing `usage_rules` in your project. |
| 12 | + If you have [igniter](https://github.com/ash-project/igniter) installed, run: |
| 14 13 | |
| 14 | + ```sh |
| 15 | + mix igniter.install usage_rules |
| 16 | + ``` |
| 17 | + |
| 18 | + Otherwise, add `usage_rules` to your dependencies in `mix.exs` and run `mix deps.get`: |
| 19 | + |
| 20 | + ```elixir |
| 21 | + {:usage_rules, "~> 0.1"} |
| 22 | + ``` |
| 23 | + |
| 24 | + Then, use the `usage_rules.sync` mix task to gather rules from your dependencies: |
| 25 | + |
| 26 | + ```sh |
| 15 27 | # swap AGENTS.md out for any file you like, e.g `CLAUDE.md` |
| 16 28 | # sync projects as links to their usage rules |
| 17 | - # to save tokens. Agent can view them on demand |
| 29 | + # to save tokens. Agent can view them on demand. |
| 30 | + # Existing rules in the file are retained. |
| 18 31 | mix usage_rules.sync AGENTS.md --all \ |
| 19 32 | --inline usage_rules:all \ |
| 20 33 | --link-to-folder deps |
| @@ -216,3 +229,20 @@ def deps do | |
| 216 229 | ] |
| 217 230 | end |
| 218 231 | ``` |
| 232 | + |
| 233 | + ### Alias example |
| 234 | + |
| 235 | + ```elixir |
| 236 | + defp aliases do |
| 237 | + [ |
| 238 | + "usage_rules.update": [ |
| 239 | + """ |
| 240 | + usage_rules.sync AGENTS.md --all \ |
| 241 | + --inline usage_rules:all \ |
| 242 | + --link-to-folder deps |
| 243 | + """ |
| 244 | + |> String.trim() |
| 245 | + ] |
| 246 | + ] |
| 247 | + end |
| 248 | + ``` |
| @@ -6,7 +6,7 @@ | |
| 6 6 | {<<"GitHub">>,<<"https://github.com/ash-project/usage_rules">>}, |
| 7 7 | {<<"Website">>,<<"https://ash-hq.org">>}]}. |
| 8 8 | {<<"name">>,<<"usage_rules">>}. |
| 9 | - {<<"version">>,<<"0.1.23">>}. |
| 9 | + {<<"version">>,<<"0.1.24">>}. |
| 10 10 | {<<"description">>, |
| 11 11 | <<"A dev tool for Elixir projects to gather LLM usage rules from dependencies">>}. |
| 12 12 | {<<"elixir">>,<<"~> 1.18">>}. |
| @@ -62,7 +62,7 @@ if Code.ensure_loaded?(Igniter) do | |
| 62 62 | --link-to-folder rules |
| 63 63 | |
| 64 64 | |
| 65 | - For more ineo and examples: `mix help usage_rules.sync` |
| 65 | + For more info and examples: `mix help usage_rules.sync` |
| 66 66 | """) |
| 67 67 | end |
| 68 68 | end |
| @@ -1,7 +1,7 @@ | |
| 1 1 | defmodule UsageRules.MixProject do |
| 2 2 | use Mix.Project |
| 3 3 | |
| 4 | - @version "0.1.23" |
| 4 | + @version "0.1.24" |
| 5 5 | @description """ |
| 6 6 | A dev tool for Elixir projects to gather LLM usage rules from dependencies |
| 7 7 | """ |
Loading more files…