Packages

usage_rules

0.1.19
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

Files

Jump to
Readme
42 Versions
3 Dependencies
Dependants
Files
Activity
usage_rules usage-rules.md
Raw

usage-rules.md 

## Using Usage Rules



Many packages have usage rules, which you should *thoroughly* consult before taking any

action. These usage rules contain guidelines and rules *directly from the package authors*.

They are your best source of knowledge for making decisions.



## Searching Documentation



You should also consult the documentation of any tools you are using, early and often. The best 

way to accomplish this is to use the `usage_rules.search_docs` mix task. For example:



```

# Search docs for all packages in the current application, including Elixir

mix usage_rules.search_docs Enum.zip



# Search docs for specific packages

mix usage_rules.search_docs Req.get -p req



# Search docs for multi-word queries

mix usage_rules.search_docs "making requests" -p req



# Search only in titles (useful for finding specific functions/modules)

mix usage_rules.search_docs "Enum.zip" --query-by title



# Search by title only

mix usage_rules.search_docs "validation" --query-by "title"

```