skills.rest
bradleygolden
bradleygoldenCOMMUNITY
Explore all skills by this author →
GitHub

hex-docs-search

Search Hex package documentation across local dependencies and caches.

176|8|Updated Jul 25, 2025
Search Tags:#developer tools#documentation#code search#erlang#elixir#hex packages#usage examples
One-click install
npx skills add https://github.com/bradleygolden/claude-marketplace-elixir --skill hex-docs-search
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: hex-docs-search
Source: https://github.com/bradleygolden/claude-marketplace-elixir/tree/main/plugins/core/skills/hex-docs-search
Command: npx skills add https://github.com/bradleygolden/claude-marketplace-elixir --skill hex-docs-search

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, jq.

What problem does it solve?

This Skill eliminates the tedious manual search for Elixir and Erlang package documentation, usage examples, and integration patterns. It automates the process of finding relevant information, saving you significant time and reducing complexity when working with the BEAM ecosystem.

Core Features & Use Cases

  • Cascading Search Strategy: Intelligently searches local dependencies, your project's codebase, the official HexDocs API, and the web, prioritizing the most relevant context.
  • Context-Aware Usage Examples: Provides real-world examples of how a library or module is used within your current project, offering invaluable practical insights.
  • Comprehensive Documentation Retrieval: Fetches module definitions, function implementations, @moduledoc/@doc annotations, and official HexDocs content.
  • Use Case: When you need to understand a specific function like Jason.decode!/1, this Skill will not only provide its official documentation but also show you its implementation from your deps/ and how it's used in your project's test/ files.

Quick Start

How do I use Phoenix.LiveView mount/3?

Frequently Asked Questions about hex-docs-search

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find Elixir package documentation without leaving my project?▼

Search Elixir and Erlang package documentation directly from your dependencies using a cascading strategy that checks local deps, cached docs, and HexDocs API. This eliminates manual browser searches and surfaces usage examples from your own codebase alongside official documentation.

Can I see how a specific function is used in my Elixir project?▼

Yes, this tool searches your project's codebase to find real-world usage examples of library functions alongside their official documentation. For example, query Phoenix.LiveView mount/3 to see both its signature and how it's implemented in your test files.

What's the fastest way to look up Ecto, Jason, or Sobelow function signatures?▼

Use a cascading search that prioritizes local dependencies and cached documentation over web requests. This approach retrieves function signatures, @doc annotations, and implementation details from Hex packages instantly without repeated API calls.

Does this work with packages I haven't downloaded yet?▼

Yes. The tool falls back to the HexDocs API and web search if documentation isn't cached locally, so you can find docs for any published Hex package even if it's not in your current project dependencies.

How do I find integration patterns for libraries like Ash or Credo?▼

Search by package name to retrieve module definitions, function implementations, and @moduledoc annotations from HexDocs. The codebase search layer also reveals how these libraries are already integrated and configured in your project.

Related Skills

Explore More Software Engineering Skills→
oliver-kriskaoliver-kriska
517

hexdocs-fetcher

Fetch HexDocs documentation for Elixir libraries and convert HTML to markdown.

Community
Intermediate
IgorGanapolskyIgorGanapolsky
38

Local CI Runner (ACT)

Run GitHub Actions workflows locally in Docker using ACT.

Community
Advanced
andreashasseandreashasse
7

bump-spectra

Updates the spectra Erlang library dependency to its latest stable version on Hex.pm and verifies compatibility with the Elixir Spectral wrapper via format, compile, test, credo, and dialyzer checks.

Community
Intermediate
jusi-devjusi-dev

hex-docs-search

Locate Elixir Hex package docs from local sources and HexDocs API.

Community
Intermediate