mix usage_rules.search_docs (usage_rules v0.1.24)

View Source

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.

Search documentation for all dependencies in the current mix project

$ mix usage_rules.search_docs "search term"

Search documentation for specific packages

$ mix usage_rules.search_docs "search term" -p ecto -p ash

Search documentation for specific versions

$ mix usage_rules.search_docs "search term" -p ecto@3.13.2 -p ash@3.5.26

Control output format and pagination

$ mix usage_rules.search_docs "search term" --output json --page 2 --per-page 20

Search across all packages on hex

$ mix usage_rules.search_docs "search term" --everywhere

Search only in titles

$ mix usage_rules.search_docs "search term" --query-by title

Search in specific fields

$ mix usage_rules.search_docs "search term" --query-by "doc,title,type"